@aws-cdk_app-staging-synthesizer-alpha.DefaultStagingStackProps

interface DefaultStagingStackProps ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AppStagingSynthesizer.Alpha.DefaultStagingStackProps
Javasoftware.amazon.awscdk.app.staging.synthesizer.alpha.DefaultStagingStackProps
Pythonaws_cdk.app_staging_synthesizer_alpha.DefaultStagingStackProps
TypeScript (source)@aws-cdk/app-staging-synthesizer-alpha ยป DefaultStagingStackProps

Default Staging Stack Properties.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as app_staging_synthesizer_alpha from '@aws-cdk/app-staging-synthesizer-alpha';
import * as cdk from 'aws-cdk-lib';

declare const bootstrapRole: app_staging_synthesizer_alpha.BootstrapRole;
declare const permissionsBoundary: cdk.PermissionsBoundary;
declare const stackSynthesizer: cdk.StackSynthesizer;
const defaultStagingStackProps: app_staging_synthesizer_alpha.DefaultStagingStackProps = {
  appId: 'appId',
  qualifier: 'qualifier',

  // the properties below are optional
  analyticsReporting: false,
  autoDeleteStagingAssets: false,
  crossRegionReferences: false,
  deployRoleArn: 'deployRoleArn',
  deployTimeFileAssetLifetime: cdk.Duration.minutes(30),
  description: 'description',
  env: {
    account: 'account',
    region: 'region',
  },
  fileAssetPublishingRole: bootstrapRole,
  imageAssetPublishingRole: bootstrapRole,
  imageAssetVersionCount: 123,
  permissionsBoundary: permissionsBoundary,
  stackName: 'stackName',
  stagingBucketName: 'stagingBucketName',
  suppressTemplateIndentation: false,
  synthesizer: stackSynthesizer,
  tags: {
    tagsKey: 'tags',
  },
  terminationProtection: false,
};

Properties

NameTypeDescription
appId๐Ÿ”นstringA unique identifier for the application that the staging stack belongs to.
qualifier๐Ÿ”นstringThe qualifier used to specialize strings.
analyticsReporting?๐Ÿ”นbooleanInclude runtime versioning information in this Stack.
autoDeleteStagingAssets?๐Ÿ”นbooleanAuto deletes objects in the staging S3 bucket and images in the staging ECR repositories.
crossRegionReferences?๐Ÿ”นbooleanEnable this flag to allow native cross region stack references.
deployRoleArn?๐Ÿ”นstringThe ARN of the deploy action role, if given.
deployTimeFileAssetLifetime?๐Ÿ”นDurationThe lifetime for deploy time file assets.
description?๐Ÿ”นstringA description of the stack.
env?๐Ÿ”นEnvironmentThe AWS environment (account/region) where this stack will be deployed.
fileAssetPublishingRole?๐Ÿ”นBootstrapRolePass in an existing role to be used as the file publishing role.
imageAssetPublishingRole?๐Ÿ”นBootstrapRolePass in an existing role to be used as the image publishing role.
imageAssetVersionCount?๐Ÿ”นnumberThe maximum number of image versions to store in a repository.
permissionsBoundary?๐Ÿ”นPermissionsBoundaryOptions for applying a permissions boundary to all IAM Roles and Users created within this Stage.
stackName?๐Ÿ”นstringName to deploy the stack with.
stagingBucketName?๐Ÿ”นstringExplicit name for the staging bucket.
suppressTemplateIndentation?๐Ÿ”นbooleanEnable this flag to suppress indentation in generated CloudFormation templates.
synthesizer?๐Ÿ”นIStackSynthesizerSynthesis method to use while deploying this stack.
tags?๐Ÿ”น{ [string]: string }Stack tags that will be applied to all the taggable resources and the stack itself.
terminationProtection?๐Ÿ”นbooleanWhether to enable termination protection for this stack.

appId๐Ÿ”น

Type: string

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.


qualifier๐Ÿ”น

Type: string

The qualifier used to specialize strings.

Shouldn't be necessary but who knows what people might do.


analyticsReporting?๐Ÿ”น

Type: boolean (optional, default: analyticsReporting setting of containing App, or value of 'aws:cdk:version-reporting' context key)

Include runtime versioning information in this Stack.


autoDeleteStagingAssets?๐Ÿ”น

Type: boolean (optional, default: true)

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


crossRegionReferences?๐Ÿ”น

Type: boolean (optional, default: 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


deployRoleArn?๐Ÿ”น

Type: string (optional, default: The CLI credentials are assumed, no additional permissions are granted.)

The ARN of the deploy action role, if given.

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


deployTimeFileAssetLifetime?๐Ÿ”น

Type: Duration (optional, default: Duration.days(30))

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.


description?๐Ÿ”น

Type: string (optional, default: No description.)

A description of the stack.


env?๐Ÿ”น

Type: Environment (optional, default: The environment of the containing Stage if available, otherwise create the stack will be environment-agnostic.)

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. Example

// 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');

fileAssetPublishingRole?๐Ÿ”น

Type: BootstrapRole (optional, default: a new role will be created)

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


imageAssetPublishingRole?๐Ÿ”น

Type: BootstrapRole (optional, default: a new role will be created)

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


imageAssetVersionCount?๐Ÿ”น

Type: number (optional, default: up to 3 versions stored)

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.


permissionsBoundary?๐Ÿ”น

Type: PermissionsBoundary (optional, default: no permissions boundary is applied)

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


stackName?๐Ÿ”น

Type: string (optional, default: Derived from construct path.)

Name to deploy the stack with.


stagingBucketName?๐Ÿ”น

Type: string (optional, default: a well-known name unique to this app/env.)

Explicit name for the staging bucket.


suppressTemplateIndentation?๐Ÿ”น

Type: boolean (optional, default: the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.)

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.


synthesizer?๐Ÿ”น

Type: IStackSynthesizer (optional, default: The synthesizer specified on App, or DefaultStackSynthesizer otherwise.)

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.


tags?๐Ÿ”น

Type: { [string]: string } (optional, default: {})

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


terminationProtection?๐Ÿ”น

Type: boolean (optional, default: false)

Whether to enable termination protection for this stack.