software.amazon.awscdk.core

Class SynthesizeStackArtifactOptions.Builder

java.lang.Object

software.amazon.awscdk.core.SynthesizeStackArtifactOptions.Builder

Enclosing interface:

SynthesizeStackArtifactOptions

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

A builder for SynthesizeStackArtifactOptions

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
SynthesizeStackArtifactOptions.Builder	additionalDependencies(java.util.List<java.lang.String> additionalDependencies) Sets the value of SynthesizeStackArtifactOptions.getAdditionalDependencies()
SynthesizeStackArtifactOptions.Builder	assumeRoleArn(java.lang.String assumeRoleArn) Sets the value of SynthesizeStackArtifactOptions.getAssumeRoleArn()
SynthesizeStackArtifactOptions.Builder	assumeRoleExternalId(java.lang.String assumeRoleExternalId) Sets the value of SynthesizeStackArtifactOptions.getAssumeRoleExternalId()
SynthesizeStackArtifactOptions.Builder	bootstrapStackVersionSsmParameter(java.lang.String bootstrapStackVersionSsmParameter) Sets the value of SynthesizeStackArtifactOptions.getBootstrapStackVersionSsmParameter()
SynthesizeStackArtifactOptions	build() Builds the configured instance.
SynthesizeStackArtifactOptions.Builder	cloudFormationExecutionRoleArn(java.lang.String cloudFormationExecutionRoleArn) Sets the value of SynthesizeStackArtifactOptions.getCloudFormationExecutionRoleArn()
SynthesizeStackArtifactOptions.Builder	lookupRole(BootstrapRole lookupRole) Sets the value of SynthesizeStackArtifactOptions.getLookupRole()
SynthesizeStackArtifactOptions.Builder	parameters(java.util.Map<java.lang.String,java.lang.String> parameters) Sets the value of SynthesizeStackArtifactOptions.getParameters()
SynthesizeStackArtifactOptions.Builder	requiresBootstrapStackVersion(java.lang.Number requiresBootstrapStackVersion) Sets the value of SynthesizeStackArtifactOptions.getRequiresBootstrapStackVersion()
SynthesizeStackArtifactOptions.Builder	stackTemplateAssetObjectUrl(java.lang.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 Detail

Builder

public Builder()

Method Detail

additionalDependencies

public SynthesizeStackArtifactOptions.Builder additionalDependencies(java.util.List<java.lang.String> additionalDependencies)

Sets the value of SynthesizeStackArtifactOptions.getAdditionalDependencies()

Parameters:

additionalDependencies - Identifiers of additional dependencies.

Returns:

this

assumeRoleArn

public SynthesizeStackArtifactOptions.Builder assumeRoleArn(java.lang.String assumeRoleArn)

Sets the value of SynthesizeStackArtifactOptions.getAssumeRoleArn()

Parameters:

assumeRoleArn - The role that needs to be assumed to deploy the stack.

Returns:

this

assumeRoleExternalId

public SynthesizeStackArtifactOptions.Builder assumeRoleExternalId(java.lang.String assumeRoleExternalId)

Sets the value of SynthesizeStackArtifactOptions.getAssumeRoleExternalId()

Parameters:

assumeRoleExternalId - The externalID to use with the assumeRoleArn.

Returns:

this

bootstrapStackVersionSsmParameter

public SynthesizeStackArtifactOptions.Builder bootstrapStackVersionSsmParameter(java.lang.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

public SynthesizeStackArtifactOptions.Builder cloudFormationExecutionRoleArn(java.lang.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

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

public SynthesizeStackArtifactOptions.Builder parameters(java.util.Map<java.lang.String,java.lang.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

public SynthesizeStackArtifactOptions.Builder requiresBootstrapStackVersion(java.lang.Number requiresBootstrapStackVersion)

Sets the value of SynthesizeStackArtifactOptions.getRequiresBootstrapStackVersion()

Parameters:

requiresBootstrapStackVersion - Version of bootstrap stack required to deploy this stack.

Returns:

this

stackTemplateAssetObjectUrl

public SynthesizeStackArtifactOptions.Builder stackTemplateAssetObjectUrl(java.lang.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

public SynthesizeStackArtifactOptions build()

Builds the configured instance.

Returns:

a new instance of SynthesizeStackArtifactOptions

Throws:

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