Package software.amazon.awscdk.services.codepipeline.actions

Class CloudFormationExecuteChangeSetAction

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.codepipeline.Action

software.amazon.awscdk.services.codepipeline.actions.Action

software.amazon.awscdk.services.codepipeline.actions.CloudFormationExecuteChangeSetAction

All Implemented Interfaces:

IAction, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:23:58.957Z")
@Stability(Stable)
public class CloudFormationExecuteChangeSetAction
extends Action

CodePipeline action to execute a prepared change set.

Example:

 // Source stage: read from repository
 Repository repo = Repository.Builder.create(stack, "TemplateRepo")
         .repositoryName("template-repo")
         .build();
 Artifact sourceOutput = new Artifact("SourceArtifact");
 CodeCommitSourceAction source = CodeCommitSourceAction.Builder.create()
         .actionName("Source")
         .repository(repo)
         .output(sourceOutput)
         .trigger(CodeCommitTrigger.POLL)
         .build();
 Map<String, Object> sourceStage = Map.of(
         "stageName", "Source",
         "actions", List.of(source));
 // Deployment stage: create and deploy changeset with manual approval
 String stackName = "OurStack";
 String changeSetName = "StagedChangeSet";
 Map<String, Object> prodStage = Map.of(
         "stageName", "Deploy",
         "actions", List.of(
             CloudFormationCreateReplaceChangeSetAction.Builder.create()
                     .actionName("PrepareChanges")
                     .stackName(stackName)
                     .changeSetName(changeSetName)
                     .adminPermissions(true)
                     .templatePath(sourceOutput.atPath("template.yaml"))
                     .runOrder(1)
                     .build(),
             ManualApprovalAction.Builder.create()
                     .actionName("ApproveChanges")
                     .runOrder(2)
                     .build(),
             CloudFormationExecuteChangeSetAction.Builder.create()
                     .actionName("ExecuteChanges")
                     .stackName(stackName)
                     .changeSetName(changeSetName)
                     .runOrder(3)
                     .build()));
 Pipeline.Builder.create(stack, "Pipeline")
         .crossAccountKeys(true)
         .stages(List.of(sourceStage, prodStage))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CloudFormationExecuteChangeSetAction.Builder	A fluent builder for CloudFormationExecuteChangeSetAction.

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.codepipeline.IAction

IAction.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
	CloudFormationExecuteChangeSetAction(CloudFormationExecuteChangeSetActionProps props)
protected	CloudFormationExecuteChangeSetAction(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CloudFormationExecuteChangeSetAction(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
protected ActionConfig	bound(software.constructs.Construct scope, IStage stage, ActionBindOptions options)	This is a renamed version of the IAction.bind method.

Methods inherited from class software.amazon.awscdk.services.codepipeline.actions.Action

getProvidedActionProperties

Methods inherited from class software.amazon.awscdk.services.codepipeline.Action

bind, getActionProperties, onStateChange, onStateChange, onStateChange, variableExpression

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

Constructor Details

CloudFormationExecuteChangeSetAction

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

CloudFormationExecuteChangeSetAction

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

CloudFormationExecuteChangeSetAction

@Stability(Stable)
public CloudFormationExecuteChangeSetAction(@NotNull
 CloudFormationExecuteChangeSetActionProps props)

Parameters:

props - This parameter is required.

Method Details

bound

@Stability(Stable)
@NotNull
protected ActionConfig bound(@NotNull
 software.constructs.Construct scope,
 @NotNull
 IStage stage,
 @NotNull
 ActionBindOptions options)

This is a renamed version of the IAction.bind method.

Specified by:

bound in class Action

Parameters:

scope - This parameter is required.

stage - This parameter is required.

options - This parameter is required.