software.amazon.awscdk.services.codepipeline.actions

Class ManualApprovalAction.Builder

java.lang.Object

software.amazon.awscdk.services.codepipeline.actions.ManualApprovalAction.Builder

Enclosing class:

ManualApprovalAction

@Stability(value=Stable)
public static final class ManualApprovalAction.Builder
extends Object

A fluent builder for ManualApprovalAction.

Method Summary

Modifier and Type	Method and Description
ManualApprovalAction.Builder	actionName(String actionName)
ManualApprovalAction.Builder	additionalInformation(String additionalInformation)
ManualApprovalAction	build()
static ManualApprovalAction.Builder	create()
ManualApprovalAction.Builder	notificationTopic(ITopic notificationTopic)
ManualApprovalAction.Builder	notifyEmails(List<String> notifyEmails)
ManualApprovalAction.Builder	role(IRole role)
ManualApprovalAction.Builder	runOrder(Number runOrder)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Stable)
public static ManualApprovalAction.Builder create()

Returns:

a new instance of ManualApprovalAction.Builder.

actionName

@Stability(value=Stable)
public ManualApprovalAction.Builder actionName(String actionName)

Parameters:

actionName - The physical, human-readable name of the Action. Not that Action names must be unique within a single Stage. This parameter is required.

Returns:

this

runOrder

@Stability(value=Stable)
public ManualApprovalAction.Builder runOrder(Number runOrder)

Parameters:

runOrder - The runOrder property for this Action. RunOrder determines the relative order in which multiple Actions in the same Stage execute. This parameter is required.

Returns:

this

role

@Stability(value=Stable)
public ManualApprovalAction.Builder role(IRole role)

Parameters:

role - The Role in which context's this Action will be executing in. 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. This parameter is required.

Returns:

this

additionalInformation

@Stability(value=Stable)
public ManualApprovalAction.Builder additionalInformation(String additionalInformation)

Parameters:

additionalInformation - Any additional information that you want to include in the notification email message. This parameter is required.

Returns:

this

notificationTopic

@Stability(value=Stable)
public ManualApprovalAction.Builder notificationTopic(ITopic notificationTopic)

Parameters:

notificationTopic - Optional SNS topic to send notifications to when an approval is pending. This parameter is required.

Returns:

this

notifyEmails

@Stability(value=Stable)
public ManualApprovalAction.Builder notifyEmails(List<String> notifyEmails)

Parameters:

notifyEmails - 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. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public ManualApprovalAction build()