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

interface DefaultStagingStackOptions ๐Ÿ”น

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

User configurable options to the DefaultStagingStack.

Example

const defaultStagingStack = DefaultStagingStack.factory({ appId: 'my-app-id' });

Properties

NameTypeDescription
appId๐Ÿ”นstringA unique identifier for the application that the staging stack belongs to.
autoDeleteStagingAssets?๐Ÿ”นbooleanAuto deletes objects in the staging S3 bucket and images in the staging ECR repositories.
deployTimeFileAssetLifetime?๐Ÿ”นDurationThe lifetime for deploy time file assets.
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.
stagingBucketName?๐Ÿ”นstringExplicit name for the staging bucket.

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.


autoDeleteStagingAssets?๐Ÿ”น

Type: boolean (optional, default: true)

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


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.


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.


stagingBucketName?๐Ÿ”น

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

Explicit name for the staging bucket.