software.amazon.awscdk

Class DefaultStackSynthesizer

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.StackSynthesizer

software.amazon.awscdk.DefaultStackSynthesizer

All Implemented Interfaces:

IStackSynthesizer, software.amazon.jsii.JsiiSerializable

Direct Known Subclasses:

BootstraplessSynthesizer

@Generated(value="jsii-pacmak/1.30.0 (build adae23f)",
           date="2021-06-30T10:00:42.447Z")
 @Stability(value=Experimental)
public class DefaultStackSynthesizer
extends StackSynthesizer

(experimental) Uses conventionally named roles and reify asset storage locations.

This synthesizer is the only StackSynthesizer that generates an asset manifest, and is required to deploy CDK applications using the @aws-cdk/app-delivery CI/CD library.

Requires the environment to have been bootstrapped with Bootstrap Stack V2.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultStackSynthesizer.Builder (experimental) A fluent builder for DefaultStackSynthesizer.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IStackSynthesizer

IStackSynthesizer.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_BOOTSTRAP_STACK_VERSION_SSM_PARAMETER (experimental) Default bootstrap stack version SSM parameter.
static String	DEFAULT_CLOUDFORMATION_ROLE_ARN (experimental) Default CloudFormation role ARN.
static String	DEFAULT_DEPLOY_ROLE_ARN (experimental) Default deploy role ARN.
static String	DEFAULT_FILE_ASSET_KEY_ARN_EXPORT_NAME (experimental) Name of the CloudFormation Export with the asset key name.
static String	DEFAULT_FILE_ASSET_PREFIX (experimental) Default file asset prefix.
static String	DEFAULT_FILE_ASSET_PUBLISHING_ROLE_ARN (experimental) Default asset publishing role ARN for file (S3) assets.
static String	DEFAULT_FILE_ASSETS_BUCKET_NAME (experimental) Default file assets bucket name.
static String	DEFAULT_IMAGE_ASSET_PUBLISHING_ROLE_ARN (experimental) Default asset publishing role ARN for image (ECR) assets.
static String	DEFAULT_IMAGE_ASSETS_REPOSITORY_NAME (experimental) Default image assets repository name.
static String	DEFAULT_LOOKUP_ROLE_ARN (experimental) Default lookup role ARN for missing values.
static String	DEFAULT_QUALIFIER (experimental) Default ARN qualifier.

Constructor Summary

Constructors

Modifier	Constructor and Description
	DefaultStackSynthesizer()
	DefaultStackSynthesizer(DefaultStackSynthesizerProps props)
protected	DefaultStackSynthesizer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	DefaultStackSynthesizer(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
DockerImageAssetLocation	addDockerImageAsset(DockerImageAssetSource asset) (experimental) Register a Docker Image Asset.
FileAssetLocation	addFileAsset(FileAssetSource asset) (experimental) Register a File Asset.
void	bind(Stack stack) (experimental) Bind to the stack this environment is going to be used on.
String	getCloudFormationExecutionRoleArn() (experimental) Returns the ARN of the CFN execution Role.
String	getDeployRoleArn() (experimental) Returns the ARN of the deploy Role.
protected Stack	getStack()
void	synthesize(ISynthesisSession session) (experimental) Synthesize the associated stack to the session.
protected void	synthesizeStackTemplate(Stack stack, ISynthesisSession session) (experimental) Have the stack write out its template.

Methods inherited from class software.amazon.awscdk.StackSynthesizer

emitStackArtifact, emitStackArtifact

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

DEFAULT_BOOTSTRAP_STACK_VERSION_SSM_PARAMETER

@Stability(value=Experimental)
public static final String DEFAULT_BOOTSTRAP_STACK_VERSION_SSM_PARAMETER

(experimental) Default bootstrap stack version SSM parameter.

DEFAULT_CLOUDFORMATION_ROLE_ARN

@Stability(value=Experimental)
public static final String DEFAULT_CLOUDFORMATION_ROLE_ARN

(experimental) Default CloudFormation role ARN.

DEFAULT_DEPLOY_ROLE_ARN

@Stability(value=Experimental)
public static final String DEFAULT_DEPLOY_ROLE_ARN

(experimental) Default deploy role ARN.

DEFAULT_FILE_ASSET_KEY_ARN_EXPORT_NAME

@Stability(value=Experimental)
public static final String DEFAULT_FILE_ASSET_KEY_ARN_EXPORT_NAME

(experimental) Name of the CloudFormation Export with the asset key name.

DEFAULT_FILE_ASSET_PREFIX

@Stability(value=Experimental)
public static final String DEFAULT_FILE_ASSET_PREFIX

(experimental) Default file asset prefix.

DEFAULT_FILE_ASSET_PUBLISHING_ROLE_ARN

@Stability(value=Experimental)
public static final String DEFAULT_FILE_ASSET_PUBLISHING_ROLE_ARN

(experimental) Default asset publishing role ARN for file (S3) assets.

DEFAULT_FILE_ASSETS_BUCKET_NAME

@Stability(value=Experimental)
public static final String DEFAULT_FILE_ASSETS_BUCKET_NAME

(experimental) Default file assets bucket name.

DEFAULT_IMAGE_ASSET_PUBLISHING_ROLE_ARN

@Stability(value=Experimental)
public static final String DEFAULT_IMAGE_ASSET_PUBLISHING_ROLE_ARN

(experimental) Default asset publishing role ARN for image (ECR) assets.

DEFAULT_IMAGE_ASSETS_REPOSITORY_NAME

@Stability(value=Experimental)
public static final String DEFAULT_IMAGE_ASSETS_REPOSITORY_NAME

(experimental) Default image assets repository name.

DEFAULT_LOOKUP_ROLE_ARN

@Stability(value=Experimental)
public static final String DEFAULT_LOOKUP_ROLE_ARN

(experimental) Default lookup role ARN for missing values.

DEFAULT_QUALIFIER

@Stability(value=Experimental)
public static final String DEFAULT_QUALIFIER

(experimental) Default ARN qualifier.

Constructor Detail

DefaultStackSynthesizer

protected DefaultStackSynthesizer(software.amazon.jsii.JsiiObjectRef objRef)

DefaultStackSynthesizer

protected DefaultStackSynthesizer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

DefaultStackSynthesizer

@Stability(value=Experimental)
public DefaultStackSynthesizer(@Nullable
                                                              DefaultStackSynthesizerProps props)

Parameters:

props -

DefaultStackSynthesizer

@Stability(value=Experimental)
public DefaultStackSynthesizer()

Method Detail

addDockerImageAsset

@Stability(value=Experimental)
 @NotNull
public DockerImageAssetLocation addDockerImageAsset(@NotNull
                                                                                             DockerImageAssetSource asset)

(experimental) Register a Docker Image Asset.

Returns the parameters that can be used to refer to the asset inside the template.

Specified by:

addDockerImageAsset in interface IStackSynthesizer

Specified by:

addDockerImageAsset in class StackSynthesizer

Parameters:

asset - This parameter is required.

addFileAsset

@Stability(value=Experimental)
 @NotNull
public FileAssetLocation addFileAsset(@NotNull
                                                                               FileAssetSource asset)

(experimental) Register a File Asset.

Returns the parameters that can be used to refer to the asset inside the template.

Specified by:

addFileAsset in interface IStackSynthesizer

Specified by:

addFileAsset in class StackSynthesizer

Parameters:

asset - This parameter is required.

bind

@Stability(value=Experimental)
public void bind(@NotNull
                                                Stack stack)

(experimental) Bind to the stack this environment is going to be used on.

Must be called before any of the other methods are called.

Specified by:

bind in interface IStackSynthesizer

Specified by:

bind in class StackSynthesizer

Parameters:

stack - This parameter is required.

synthesize

@Stability(value=Experimental)
public void synthesize(@NotNull
                                                      ISynthesisSession session)

(experimental) Synthesize the associated stack to the session.

Specified by:

synthesize in interface IStackSynthesizer

Specified by:

synthesize in class StackSynthesizer

Parameters:

session - This parameter is required.

synthesizeStackTemplate

@Stability(value=Experimental)
protected void synthesizeStackTemplate(@NotNull
                                                                      Stack stack,
                                                                      @NotNull
                                                                      ISynthesisSession session)

(experimental) Have the stack write out its template.

Overrides:

synthesizeStackTemplate in class StackSynthesizer

Parameters:

stack - This parameter is required.

session - This parameter is required.

getCloudFormationExecutionRoleArn

@Stability(value=Experimental)
 @NotNull
public String getCloudFormationExecutionRoleArn()

(experimental) Returns the ARN of the CFN execution Role.

getDeployRoleArn

@Stability(value=Experimental)
 @NotNull
public String getDeployRoleArn()

(experimental) Returns the ARN of the deploy Role.

getStack

@Stability(value=Experimental)
 @Nullable
protected Stack getStack()