Package software.amazon.awscdk.pipelines

Interface DeployCdkStackActionProps

All Superinterfaces:
DeployCdkStackActionOptions, software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
DeployCdkStackActionProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:49.818Z") @Stability(Deprecated) @Deprecated public interface DeployCdkStackActionProps extends software.amazon.jsii.JsiiSerializable, DeployCdkStackActionOptions
Deprecated.
This class is part of the old API. Use the API based on the CodePipeline class instead
(deprecated) Properties for a DeployCdkStackAction.

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;
 DeployCdkStackActionProps deployCdkStackActionProps = DeployCdkStackActionProps.builder()
         .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();

  • Method Details

    • getActionRole

      @Stability(Deprecated) @Deprecated @NotNull IRole getActionRole()
      Deprecated.
      (deprecated) Role for the action to assume.

      This controls the account to deploy into

    • getStackName

      @Stability(Deprecated) @Deprecated @NotNull String getStackName()
      Deprecated.
      (deprecated) The name of the stack that should be created/updated.

    • getTemplatePath

      @Stability(Deprecated) @Deprecated @NotNull String getTemplatePath()
      Deprecated.
      (deprecated) Relative path of template in the input artifact.

    • getCloudFormationExecutionRole

      @Stability(Deprecated) @Deprecated @Nullable default IRole getCloudFormationExecutionRole()
      Deprecated.
      (deprecated) Role to execute CloudFormation under.

      Default: - Execute CloudFormation using the action role

    • getDependencyStackArtifactIds

      @Stability(Deprecated) @Deprecated @Nullable default List<String> getDependencyStackArtifactIds()
      Deprecated.
      (deprecated) Artifact ID for the stacks this stack depends on.

      Used for pipeline order checking.

      Default: - No dependencies

    • getRegion

      @Stability(Deprecated) @Deprecated @Nullable default String getRegion()
      Deprecated.
      (deprecated) Region to deploy into.

      Default: - Same region as pipeline

    • getStackArtifactId

      @Stability(Deprecated) @Deprecated @Nullable default String getStackArtifactId()
      Deprecated.
      (deprecated) Artifact ID for the stack deployed here.

      Used for pipeline order checking.

      Default: - Order will not be checked

    • getTemplateConfigurationPath

      @Stability(Deprecated) @Deprecated @Nullable default String getTemplateConfigurationPath()
      Deprecated.
      (deprecated) Template configuration path relative to the input artifact.

      Default: - No template configuration

    • builder

      @Stability(Deprecated) @Deprecated static DeployCdkStackActionProps.Builder builder()
      Deprecated.
      Returns:
      a DeployCdkStackActionProps.Builder of DeployCdkStackActionProps