software.amazon.awscdk.services.codepipeline.actions

Interface ManualApprovalActionProps

All Superinterfaces:

CommonActionProps, CommonAwsActionProps, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ManualApprovalActionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.558Z")
 @Stability(value=Stable)
public interface ManualApprovalActionProps
extends software.amazon.jsii.JsiiSerializable, CommonAwsActionProps

Construction properties of the ManualApprovalAction.

Example:

 // Example automatically generated from non-compiling source. May contain errors.
 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 String	getAdditionalInformation() Any additional information that you want to include in the notification email message.
default 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 List<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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAdditionalInformation

@Stability(value=Stable)
 @Nullable
default String getAdditionalInformation()

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

getExternalEntityLink

@Stability(value=Stable)
 @Nullable
default 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

@Stability(value=Stable)
 @Nullable
default ITopic getNotificationTopic()

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

getNotifyEmails

@Stability(value=Stable)
 @Nullable
default List<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

@Stability(value=Stable)
static ManualApprovalActionProps.Builder builder()

Specified by:

builder in interface CommonActionProps

Specified by:

builder in interface CommonAwsActionProps

Returns:

a ManualApprovalActionProps.Builder of ManualApprovalActionProps