software.amazon.awscdk.core

Class DefaultStackSynthesizer.Builder

java.lang.Object

software.amazon.awscdk.core.DefaultStackSynthesizer.Builder

Enclosing class:

DefaultStackSynthesizer

@Stability(value=Stable)
public static final class DefaultStackSynthesizer.Builder
extends Object

A fluent builder for DefaultStackSynthesizer.

Method Summary

Modifier and Type	Method and Description
DefaultStackSynthesizer.Builder	assetPublishingExternalId(String assetPublishingExternalId) External ID to use when assuming role for asset publishing.
DefaultStackSynthesizer.Builder	assetPublishingRoleArn(String assetPublishingRoleArn) The role to use to publish assets to this environment.
DefaultStackSynthesizer	build()
DefaultStackSynthesizer.Builder	cloudFormationExecutionRole(String cloudFormationExecutionRole) The role CloudFormation will assume when deploying the Stack.
static DefaultStackSynthesizer.Builder	create()
DefaultStackSynthesizer.Builder	deployActionRoleArn(String deployActionRoleArn) The role to assume to initiate a deployment in this environment.
DefaultStackSynthesizer.Builder	fileAssetsBucketName(String fileAssetsBucketName) Name of the S3 bucket to hold file assets.
DefaultStackSynthesizer.Builder	imageAssetsRepositoryName(String imageAssetsRepositoryName) Name of the ECR repository to hold Docker Image assets.
DefaultStackSynthesizer.Builder	qualifier(String qualifier) 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=Stable)
public static DefaultStackSynthesizer.Builder create()

Returns:

a new instance of DefaultStackSynthesizer.Builder.

assetPublishingExternalId

@Stability(value=Stable)
public DefaultStackSynthesizer.Builder assetPublishingExternalId(String assetPublishingExternalId)

External ID to use when assuming role for asset publishing.

Default: - No external ID

Parameters:

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

Returns:

this

assetPublishingRoleArn

@Stability(value=Stable)
public DefaultStackSynthesizer.Builder assetPublishingRoleArn(String assetPublishingRoleArn)

The role to use to publish assets to 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_ASSET_PUBLISHING_ROLE_ARN

Parameters:

assetPublishingRoleArn - The role to use to publish assets to this environment. This parameter is required.

Returns:

this

cloudFormationExecutionRole

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

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

deployActionRoleArn

@Stability(value=Stable)
public DefaultStackSynthesizer.Builder deployActionRoleArn(String deployActionRoleArn)

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_ACTION_ROLE_ARN

Parameters:

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

Returns:

this

fileAssetsBucketName

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

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

imageAssetsRepositoryName

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

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

qualifier

@Stability(value=Stable)
public DefaultStackSynthesizer.Builder qualifier(String 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 differnet qualifiers.

Default: DefaultStackSynthesizer.DEFAULT_QUALIFIER

Parameters:

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

Returns:

this

build

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