class CfnDataLakeSettings (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.LakeFormation.CfnDataLakeSettings |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awslakeformation#CfnDataLakeSettings |
![]() | software.amazon.awscdk.services.lakeformation.CfnDataLakeSettings |
![]() | aws_cdk.aws_lakeformation.CfnDataLakeSettings |
![]() | aws-cdk-lib » aws_lakeformation » CfnDataLakeSettings |
Implements
IConstruct
, IDependable
, IInspectable
The AWS::LakeFormation::DataLakeSettings
resource is an AWS Lake Formation resource type that manages the data lake settings for your account.
Example
import * as cdk from 'aws-cdk-lib';
import { S3Table, Database, DataFormat, Schema } from '@aws-cdk/aws-glue-alpha';
import { CfnDataLakeSettings, CfnTag, CfnTagAssociation } from 'aws-cdk-lib/aws-lakeformation';
declare const stack: cdk.Stack;
declare const accountId: string;
const tagKey = 'aws';
const tagValues = ['dev'];
const database = new Database(this, 'Database');
const table = new S3Table(this, 'Table', {
database,
columns: [
{
name: 'col1',
type: Schema.STRING,
},
{
name: 'col2',
type: Schema.STRING,
}
],
dataFormat: DataFormat.CSV,
});
const synthesizer = stack.synthesizer as cdk.DefaultStackSynthesizer;
new CfnDataLakeSettings(this, 'DataLakeSettings', {
admins: [
{
dataLakePrincipalIdentifier: stack.formatArn({
service: 'iam',
resource: 'role',
region: '',
account: accountId,
resourceName: 'Admin',
}),
},
{
// The CDK cloudformation execution role.
dataLakePrincipalIdentifier: synthesizer.cloudFormationExecutionRoleArn.replace('${AWS::Partition}', 'aws'),
},
],
});
const tag = new CfnTag(this, 'Tag', {
catalogId: accountId,
tagKey,
tagValues,
});
const lfTagPairProperty: CfnTagAssociation.LFTagPairProperty = {
catalogId: accountId,
tagKey,
tagValues,
};
const tagAssociation = new CfnTagAssociation(this, 'TagAssociation', {
lfTags: [lfTagPairProperty],
resource: {
tableWithColumns: {
databaseName: database.databaseName,
columnNames: ['col1', 'col2'],
catalogId: accountId,
name: table.tableName,
}
}
});
tagAssociation.node.addDependency(tag);
tagAssociation.node.addDependency(table);
Initializer
new CfnDataLakeSettings(scope: Construct, id: string, props?: CfnDataLakeSettingsProps)
Parameters
- scope
Construct
— Scope in which this resource is defined. - id
string
— Construct identifier for this resource (unique in its scope). - props
Cfn
— Resource properties.Data Lake Settings Props
Construct Props
Name | Type | Description |
---|---|---|
admins? | IResolvable | IResolvable | Data [] | A list of AWS Lake Formation principals. |
allow | boolean | IResolvable | Whether to allow Amazon EMR clusters or other third-party query engines to access data managed by Lake Formation . |
allow | boolean | IResolvable | Specifies whether query engines and applications can get credentials without IAM session tags if the user has full table access. |
authorized | 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. |
create | IResolvable | IResolvable | Principal [] | Specifies whether access control on a newly created database is managed by Lake Formation permissions or exclusively by IAM permissions. |
create | IResolvable | IResolvable | Principal [] | Specifies whether access control on a newly created table is managed by Lake Formation permissions or exclusively by IAM permissions. |
external | IResolvable | IResolvable | Data [] | A list of the account IDs of AWS accounts with Amazon EMR clusters or third-party engines that are allwed to perform data filtering. |
mutation | 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 ). |
parameters? | any | A key-value map that provides an additional configuration on your data lake. |
trusted | string[] | An array of UTF-8 strings. |
admins?
Type:
IResolvable
|
IResolvable
|
Data
[]
(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 .
allowFullTableExternalDataAccess?
Type:
boolean |
IResolvable
(optional)
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.
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
|
Principal
[]
(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
|
Principal
[]
(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
|
Data
[]
(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.
mutationType?
Type:
string
(optional)
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?
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
Name | Type | Description |
---|---|---|
attr | string | |
cfn | ICfn | Options for this resource, such as condition, update policy etc. |
cfn | { [string]: any } | |
cfn | string | AWS resource type. |
creation | string[] | |
logical | string | The logical ID for this CloudFormation stack element. |
node | Node | The tree node. |
ref | string | Return a string that will be resolved to a CloudFormation { Ref } for this element. |
stack | Stack | The stack in which this element is defined. |
admins? | IResolvable | IResolvable | Data [] | A list of AWS Lake Formation principals. |
allow | boolean | IResolvable | Whether to allow Amazon EMR clusters or other third-party query engines to access data managed by Lake Formation . |
allow | boolean | IResolvable | Specifies whether query engines and applications can get credentials without IAM session tags if the user has full table access. |
authorized | 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. |
create | IResolvable | IResolvable | Principal [] | Specifies whether access control on a newly created database is managed by Lake Formation permissions or exclusively by IAM permissions. |
create | IResolvable | IResolvable | Principal [] | Specifies whether access control on a newly created table is managed by Lake Formation permissions or exclusively by IAM permissions. |
external | IResolvable | IResolvable | Data [] | A list of the account IDs of AWS accounts with Amazon EMR clusters or third-party engines that are allwed to perform data filtering. |
mutation | 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 ). |
parameters? | any | A key-value map that provides an additional configuration on your data lake. |
trusted | string[] | An array of UTF-8 strings. |
static CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. |
attrId
Type:
string
cfnOptions
Type:
ICfn
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:
Node
The tree node.
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
|
Data
[]
(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 .
allowFullTableExternalDataAccess?
Type:
boolean |
IResolvable
(optional)
Specifies whether query engines and applications can get credentials without IAM session tags if the user has full table access.
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.
createDatabaseDefaultPermissions?
Type:
IResolvable
|
IResolvable
|
Principal
[]
(optional)
Specifies whether access control on a newly created database is managed by Lake Formation permissions or exclusively by IAM permissions.
createTableDefaultPermissions?
Type:
IResolvable
|
IResolvable
|
Principal
[]
(optional)
Specifies whether access control on a newly created table is managed by Lake Formation permissions or exclusively by IAM permissions.
externalDataFilteringAllowList?
Type:
IResolvable
|
IResolvable
|
Data
[]
(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.
mutationType?
Type:
string
(optional)
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
).
parameters?
Type:
any
(optional)
A key-value map that provides an additional configuration on your data lake.
trustedResourceOwners?
Type:
string[]
(optional)
An array of UTF-8 strings.
static CFN_RESOURCE_TYPE_NAME
Type:
string
The CloudFormation resource type name for this resource class.
Methods
Name | Description |
---|---|
add | Syntactic sugar for addOverride(path, undefined) . |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Add a value to the CloudFormation Resource Metadata. |
add | Adds an override to the synthesized CloudFormation resource. |
add | Adds an override that deletes the value of a property from the resource definition. |
add | Adds an override to a resource property. |
apply | Sets the deletion policy of the resource based on the removal policy specified. |
get | Returns a token for an runtime attribute of this resource. |
get | Retrieve a value value from the CloudFormation Resource Metadata. |
inspect(inspector) | Examines the CloudFormation resource and discloses attributes. |
obtain | Retrieves an array of resources this resource depends on. |
obtain | Get a shallow copy of dependencies between this resource and other resources in the same stack. |
override | Overrides the auto-generated logical ID with a specific ID. |
remove | Indicates that this resource no longer depends on another resource. |
replace | Replaces one dependency with another. |
to | Returns a string representation of this construct. |
protected render |
addDeletionOverride(path)
public addDeletionOverride(path: string): void
Parameters
- path
string
— The path of the value to delete.
Syntactic sugar for addOverride(path, undefined)
.
addDependency(target)
public addDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
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.
addDependsOn(target)
public addDependsOn(target: CfnResource): void
⚠️ Deprecated: use addDependency
Parameters
- target
Cfn
Resource
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)
public addMetadata(key: string, value: any): void
Parameters
- key
string
- value
any
Add a value to the CloudFormation Resource Metadata.
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
- policy
Removal
Policy - options
Removal
Policy Options
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
). In some
cases, a snapshot can be taken of the resource prior to deletion
(RemovalPolicy.SNAPSHOT
). A list of resources that support this policy
can be found in the following link:
getAtt(attributeName, typeHint?)
public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference
Parameters
- attributeName
string
— The name of the attribute. - typeHint
Resolution
Type Hint
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.
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
Tree
— tree inspector to collect and process attributes.Inspector
Examines the CloudFormation resource and discloses attributes.
obtainDependencies()
public obtainDependencies(): Stack | CfnResource[]
Returns
Stack
|
Cfn
Resource []
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
obtainResourceDependencies()
public obtainResourceDependencies(): CfnResource[]
Returns
Get a shallow copy of dependencies between this resource and other resources in the same stack.
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.
removeDependency(target)
public removeDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
replaceDependency(target, newTarget)
public replaceDependency(target: CfnResource, newTarget: CfnResource): void
Parameters
- target
Cfn
— The dependency to replace.Resource - newTarget
Cfn
— The new dependency to add.Resource
Replaces one dependency with another.
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 }