aws-cdk-lib.aws_codepipeline_actions.CloudFormationDeleteStackAction

class CloudFormationDeleteStackAction

LanguageType name
.NETAmazon.CDK.AWS.CodePipeline.Actions.CloudFormationDeleteStackAction
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscodepipelineactions#CloudFormationDeleteStackAction
Javasoftware.amazon.awscdk.services.codepipeline.actions.CloudFormationDeleteStackAction
Pythonaws_cdk.aws_codepipeline_actions.CloudFormationDeleteStackAction
TypeScript (source)aws-cdk-lib » aws_codepipeline_actions » CloudFormationDeleteStackAction

Implements IAction

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 * as cdk from 'aws-cdk-lib';
import { aws_codepipeline as codepipeline } from 'aws-cdk-lib';
import { aws_codepipeline_actions as codepipeline_actions } from 'aws-cdk-lib';
import { aws_iam as iam } from 'aws-cdk-lib';

declare const artifact: codepipeline.Artifact;
declare const artifactPath: codepipeline.ArtifactPath;
declare const parameterOverrides: any;
declare const role: iam.Role;
const cloudFormationDeleteStackAction = new codepipeline_actions.CloudFormationDeleteStackAction({
  actionName: 'actionName',
  adminPermissions: false,
  stackName: 'stackName',

  // the properties below are optional
  account: 'account',
  cfnCapabilities: [cdk.CfnCapabilities.NONE],
  deploymentRole: role,
  extraInputs: [artifact],
  output: artifact,
  outputFileName: 'outputFileName',
  parameterOverrides: {
    parameterOverridesKey: parameterOverrides,
  },
  region: 'region',
  role: role,
  runOrder: 123,
  templateConfiguration: artifactPath,
  variablesNamespace: 'variablesNamespace',
});

Initializer

new CloudFormationDeleteStackAction(props: CloudFormationDeleteStackActionProps)

Parameters

  • props CloudFormationDeleteStackActionProps

Properties

NameTypeDescription
actionPropertiesActionPropertiesThe simple properties of the Action, like its Owner, name, etc.
deploymentRoleIRole

actionProperties

Type: ActionProperties

The simple properties of the Action, like its Owner, name, etc.

Note that this accessor will be called before the bind callback.


deploymentRole

Type: IRole

Methods

NameDescription
addToDeploymentRolePolicy(statement)Add statement to the service role assumed by CloudFormation while executing this action.
bind(scope, stage, options)The callback invoked when this Action is added to a Pipeline.
onStateChange(name, target?, options?)Creates an Event that will be triggered whenever the state of this Action changes.
protected bound(scope, stage, options)This is a renamed version of the IAction.bind method.

addToDeploymentRolePolicy(statement)

public addToDeploymentRolePolicy(statement: PolicyStatement): boolean

Parameters

  • statement PolicyStatement

Returns

  • boolean

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


bind(scope, stage, options)

public bind(scope: Construct, stage: IStage, options: ActionBindOptions): ActionConfig

Parameters

  • scope Construct
  • stage IStage
  • options ActionBindOptions

Returns

  • ActionConfig

The callback invoked when this Action is added to a Pipeline.


onStateChange(name, target?, options?)

public onStateChange(name: string, target?: IRuleTarget, options?: RuleProps): Rule

Parameters

  • name string
  • target IRuleTarget
  • options RuleProps

Returns

  • Rule

Creates an Event that will be triggered whenever the state of this Action changes.


protected bound(scope, stage, options)

protected bound(scope: Construct, stage: IStage, options: ActionBindOptions): ActionConfig

Parameters

  • scope Construct
  • stage IStage
  • options ActionBindOptions

Returns

  • ActionConfig

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