software.amazon.awscdk.services.codepipeline.actions

Interface ManualApprovalActionProps

All Superinterfaces:

CommonActionProps, CommonAwsActionProps

All Known Implementing Classes:

ManualApprovalActionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-09T19:16:44.819Z")
public interface ManualApprovalActionProps
extends CommonAwsActionProps

Construction properties of the ManualApprovalAction.

Example:

 Pipeline pipeline = new Pipeline(this, "MyPipeline");
 IStage approveStage = pipeline.addStage(StageOptions.builder().stageName("Approve").build());
 ManualApprovalAction manualApprovalAction = ManualApprovalAction.Builder.create()
         .actionName("Approve")
         .build();
 approveStage.addAction(manualApprovalAction);
 IRole role = Role.fromRoleArn(this, "Admin", Arn.format(ArnComponents.builder().service("iam").resource("role").resourceName("Admin").build(), this));
 manualApprovalAction.grantManualApproval(role);
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ManualApprovalActionProps.Builder A builder for ManualApprovalActionProps
static class	ManualApprovalActionProps.Jsii$Proxy An implementation for ManualApprovalActionProps

Method Summary

Modifier and Type	Method and Description
static ManualApprovalActionProps.Builder	builder()
default java.lang.String	getAdditionalInformation() Any additional information that you want to include in the notification email message.
default java.lang.String	getExternalEntityLink() URL you want to provide to the reviewer as part of the approval request.
default ITopic	getNotificationTopic() Optional SNS topic to send notifications to when an approval is pending.
default java.util.List<java.lang.String>	getNotifyEmails() A list of email addresses to subscribe to notifications when this Action is pending approval.

Methods inherited from interface software.amazon.awscdk.services.codepipeline.CommonAwsActionProps

getRole

Methods inherited from interface software.amazon.awscdk.services.codepipeline.CommonActionProps

getActionName, getRunOrder, getVariablesNamespace

Method Detail

getAdditionalInformation

default java.lang.String getAdditionalInformation()

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

getExternalEntityLink

default java.lang.String getExternalEntityLink()

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

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

getNotificationTopic

default ITopic getNotificationTopic()

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

getNotifyEmails

default java.util.List<java.lang.String> getNotifyEmails()

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

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

builder

static ManualApprovalActionProps.Builder builder()

Specified by:

builder in interface CommonActionProps

Specified by:

builder in interface CommonAwsActionProps

Returns:

a ManualApprovalActionProps.Builder of ManualApprovalActionProps