Package software.amazon.awscdk.core

Interface SynthesizeStackArtifactOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

SynthesizeStackArtifactOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:29:55.148Z")
@Stability(Stable)
public interface SynthesizeStackArtifactOptions
extends software.amazon.jsii.JsiiSerializable

Stack artifact options.

A subset of cxschema.AwsCloudFormationStackProperties of optional settings that need to be configurable by synthesizers, plus additionalDependencies.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.core.*;
 SynthesizeStackArtifactOptions synthesizeStackArtifactOptions = SynthesizeStackArtifactOptions.builder()
         .additionalDependencies(List.of("additionalDependencies"))
         .assumeRoleArn("assumeRoleArn")
         .assumeRoleExternalId("assumeRoleExternalId")
         .bootstrapStackVersionSsmParameter("bootstrapStackVersionSsmParameter")
         .cloudFormationExecutionRoleArn("cloudFormationExecutionRoleArn")
         .lookupRole(BootstrapRole.builder()
                 .arn("arn")
                 // the properties below are optional
                 .assumeRoleExternalId("assumeRoleExternalId")
                 .bootstrapStackVersionSsmParameter("bootstrapStackVersionSsmParameter")
                 .requiresBootstrapStackVersion(123)
                 .build())
         .parameters(Map.of(
                 "parametersKey", "parameters"))
         .requiresBootstrapStackVersion(123)
         .stackTemplateAssetObjectUrl("stackTemplateAssetObjectUrl")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	SynthesizeStackArtifactOptions.Builder	A builder for SynthesizeStackArtifactOptions
static final class	SynthesizeStackArtifactOptions.Jsii$Proxy	An implementation for SynthesizeStackArtifactOptions

Method Summary

Modifier and Type	Method	Description
static SynthesizeStackArtifactOptions.Builder	builder()
default List<String>	getAdditionalDependencies()	Identifiers of additional dependencies.
default String	getAssumeRoleArn()	The role that needs to be assumed to deploy the stack.
default String	getAssumeRoleExternalId()	The externalID to use with the assumeRoleArn.
default String	getBootstrapStackVersionSsmParameter()	SSM parameter where the bootstrap stack version number can be found.
default String	getCloudFormationExecutionRoleArn()	The role that is passed to CloudFormation to execute the change set.
default BootstrapRole	getLookupRole()	The role to use to look up values from the target AWS account.
default Map<String,String>	getParameters()	Values for CloudFormation stack parameters that should be passed when the stack is deployed.
default Number	getRequiresBootstrapStackVersion()	Version of bootstrap stack required to deploy this stack.
default String	getStackTemplateAssetObjectUrl()	If the stack template has already been included in the asset manifest, its asset URL.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAdditionalDependencies

@Stability(Stable)
@Nullable
default List<String> getAdditionalDependencies()

Identifiers of additional dependencies.

Default: - No additional dependencies

getAssumeRoleArn

@Stability(Stable)
@Nullable
default String getAssumeRoleArn()

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

Default: - No role is assumed (current credentials are used)

getAssumeRoleExternalId

@Stability(Stable)
@Nullable
default String getAssumeRoleExternalId()

The externalID to use with the assumeRoleArn.

Default: - No externalID is used

getBootstrapStackVersionSsmParameter

@Stability(Stable)
@Nullable
default String getBootstrapStackVersionSsmParameter()

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.

Default: - Bootstrap stack version number looked up

getCloudFormationExecutionRoleArn

@Stability(Stable)
@Nullable
default String getCloudFormationExecutionRoleArn()

The role that is passed to CloudFormation to execute the change set.

Default: - No role is passed (currently assumed role/credentials are used)

getLookupRole

@Stability(Stable)
@Nullable
default BootstrapRole getLookupRole()

The role to use to look up values from the target AWS account.

Default: - None

getParameters

@Stability(Stable)
@Nullable
default Map<String,String> getParameters()

Values for CloudFormation stack parameters that should be passed when the stack is deployed.

Default: - No parameters

getRequiresBootstrapStackVersion

@Stability(Stable)
@Nullable
default Number getRequiresBootstrapStackVersion()

Version of bootstrap stack required to deploy this stack.

Default: - No bootstrap stack required

getStackTemplateAssetObjectUrl

@Stability(Stable)
@Nullable
default String getStackTemplateAssetObjectUrl()

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

Default: - Not uploaded yet, upload just before deploying

builder

@Stability(Stable)
static SynthesizeStackArtifactOptions.Builder builder()

Returns:

a SynthesizeStackArtifactOptions.Builder of SynthesizeStackArtifactOptions