Interface CreatePlanRequest.Builder

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

  • Method Details

    • description

      CreatePlanRequest.Builder description(String description)

      The description of a Region switch plan.

      Parameters:
      description - The description of a Region switch plan.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • workflows

      CreatePlanRequest.Builder workflows(Collection<Workflow> workflows)

      An array of workflows included in a Region switch plan.

      Parameters:
      workflows - An array of workflows included in a Region switch plan.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • workflows

      CreatePlanRequest.Builder workflows(Workflow... workflows)

      An array of workflows included in a Region switch plan.

      Parameters:
      workflows - An array of workflows included in a Region switch plan.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • workflows

      CreatePlanRequest.Builder workflows(Consumer<Workflow.Builder>... workflows)

      An array of workflows included in a Region switch plan.

      This is a convenience method that creates an instance of the Workflow.Builder avoiding the need to create one manually via Workflow.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to workflows(List<Workflow>).

      Parameters:
      workflows - a consumer that will call methods on Workflow.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • executionRole

      CreatePlanRequest.Builder executionRole(String executionRole)

      An execution role is a way to categorize a Region switch plan.

      Parameters:
      executionRole - An execution role is a way to categorize a Region switch plan.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • recoveryTimeObjectiveMinutes

      CreatePlanRequest.Builder recoveryTimeObjectiveMinutes(Integer recoveryTimeObjectiveMinutes)

      Optionally, you can specify an recovery time objective for a Region switch plan, in minutes.

      Parameters:
      recoveryTimeObjectiveMinutes - Optionally, you can specify an recovery time objective for a Region switch plan, in minutes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • associatedAlarms

      CreatePlanRequest.Builder associatedAlarms(Map<String,AssociatedAlarm> associatedAlarms)

      The alarms associated with a Region switch plan.

      Parameters:
      associatedAlarms - The alarms associated with a Region switch plan.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • triggers

      CreatePlanRequest.Builder triggers(Collection<Trigger> triggers)

      The triggers associated with a Region switch plan.

      Parameters:
      triggers - The triggers associated with a Region switch plan.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • triggers

      CreatePlanRequest.Builder triggers(Trigger... triggers)

      The triggers associated with a Region switch plan.

      Parameters:
      triggers - The triggers associated with a Region switch plan.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • triggers

      CreatePlanRequest.Builder triggers(Consumer<Trigger.Builder>... triggers)

      The triggers associated with a Region switch plan.

      This is a convenience method that creates an instance of the Trigger.Builder avoiding the need to create one manually via Trigger.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to triggers(List<Trigger>).

      Parameters:
      triggers - a consumer that will call methods on Trigger.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • reportConfiguration

      CreatePlanRequest.Builder reportConfiguration(ReportConfiguration reportConfiguration)
      Sets the value of the ReportConfiguration property for this object.
      Parameters:
      reportConfiguration - The new value for the ReportConfiguration property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • reportConfiguration

      default CreatePlanRequest.Builder reportConfiguration(Consumer<ReportConfiguration.Builder> reportConfiguration)
      Sets the value of the ReportConfiguration property for this object. This is a convenience method that creates an instance of the ReportConfiguration.Builder avoiding the need to create one manually via ReportConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to reportConfiguration(ReportConfiguration).

      Parameters:
      reportConfiguration - a consumer that will call methods on ReportConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • name

      CreatePlanRequest.Builder name(String name)

      The name of a Region switch plan.

      Parameters:
      name - The name of a Region switch plan.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • regions

      CreatePlanRequest.Builder regions(Collection<String> regions)

      An array that specifies the Amazon Web Services Regions for a Region switch plan. Specify two Regions.

      Parameters:
      regions - An array that specifies the Amazon Web Services Regions for a Region switch plan. Specify two Regions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • regions

      CreatePlanRequest.Builder regions(String... regions)

      An array that specifies the Amazon Web Services Regions for a Region switch plan. Specify two Regions.

      Parameters:
      regions - An array that specifies the Amazon Web Services Regions for a Region switch plan. Specify two Regions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • recoveryApproach

      CreatePlanRequest.Builder recoveryApproach(String recoveryApproach)

      The recovery approach for a Region switch plan, which can be active/active (activeActive) or active/passive (activePassive).

      Parameters:
      recoveryApproach - The recovery approach for a Region switch plan, which can be active/active (activeActive) or active/passive (activePassive).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • recoveryApproach

      CreatePlanRequest.Builder recoveryApproach(RecoveryApproach recoveryApproach)

      The recovery approach for a Region switch plan, which can be active/active (activeActive) or active/passive (activePassive).

      Parameters:
      recoveryApproach - The recovery approach for a Region switch plan, which can be active/active (activeActive) or active/passive (activePassive).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • primaryRegion

      CreatePlanRequest.Builder primaryRegion(String primaryRegion)

      The primary Amazon Web Services Region for the application. This is the Region where the application normally runs before any Region switch occurs.

      Parameters:
      primaryRegion - The primary Amazon Web Services Region for the application. This is the Region where the application normally runs before any Region switch occurs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreatePlanRequest.Builder tags(Map<String,String> tags)

      The tags to apply to the Region switch plan.

      Parameters:
      tags - The tags to apply to the Region switch plan.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreatePlanRequest.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

      CreatePlanRequest.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.