Package software.amazon.awscdk.services.codepipeline

Interface CommonActionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

AlexaSkillDeployActionProps, CloudFormationCreateReplaceChangeSetActionProps, CloudFormationCreateUpdateStackActionProps, CloudFormationDeleteStackActionProps, CloudFormationDeployStackInstancesActionProps, CloudFormationDeployStackSetActionProps, CloudFormationExecuteChangeSetActionProps, CodeBuildActionProps, CodeCommitSourceActionProps, CodeDeployEcsDeployActionProps, CodeDeployServerDeployActionProps, CodeStarConnectionsSourceActionProps, CommonAwsActionProps, EcrSourceActionProps, EcsDeployActionProps, ElasticBeanstalkDeployActionProps, GitHubSourceActionProps, JenkinsActionProps, LambdaInvokeActionProps, ManualApprovalActionProps, S3DeployActionProps, S3SourceActionProps, ServiceCatalogDeployActionBeta1Props, StepFunctionsInvokeActionProps

All Known Implementing Classes:

AlexaSkillDeployActionProps.Jsii$Proxy, CloudFormationCreateReplaceChangeSetActionProps.Jsii$Proxy, CloudFormationCreateUpdateStackActionProps.Jsii$Proxy, CloudFormationDeleteStackActionProps.Jsii$Proxy, CloudFormationDeployStackInstancesActionProps.Jsii$Proxy, CloudFormationDeployStackSetActionProps.Jsii$Proxy, CloudFormationExecuteChangeSetActionProps.Jsii$Proxy, CodeBuildActionProps.Jsii$Proxy, CodeCommitSourceActionProps.Jsii$Proxy, CodeDeployEcsDeployActionProps.Jsii$Proxy, CodeDeployServerDeployActionProps.Jsii$Proxy, CodeStarConnectionsSourceActionProps.Jsii$Proxy, CommonActionProps.Jsii$Proxy, CommonAwsActionProps.Jsii$Proxy, EcrSourceActionProps.Jsii$Proxy, EcsDeployActionProps.Jsii$Proxy, ElasticBeanstalkDeployActionProps.Jsii$Proxy, GitHubSourceActionProps.Jsii$Proxy, JenkinsActionProps.Jsii$Proxy, LambdaInvokeActionProps.Jsii$Proxy, ManualApprovalActionProps.Jsii$Proxy, S3DeployActionProps.Jsii$Proxy, S3SourceActionProps.Jsii$Proxy, ServiceCatalogDeployActionBeta1Props.Jsii$Proxy, StepFunctionsInvokeActionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-18T17:54:14.295Z")
@Stability(Stable)
public interface CommonActionProps
extends software.amazon.jsii.JsiiSerializable

Common properties shared by all Actions.

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.*;
 CommonActionProps commonActionProps = CommonActionProps.builder()
         .actionName("actionName")
         // the properties below are optional
         .runOrder(123)
         .variablesNamespace("variablesNamespace")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CommonActionProps.Builder	builder()
String	getActionName()	The physical, human-readable name of the Action.
default Number	getRunOrder()	The runOrder property for this Action.
default String	getVariablesNamespace()	The name of the namespace to use for variables emitted by this action.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getActionName

@Stability(Stable)
@NotNull
String getActionName()

The physical, human-readable name of the Action.

Note that Action names must be unique within a single Stage.

getRunOrder

@Stability(Stable)
@Nullable
default Number getRunOrder()

The runOrder property for this Action.

RunOrder determines the relative order in which multiple Actions in the same Stage execute.

Default: 1

See Also:

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

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, if any of the action's variables were referenced - otherwise, no namespace will be set

builder

@Stability(Stable)
static CommonActionProps.Builder builder()

Returns:

a CommonActionProps.Builder of CommonActionProps