Package software.amazon.awscdk.services.lakeformation

Class CfnDataLakeSettings

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.lakeformation.CfnDataLakeSettings

All Implemented Interfaces:

IEnvironmentAware, IInspectable, IDataLakeSettingsRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
           date="2025-11-10T13:40:08.617Z")
@Stability(Stable)
public class CfnDataLakeSettings
extends CfnResource
implements IInspectable, IDataLakeSettingsRef

The AWS::LakeFormation::DataLakeSettings resource is an AWS Lake Formation resource type that manages the data lake settings for your account.

Example:

 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.glue.alpha.S3Table;
 import software.amazon.awscdk.services.glue.alpha.Database;
 import software.amazon.awscdk.services.glue.alpha.DataFormat;
 import software.amazon.awscdk.services.glue.alpha.Schema;
 import software.amazon.awscdk.services.lakeformation.CfnDataLakeSettings;
 import software.amazon.awscdk.services.lakeformation.CfnTag;
 import software.amazon.awscdk.services.lakeformation.CfnTagAssociation;
 Stack stack;
 String accountId;
 String tagKey = "aws";
 String[] tagValues = List.of("dev");
 Database database = new Database(this, "Database");
 S3Table table = S3Table.Builder.create(this, "Table")
         .database(database)
         .columns(List.of(Column.builder()
                 .name("col1")
                 .type(Schema.STRING)
                 .build(), Column.builder()
                 .name("col2")
                 .type(Schema.STRING)
                 .build()))
         .dataFormat(DataFormat.CSV)
         .build();
 DefaultStackSynthesizer synthesizer = (DefaultStackSynthesizer)stack.getSynthesizer();
 CfnDataLakeSettings.Builder.create(this, "DataLakeSettings")
         .admins(List.of(DataLakePrincipalProperty.builder()
                 .dataLakePrincipalIdentifier(stack.formatArn(ArnComponents.builder()
                         .service("iam")
                         .resource("role")
                         .region("")
                         .account(accountId)
                         .resourceName("Admin")
                         .build()))
                 .build(), DataLakePrincipalProperty.builder()
                 // The CDK cloudformation execution role.
                 .dataLakePrincipalIdentifier(synthesizer.cloudFormationExecutionRoleArn.replace("${AWS::Partition}", "aws"))
                 .build()))
         .build();
 CfnTag tag = CfnTag.Builder.create(this, "Tag")
         .catalogId(accountId)
         .tagKey(tagKey)
         .tagValues(tagValues)
         .build();
 LFTagPairProperty lfTagPairProperty = LFTagPairProperty.builder()
         .catalogId(accountId)
         .tagKey(tagKey)
         .tagValues(tagValues)
         .build();
 CfnTagAssociation tagAssociation = CfnTagAssociation.Builder.create(this, "TagAssociation")
         .lfTags(List.of(lfTagPairProperty))
         .resource(ResourceProperty.builder()
                 .tableWithColumns(TableWithColumnsResourceProperty.builder()
                         .databaseName(database.getDatabaseName())
                         .columnNames(List.of("col1", "col2"))
                         .catalogId(accountId)
                         .name(table.getTableName())
                         .build())
                 .build())
         .build();
 tagAssociation.node.addDependency(tag);
 tagAssociation.node.addDependency(table);
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datalakesettings.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnDataLakeSettings.Builder	A fluent builder for CfnDataLakeSettings.
static interface	CfnDataLakeSettings.DataLakePrincipalProperty	The Lake Formation principal.
static interface	CfnDataLakeSettings.PrincipalPermissionsProperty	Permissions granted to a principal.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.lakeformation.IDataLakeSettingsRef

IDataLakeSettingsRef.Jsii$Default, IDataLakeSettingsRef.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnDataLakeSettings(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDataLakeSettings(software.amazon.jsii.JsiiObjectRef objRef)
	CfnDataLakeSettings(software.constructs.Construct scope, String id)
	CfnDataLakeSettings(software.constructs.Construct scope, String id, CfnDataLakeSettingsProps props)

Method Summary

Modifier and Type	Method	Description
Object	getAdmins()	A list of AWS Lake Formation principals.
Object	getAllowExternalDataFiltering()	Whether to allow Amazon EMR clusters or other third-party query engines to access data managed by Lake Formation .
Object	getAllowFullTableExternalDataAccess()	Specifies whether query engines and applications can get credentials without IAM session tags if the user has full table access.
String	getAttrId()
List<String>	getAuthorizedSessionTagValueList()	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.
protected Map<String,Object>	getCfnProperties()
Object	getCreateDatabaseDefaultPermissions()	Specifies whether access control on a newly created database is managed by Lake Formation permissions or exclusively by IAM permissions.
Object	getCreateTableDefaultPermissions()	Specifies whether access control on a newly created table is managed by Lake Formation permissions or exclusively by IAM permissions.
DataLakeSettingsReference	getDataLakeSettingsRef()	A reference to a DataLakeSettings resource.
Object	getExternalDataFilteringAllowList()	A list of the account IDs of AWS accounts with Amazon EMR clusters or third-party engines that are allwed to perform data filtering.
String	getMutationType()	Specifies whether the data lake settings are updated by adding new values to the current settings ( APPEND ) or by replacing the current settings with new settings ( REPLACE ).
Object	getParameters()	A key-value map that provides an additional configuration on your data lake.
List<String>	getTrustedResourceOwners()	An array of UTF-8 strings.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAdmins(List<Object> value)	A list of AWS Lake Formation principals.
void	setAdmins(IResolvable value)	A list of AWS Lake Formation principals.
void	setAllowExternalDataFiltering(Boolean value)	Whether to allow Amazon EMR clusters or other third-party query engines to access data managed by Lake Formation .
void	setAllowExternalDataFiltering(IResolvable value)	Whether to allow Amazon EMR clusters or other third-party query engines to access data managed by Lake Formation .
void	setAllowFullTableExternalDataAccess(Boolean value)	Specifies whether query engines and applications can get credentials without IAM session tags if the user has full table access.
void	setAllowFullTableExternalDataAccess(IResolvable value)	Specifies whether query engines and applications can get credentials without IAM session tags if the user has full table access.
void	setAuthorizedSessionTagValueList(List<String> value)	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.
void	setCreateDatabaseDefaultPermissions(List<Object> value)	Specifies whether access control on a newly created database is managed by Lake Formation permissions or exclusively by IAM permissions.
void	setCreateDatabaseDefaultPermissions(IResolvable value)	Specifies whether access control on a newly created database is managed by Lake Formation permissions or exclusively by IAM permissions.
void	setCreateTableDefaultPermissions(List<Object> value)	Specifies whether access control on a newly created table is managed by Lake Formation permissions or exclusively by IAM permissions.
void	setCreateTableDefaultPermissions(IResolvable value)	Specifies whether access control on a newly created table is managed by Lake Formation permissions or exclusively by IAM permissions.
void	setExternalDataFilteringAllowList(List<Object> value)	A list of the account IDs of AWS accounts with Amazon EMR clusters or third-party engines that are allwed to perform data filtering.
void	setExternalDataFilteringAllowList(IResolvable value)	A list of the account IDs of AWS accounts with Amazon EMR clusters or third-party engines that are allwed to perform data filtering.
void	setMutationType(String value)	Specifies whether the data lake settings are updated by adding new values to the current settings ( APPEND ) or by replacing the current settings with new settings ( REPLACE ).
void	setParameters(Object value)	A key-value map that provides an additional configuration on your data lake.
void	setTrustedResourceOwners(List<String> value)	An array of UTF-8 strings.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnDataLakeSettings

protected CfnDataLakeSettings(software.amazon.jsii.JsiiObjectRef objRef)

CfnDataLakeSettings

protected CfnDataLakeSettings(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnDataLakeSettings

@Stability(Stable)
public CfnDataLakeSettings(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 CfnDataLakeSettingsProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties.

CfnDataLakeSettings

@Stability(Stable)
public CfnDataLakeSettings(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrId

@Stability(Stable)
@NotNull
public String getAttrId()

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getDataLakeSettingsRef

@Stability(Stable)
@NotNull
public DataLakeSettingsReference getDataLakeSettingsRef()

A reference to a DataLakeSettings resource.

Specified by:

getDataLakeSettingsRef in interface IDataLakeSettingsRef

getAdmins

@Stability(Stable)
@Nullable
public Object getAdmins()

A list of AWS Lake Formation principals.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDataLakeSettings.DataLakePrincipalProperty>

setAdmins

@Stability(Stable)
public void setAdmins(@Nullable
 IResolvable value)

A list of AWS Lake Formation principals.

setAdmins

@Stability(Stable)
public void setAdmins(@Nullable
 List<Object> value)

A list of AWS Lake Formation principals.

getAllowExternalDataFiltering

@Stability(Stable)
@Nullable
public Object getAllowExternalDataFiltering()

Whether to allow Amazon EMR clusters or other third-party query engines to access data managed by Lake Formation .

Returns union: either Boolean or IResolvable

setAllowExternalDataFiltering

@Stability(Stable)
public void setAllowExternalDataFiltering(@Nullable
 Boolean value)

Whether to allow Amazon EMR clusters or other third-party query engines to access data managed by Lake Formation .

setAllowExternalDataFiltering

@Stability(Stable)
public void setAllowExternalDataFiltering(@Nullable
 IResolvable value)

Whether to allow Amazon EMR clusters or other third-party query engines to access data managed by Lake Formation .

getAllowFullTableExternalDataAccess

@Stability(Stable)
@Nullable
public Object getAllowFullTableExternalDataAccess()

Specifies whether query engines and applications can get credentials without IAM session tags if the user has full table access.

Returns union: either Boolean or IResolvable

setAllowFullTableExternalDataAccess

@Stability(Stable)
public void setAllowFullTableExternalDataAccess(@Nullable
 Boolean value)

Specifies whether query engines and applications can get credentials without IAM session tags if the user has full table access.

setAllowFullTableExternalDataAccess

@Stability(Stable)
public void setAllowFullTableExternalDataAccess(@Nullable
 IResolvable value)

Specifies whether query engines and applications can get credentials without IAM session tags if the user has full table access.

getAuthorizedSessionTagValueList

@Stability(Stable)
@Nullable
public List<String> getAuthorizedSessionTagValueList()

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.

setAuthorizedSessionTagValueList

@Stability(Stable)
public void setAuthorizedSessionTagValueList(@Nullable
 List<String> value)

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.

getCreateDatabaseDefaultPermissions

@Stability(Stable)
@Nullable
public Object getCreateDatabaseDefaultPermissions()

Specifies whether access control on a newly created database is managed by Lake Formation permissions or exclusively by IAM permissions.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDataLakeSettings.PrincipalPermissionsProperty>

setCreateDatabaseDefaultPermissions

@Stability(Stable)
public void setCreateDatabaseDefaultPermissions(@Nullable
 IResolvable value)

Specifies whether access control on a newly created database is managed by Lake Formation permissions or exclusively by IAM permissions.

setCreateDatabaseDefaultPermissions

@Stability(Stable)
public void setCreateDatabaseDefaultPermissions(@Nullable
 List<Object> value)

Specifies whether access control on a newly created database is managed by Lake Formation permissions or exclusively by IAM permissions.

getCreateTableDefaultPermissions

@Stability(Stable)
@Nullable
public Object getCreateTableDefaultPermissions()

Specifies whether access control on a newly created table is managed by Lake Formation permissions or exclusively by IAM permissions.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDataLakeSettings.PrincipalPermissionsProperty>

setCreateTableDefaultPermissions

@Stability(Stable)
public void setCreateTableDefaultPermissions(@Nullable
 IResolvable value)

Specifies whether access control on a newly created table is managed by Lake Formation permissions or exclusively by IAM permissions.

setCreateTableDefaultPermissions

@Stability(Stable)
public void setCreateTableDefaultPermissions(@Nullable
 List<Object> value)

Specifies whether access control on a newly created table is managed by Lake Formation permissions or exclusively by IAM permissions.

getExternalDataFilteringAllowList

@Stability(Stable)
@Nullable
public Object getExternalDataFilteringAllowList()

A list of the account IDs of AWS accounts with Amazon EMR clusters or third-party engines that are allwed to perform data filtering.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDataLakeSettings.DataLakePrincipalProperty>

setExternalDataFilteringAllowList

@Stability(Stable)
public void setExternalDataFilteringAllowList(@Nullable
 IResolvable value)

A list of the account IDs of AWS accounts with Amazon EMR clusters or third-party engines that are allwed to perform data filtering.

setExternalDataFilteringAllowList

@Stability(Stable)
public void setExternalDataFilteringAllowList(@Nullable
 List<Object> value)

A list of the account IDs of AWS accounts with Amazon EMR clusters or third-party engines that are allwed to perform data filtering.

getMutationType

@Stability(Stable)
@Nullable
public String getMutationType()

Specifies whether the data lake settings are updated by adding new values to the current settings ( APPEND ) or by replacing the current settings with new settings ( REPLACE ).

setMutationType

@Stability(Stable)
public void setMutationType(@Nullable
 String value)

Specifies whether the data lake settings are updated by adding new values to the current settings ( APPEND ) or by replacing the current settings with new settings ( REPLACE ).

getParameters

@Stability(Stable)
@Nullable
public Object getParameters()

A key-value map that provides an additional configuration on your data lake.

setParameters

@Stability(Stable)
public void setParameters(@Nullable
 Object value)

A key-value map that provides an additional configuration on your data lake.

getTrustedResourceOwners

@Stability(Stable)
@Nullable
public List<String> getTrustedResourceOwners()

An array of UTF-8 strings.

setTrustedResourceOwners

@Stability(Stable)
public void setTrustedResourceOwners(@Nullable
 List<String> value)

An array of UTF-8 strings.