Package software.amazon.awscdk
Class SynthesizeStackArtifactOptions.Builder
java.lang.Object
software.amazon.awscdk.SynthesizeStackArtifactOptions.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<SynthesizeStackArtifactOptions>
- Enclosing interface:
SynthesizeStackArtifactOptions
@Stability(Stable)
public static final class SynthesizeStackArtifactOptions.Builder
extends Object
implements software.amazon.jsii.Builder<SynthesizeStackArtifactOptions>
A builder for
SynthesizeStackArtifactOptions
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionadditionalDependencies
(List<String> additionalDependencies) Sets the value ofSynthesizeStackArtifactOptions.getAdditionalDependencies()
assumeRoleArn
(String assumeRoleArn) Sets the value ofSynthesizeStackArtifactOptions.getAssumeRoleArn()
assumeRoleExternalId
(String assumeRoleExternalId) Sets the value ofSynthesizeStackArtifactOptions.getAssumeRoleExternalId()
bootstrapStackVersionSsmParameter
(String bootstrapStackVersionSsmParameter) Sets the value ofSynthesizeStackArtifactOptions.getBootstrapStackVersionSsmParameter()
build()
Builds the configured instance.cloudFormationExecutionRoleArn
(String cloudFormationExecutionRoleArn) Sets the value ofSynthesizeStackArtifactOptions.getCloudFormationExecutionRoleArn()
lookupRole
(BootstrapRole lookupRole) Sets the value ofSynthesizeStackArtifactOptions.getLookupRole()
parameters
(Map<String, String> parameters) Sets the value ofSynthesizeStackArtifactOptions.getParameters()
requiresBootstrapStackVersion
(Number requiresBootstrapStackVersion) Sets the value ofSynthesizeStackArtifactOptions.getRequiresBootstrapStackVersion()
stackTemplateAssetObjectUrl
(String stackTemplateAssetObjectUrl) Sets the value ofSynthesizeStackArtifactOptions.getStackTemplateAssetObjectUrl()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
additionalDependencies
@Stability(Stable) public SynthesizeStackArtifactOptions.Builder additionalDependencies(List<String> additionalDependencies) Sets the value ofSynthesizeStackArtifactOptions.getAdditionalDependencies()
- Parameters:
additionalDependencies
- Identifiers of additional dependencies.- Returns:
this
-
assumeRoleArn
@Stability(Stable) public SynthesizeStackArtifactOptions.Builder assumeRoleArn(String assumeRoleArn) Sets the value ofSynthesizeStackArtifactOptions.getAssumeRoleArn()
- Parameters:
assumeRoleArn
- The role that needs to be assumed to deploy the stack.- Returns:
this
-
assumeRoleExternalId
@Stability(Stable) public SynthesizeStackArtifactOptions.Builder assumeRoleExternalId(String assumeRoleExternalId) Sets the value ofSynthesizeStackArtifactOptions.getAssumeRoleExternalId()
- Parameters:
assumeRoleExternalId
- The externalID to use with the assumeRoleArn.- Returns:
this
-
bootstrapStackVersionSsmParameter
@Stability(Stable) public SynthesizeStackArtifactOptions.Builder bootstrapStackVersionSsmParameter(String bootstrapStackVersionSsmParameter) Sets the value ofSynthesizeStackArtifactOptions.getBootstrapStackVersionSsmParameter()
- Parameters:
bootstrapStackVersionSsmParameter
- SSM parameter where the bootstrap stack version number can be found. Only used ifrequiresBootstrapStackVersion
is set.- If this value is not set, the bootstrap stack name must be known at deployment time so the stack version can be looked up from the stack outputs.
- If this value is set, the bootstrap stack can have any name because we won't need to look it up.
- Returns:
this
-
cloudFormationExecutionRoleArn
@Stability(Stable) public SynthesizeStackArtifactOptions.Builder cloudFormationExecutionRoleArn(String cloudFormationExecutionRoleArn) Sets the value ofSynthesizeStackArtifactOptions.getCloudFormationExecutionRoleArn()
- Parameters:
cloudFormationExecutionRoleArn
- The role that is passed to CloudFormation to execute the change set.- Returns:
this
-
lookupRole
@Stability(Stable) public SynthesizeStackArtifactOptions.Builder lookupRole(BootstrapRole lookupRole) Sets the value ofSynthesizeStackArtifactOptions.getLookupRole()
- Parameters:
lookupRole
- The role to use to look up values from the target AWS account.- Returns:
this
-
parameters
@Stability(Stable) public SynthesizeStackArtifactOptions.Builder parameters(Map<String, String> parameters) Sets the value ofSynthesizeStackArtifactOptions.getParameters()
- Parameters:
parameters
- Values for CloudFormation stack parameters that should be passed when the stack is deployed.- Returns:
this
-
requiresBootstrapStackVersion
@Stability(Stable) public SynthesizeStackArtifactOptions.Builder requiresBootstrapStackVersion(Number requiresBootstrapStackVersion) Sets the value ofSynthesizeStackArtifactOptions.getRequiresBootstrapStackVersion()
- Parameters:
requiresBootstrapStackVersion
- Version of bootstrap stack required to deploy this stack.- Returns:
this
-
stackTemplateAssetObjectUrl
@Stability(Stable) public SynthesizeStackArtifactOptions.Builder stackTemplateAssetObjectUrl(String stackTemplateAssetObjectUrl) Sets the value ofSynthesizeStackArtifactOptions.getStackTemplateAssetObjectUrl()
- Parameters:
stackTemplateAssetObjectUrl
- If the stack template has already been included in the asset manifest, its asset URL.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<SynthesizeStackArtifactOptions>
- Returns:
- a new instance of
SynthesizeStackArtifactOptions
- Throws:
NullPointerException
- if any required attribute was not provided
-