software.amazon.awscdk.services.codepipeline.actions

Class CloudFormationCreateUpdateStackAction

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.CloudFormationCreateUpdateStackAction

All Implemented Interfaces:

IAction

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:48.187Z")
public class CloudFormationCreateUpdateStackAction
extends Action

CodePipeline action to deploy a stack.

Creates the stack if the specified stack doesn't exist. If the stack exists, AWS CloudFormation updates the stack. Use this action to update existing stacks.

AWS CodePipeline won't replace the stack, and will fail deployment if the stack is in a failed state. Use ReplaceOnFailure for an action that will delete and recreate the stack to try and recover from failed states.

Use this action to automatically replace failed stacks without recovering or troubleshooting them. You would typically choose this mode for testing.

Example:

 import software.amazon.awscdk.core.PhysicalName;
 // in stack for account 123456789012...
 Stack otherAccountStack;
 Role actionRole = Role.Builder.create(otherAccountStack, "ActionRole")
         .assumedBy(new AccountPrincipal("123456789012"))
         // the role has to have a physical name set
         .roleName(PhysicalName.GENERATE_IF_NEEDED)
         .build();
 // in the pipeline stack...
 Artifact sourceOutput = new Artifact();
 CloudFormationCreateUpdateStackAction.Builder.create()
         .actionName("CloudFormationCreateUpdate")
         .stackName("MyStackName")
         .adminPermissions(true)
         .templatePath(sourceOutput.atPath("template.yaml"))
         .role(actionRole)
         .build();
 

Nested Class Summary

Nested Classes

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

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

IAction.Jsii$Default

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	addToDeploymentRolePolicy(PolicyStatement statement) Add statement to the service role assumed by CloudFormation while executing this action.
protected ActionConfig	bound(Construct scope, IStage stage, ActionBindOptions options) This is a renamed version of the IAction.bind method.
IRole	getDeploymentRole()

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 java.lang.Object

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

Constructor Detail

CloudFormationCreateUpdateStackAction

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

CloudFormationCreateUpdateStackAction

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

Method Detail

addToDeploymentRolePolicy

public java.lang.Boolean addToDeploymentRolePolicy(PolicyStatement statement)

Add statement to the service role assumed by CloudFormation while executing this action.

Parameters:

statement - This parameter is required.

bound

protected ActionConfig bound(Construct scope,
                             IStage stage,
                             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.

getDeploymentRole

public IRole getDeploymentRole()