software.amazon.awscdk

Class DefaultStackSynthesizer.Builder

java.lang.Object

software.amazon.awscdk.DefaultStackSynthesizer.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<DefaultStackSynthesizer>

Enclosing class:

DefaultStackSynthesizer

@Stability(value=Experimental)
public static final class DefaultStackSynthesizer.Builder
extends Object
implements software.amazon.jsii.Builder<DefaultStackSynthesizer>

(experimental) A fluent builder for DefaultStackSynthesizer.

Method Summary

Modifier and Type	Method and Description
DefaultStackSynthesizer.Builder	bootstrapStackVersionSsmParameter(String bootstrapStackVersionSsmParameter) (experimental) Bootstrap stack version SSM parameter.
DefaultStackSynthesizer.Builder	bucketPrefix(String bucketPrefix) (experimental) bucketPrefix to use while storing S3 Assets.
DefaultStackSynthesizer	build()
DefaultStackSynthesizer.Builder	cloudFormationExecutionRole(String cloudFormationExecutionRole) (experimental) The role CloudFormation will assume when deploying the Stack.
static DefaultStackSynthesizer.Builder	create()
DefaultStackSynthesizer.Builder	deployRoleArn(String deployRoleArn) (experimental) The role to assume to initiate a deployment in this environment.
DefaultStackSynthesizer.Builder	fileAssetPublishingExternalId(String fileAssetPublishingExternalId) (experimental) External ID to use when assuming role for file asset publishing.
DefaultStackSynthesizer.Builder	fileAssetPublishingRoleArn(String fileAssetPublishingRoleArn) (experimental) The role to use to publish file assets to the S3 bucket in this environment.
DefaultStackSynthesizer.Builder	fileAssetsBucketName(String fileAssetsBucketName) (experimental) Name of the S3 bucket to hold file assets.
DefaultStackSynthesizer.Builder	generateBootstrapVersionRule(Boolean generateBootstrapVersionRule) (experimental) Whether to add a Rule to the stack template verifying the bootstrap stack version.
DefaultStackSynthesizer.Builder	imageAssetPublishingExternalId(String imageAssetPublishingExternalId) (experimental) External ID to use when assuming role for image asset publishing.
DefaultStackSynthesizer.Builder	imageAssetPublishingRoleArn(String imageAssetPublishingRoleArn) (experimental) The role to use to publish image assets to the ECR repository in this environment.
DefaultStackSynthesizer.Builder	imageAssetsRepositoryName(String imageAssetsRepositoryName) (experimental) Name of the ECR repository to hold Docker Image assets.
DefaultStackSynthesizer.Builder	lookupRoleArn(String lookupRoleArn) (experimental) The role to use to look up values from the target AWS account during synthesis.
DefaultStackSynthesizer.Builder	qualifier(String qualifier) (experimental) Qualifier to disambiguate multiple environments in the same account.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Experimental)
public static DefaultStackSynthesizer.Builder create()

Returns:

a new instance of DefaultStackSynthesizer.Builder.

bootstrapStackVersionSsmParameter

@Stability(value=Experimental)
public DefaultStackSynthesizer.Builder bootstrapStackVersionSsmParameter(String bootstrapStackVersionSsmParameter)

(experimental) Bootstrap stack version SSM parameter.

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

Default: DefaultStackSynthesizer.DEFAULT_BOOTSTRAP_STACK_VERSION_SSM_PARAMETER

Parameters:

bootstrapStackVersionSsmParameter - Bootstrap stack version SSM parameter. This parameter is required.

Returns:

this

bucketPrefix

@Stability(value=Experimental)
public DefaultStackSynthesizer.Builder bucketPrefix(String bucketPrefix)

(experimental) bucketPrefix to use while storing S3 Assets.

Default: - DefaultStackSynthesizer.DEFAULT_FILE_ASSET_PREFIX

Parameters:

bucketPrefix - bucketPrefix to use while storing S3 Assets. This parameter is required.

Returns:

this

cloudFormationExecutionRole

@Stability(value=Experimental)
public DefaultStackSynthesizer.Builder cloudFormationExecutionRole(String cloudFormationExecutionRole)

(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

Parameters:

cloudFormationExecutionRole - The role CloudFormation will assume when deploying the Stack. This parameter is required.

Returns:

this

deployRoleArn

@Stability(value=Experimental)
public DefaultStackSynthesizer.Builder deployRoleArn(String deployRoleArn)

(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

Parameters:

deployRoleArn - The role to assume to initiate a deployment in this environment. This parameter is required.

Returns:

this

fileAssetPublishingExternalId

@Stability(value=Experimental)
public DefaultStackSynthesizer.Builder fileAssetPublishingExternalId(String fileAssetPublishingExternalId)

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

Default: - No external ID

Parameters:

fileAssetPublishingExternalId - External ID to use when assuming role for file asset publishing. This parameter is required.

Returns:

this

fileAssetPublishingRoleArn

@Stability(value=Experimental)
public DefaultStackSynthesizer.Builder fileAssetPublishingRoleArn(String fileAssetPublishingRoleArn)

(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

Parameters:

fileAssetPublishingRoleArn - The role to use to publish file assets to the S3 bucket in this environment. This parameter is required.

Returns:

this

fileAssetsBucketName

@Stability(value=Experimental)
public DefaultStackSynthesizer.Builder fileAssetsBucketName(String fileAssetsBucketName)

(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

Parameters:

fileAssetsBucketName - Name of the S3 bucket to hold file assets. This parameter is required.

Returns:

this

generateBootstrapVersionRule

@Stability(value=Experimental)
public DefaultStackSynthesizer.Builder generateBootstrapVersionRule(Boolean generateBootstrapVersionRule)

(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

Parameters:

generateBootstrapVersionRule - Whether to add a Rule to the stack template verifying the bootstrap stack version. This parameter is required.

Returns:

this

imageAssetPublishingExternalId

@Stability(value=Experimental)
public DefaultStackSynthesizer.Builder imageAssetPublishingExternalId(String imageAssetPublishingExternalId)

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

Default: - No external ID

Parameters:

imageAssetPublishingExternalId - External ID to use when assuming role for image asset publishing. This parameter is required.

Returns:

this

imageAssetPublishingRoleArn

@Stability(value=Experimental)
public DefaultStackSynthesizer.Builder imageAssetPublishingRoleArn(String imageAssetPublishingRoleArn)

(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

Parameters:

imageAssetPublishingRoleArn - The role to use to publish image assets to the ECR repository in this environment. This parameter is required.

Returns:

this

imageAssetsRepositoryName

@Stability(value=Experimental)
public DefaultStackSynthesizer.Builder imageAssetsRepositoryName(String imageAssetsRepositoryName)

(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

Parameters:

imageAssetsRepositoryName - Name of the ECR repository to hold Docker Image assets. This parameter is required.

Returns:

this

lookupRoleArn

@Stability(value=Experimental)
public DefaultStackSynthesizer.Builder lookupRoleArn(String lookupRoleArn)

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

Default: - None

Parameters:

lookupRoleArn - The role to use to look up values from the target AWS account during synthesis. This parameter is required.

Returns:

this

qualifier

@Stability(value=Experimental)
public DefaultStackSynthesizer.Builder qualifier(String qualifier)

(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 '

Parameters:

qualifier - Qualifier to disambiguate multiple environments in the same account. This parameter is required.

Returns:

this

build

@Stability(value=Experimental)
public DefaultStackSynthesizer build()

Specified by:

build in interface software.amazon.jsii.Builder<DefaultStackSynthesizer>