Package 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.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:48.480Z")
@Stability(Stable)
public interface ManualApprovalActionProps
extends software.amazon.jsii.JsiiSerializable, 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	Description
static final class	ManualApprovalActionProps.Builder	A builder for ManualApprovalActionProps
static final class	ManualApprovalActionProps.Jsii$Proxy	An implementation for ManualApprovalActionProps

Method Summary

Modifier and Type	Method	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.CommonActionProps

getActionName, getRunOrder, getVariablesNamespace

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

getRole

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAdditionalInformation

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

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

getExternalEntityLink

@Stability(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(Stable)
@Nullable
default ITopic getNotificationTopic()

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

getNotifyEmails

@Stability(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(Stable)
static ManualApprovalActionProps.Builder builder()

Returns:

a ManualApprovalActionProps.Builder of ManualApprovalActionProps