software.amazon.awscdk.services.codepipeline.actions

Interface CloudFormationExecuteChangeSetActionProps

All Superinterfaces:

CommonActionProps, CommonAwsActionProps, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CloudFormationExecuteChangeSetActionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.29.0 (build 41df200)",
           date="2021-06-02T09:55:07.418Z")
 @Stability(value=Experimental)
public interface CloudFormationExecuteChangeSetActionProps
extends software.amazon.jsii.JsiiSerializable, CommonAwsActionProps

(experimental) Properties for the CloudFormationExecuteChangeSetAction.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CloudFormationExecuteChangeSetActionProps.Builder	builder()
default String	getAccount() (experimental) The AWS account this Action is supposed to operate in.
String	getChangeSetName() (experimental) Name of the change set to execute.
default Artifact	getOutput() (experimental) The name of the output artifact to generate.
default String	getOutputFileName() (experimental) A name for the filename in the output artifact to store the AWS CloudFormation call's result.
default String	getRegion() (experimental) The AWS region the given Action resides in.
String	getStackName() (experimental) The name of the stack to apply this action to.

Methods inherited from interface software.amazon.awscdk.services.codepipeline.CommonAwsActionProps

getRole

Methods inherited from interface software.amazon.awscdk.services.codepipeline.CommonActionProps

getActionName, getRunOrder, getVariablesNamespace

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getChangeSetName

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

(experimental) Name of the change set to execute.

getStackName

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

(experimental) The name of the stack to apply this action to.

getAccount

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

(experimental) The AWS account this Action is supposed to operate in.

Note: if you specify the role property, this is ignored - the action will operate in the same region the passed role does.

Default: - action resides in the same account as the pipeline

getOutput

@Stability(value=Experimental)
 @Nullable
default Artifact getOutput()

(experimental) The name of the output artifact to generate.

Only applied if outputFileName is set as well.

Default: Automatically generated artifact name.

getOutputFileName

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

(experimental) A name for the filename in the output artifact to store the AWS CloudFormation call's result.

The file will contain the result of the call to AWS CloudFormation (for example the call to UpdateStack or CreateChangeSet).

AWS CodePipeline adds the file to the output artifact after performing the specified action.

Default: No output artifact generated

getRegion

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

(experimental) The AWS region the given Action resides in.

Note that a cross-region Pipeline requires replication buckets to function correctly. You can provide their names with the {@link PipelineProps#crossRegionReplicationBuckets} property. If you don't, the CodePipeline Construct will create new Stacks in your CDK app containing those buckets, that you will need to cdk deploy before deploying the main, Pipeline-containing Stack.

Default: the Action resides in the same region as the Pipeline

builder

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

Specified by:

builder in interface CommonActionProps

Specified by:

builder in interface CommonAwsActionProps

Returns:

a CloudFormationExecuteChangeSetActionProps.Builder of CloudFormationExecuteChangeSetActionProps