Package software.amazon.awscdk

Class DefaultStackSynthesizerProps.Builder

java.lang.Object

software.amazon.awscdk.DefaultStackSynthesizerProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<DefaultStackSynthesizerProps>

Enclosing interface:

DefaultStackSynthesizerProps

@Stability(Stable)
public static final class DefaultStackSynthesizerProps.Builder
extends Object
implements software.amazon.jsii.Builder<DefaultStackSynthesizerProps>

A builder for DefaultStackSynthesizerProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DefaultStackSynthesizerProps.Builder	bootstrapStackVersionSsmParameter(String bootstrapStackVersionSsmParameter)	Sets the value of DefaultStackSynthesizerProps.getBootstrapStackVersionSsmParameter()
DefaultStackSynthesizerProps.Builder	bucketPrefix(String bucketPrefix)	Sets the value of DefaultStackSynthesizerProps.getBucketPrefix()
DefaultStackSynthesizerProps	build()	Builds the configured instance.
DefaultStackSynthesizerProps.Builder	cloudFormationExecutionRole(String cloudFormationExecutionRole)	Sets the value of DefaultStackSynthesizerProps.getCloudFormationExecutionRole()
DefaultStackSynthesizerProps.Builder	deployRoleAdditionalOptions(Map<String,? extends Object> deployRoleAdditionalOptions)	Sets the value of DefaultStackSynthesizerProps.getDeployRoleAdditionalOptions()
DefaultStackSynthesizerProps.Builder	deployRoleArn(String deployRoleArn)	Sets the value of DefaultStackSynthesizerProps.getDeployRoleArn()
DefaultStackSynthesizerProps.Builder	deployRoleExternalId(String deployRoleExternalId)	Sets the value of DefaultStackSynthesizerProps.getDeployRoleExternalId()
DefaultStackSynthesizerProps.Builder	dockerTagPrefix(String dockerTagPrefix)	Sets the value of DefaultStackSynthesizerProps.getDockerTagPrefix()
DefaultStackSynthesizerProps.Builder	fileAssetPublishingExternalId(String fileAssetPublishingExternalId)	Sets the value of DefaultStackSynthesizerProps.getFileAssetPublishingExternalId()
DefaultStackSynthesizerProps.Builder	fileAssetPublishingRoleAdditionalOptions(Map<String,? extends Object> fileAssetPublishingRoleAdditionalOptions)	Sets the value of DefaultStackSynthesizerProps.getFileAssetPublishingRoleAdditionalOptions()
DefaultStackSynthesizerProps.Builder	fileAssetPublishingRoleArn(String fileAssetPublishingRoleArn)	Sets the value of DefaultStackSynthesizerProps.getFileAssetPublishingRoleArn()
DefaultStackSynthesizerProps.Builder	fileAssetsBucketName(String fileAssetsBucketName)	Sets the value of DefaultStackSynthesizerProps.getFileAssetsBucketName()
DefaultStackSynthesizerProps.Builder	generateBootstrapVersionRule(Boolean generateBootstrapVersionRule)	Sets the value of DefaultStackSynthesizerProps.getGenerateBootstrapVersionRule()
DefaultStackSynthesizerProps.Builder	imageAssetPublishingExternalId(String imageAssetPublishingExternalId)	Sets the value of DefaultStackSynthesizerProps.getImageAssetPublishingExternalId()
DefaultStackSynthesizerProps.Builder	imageAssetPublishingRoleAdditionalOptions(Map<String,? extends Object> imageAssetPublishingRoleAdditionalOptions)	Sets the value of DefaultStackSynthesizerProps.getImageAssetPublishingRoleAdditionalOptions()
DefaultStackSynthesizerProps.Builder	imageAssetPublishingRoleArn(String imageAssetPublishingRoleArn)	Sets the value of DefaultStackSynthesizerProps.getImageAssetPublishingRoleArn()
DefaultStackSynthesizerProps.Builder	imageAssetsRepositoryName(String imageAssetsRepositoryName)	Sets the value of DefaultStackSynthesizerProps.getImageAssetsRepositoryName()
DefaultStackSynthesizerProps.Builder	lookupRoleAdditionalOptions(Map<String,? extends Object> lookupRoleAdditionalOptions)	Sets the value of DefaultStackSynthesizerProps.getLookupRoleAdditionalOptions()
DefaultStackSynthesizerProps.Builder	lookupRoleArn(String lookupRoleArn)	Sets the value of DefaultStackSynthesizerProps.getLookupRoleArn()
DefaultStackSynthesizerProps.Builder	lookupRoleExternalId(String lookupRoleExternalId)	Sets the value of DefaultStackSynthesizerProps.getLookupRoleExternalId()
DefaultStackSynthesizerProps.Builder	qualifier(String qualifier)	Sets the value of DefaultStackSynthesizerProps.getQualifier()
DefaultStackSynthesizerProps.Builder	useLookupRoleForStackOperations(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 Details

Builder

public Builder()

Method Details

bootstrapStackVersionSsmParameter

@Stability(Stable)
public DefaultStackSynthesizerProps.Builder bootstrapStackVersionSsmParameter(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

@Stability(Stable)
public DefaultStackSynthesizerProps.Builder bucketPrefix(String bucketPrefix)

Sets the value of DefaultStackSynthesizerProps.getBucketPrefix()

Parameters:

bucketPrefix - bucketPrefix to use while storing S3 Assets.

Returns:

this

cloudFormationExecutionRole

@Stability(Stable)
public DefaultStackSynthesizerProps.Builder cloudFormationExecutionRole(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

deployRoleAdditionalOptions

@Stability(Stable)
public DefaultStackSynthesizerProps.Builder deployRoleAdditionalOptions(Map<String,? extends Object> deployRoleAdditionalOptions)

Sets the value of DefaultStackSynthesizerProps.getDeployRoleAdditionalOptions()

Parameters:

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

Returns:

this

deployRoleArn

@Stability(Stable)
public DefaultStackSynthesizerProps.Builder deployRoleArn(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

@Stability(Stable)
public DefaultStackSynthesizerProps.Builder deployRoleExternalId(String deployRoleExternalId)

Sets the value of DefaultStackSynthesizerProps.getDeployRoleExternalId()

Parameters:

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

Returns:

this

dockerTagPrefix

@Stability(Stable)
public DefaultStackSynthesizerProps.Builder dockerTagPrefix(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

fileAssetPublishingExternalId

@Stability(Stable)
public DefaultStackSynthesizerProps.Builder fileAssetPublishingExternalId(String fileAssetPublishingExternalId)

Sets the value of DefaultStackSynthesizerProps.getFileAssetPublishingExternalId()

Parameters:

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

Returns:

this

fileAssetPublishingRoleAdditionalOptions

@Stability(Stable)
public DefaultStackSynthesizerProps.Builder fileAssetPublishingRoleAdditionalOptions(Map<String,? extends Object> fileAssetPublishingRoleAdditionalOptions)

Sets the value of DefaultStackSynthesizerProps.getFileAssetPublishingRoleAdditionalOptions()

Parameters:

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

Returns:

this

fileAssetPublishingRoleArn

@Stability(Stable)
public DefaultStackSynthesizerProps.Builder fileAssetPublishingRoleArn(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

@Stability(Stable)
public DefaultStackSynthesizerProps.Builder fileAssetsBucketName(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

@Stability(Stable)
public DefaultStackSynthesizerProps.Builder generateBootstrapVersionRule(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

@Stability(Stable)
public DefaultStackSynthesizerProps.Builder imageAssetPublishingExternalId(String imageAssetPublishingExternalId)

Sets the value of DefaultStackSynthesizerProps.getImageAssetPublishingExternalId()

Parameters:

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

Returns:

this

imageAssetPublishingRoleAdditionalOptions

@Stability(Stable)
public DefaultStackSynthesizerProps.Builder imageAssetPublishingRoleAdditionalOptions(Map<String,? extends Object> imageAssetPublishingRoleAdditionalOptions)

Sets the value of DefaultStackSynthesizerProps.getImageAssetPublishingRoleAdditionalOptions()

Parameters:

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

Returns:

this

imageAssetPublishingRoleArn

@Stability(Stable)
public DefaultStackSynthesizerProps.Builder imageAssetPublishingRoleArn(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

@Stability(Stable)
public DefaultStackSynthesizerProps.Builder imageAssetsRepositoryName(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

lookupRoleAdditionalOptions

@Stability(Stable)
public DefaultStackSynthesizerProps.Builder lookupRoleAdditionalOptions(Map<String,? extends Object> lookupRoleAdditionalOptions)

Sets the value of DefaultStackSynthesizerProps.getLookupRoleAdditionalOptions()

Parameters:

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

Returns:

this

lookupRoleArn

@Stability(Stable)
public DefaultStackSynthesizerProps.Builder lookupRoleArn(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

@Stability(Stable)
public DefaultStackSynthesizerProps.Builder lookupRoleExternalId(String lookupRoleExternalId)

Sets the value of DefaultStackSynthesizerProps.getLookupRoleExternalId()

Parameters:

lookupRoleExternalId - External ID to use when assuming lookup role.

Returns:

this

qualifier

@Stability(Stable)
public DefaultStackSynthesizerProps.Builder qualifier(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 different qualifiers.

Returns:

this

useLookupRoleForStackOperations

@Stability(Stable)
public DefaultStackSynthesizerProps.Builder useLookupRoleForStackOperations(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

@Stability(Stable)
public DefaultStackSynthesizerProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of DefaultStackSynthesizerProps

Throws:

NullPointerException - if any required attribute was not provided