Stack¶
-
class
aws_cdk.core.
Stack
(scope=None, id=None, *, analytics_reporting=None, description=None, env=None, stack_name=None, synthesizer=None, tags=None, termination_protection=None)¶ Bases:
aws_cdk.core.Construct
A root construct which represents a single CloudFormation stack.
Creates a new stack.
- Parameters
scope (
Optional
[Construct
]) – Parent of this stack, usually anApp
or aStage
, but could be any construct.id (
Optional
[str
]) – The construct ID of this stack. IfstackName
is not explicitly defined, this id (and any parent IDs) will be used to determine the physical ID of the stack.analytics_reporting (
Optional
[bool
]) – Include runtime versioning information in this Stack. Default:analyticsReporting
setting of containingApp
, or value of ‘aws:cdk:version-reporting’ context keydescription (
Optional
[str
]) – A description of the stack. Default: - No description.env (
Optional
[Environment
]) – The AWS environment (account/region) where this stack will be deployed. Set theregion
/account
fields ofenv
to either a concrete value to select the indicated environment (recommended for production stacks), or to the values of environment variablesCDK_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 theStack
is instantiated inside aStage
, any undefinedregion
/account
fields fromenv
will default to the same field on the encompassingStage
, if configured there. If eitherregion
oraccount
are not set nor inherited fromStage
, 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 asec2.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 containingStage
if available, otherwise create the stack will be environment-agnostic.stack_name (
Optional
[str
]) – Name to deploy the stack with. Default: - Derived from construct path.synthesizer (
Optional
[IStackSynthesizer
]) – Synthesis method to use while deploying this stack. Default: -DefaultStackSynthesizer
if the@aws-cdk/core:newStyleStackSynthesis
feature flag is set,LegacyStackSynthesizer
otherwise.tags (
Optional
[Mapping
[str
,str
]]) – Stack tags that will be applied to all the taggable resources and the stack itself. Default: {}termination_protection (
Optional
[bool
]) – Whether to enable termination protection for this stack. Default: false
Methods
-
add_dependency
(target, reason=None)¶ Add a dependency between this stack and another stack.
This can be used to define dependencies between any two stacks within an app, and also supports nested stacks.
- Parameters
target (
Stack
) –reason (
Optional
[str
]) –
- Return type
None
-
add_docker_image_asset
(*, source_hash, directory_name=None, docker_build_args=None, docker_build_target=None, docker_file=None, executable=None, repository_name=None)¶ (deprecated) Register a docker image asset on this Stack.
- Parameters
source_hash (
str
) – The hash of the contents of the docker build context. This hash is used throughout the system to identify this image and avoid duplicate work in case the source did not change. NOTE: this means that if you wish to update your docker image, you must make a modification to the source (e.g. add some metadata to your Dockerfile).directory_name (
Optional
[str
]) – The directory where the Dockerfile is stored, must be relative to the cloud assembly root. Default: - Exactly one ofdirectoryName
andexecutable
is requireddocker_build_args (
Optional
[Mapping
[str
,str
]]) – Build args to pass to thedocker build
command. Since Docker build arguments are resolved before deployment, keys and values cannot refer to unresolved tokens (such aslambda.functionArn
orqueue.queueUrl
). Only allowed whendirectoryName
is specified. Default: - no build args are passeddocker_build_target (
Optional
[str
]) – Docker target to build to. Only allowed whendirectoryName
is specified. Default: - no targetdocker_file (
Optional
[str
]) – Path to the Dockerfile (relative to the directory). Only allowed whendirectoryName
is specified. Default: - no fileexecutable (
Optional
[List
[str
]]) – An external command that will produce the packaged asset. The command should produce the name of a local Docker image onstdout
. Default: - Exactly one ofdirectoryName
andexecutable
is requiredrepository_name (
Optional
[str
]) – (deprecated) ECR repository name. Specify this property if you need to statically address the image, e.g. from a Kubernetes Pod. Note, this is only the repository name, without the registry and the tag parts. Default: - automatically derived from the asset’s ID.
- Deprecated
Use
stack.synthesizer.addDockerImageAsset()
if you are calling, and a differentIStackSynthesizer
class if you are implementing.- Stability
deprecated
- Return type
-
add_file_asset
(*, source_hash, executable=None, file_name=None, packaging=None)¶ (deprecated) Register a file asset on this Stack.
- Parameters
source_hash (
str
) – A hash on the content source. This hash is used to uniquely identify this asset throughout the system. If this value doesn’t change, the asset will not be rebuilt or republished.executable (
Optional
[List
[str
]]) – An external command that will produce the packaged asset. The command should produce the location of a ZIP file onstdout
. Default: - Exactly one ofdirectory
andexecutable
is requiredfile_name (
Optional
[str
]) – The path, relative to the root of the cloud assembly, in which this asset source resides. This can be a path to a file or a directory, dependning on the packaging type. Default: - Exactly one ofdirectory
andexecutable
is requiredpackaging (
Optional
[FileAssetPackaging
]) – Which type of packaging to perform. Default: - Required iffileName
is specified.
- Deprecated
Use
stack.synthesizer.addFileAsset()
if you are calling, and a different IStackSynthesizer class if you are implementing.- Stability
deprecated
- Return type
-
add_transform
(transform)¶ 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.
- Parameters
transform (
str
) – The transform to add.- See
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html
Example:
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826 stack.add_transform("AWS::Serverless-2016-10-31")
- Return type
None
-
format_arn
(*, resource, service, account=None, partition=None, region=None, resource_name=None, sep=None)¶ Creates an ARN from components.
If
partition
,region
oraccount
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’.
- Parameters
resource (
str
) – Resource type (e.g. “table”, “autoScalingGroup”, “certificate”). For some resource types, e.g. S3 buckets, this field defines the bucket name.service (
str
) – The service namespace that identifies the AWS product (for example, ‘s3’, ‘iam’, ‘codepipline’).account (
Optional
[str
]) – The ID of the AWS account that owns the resource, without the hyphens. For example, 123456789012. Note that the ARNs for some resources don’t require an account number, so this component might be omitted. Default: The account the stack is deployed to.partition (
Optional
[str
]) – The partition that the resource is in. For standard AWS regions, the partition is aws. If you have resources in other partitions, the partition is aws-partitionname. For example, the partition for resources in the China (Beijing) region is aws-cn. Default: The AWS partition the stack is deployed to.region (
Optional
[str
]) – The region the resource resides in. Note that the ARNs for some resources do not require a region, so this component might be omitted. Default: The region the stack is deployed to.resource_name (
Optional
[str
]) – Resource name or path within the resource (i.e. S3 bucket object key) or a wildcard such as"*"
. This is service-dependent.sep (
Optional
[str
]) – Separator between resource type and the resource. Can be either ‘/’, ‘:’ or an empty string. Will only be used if resourceName is defined. Default: ‘/’
- Return type
str
-
get_logical_id
(element)¶ Allocates a stack-unique CloudFormation-compatible logical identity for a specific resource.
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 theStack
class and override this method.- Parameters
element (
CfnElement
) – The CloudFormation element for which a logical identity is needed.- Return type
str
-
parse_arn
(arn, sep_if_token=None, has_name=None)¶ Given an ARN, parses it and returns components.
IF THE ARN IS A CONCRETE STRING…
…it will be parsed and validated. The separator (
sep
) will be set to ‘/’ if the 6th component includes a ‘/’, in which case,resource
will be set to the value before the ‘/’ andresourceName
will be the rest. In case there is no ‘/’,resource
will be set to the 6th components andresourceName
will be set to the rest of the string.IF THE ARN IS A TOKEN…
…it cannot be validated, since we don’t have the actual value yet at the time of this function call. You will have to supply
sepIfToken
and whether or not ARNs of the expected format usually have resource names in order to parse it properly. The resultingArnComponents
object will contain tokens for the subexpressions of the ARN, not string literals.If the resource name could possibly contain the separator char, the actual resource name cannot be properly parsed. This only occurs if the separator char is ‘/’, and happens for example for S3 object ARNs, IAM Role ARNs, IAM OIDC Provider ARNs, etc. To properly extract the resource name from a Tokenized ARN, you must know the resource type and call
Arn.extractResourceName
.- Parameters
arn (
str
) – The ARN string to parse.sep_if_token (
Optional
[str
]) – The separator used to separate resource from resourceName.has_name (
Optional
[bool
]) – Whether there is a name component in the ARN at all. For example, SNS Topics ARNs have the ‘resource’ component contain the topic name, and no ‘resourceName’ component.
- Return type
- Returns
an ArnComponents object which allows access to the various components of the ARN.
-
rename_logical_id
(old_id, new_id)¶ Rename a generated logical identities.
To modify the naming scheme strategy, extend the
Stack
class and override theallocateLogicalId
method.- Parameters
old_id (
str
) –new_id (
str
) –
- Return type
None
-
report_missing_context
(*, key, props, provider)¶ Indicate that a context key was expected.
Contains instructions which will be emitted into the cloud assembly on how the key should be supplied.
- Parameters
key (
str
) – (deprecated) The missing context key.props (
Mapping
[str
,Any
]) – (deprecated) A set of provider-specific options. (This is the old untyped definition, which is necessary for backwards compatibility. See cxschema for a type definition.)provider (
str
) – (deprecated) The provider from which we expect this context key to be obtained. (This is the old untyped definition, which is necessary for backwards compatibility. See cxschema for a type definition.)
- Return type
None
-
resolve
(obj)¶ Resolve a tokenized value in the context of the current stack.
- Parameters
obj (
Any
) –- Return type
Any
-
to_json_string
(obj, space=None)¶ Convert an object, potentially containing tokens, to a JSON string.
- Parameters
obj (
Any
) –space (
Union
[int
,float
,None
]) –
- Return type
str
-
to_string
()¶ Returns a string representation of this construct.
- Return type
str
Attributes
-
account
¶ The AWS account into which this stack will be deployed.
This value is resolved according to the following rules:
The value provided to
env.account
when the stack is defined. This can either be a concerete account (e.g.585695031111
) or theAws.accountId
token.Aws.accountId
, 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 concerete value an not an unresolved token. If this value is an unresolved token (
Token.isUnresolved(stack.account)
returnstrue
), this implies that the user wishes that this stack will synthesize into a account-agnostic template. In this case, your code should either fail (throw an error, emit a synth error usingAnnotations.of(construct).addError()
) or implement some other region-agnostic behavior.- Return type
str
-
artifact_id
¶ The ID of the cloud assembly artifact for this stack.
- Return type
str
-
availability_zones
¶ Returns the list of AZs that are available in the AWS environment (account/region) associated with this stack.
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.
- Return type
List
[str
]
-
environment
¶ The environment coordinates in which this stack is deployed.
In the form
aws://account/region
. Usestack.account
andstack.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
orstack.region
are not concrete values (e.g.Aws.account
orAws.region
) the special stringsunknown-account
and/orunknown-region
will be used respectively to indicate this stack is region/account-agnostic.- Return type
str
-
nested
¶ Indicates if this is a nested stack, in which case
parentStack
will include a reference to it’s parent.- Return type
bool
-
nested_stack_parent
¶ If this is a nested stack, returns it’s parent stack.
- Return type
Optional
[Stack
]
-
nested_stack_resource
¶ (experimental) If this is a nested stack, this represents its
AWS::CloudFormation::Stack
resource.undefined
for top-level (non-nested) stacks.- Stability
experimental
- Return type
Optional
[CfnResource
]
-
node
¶ The construct tree node associated with this construct.
- Return type
-
notification_arns
¶ Returns the list of notification Amazon Resource Names (ARNs) for the current stack.
- Return type
List
[str
]
-
parent_stack
¶ (deprecated) Returns the parent of a nested stack.
- Deprecated
use
nestedStackParent
- Stability
deprecated
- Return type
Optional
[Stack
]
-
partition
¶ The partition in which this stack is defined.
- Return type
str
-
region
¶ The AWS region into which this stack will be deployed (e.g.
us-west-2
).This value is resolved according to the following rules:
The value provided to
env.region
when the stack is defined. This can either be a concerete region (e.g.us-west-2
) or theAws.region
token.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 concerete value an not an unresolved token. If this value is an unresolved token (
Token.isUnresolved(stack.region)
returnstrue
), 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 usingAnnotations.of(construct).addError()
) or implement some other region-agnostic behavior.- Return type
str
-
stack_id
¶ The ID of the stack.
Example:
# Example automatically generated. See https://github.com/aws/jsii/issues/826 # After resolving, looks like "arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123"
- Return type
str
-
stack_name
¶ The concrete CloudFormation physical stack name.
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 constructid
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.stackName
directly.- Return type
str
-
synthesizer
¶ (experimental) Synthesis method for this stack.
- Stability
experimental
- Return type
Tags to be applied to the stack.
- Return type
-
template_file
¶ The name of the CloudFormation template file emitted to the output directory during synthesis.
Example:
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826 "MyStack.template.json"
- Return type
str
-
template_options
¶ Options for CloudFormation template (like version, transform, description).
- Return type
-
termination_protection
¶ Whether termination protection is enabled for this stack.
- Return type
Optional
[bool
]
-
url_suffix
¶ The Amazon domain suffix for the region in which this stack is defined.
- Return type
str
Static Methods
-
classmethod
is_construct
(x)¶ Return whether the given object is a Construct.
- Parameters
x (
Any
) –- Return type
bool
-
classmethod
is_stack
(x)¶ Return whether the given object is a Stack.
We do attribute detection since we can’t reliably use ‘instanceof’.
- Parameters
x (
Any
) –- Return type
bool