1.204.0

interface CommonAwsActionProps

LanguageType name
.NETAmazon.CDK.AWS.CodePipeline.CommonAwsActionProps
Javasoftware.amazon.awscdk.services.codepipeline.CommonAwsActionProps
Pythonaws_cdk.aws_codepipeline.CommonAwsActionProps
TypeScript (source)@aws-cdk/aws-codepipeline » CommonAwsActionProps

Common properties shared by all Actions whose {@link ActionProperties.owner} field is 'AWS' (or unset, as 'AWS' is the default).

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as codepipeline from '@aws-cdk/aws-codepipeline';
import * as iam from '@aws-cdk/aws-iam';

declare const role: iam.Role;
const commonAwsActionProps: codepipeline.CommonAwsActionProps = {
  actionName: 'actionName',

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

Properties

NameTypeDescription
actionNamestringThe physical, human-readable name of the Action.
role?IRoleThe Role in which context's this Action will be executing in.
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.

role?

Type: IRole (optional, default: a new Role will be generated)

The Role in which context's this Action will be executing in.

The Pipeline's Role will assume this Role (the required permissions for that will be granted automatically) right before executing this Action. This Action will be passed into your {@link IAction.bind} method in the {@link ActionBindOptions.role} property.

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.

← PreviousNext →