Package software.amazon.awscdk.services.codepipeline

Interface ActionProperties

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ActionProperties.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-24T21:00:27.202Z")
@Stability(Stable)
public interface ActionProperties
extends software.amazon.jsii.JsiiSerializable

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.codepipeline.*;
 import software.amazon.awscdk.services.iam.*;
 Artifact artifact;
 Resource resource;
 Role role;
 ActionProperties actionProperties = ActionProperties.builder()
         .actionName("actionName")
         .artifactBounds(ActionArtifactBounds.builder()
                 .maxInputs(123)
                 .maxOutputs(123)
                 .minInputs(123)
                 .minOutputs(123)
                 .build())
         .category(ActionCategory.SOURCE)
         .provider("provider")
         // the properties below are optional
         .account("account")
         .inputs(List.of(artifact))
         .outputs(List.of(artifact))
         .owner("owner")
         .region("region")
         .resource(resource)
         .role(role)
         .runOrder(123)
         .variablesNamespace("variablesNamespace")
         .version("version")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	ActionProperties.Builder	A builder for ActionProperties
static final class	ActionProperties.Jsii$Proxy	An implementation for ActionProperties

Method Summary

Modifier and Type	Method	Description
static ActionProperties.Builder	builder()
default String	getAccount()	The account the Action is supposed to live in.
String	getActionName()
ActionArtifactBounds	getArtifactBounds()
ActionCategory	getCategory()	The category of the action.
default List<Artifact>	getInputs()
default List<Artifact>	getOutputs()
default String	getOwner()
String	getProvider()	The service provider that the action calls.
default String	getRegion()	The AWS region the given Action resides in.
default IResource	getResource()	The optional resource that is backing this Action.
default IRole	getRole()
default Number	getRunOrder()	The order in which AWS CodePipeline runs this action.
default String	getVariablesNamespace()	The name of the namespace to use for variables emitted by this action.
default String	getVersion()

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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 resource 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 resource, or account - 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 PipelineProps#crossRegionReplicationBuckets 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.

https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#action-requirements

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()

Returns:

a ActionProperties.Builder of ActionProperties