Class ManualApprovalAction.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<ManualApprovalAction>
- Enclosing class:
ManualApprovalAction
ManualApprovalAction
.-
Method Summary
Modifier and TypeMethodDescriptionactionName
(String actionName) The physical, human-readable name of the Action.additionalInformation
(String additionalInformation) Any additional information that you want to include in the notification email message.build()
static ManualApprovalAction.Builder
create()
externalEntityLink
(String externalEntityLink) URL you want to provide to the reviewer as part of the approval request.notificationTopic
(ITopic notificationTopic) Optional SNS topic to send notifications to when an approval is pending.notifyEmails
(List<String> notifyEmails) A list of email addresses to subscribe to notifications when this Action is pending approval.The Role in which context's this Action will be executing in.The runOrder property for this Action.variablesNamespace
(String variablesNamespace) The name of the namespace to use for variables emitted by this action.
-
Method Details
-
create
- Returns:
- a new instance of
ManualApprovalAction.Builder
.
-
actionName
The physical, human-readable name of the Action.Note that Action names must be unique within a single Stage.
- Parameters:
actionName
- The physical, human-readable name of the Action. This parameter is required.- Returns:
this
-
runOrder
The runOrder property for this Action.RunOrder determines the relative order in which multiple Actions in the same Stage execute.
Default: 1
- Parameters:
runOrder
- The runOrder property for this Action. This parameter is required.- Returns:
this
- See Also:
-
variablesNamespace
@Stability(Stable) public ManualApprovalAction.Builder variablesNamespace(String variablesNamespace) The name of the namespace to use for variables emitted by this action.Default: - a name will be generated, based on the stage and action names, if any of the action's variables were referenced - otherwise, no namespace will be set
- Parameters:
variablesNamespace
- The name of the namespace to use for variables emitted by this action. This parameter is required.- Returns:
this
-
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 theActionBindOptions.role
property.Default: a new Role will be generated
- Parameters:
role
- The Role in which context's this Action will be executing in. This parameter is required.- Returns:
this
-
additionalInformation
@Stability(Stable) public ManualApprovalAction.Builder additionalInformation(String additionalInformation) Any additional information that you want to include in the notification email message.- Parameters:
additionalInformation
- Any additional information that you want to include in the notification email message. This parameter is required.- Returns:
this
-
externalEntityLink
@Stability(Stable) public ManualApprovalAction.Builder externalEntityLink(String externalEntityLink) URL you want to provide to the reviewer as part of the approval request.Default: - the approval request will not have an external link
- Parameters:
externalEntityLink
- URL you want to provide to the reviewer as part of the approval request. This parameter is required.- Returns:
this
-
notificationTopic
Optional SNS topic to send notifications to when an approval is pending.- Parameters:
notificationTopic
- Optional SNS topic to send notifications to when an approval is pending. This parameter is required.- Returns:
this
-
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.- Parameters:
notifyEmails
- A list of email addresses to subscribe to notifications when this Action is pending approval. This parameter is required.- Returns:
this
-
build
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<ManualApprovalAction>
- Returns:
- a newly built instance of
ManualApprovalAction
.
-