interface DefaultStackSynthesizerProps

Language	Type name
.NET	`Amazon.CDK.DefaultStackSynthesizerProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2#DefaultStackSynthesizerProps`
Java	`software.amazon.awscdk.DefaultStackSynthesizerProps`
Python	`aws_cdk.DefaultStackSynthesizerProps`
TypeScript (source)	`aws-cdk-lib` » `DefaultStackSynthesizerProps`

Configuration properties for DefaultStackSynthesizer.

Example

new MyStack(app, 'MyStack', {
  synthesizer: new DefaultStackSynthesizer({
    fileAssetsBucketName: 'amzn-s3-demo-bucket',
  }),
});

Properties

Name	Type	Description
bootstrapStackVersionSsmParameter?	`string`	Bootstrap stack version SSM parameter.
bucketPrefix?	`string`	bucketPrefix to use while storing S3 Assets.
cloudFormationExecutionRole?	`string`	The role CloudFormation will assume when deploying the Stack.
deployRoleAdditionalOptions?	`{ [string]: any }`	Additional options to pass to STS when assuming the deploy role.
deployRoleArn?	`string`	The role to assume to initiate a deployment in this environment.
deployRoleExternalId?	`string`	External ID to use when assuming role for cloudformation deployments.
dockerTagPrefix?	`string`	A prefix to use while tagging and uploading Docker images to ECR.
fileAssetPublishingExternalId?	`string`	External ID to use when assuming role for file asset publishing.
fileAssetPublishingRoleAdditionalOptions?	`{ [string]: any }`	Additional options to pass to STS when assuming the file asset publishing.
fileAssetPublishingRoleArn?	`string`	The role to use to publish file assets to the S3 bucket in this environment.
fileAssetsBucketName?	`string`	Name of the S3 bucket to hold file assets.
generateBootstrapVersionRule?	`boolean`	Whether to add a Rule to the stack template verifying the bootstrap stack version.
imageAssetPublishingExternalId?	`string`	External ID to use when assuming role for image asset publishing.
imageAssetPublishingRoleAdditionalOptions?	`{ [string]: any }`	Additional options to pass to STS when assuming the image asset publishing.
imageAssetPublishingRoleArn?	`string`	The role to use to publish image assets to the ECR repository in this environment.
imageAssetsRepositoryName?	`string`	Name of the ECR repository to hold Docker Image assets.
lookupRoleAdditionalOptions?	`{ [string]: any }`	Additional options to pass to STS when assuming the lookup role.
lookupRoleArn?	`string`	The role to use to look up values from the target AWS account during synthesis.
lookupRoleExternalId?	`string`	External ID to use when assuming lookup role.
qualifier?	`string`	Qualifier to disambiguate multiple environments in the same account.
useLookupRoleForStackOperations?	`boolean`	Use the bootstrapped lookup role for (read-only) stack operations.

bootstrapStackVersionSsmParameter?

Type: string (optional, default: DefaultStackSynthesizer.DEFAULT_BOOTSTRAP_STACK_VERSION_SSM_PARAMETER)

Bootstrap stack version SSM parameter.

The placeholder ${Qualifier} will be replaced with the value of qualifier.

bucketPrefix?

Type: string (optional, default: DefaultStackSynthesizer.DEFAULT_FILE_ASSET_PREFIX)

bucketPrefix to use while storing S3 Assets.

cloudFormationExecutionRole?

Type: string (optional, default: DefaultStackSynthesizer.DEFAULT_CLOUDFORMATION_ROLE_ARN)

The role CloudFormation will assume when deploying the Stack.

You must supply this if you have given a non-standard name to the execution role.

The placeholders ${Qualifier}, ${AWS::AccountId} and ${AWS::Region} will be replaced with the values of qualifier and the stack's account and region, respectively.

deployRoleAdditionalOptions?

Type: { [string]: any } (optional, default: No additional options.)

Additional options to pass to STS when assuming the deploy role.

RoleArn should not be used. Use the dedicated deployRoleArn property instead.
ExternalId should not be used. Use the dedicated deployRoleExternalId instead.
TransitiveTagKeys defaults to use all keys (if any) specified in Tags. E.g, all tags are transitive by default.

deployRoleArn?

Type: string (optional, default: DefaultStackSynthesizer.DEFAULT_DEPLOY_ROLE_ARN)

The role to assume to initiate a deployment in this environment.

You must supply this if you have given a non-standard name to the publishing role.

The placeholders ${Qualifier}, ${AWS::AccountId} and ${AWS::Region} will be replaced with the values of qualifier and the stack's account and region, respectively.

deployRoleExternalId?

Type: string (optional, default: No external ID)

External ID to use when assuming role for cloudformation deployments.

dockerTagPrefix?

Type: string (optional, default: DefaultStackSynthesizer.DEFAULT_DOCKER_ASSET_PREFIX)

A prefix to use while tagging and uploading Docker images to ECR.

This does not add any separators - the source hash will be appended to this string directly.

fileAssetPublishingExternalId?

Type: string (optional, default: No external ID)

External ID to use when assuming role for file asset publishing.

fileAssetPublishingRoleAdditionalOptions?

Type: { [string]: any } (optional, default: No additional options.)

Additional options to pass to STS when assuming the file asset publishing.

RoleArn should not be used. Use the dedicated fileAssetPublishingRoleArn property instead.
ExternalId should not be used. Use the dedicated fileAssetPublishingExternalId instead.
TransitiveTagKeys defaults to use all keys (if any) specified in Tags. E.g, all tags are transitive by default.

fileAssetPublishingRoleArn?

Type: string (optional, default: DefaultStackSynthesizer.DEFAULT_FILE_ASSET_PUBLISHING_ROLE_ARN)

The role to use to publish file assets to the S3 bucket in this environment.

You must supply this if you have given a non-standard name to the publishing role.

The placeholders ${Qualifier}, ${AWS::AccountId} and ${AWS::Region} will be replaced with the values of qualifier and the stack's account and region, respectively.

fileAssetsBucketName?

Type: string (optional, default: DefaultStackSynthesizer.DEFAULT_FILE_ASSETS_BUCKET_NAME)

Name of the S3 bucket to hold file assets.

You must supply this if you have given a non-standard name to the staging bucket.

The placeholders ${Qualifier}, ${AWS::AccountId} and ${AWS::Region} will be replaced with the values of qualifier and the stack's account and region, respectively.

generateBootstrapVersionRule?

Type: boolean (optional, default: true)

Whether to add a Rule to the stack template verifying the bootstrap stack version.

This generally should be left set to true, unless you explicitly want to be able to deploy to an unbootstrapped environment.

imageAssetPublishingExternalId?

Type: string (optional, default: No external ID)

External ID to use when assuming role for image asset publishing.

imageAssetPublishingRoleAdditionalOptions?

Type: { [string]: any } (optional, default: No additional options.)

Additional options to pass to STS when assuming the image asset publishing.

RoleArn should not be used. Use the dedicated imageAssetPublishingRoleArn property instead.
ExternalId should not be used. Use the dedicated imageAssetPublishingExternalId instead.
TransitiveTagKeys defaults to use all keys (if any) specified in Tags. E.g, all tags are transitive by default.

imageAssetPublishingRoleArn?

Type: string (optional, default: DefaultStackSynthesizer.DEFAULT_IMAGE_ASSET_PUBLISHING_ROLE_ARN)

The role to use to publish image assets to the ECR repository in this environment.

You must supply this if you have given a non-standard name to the publishing role.

The placeholders ${Qualifier}, ${AWS::AccountId} and ${AWS::Region} will be replaced with the values of qualifier and the stack's account and region, respectively.

imageAssetsRepositoryName?

Type: string (optional, default: DefaultStackSynthesizer.DEFAULT_IMAGE_ASSETS_REPOSITORY_NAME)

Name of the ECR repository to hold Docker Image assets.

You must supply this if you have given a non-standard name to the ECR repository.

The placeholders ${Qualifier}, ${AWS::AccountId} and ${AWS::Region} will be replaced with the values of qualifier and the stack's account and region, respectively.

lookupRoleAdditionalOptions?

Type: { [string]: any } (optional, default: No additional options.)

Additional options to pass to STS when assuming the lookup role.

RoleArn should not be used. Use the dedicated lookupRoleArn property instead.
ExternalId should not be used. Use the dedicated lookupRoleExternalId instead.
TransitiveTagKeys defaults to use all keys (if any) specified in Tags. E.g, all tags are transitive by default.

lookupRoleArn?

Type: string (optional, default: None)

The role to use to look up values from the target AWS account during synthesis.

lookupRoleExternalId?

Type: string (optional, default: No external ID)

External ID to use when assuming lookup role.

qualifier?

Type: string (optional, default: Value of context key '@aws-cdk/core:bootstrapQualifier' if set, otherwise DefaultStackSynthesizer.DEFAULT_QUALIFIER)

Qualifier to disambiguate multiple environments in the same account.

You can use this and leave the other naming properties empty if you have deployed the bootstrap environment with standard names but only different qualifiers.

useLookupRoleForStackOperations?

Type: boolean (optional, default: true)

Use the bootstrapped lookup role for (read-only) stack operations.

Use the lookup role when performing a cdk diff. If set to false, the deploy role credentials will be used to perform a cdk diff.

Requires bootstrap stack version 8.