Skip to content
v2.277.0

Experimental

@aws-cdk/app-staging-synthesizer-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

DefaultStagingStack ​

A default Staging Stack that implements IStagingResources.

Example ​

ts
import { BucketEncryption } from 'aws-cdk-lib/aws-s3';
const defaultStagingStack = DefaultStagingStack.factory({ appId: 'my-app-id', stagingBucketEncryption: BucketEncryption.S3_MANAGED });
python
from aws_cdk.aws_s3 import BucketEncryption

default_staging_stack = DefaultStagingStack.factory(app_id="my-app-id", staging_bucket_encryption=BucketEncryption.S3_MANAGED)
java
import software.amazon.awscdk.services.s3.BucketEncryption;

IStagingResourcesFactory defaultStagingStack = DefaultStagingStack.factory(DefaultStagingStackOptions.builder().appId("my-app-id").stagingBucketEncryption(BucketEncryption.S3_MANAGED).build());
csharp
// Install: dotnet add package Amazon.CDK.AppStagingSynthesizer.Alpha
using Amazon.CDK.AWS.S3;

var defaultStagingStack = DefaultStagingStack.Factory(new DefaultStagingStackOptions { AppId = "my-app-id", StagingBucketEncryption = BucketEncryption.S3_MANAGED });
go
// Install: go get github.com/aws/aws-cdk-go/appstagingsynthesizeralpha/v2
import "github.com/aws/aws-cdk-go/awscdk"

defaultStagingStack := appstagingsynthesizeralpha.DefaultStagingStack_Factory(&DefaultStagingStackOptions{
	AppId: jsii.String("my-app-id"),
	StagingBucketEncryption: awscdk.BucketEncryption_S3_MANAGED,
})

Initializer ​

ts
new DefaultStagingStack(scope: App, id: string, props: DefaultStagingStackProps)
python
DefaultStagingStack(scope: App, id: str, props: DefaultStagingStackProps)
java
new DefaultStagingStack(App scope, String id, DefaultStagingStackProps props)
csharp
new DefaultStagingStack(App scope, string id, DefaultStagingStackProps props)
go
NewDefaultStagingStack(Scope App, Id *string, Props DefaultStagingStackProps)

Construct Props ​

analyticsReportingoptionalbooleananalytics_reportingoptionalboolanalyticsReportingoptionalBooleanAnalyticsReportingoptionalboolAnalyticsReportingoptional*bool #
Include runtime versioning information in this Stack.

Default: analyticsReporting setting of containing App, or value of 'aws:cdk:version-reporting' context key

appIdstringapp_idstrappIdStringAppIdstringAppId*string required #
A unique identifier for the application that the staging stack belongs to.

This identifier will be used in the name of staging resources created for this application, and should be unique across CDK apps.

The identifier should include lowercase characters and dashes ('-') only and have a maximum of 20 characters.

autoDeleteStagingAssetsoptionalbooleanauto_delete_staging_assetsoptionalboolautoDeleteStagingAssetsoptionalBooleanAutoDeleteStagingAssetsoptionalboolAutoDeleteStagingAssetsoptional*bool = true #
Auto deletes objects in the staging S3 bucket and images in the staging ECR repositories.
crossRegionReferencesoptionalbooleancross_region_referencesoptionalboolcrossRegionReferencesoptionalBooleanCrossRegionReferencesoptionalboolCrossRegionReferencesoptional*bool = false #
Enable this flag to allow native cross region stack references.

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

deployRoleArnoptionalstringdeploy_role_arnoptionalstrdeployRoleArnoptionalStringDeployRoleArnoptionalstringDeployRoleArnoptional*string #
The ARN of the deploy action role, if given.

Default: The CLI credentials are assumed, no additional permissions are granted.

This role will need permissions to read from to the staging resources.

deployTimeFileAssetLifetimeoptionalDurationdeploy_time_file_asset_lifetimeoptionalDurationdeployTimeFileAssetLifetimeoptionalDurationDeployTimeFileAssetLifetimeoptionalDurationDeployTimeFileAssetLifetimeoptionalDuration = Duration.days(30) #
The lifetime for deploy time file assets.
notes

Assets that are only necessary at deployment time (for instance, CloudFormation templates and Lambda source code bundles) will be automatically deleted after this many days. Assets that may be read from the staging bucket during your application's run time will not be deleted.

Set this to the length of time you wish to be able to roll back to previous versions of your application without having to do a new cdk synth and re-upload of assets.

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string #
A description of the stack.

Default: No description.

envoptionalEnvironmentenvoptionalEnvironmentenvoptionalEnvironmentEnvoptionalEnvironmentEnvoptionalEnvironment #
The AWS environment (account/region) where this stack will be deployed.

Default: The environment of the containing Stage if available, otherwise create the stack will be environment-agnostic.

notes · 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.

ts
// 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');
fileAssetPublishingRoleoptionalBootstrapRolefile_asset_publishing_roleoptionalBootstrapRolefileAssetPublishingRoleoptionalBootstrapRoleFileAssetPublishingRoleoptionalBootstrapRoleFileAssetPublishingRoleoptionalBootstrapRole #
Pass in an existing role to be used as the file publishing role.

Default: a new role will be created

imageAssetPublishingRoleoptionalBootstrapRoleimage_asset_publishing_roleoptionalBootstrapRoleimageAssetPublishingRoleoptionalBootstrapRoleImageAssetPublishingRoleoptionalBootstrapRoleImageAssetPublishingRoleoptionalBootstrapRole #
Pass in an existing role to be used as the image publishing role.

Default: a new role will be created

imageAssetVersionCountoptionalnumberimage_asset_version_countoptionalint | floatimageAssetVersionCountoptionalNumberImageAssetVersionCountoptionaldoubleImageAssetVersionCountoptional*float64 #
The maximum number of image versions to store in a repository.

Default: up to 3 versions stored

notes

Previous versions of an image can be stored for rollback purposes. Once a repository has more than 3 image versions stored, the oldest version will be discarded. This allows for sensible garbage collection while maintaining a few previous versions for rollback scenarios.

notificationArnsoptionalstring[]notification_arnsoptionaltyping.List[str]notificationArnsoptionalList<String>NotificationArnsoptionalstring[]NotificationArnsoptional*[]*string #
SNS Topic ARNs that will receive stack events.

Default: no notification arns.

permissionsBoundaryoptionalPermissionsBoundarypermissions_boundaryoptionalPermissionsBoundarypermissionsBoundaryoptionalPermissionsBoundaryPermissionsBoundaryoptionalPermissionsBoundaryPermissionsBoundaryoptionalPermissionsBoundary #
Options for applying a permissions boundary to all IAM Roles and Users created within this Stage.

Default: no permissions boundary is applied

propertyInjectorsoptionalIPropertyInjector[]property_injectorsoptionaltyping.List[IPropertyInjector]propertyInjectorsoptionalList<IPropertyInjector>PropertyInjectorsoptionalIPropertyInjector[]PropertyInjectorsoptional*[]IPropertyInjector #
A list of IPropertyInjector attached to this Stack.

Default: no PropertyInjectors

qualifierstringqualifierstrqualifierStringQualifierstringQualifier*string required #
The qualifier used to specialize strings.

Can be used to specify custom bootstrapped role names

stackNameoptionalstringstack_nameoptionalstrstackNameoptionalStringStackNameoptionalstringStackNameoptional*string #
Name to deploy the stack with.

Default: Derived from construct path.

stagingBucketEncryptionBucketEncryptionstaging_bucket_encryptionBucketEncryptionstagingBucketEncryptionBucketEncryptionStagingBucketEncryptionBucketEncryptionStagingBucketEncryptionBucketEncryption required #
Encryption type for staging bucket.
notes

In future versions of this package, the default will be BucketEncryption.S3_MANAGED.

In previous versions of this package, the default was to use KMS encryption for the staging bucket. KMS keys cost $1/month, which could result in unexpected costs for users who are not aware of this. As we stabilize this module we intend to make the default S3-managed encryption, which is free. However, the migration path from KMS to S3 managed encryption for existing buckets is not straightforward. Therefore, for now, this property is required.

If you have an existing staging bucket encrypted with a KMS key, you will likely want to set this property to BucketEncryption.KMS. If you are creating a new staging bucket, you can set this property to BucketEncryption.S3_MANAGED to avoid the cost of a KMS key.

stagingBucketNameoptionalstringstaging_bucket_nameoptionalstrstagingBucketNameoptionalStringStagingBucketNameoptionalstringStagingBucketNameoptional*string #
Explicit name for the staging bucket.

Default: a well-known name unique to this app/env.

stagingStackNamePrefixoptionalstringstaging_stack_name_prefixoptionalstrstagingStackNamePrefixoptionalStringStagingStackNamePrefixoptionalstringStagingStackNamePrefixoptional*string = 'StagingStack' #
Specify a custom prefix to be used as the staging stack name and construct ID.

The prefix will be appended before the appId, which is required to be part of the stack name and construct ID to ensure uniqueness.

suppressTemplateIndentationoptionalbooleansuppress_template_indentationoptionalboolsuppressTemplateIndentationoptionalBooleanSuppressTemplateIndentationoptionalboolSuppressTemplateIndentationoptional*bool #
Enable this flag to suppress indentation in generated CloudFormation templates.

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.

synthesizeroptionalIStackSynthesizersynthesizeroptionalIStackSynthesizersynthesizeroptionalIStackSynthesizerSynthesizeroptionalIStackSynthesizerSynthesizeroptionalIStackSynthesizer #
Synthesis method to use while deploying this stack.

Default: The synthesizer specified on App, or DefaultStackSynthesizer otherwise.

notes

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.

tagsoptional{ [key: string]: string }tagsoptionaltyping.Mapping[str, str]tagsoptionalMap<String, String>TagsoptionalIDictionary<string, string>Tagsoptional*map[string]*string = {} #
Tags that will be applied to the Stack.
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.

terminationProtectionoptionalbooleantermination_protectionoptionalboolterminationProtectionoptionalBooleanTerminationProtectionoptionalboolTerminationProtectionoptional*bool = false #
Whether to enable termination protection for this stack.

Properties ​

accountstringaccountstraccountStringAccountstringAccount*string #
The AWS account into which this stack will be deployed.
notes

This value is resolved according to the following rules:

  1. The value provided to env.account when the stack is defined. This can either be a concrete account (e.g. 585695031111) or the Aws.ACCOUNT_ID token.
  2. 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.

artifactIdstringartifact_idstrartifactIdStringArtifactIdstringArtifactId*string #
The ID of the cloud assembly artifact for this stack.
availabilityZonesstring[]availability_zonestyping.List[str]availabilityZonesList<String>AvailabilityZonesstring[]AvailabilityZones*[]*string #
Returns the list of AZs that are available in the AWS environment (account/region) associated with this stack.
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 #
Indicates whether the stack requires bundling or not.
dependenciesStack[]dependenciestyping.List[Stack]dependenciesList<Stack>DependenciesStack[]Dependencies*[]Stack #
Return the stacks this stack depends on.
dependencyStackStackdependency_stackStackdependencyStackStackDependencyStackStackDependencyStackStack #
The stack to add dependencies to.
environmentstringenvironmentstrenvironmentStringEnvironmentstringEnvironment*string #
The environment coordinates in which this stack is deployed.
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.

nestedbooleannestedboolnestedBooleanNestedboolNested*bool #
Indicates if this is a nested stack, in which case `parentStack` will include a reference to its parent.
nestedStackParentmay be undefinedStacknested_stack_parentmay be undefinedStacknestedStackParentmay be undefinedStackNestedStackParentmay be undefinedStackNestedStackParentmay be undefinedStack #
If this is a nested stack, returns its parent stack.
nestedStackResourcemay be undefinedCfnResourcenested_stack_resourcemay be undefinedCfnResourcenestedStackResourcemay be undefinedCfnResourceNestedStackResourcemay be undefinedCfnResourceNestedStackResourcemay be undefinedCfnResource #
If this is a nested stack, this represents its `AWS::CloudFormation::Stack` resource.

undefined for top-level (non-nested) stacks.

nodeNodenodeNodenodeNodeNodeNodeNodeNode #
The tree node.
notificationArnsstring[]notification_arnstyping.List[str]notificationArnsList<String>NotificationArnsstring[]NotificationArns*[]*string #
The `AWS::NotificationARNs` pseudo parameter for this stack.
notes

This is a list token that CloudFormation resolves at deployment time to the notification Amazon Resource Names (ARNs) of the stack. During synthesis it does not contain the ARNs passed in the notificationArns property.

To configure notification ARNs, set the notificationArns property when creating the stack. Adding elements to the returned list does not configure notifications, and causes a synthesis error if the list is used afterwards.

partitionstringpartitionstrpartitionStringPartitionstringPartition*string #
The partition in which this stack is defined.
regionstringregionstrregionStringRegionstringRegion*string #
The AWS region into which this stack will be deployed (e.g. `us-west-2`).
notes

This value is resolved according to the following rules:

  1. The value provided to env.region when the stack is defined. This can either be a concrete region (e.g. us-west-2) or the Aws.REGION token.
  2. 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.

stackIdstringstack_idstrstackIdStringStackIdstringStackId*string #
The ID of the stack.
example
ts
// After resolving, looks like
'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'
stackNamestringstack_namestrstackNameStringStackNamestringStackName*string #
The concrete CloudFormation physical stack name.
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.

stagingBucketmay be undefinedBucketstaging_bucketmay be undefinedBucketstagingBucketmay be undefinedBucketStagingBucketmay be undefinedBucketStagingBucketmay be undefinedBucket #
The app-scoped, evironment-keyed staging bucket.
stagingRepos{ [key: string]: Repository }staging_repostyping.Mapping[str, Repository]stagingReposMap<String, Repository>StagingReposIDictionary<string, Repository>StagingRepos*map[string]Repository #
The app-scoped, environment-keyed ecr repositories associated with this app.
Synthesis method for this stack.
Tags to be applied to the stack.
templateFilestringtemplate_filestrtemplateFileStringTemplateFilestringTemplateFile*string #
The name of the CloudFormation template file emitted to the output directory during synthesis.

Example value: MyStack.template.json

templateOptionsITemplateOptionstemplate_optionsITemplateOptionstemplateOptionsITemplateOptionsTemplateOptionsITemplateOptionsTemplateOptionsITemplateOptions #
Options for CloudFormation template (like version, transform, description).
terminationProtectionbooleantermination_protectionboolterminationProtectionBooleanTerminationProtectionboolTerminationProtection*bool #
Whether termination protection is enabled for this stack.
urlSuffixstringurl_suffixstrurlSuffixStringUrlSuffixstringUrlSuffix*string #
The Amazon domain suffix for the region in which this stack is defined.

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 #
Use `addStackDependency` instead.
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.

addDockerImage(asset: DockerImageAssetSource): ImageStagingLocationdef add_docker_image(self, asset: DockerImageAssetSource) -> ImageStagingLocationpublic ImageStagingLocation addDockerImage(DockerImageAssetSource asset)public ImageStagingLocation AddDockerImage(DockerImageAssetSource asset)func AddDockerImage(Asset DockerImageAssetSource) ImageStagingLocation #
Return staging resource information for a docker asset.
addFile(asset: FileAssetSource): FileStagingLocationdef add_file(self, asset: FileAssetSource) -> FileStagingLocationpublic FileStagingLocation addFile(FileAssetSource asset)public FileStagingLocation AddFile(FileAssetSource asset)func AddFile(Asset FileAssetSource) FileStagingLocation #
Return staging resource information for a file asset.
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{}) #
Adds an arbitrary key-value pair, with information you want to record about the stack.

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) #
Add a dependency between this stack and another stack.
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) #
Configure a stack tag.

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) #
Add a Transform to this stack. A Transform is a macro that AWS CloudFormation uses to process your template.

Duplicate values are removed when stack is synthesized.

1 parameter · example

Parameters

  • transformtransformtransformtransformTransform — The transform to add.
ts
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) *[]*string static #
Override the reference strength for a specific cross-stack string list reference.

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) *string static #
Override the reference strength for a specific cross-stack reference value.
notes · 2 parameters · returns

Use this to weaken (or strengthen) an individual reference without affecting other references to the same resource. For example:

ts
// 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 #
Create a CloudFormation Export for a string list value.
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 #
Create a CloudFormation Export for a string value.
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 consumerStack no longer references bucket.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 ProducerStack class, call this.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 bucket resource from producerStack.
  • Don't forget to remove the exportValue() call as well.
  • Deploy again (this time only the producerStack will be changed -- the bucket will be deleted).
factory(options: DefaultStagingStackOptions): IStagingResourcesFactory@staticmethod def factory(options: DefaultStagingStackOptions) -> IStagingResourcesFactorypublic static IStagingResourcesFactory factory(DefaultStagingStackOptions options)public static IStagingResourcesFactory Factory(DefaultStagingStackOptions options)func Factory(Options DefaultStagingStackOptions) IStagingResourcesFactory static #
Return a factory that will create DefaultStagingStacks.
formatArn(components: ArnComponents): stringdef format_arn(self, components: ArnComponents) -> strpublic String formatArn(ArnComponents components)public string FormatArn(ArnComponents components)func FormatArn(Components ArnComponents) *string #
Creates an ARN from components.
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 #
Allocates a stack-unique CloudFormation-compatible logical identity for a specific resource.
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{}) *bool static #
Checks if `x` is a construct.
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{}) *bool static #
Return whether the given object is a Stack.

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) Stack static #
Looks up the first stack scope in which `construct` is defined.

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 #
Look up a fact value for the given fact for the region of this stack.
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) #
Remove a stack tag.

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) #
Rename a generated logical identities.

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) #
Indicate that a context key was expected.

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{} #
Resolve a tokenized value in the context of the current stack.
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 #
Splits the provided ARN into its components.

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 #
Convert an object, potentially containing tokens, to a JSON string.
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string #
Returns a string representation of this construct.
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 #
Convert an object, potentially containing tokens, to a YAML string.
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct #
Applies one or more mixins to this construct.

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.