NestedStack L2 construct
A CloudFormation nested stack.
When you apply template changes to update a top-level stack, CloudFormation updates the top-level stack and initiates an update to its nested stacks. CloudFormation updates the resources of modified nested stacks, but does not update the resources of unmodified nested stacks.
Furthermore, this stack will not be treated as an independent deployment artifact (won't be listed in "cdk list" or deployable through "cdk deploy"), but rather only synthesized as a template and uploaded as an asset to S3.
Cross references of resource attributes between the parent stack and the nested stack will automatically be translated to stack parameters and outputs.
Example
import * as cdk from 'aws-cdk-lib';
import { CustomResourceConfig } from 'aws-cdk-lib/custom-resources';
import * as s3deploy from 'aws-cdk-lib/aws-s3-deployment';
const app = new cdk.App();
const stack = new cdk.Stack(app, 'Stack');
CustomResourceConfig.of(app).addLogRetentionLifetime(logs.RetentionDays.TEN_YEARS);
const nestedStackA = new cdk.NestedStack(stack, 'NestedStackA');
let websiteBucketA = new s3.Bucket(nestedStackA, "WebsiteBucketA", {});
new s3deploy.BucketDeployment(nestedStackA, "s3deployA", {
sources: [s3deploy.Source.jsonData("file.json", { a: "b" })],
destinationBucket: websiteBucketA,
logRetention: logs.RetentionDays.ONE_DAY, // overridden by the `TEN_YEARS` set by `CustomResourceConfig`.
});
const nestedStackB = new cdk.NestedStack(stack, 'NestedStackB');
let websiteBucketB = new s3.Bucket(nestedStackB, "WebsiteBucketB", {});
new s3deploy.BucketDeployment(nestedStackB, "s3deployB", {
sources: [s3deploy.Source.jsonData("file.json", { a: "b" })],
destinationBucket: websiteBucketB,
logRetention: logs.RetentionDays.ONE_DAY, // overridden by the `TEN_YEARS` set by `CustomResourceConfig`.
});
import aws_cdk as cdk
from aws_cdk.custom_resources import CustomResourceConfig
import aws_cdk.aws_s3_deployment as s3deploy
app = cdk.App()
stack = cdk.Stack(app, "Stack")
CustomResourceConfig.of(app).add_log_retention_lifetime(logs.RetentionDays.TEN_YEARS)
nested_stack_a = cdk.NestedStack(stack, "NestedStackA")
website_bucket_a = s3.Bucket(nested_stack_a, "WebsiteBucketA")
s3deploy.BucketDeployment(nested_stack_a, "s3deployA",
sources=[s3deploy.Source.json_data("file.json", {"a": "b"})],
destination_bucket=website_bucket_a,
log_retention=logs.RetentionDays.ONE_DAY
)
nested_stack_b = cdk.NestedStack(stack, "NestedStackB")
website_bucket_b = s3.Bucket(nested_stack_b, "WebsiteBucketB")
s3deploy.BucketDeployment(nested_stack_b, "s3deployB",
sources=[s3deploy.Source.json_data("file.json", {"a": "b"})],
destination_bucket=website_bucket_b,
log_retention=logs.RetentionDays.ONE_DAY
)
import software.amazon.awscdk.*;
import software.amazon.awscdk.customresources.CustomResourceConfig;
import software.amazon.awscdk.services.s3.deployment.*;
App app = new App();
Stack stack = new Stack(app, "Stack");
CustomResourceConfig.of(app).addLogRetentionLifetime(RetentionDays.TEN_YEARS);
NestedStack nestedStackA = new NestedStack(stack, "NestedStackA");
Bucket websiteBucketA = Bucket.Builder.create(nestedStackA, "WebsiteBucketA").build();
BucketDeployment.Builder.create(nestedStackA, "s3deployA")
.sources(List.of(Source.jsonData("file.json", Map.of("a", "b"))))
.destinationBucket(websiteBucketA)
.logRetention(RetentionDays.ONE_DAY)
.build();
NestedStack nestedStackB = new NestedStack(stack, "NestedStackB");
Bucket websiteBucketB = Bucket.Builder.create(nestedStackB, "WebsiteBucketB").build();
BucketDeployment.Builder.create(nestedStackB, "s3deployB")
.sources(List.of(Source.jsonData("file.json", Map.of("a", "b"))))
.destinationBucket(websiteBucketB)
.logRetention(RetentionDays.ONE_DAY)
.build();
// Install: dotnet add package Amazon.CDK.Lib
using Amazon.CDK;
using Amazon.CDK.CustomResources;
using Amazon.CDK.AWS.S3.Deployment;
var app = new App();
var stack = new Stack(app, "Stack");
CustomResourceConfig.Of(app).AddLogRetentionLifetime(RetentionDays.TEN_YEARS);
var nestedStackA = new NestedStack(stack, "NestedStackA");
var websiteBucketA = new Bucket(nestedStackA, "WebsiteBucketA", new BucketProps { });
new BucketDeployment(nestedStackA, "s3deployA", new BucketDeploymentProps {
Sources = new [] { Source.JsonData("file.json", new Dictionary<string, string> { { "a", "b" } }) },
DestinationBucket = websiteBucketA,
LogRetention = RetentionDays.ONE_DAY
});
var nestedStackB = new NestedStack(stack, "NestedStackB");
var websiteBucketB = new Bucket(nestedStackB, "WebsiteBucketB", new BucketProps { });
new BucketDeployment(nestedStackB, "s3deployB", new BucketDeploymentProps {
Sources = new [] { Source.JsonData("file.json", new Dictionary<string, string> { { "a", "b" } }) },
DestinationBucket = websiteBucketB,
LogRetention = RetentionDays.ONE_DAY
});
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
app := cdk.NewApp()
stack := cdk.NewStack(app, jsii.String("Stack"))
awscdk.CustomResourceConfig_Of(app).AddLogRetentionLifetime(logs.RetentionDays_TEN_YEARS)
nestedStackA := cdk.NewNestedStack(stack, jsii.String("NestedStackA"))
websiteBucketA := s3.NewBucket(nestedStackA, jsii.String("WebsiteBucketA"), &BucketProps{
})
s3deploy.NewBucketDeployment(nestedStackA, jsii.String("s3deployA"), &BucketDeploymentProps{
Sources: []ISource{
s3deploy.Source_JsonData(jsii.String("file.json"), map[string]*string{
"a": jsii.String("b"),
}),
},
DestinationBucket: websiteBucketA,
LogRetention: logs.RetentionDays_ONE_DAY,
})
nestedStackB := cdk.NewNestedStack(stack, jsii.String("NestedStackB"))
websiteBucketB := s3.NewBucket(nestedStackB, jsii.String("WebsiteBucketB"), &BucketProps{
})
s3deploy.NewBucketDeployment(nestedStackB, jsii.String("s3deployB"), &BucketDeploymentProps{
Sources: []ISource{
s3deploy.Source_*JsonData(jsii.String("file.json"), map[string]*string{
"a": jsii.String("b"),
}),
},
DestinationBucket: websiteBucketB,
LogRetention: logs.RetentionDays_ONE_DAY,
})
Initializer
new NestedStack(scope: Construct, id: string, props?: NestedStackProps)
NestedStack(scope: Construct, id: str, props: typing.Optional[NestedStackProps] = None)
new NestedStack(Construct scope, String id, NestedStackProps props)
new NestedStack(Construct scope, string id, NestedStackProps? props = null)
NewNestedStack(Scope Construct, Id *string, Props NestedStackProps)
Construct Props
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#Default: No description.
notificationArnsoptionalstring[]notification_arnsoptionaltyping.List[str]notificationArnsoptionalList<String>NotificationArnsoptionalstring[]NotificationArnsoptional*[]*string#Default: notifications are not sent for this stack.
parametersoptional{ [key: string]: string }parametersoptionaltyping.Mapping[str, str]parametersoptionalMap<String, String>ParametersoptionalIDictionary<string, string>Parametersoptional*map[string]*string#Default: no user-defined parameters are passed to the nested stack
notes
Each parameter has a name corresponding to a parameter defined in the embedded template and a value representing the value that you want to set for the parameter.
The nested stack construct will automatically synthesize parameters in order to bind references from the parent stack(s) into the nested stack.
removalPolicyoptionalRemovalPolicyremoval_policyoptionalRemovalPolicyremovalPolicyoptionalRemovalPolicyRemovalPolicyoptionalRemovalPolicyRemovalPolicyoptionalRemovalPolicy= RemovalPolicy.DESTROY#The default is Destroy, because all Removal Policies of resources inside the Nested Stack should already have been set correctly. You normally should not need to set this value.
suppressTemplateIndentationoptionalbooleansuppress_template_indentationoptionalboolsuppressTemplateIndentationoptionalBooleanSuppressTemplateIndentationoptionalboolSuppressTemplateIndentationoptional*bool#Default: the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.
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.
timeoutoptionalDurationtimeoutoptionalDurationtimeoutoptionalDurationTimeoutoptionalDurationTimeoutoptionalDuration#Default: no timeout
notes
When CloudFormation detects that the nested stack has reached the CREATE_COMPLETE state, it marks the nested stack resource as CREATE_COMPLETE in the parent stack and resumes creating the parent stack. If the timeout period expires before the nested stack reaches CREATE_COMPLETE, CloudFormation marks the nested stack as failed and rolls back both the nested stack and parent stack.
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*[]*string#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*bool#dependenciesStack[]dependenciestyping.List[Stack]dependenciesList<Stack>DependenciesStack[]Dependencies*[]Stack#envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironment#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.
nestedStackParentmay be undefinedStacknested_stack_parentmay be undefinedStacknestedStackParentmay be undefinedStackNestedStackParentmay be undefinedStackNestedStackParentmay be undefinedStack#nestedStackResourcemay be undefinedCfnResourcenested_stack_resourcemay be undefinedCfnResourcenestedStackResourcemay be undefinedCfnResourceNestedStackResourcemay be undefinedCfnResourceNestedStackResourcemay be undefinedCfnResource#undefined for top-level (non-nested) stacks.
notificationArnsstring[]notification_arnstyping.List[str]notificationArnsList<String>NotificationArnsstring[]NotificationArns*[]*string#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.
notes
This is a context aware attribute:
- If this is referenced from the parent stack, it will return
{ "Ref": "LogicalIdOfNestedStackResource" }. - If this is referenced from the context of the nested stack, it will return
{ "Ref": "AWS::StackId" }
Example value: arn:aws:cloudformation:us-east-2:123456789012:stack/mystack-mynestedstack-sggfrhxhum7w/f449b250-b969-11e0-a185-5081d0136786
notes
This is a context aware attribute:
- If this is referenced from the parent stack, it will return a token that parses the name from the stack ID.
- If this is referenced from the context of the nested stack, it will return
{ "Ref": "AWS::StackName" }
Example value: mystack-mynestedstack-sggfrhxhum7w
synthesizerIStackSynthesizersynthesizerIStackSynthesizersynthesizerIStackSynthesizerSynthesizerIStackSynthesizerSynthesizerIStackSynthesizer#Example value: MyStack.template.json
templateOptionsITemplateOptionstemplate_optionsITemplateOptionstemplateOptionsITemplateOptionsTemplateOptionsITemplateOptionsTemplateOptionsITemplateOptions#terminationProtectionbooleantermination_protectionboolterminationProtectionBooleanTerminationProtectionboolTerminationProtection*bool#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.
isNestedStack(x: any): boolean@staticmethod def is_nested_stack(x: Any) -> boolpublic static Boolean isNestedStack(Object x)public static bool IsNestedStack(object x)func IsNestedStack(X interface{}) *boolstatic#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@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{}#setParameter(name: string, value: string): voiddef set_parameter(self, name: str, value: str) -> Nonepublic void setParameter(String name, String value)public void SetParameter(string name, string value)func SetParameter(Name *string, Value *string)#2 parameters
Parameters
namenamenamenameName— The parameter name (ID).valuevaluevaluevalueValue— The value to assign.
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.