Interface CfnDataLakeSettingsProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnDataLakeSettingsProps.Jsii$Proxy
CfnDataLakeSettings
.
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:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnDataLakeSettingsProps
static final class
An implementation forCfnDataLakeSettingsProps
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default Object
A list of AWS Lake Formation principals.default Object
Whether to allow Amazon EMR clusters or other third-party query engines to access data managed by Lake Formation .default Object
Specifies whether query engines and applications can get credentials without IAM session tags if the user has full table access.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.default Object
Specifies whether access control on a newly created database is managed by Lake Formation permissions or exclusively by IAM permissions.default Object
Specifies whether access control on a newly created table is managed by Lake Formation permissions or exclusively by IAM permissions.default Object
A list of the account IDs of AWS accounts with Amazon EMR clusters or third-party engines that are allwed to perform data filtering.default String
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
).default Object
A key-value map that provides an additional configuration on your data lake.An array of UTF-8 strings.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getAdmins
A list of AWS Lake Formation principals.- See Also:
-
getAllowExternalDataFiltering
Whether to allow Amazon EMR clusters or other third-party query engines to access data managed by Lake Formation .If set to true, you allow Amazon EMR clusters or other third-party engines to access data in Amazon S3 locations that are registered with Lake Formation .
If false or null, no third-party query engines will be able to access data in Amazon S3 locations that are registered with Lake Formation.
For more information, see External data filtering setting .
- See Also:
-
getAllowFullTableExternalDataAccess
Specifies whether query engines and applications can get credentials without IAM session tags if the user has full table access.It provides query engines and applications performance benefits as well as simplifies data access. Amazon EMR on Amazon EC2 is able to leverage this setting.
- See Also:
-
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.Lake Formation will publish the acceptable key-value pair, for example key = "LakeFormationTrustedCaller" and value = "TRUE" and the third party integrator must properly tag the temporary security credentials that will be used to call Lake Formation 's administrative API operations.
- See Also:
-
getCreateDatabaseDefaultPermissions
Specifies whether access control on a newly created database is managed by Lake Formation permissions or exclusively by IAM permissions.A null value indicates that the access is controlled by Lake Formation permissions.
ALL
permissions assigned toIAM_ALLOWED_PRINCIPALS
group indicates that the user's IAM permissions determine the access to the database. This is referred to as the setting "Use only IAM access control," and is to support backward compatibility with the AWS Glue permission model implemented by IAM permissions.The only permitted values are an empty array or an array that contains a single JSON object that grants
ALL
toIAM_ALLOWED_PRINCIPALS
.For more information, see Changing the default security settings for your data lake .
- See Also:
-
getCreateTableDefaultPermissions
Specifies whether access control on a newly created table is managed by Lake Formation permissions or exclusively by IAM permissions.A null value indicates that the access is controlled by Lake Formation permissions.
ALL
permissions assigned toIAM_ALLOWED_PRINCIPALS
group indicate that the user's IAM permissions determine the access to the table. This is referred to as the setting "Use only IAM access control," and is to support the backward compatibility with the AWS Glue permission model implemented by IAM permissions.The only permitted values are an empty array or an array that contains a single JSON object that grants
ALL
permissions toIAM_ALLOWED_PRINCIPALS
.For more information, see Changing the default security settings for your data lake .
- See Also:
-
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.- See Also:
-
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
).If you choose
REPLACE
, your current data lake settings will be replaced with the new values in your template.- See Also:
-
getParameters
A key-value map that provides an additional configuration on your data lake.CrossAccountVersion
is the key you can configure in theParameters
field. Accepted values for theCrossAccountVersion
key are 1, 2, and 3.- See Also:
-
getTrustedResourceOwners
An array of UTF-8 strings.A list of the resource-owning account IDs that the caller's account can use to share their user access details (user ARNs). The user ARNs can be logged in the resource owner's CloudTrail log. You may want to specify this property when you are in a high-trust boundary, such as the same team or company.
- See Also:
-
builder
- Returns:
- a
CfnDataLakeSettingsProps.Builder
ofCfnDataLakeSettingsProps
-