Interface Plan.Builder

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

  • Method Details

    • arn

      Plan.Builder arn(String arn)

      The Amazon Resource Name (ARN) of the plan.

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

    • description

      Plan.Builder description(String description)

      The description for a plan.

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

    • workflows

      Plan.Builder workflows(Collection<Workflow> workflows)

      The workflows for a plan.

      Parameters:
      workflows - The workflows for a plan.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • workflows

      Plan.Builder workflows(Workflow... workflows)

      The workflows for a plan.

      Parameters:
      workflows - The workflows for a plan.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • workflows

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

      The workflows for a 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

      Plan.Builder executionRole(String executionRole)

      The execution role for a plan.

      Parameters:
      executionRole - The execution role for a plan.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • recoveryTimeObjectiveMinutes

      Plan.Builder recoveryTimeObjectiveMinutes(Integer recoveryTimeObjectiveMinutes)

      The recovery time objective for a plan.

      Parameters:
      recoveryTimeObjectiveMinutes - The recovery time objective for a plan.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • associatedAlarms

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

      The associated application health alarms for a plan.

      Parameters:
      associatedAlarms - The associated application health alarms for a plan.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • triggers

      Plan.Builder triggers(Collection<Trigger> triggers)

      The triggers for a plan.

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

    • triggers

      Plan.Builder triggers(Trigger... triggers)

      The triggers for a plan.

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

    • triggers

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

      The triggers for a 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

      Plan.Builder reportConfiguration(ReportConfiguration reportConfiguration)

      The report configuration for a plan.

      Parameters:
      reportConfiguration - The report configuration for a plan.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • reportConfiguration

      default Plan.Builder reportConfiguration(Consumer<ReportConfiguration.Builder> reportConfiguration)

      The report configuration for a plan.

      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:

    • serviceQuotaChecksEnabled

      Plan.Builder serviceQuotaChecksEnabled(Boolean serviceQuotaChecksEnabled)

      Indicates whether service quota checks are enabled for the Region switch plan. When enabled, Region switch compares the applied service quota values across the plan's Amazon Web Services Regions and creates a warning when a quota in one Region is lower than the value required for the matching resource in another Region. Service quota checks are advisory and don't prevent you from creating, evaluating, or executing a plan.

      Parameters:
      serviceQuotaChecksEnabled - Indicates whether service quota checks are enabled for the Region switch plan. When enabled, Region switch compares the applied service quota values across the plan's Amazon Web Services Regions and creates a warning when a quota in one Region is lower than the value required for the matching resource in another Region. Service quota checks are advisory and don't prevent you from creating, evaluating, or executing a plan.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      Plan.Builder name(String name)

      The name for a plan.

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

    • regions

      Plan.Builder regions(Collection<String> regions)

      The Amazon Web Services Regions for a plan.

      Parameters:
      regions - The Amazon Web Services Regions for a plan.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • regions

      Plan.Builder regions(String... regions)

      The Amazon Web Services Regions for a plan.

      Parameters:
      regions - The Amazon Web Services Regions for a plan.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • recoveryApproach

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

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

      Plan.Builder primaryRegion(String primaryRegion)

      The primary Region for a plan.

      Parameters:
      primaryRegion - The primary Region for a plan.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • owner

      Plan.Builder owner(String owner)

      The owner of a plan.

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

    • version

      Plan.Builder version(String version)

      The version for the plan.

      Parameters:
      version - The version for the plan.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • updatedAt

      Plan.Builder updatedAt(Instant updatedAt)

      The timestamp when the plan was last updated.

      Parameters:
      updatedAt - The timestamp when the plan was last updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.