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

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SynthesizeStackArtifactOptions.Builder	additionalDependencies(List<String> additionalDependencies)	Sets the value of SynthesizeStackArtifactOptions.getAdditionalDependencies()
SynthesizeStackArtifactOptions.Builder	assumeRoleAdditionalOptions(Map<String,? extends Object> assumeRoleAdditionalOptions)	Sets the value of SynthesizeStackArtifactOptions.getAssumeRoleAdditionalOptions()
SynthesizeStackArtifactOptions.Builder	assumeRoleArn(String assumeRoleArn)	Sets the value of SynthesizeStackArtifactOptions.getAssumeRoleArn()
SynthesizeStackArtifactOptions.Builder	assumeRoleExternalId(String assumeRoleExternalId)	Sets the value of SynthesizeStackArtifactOptions.getAssumeRoleExternalId()
SynthesizeStackArtifactOptions.Builder	bootstrapStackVersionSsmParameter(String bootstrapStackVersionSsmParameter)	Sets the value of SynthesizeStackArtifactOptions.getBootstrapStackVersionSsmParameter()
SynthesizeStackArtifactOptions	build()	Builds the configured instance.
SynthesizeStackArtifactOptions.Builder	cloudFormationExecutionRoleArn(String cloudFormationExecutionRoleArn)	Sets the value of SynthesizeStackArtifactOptions.getCloudFormationExecutionRoleArn()
SynthesizeStackArtifactOptions.Builder	lookupRole(BootstrapRole lookupRole)	Sets the value of SynthesizeStackArtifactOptions.getLookupRole()
SynthesizeStackArtifactOptions.Builder	parameters(Map<String,String> parameters)	Sets the value of SynthesizeStackArtifactOptions.getParameters()
SynthesizeStackArtifactOptions.Builder	requiresBootstrapStackVersion(Number requiresBootstrapStackVersion)	Sets the value of SynthesizeStackArtifactOptions.getRequiresBootstrapStackVersion()
SynthesizeStackArtifactOptions.Builder	stackTemplateAssetObjectUrl(String stackTemplateAssetObjectUrl)	Sets the value of SynthesizeStackArtifactOptions.getStackTemplateAssetObjectUrl()

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

additionalDependencies

@Stability(Stable)
public SynthesizeStackArtifactOptions.Builder additionalDependencies(List<String> additionalDependencies)

Sets the value of SynthesizeStackArtifactOptions.getAdditionalDependencies()

Parameters:

additionalDependencies - Identifiers of additional dependencies.

Returns:

this

assumeRoleAdditionalOptions

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

Sets the value of SynthesizeStackArtifactOptions.getAssumeRoleAdditionalOptions()

Parameters:

assumeRoleAdditionalOptions - Additional options to pass to STS when assuming the role for cloudformation deployments.

• RoleArn should not be used. Use the dedicated assumeRoleArn property instead.
• ExternalId should not be used. Use the dedicated assumeRoleExternalId instead.
• TransitiveTagKeys defaults to use all keys (if any) specified in Tags. E.g, all tags are transitive by default.

Returns:

this

assumeRoleArn

@Stability(Stable)
public SynthesizeStackArtifactOptions.Builder assumeRoleArn(String assumeRoleArn)

Sets the value of SynthesizeStackArtifactOptions.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 of SynthesizeStackArtifactOptions.getAssumeRoleExternalId()

Parameters:

assumeRoleExternalId - The externalID to use with the assumeRoleArn.

Returns:

this

bootstrapStackVersionSsmParameter

@Stability(Stable)
public SynthesizeStackArtifactOptions.Builder bootstrapStackVersionSsmParameter(String bootstrapStackVersionSsmParameter)

Sets the value of SynthesizeStackArtifactOptions.getBootstrapStackVersionSsmParameter()

Parameters:

bootstrapStackVersionSsmParameter - SSM parameter where the bootstrap stack version number can be found. Only used if requiresBootstrapStackVersion 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 of SynthesizeStackArtifactOptions.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 of SynthesizeStackArtifactOptions.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 of SynthesizeStackArtifactOptions.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 of SynthesizeStackArtifactOptions.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 of SynthesizeStackArtifactOptions.getStackTemplateAssetObjectUrl()

Parameters:

stackTemplateAssetObjectUrl - If the stack template has already been included in the asset manifest, its asset URL.

Returns:

this

build

@Stability(Stable)
public SynthesizeStackArtifactOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of SynthesizeStackArtifactOptions

Throws:

NullPointerException - if any required attribute was not provided