Interface StartPlanExecutionRequest.Builder

All Superinterfaces:
ArcRegionSwitchRequest.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<StartPlanExecutionRequest.Builder,StartPlanExecutionRequest>, SdkBuilder<StartPlanExecutionRequest.Builder,StartPlanExecutionRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
StartPlanExecutionRequest
@Mutable @NotThreadSafe public static interface StartPlanExecutionRequest.Builder extends ArcRegionSwitchRequest.Builder, SdkPojo, CopyableBuilder<StartPlanExecutionRequest.Builder,StartPlanExecutionRequest>

  • Method Details

    • planArn

      StartPlanExecutionRequest.Builder planArn(String planArn)

      The Amazon Resource Name (ARN) of the plan to execute.

      Parameters:
      planArn - The Amazon Resource Name (ARN) of the plan to execute.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targetRegion

      StartPlanExecutionRequest.Builder targetRegion(String targetRegion)

      The Amazon Web Services Region to target with this execution. This is the Region that traffic will be shifted to or from, depending on the action.

      Parameters:
      targetRegion - The Amazon Web Services Region to target with this execution. This is the Region that traffic will be shifted to or from, depending on the action.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • action

      StartPlanExecutionRequest.Builder action(String action)

      The action to perform. Valid values are ACTIVATE (to shift traffic to the target Region) or DEACTIVATE (to shift traffic away from the target Region).

      Parameters:
      action - The action to perform. Valid values are ACTIVATE (to shift traffic to the target Region) or DEACTIVATE (to shift traffic away from the target Region).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • action

      StartPlanExecutionRequest.Builder action(ExecutionAction action)

      The action to perform. Valid values are ACTIVATE (to shift traffic to the target Region) or DEACTIVATE (to shift traffic away from the target Region).

      Parameters:
      action - The action to perform. Valid values are ACTIVATE (to shift traffic to the target Region) or DEACTIVATE (to shift traffic away from the target Region).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • mode

      StartPlanExecutionRequest.Builder mode(String mode)

      The plan execution mode. Valid values are Practice, for testing without making actual changes, or Recovery, for actual traffic shifting and application recovery.

      Parameters:
      mode - The plan execution mode. Valid values are Practice, for testing without making actual changes, or Recovery, for actual traffic shifting and application recovery.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • mode

      StartPlanExecutionRequest.Builder mode(ExecutionMode mode)

      The plan execution mode. Valid values are Practice, for testing without making actual changes, or Recovery, for actual traffic shifting and application recovery.

      Parameters:
      mode - The plan execution mode. Valid values are Practice, for testing without making actual changes, or Recovery, for actual traffic shifting and application recovery.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • comment

      StartPlanExecutionRequest.Builder comment(String comment)

      An optional comment explaining why the plan execution is being started.

      Parameters:
      comment - An optional comment explaining why the plan execution is being started.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • latestVersion

      StartPlanExecutionRequest.Builder latestVersion(String latestVersion)

      A boolean value indicating whether to use the latest version of the plan. If set to false, you must specify a specific version.

      Parameters:
      latestVersion - A boolean value indicating whether to use the latest version of the plan. If set to false, you must specify a specific version.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      StartPlanExecutionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      StartPlanExecutionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.