Package software.amazon.awscdk.services.lakeformation

Class CfnDataLakeSettings.Builder

java.lang.Object

software.amazon.awscdk.services.lakeformation.CfnDataLakeSettings.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDataLakeSettings>

Enclosing class:

CfnDataLakeSettings

@Stability(Stable)
public static final class CfnDataLakeSettings.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDataLakeSettings>

A fluent builder for CfnDataLakeSettings.

Method Summary

Modifier and Type	Method	Description
CfnDataLakeSettings.Builder	admins(List<? extends Object> admins)	A list of AWS Lake Formation principals.
CfnDataLakeSettings.Builder	admins(IResolvable admins)	A list of AWS Lake Formation principals.
CfnDataLakeSettings.Builder	allowExternalDataFiltering(Boolean allowExternalDataFiltering)	Whether to allow Amazon EMR clusters or other third-party query engines to access data managed by Lake Formation .
CfnDataLakeSettings.Builder	allowExternalDataFiltering(IResolvable allowExternalDataFiltering)	Whether to allow Amazon EMR clusters or other third-party query engines to access data managed by Lake Formation .
CfnDataLakeSettings.Builder	allowFullTableExternalDataAccess(Boolean allowFullTableExternalDataAccess)	Specifies whether query engines and applications can get credentials without IAM session tags if the user has full table access.
CfnDataLakeSettings.Builder	allowFullTableExternalDataAccess(IResolvable allowFullTableExternalDataAccess)	Specifies whether query engines and applications can get credentials without IAM session tags if the user has full table access.
CfnDataLakeSettings.Builder	authorizedSessionTagValueList(List<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.
CfnDataLakeSettings	build()
static CfnDataLakeSettings.Builder	create(software.constructs.Construct scope, String id)
CfnDataLakeSettings.Builder	createDatabaseDefaultPermissions(List<? extends Object> createDatabaseDefaultPermissions)	Specifies whether access control on a newly created database is managed by Lake Formation permissions or exclusively by IAM permissions.
CfnDataLakeSettings.Builder	createDatabaseDefaultPermissions(IResolvable createDatabaseDefaultPermissions)	Specifies whether access control on a newly created database is managed by Lake Formation permissions or exclusively by IAM permissions.
CfnDataLakeSettings.Builder	createTableDefaultPermissions(List<? extends Object> createTableDefaultPermissions)	Specifies whether access control on a newly created table is managed by Lake Formation permissions or exclusively by IAM permissions.
CfnDataLakeSettings.Builder	createTableDefaultPermissions(IResolvable createTableDefaultPermissions)	Specifies whether access control on a newly created table is managed by Lake Formation permissions or exclusively by IAM permissions.
CfnDataLakeSettings.Builder	externalDataFilteringAllowList(List<? extends Object> externalDataFilteringAllowList)	A list of the account IDs of AWS accounts with Amazon EMR clusters or third-party engines that are allwed to perform data filtering.
CfnDataLakeSettings.Builder	externalDataFilteringAllowList(IResolvable externalDataFilteringAllowList)	A list of the account IDs of AWS accounts with Amazon EMR clusters or third-party engines that are allwed to perform data filtering.
CfnDataLakeSettings.Builder	mutationType(String mutationType)	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 ).
CfnDataLakeSettings.Builder	parameters(Object parameters)	A key-value map that provides an additional configuration on your data lake.
CfnDataLakeSettings.Builder	trustedResourceOwners(List<String> trustedResourceOwners)	An array of UTF-8 strings.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnDataLakeSettings.Builder create(software.constructs.Construct scope,
 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.

Returns:

a new instance of CfnDataLakeSettings.Builder.

admins

@Stability(Stable)
public CfnDataLakeSettings.Builder admins(IResolvable admins)

A list of AWS Lake Formation principals.

Parameters:

admins - A list of AWS Lake Formation principals. This parameter is required.

Returns:

this

See Also:

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

admins

@Stability(Stable)
public CfnDataLakeSettings.Builder admins(List<? extends Object> admins)

A list of AWS Lake Formation principals.

Parameters:

admins - A list of AWS Lake Formation principals. This parameter is required.

Returns:

this

See Also:

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

allowExternalDataFiltering

@Stability(Stable)
public CfnDataLakeSettings.Builder allowExternalDataFiltering(Boolean allowExternalDataFiltering)

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 .

Parameters:

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

Returns:

this

See Also:

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

allowExternalDataFiltering

@Stability(Stable)
public CfnDataLakeSettings.Builder allowExternalDataFiltering(IResolvable allowExternalDataFiltering)

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 .

Parameters:

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

Returns:

this

See Also:

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

allowFullTableExternalDataAccess

@Stability(Stable)
public CfnDataLakeSettings.Builder allowFullTableExternalDataAccess(Boolean allowFullTableExternalDataAccess)

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.

For more information, see

Parameters:

allowFullTableExternalDataAccess - Specifies whether query engines and applications can get credentials without IAM session tags if the user has full table access. This parameter is required.

Returns:

this

See Also:

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

allowFullTableExternalDataAccess

@Stability(Stable)
public CfnDataLakeSettings.Builder allowFullTableExternalDataAccess(IResolvable allowFullTableExternalDataAccess)

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.

For more information, see

Parameters:

allowFullTableExternalDataAccess - Specifies whether query engines and applications can get credentials without IAM session tags if the user has full table access. This parameter is required.

Returns:

this

See Also:

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

authorizedSessionTagValueList

@Stability(Stable)
public CfnDataLakeSettings.Builder authorizedSessionTagValueList(List<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 API operations.

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. This parameter is required.

Returns:

this

See Also:

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

createDatabaseDefaultPermissions

@Stability(Stable)
public CfnDataLakeSettings.Builder createDatabaseDefaultPermissions(IResolvable createDatabaseDefaultPermissions)

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 to IAM_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 to IAM_ALLOWED_PRINCIPALS .

For more information, see Changing the default security settings for your data lake .

Parameters:

createDatabaseDefaultPermissions - Specifies whether access control on a newly created database is managed by Lake Formation permissions or exclusively by IAM permissions. This parameter is required.

Returns:

this

See Also:

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

createDatabaseDefaultPermissions

@Stability(Stable)
public CfnDataLakeSettings.Builder createDatabaseDefaultPermissions(List<? extends Object> createDatabaseDefaultPermissions)

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 to IAM_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 to IAM_ALLOWED_PRINCIPALS .

For more information, see Changing the default security settings for your data lake .

Parameters:

createDatabaseDefaultPermissions - Specifies whether access control on a newly created database is managed by Lake Formation permissions or exclusively by IAM permissions. This parameter is required.

Returns:

this

See Also:

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

createTableDefaultPermissions

@Stability(Stable)
public CfnDataLakeSettings.Builder createTableDefaultPermissions(IResolvable createTableDefaultPermissions)

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 to IAM_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 to IAM_ALLOWED_PRINCIPALS .

For more information, see Changing the default security settings for your data lake .

Parameters:

createTableDefaultPermissions - Specifies whether access control on a newly created table is managed by Lake Formation permissions or exclusively by IAM permissions. This parameter is required.

Returns:

this

See Also:

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

createTableDefaultPermissions

@Stability(Stable)
public CfnDataLakeSettings.Builder createTableDefaultPermissions(List<? extends Object> createTableDefaultPermissions)

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 to IAM_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 to IAM_ALLOWED_PRINCIPALS .

For more information, see Changing the default security settings for your data lake .

Parameters:

createTableDefaultPermissions - Specifies whether access control on a newly created table is managed by Lake Formation permissions or exclusively by IAM permissions. This parameter is required.

Returns:

this

See Also:

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

externalDataFilteringAllowList

@Stability(Stable)
public CfnDataLakeSettings.Builder externalDataFilteringAllowList(IResolvable externalDataFilteringAllowList)

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

Parameters:

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

Returns:

this

See Also:

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

externalDataFilteringAllowList

@Stability(Stable)
public CfnDataLakeSettings.Builder externalDataFilteringAllowList(List<? extends Object> externalDataFilteringAllowList)

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

Parameters:

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

Returns:

this

See Also:

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

mutationType

@Stability(Stable)
public CfnDataLakeSettings.Builder mutationType(String mutationType)

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.

Parameters:

mutationType - 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 ). This parameter is required.

Returns:

this

See Also:

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

parameters

@Stability(Stable)
public CfnDataLakeSettings.Builder parameters(Object parameters)

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

CrossAccountVersion is the key you can configure in the Parameters field. Accepted values for the CrossAccountVersion key are 1, 2, and 3.

Parameters:

parameters - A key-value map that provides an additional configuration on your data lake. This parameter is required.

Returns:

this

See Also:

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

trustedResourceOwners

@Stability(Stable)
public CfnDataLakeSettings.Builder trustedResourceOwners(List<String> trustedResourceOwners)

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.

Parameters:

trustedResourceOwners - An array of UTF-8 strings. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnDataLakeSettings build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnDataLakeSettings>

Returns:

a newly built instance of CfnDataLakeSettings.