interface DefaultResourcesOptions
Language | Type name |
---|---|
![]() | Amazon.CDK.AppStagingSynthesizer.Alpha.DefaultResourcesOptions |
![]() | software.amazon.awscdk.app.staging.synthesizer.alpha.DefaultResourcesOptions |
![]() | aws_cdk.app_staging_synthesizer_alpha.DefaultResourcesOptions |
![]() | @aws-cdk/app-staging-synthesizer-alpha ยป DefaultResourcesOptions |
Properties for stackPerEnv static method.
Example
const app = new App({
defaultStackSynthesizer: AppStagingSynthesizer.defaultResources({
appId: 'my-app-id',
fileAssetPublishingRole: BootstrapRole.fromRoleArn('arn:aws:iam::123456789012:role/S3Access'),
imageAssetPublishingRole: BootstrapRole.fromRoleArn('arn:aws:iam::123456789012:role/ECRAccess'),
}),
});
Properties
Name | Type | Description |
---|---|---|
app | string | A unique identifier for the application that the staging stack belongs to. |
auto | boolean | Auto deletes objects in the staging S3 bucket and images in the staging ECR repositories. |
bootstrap | string | Qualifier to disambiguate multiple bootstrapped environments in the same account. |
deploy | Duration | The lifetime for deploy time file assets. |
deployment | Deployment | What roles to use to deploy applications. |
file | Bootstrap | Pass in an existing role to be used as the file publishing role. |
image | Bootstrap | Pass in an existing role to be used as the image publishing role. |
image | number | The maximum number of image versions to store in a repository. |
staging | string | Explicit 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.
bootstrapQualifier?
Type:
string
(optional, default: Value of context key '@aws-cdk/core:bootstrapQualifier' if set, otherwise DEFAULT_QUALIFIER
)
Qualifier to disambiguate multiple bootstrapped environments in the same account.
This qualifier is only used to reference bootstrapped resources. It will not
be used in the creation of app-specific staging resources: appId
is used for that
instead.
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.
deploymentIdentities?
Type:
Deployment
(optional, default: The standard bootstrapped CDK roles)
What roles to use to deploy applications.
These are the roles that have permissions to interact with CloudFormation on your behalf. By default these are the standard bootstrapped CDK roles, but you can customize them or turn them off and use the CLI credentials to deploy.
fileAssetPublishingRole?
Type:
Bootstrap
(optional, default: a new role will be created)
Pass in an existing role to be used as the file publishing role.
imageAssetPublishingRole?
Type:
Bootstrap
(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.