StackProps

class aws_cdk.StackProps(*, analytics_reporting=None, cross_region_references=None, description=None, env=None, notification_arns=None, permissions_boundary=None, stack_name=None, suppress_template_indentation=None, synthesizer=None, tags=None, termination_protection=None)

Bases: object

Parameters:

  • analytics_reporting (Optional[bool]) – Include runtime versioning information in this Stack. Default: analyticsReporting setting of containing App, or value of ‘aws:cdk:version-reporting’ context key

  • cross_region_references (Optional[bool]) – 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 Default: false

  • description (Optional[str]) – A description of the stack. Default: - No description.

  • env (Union[Environment, Dict[str, Any], None]) – 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.

  • notification_arns (Optional[Sequence[str]]) – SNS Topic ARNs that will receive stack events. Default: - no notfication arns.

  • permissions_boundary (Optional[PermissionsBoundary]) – Options for applying a permissions boundary to all IAM Roles and Users created within this Stage. Default: - no permissions boundary is applied

  • stack_name (Optional[str]) – Name to deploy the stack with. Default: - Derived from construct path.

  • suppress_template_indentation (Optional[bool]) – Enable this flag to suppress indentation in generated CloudFormation templates. If not specified, the value of the @aws-cdk/core:suppressTemplateIndentation context key will be used. If that is not specified, then the default value false will be used. Default: - the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.

  • synthesizer (Optional[IStackSynthesizer]) – Synthesis method to use while deploying this stack. The Stack Synthesizer controls aspects of synthesis and deployment, like how assets are referenced and what IAM roles to use. For more information, see the README of the main CDK package. If not specified, the defaultStackSynthesizer from App will be used. If that is not specified, DefaultStackSynthesizer is used if @aws-cdk/core:newStyleStackSynthesis is set to true or the CDK major version is v2. In CDK v1 LegacyStackSynthesizer is the default if no other synthesizer is specified. Default: - The synthesizer specified on App, or DefaultStackSynthesizer otherwise.

  • tags (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

ExampleMetadata:

infused

Example:

stack1 = Stack(app, "Stack1",
    env=Environment(
        region="us-east-1"
    ),
    cross_region_references=True
)
cert = acm.Certificate(stack1, "Cert",
    domain_name="*.example.com",
    validation=acm.CertificateValidation.from_dns(route53.PublicHostedZone.from_hosted_zone_id(stack1, "Zone", "Z0329774B51CGXTDQV3X"))
)

stack2 = Stack(app, "Stack2",
    env=Environment(
        region="us-east-2"
    ),
    cross_region_references=True
)
cloudfront.Distribution(stack2, "Distribution",
    default_behavior=cloudfront.BehaviorOptions(
        origin=origins.HttpOrigin("example.com")
    ),
    domain_names=["dev.example.com"],
    certificate=cert
)

Attributes

analytics_reporting

Include runtime versioning information in this Stack.

Default:

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

cross_region_references

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

Default:

false

description

A description of the stack.

Default:

  • No description.

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:

  • The environment of the containing Stage if available,

otherwise create the stack will be environment-agnostic.

Example:

# Use a concrete account and region to deploy this stack to:
# `.account` and `.region` will simply return these values.
Stack(app, "Stack1",
    env=Environment(
        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)
Stack(app, "Stack2",
    env=Environment(
        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=Environment(
        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
MyStack(my_stage, "Stack1")
YourStack(my_stage, "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.
MyStack(app, "Stack1")
notification_arns

SNS Topic ARNs that will receive stack events.

Default:

  • no notfication arns.

permissions_boundary

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

Default:

  • no permissions boundary is applied

stack_name

Name to deploy the stack with.

Default:

  • Derived from construct path.

suppress_template_indentation

Enable this flag to suppress indentation in generated CloudFormation templates.

If not specified, the value of the @aws-cdk/core:suppressTemplateIndentation context key will be used. If that is not specified, then the default value false will be used.

Default:

  • the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.

synthesizer

Synthesis method to use while deploying this stack.

The Stack Synthesizer controls aspects of synthesis and deployment, like how assets are referenced and what IAM roles to use. For more information, see the README of the main CDK package.

If not specified, the defaultStackSynthesizer from App will be used. If that is not specified, DefaultStackSynthesizer is used if @aws-cdk/core:newStyleStackSynthesis is set to true or the CDK major version is v2. In CDK v1 LegacyStackSynthesizer is the default if no other synthesizer is specified.

Default:

  • The synthesizer specified on App, or DefaultStackSynthesizer otherwise.

tags

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

Default:

{}

termination_protection

Whether to enable termination protection for this stack.

Default:

false