Package software.amazon.awscdk

Interface DefaultStackSynthesizerProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
DefaultStackSynthesizerProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:30.957Z") @Stability(Stable) public interface DefaultStackSynthesizerProps extends software.amazon.jsii.JsiiSerializable
Configuration properties for DefaultStackSynthesizer.

Example: 

 App app;
 Stage prodStage = Stage.Builder.create(app, "ProdStage")
         .permissionsBoundary(PermissionsBoundary.fromName("cdk-${Qualifier}-PermissionsBoundary-${AWS::AccountId}-${AWS::Region}"))
         .build();
 Stack.Builder.create(prodStage, "ProdStack")
         .synthesizer(DefaultStackSynthesizer.Builder.create()
                 .qualifier("custom")
                 .build())
         .build();

  • Method Details

    • getBootstrapStackVersionSsmParameter

      @Stability(Stable) @Nullable default String getBootstrapStackVersionSsmParameter()
      Bootstrap stack version SSM parameter.

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

      Default: DefaultStackSynthesizer.DEFAULT_BOOTSTRAP_STACK_VERSION_SSM_PARAMETER

    • getBucketPrefix

      @Stability(Stable) @Nullable default String getBucketPrefix()
      bucketPrefix to use while storing S3 Assets.

      Default: - DefaultStackSynthesizer.DEFAULT_FILE_ASSET_PREFIX

    • getCloudFormationExecutionRole

      @Stability(Stable) @Nullable default String getCloudFormationExecutionRole()
      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.

      Default: DefaultStackSynthesizer.DEFAULT_CLOUDFORMATION_ROLE_ARN

    • getDeployRoleAdditionalOptions

      @Stability(Stable) @Nullable default Map<String,Object> getDeployRoleAdditionalOptions()
      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.

      Default: - No additional options.

      See Also:

    • getDeployRoleArn

      @Stability(Stable) @Nullable default String getDeployRoleArn()
      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.

      Default: DefaultStackSynthesizer.DEFAULT_DEPLOY_ROLE_ARN

    • getDeployRoleExternalId

      @Stability(Stable) @Nullable default String getDeployRoleExternalId()
      External ID to use when assuming role for cloudformation deployments.

      Default: - No external ID

    • getDockerTagPrefix

      @Stability(Stable) @Nullable default String getDockerTagPrefix()
      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.

      Default: - DefaultStackSynthesizer.DEFAULT_DOCKER_ASSET_PREFIX

    • getFileAssetPublishingExternalId

      @Stability(Stable) @Nullable default String getFileAssetPublishingExternalId()
      External ID to use when assuming role for file asset publishing.

      Default: - No external ID

    • getFileAssetPublishingRoleAdditionalOptions

      @Stability(Stable) @Nullable default Map<String,Object> getFileAssetPublishingRoleAdditionalOptions()
      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.

      Default: - No additional options.

      See Also:

    • getFileAssetPublishingRoleArn

      @Stability(Stable) @Nullable default String getFileAssetPublishingRoleArn()
      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.

      Default: DefaultStackSynthesizer.DEFAULT_FILE_ASSET_PUBLISHING_ROLE_ARN

    • getFileAssetsBucketName

      @Stability(Stable) @Nullable default String getFileAssetsBucketName()
      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.

      Default: DefaultStackSynthesizer.DEFAULT_FILE_ASSETS_BUCKET_NAME

    • getGenerateBootstrapVersionRule

      @Stability(Stable) @Nullable default Boolean getGenerateBootstrapVersionRule()
      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.

      Default: true

    • getImageAssetPublishingExternalId

      @Stability(Stable) @Nullable default String getImageAssetPublishingExternalId()
      External ID to use when assuming role for image asset publishing.

      Default: - No external ID

    • getImageAssetPublishingRoleAdditionalOptions

      @Stability(Stable) @Nullable default Map<String,Object> getImageAssetPublishingRoleAdditionalOptions()
      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.

      Default: - No additional options.

      See Also:

    • getImageAssetPublishingRoleArn

      @Stability(Stable) @Nullable default String getImageAssetPublishingRoleArn()
      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.

      Default: DefaultStackSynthesizer.DEFAULT_IMAGE_ASSET_PUBLISHING_ROLE_ARN

    • getImageAssetsRepositoryName

      @Stability(Stable) @Nullable default String getImageAssetsRepositoryName()
      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.

      Default: DefaultStackSynthesizer.DEFAULT_IMAGE_ASSETS_REPOSITORY_NAME

    • getLookupRoleAdditionalOptions

      @Stability(Stable) @Nullable default Map<String,Object> getLookupRoleAdditionalOptions()
      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.

      Default: - No additional options.

      See Also:

    • getLookupRoleArn

      @Stability(Stable) @Nullable default String getLookupRoleArn()
      The role to use to look up values from the target AWS account during synthesis.

      Default: - None

    • getLookupRoleExternalId

      @Stability(Stable) @Nullable default String getLookupRoleExternalId()
      External ID to use when assuming lookup role.

      Default: - No external ID

    • getQualifier

      @Stability(Stable) @Nullable default String getQualifier()
      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.

      Default: - Value of context key '@aws-cdk/core:bootstrapQualifier' if set, otherwise `DefaultStackSynthesizer.DEFAULT_QUALIFIER`

    • getUseLookupRoleForStackOperations

      @Stability(Stable) @Nullable default Boolean getUseLookupRoleForStackOperations()
      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.

      Default: true

    • builder

      @Stability(Stable) static DefaultStackSynthesizerProps.Builder builder()
      Returns:
      a DefaultStackSynthesizerProps.Builder of DefaultStackSynthesizerProps