Interface DataLakeSettings.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<DataLakeSettings.Builder,
,DataLakeSettings> SdkBuilder<DataLakeSettings.Builder,
,DataLakeSettings> SdkPojo
- Enclosing class:
DataLakeSettings
-
Method Summary
Modifier and TypeMethodDescriptionallowExternalDataFiltering
(Boolean allowExternalDataFiltering) Whether to allow Amazon EMR clusters to access data managed by Lake Formation.allowFullTableExternalDataAccess
(Boolean allowFullTableExternalDataAccess) Whether to allow a third-party query engine to get data access credentials without session tags when a caller has full data access permissions.authorizedSessionTagValueList
(String... authorizedSessionTagValueList) 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.authorizedSessionTagValueList
(Collection<String> authorizedSessionTagValueList) 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
(Collection<PrincipalPermissions> createDatabaseDefaultPermissions) Specifies whether access control on newly created database is managed by Lake Formation permissions or exclusively by IAM permissions.createDatabaseDefaultPermissions
(Consumer<PrincipalPermissions.Builder>... createDatabaseDefaultPermissions) Specifies whether access control on newly created database is managed by Lake Formation permissions or exclusively by IAM permissions.createDatabaseDefaultPermissions
(PrincipalPermissions... createDatabaseDefaultPermissions) Specifies whether access control on newly created database is managed by Lake Formation permissions or exclusively by IAM permissions.createTableDefaultPermissions
(Collection<PrincipalPermissions> createTableDefaultPermissions) Specifies whether access control on newly created table is managed by Lake Formation permissions or exclusively by IAM permissions.createTableDefaultPermissions
(Consumer<PrincipalPermissions.Builder>... createTableDefaultPermissions) Specifies whether access control on newly created table is managed by Lake Formation permissions or exclusively by IAM permissions.createTableDefaultPermissions
(PrincipalPermissions... createTableDefaultPermissions) Specifies whether access control on newly created table is managed by Lake Formation permissions or exclusively by IAM permissions.dataLakeAdmins
(Collection<DataLakePrincipal> dataLakeAdmins) A list of Lake Formation principals.dataLakeAdmins
(Consumer<DataLakePrincipal.Builder>... dataLakeAdmins) A list of Lake Formation principals.dataLakeAdmins
(DataLakePrincipal... dataLakeAdmins) A list of Lake Formation principals.externalDataFilteringAllowList
(Collection<DataLakePrincipal> externalDataFilteringAllowList) A list of the account IDs of Amazon Web Services accounts with Amazon EMR clusters that are to perform data filtering.>externalDataFilteringAllowList
(Consumer<DataLakePrincipal.Builder>... externalDataFilteringAllowList) A list of the account IDs of Amazon Web Services accounts with Amazon EMR clusters that are to perform data filtering.>externalDataFilteringAllowList
(DataLakePrincipal... externalDataFilteringAllowList) A list of the account IDs of Amazon Web Services accounts with Amazon EMR clusters that are to perform data filtering.>parameters
(Map<String, String> parameters) A key-value map that provides an additional configuration on your data lake.readOnlyAdmins
(Collection<DataLakePrincipal> readOnlyAdmins) A list of Lake Formation principals with only view access to the resources, without the ability to make changes.readOnlyAdmins
(Consumer<DataLakePrincipal.Builder>... readOnlyAdmins) A list of Lake Formation principals with only view access to the resources, without the ability to make changes.readOnlyAdmins
(DataLakePrincipal... readOnlyAdmins) A list of Lake Formation principals with only view access to the resources, without the ability to make changes.trustedResourceOwners
(String... trustedResourceOwners) A list of the resource-owning account IDs that the caller's account can use to share their user access details (user ARNs).trustedResourceOwners
(Collection<String> trustedResourceOwners) A list of the resource-owning account IDs that the caller's account can use to share their user access details (user ARNs).Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
dataLakeAdmins
A list of Lake Formation principals. Supported principals are IAM users or IAM roles.
- Parameters:
dataLakeAdmins
- A list of Lake Formation principals. Supported principals are IAM users or IAM roles.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dataLakeAdmins
A list of Lake Formation principals. Supported principals are IAM users or IAM roles.
- Parameters:
dataLakeAdmins
- A list of Lake Formation principals. Supported principals are IAM users or IAM roles.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dataLakeAdmins
A list of Lake Formation principals. Supported principals are IAM users or IAM roles.
This is a convenience method that creates an instance of theDataLakePrincipal.Builder
avoiding the need to create one manually viaDataLakePrincipal.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todataLakeAdmins(List<DataLakePrincipal>)
.- Parameters:
dataLakeAdmins
- a consumer that will call methods onDataLakePrincipal.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
readOnlyAdmins
A list of Lake Formation principals with only view access to the resources, without the ability to make changes. Supported principals are IAM users or IAM roles.
- Parameters:
readOnlyAdmins
- A list of Lake Formation principals with only view access to the resources, without the ability to make changes. Supported principals are IAM users or IAM roles.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
readOnlyAdmins
A list of Lake Formation principals with only view access to the resources, without the ability to make changes. Supported principals are IAM users or IAM roles.
- Parameters:
readOnlyAdmins
- A list of Lake Formation principals with only view access to the resources, without the ability to make changes. Supported principals are IAM users or IAM roles.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
readOnlyAdmins
A list of Lake Formation principals with only view access to the resources, without the ability to make changes. Supported principals are IAM users or IAM roles.
This is a convenience method that creates an instance of theDataLakePrincipal.Builder
avoiding the need to create one manually viaDataLakePrincipal.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toreadOnlyAdmins(List<DataLakePrincipal>)
.- Parameters:
readOnlyAdmins
- a consumer that will call methods onDataLakePrincipal.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
createDatabaseDefaultPermissions
DataLakeSettings.Builder createDatabaseDefaultPermissions(Collection<PrincipalPermissions> createDatabaseDefaultPermissions) Specifies whether access control on newly created database is managed by Lake Formation permissions or exclusively by IAM permissions.
A null value indicates access control by Lake Formation permissions. A value that assigns ALL to IAM_ALLOWED_PRINCIPALS indicates access control by IAM permissions. This is referred to as the setting "Use only IAM access control," and is for backward compatibility with the 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 to IAM_ALLOWED_PRINCIPALS.
For more information, see Changing the Default Security Settings for Your Data Lake.
- Parameters:
createDatabaseDefaultPermissions
- Specifies whether access control on newly created database is managed by Lake Formation permissions or exclusively by IAM permissions.A null value indicates access control by Lake Formation permissions. A value that assigns ALL to IAM_ALLOWED_PRINCIPALS indicates access control by IAM permissions. This is referred to as the setting "Use only IAM access control," and is for backward compatibility with the 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 to IAM_ALLOWED_PRINCIPALS.
For more information, see Changing the Default Security Settings for Your Data Lake.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
createDatabaseDefaultPermissions
DataLakeSettings.Builder createDatabaseDefaultPermissions(PrincipalPermissions... createDatabaseDefaultPermissions) Specifies whether access control on newly created database is managed by Lake Formation permissions or exclusively by IAM permissions.
A null value indicates access control by Lake Formation permissions. A value that assigns ALL to IAM_ALLOWED_PRINCIPALS indicates access control by IAM permissions. This is referred to as the setting "Use only IAM access control," and is for backward compatibility with the 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 to IAM_ALLOWED_PRINCIPALS.
For more information, see Changing the Default Security Settings for Your Data Lake.
- Parameters:
createDatabaseDefaultPermissions
- Specifies whether access control on newly created database is managed by Lake Formation permissions or exclusively by IAM permissions.A null value indicates access control by Lake Formation permissions. A value that assigns ALL to IAM_ALLOWED_PRINCIPALS indicates access control by IAM permissions. This is referred to as the setting "Use only IAM access control," and is for backward compatibility with the 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 to IAM_ALLOWED_PRINCIPALS.
For more information, see Changing the Default Security Settings for Your Data Lake.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
createDatabaseDefaultPermissions
DataLakeSettings.Builder createDatabaseDefaultPermissions(Consumer<PrincipalPermissions.Builder>... createDatabaseDefaultPermissions) Specifies whether access control on newly created database is managed by Lake Formation permissions or exclusively by IAM permissions.
A null value indicates access control by Lake Formation permissions. A value that assigns ALL to IAM_ALLOWED_PRINCIPALS indicates access control by IAM permissions. This is referred to as the setting "Use only IAM access control," and is for backward compatibility with the 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 to IAM_ALLOWED_PRINCIPALS.
For more information, see Changing the Default Security Settings for Your Data Lake.
This is a convenience method that creates an instance of thePrincipalPermissions.Builder
avoiding the need to create one manually viaPrincipalPermissions.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocreateDatabaseDefaultPermissions(List<PrincipalPermissions>)
.- Parameters:
createDatabaseDefaultPermissions
- a consumer that will call methods onPrincipalPermissions.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
createTableDefaultPermissions
DataLakeSettings.Builder createTableDefaultPermissions(Collection<PrincipalPermissions> createTableDefaultPermissions) Specifies whether access control on newly created table is managed by Lake Formation permissions or exclusively by IAM permissions.
A null value indicates access control by Lake Formation permissions. A value that assigns ALL to IAM_ALLOWED_PRINCIPALS indicates access control by IAM permissions. This is referred to as the setting "Use only IAM access control," and is for backward compatibility with the 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 to IAM_ALLOWED_PRINCIPALS.
For more information, see Changing the Default Security Settings for Your Data Lake.
- Parameters:
createTableDefaultPermissions
- Specifies whether access control on newly created table is managed by Lake Formation permissions or exclusively by IAM permissions.A null value indicates access control by Lake Formation permissions. A value that assigns ALL to IAM_ALLOWED_PRINCIPALS indicates access control by IAM permissions. This is referred to as the setting "Use only IAM access control," and is for backward compatibility with the 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 to IAM_ALLOWED_PRINCIPALS.
For more information, see Changing the Default Security Settings for Your Data Lake.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
createTableDefaultPermissions
DataLakeSettings.Builder createTableDefaultPermissions(PrincipalPermissions... createTableDefaultPermissions) Specifies whether access control on newly created table is managed by Lake Formation permissions or exclusively by IAM permissions.
A null value indicates access control by Lake Formation permissions. A value that assigns ALL to IAM_ALLOWED_PRINCIPALS indicates access control by IAM permissions. This is referred to as the setting "Use only IAM access control," and is for backward compatibility with the 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 to IAM_ALLOWED_PRINCIPALS.
For more information, see Changing the Default Security Settings for Your Data Lake.
- Parameters:
createTableDefaultPermissions
- Specifies whether access control on newly created table is managed by Lake Formation permissions or exclusively by IAM permissions.A null value indicates access control by Lake Formation permissions. A value that assigns ALL to IAM_ALLOWED_PRINCIPALS indicates access control by IAM permissions. This is referred to as the setting "Use only IAM access control," and is for backward compatibility with the 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 to IAM_ALLOWED_PRINCIPALS.
For more information, see Changing the Default Security Settings for Your Data Lake.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
createTableDefaultPermissions
DataLakeSettings.Builder createTableDefaultPermissions(Consumer<PrincipalPermissions.Builder>... createTableDefaultPermissions) Specifies whether access control on newly created table is managed by Lake Formation permissions or exclusively by IAM permissions.
A null value indicates access control by Lake Formation permissions. A value that assigns ALL to IAM_ALLOWED_PRINCIPALS indicates access control by IAM permissions. This is referred to as the setting "Use only IAM access control," and is for backward compatibility with the 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 to IAM_ALLOWED_PRINCIPALS.
For more information, see Changing the Default Security Settings for Your Data Lake.
This is a convenience method that creates an instance of thePrincipalPermissions.Builder
avoiding the need to create one manually viaPrincipalPermissions.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocreateTableDefaultPermissions(List<PrincipalPermissions>)
.- Parameters:
createTableDefaultPermissions
- a consumer that will call methods onPrincipalPermissions.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
parameters
A key-value map that provides an additional configuration on your data lake. CROSS_ACCOUNT_VERSION is the key you can configure in the Parameters field. Accepted values for the CrossAccountVersion key are 1, 2, 3, and 4.
- Parameters:
parameters
- A key-value map that provides an additional configuration on your data lake. CROSS_ACCOUNT_VERSION is the key you can configure in the Parameters field. Accepted values for the CrossAccountVersion key are 1, 2, 3, and 4.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
trustedResourceOwners
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.
- Parameters:
trustedResourceOwners
- 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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
trustedResourceOwners
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.
- Parameters:
trustedResourceOwners
- 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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
allowExternalDataFiltering
Whether to allow Amazon EMR clusters to access data managed by Lake Formation.
If true, you allow Amazon EMR clusters to access data in Amazon S3 locations that are registered with Lake Formation.
If false or null, no Amazon EMR clusters will be able to access data in Amazon S3 locations that are registered with Lake Formation.
For more information, see (Optional) Allow external data filtering.
- Parameters:
allowExternalDataFiltering
- Whether to allow Amazon EMR clusters to access data managed by Lake Formation.If true, you allow Amazon EMR clusters to access data in Amazon S3 locations that are registered with Lake Formation.
If false or null, no Amazon EMR clusters will be able to access data in Amazon S3 locations that are registered with Lake Formation.
For more information, see (Optional) Allow external data filtering.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
allowFullTableExternalDataAccess
Whether to allow a third-party query engine to get data access credentials without session tags when a caller has full data access permissions.
- Parameters:
allowFullTableExternalDataAccess
- Whether to allow a third-party query engine to get data access credentials without session tags when a caller has full data access permissions.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
externalDataFilteringAllowList
DataLakeSettings.Builder externalDataFilteringAllowList(Collection<DataLakePrincipal> externalDataFilteringAllowList) A list of the account IDs of Amazon Web Services accounts with Amazon EMR clusters that are to perform data filtering.>
- Parameters:
externalDataFilteringAllowList
- A list of the account IDs of Amazon Web Services accounts with Amazon EMR clusters that are to perform data filtering.>- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
externalDataFilteringAllowList
DataLakeSettings.Builder externalDataFilteringAllowList(DataLakePrincipal... externalDataFilteringAllowList) A list of the account IDs of Amazon Web Services accounts with Amazon EMR clusters that are to perform data filtering.>
- Parameters:
externalDataFilteringAllowList
- A list of the account IDs of Amazon Web Services accounts with Amazon EMR clusters that are to perform data filtering.>- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
externalDataFilteringAllowList
DataLakeSettings.Builder externalDataFilteringAllowList(Consumer<DataLakePrincipal.Builder>... externalDataFilteringAllowList) A list of the account IDs of Amazon Web Services accounts with Amazon EMR clusters that are to perform data filtering.>
This is a convenience method that creates an instance of theDataLakePrincipal.Builder
avoiding the need to create one manually viaDataLakePrincipal.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toexternalDataFilteringAllowList(List<DataLakePrincipal>)
.- Parameters:
externalDataFilteringAllowList
- a consumer that will call methods onDataLakePrincipal.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
authorizedSessionTagValueList
DataLakeSettings.Builder authorizedSessionTagValueList(Collection<String> authorizedSessionTagValueList) 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 APIs.
- Parameters:
authorizedSessionTagValueList
- 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 APIs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
authorizedSessionTagValueList
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 APIs.
- Parameters:
authorizedSessionTagValueList
- 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 APIs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-