DefaultStagingStackProps

class aws_cdk.app_staging_synthesizer_alpha.DefaultStagingStackProps(*, app_id, staging_bucket_encryption, auto_delete_staging_assets=None, deploy_time_file_asset_lifetime=None, file_asset_publishing_role=None, image_asset_publishing_role=None, image_asset_version_count=None, staging_bucket_name=None, staging_stack_name_prefix=None, analytics_reporting=None, cross_region_references=None, description=None, env=None, notification_arns=None, permissions_boundary=None, property_injectors=None, stack_name=None, suppress_template_indentation=None, synthesizer=None, tags=None, termination_protection=None, qualifier, deploy_role_arn=None)

Bases: DefaultStagingStackOptions, StackProps

(experimental) Default Staging Stack Properties.

Parameters:

  • app_id (str) – (experimental) 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.

  • staging_bucket_encryption (BucketEncryption) – (experimental) Encryption type for staging bucket. 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.

  • auto_delete_staging_assets (Optional[bool]) – (experimental) Auto deletes objects in the staging S3 bucket and images in the staging ECR repositories. Default: true

  • deploy_time_file_asset_lifetime (Optional[Duration]) – (experimental) The lifetime for deploy time file assets. 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. Default: - Duration.days(30)

  • file_asset_publishing_role (Optional[BootstrapRole]) – (experimental) Pass in an existing role to be used as the file publishing role. Default: - a new role will be created

  • image_asset_publishing_role (Optional[BootstrapRole]) – (experimental) Pass in an existing role to be used as the image publishing role. Default: - a new role will be created

  • image_asset_version_count (Union[int, float, None]) – (experimental) The maximum number of image versions to store in a repository. 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. Default: - up to 3 versions stored

  • staging_bucket_name (Optional[str]) – (experimental) Explicit name for the staging bucket. Default: - a well-known name unique to this app/env.

  • staging_stack_name_prefix (Optional[str]) – (experimental) 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. Default: ‘StagingStack’

  • 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 notification 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

  • property_injectors (Optional[Sequence[IPropertyInjector]]) – A list of IPropertyInjector attached to this Stack. Default: - no PropertyInjectors

  • 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]]) – Tags that will be applied to the Stack. 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. Default: {}

  • termination_protection (Optional[bool]) – Whether to enable termination protection for this stack. Default: false

  • qualifier (str) – (experimental) The qualifier used to specialize strings. Can be used to specify custom bootstrapped role names

  • deploy_role_arn (Optional[str]) – (experimental) The ARN of the deploy action role, if given. This role will need permissions to read from to the staging resources. Default: - The CLI credentials are assumed, no additional permissions are granted.

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.app_staging_synthesizer_alpha as app_staging_synthesizer_alpha
import aws_cdk as cdk
from aws_cdk import aws_s3 as s3

# bootstrap_role: app_staging_synthesizer_alpha.BootstrapRole
# permissions_boundary: cdk.PermissionsBoundary
# property_injector: cdk.IPropertyInjector
# stack_synthesizer: cdk.StackSynthesizer

default_staging_stack_props = app_staging_synthesizer_alpha.DefaultStagingStackProps(
    app_id="appId",
    qualifier="qualifier",
    staging_bucket_encryption=s3.BucketEncryption.UNENCRYPTED,

    # the properties below are optional
    analytics_reporting=False,
    auto_delete_staging_assets=False,
    cross_region_references=False,
    deploy_role_arn="deployRoleArn",
    deploy_time_file_asset_lifetime=cdk.Duration.minutes(30),
    description="description",
    env=cdk.Environment(
        account="account",
        region="region"
    ),
    file_asset_publishing_role=bootstrap_role,
    image_asset_publishing_role=bootstrap_role,
    image_asset_version_count=123,
    notification_arns=["notificationArns"],
    permissions_boundary=permissions_boundary,
    property_injectors=[property_injector],
    stack_name="stackName",
    staging_bucket_name="stagingBucketName",
    staging_stack_name_prefix="stagingStackNamePrefix",
    suppress_template_indentation=False,
    synthesizer=stack_synthesizer,
    tags={
        "tags_key": "tags"
    },
    termination_protection=False
)

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

app_id

(experimental) 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.

Stability:

experimental

auto_delete_staging_assets

(experimental) Auto deletes objects in the staging S3 bucket and images in the staging ECR repositories.

Default:

true

Stability:

experimental

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

deploy_role_arn

(experimental) The ARN of the deploy action role, if given.

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

Default:

  • The CLI credentials are assumed, no additional permissions are granted.

Stability:

experimental

deploy_time_file_asset_lifetime

(experimental) The lifetime for deploy time file assets.

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.

Default:

  • Duration.days(30)

Stability:

experimental

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:

from aws_cdk import Environment, Environment, Environment
# 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")
file_asset_publishing_role

(experimental) Pass in an existing role to be used as the file publishing role.

Default:

  • a new role will be created

Stability:

experimental

image_asset_publishing_role

(experimental) Pass in an existing role to be used as the image publishing role.

Default:

  • a new role will be created

Stability:

experimental

image_asset_version_count

(experimental) The maximum number of image versions to store in a repository.

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.

Default:

  • up to 3 versions stored

Stability:

experimental

notification_arns

SNS Topic ARNs that will receive stack events.

Default:

  • no notification 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

property_injectors

A list of IPropertyInjector attached to this Stack.

Default:

  • no PropertyInjectors

qualifier

(experimental) The qualifier used to specialize strings.

Can be used to specify custom bootstrapped role names

Stability:

experimental

stack_name

Name to deploy the stack with.

Default:

  • Derived from construct path.

staging_bucket_encryption

(experimental) Encryption type for staging bucket.

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.

Stability:

experimental

staging_bucket_name

(experimental) Explicit name for the staging bucket.

Default:

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

Stability:

experimental

staging_stack_name_prefix

(experimental) 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.

Default:

‘StagingStack’

Stability:

experimental

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

Tags that will be applied to the Stack.

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.

Default:

{}

termination_protection

Whether to enable termination protection for this stack.

Default:

false