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

Class ManualApprovalAction.Builder

java.lang.Object
software.amazon.awscdk.services.codepipeline.actions.ManualApprovalAction.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<ManualApprovalAction>
Enclosing class:
ManualApprovalAction
@Stability(Stable) public static final class ManualApprovalAction.Builder extends Object implements software.amazon.jsii.Builder<ManualApprovalAction>
A fluent builder for ManualApprovalAction.

  • Method Details

    • create

      @Stability(Stable) public static ManualApprovalAction.Builder create()
      Returns:
      a new instance of ManualApprovalAction.Builder.

    • actionName

      @Stability(Stable) public ManualApprovalAction.Builder actionName(String 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

      @Stability(Stable) public ManualApprovalAction.Builder runOrder(Number 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

      @Stability(Stable) public ManualApprovalAction.Builder role(IRole 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

      invalid @link 
      IAction.bind
      method in the
      invalid @link 
      ActionBindOptions.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

      @Stability(Stable) public ManualApprovalAction.Builder notificationTopic(ITopic 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

      @Stability(Stable) public ManualApprovalAction.Builder notifyEmails(List<String> 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

      @Stability(Stable) public ManualApprovalAction build()
      Specified by:
      build in interface software.amazon.jsii.Builder<ManualApprovalAction>
      Returns:
      a newly built instance of ManualApprovalAction.