Class CommonAwsActionProps
Common properties shared by all Actions whose {@link ActionProperties.owner} field is 'AWS' (or unset, as 'AWS' is the default).
Inheritance
Namespace: Amazon.CDK.AWS.CodePipeline
Assembly: Amazon.CDK.AWS.CodePipeline.dll
Syntax (csharp)
public class CommonAwsActionProps : Object, ICommonAwsActionProps, ICommonActionProps
Syntax (vb)
Public Class CommonAwsActionProps
Inherits Object
Implements ICommonAwsActionProps, ICommonActionProps
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.CodePipeline;
using Amazon.CDK.AWS.IAM;
Role role;
var commonAwsActionProps = new CommonAwsActionProps {
ActionName = "actionName",
// the properties below are optional
Role = role,
RunOrder = 123,
VariablesNamespace = "variablesNamespace"
};
Synopsis
Constructors
CommonAwsActionProps() |
Properties
ActionName | The physical, human-readable name of the Action. |
Role | The Role in which context's this Action will be executing in. |
RunOrder | The runOrder property for this Action. |
VariablesNamespace | The name of the namespace to use for variables emitted by this action. |
Constructors
CommonAwsActionProps()
public CommonAwsActionProps()
Properties
ActionName
The physical, human-readable name of the Action.
public string ActionName { get; set; }
Property Value
System.String
Remarks
Note that Action names must be unique within a single Stage.
Role
The Role in which context's this Action will be executing in.
public IRole Role { get; set; }
Property Value
Remarks
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.
Default: a new Role will be generated
RunOrder
The runOrder property for this Action.
public Nullable<double> RunOrder { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
RunOrder determines the relative order in which multiple Actions in the same Stage execute.
Default: 1
See: https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html
VariablesNamespace
The name of the namespace to use for variables emitted by this action.
public string VariablesNamespace { get; set; }
Property Value
System.String
Remarks
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