software.amazon.awscdk.pipelines

Class DeployCdkStackAction

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.pipelines.DeployCdkStackAction

All Implemented Interfaces:

IAction

Deprecated.

This class is part of the old API. Use the API based on the `CodePipeline` class instead

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:51.806Z")
 @Deprecated
public class DeployCdkStackAction
extends software.amazon.jsii.JsiiObject
implements IAction

(deprecated) Action to deploy a CDK Stack.

Adds two CodePipeline Actions to the pipeline: one to create a ChangeSet and one to execute it.

You do not need to instantiate this action yourself -- it will automatically be added by the pipeline when you add stack artifacts or entire stages.

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.codepipeline.*;
 import software.amazon.awscdk.services.iam.*;
 import software.amazon.awscdk.pipelines.*;
 Artifact artifact;
 Role role;
 DeployCdkStackAction deployCdkStackAction = DeployCdkStackAction.Builder.create()
         .actionRole(role)
         .cloudAssemblyInput(artifact)
         .stackName("stackName")
         .templatePath("templatePath")
         // the properties below are optional
         .baseActionName("baseActionName")
         .changeSetName("changeSetName")
         .cloudFormationExecutionRole(role)
         .dependencyStackArtifactIds(List.of("dependencyStackArtifactIds"))
         .executeRunOrder(123)
         .output(artifact)
         .outputFileName("outputFileName")
         .prepareRunOrder(123)
         .region("region")
         .stackArtifactId("stackArtifactId")
         .templateConfigurationPath("templateConfigurationPath")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DeployCdkStackAction.Builder Deprecated.

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

IAction.Jsii$Default, IAction.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ActionConfig	bind(Construct scope, IStage stage, ActionBindOptions options) Deprecated.
static DeployCdkStackAction	fromStackArtifact(software.constructs.Construct scope, CloudFormationStackArtifact artifact, CdkStackActionFromArtifactOptions options) Deprecated.
ActionProperties	getActionProperties() Deprecated.
java.util.List<java.lang.String>	getDependencyStackArtifactIds() Deprecated.
java.lang.Number	getExecuteRunOrder() Deprecated.
java.lang.Number	getPrepareRunOrder() Deprecated.
java.lang.String	getStackArtifactId() Deprecated.
java.lang.String	getStackName() Deprecated.
Rule	onStateChange(java.lang.String name) Deprecated.
Rule	onStateChange(java.lang.String name, IRuleTarget target) Deprecated.
Rule	onStateChange(java.lang.String name, IRuleTarget target, RuleProps options) Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

DeployCdkStackAction

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

Deprecated.

DeployCdkStackAction

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

Deprecated.

Method Detail

fromStackArtifact

@Deprecated
public static DeployCdkStackAction fromStackArtifact(software.constructs.Construct scope,
                                                                 CloudFormationStackArtifact artifact,
                                                                 CdkStackActionFromArtifactOptions options)

Deprecated.

(deprecated) Construct a DeployCdkStackAction from a Stack artifact.

Parameters:

scope - This parameter is required.

artifact - This parameter is required.

options - This parameter is required.

bind

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

Deprecated.

(deprecated) Exists to implement IAction.

Specified by:

bind in interface IAction

Parameters:

scope - This parameter is required.

stage - This parameter is required.

options - This parameter is required.

onStateChange

@Deprecated
public Rule onStateChange(java.lang.String name,
                                      IRuleTarget target,
                                      RuleProps options)

Deprecated.

(deprecated) Exists to implement IAction.

Specified by:

onStateChange in interface IAction

Parameters:

name - This parameter is required.

target -

options -

onStateChange

@Deprecated
public Rule onStateChange(java.lang.String name,
                                      IRuleTarget target)

Deprecated.

(deprecated) Exists to implement IAction.

Specified by:

onStateChange in interface IAction

Parameters:

name - This parameter is required.

target -

onStateChange

@Deprecated
public Rule onStateChange(java.lang.String name)

Deprecated.

(deprecated) Exists to implement IAction.

Specified by:

onStateChange in interface IAction

Parameters:

name - This parameter is required.

getActionProperties

@Deprecated
public ActionProperties getActionProperties()

Deprecated.

(deprecated) Exists to implement IAction.

Specified by:

getActionProperties in interface IAction

getDependencyStackArtifactIds

@Deprecated
public java.util.List<java.lang.String> getDependencyStackArtifactIds()

Deprecated.

(deprecated) Artifact ids of the artifact this stack artifact depends on.

getExecuteRunOrder

@Deprecated
public java.lang.Number getExecuteRunOrder()

Deprecated.

(deprecated) The runorder for the execute action.

getPrepareRunOrder

@Deprecated
public java.lang.Number getPrepareRunOrder()

Deprecated.

(deprecated) The runorder for the prepare action.

getStackName

@Deprecated
public java.lang.String getStackName()

Deprecated.

(deprecated) Name of the deployed stack.

getStackArtifactId

@Deprecated
public java.lang.String getStackArtifactId()

Deprecated.

(deprecated) Artifact id of the artifact this action was based on.