software.amazon.awscdk

Interface DefaultStackSynthesizerProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

DefaultStackSynthesizerProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.29.0 (build 41df200)",
           date="2021-06-02T09:54:53.121Z")
 @Stability(value=Experimental)
public interface DefaultStackSynthesizerProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Configuration properties for DefaultStackSynthesizer.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DefaultStackSynthesizerProps.Builder A builder for DefaultStackSynthesizerProps
static class	DefaultStackSynthesizerProps.Jsii$Proxy An implementation for DefaultStackSynthesizerProps

Method Summary

Modifier and Type	Method and Description
static DefaultStackSynthesizerProps.Builder	builder()
default String	getBucketPrefix() (experimental) bucketPrefix to use while storing S3 Assets.
default String	getCloudFormationExecutionRole() (experimental) The role CloudFormation will assume when deploying the Stack.
default String	getDeployRoleArn() (experimental) The role to assume to initiate a deployment in this environment.
default String	getFileAssetPublishingExternalId() (experimental) External ID to use when assuming role for file asset publishing.
default String	getFileAssetPublishingRoleArn() (experimental) The role to use to publish file assets to the S3 bucket in this environment.
default String	getFileAssetsBucketName() (experimental) Name of the S3 bucket to hold file assets.
default Boolean	getGenerateBootstrapVersionRule() (experimental) Whether to add a Rule to the stack template verifying the bootstrap stack version.
default String	getImageAssetPublishingExternalId() (experimental) External ID to use when assuming role for image asset publishing.
default String	getImageAssetPublishingRoleArn() (experimental) The role to use to publish image assets to the ECR repository in this environment.
default String	getImageAssetsRepositoryName() (experimental) Name of the ECR repository to hold Docker Image assets.
default String	getQualifier() (experimental) Qualifier to disambiguate multiple environments in the same account.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getBucketPrefix

@Stability(value=Experimental)
 @Nullable
default String getBucketPrefix()

(experimental) bucketPrefix to use while storing S3 Assets.

Default: - DefaultStackSynthesizer.DEFAULT_FILE_ASSET_PREFIX

getCloudFormationExecutionRole

@Stability(value=Experimental)
 @Nullable
default String getCloudFormationExecutionRole()

(experimental) 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

getDeployRoleArn

@Stability(value=Experimental)
 @Nullable
default String getDeployRoleArn()

(experimental) 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

getFileAssetPublishingExternalId

@Stability(value=Experimental)
 @Nullable
default String getFileAssetPublishingExternalId()

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

Default: - No external ID

getFileAssetPublishingRoleArn

@Stability(value=Experimental)
 @Nullable
default String getFileAssetPublishingRoleArn()

(experimental) 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(value=Experimental)
 @Nullable
default String getFileAssetsBucketName()

(experimental) 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(value=Experimental)
 @Nullable
default Boolean getGenerateBootstrapVersionRule()

(experimental) 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(value=Experimental)
 @Nullable
default String getImageAssetPublishingExternalId()

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

Default: - No external ID

getImageAssetPublishingRoleArn

@Stability(value=Experimental)
 @Nullable
default String getImageAssetPublishingRoleArn()

(experimental) 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(value=Experimental)
 @Nullable
default String getImageAssetsRepositoryName()

(experimental) 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

getQualifier

@Stability(value=Experimental)
 @Nullable
default String getQualifier()

(experimental) 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 differnet qualifiers.

Default: - Value of context key '

builder

@Stability(value=Experimental)
static DefaultStackSynthesizerProps.Builder builder()

Returns:

a DefaultStackSynthesizerProps.Builder of DefaultStackSynthesizerProps