1.204.0

class CfnDataLakeSettings (construct)

LanguageType name
.NETAmazon.CDK.AWS.LakeFormation.CfnDataLakeSettings
Javasoftware.amazon.awscdk.services.lakeformation.CfnDataLakeSettings
Pythonaws_cdk.aws_lakeformation.CfnDataLakeSettings
TypeScript @aws-cdk/aws-lakeformation » CfnDataLakeSettings

Implements IConstruct, IConstruct, IDependable, IInspectable

A CloudFormation AWS::LakeFormation::DataLakeSettings.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as lakeformation from '@aws-cdk/aws-lakeformation';

declare const parameters: any;
const cfnDataLakeSettings = new lakeformation.CfnDataLakeSettings(this, 'MyCfnDataLakeSettings', /* all optional props */ {
  admins: [{
    dataLakePrincipalIdentifier: 'dataLakePrincipalIdentifier',
  }],
  allowExternalDataFiltering: false,
  authorizedSessionTagValueList: ['authorizedSessionTagValueList'],
  createDatabaseDefaultPermissions: [{
    permissions: ['permissions'],
    principal: {
      dataLakePrincipalIdentifier: 'dataLakePrincipalIdentifier',
    },
  }],
  createTableDefaultPermissions: [{
    permissions: ['permissions'],
    principal: {
      dataLakePrincipalIdentifier: 'dataLakePrincipalIdentifier',
    },
  }],
  externalDataFilteringAllowList: [{
    dataLakePrincipalIdentifier: 'dataLakePrincipalIdentifier',
  }],
  parameters: parameters,
  trustedResourceOwners: ['trustedResourceOwners'],
});

Initializer

new CfnDataLakeSettings(scope: Construct, id: string, props?: CfnDataLakeSettingsProps)

Parameters

  • scope Construct — - scope in which this resource is defined.
  • id string — - scoped id of the resource.
  • props CfnDataLakeSettingsProps — - resource properties.

Create a new AWS::LakeFormation::DataLakeSettings.

Construct Props

NameTypeDescription
admins?IResolvable | IResolvable | DataLakePrincipalProperty[]A list of AWS Lake Formation principals.
allowExternalDataFiltering?boolean | IResolvableWhether to allow Amazon EMR clusters or other third-party query engines to access data managed by Lake Formation .
authorizedSessionTagValueList?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?IResolvable | IResolvable | PrincipalPermissionsProperty[]Specifies whether access control on a newly created database is managed by Lake Formation permissions or exclusively by IAM permissions.
createTableDefaultPermissions?IResolvable | IResolvable | PrincipalPermissionsProperty[]Specifies whether access control on a newly created table is managed by Lake Formation permissions or exclusively by IAM permissions.
externalDataFilteringAllowList?IResolvable | IResolvable | DataLakePrincipalProperty[]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?anyA key-value map that provides an additional configuration on your data lake.
trustedResourceOwners?string[]An array of UTF-8 strings.

admins?

Type: IResolvable | IResolvable | DataLakePrincipalProperty[] (optional)

A list of AWS Lake Formation principals.

allowExternalDataFiltering?

Type: boolean | IResolvable (optional)

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 .

authorizedSessionTagValueList?

Type: string[] (optional)

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.

createDatabaseDefaultPermissions?

Type: IResolvable | IResolvable | PrincipalPermissionsProperty[] (optional)

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 .

createTableDefaultPermissions?

Type: IResolvable | IResolvable | PrincipalPermissionsProperty[] (optional)

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 .

externalDataFilteringAllowList?

Type: IResolvable | IResolvable | DataLakePrincipalProperty[] (optional)

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?

Type: any (optional)

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.

trustedResourceOwners?

Type: string[] (optional)

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.

Properties

NameTypeDescription
cfnOptionsICfnResourceOptionsOptions for this resource, such as condition, update policy etc.
cfnProperties{ [string]: any }
cfnResourceTypestringAWS resource type.
creationStackstring[]
logicalIdstringThe logical ID for this CloudFormation stack element.
nodeConstructNodeThe construct tree node associated with this construct.
parametersanyA key-value map that provides an additional configuration on your data lake.
refstringReturn a string that will be resolved to a CloudFormation { Ref } for this element.
stackStackThe stack in which this element is defined.
admins?IResolvable | IResolvable | DataLakePrincipalProperty[]A list of AWS Lake Formation principals.
allowExternalDataFiltering?boolean | IResolvableWhether to allow Amazon EMR clusters or other third-party query engines to access data managed by Lake Formation .
authorizedSessionTagValueList?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?IResolvable | IResolvable | PrincipalPermissionsProperty[]Specifies whether access control on a newly created database is managed by Lake Formation permissions or exclusively by IAM permissions.
createTableDefaultPermissions?IResolvable | IResolvable | PrincipalPermissionsProperty[]Specifies whether access control on a newly created table is managed by Lake Formation permissions or exclusively by IAM permissions.
externalDataFilteringAllowList?IResolvable | IResolvable | DataLakePrincipalProperty[]A list of the account IDs of AWS accounts with Amazon EMR clusters or third-party engines that are allwed to perform data filtering.
trustedResourceOwners?string[]An array of UTF-8 strings.
static CFN_RESOURCE_TYPE_NAMEstringThe CloudFormation resource type name for this resource class.

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

creationStack

Type: string[]

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

node

Type: ConstructNode

The construct tree node associated with this construct.

parameters

Type: any

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.

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

admins?

Type: IResolvable | IResolvable | DataLakePrincipalProperty[] (optional)

A list of AWS Lake Formation principals.

allowExternalDataFiltering?

Type: boolean | IResolvable (optional)

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 .

authorizedSessionTagValueList?

Type: string[] (optional)

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.

createDatabaseDefaultPermissions?

Type: IResolvable | IResolvable | PrincipalPermissionsProperty[] (optional)

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 .

createTableDefaultPermissions?

Type: IResolvable | IResolvable | PrincipalPermissionsProperty[] (optional)

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 .

externalDataFilteringAllowList?

Type: IResolvable | IResolvable | DataLakePrincipalProperty[] (optional)

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

trustedResourceOwners?

Type: string[] (optional)

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.

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

NameDescription
addDeletionOverride(path)Syntactic sugar for addOverride(path, undefined).
addDependsOn(target)Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName)Returns a token for an runtime attribute of this resource.
getMetadata(key)Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)Examines the CloudFormation resource and discloses attributes.
overrideLogicalId(newLogicalId)Overrides the auto-generated logical ID with a specific ID.
toString()Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

  • path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependsOn(target)

public addDependsOn(target: CfnResource): void

Parameters

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

  • key string
  • value any

Add a value to the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

  • path string — - The path of the property, you can use dot notation to override values in complex types.
  • value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

  • propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

  • propertyPath string — The path of the property.
  • value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

getAtt(attributeName)

public getAtt(attributeName: string): Reference

Parameters

  • attributeName string — The name of the attribute.

Returns

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

getMetadata(key)

public getMetadata(key: string): any

Parameters

  • key string

Returns

  • any

Retrieve a value value from the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

  • inspector TreeInspector — - tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

  • newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

toString()

public toString(): string

Returns

  • string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

  • props { [string]: any }

Returns

  • { [string]: any }
← PreviousNext →