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

Class CloudFormationDeleteStackAction

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

All Implemented Interfaces:

IAction, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:48.363Z")
@Stability(Stable)
public class CloudFormationDeleteStackAction
extends Action

CodePipeline action to delete a stack.

Deletes a stack. If you specify a stack that doesn't exist, the action completes successfully without deleting a stack.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cloudformation.*;
 import software.amazon.awscdk.services.codepipeline.*;
 import software.amazon.awscdk.services.codepipeline.actions.*;
 import software.amazon.awscdk.services.iam.*;
 import software.amazon.awscdk.core.*;
 Artifact artifact;
 ArtifactPath artifactPath;
 Object parameterOverrides;
 Role role;
 CloudFormationDeleteStackAction cloudFormationDeleteStackAction = CloudFormationDeleteStackAction.Builder.create()
         .actionName("actionName")
         .adminPermissions(false)
         .stackName("stackName")
         // the properties below are optional
         .account("account")
         .capabilities(List.of(CloudFormationCapabilities.NONE))
         .cfnCapabilities(List.of(CfnCapabilities.NONE))
         .deploymentRole(role)
         .extraInputs(List.of(artifact))
         .output(artifact)
         .outputFileName("outputFileName")
         .parameterOverrides(Map.of(
                 "parameterOverridesKey", parameterOverrides))
         .region("region")
         .role(role)
         .runOrder(123)
         .templateConfiguration(artifactPath)
         .variablesNamespace("variablesNamespace")
         .build();
 

Nested Class Summary

Nested Classes

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

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
	CloudFormationDeleteStackAction(CloudFormationDeleteStackActionProps props)
protected	CloudFormationDeleteStackAction(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CloudFormationDeleteStackAction(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
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 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

CloudFormationDeleteStackAction

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

CloudFormationDeleteStackAction

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

CloudFormationDeleteStackAction

@Stability(Stable)
public CloudFormationDeleteStackAction(@NotNull
 CloudFormationDeleteStackActionProps props)

Parameters:

props - This parameter is required.

Method Details

addToDeploymentRolePolicy

@Stability(Stable)
@NotNull
public Boolean addToDeploymentRolePolicy(@NotNull
 PolicyStatement statement)

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

Parameters:

statement - This parameter is required.

bound

@Stability(Stable)
@NotNull
protected ActionConfig bound(@NotNull
 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.

getDeploymentRole

@Stability(Stable)
@NotNull
public IRole getDeploymentRole()