AWS v6.71.0, Mar 7 25

AWS v6.71.0 published on Friday, Mar 7, 2025 by Pulumi

aws.lakeformation.getDataLakeSettings

Explore with Pulumi AI

AWS v6.71.0 published on Friday, Mar 7, 2025 by Pulumi

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = aws.lakeformation.getDataLakeSettings({
    catalogId: "14916253649",
});

import pulumi
import pulumi_aws as aws

example = aws.lakeformation.get_data_lake_settings(catalog_id="14916253649")

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/lakeformation"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := lakeformation.LookupDataLakeSettings(ctx, &lakeformation.LookupDataLakeSettingsArgs{
			CatalogId: pulumi.StringRef("14916253649"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = Aws.LakeFormation.GetDataLakeSettings.Invoke(new()
    {
        CatalogId = "14916253649",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.lakeformation.LakeformationFunctions;
import com.pulumi.aws.lakeformation.inputs.GetDataLakeSettingsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = LakeformationFunctions.getDataLakeSettings(GetDataLakeSettingsArgs.builder()
            .catalogId("14916253649")
            .build());

    }
}

variables:
  example:
    fn::invoke:
      function: aws:lakeformation:getDataLakeSettings
      arguments:
        catalogId: '14916253649'

Using getDataLakeSettings

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getDataLakeSettings(args: GetDataLakeSettingsArgs, opts?: InvokeOptions): Promise<GetDataLakeSettingsResult>
function getDataLakeSettingsOutput(args: GetDataLakeSettingsOutputArgs, opts?: InvokeOptions): Output<GetDataLakeSettingsResult>

def get_data_lake_settings(catalog_id: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetDataLakeSettingsResult
def get_data_lake_settings_output(catalog_id: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetDataLakeSettingsResult]

func LookupDataLakeSettings(ctx *Context, args *LookupDataLakeSettingsArgs, opts ...InvokeOption) (*LookupDataLakeSettingsResult, error)
func LookupDataLakeSettingsOutput(ctx *Context, args *LookupDataLakeSettingsOutputArgs, opts ...InvokeOption) LookupDataLakeSettingsResultOutput

> Note: This function is named LookupDataLakeSettings in the Go SDK.

public static class GetDataLakeSettings 
{
    public static Task<GetDataLakeSettingsResult> InvokeAsync(GetDataLakeSettingsArgs args, InvokeOptions? opts = null)
    public static Output<GetDataLakeSettingsResult> Invoke(GetDataLakeSettingsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDataLakeSettingsResult> getDataLakeSettings(GetDataLakeSettingsArgs args, InvokeOptions options)
public static Output<GetDataLakeSettingsResult> getDataLakeSettings(GetDataLakeSettingsArgs args, InvokeOptions options)

fn::invoke:
  function: aws:lakeformation/getDataLakeSettings:getDataLakeSettings
  arguments:
    # arguments dictionary

The following arguments are supported:

CatalogId string: Identifier for the Data Catalog. By default, the account ID.

CatalogId string: Identifier for the Data Catalog. By default, the account ID.

catalogId String: Identifier for the Data Catalog. By default, the account ID.

catalogId string: Identifier for the Data Catalog. By default, the account ID.

catalog_id str: Identifier for the Data Catalog. By default, the account ID.

catalogId String: Identifier for the Data Catalog. By default, the account ID.

getDataLakeSettings Result

The following output properties are available:

Admins List<string>: List of ARNs of AWS Lake Formation principals (IAM users or roles).
AllowExternalDataFiltering bool: Whether to allow Amazon EMR clusters to access data managed by Lake Formation.
AllowFullTableExternalDataAccess bool: Whether to allow a third-party query engine to get data access credentials without session tags when a caller has full data access permissions.
AuthorizedSessionTagValueLists List<string>: Lake Formation relies on a privileged process secured by Amazon EMR or the third party integrator to tag the user's role while assuming it.
CreateDatabaseDefaultPermissions List<GetDataLakeSettingsCreateDatabaseDefaultPermission>: Up to three configuration blocks of principal permissions for default create database permissions. Detailed below.
CreateTableDefaultPermissions List<GetDataLakeSettingsCreateTableDefaultPermission>: Up to three configuration blocks of principal permissions for default create table permissions. Detailed below.
ExternalDataFilteringAllowLists List<string>: A list of the account IDs of Amazon Web Services accounts with Amazon EMR clusters that are to perform data filtering.
Id string: The provider-assigned unique ID for this managed resource.
Parameters Dictionary<string, string>: Key-value map of additional configuration. CROSS_ACCOUNT_VERSION will be set to values "1", "2", "3", or "4". SET_CONTEXT will also be returned with a value of TRUE. In a fresh account, prior to configuring, CROSS_ACCOUNT_VERSION is "1".
ReadOnlyAdmins List<string>: List of ARNs of AWS Lake Formation principals (IAM users or roles) with only view access to the resources.
TrustedResourceOwners List<string>: List of the resource-owning account IDs that the caller's account can use to share their user access details (user ARNs).
CatalogId string

Admins []string: List of ARNs of AWS Lake Formation principals (IAM users or roles).
AllowExternalDataFiltering bool: Whether to allow Amazon EMR clusters to access data managed by Lake Formation.
AllowFullTableExternalDataAccess bool: Whether to allow a third-party query engine to get data access credentials without session tags when a caller has full data access permissions.
AuthorizedSessionTagValueLists []string: Lake Formation relies on a privileged process secured by Amazon EMR or the third party integrator to tag the user's role while assuming it.
CreateDatabaseDefaultPermissions []GetDataLakeSettingsCreateDatabaseDefaultPermission: Up to three configuration blocks of principal permissions for default create database permissions. Detailed below.
CreateTableDefaultPermissions []GetDataLakeSettingsCreateTableDefaultPermission: Up to three configuration blocks of principal permissions for default create table permissions. Detailed below.
ExternalDataFilteringAllowLists []string: A list of the account IDs of Amazon Web Services accounts with Amazon EMR clusters that are to perform data filtering.
Id string: The provider-assigned unique ID for this managed resource.
Parameters map[string]string: Key-value map of additional configuration. CROSS_ACCOUNT_VERSION will be set to values "1", "2", "3", or "4". SET_CONTEXT will also be returned with a value of TRUE. In a fresh account, prior to configuring, CROSS_ACCOUNT_VERSION is "1".
ReadOnlyAdmins []string: List of ARNs of AWS Lake Formation principals (IAM users or roles) with only view access to the resources.
TrustedResourceOwners []string: List of the resource-owning account IDs that the caller's account can use to share their user access details (user ARNs).
CatalogId string

admins List<String>: List of ARNs of AWS Lake Formation principals (IAM users or roles).
allowExternalDataFiltering Boolean: Whether to allow Amazon EMR clusters to access data managed by Lake Formation.
allowFullTableExternalDataAccess Boolean: Whether to allow a third-party query engine to get data access credentials without session tags when a caller has full data access permissions.
authorizedSessionTagValueLists List<String>: Lake Formation relies on a privileged process secured by Amazon EMR or the third party integrator to tag the user's role while assuming it.
createDatabaseDefaultPermissions List<GetDataLakeSettingsCreateDatabaseDefaultPermission>: Up to three configuration blocks of principal permissions for default create database permissions. Detailed below.
createTableDefaultPermissions List<GetDataLakeSettingsCreateTableDefaultPermission>: Up to three configuration blocks of principal permissions for default create table permissions. Detailed below.
externalDataFilteringAllowLists List<String>: A list of the account IDs of Amazon Web Services accounts with Amazon EMR clusters that are to perform data filtering.
id String: The provider-assigned unique ID for this managed resource.
parameters Map<String,String>: Key-value map of additional configuration. CROSS_ACCOUNT_VERSION will be set to values "1", "2", "3", or "4". SET_CONTEXT will also be returned with a value of TRUE. In a fresh account, prior to configuring, CROSS_ACCOUNT_VERSION is "1".
readOnlyAdmins List<String>: List of ARNs of AWS Lake Formation principals (IAM users or roles) with only view access to the resources.
trustedResourceOwners List<String>: List of the resource-owning account IDs that the caller's account can use to share their user access details (user ARNs).
catalogId String

admins string[]: List of ARNs of AWS Lake Formation principals (IAM users or roles).
allowExternalDataFiltering boolean: Whether to allow Amazon EMR clusters to access data managed by Lake Formation.
allowFullTableExternalDataAccess boolean: Whether to allow a third-party query engine to get data access credentials without session tags when a caller has full data access permissions.
authorizedSessionTagValueLists string[]: Lake Formation relies on a privileged process secured by Amazon EMR or the third party integrator to tag the user's role while assuming it.
createDatabaseDefaultPermissions GetDataLakeSettingsCreateDatabaseDefaultPermission[]: Up to three configuration blocks of principal permissions for default create database permissions. Detailed below.
createTableDefaultPermissions GetDataLakeSettingsCreateTableDefaultPermission[]: Up to three configuration blocks of principal permissions for default create table permissions. Detailed below.
externalDataFilteringAllowLists string[]: A list of the account IDs of Amazon Web Services accounts with Amazon EMR clusters that are to perform data filtering.
id string: The provider-assigned unique ID for this managed resource.
parameters {[key: string]: string}: Key-value map of additional configuration. CROSS_ACCOUNT_VERSION will be set to values "1", "2", "3", or "4". SET_CONTEXT will also be returned with a value of TRUE. In a fresh account, prior to configuring, CROSS_ACCOUNT_VERSION is "1".
readOnlyAdmins string[]: List of ARNs of AWS Lake Formation principals (IAM users or roles) with only view access to the resources.
trustedResourceOwners string[]: List of the resource-owning account IDs that the caller's account can use to share their user access details (user ARNs).
catalogId string

admins Sequence[str]: List of ARNs of AWS Lake Formation principals (IAM users or roles).
allow_external_data_filtering bool: Whether to allow Amazon EMR clusters to access data managed by Lake Formation.
allow_full_table_external_data_access bool: Whether to allow a third-party query engine to get data access credentials without session tags when a caller has full data access permissions.
authorized_session_tag_value_lists Sequence[str]: Lake Formation relies on a privileged process secured by Amazon EMR or the third party integrator to tag the user's role while assuming it.
create_database_default_permissions Sequence[GetDataLakeSettingsCreateDatabaseDefaultPermission]: Up to three configuration blocks of principal permissions for default create database permissions. Detailed below.
create_table_default_permissions Sequence[GetDataLakeSettingsCreateTableDefaultPermission]: Up to three configuration blocks of principal permissions for default create table permissions. Detailed below.
external_data_filtering_allow_lists Sequence[str]: A list of the account IDs of Amazon Web Services accounts with Amazon EMR clusters that are to perform data filtering.
id str: The provider-assigned unique ID for this managed resource.
parameters Mapping[str, str]: Key-value map of additional configuration. CROSS_ACCOUNT_VERSION will be set to values "1", "2", "3", or "4". SET_CONTEXT will also be returned with a value of TRUE. In a fresh account, prior to configuring, CROSS_ACCOUNT_VERSION is "1".
read_only_admins Sequence[str]: List of ARNs of AWS Lake Formation principals (IAM users or roles) with only view access to the resources.
trusted_resource_owners Sequence[str]: List of the resource-owning account IDs that the caller's account can use to share their user access details (user ARNs).
catalog_id str

admins List<String>: List of ARNs of AWS Lake Formation principals (IAM users or roles).
allowExternalDataFiltering Boolean: Whether to allow Amazon EMR clusters to access data managed by Lake Formation.
allowFullTableExternalDataAccess Boolean: Whether to allow a third-party query engine to get data access credentials without session tags when a caller has full data access permissions.
authorizedSessionTagValueLists List<String>: Lake Formation relies on a privileged process secured by Amazon EMR or the third party integrator to tag the user's role while assuming it.
createDatabaseDefaultPermissions List<Property Map>: Up to three configuration blocks of principal permissions for default create database permissions. Detailed below.
createTableDefaultPermissions List<Property Map>: Up to three configuration blocks of principal permissions for default create table permissions. Detailed below.
externalDataFilteringAllowLists List<String>: A list of the account IDs of Amazon Web Services accounts with Amazon EMR clusters that are to perform data filtering.
id String: The provider-assigned unique ID for this managed resource.
parameters Map<String>: Key-value map of additional configuration. CROSS_ACCOUNT_VERSION will be set to values "1", "2", "3", or "4". SET_CONTEXT will also be returned with a value of TRUE. In a fresh account, prior to configuring, CROSS_ACCOUNT_VERSION is "1".
readOnlyAdmins List<String>: List of ARNs of AWS Lake Formation principals (IAM users or roles) with only view access to the resources.
trustedResourceOwners List<String>: List of the resource-owning account IDs that the caller's account can use to share their user access details (user ARNs).
catalogId String

Supporting Types

GetDataLakeSettingsCreateDatabaseDefaultPermission

Permissions List<string>: List of permissions granted to the principal.
Principal string: Principal who is granted permissions.

Permissions []string: List of permissions granted to the principal.
Principal string: Principal who is granted permissions.

permissions List<String>: List of permissions granted to the principal.
principal String: Principal who is granted permissions.

permissions string[]: List of permissions granted to the principal.
principal string: Principal who is granted permissions.

permissions Sequence[str]: List of permissions granted to the principal.
principal str: Principal who is granted permissions.

permissions List<String>: List of permissions granted to the principal.
principal String: Principal who is granted permissions.

GetDataLakeSettingsCreateTableDefaultPermission

Permissions List<string>: List of permissions granted to the principal.
Principal string: Principal who is granted permissions.

Permissions []string: List of permissions granted to the principal.
Principal string: Principal who is granted permissions.

permissions List<String>: List of permissions granted to the principal.
principal String: Principal who is granted permissions.

permissions string[]: List of permissions granted to the principal.
principal string: Principal who is granted permissions.

permissions Sequence[str]: List of permissions granted to the principal.
principal str: Principal who is granted permissions.

permissions List<String>: List of permissions granted to the principal.
principal String: Principal who is granted permissions.

Package Details

Repository: AWS Classic pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

AWS v6.71.0 published on Friday, Mar 7, 2025 by Pulumi

pulumi/pulumi-aws

aws.lakeformation.getDataLakeSettings

On this page

On this page

Example Usage

Using getDataLakeSettings

getDataLakeSettings Result

Supporting Types

GetDataLakeSettingsCreateDatabaseDefaultPermission

GetDataLakeSettingsCreateTableDefaultPermission

Package Details

On this page

On this page