Stack L2 construct
A root construct which represents a single CloudFormation stack.
Example
import * as cdk from 'aws-cdk-lib';
import * as s3 from 'aws-cdk-lib/aws-s3';
const app = new cdk.App();
const stack = new cdk.Stack(app, 'Stack');
declare const bucket: s3.IBucket;
new dynamodb.Table(stack, 'Table', {
partitionKey: {
name: 'id',
type: dynamodb.AttributeType.STRING,
},
importSource: {
compressionType: dynamodb.InputCompressionType.GZIP,
inputFormat: dynamodb.InputFormat.csv({
delimiter: ',',
headerList: ['id', 'name'],
}),
bucket,
keyPrefix: 'prefix',
},
});
import aws_cdk as cdk
import aws_cdk.aws_s3 as s3
# bucket: s3.IBucket
app = cdk.App()
stack = cdk.Stack(app, "Stack")
dynamodb.Table(stack, "Table",
partition_key=dynamodb.Attribute(
name="id",
type=dynamodb.AttributeType.STRING
),
import_source=dynamodb.ImportSourceSpecification(
compression_type=dynamodb.InputCompressionType.GZIP,
input_format=dynamodb.InputFormat.csv(
delimiter=",",
header_list=["id", "name"]
),
bucket=bucket,
key_prefix="prefix"
)
)
import software.amazon.awscdk.*;
import software.amazon.awscdk.services.s3.*;
IBucket bucket;
App app = new App();
Stack stack = new Stack(app, "Stack");
Table.Builder.create(stack, "Table")
.partitionKey(Attribute.builder()
.name("id")
.type(AttributeType.STRING)
.build())
.importSource(ImportSourceSpecification.builder()
.compressionType(InputCompressionType.GZIP)
.inputFormat(InputFormat.csv(CsvOptions.builder()
.delimiter(",")
.headerList(List.of("id", "name"))
.build()))
.bucket(bucket)
.keyPrefix("prefix")
.build())
.build();
// Install: dotnet add package Amazon.CDK.Lib
using Amazon.CDK;
using Amazon.CDK.AWS.S3;
IBucket bucket;
var app = new App();
var stack = new Stack(app, "Stack");
new Table(stack, "Table", new TableProps {
PartitionKey = new Attribute {
Name = "id",
Type = AttributeType.STRING
},
ImportSource = new ImportSourceSpecification {
CompressionType = InputCompressionType.GZIP,
InputFormat = InputFormat.Csv(new CsvOptions {
Delimiter = ",",
HeaderList = new [] { "id", "name" }
}),
Bucket = bucket,
KeyPrefix = "prefix"
}
});
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
import "github.com/aws/aws-cdk-go/awscdk"
import s3 "github.com/aws/aws-cdk-go/awscdk"
var bucket IBucket
app := cdk.NewApp()
stack := cdk.NewStack(app, jsii.String("Stack"))
dynamodb.NewTable(stack, jsii.String("Table"), &TableProps{
PartitionKey: &Attribute{
Name: jsii.String("id"),
Type: dynamodb.AttributeType_STRING,
},
ImportSource: &ImportSourceSpecification{
CompressionType: dynamodb.InputCompressionType_GZIP,
InputFormat: dynamodb.InputFormat_Csv(&CsvOptions{
Delimiter: jsii.String(","),
HeaderList: []*string{
jsii.String("id"),
jsii.String("name"),
},
}),
Bucket: *Bucket,
KeyPrefix: jsii.String("prefix"),
},
})
Initializer
new Stack(scope?: Construct, id?: string, props?: StackProps)
Stack(scope: typing.Optional[Construct] = None, id: typing.Optional[str] = None, props: typing.Optional[StackProps] = None)
new Stack(Construct scope, String id, StackProps props)
new Stack(Construct? scope = null, string? id = null, StackProps? props = null)
NewStack(Scope Construct, Id *string, Props StackProps)
Construct Props
analyticsReportingbooleananalytics_reportingboolanalyticsReportingBooleanAnalyticsReportingboolAnalyticsReporting*bool= `analyticsReporting` setting of …#default
Default: analyticsReporting setting of containing App, or value of 'aws:cdk:version-reporting' context key
crossRegionReferencesbooleancross_region_referencesboolcrossRegionReferencesBooleanCrossRegionReferencesboolCrossRegionReferences*bool= false#Enabling this will create a CloudFormation custom resource in both the producing stack and consuming stack in order to perform the export/import
This feature is currently experimental
descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string= No description.#envEnvironmentenvEnvironmentenvEnvironmentEnvEnvironmentEnvEnvironment= The environment of the containin…#notes · default · example
Set the region/account fields of env to either a concrete value to select the indicated environment (recommended for production stacks), or to the values of environment variables CDK_DEFAULT_REGION/CDK_DEFAULT_ACCOUNT to let the target environment depend on the AWS credentials/configuration that the CDK CLI is executed under (recommended for development stacks).
If the Stack is instantiated inside a Stage, any undefined region/account fields from env will default to the same field on the encompassing Stage, if configured there.
If either region or account are not set nor inherited from Stage, the Stack will be considered "environment-agnostic"". Environment-agnostic stacks can be deployed to any environment but may not be able to take advantage of all features of the CDK. For example, they will not be able to use environmental context lookups such as ec2.Vpc.fromLookup and will not automatically translate Service Principals to the right format based on the environment's AWS partition, and other such enhancements.
Default: The environment of the containing Stage if available, otherwise create the stack will be environment-agnostic.
// Use a concrete account and region to deploy this stack to:
// `.account` and `.region` will simply return these values.
new Stack(app, 'Stack1', {
env: {
account: '123456789012',
region: 'us-east-1'
},
});
// Use the CLI's current credentials to determine the target environment:
// `.account` and `.region` will reflect the account+region the CLI
// is configured to use (based on the user CLI credentials)
new Stack(app, 'Stack2', {
env: {
account: process.env.CDK_DEFAULT_ACCOUNT,
region: process.env.CDK_DEFAULT_REGION
},
});
// Define multiple stacks stage associated with an environment
const myStage = new Stage(app, 'MyStage', {
env: {
account: '123456789012',
region: 'us-east-1'
}
});
// both of these stacks will use the stage's account/region:
// `.account` and `.region` will resolve to the concrete values as above
new MyStack(myStage, 'Stack1');
new YourStack(myStage, 'Stack2');
// Define an environment-agnostic stack:
// `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
// which will only resolve to actual values by CloudFormation during deployment.
new MyStack(app, 'Stack1');
notificationArnsstring[]notification_arnstyping.List[str]notificationArnsList<String>NotificationArnsstring[]NotificationArns*[]*string= no notification arns.#permissionsBoundaryPermissionsBoundarypermissions_boundaryPermissionsBoundarypermissionsBoundaryPermissionsBoundaryPermissionsBoundaryPermissionsBoundaryPermissionsBoundaryPermissionsBoundary= no permissions boundary is appli…#default
Default: no permissions boundary is applied
propertyInjectorsIPropertyInjector[]property_injectorstyping.List[IPropertyInjector]propertyInjectorsList<IPropertyInjector>PropertyInjectorsIPropertyInjector[]PropertyInjectors*[]IPropertyInjector= no PropertyInjectors#stackNamestringstack_namestrstackNameStringStackNamestringStackName*string= Derived from construct path.#suppressTemplateIndentationbooleansuppress_template_indentationboolsuppressTemplateIndentationBooleanSuppressTemplateIndentationboolSuppressTemplateIndentation*bool= the value of `@aws-cdk/core:supp…#If not specified, the value of the @aws-cdk/core:suppressTemplateIndentation context key will be used. If that is not specified, then the default value false will be used.
default
Default: the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.
synthesizerIStackSynthesizersynthesizerIStackSynthesizersynthesizerIStackSynthesizerSynthesizerIStackSynthesizerSynthesizerIStackSynthesizer= The synthesizer specified on `Ap…#notes · default
The Stack Synthesizer controls aspects of synthesis and deployment, like how assets are referenced and what IAM roles to use. For more information, see the README of the main CDK package.
If not specified, the defaultStackSynthesizer from App will be used. If that is not specified, DefaultStackSynthesizer is used if @aws-cdk/core:newStyleStackSynthesis is set to true or the CDK major version is v2. In CDK v1 LegacyStackSynthesizer is the default if no other synthesizer is specified.
Default: The synthesizer specified on App, or DefaultStackSynthesizer otherwise.
tags{ [key: string]: string }tagstyping.Mapping[str, str]tagsMap<String, String>TagsIDictionary<string, string>Tags*map[string]*string= {}#notes
These tags are applied to the CloudFormation Stack itself. They will not appear in the CloudFormation template.
However, at deployment time, CloudFormation will apply these tags to all resources in the stack that support tagging. You will not be able to exempt resources from tagging (using the excludeResourceTypes property of Tags.of(...).add()) for tags applied in this way.
terminationProtectionbooleantermination_protectionboolterminationProtectionBooleanTerminationProtectionboolTerminationProtection*bool= false#Properties
notes
This value is resolved according to the following rules:
- The value provided to
env.accountwhen the stack is defined. This can either be a concrete account (e.g.585695031111) or theAws.ACCOUNT_IDtoken. Aws.ACCOUNT_ID, which represents the CloudFormation intrinsic reference{ "Ref": "AWS::AccountId" }encoded as a string token.
Preferably, you should use the return value as an opaque string and not attempt to parse it to implement your logic. If you do, you must first check that it is a concrete value an not an unresolved token. If this value is an unresolved token (Token.isUnresolved(stack.account) returns true), this implies that the user wishes that this stack will synthesize into an account-agnostic template. In this case, your code should either fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or implement some other account-agnostic behavior.
availabilityZonesstring[]availability_zonestyping.List[str]availabilityZonesList<String>AvailabilityZonesstring[]AvailabilityZones*[]*stringrequired#notes
If the stack is environment-agnostic (either account and/or region are tokens), this property will return an array with 2 tokens that will resolve at deploy-time to the first two availability zones returned from CloudFormation's Fn::GetAZs intrinsic function.
If they are not available in the context, returns a set of dummy values and reports them as missing, and let the CLI resolve them by calling EC2 DescribeAvailabilityZones on the target environment.
To specify a different strategy for selecting availability zones override this method.
bundlingRequiredbooleanbundling_requiredboolbundlingRequiredBooleanBundlingRequiredboolBundlingRequired*boolrequired#dependenciesStack[]dependenciestyping.List[Stack]dependenciesList<Stack>DependenciesStack[]Dependencies*[]Stackrequired#envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#notes
In the form aws://account/region. Use stack.account and stack.region to obtain the specific values, no need to parse.
You can use this value to determine if two stacks are targeting the same environment.
If either stack.account or stack.region are not concrete values (e.g. Aws.ACCOUNT_ID or Aws.REGION) the special strings unknown-account and/or unknown-region will be used respectively to indicate this stack is region/account-agnostic.
nestedStackParentStacknested_stack_parentStacknestedStackParentStackNestedStackParentStackNestedStackParentStack#nestedStackResourceCfnResourcenested_stack_resourceCfnResourcenestedStackResourceCfnResourceNestedStackResourceCfnResourceNestedStackResourceCfnResource#undefined for top-level (non-nested) stacks.
notificationArnsstring[]notification_arnstyping.List[str]notificationArnsList<String>NotificationArnsstring[]NotificationArns*[]*stringrequired#notes
This value is resolved according to the following rules:
- The value provided to
env.regionwhen the stack is defined. This can either be a concrete region (e.g.us-west-2) or theAws.REGIONtoken. Aws.REGION, which is represents the CloudFormation intrinsic reference{ "Ref": "AWS::Region" }encoded as a string token.
Preferably, you should use the return value as an opaque string and not attempt to parse it to implement your logic. If you do, you must first check that it is a concrete value an not an unresolved token. If this value is an unresolved token (Token.isUnresolved(stack.region) returns true), this implies that the user wishes that this stack will synthesize into a region-agnostic template. In this case, your code should either fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or implement some other region-agnostic behavior.
example
// After resolving, looks like
'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'
notes
This is either the name defined explicitly in the stackName prop or allocated based on the stack's location in the construct tree. Stacks that are directly defined under the app use their construct id as their stack name. Stacks that are defined deeper within the tree will use a hashed naming scheme based on the construct path to ensure uniqueness.
If you wish to obtain the deploy-time AWS::StackName intrinsic, you can use Aws.STACK_NAME directly.
synthesizerIStackSynthesizersynthesizerIStackSynthesizersynthesizerIStackSynthesizerSynthesizerIStackSynthesizerSynthesizerIStackSynthesizerrequired#Example value: MyStack.template.json
templateOptionsITemplateOptionstemplate_optionsITemplateOptionstemplateOptionsITemplateOptionsTemplateOptionsITemplateOptionsTemplateOptionsITemplateOptionsrequired#terminationProtectionbooleantermination_protectionboolterminationProtectionBooleanTerminationProtectionboolTerminationProtection*boolrequired#Methods
addDependency(target: Stack, reason?: string): voiddef add_dependency(self, target: Stack, reason: typing.Optional[str] = None) -> Nonepublic void addDependency(Stack target, String reason)public void AddDependency(Stack target, string? reason = null)func AddDependency(Target Stack, Reason *string)deprecated#notes
This can be used to define dependencies between any two stacks within an app, and also supports nested stacks.
Stack dependencies may not cross Stage boundaries.
This method has been renamed to addStackDependency to more clearly set it apart from construct.node.addDependency. See the documentation of that function for more details.
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{})#These get translated to the Metadata section of the generated template.
addStackDependency(target: Stack, reason?: string): voiddef add_stack_dependency(self, target: Stack, reason: typing.Optional[str] = None) -> Nonepublic void addStackDependency(Stack target, String reason)public void AddStackDependency(Stack target, string? reason = null)func AddStackDependency(Target Stack, Reason *string)#notes
This can be used to define dependencies between any two stacks within an app, and also supports nested stacks.
Stack dependencies may not cross Stage boundaries.
This method only adds dependencies between stacks. If you are looking for a generic construct-to-construct dependency mechanism, use construct.node.addDependency instead.
addStackTag(tagName: string, tagValue: string): voiddef add_stack_tag(self, tag_name: str, tag_value: str) -> Nonepublic void addStackTag(String tagName, String tagValue)public void AddStackTag(string tagName, string tagValue)func AddStackTag(TagName *string, TagValue *string)#At deploy time, CloudFormation will automatically apply all stack tags to all resources in the stack.
addTransform(transform: string): voiddef add_transform(self, transform: str) -> Nonepublic void addTransform(String transform)public void AddTransform(string transform)func AddTransform(Transform *string)#Duplicate values are removed when stack is synthesized.
1 parameter · example
Parameters
transformtransformtransformtransformTransform— The transform to add.
declare const stack: Stack;
stack.addTransform('AWS::Serverless-2016-10-31')
consumeListReference(value: string[], strength?: ReferenceStrength): string[]@staticmethod def consume_list_reference(value: typing.List[str], strength: typing.Optional[ReferenceStrength] = None) -> typing.List[str]public static List<String> consumeListReference(List<String> value, ReferenceStrength strength)public static string[] ConsumeListReference(string[] value, ReferenceStrength? strength = null)func ConsumeListReference(Value *[]*string, Strength ReferenceStrength) *[]*stringstatic#This is the string list equivalent of consumeReference.
2 parameters · returns
Parameters
valuevaluevaluevalueValue— A tokenized string list reference.strengthstrengthstrengthstrengthStrength— The reference strength to use.
Returns: A token that resolves to the same value but uses the overridden strength.
consumeReference(value: string, strength?: ReferenceStrength): string@staticmethod def consume_reference(value: str, strength: typing.Optional[ReferenceStrength] = None) -> strpublic static String consumeReference(String value, ReferenceStrength strength)public static string ConsumeReference(string value, ReferenceStrength? strength = null)func ConsumeReference(Value *string, Strength ReferenceStrength) *stringstatic#notes · 2 parameters · returns
Use this to weaken (or strengthen) an individual reference without affecting other references to the same resource. For example:
// producerStack defines an SNS topic
declare const topic: sns.Topic;
// consumerStack subscribes to it with a weak reference,
// so the producer can be torn down without blocking on this consumer
const consumerStack = new Stack(app, 'Consumer', {
env: { account: '123456789012', region: 'us-east-1' },
});
new sns.Subscription(consumerStack, 'Subscription', {
topic: sns.Topic.fromTopicArn(consumerStack, 'Topic', Stack.consumeReference(topic.topicArn)),
endpoint: 'https://example.com/webhook',
protocol: sns.SubscriptionProtocol.HTTPS,
});
Parameters
valuevaluevaluevalueValue— A tokenized string reference (e.g.bucket.bucketArn).strengthstrengthstrengthstrengthStrength— The reference strength to use.
Returns: A token that resolves to the same value but uses the overridden strength.
exportStringListValue(exportedValue: any, options?: ExportValueOptions): string[]def export_string_list_value(self, exported_value: Any, options: typing.Optional[ExportValueOptions] = None) -> typing.List[str]public List<String> exportStringListValue(Object exportedValue, ExportValueOptions options)public string[] ExportStringListValue(object exportedValue, ExportValueOptions? options = null)func ExportStringListValue(ExportedValue interface{}, Options ExportValueOptions) *[]*string#notes
Returns a string list representing the corresponding Fn.importValue() expression for this Export. The export expression is automatically wrapped with an Fn::Join and the import value with an Fn::Split, since CloudFormation can only export strings. You can control the name for the export by passing the name option.
If you don't supply a value for name, the value you're exporting must be a Resource attribute (for example: bucket.bucketName) and it will be given the same name as the automatic cross-stack reference that would be created if you used the attribute in another Stack.
One of the uses for this method is to remove the relationship between two Stacks established by automatic cross-stack references. It will temporarily ensure that the CloudFormation Export still exists while you remove the reference from the consuming stack. After that, you can remove the resource and the manual export.
See exportValue for an example of this process.
exportValue(exportedValue: any, options?: ExportValueOptions): stringdef export_value(self, exported_value: Any, options: typing.Optional[ExportValueOptions] = None) -> strpublic String exportValue(Object exportedValue, ExportValueOptions options)public string ExportValue(object exportedValue, ExportValueOptions? options = null)func ExportValue(ExportedValue interface{}, Options ExportValueOptions) *string#notes
Returns a string representing the corresponding Fn.importValue() expression for this Export. You can control the name for the export by passing the name option.
If you don't supply a value for name, the value you're exporting must be a Resource attribute (for example: bucket.bucketName) and it will be given the same name as the automatic cross-stack reference that would be created if you used the attribute in another Stack.
One of the uses for this method is to remove the relationship between two Stacks established by automatic cross-stack references. It will temporarily ensure that the CloudFormation Export still exists while you remove the reference from the consuming stack. After that, you can remove the resource and the manual export.
Here is how the process works. Let's say there are two stacks, producerStack and consumerStack, and producerStack has a bucket called bucket, which is referenced by consumerStack (perhaps because an AWS Lambda Function writes into it, or something like that).
It is not safe to remove producerStack.bucket because as the bucket is being deleted, consumerStack might still be using it.
Instead, the process takes two deployments:
Deployment 1: break the relationship:
- Make sure
consumerStackno longer referencesbucket.bucketName(maybe the consumer stack now uses its own bucket, or it writes to an AWS DynamoDB table, or maybe you just remove the Lambda Function altogether). - In the
ProducerStackclass, callthis.exportValue(this.bucket.bucketName). This will make sure the CloudFormation Export continues to exist while the relationship between the two stacks is being broken. - Deploy (this will effectively only change the
consumerStack, but it's safe to deploy both).
Deployment 2: remove the bucket resource:
- You are now free to remove the
bucketresource fromproducerStack. - Don't forget to remove the
exportValue()call as well. - Deploy again (this time only the
producerStackwill be changed -- the bucket will be deleted).
formatArn(components: ArnComponents): stringdef format_arn(self, components: ArnComponents) -> strpublic String formatArn(ArnComponents components)public string FormatArn(ArnComponents components)func FormatArn(Components ArnComponents) *string#notes
If partition, region or account are not specified, the stack's partition, region and account will be used.
If any component is the empty string, an empty string will be inserted into the generated ARN at the location that component corresponds to.
The ARN will be formatted as follows:
arn:{partition}:{service}:{region}:{account}:{resource}{sep}{resource-name}
The required ARN pieces that are omitted will be taken from the stack that the 'scope' is attached to. If all ARN pieces are supplied, the supplied scope can be 'undefined'.
getLogicalId(element: CfnElement): stringdef get_logical_id(self, element: CfnElement) -> strpublic String getLogicalId(CfnElement element)public string GetLogicalId(CfnElement element)func GetLogicalId(Element CfnElement) *string#notes · 1 parameter
This method is called when a CfnElement is created and used to render the initial logical identity of resources. Logical ID renames are applied at this stage.
This method uses the protected method allocateLogicalId to render the logical ID for an element. To modify the naming scheme, extend the Stack class and override this method.
Parameters
elementelementelementelementElement— The CloudFormation element for which a logical identity is needed.
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.
isStack(x: any): boolean@staticmethod def is_stack(x: Any) -> boolpublic static Boolean isStack(Object x)public static bool IsStack(object x)func IsStack(X interface{}) *boolstatic#We do attribute detection since we can't reliably use 'instanceof'.
of(construct: IConstruct): Stack // chainable@staticmethod def of(construct: IConstruct) -> Stackpublic static Stack of(IConstruct construct)public static Stack Of(IConstruct construct)func Of(Construct IConstruct) Stackstatic#Fails if there is no stack up the tree.
Will return the closest containing Stack or NestedStack.
1 parameter
Parameters
constructconstructconstructconstructConstruct— The construct to start the search from.
regionalFact(factName: string, defaultValue?: string): stringdef regional_fact(self, fact_name: str, default_value: typing.Optional[str] = None) -> strpublic String regionalFact(String factName, String defaultValue)public string RegionalFact(string factName, string? defaultValue = null)func RegionalFact(FactName *string, DefaultValue *string) *string#notes
Will return a definite value only if the region of the current stack is resolved. If not, a lookup map will be added to the stack and the lookup will be done at CDK deployment time.
What regions will be included in the lookup map is controlled by the @aws-cdk/core:target-partitions context value: it must be set to a list of partitions, and only regions from the given partitions will be included. If no such context key is set, all regions will be included.
This function is intended to be used by construct library authors. Application builders can rely on the abstractions offered by construct libraries and do not have to worry about regional facts.
If defaultValue is not given, it is an error if the fact is unknown for the given region.
removeStackTag(tagName: string): voiddef remove_stack_tag(self, tag_name: str) -> Nonepublic void removeStackTag(String tagName)public void RemoveStackTag(string tagName)func RemoveStackTag(TagName *string)#At deploy time, CloudFormation will automatically apply all stack tags to all resources in the stack.
renameLogicalId(oldId: string, newId: string): voiddef rename_logical_id(self, old_id: str, new_id: str) -> Nonepublic void renameLogicalId(String oldId, String newId)public void RenameLogicalId(string oldId, string newId)func RenameLogicalId(OldId *string, NewId *string)#To modify the naming scheme strategy, extend the Stack class and override the allocateLogicalId method.
reportMissingContextKey(report: MissingContext): voiddef report_missing_context_key(self, report: MissingContext) -> Nonepublic void reportMissingContextKey(MissingContext report)public void ReportMissingContextKey(MissingContext report)func ReportMissingContextKey(Report MissingContext)#Contains instructions which will be emitted into the cloud assembly on how the key should be supplied.
1 parameter
Parameters
reportreportreportreportReport— The set of parameters needed to obtain the context.
resolve(obj: any): anydef resolve(self, obj: Any) -> Anypublic Object resolve(Object obj)public object Resolve(object obj)func Resolve(Obj interface{}) interface{}#splitArn(arn: string, arnFormat: ArnFormat): ArnComponentsdef split_arn(self, arn: str, arn_format: ArnFormat) -> ArnComponentspublic ArnComponents splitArn(String arn, ArnFormat arnFormat)public ArnComponents SplitArn(string arn, ArnFormat arnFormat)func SplitArn(Arn *string, ArnFormat ArnFormat) ArnComponents#Works both if 'arn' is a string like 'arn:aws:s3:::bucket', and a Token representing a dynamic CloudFormation expression (in which case the returned components will also be dynamic CloudFormation expressions, encoded as Tokens).
2 parameters
Parameters
arnarnarnarnArn— the ARN to split into its components.arnFormatarn_formatarnFormatarnFormatArnFormat— the expected format of 'arn' - depends on what format the service 'arn' represents uses.
toJsonString(obj: any, space?: number): stringdef to_json_string(self, obj: Any, space: typing.Optional[int | float] = None) -> strpublic String toJsonString(Object obj, Number space)public string ToJsonString(object obj, double? space = null)func ToJsonString(Obj interface{}, Space *float64) *string#toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#toYamlString(obj: any): stringdef to_yaml_string(self, obj: Any) -> strpublic String toYamlString(Object obj)public string ToYamlString(object obj)func ToYamlString(Obj interface{}) *string#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.