AWS CDK Reference

Appearance

v2.274.0

CommonAwsActionProps Struct ​

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

Source
aws-codepipeline/lib/action.ts

Example ​

ts
// 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';
import { aws_iam as iam } from 'aws-cdk-lib';

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

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

Properties ​

actionNamestringaction_namestractionNameStringActionNamestringActionName*stringrequired#
The physical, human-readable name of the Action.

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

roleIRoleroleIRoleroleIRoleRoleIRoleRoleIRole= a new Role will be generated#
The Role in which context's this Action will be executing in.
notes

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 IAction.bind method in the ActionBindOptions.role property.

runOrdernumberrun_orderint | floatrunOrderNumberRunOrderdoubleRunOrder*float64= 1#
The runOrder property for this Action.

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

variablesNamespacestringvariables_namespacestrvariablesNamespaceStringVariablesNamespacestringVariablesNamespace*string= a name will be generated, based …#
The name of the namespace to use for variables emitted by this action.
default

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