software.amazon.awscdk.pipelines

Interface DeployCdkStackActionProps

All Superinterfaces:

DeployCdkStackActionOptions, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

DeployCdkStackActionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.26.0 (build 7d76e02)",
           date="2021-03-25T11:30:29.083Z")
 @Stability(value=Experimental)
public interface DeployCdkStackActionProps
extends software.amazon.jsii.JsiiSerializable, DeployCdkStackActionOptions

(experimental) Properties for a DeployCdkStackAction.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static DeployCdkStackActionProps.Builder	builder()
IRole	getActionRole() (experimental) Role for the action to assume.
default IRole	getCloudFormationExecutionRole() (experimental) Role to execute CloudFormation under.
default List<String>	getDependencyStackArtifactIds() (experimental) Artifact ID for the stacks this stack depends on.
default String	getRegion() (experimental) Region to deploy into.
default String	getStackArtifactId() (experimental) Artifact ID for the stack deployed here.
String	getStackName() (experimental) The name of the stack that should be created/updated.
default String	getTemplateConfigurationPath() (experimental) Template configuration path relative to the input artifact.
String	getTemplatePath() (experimental) Relative path of template in the input artifact.

Methods inherited from interface software.amazon.awscdk.pipelines.DeployCdkStackActionOptions

getBaseActionName, getChangeSetName, getCloudAssemblyInput, getExecuteRunOrder, getOutput, getOutputFileName, getPrepareRunOrder

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getActionRole

@Stability(value=Experimental)
 @NotNull
IRole getActionRole()

(experimental) Role for the action to assume.

This controls the account to deploy into

getStackName

@Stability(value=Experimental)
 @NotNull
String getStackName()

(experimental) The name of the stack that should be created/updated.

getTemplatePath

@Stability(value=Experimental)
 @NotNull
String getTemplatePath()

(experimental) Relative path of template in the input artifact.

getCloudFormationExecutionRole

@Stability(value=Experimental)
 @Nullable
default IRole getCloudFormationExecutionRole()

(experimental) Role to execute CloudFormation under.

Default: - Execute CloudFormation using the action role

getDependencyStackArtifactIds

@Stability(value=Experimental)
 @Nullable
default List<String> getDependencyStackArtifactIds()

(experimental) Artifact ID for the stacks this stack depends on.

Used for pipeline order checking.

Default: - No dependencies

getRegion

@Stability(value=Experimental)
 @Nullable
default String getRegion()

(experimental) Region to deploy into.

Default: - Same region as pipeline

getStackArtifactId

@Stability(value=Experimental)
 @Nullable
default String getStackArtifactId()

(experimental) Artifact ID for the stack deployed here.

Used for pipeline order checking.

Default: - Order will not be checked

getTemplateConfigurationPath

@Stability(value=Experimental)
 @Nullable
default String getTemplateConfigurationPath()

(experimental) Template configuration path relative to the input artifact.

Default: - No template configuration

builder

@Stability(value=Experimental)
static DeployCdkStackActionProps.Builder builder()

Specified by:

builder in interface DeployCdkStackActionOptions

Returns:

a DeployCdkStackActionProps.Builder of DeployCdkStackActionProps