Interface ActionProperties

All Superinterfaces:
All Known Implementing Classes:

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

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 Artifact artifact;
 Resource resource;
 Role role;
 ActionProperties actionProperties = ActionProperties.builder()
         // the properties below are optional
  • Method Details

    • getActionName

      @Stability(Stable) @NotNull String getActionName()
    • getArtifactBounds

      @Stability(Stable) @NotNull ActionArtifactBounds getArtifactBounds()
    • getCategory

      @Stability(Stable) @NotNull ActionCategory getCategory()
      The category of the action.

      The category defines which action type the owner (the entity that performs the action) performs.

    • getProvider

      @Stability(Stable) @NotNull String getProvider()
      The service provider that the action calls.
    • getAccount

      @Stability(Stable) @Nullable default String getAccount()
      The account the Action is supposed to live in.

      For Actions backed by resources, this is inferred from the Stack

      invalid @link
      is part of. However, some Actions, like the CloudFormation ones, are not backed by any resource, and they still might want to be cross-account. In general, a concrete Action class should specify either
      invalid @link
      , or
      invalid @link
      - but not both.
    • getInputs

      @Stability(Stable) @Nullable default List<Artifact> getInputs()
    • getOutputs

      @Stability(Stable) @Nullable default List<Artifact> getOutputs()
    • getOwner

      @Stability(Stable) @Nullable default String getOwner()
    • getRegion

      @Stability(Stable) @Nullable default String getRegion()
      The AWS region the given Action resides in.

      Note that a cross-region Pipeline requires replication buckets to function correctly. You can provide their names with the

      invalid @link
      property. If you don't, the CodePipeline Construct will create new Stacks in your CDK app containing those buckets, that you will need to `cdk deploy` before deploying the main, Pipeline-containing Stack.

      Default: the Action resides in the same region as the Pipeline

    • getResource

      @Stability(Stable) @Nullable default IResource getResource()
      The optional resource that is backing this Action.

      This is used for automatically handling Actions backed by resources from a different account and/or region.

    • getRole

      @Stability(Stable) @Nullable default IRole getRole()
    • getRunOrder

      @Stability(Stable) @Nullable default Number getRunOrder()
      The order in which AWS CodePipeline runs this action. For more information, see the AWS CodePipeline User Guide.

    • getVariablesNamespace

      @Stability(Stable) @Nullable default String getVariablesNamespace()
      The name of the namespace to use for variables emitted by this action.

      Default: - a name will be generated, based on the stage and action names

    • getVersion

      @Stability(Stable) @Nullable default String getVersion()
    • builder

      @Stability(Stable) static ActionProperties.Builder builder()
      a ActionProperties.Builder of ActionProperties