CfnDataLakeSettings L1 construct
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-lib/aws-glue';
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);
import aws_cdk as cdk
from aws_cdk.aws_glue import S3Table, Database, DataFormat, Schema
from aws_cdk.aws_lakeformation import CfnDataLakeSettings, CfnTag, CfnTagAssociation
# stack: cdk.Stack
# account_id: str
tag_key = "aws"
tag_values = ["dev"]
database = Database(self, "Database")
table = S3Table(self, "Table",
database=database,
columns=[cdk.aws_glue.Column(
name="col1",
type=Schema.STRING
), cdk.aws_glue.Column(
name="col2",
type=Schema.STRING
)
],
data_format=DataFormat.CSV
)
synthesizer = stack.synthesizer
CfnDataLakeSettings(self, "DataLakeSettings",
admins=[CfnDataLakeSettings.DataLakePrincipalProperty(
data_lake_principal_identifier=stack.format_arn(
service="iam",
resource="role",
region="",
account=account_id,
resource_name="Admin"
)
), CfnDataLakeSettings.DataLakePrincipalProperty(
# The CDK cloudformation execution role.
data_lake_principal_identifier=synthesizer.cloud_formation_execution_role_arn.replace("${AWS::Partition}", "aws")
)
]
)
tag = CfnTag(self, "Tag",
catalog_id=account_id,
tag_key=tag_key,
tag_values=tag_values
)
lf_tag_pair_property = CfnTagAssociation.LFTagPairProperty(
catalog_id=account_id,
tag_key=tag_key,
tag_values=tag_values
)
tag_association = CfnTagAssociation(self, "TagAssociation",
lf_tags=[lf_tag_pair_property],
resource=CfnTagAssociation.ResourceProperty(
table_with_columns=CfnTagAssociation.TableWithColumnsResourceProperty(
database_name=database.database_name,
column_names=["col1", "col2"],
catalog_id=account_id,
name=table.table_name
)
)
)
tag_association.node.add_dependency(tag)
tag_association.node.add_dependency(table)
import software.amazon.awscdk.*;
import software.amazon.awscdk.services.glue.S3Table;
import software.amazon.awscdk.services.glue.Database;
import software.amazon.awscdk.services.glue.DataFormat;
import software.amazon.awscdk.services.glue.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);
// Install: dotnet add package Amazon.CDK.Lib
using Amazon.CDK;
using Amazon.CDK.AWS.Glue;
using Amazon.CDK.AWS.LakeFormation;
Stack stack;
string accountId;
var tagKey = "aws";
var tagValues = new [] { "dev" };
var database = new Database(this, "Database");
var table = new S3Table(this, "Table", new S3TableProps {
Database = database,
Columns = new [] { new Column {
Name = "col1",
Type = Schema.STRING
}, new Column {
Name = "col2",
Type = Schema.STRING
} },
DataFormat = DataFormat.CSV
});
var synthesizer = (DefaultStackSynthesizer)stack.Synthesizer;
new CfnDataLakeSettings(this, "DataLakeSettings", new CfnDataLakeSettingsProps {
Admins = new [] { new DataLakePrincipalProperty {
DataLakePrincipalIdentifier = stack.FormatArn(new ArnComponents {
Service = "iam",
Resource = "role",
Region = "",
Account = accountId,
ResourceName = "Admin"
})
}, new DataLakePrincipalProperty {
// The CDK cloudformation execution role.
DataLakePrincipalIdentifier = synthesizer.CloudFormationExecutionRoleArn.Replace("${AWS::Partition}", "aws")
} }
});
var tag = new CfnTag(this, "Tag", new CfnTagProps {
CatalogId = accountId,
TagKey = tagKey,
TagValues = tagValues
});
var lfTagPairProperty = new LFTagPairProperty {
CatalogId = accountId,
TagKey = tagKey,
TagValues = tagValues
};
var tagAssociation = new CfnTagAssociation(this, "TagAssociation", new CfnTagAssociationProps {
LfTags = new [] { lfTagPairProperty },
Resource = new ResourceProperty {
TableWithColumns = new TableWithColumnsResourceProperty {
DatabaseName = database.DatabaseName,
ColumnNames = new [] { "col1", "col2" },
CatalogId = accountId,
Name = table.TableName
}
}
});
tagAssociation.Node.AddDependency(tag);
tagAssociation.Node.AddDependency(table);
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
import cdk "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
var stack Stack
var accountId string
tagKey := "aws"
tagValues := []*string{
"dev",
}
database := awscdk.NewDatabase(this, jsii.String("Database"))
table := awscdk.NewS3Table(this, jsii.String("Table"), &S3TableProps{
Database: Database,
Columns: []Column{
&Column{
Name: jsii.String("col1"),
Type: awscdk.Schema_STRING(),
},
&Column{
Name: jsii.String("col2"),
Type: awscdk.Schema_STRING(),
},
},
DataFormat: awscdk.DataFormat_CSV(),
})
synthesizer := stack.Synthesizer.(DefaultStackSynthesizer)
awscdk.NewCfnDataLakeSettings(this, jsii.String("DataLakeSettings"), &CfnDataLakeSettingsProps{
Admins: []interface{}{
&DataLakePrincipalProperty{
DataLakePrincipalIdentifier: stack.FormatArn(&ArnComponents{
Service: jsii.String("iam"),
Resource: jsii.String("role"),
Region: jsii.String(""),
Account: accountId,
ResourceName: jsii.String("Admin"),
}),
},
&DataLakePrincipalProperty{
// The CDK cloudformation execution role.
DataLakePrincipalIdentifier: synthesizer.cloudFormationExecutionRoleArn.replace(jsii.String("${AWS::Partition}"), jsii.String("aws")),
},
},
})
tag := awscdk.NewCfnTag(this, jsii.String("Tag"), &CfnTagProps{
CatalogId: accountId,
TagKey: jsii.String(TagKey),
TagValues: TagValues,
})
lfTagPairProperty := &LFTagPairProperty{
CatalogId: accountId,
TagKey: jsii.String(TagKey),
TagValues: TagValues,
}
tagAssociation := awscdk.NewCfnTagAssociation(this, jsii.String("TagAssociation"), &CfnTagAssociationProps{
LfTags: []interface{}{
lfTagPairProperty,
},
Resource: &ResourceProperty{
TableWithColumns: &TableWithColumnsResourceProperty{
DatabaseName: database.databaseName,
ColumnNames: []*string{
jsii.String("col1"),
jsii.String("col2"),
},
CatalogId: accountId,
Name: table.tableName,
},
},
})
tagAssociation.Node.AddDependency(tag)
tagAssociation.Node.AddDependency(table)
Initializer
new CfnDataLakeSettings(scope: Construct, id: string, props?: CfnDataLakeSettingsProps)
CfnDataLakeSettings(scope: Construct, id: str, props: typing.Optional[CfnDataLakeSettingsProps] = None)
new CfnDataLakeSettings(Construct scope, String id, CfnDataLakeSettingsProps props)
new CfnDataLakeSettings(Construct scope, string id, CfnDataLakeSettingsProps? props = null)
NewCfnDataLakeSettings(Scope Construct, Id *string, Props CfnDataLakeSettingsProps)
Construct Props
adminsoptionalIResolvable | IResolvable | CfnDataLakeSettings.DataLakePrincipalProperty[]adminsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, DataLakePrincipalProperty]]]adminsoptionalIResolvableAdminsoptionalIResolvableAdminsoptionalinterface{}#allowExternalDataFilteringoptionalboolean | IResolvableallow_external_data_filteringoptionaltyping.Union[bool, IResolvable]allowExternalDataFilteringoptionalBooleanAllowExternalDataFilteringoptionalboolAllowExternalDataFilteringoptionalinterface{}#notes
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 .
allowFullTableExternalDataAccessoptionalboolean | IResolvableallow_full_table_external_data_accessoptionaltyping.Union[bool, IResolvable]allowFullTableExternalDataAccessoptionalBooleanAllowFullTableExternalDataAccessoptionalboolAllowFullTableExternalDataAccessoptionalinterface{}#authorizedSessionTagValueListoptionalstring[]authorized_session_tag_value_listoptionaltyping.List[str]authorizedSessionTagValueListoptionalList<String>AuthorizedSessionTagValueListoptionalstring[]AuthorizedSessionTagValueListoptional*[]*string#notes
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.
createDatabaseDefaultPermissionsoptionalIResolvable | IResolvable | CfnDataLakeSettings.PrincipalPermissionsProperty[]create_database_default_permissionsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, PrincipalPermissionsProperty]]]createDatabaseDefaultPermissionsoptionalIResolvableCreateDatabaseDefaultPermissionsoptionalIResolvableCreateDatabaseDefaultPermissionsoptionalinterface{}#notes
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 .
createTableDefaultPermissionsoptionalIResolvable | IResolvable | CfnDataLakeSettings.PrincipalPermissionsProperty[]create_table_default_permissionsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, PrincipalPermissionsProperty]]]createTableDefaultPermissionsoptionalIResolvableCreateTableDefaultPermissionsoptionalIResolvableCreateTableDefaultPermissionsoptionalinterface{}#notes
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 .
externalDataFilteringAllowListoptionalIResolvable | IResolvable | CfnDataLakeSettings.DataLakePrincipalProperty[]external_data_filtering_allow_listoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, DataLakePrincipalProperty]]]externalDataFilteringAllowListoptionalIResolvableExternalDataFilteringAllowListoptionalIResolvableExternalDataFilteringAllowListoptionalinterface{}#mutationTypeoptionalstringmutation_typeoptionalstrmutationTypeoptionalStringMutationTypeoptionalstringMutationTypeoptional*string#If you choose
REPLACE, your current data lake settings will be replaced with the new values in your template.
parametersoptionalanyparametersoptionalAnyparametersoptionalObjectParametersoptionalobjectParametersoptionalinterface{}#CrossAccountVersion is the key you can configure in the Parameters field. Accepted values for the CrossAccountVersion key are 1, 2, 3, and 4.
readOnlyAdminsoptionalIResolvable | IResolvable | CfnDataLakeSettings.DataLakePrincipalProperty[]read_only_adminsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, DataLakePrincipalProperty]]]readOnlyAdminsoptionalIResolvableReadOnlyAdminsoptionalIResolvableReadOnlyAdminsoptionalinterface{}#trustedResourceOwnersoptionalstring[]trusted_resource_ownersoptionaltyping.List[str]trustedResourceOwnersoptionalList<String>TrustedResourceOwnersoptionalstring[]TrustedResourceOwnersoptional*[]*string#notes
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
adminsmay be undefinedIResolvable | IResolvable | CfnDataLakeSettings.DataLakePrincipalProperty[]adminsmay be undefinedtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, DataLakePrincipalProperty]]]adminsmay be undefinedIResolvableAdminsmay be undefinedIResolvableAdminsmay be undefinedinterface{}#allowExternalDataFilteringmay be undefinedboolean | IResolvableallow_external_data_filteringmay be undefinedtyping.Union[bool, IResolvable]allowExternalDataFilteringmay be undefinedBooleanAllowExternalDataFilteringmay be undefinedboolAllowExternalDataFilteringmay be undefinedinterface{}#allowFullTableExternalDataAccessmay be undefinedboolean | IResolvableallow_full_table_external_data_accessmay be undefinedtyping.Union[bool, IResolvable]allowFullTableExternalDataAccessmay be undefinedBooleanAllowFullTableExternalDataAccessmay be undefinedboolAllowFullTableExternalDataAccessmay be undefinedinterface{}#authorizedSessionTagValueListmay be undefinedstring[]authorized_session_tag_value_listmay be undefinedtyping.List[str]authorizedSessionTagValueListmay be undefinedList<String>AuthorizedSessionTagValueListmay be undefinedstring[]AuthorizedSessionTagValueListmay be undefined*[]*string#CFN_RESOURCE_TYPE_NAMEstringcfn_resource_type_namestrCFN_RESOURCE_TYPE_NAMEStringCFN_RESOURCE_TYPE_NAMEstringCFN_RESOURCE_TYPE_NAME*stringstatic#cfnOptionsICfnResourceOptionscfn_optionsICfnResourceOptionscfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptions#cfnResourceTypestringcfn_resource_typestrcfnResourceTypeStringCfnResourceTypestringCfnResourceType*string#createDatabaseDefaultPermissionsmay be undefinedIResolvable | IResolvable | CfnDataLakeSettings.PrincipalPermissionsProperty[]create_database_default_permissionsmay be undefinedtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, PrincipalPermissionsProperty]]]createDatabaseDefaultPermissionsmay be undefinedIResolvableCreateDatabaseDefaultPermissionsmay be undefinedIResolvableCreateDatabaseDefaultPermissionsmay be undefinedinterface{}#createTableDefaultPermissionsmay be undefinedIResolvable | IResolvable | CfnDataLakeSettings.PrincipalPermissionsProperty[]create_table_default_permissionsmay be undefinedtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, PrincipalPermissionsProperty]]]createTableDefaultPermissionsmay be undefinedIResolvableCreateTableDefaultPermissionsmay be undefinedIResolvableCreateTableDefaultPermissionsmay be undefinedinterface{}#creationStackstring[]creation_stacktyping.List[str]creationStackList<String>CreationStackstring[]CreationStack*[]*string#dataLakeSettingsRefDataLakeSettingsReferencedata_lake_settings_refDataLakeSettingsReferencedataLakeSettingsRefDataLakeSettingsReferenceDataLakeSettingsRefDataLakeSettingsReferenceDataLakeSettingsRefDataLakeSettingsReference#externalDataFilteringAllowListmay be undefinedIResolvable | IResolvable | CfnDataLakeSettings.DataLakePrincipalProperty[]external_data_filtering_allow_listmay be undefinedtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, DataLakePrincipalProperty]]]externalDataFilteringAllowListmay be undefinedIResolvableExternalDataFilteringAllowListmay be undefinedIResolvableExternalDataFilteringAllowListmay be undefinedinterface{}#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).
mutationTypemay be undefinedstringmutation_typemay be undefinedstrmutationTypemay be undefinedStringMutationTypemay be undefinedstringMutationTypemay be undefined*string#readOnlyAdminsmay be undefinedIResolvable | IResolvable | CfnDataLakeSettings.DataLakePrincipalProperty[]read_only_adminsmay be undefinedtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, DataLakePrincipalProperty]]]readOnlyAdminsmay be undefinedIResolvableReadOnlyAdminsmay be undefinedIResolvableReadOnlyAdminsmay be undefinedinterface{}#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 }).
CfnElements must be defined within a stack scope (directly or indirectly).
trustedResourceOwnersmay be undefinedstring[]trusted_resource_ownersmay be undefinedtyping.List[str]trustedResourceOwnersmay be undefinedList<String>TrustedResourceOwnersmay be undefinedstring[]TrustedResourceOwnersmay be undefined*[]*string#Methods
addDeletionOverride(path: string): voiddef add_deletion_override(self, path: str) -> Nonepublic void addDeletionOverride(String path)public void AddDeletionOverride(string path)func AddDeletionOverride(Path *string)#1 parameter
Parameters
pathpathpathpathPath— The path of the value to delete.
addDependency(target: CfnResource): voiddef add_dependency(self, target: CfnResource) -> Nonepublic void addDependency(CfnResource target)public void AddDependency(CfnResource target)func AddDependency(Target CfnResource)deprecated#This method has been renamed to addResourceDependency to more clearly set it apart from construct.node.addDependency. See the documentation of that function for more details.
addDependsOn(target: CfnResource): voiddef add_depends_on(self, target: CfnResource) -> Nonepublic void addDependsOn(CfnResource target)public void AddDependsOn(CfnResource target)func AddDependsOn(Target CfnResource)deprecated#notes
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
This method has been renamed to addResourceDependency, which makes it more clear that this method operates at a different level from the construct-level construct.node.addDependency() mechanism.
addMetadata(key: string, value: any): voiddef add_metadata(self, key: str, value: Any) -> Nonepublic void addMetadata(String key, Object value)public void AddMetadata(string key, object value)func AddMetadata(Key *string, Value interface{})#addOverride(path: string, value: any): voiddef add_override(self, path: str, value: Any) -> Nonepublic void addOverride(String path, Object value)public void AddOverride(string path, object value)func AddOverride(Path *string, Value interface{})#notes · 2 parameters
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.
Parameters
pathpathpathpathPath— - The path of the property, you can use dot notation to override values in complex types.valuevaluevaluevalueValue— - The value.
addPropertyDeletionOverride(propertyPath: string): voiddef add_property_deletion_override(self, property_path: str) -> Nonepublic void addPropertyDeletionOverride(String propertyPath)public void AddPropertyDeletionOverride(string propertyPath)func AddPropertyDeletionOverride(PropertyPath *string)#1 parameter
Parameters
propertyPathproperty_pathpropertyPathpropertyPathPropertyPath— The path to the property.
addPropertyOverride(propertyPath: string, value: any): voiddef add_property_override(self, property_path: str, value: Any) -> Nonepublic void addPropertyOverride(String propertyPath, Object value)public void AddPropertyOverride(string propertyPath, object value)func AddPropertyOverride(PropertyPath *string, Value interface{})#Syntactic sugar for addOverride("Properties.<...>", value).
2 parameters
Parameters
propertyPathproperty_pathpropertyPathpropertyPathPropertyPath— The path of the property.valuevaluevaluevalueValue— The value.
addResourceDependency(target: CfnResource, reason?: string): voiddef add_resource_dependency(self, target: CfnResource, reason: typing.Optional[str] = None) -> Nonepublic void addResourceDependency(CfnResource target, String reason)public void AddResourceDependency(CfnResource target, string? reason = null)func AddResourceDependency(Target CfnResource, Reason *string)#notes
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
This method only adds dependencies between L1 resources. If you are looking for a generic construct-to-construct dependency mechanism that works for all constructs including L2s, use construct.node.addDependency instead.
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.
1 parameter
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): voiddef apply_removal_policy(self, policy: typing.Optional[RemovalPolicy] = None, options: typing.Optional[RemovalPolicyOptions] = None) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy, RemovalPolicyOptions options)public void ApplyRemovalPolicy(RemovalPolicy? policy = null, RemovalPolicyOptions? options = null)func ApplyRemovalPolicy(Policy RemovalPolicy, Options RemovalPolicyOptions)#notes
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:
cfnPropertyName(cdkPropertyName: string): stringdef cfn_property_name(self, cdk_property_name: str) -> strpublic String cfnPropertyName(String cdkPropertyName)public string CfnPropertyName(string cdkPropertyName)func CfnPropertyName(CdkPropertyName *string) *string#getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Referencedef get_att(self, attribute_name: str, type_hint: typing.Optional[ResolutionTypeHint] = None) -> Referencepublic Reference getAtt(String attributeName, ResolutionTypeHint typeHint)public Reference GetAtt(string attributeName, ResolutionTypeHint? typeHint = null)func GetAtt(AttributeName *string, TypeHint ResolutionTypeHint) Reference#Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.
1 parameter
Parameters
attributeNameattribute_nameattributeNameattributeNameAttributeName— The name of the attribute.
getMetadata(key: string): anydef get_metadata(self, key: str) -> Anypublic Object getMetadata(String key)public object GetMetadata(string key)func GetMetadata(Key *string) interface{}#inspect(inspector: TreeInspector): voiddef inspect(self, inspector: TreeInspector) -> Nonepublic void inspect(TreeInspector inspector)public void Inspect(TreeInspector inspector)func Inspect(Inspector TreeInspector)#1 parameter
Parameters
inspectorinspectorinspectorinspectorInspector— tree inspector to collect and process attributes.
isCfnDataLakeSettings(x: any): boolean@staticmethod def is_cfn_data_lake_settings(x: Any) -> boolpublic static Boolean isCfnDataLakeSettings(Object x)public static bool IsCfnDataLakeSettings(object x)func IsCfnDataLakeSettings(X interface{}) *boolstatic#isCfnElement(x: any): boolean@staticmethod def is_cfn_element(x: Any) -> boolpublic static Boolean isCfnElement(Object x)public static bool IsCfnElement(object x)func IsCfnElement(X interface{}) *boolstatic#Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.
returns
Returns: The construct as a stack element or undefined if it is not a stack element.
isCfnResource(x: any): boolean@staticmethod def is_cfn_resource(x: Any) -> boolpublic static Boolean isCfnResource(Object x)public static bool IsCfnResource(object x)func IsCfnResource(X interface{}) *boolstatic#isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
obtainDependencies(): Stack | CfnResource[]def obtain_dependencies(self, ) -> typing.List[typing.Union[Stack, CfnResource]]public List<Stack> obtainDependencies()public Stack[] ObtainDependencies()func ObtainDependencies() *[]interface{}#For resources depended on directly, returns the CfnResource object. For dependencies on other stacks, returns the Stack object. The order of the array is not guaranteed.
overrideLogicalId(newLogicalId: string): voiddef override_logical_id(self, new_logical_id: str) -> Nonepublic void overrideLogicalId(String newLogicalId)public void OverrideLogicalId(string newLogicalId)func OverrideLogicalId(NewLogicalId *string)#1 parameter
Parameters
newLogicalIdnew_logical_idnewLogicalIdnewLogicalIdNewLogicalId— The new logical ID to use for this stack element.
removeDependency(target: CfnResource): voiddef remove_dependency(self, target: CfnResource) -> Nonepublic void removeDependency(CfnResource target)public void RemoveDependency(CfnResource target)func RemoveDependency(Target CfnResource)deprecated#This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
removeResourceDependency(target: CfnResource): voiddef remove_resource_dependency(self, target: CfnResource) -> Nonepublic void removeResourceDependency(CfnResource target)public void RemoveResourceDependency(CfnResource target)func RemoveResourceDependency(Target CfnResource)#This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
replaceDependency(target: CfnResource, newTarget: CfnResource): voiddef replace_dependency(self, target: CfnResource, new_target: CfnResource) -> Nonepublic void replaceDependency(CfnResource target, CfnResource newTarget)public void ReplaceDependency(CfnResource target, CfnResource newTarget)func ReplaceDependency(Target CfnResource, NewTarget CfnResource)#2 parameters
Parameters
targettargettargettargetTarget— The dependency to replace.newTargetnew_targetnewTargetnewTargetNewTarget— The new dependency to add.
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#returns
Returns: a string representation of this resource
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.