Package software.amazon.awscdk.services.codepipeline.actions

Class ManualApprovalActionProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<ManualApprovalActionProps>

Enclosing interface:

ManualApprovalActionProps

@Stability(Stable)
public static final class ManualApprovalActionProps.Builder
extends Object
implements software.amazon.jsii.Builder<ManualApprovalActionProps>

A builder for ManualApprovalActionProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ManualApprovalActionProps.Builder	actionName(String actionName)	Sets the value of CommonActionProps.getActionName()
ManualApprovalActionProps.Builder	additionalInformation(String additionalInformation)	Sets the value of ManualApprovalActionProps.getAdditionalInformation()
ManualApprovalActionProps	build()	Builds the configured instance.
ManualApprovalActionProps.Builder	externalEntityLink(String externalEntityLink)	Sets the value of ManualApprovalActionProps.getExternalEntityLink()
ManualApprovalActionProps.Builder	notificationTopic(ITopic notificationTopic)	Sets the value of ManualApprovalActionProps.getNotificationTopic()
ManualApprovalActionProps.Builder	notifyEmails(List<String> notifyEmails)	Sets the value of ManualApprovalActionProps.getNotifyEmails()
ManualApprovalActionProps.Builder	role(IRole role)	Sets the value of CommonAwsActionProps.getRole()
ManualApprovalActionProps.Builder	runOrder(Number runOrder)	Sets the value of CommonActionProps.getRunOrder()
ManualApprovalActionProps.Builder	variablesNamespace(String variablesNamespace)	Sets the value of CommonActionProps.getVariablesNamespace()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

additionalInformation

@Stability(Stable)
public ManualApprovalActionProps.Builder additionalInformation(String additionalInformation)

Sets the value of ManualApprovalActionProps.getAdditionalInformation()

Parameters:

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

Returns:

this

externalEntityLink

@Stability(Stable)
public ManualApprovalActionProps.Builder externalEntityLink(String externalEntityLink)

Sets the value of ManualApprovalActionProps.getExternalEntityLink()

Parameters:

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

Returns:

this

notificationTopic

@Stability(Stable)
public ManualApprovalActionProps.Builder notificationTopic(ITopic notificationTopic)

Sets the value of ManualApprovalActionProps.getNotificationTopic()

Parameters:

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

Returns:

this

notifyEmails

@Stability(Stable)
public ManualApprovalActionProps.Builder notifyEmails(List<String> notifyEmails)

Sets the value of ManualApprovalActionProps.getNotifyEmails()

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.

Returns:

this

role

@Stability(Stable)
public ManualApprovalActionProps.Builder role(IRole role)

Sets the value of CommonAwsActionProps.getRole()

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.

Returns:

this

actionName

@Stability(Stable)
public ManualApprovalActionProps.Builder actionName(String actionName)

Sets the value of CommonActionProps.getActionName()

Parameters:

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

Returns:

this

runOrder

@Stability(Stable)
public ManualApprovalActionProps.Builder runOrder(Number runOrder)

Sets the value of CommonActionProps.getRunOrder()

Parameters:

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

Returns:

this

variablesNamespace

@Stability(Stable)
public ManualApprovalActionProps.Builder variablesNamespace(String variablesNamespace)

Sets the value of CommonActionProps.getVariablesNamespace()

Parameters:

variablesNamespace - The name of the namespace to use for variables emitted by this action.

Returns:

this

build

@Stability(Stable)
public ManualApprovalActionProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<ManualApprovalActionProps>

Returns:

a new instance of ManualApprovalActionProps

Throws:

NullPointerException - if any required attribute was not provided