aws-cdk-lib.aws_codepipeline.CommonActionProps

interface CommonActionProps

LanguageType name
.NETAmazon.CDK.AWS.CodePipeline.CommonActionProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscodepipeline#CommonActionProps
Javasoftware.amazon.awscdk.services.codepipeline.CommonActionProps
Pythonaws_cdk.aws_codepipeline.CommonActionProps
TypeScript (source)aws-cdk-lib » aws_codepipeline » CommonActionProps

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 { aws_codepipeline as codepipeline } from 'aws-cdk-lib';
const commonActionProps: codepipeline.CommonActionProps = {
  actionName: 'actionName',

  // the properties below are optional
  runOrder: 123,
  variablesNamespace: 'variablesNamespace',
};

Properties

NameTypeDescription
actionNamestringThe physical, human-readable name of the Action.
runOrder?numberThe runOrder property for this Action.
variablesNamespace?stringThe name of the namespace to use for variables emitted by this action.

actionName

Type: string

The physical, human-readable name of the Action.

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


runOrder?

Type: number (optional, default: 1)

The runOrder property for this Action.

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

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


variablesNamespace?

Type: string (optional, 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)

The name of the namespace to use for variables emitted by this action.