@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
date="2023-03-22T19:35:41.835Z")
public interface ActionProperties
// 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.core.*; 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();
Modifier and Type | Interface and Description |
---|---|
static class |
ActionProperties.Builder
A builder for
ActionProperties |
static class |
ActionProperties.Jsii$Proxy
An implementation for
ActionProperties |
Modifier and Type | Method and Description |
---|---|
static ActionProperties.Builder |
builder() |
default java.lang.String |
getAccount()
The account the Action is supposed to live in.
|
java.lang.String |
getActionName() |
ActionArtifactBounds |
getArtifactBounds() |
ActionCategory |
getCategory()
The category of the action.
|
default java.util.List<Artifact> |
getInputs() |
default java.util.List<Artifact> |
getOutputs() |
default java.lang.String |
getOwner() |
java.lang.String |
getProvider()
The service provider that the action calls.
|
default java.lang.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 java.lang.Number |
getRunOrder()
The order in which AWS CodePipeline runs this action.
|
default java.lang.String |
getVariablesNamespace()
The name of the namespace to use for variables emitted by this action.
|
default java.lang.String |
getVersion() |
java.lang.String getActionName()
ActionArtifactBounds getArtifactBounds()
ActionCategory getCategory()
The category defines which action type the owner (the entity that performs the action) performs.
java.lang.String getProvider()
default java.lang.String getAccount()
For Actions backed by resources, this is inferred from the Stack {@link 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 {@link resource}, or {@link account} - but not both.
default java.util.List<Artifact> getInputs()
default java.util.List<Artifact> getOutputs()
default java.lang.String getOwner()
default java.lang.String getRegion()
Note that a cross-region Pipeline requires replication buckets to function correctly.
You can provide their names with the {@link 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
default IResource getResource()
This is used for automatically handling Actions backed by resources from a different account and/or region.
default IRole getRole()
default java.lang.Number getRunOrder()
https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#action-requirements
default java.lang.String getVariablesNamespace()
Default: - a name will be generated, based on the stage and action names
default java.lang.String getVersion()
static ActionProperties.Builder builder()
ActionProperties.Builder
of ActionProperties