StackProps

class aws_cdk.core.StackProps(*, description=None, env=None, stack_name=None, synthesizer=None, tags=None, termination_protection=None)

Bases: object

__init__(*, description=None, env=None, stack_name=None, synthesizer=None, tags=None, termination_protection=None)
Parameters
  • description (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 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.

  • 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

Return type

None

Attributes

description

A description of the stack.

default :default: - No description.

Return type

Optional[str]

env

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

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 :default:

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

Example:

# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
# Use a concrete account and region to deploy this stack to:
# `.account` and `.region` will simply return these values.
MyStack(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)
MyStack(app, "Stack2",
    env={
        "account": process.env.CDK_DEFAULT_ACCOUNT,
        "region": process.env.CDK_DEFAULT_REGION
    }
)

# Define multiple stacks stage associated with an environment
my_stage = Stage(app, "MyStage",
    env={
        "account": "123456789012",
        "region": "us-east-1"
    }
)

# both of these stavks will use the stage's account/region:
# `.account` and `.region` will resolve to the concrete values as above
MyStack(my_stage, "Stack1")
YourStack(my_stage, "Stack1")

# 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.
MyStack(app, "Stack1")
Return type

Optional[Environment]

stack_name

Name to deploy the stack with.

default :default: - Derived from construct path.

Return type

Optional[str]

synthesizer

Synthesis method to use while deploying this stack.

default :default:

  • DefaultStackSynthesizer if the @aws-cdk/core:newStyleStackSynthesis feature flag is set, LegacyStackSynthesizer otherwise.

Return type

Optional[IStackSynthesizer]

tags

Stack tags that will be applied to all the taggable resources and the stack itself.

default :default: {}

Return type

Optional[Mapping[str, str]]

termination_protection

Whether to enable termination protection for this stack.

default :default: false

Return type

Optional[bool]