software.amazon.awscdk.core

Class DefaultStackSynthesizerProps.Builder

java.lang.Object

software.amazon.awscdk.core.DefaultStackSynthesizerProps.Builder

Enclosing interface:

DefaultStackSynthesizerProps

public static final class DefaultStackSynthesizerProps.Builder
extends java.lang.Object

A builder for DefaultStackSynthesizerProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
DefaultStackSynthesizerProps.Builder	bootstrapStackVersionSsmParameter(java.lang.String bootstrapStackVersionSsmParameter) Sets the value of DefaultStackSynthesizerProps.getBootstrapStackVersionSsmParameter()
DefaultStackSynthesizerProps.Builder	bucketPrefix(java.lang.String bucketPrefix) Sets the value of DefaultStackSynthesizerProps.getBucketPrefix()
DefaultStackSynthesizerProps	build() Builds the configured instance.
DefaultStackSynthesizerProps.Builder	cloudFormationExecutionRole(java.lang.String cloudFormationExecutionRole) Sets the value of DefaultStackSynthesizerProps.getCloudFormationExecutionRole()
DefaultStackSynthesizerProps.Builder	deployRoleArn(java.lang.String deployRoleArn) Sets the value of DefaultStackSynthesizerProps.getDeployRoleArn()
DefaultStackSynthesizerProps.Builder	deployRoleExternalId(java.lang.String deployRoleExternalId) Sets the value of DefaultStackSynthesizerProps.getDeployRoleExternalId()
DefaultStackSynthesizerProps.Builder	dockerTagPrefix(java.lang.String dockerTagPrefix) Sets the value of DefaultStackSynthesizerProps.getDockerTagPrefix()
DefaultStackSynthesizerProps.Builder	fileAssetKeyArnExportName(java.lang.String fileAssetKeyArnExportName) Deprecated. This property is not used anymore
DefaultStackSynthesizerProps.Builder	fileAssetPublishingExternalId(java.lang.String fileAssetPublishingExternalId) Sets the value of DefaultStackSynthesizerProps.getFileAssetPublishingExternalId()
DefaultStackSynthesizerProps.Builder	fileAssetPublishingRoleArn(java.lang.String fileAssetPublishingRoleArn) Sets the value of DefaultStackSynthesizerProps.getFileAssetPublishingRoleArn()
DefaultStackSynthesizerProps.Builder	fileAssetsBucketName(java.lang.String fileAssetsBucketName) Sets the value of DefaultStackSynthesizerProps.getFileAssetsBucketName()
DefaultStackSynthesizerProps.Builder	generateBootstrapVersionRule(java.lang.Boolean generateBootstrapVersionRule) Sets the value of DefaultStackSynthesizerProps.getGenerateBootstrapVersionRule()
DefaultStackSynthesizerProps.Builder	imageAssetPublishingExternalId(java.lang.String imageAssetPublishingExternalId) Sets the value of DefaultStackSynthesizerProps.getImageAssetPublishingExternalId()
DefaultStackSynthesizerProps.Builder	imageAssetPublishingRoleArn(java.lang.String imageAssetPublishingRoleArn) Sets the value of DefaultStackSynthesizerProps.getImageAssetPublishingRoleArn()
DefaultStackSynthesizerProps.Builder	imageAssetsRepositoryName(java.lang.String imageAssetsRepositoryName) Sets the value of DefaultStackSynthesizerProps.getImageAssetsRepositoryName()
DefaultStackSynthesizerProps.Builder	lookupRoleArn(java.lang.String lookupRoleArn) Sets the value of DefaultStackSynthesizerProps.getLookupRoleArn()
DefaultStackSynthesizerProps.Builder	lookupRoleExternalId(java.lang.String lookupRoleExternalId) Sets the value of DefaultStackSynthesizerProps.getLookupRoleExternalId()
DefaultStackSynthesizerProps.Builder	qualifier(java.lang.String qualifier) Sets the value of DefaultStackSynthesizerProps.getQualifier()
DefaultStackSynthesizerProps.Builder	useLookupRoleForStackOperations(java.lang.Boolean useLookupRoleForStackOperations) Sets the value of DefaultStackSynthesizerProps.getUseLookupRoleForStackOperations()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

bootstrapStackVersionSsmParameter

public DefaultStackSynthesizerProps.Builder bootstrapStackVersionSsmParameter(java.lang.String bootstrapStackVersionSsmParameter)

Sets the value of DefaultStackSynthesizerProps.getBootstrapStackVersionSsmParameter()

Parameters:

bootstrapStackVersionSsmParameter - Bootstrap stack version SSM parameter. The placeholder ${Qualifier} will be replaced with the value of qualifier.

Returns:

this

bucketPrefix

public DefaultStackSynthesizerProps.Builder bucketPrefix(java.lang.String bucketPrefix)

Sets the value of DefaultStackSynthesizerProps.getBucketPrefix()

Parameters:

bucketPrefix - bucketPrefix to use while storing S3 Assets.

Returns:

this

cloudFormationExecutionRole

public DefaultStackSynthesizerProps.Builder cloudFormationExecutionRole(java.lang.String cloudFormationExecutionRole)

Sets the value of DefaultStackSynthesizerProps.getCloudFormationExecutionRole()

Parameters:

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.

Returns:

this

deployRoleArn

public DefaultStackSynthesizerProps.Builder deployRoleArn(java.lang.String deployRoleArn)

Sets the value of DefaultStackSynthesizerProps.getDeployRoleArn()

Parameters:

deployRoleArn - 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.

Returns:

this

deployRoleExternalId

public DefaultStackSynthesizerProps.Builder deployRoleExternalId(java.lang.String deployRoleExternalId)

Sets the value of DefaultStackSynthesizerProps.getDeployRoleExternalId()

Parameters:

deployRoleExternalId - External ID to use when assuming role for cloudformation deployments.

Returns:

this

dockerTagPrefix

public DefaultStackSynthesizerProps.Builder dockerTagPrefix(java.lang.String dockerTagPrefix)

Sets the value of DefaultStackSynthesizerProps.getDockerTagPrefix()

Parameters:

dockerTagPrefix - 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.

Returns:

this

fileAssetKeyArnExportName

@Deprecated
public DefaultStackSynthesizerProps.Builder fileAssetKeyArnExportName(java.lang.String fileAssetKeyArnExportName)

Deprecated. This property is not used anymore

Sets the value of DefaultStackSynthesizerProps.getFileAssetKeyArnExportName()

Parameters:

fileAssetKeyArnExportName - Name of the CloudFormation Export with the asset key name. You must supply this if you have given a non-standard name to the KMS key export

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

Returns:

this

fileAssetPublishingExternalId

public DefaultStackSynthesizerProps.Builder fileAssetPublishingExternalId(java.lang.String fileAssetPublishingExternalId)

Sets the value of DefaultStackSynthesizerProps.getFileAssetPublishingExternalId()

Parameters:

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

Returns:

this

fileAssetPublishingRoleArn

public DefaultStackSynthesizerProps.Builder fileAssetPublishingRoleArn(java.lang.String fileAssetPublishingRoleArn)

Sets the value of DefaultStackSynthesizerProps.getFileAssetPublishingRoleArn()

Parameters:

fileAssetPublishingRoleArn - 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.

Returns:

this

fileAssetsBucketName

public DefaultStackSynthesizerProps.Builder fileAssetsBucketName(java.lang.String fileAssetsBucketName)

Sets the value of DefaultStackSynthesizerProps.getFileAssetsBucketName()

Parameters:

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.

Returns:

this

generateBootstrapVersionRule

public DefaultStackSynthesizerProps.Builder generateBootstrapVersionRule(java.lang.Boolean generateBootstrapVersionRule)

Sets the value of DefaultStackSynthesizerProps.getGenerateBootstrapVersionRule()

Parameters:

generateBootstrapVersionRule - 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.

Returns:

this

imageAssetPublishingExternalId

public DefaultStackSynthesizerProps.Builder imageAssetPublishingExternalId(java.lang.String imageAssetPublishingExternalId)

Sets the value of DefaultStackSynthesizerProps.getImageAssetPublishingExternalId()

Parameters:

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

Returns:

this

imageAssetPublishingRoleArn

public DefaultStackSynthesizerProps.Builder imageAssetPublishingRoleArn(java.lang.String imageAssetPublishingRoleArn)

Sets the value of DefaultStackSynthesizerProps.getImageAssetPublishingRoleArn()

Parameters:

imageAssetPublishingRoleArn - 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.

Returns:

this

imageAssetsRepositoryName

public DefaultStackSynthesizerProps.Builder imageAssetsRepositoryName(java.lang.String imageAssetsRepositoryName)

Sets the value of DefaultStackSynthesizerProps.getImageAssetsRepositoryName()

Parameters:

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.

Returns:

this

lookupRoleArn

public DefaultStackSynthesizerProps.Builder lookupRoleArn(java.lang.String lookupRoleArn)

Sets the value of DefaultStackSynthesizerProps.getLookupRoleArn()

Parameters:

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

Returns:

this

lookupRoleExternalId

public DefaultStackSynthesizerProps.Builder lookupRoleExternalId(java.lang.String lookupRoleExternalId)

Sets the value of DefaultStackSynthesizerProps.getLookupRoleExternalId()

Parameters:

lookupRoleExternalId - External ID to use when assuming lookup role.

Returns:

this

qualifier

public DefaultStackSynthesizerProps.Builder qualifier(java.lang.String qualifier)

Sets the value of DefaultStackSynthesizerProps.getQualifier()

Parameters:

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.

Returns:

this

useLookupRoleForStackOperations

public DefaultStackSynthesizerProps.Builder useLookupRoleForStackOperations(java.lang.Boolean useLookupRoleForStackOperations)

Sets the value of DefaultStackSynthesizerProps.getUseLookupRoleForStackOperations()

Parameters:

useLookupRoleForStackOperations - 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.

Returns:

this

build

public DefaultStackSynthesizerProps build()

Builds the configured instance.

Returns:

a new instance of DefaultStackSynthesizerProps

Throws:

java.lang.NullPointerException - if any required attribute was not provided