software.amazon.awscdk.pipelines

Class DeployCdkStackAction

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.pipelines.DeployCdkStackAction

All Implemented Interfaces:

IAction, software.amazon.jsii.JsiiSerializable

Deprecated.

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

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-07T23:47:16.158Z")
 @Stability(value=Deprecated)
 @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 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, IAction.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	DeployCdkStackAction(DeployCdkStackActionProps props) Deprecated.
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.
List<String>	getDependencyStackArtifactIds() Deprecated.
Number	getExecuteRunOrder() Deprecated.
Number	getPrepareRunOrder() Deprecated.
String	getStackArtifactId() Deprecated.
String	getStackName() Deprecated.
Rule	onStateChange(String name) Deprecated.
Rule	onStateChange(String name, IRuleTarget target) Deprecated.
Rule	onStateChange(String name, IRuleTarget target, RuleProps options) Deprecated.

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 Detail

DeployCdkStackAction

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

Deprecated.

DeployCdkStackAction

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

Deprecated.

DeployCdkStackAction

@Stability(value=Deprecated)
 @Deprecated
public DeployCdkStackAction(@NotNull
                                                                      DeployCdkStackActionProps props)

Deprecated.

Parameters:

props - This parameter is required.

Method Detail

fromStackArtifact

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
public static DeployCdkStackAction fromStackArtifact(@NotNull
                                                                                                         software.constructs.Construct scope,
                                                                                                         @NotNull
                                                                                                         CloudFormationStackArtifact artifact,
                                                                                                         @NotNull
                                                                                                         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

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
public ActionConfig bind(@NotNull
                                                                             Construct scope,
                                                                             @NotNull
                                                                             IStage stage,
                                                                             @NotNull
                                                                             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

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
public Rule onStateChange(@NotNull
                                                                              String name,
                                                                              @Nullable
                                                                              IRuleTarget target,
                                                                              @Nullable
                                                                              RuleProps options)

Deprecated.

(deprecated) Exists to implement IAction.

Specified by:

onStateChange in interface IAction

Parameters:

name - This parameter is required.

target -

options -

onStateChange

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
public Rule onStateChange(@NotNull
                                                                              String name,
                                                                              @Nullable
                                                                              IRuleTarget target)

Deprecated.

(deprecated) Exists to implement IAction.

Specified by:

onStateChange in interface IAction

Parameters:

name - This parameter is required.

target -

onStateChange

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
public Rule onStateChange(@NotNull
                                                                              String name)

Deprecated.

(deprecated) Exists to implement IAction.

Specified by:

onStateChange in interface IAction

Parameters:

name - This parameter is required.

getActionProperties

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
public ActionProperties getActionProperties()

Deprecated.

(deprecated) Exists to implement IAction.

Specified by:

getActionProperties in interface IAction

getDependencyStackArtifactIds

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
public List<String> getDependencyStackArtifactIds()

Deprecated.

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

getExecuteRunOrder

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
public Number getExecuteRunOrder()

Deprecated.

(deprecated) The runorder for the execute action.

getPrepareRunOrder

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
public Number getPrepareRunOrder()

Deprecated.

(deprecated) The runorder for the prepare action.

getStackName

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
public String getStackName()

Deprecated.

(deprecated) Name of the deployed stack.

getStackArtifactId

@Stability(value=Deprecated)
 @Deprecated
 @Nullable
public String getStackArtifactId()

Deprecated.

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