Class ManualApprovalActionProps

Construction properties of the ManualApprovalAction.

Inheritance
System.Object
ManualApprovalActionProps
Namespace: Amazon.CDK.AWS.CodePipeline.Actions
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class ManualApprovalActionProps : Object, IManualApprovalActionProps, ICommonAwsActionProps, ICommonActionProps
Syntax (vb)
Public Class ManualApprovalActionProps
    Inherits Object
    Implements IManualApprovalActionProps, ICommonAwsActionProps, ICommonActionProps
Remarks

ExampleMetadata: infused

Examples
var pipeline = new Pipeline(this, "MyPipeline");
var approveStage = pipeline.AddStage(new StageOptions { StageName = "Approve" });
var manualApprovalAction = new ManualApprovalAction(new ManualApprovalActionProps {
    ActionName = "Approve"
});
approveStage.AddAction(manualApprovalAction);

var role = Role.FromRoleArn(this, "Admin", Arn.Format(new ArnComponents { Service = "iam", Resource = "role", ResourceName = "Admin" }, this));
manualApprovalAction.GrantManualApproval(role);

Synopsis

Constructors

ManualApprovalActionProps()

Properties

ActionName

The physical, human-readable name of the Action.
AdditionalInformation

Any additional information that you want to include in the notification email message.
ExternalEntityLink

URL you want to provide to the reviewer as part of the approval request.
NotificationTopic

Optional SNS topic to send notifications to when an approval is pending.
NotifyEmails

A list of email addresses to subscribe to notifications when this Action is pending approval.
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

ManualApprovalActionProps()

public ManualApprovalActionProps()

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.

AdditionalInformation

Any additional information that you want to include in the notification email message.

public string AdditionalInformation { get; set; }
Property Value

System.String

URL you want to provide to the reviewer as part of the approval request.

public string ExternalEntityLink { get; set; }
Property Value

System.String

Default: - the approval request will not have an external link

NotificationTopic

Optional SNS topic to send notifications to when an approval is pending.

public ITopic NotificationTopic { get; set; }
Property Value

ITopic

NotifyEmails

A list of email addresses to subscribe to notifications when this Action is pending approval.

public string[] NotifyEmails { get; set; }
Property Value

System.String[]

Remarks

If this has been provided, but not notificationTopic, a new Topic will be created.

Role

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

public IRole Role { get; set; }
Property Value

IRole

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

Implements