Interface CreatePracticeRunConfigurationRequest.Builder

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

  • Method Details

    • resourceIdentifier

      CreatePracticeRunConfigurationRequest.Builder resourceIdentifier(String resourceIdentifier)

      The identifier of the resource that Amazon Web Services shifts traffic for with a practice run zonal shift. The identifier is the Amazon Resource Name (ARN) for the resource.

      Amazon Application Recovery Controller currently supports enabling the following resources for zonal shift and zonal autoshift:

      Parameters:
      resourceIdentifier - The identifier of the resource that Amazon Web Services shifts traffic for with a practice run zonal shift. The identifier is the Amazon Resource Name (ARN) for the resource.

      Amazon Application Recovery Controller currently supports enabling the following resources for zonal shift and zonal autoshift:

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • blockedWindows

      CreatePracticeRunConfigurationRequest.Builder blockedWindows(Collection<String> blockedWindows)

      Optionally, you can block ARC from starting practice runs for specific windows of days and times.

      The format for blocked windows is: DAY:HH:SS-DAY:HH:SS. Keep in mind, when you specify dates, that dates and times for practice runs are in UTC. Also, be aware of potential time adjustments that might be required for daylight saving time differences. Separate multiple blocked windows with spaces.

      For example, say you run business report summaries three days a week. For this scenario, you might set the following recurring days and times as blocked windows, for example: MON-20:30-21:30 WED-20:30-21:30 FRI-20:30-21:30.

      Parameters:
      blockedWindows - Optionally, you can block ARC from starting practice runs for specific windows of days and times.

      The format for blocked windows is: DAY:HH:SS-DAY:HH:SS. Keep in mind, when you specify dates, that dates and times for practice runs are in UTC. Also, be aware of potential time adjustments that might be required for daylight saving time differences. Separate multiple blocked windows with spaces.

      For example, say you run business report summaries three days a week. For this scenario, you might set the following recurring days and times as blocked windows, for example: MON-20:30-21:30 WED-20:30-21:30 FRI-20:30-21:30.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • blockedWindows

      CreatePracticeRunConfigurationRequest.Builder blockedWindows(String... blockedWindows)

      Optionally, you can block ARC from starting practice runs for specific windows of days and times.

      The format for blocked windows is: DAY:HH:SS-DAY:HH:SS. Keep in mind, when you specify dates, that dates and times for practice runs are in UTC. Also, be aware of potential time adjustments that might be required for daylight saving time differences. Separate multiple blocked windows with spaces.

      For example, say you run business report summaries three days a week. For this scenario, you might set the following recurring days and times as blocked windows, for example: MON-20:30-21:30 WED-20:30-21:30 FRI-20:30-21:30.

      Parameters:
      blockedWindows - Optionally, you can block ARC from starting practice runs for specific windows of days and times.

      The format for blocked windows is: DAY:HH:SS-DAY:HH:SS. Keep in mind, when you specify dates, that dates and times for practice runs are in UTC. Also, be aware of potential time adjustments that might be required for daylight saving time differences. Separate multiple blocked windows with spaces.

      For example, say you run business report summaries three days a week. For this scenario, you might set the following recurring days and times as blocked windows, for example: MON-20:30-21:30 WED-20:30-21:30 FRI-20:30-21:30.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • blockedDates

      CreatePracticeRunConfigurationRequest.Builder blockedDates(Collection<String> blockedDates)

      Optionally, you can block ARC from starting practice runs for a resource on specific calendar dates.

      The format for blocked dates is: YYYY-MM-DD. Keep in mind, when you specify dates, that dates and times for practice runs are in UTC. Separate multiple blocked dates with spaces.

      For example, if you have an application update scheduled to launch on May 1, 2024, and you don't want practice runs to shift traffic away at that time, you could set a blocked date for 2024-05-01.

      Parameters:
      blockedDates - Optionally, you can block ARC from starting practice runs for a resource on specific calendar dates.

      The format for blocked dates is: YYYY-MM-DD. Keep in mind, when you specify dates, that dates and times for practice runs are in UTC. Separate multiple blocked dates with spaces.

      For example, if you have an application update scheduled to launch on May 1, 2024, and you don't want practice runs to shift traffic away at that time, you could set a blocked date for 2024-05-01.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • blockedDates

      CreatePracticeRunConfigurationRequest.Builder blockedDates(String... blockedDates)

      Optionally, you can block ARC from starting practice runs for a resource on specific calendar dates.

      The format for blocked dates is: YYYY-MM-DD. Keep in mind, when you specify dates, that dates and times for practice runs are in UTC. Separate multiple blocked dates with spaces.

      For example, if you have an application update scheduled to launch on May 1, 2024, and you don't want practice runs to shift traffic away at that time, you could set a blocked date for 2024-05-01.

      Parameters:
      blockedDates - Optionally, you can block ARC from starting practice runs for a resource on specific calendar dates.

      The format for blocked dates is: YYYY-MM-DD. Keep in mind, when you specify dates, that dates and times for practice runs are in UTC. Separate multiple blocked dates with spaces.

      For example, if you have an application update scheduled to launch on May 1, 2024, and you don't want practice runs to shift traffic away at that time, you could set a blocked date for 2024-05-01.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • blockingAlarms

      CreatePracticeRunConfigurationRequest.Builder blockingAlarms(Collection<ControlCondition> blockingAlarms)

      An Amazon CloudWatch alarm that you can specify for zonal autoshift practice runs. This alarm blocks ARC from starting practice run zonal shifts, and ends a practice run that's in progress, when the alarm is in an ALARM state.

      Parameters:
      blockingAlarms - An Amazon CloudWatch alarm that you can specify for zonal autoshift practice runs. This alarm blocks ARC from starting practice run zonal shifts, and ends a practice run that's in progress, when the alarm is in an ALARM state.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • blockingAlarms

      CreatePracticeRunConfigurationRequest.Builder blockingAlarms(ControlCondition... blockingAlarms)

      An Amazon CloudWatch alarm that you can specify for zonal autoshift practice runs. This alarm blocks ARC from starting practice run zonal shifts, and ends a practice run that's in progress, when the alarm is in an ALARM state.

      Parameters:
      blockingAlarms - An Amazon CloudWatch alarm that you can specify for zonal autoshift practice runs. This alarm blocks ARC from starting practice run zonal shifts, and ends a practice run that's in progress, when the alarm is in an ALARM state.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • blockingAlarms

      CreatePracticeRunConfigurationRequest.Builder blockingAlarms(Consumer<ControlCondition.Builder>... blockingAlarms)

      An Amazon CloudWatch alarm that you can specify for zonal autoshift practice runs. This alarm blocks ARC from starting practice run zonal shifts, and ends a practice run that's in progress, when the alarm is in an ALARM state.

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

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

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

    • outcomeAlarms

      CreatePracticeRunConfigurationRequest.Builder outcomeAlarms(Collection<ControlCondition> outcomeAlarms)

      The outcome alarm for practice runs is a required Amazon CloudWatch alarm that you specify that ends a practice run when the alarm is in an ALARM state.

      Configure the alarm to monitor the health of your application when traffic is shifted away from an Availability Zone during each practice run. You should configure the alarm to go into an ALARM state if your application is impacted by the zonal shift, and you want to stop the zonal shift, to let traffic for the resource return to the Availability Zone.

      Parameters:
      outcomeAlarms - The outcome alarm for practice runs is a required Amazon CloudWatch alarm that you specify that ends a practice run when the alarm is in an ALARM state.

      Configure the alarm to monitor the health of your application when traffic is shifted away from an Availability Zone during each practice run. You should configure the alarm to go into an ALARM state if your application is impacted by the zonal shift, and you want to stop the zonal shift, to let traffic for the resource return to the Availability Zone.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outcomeAlarms

      CreatePracticeRunConfigurationRequest.Builder outcomeAlarms(ControlCondition... outcomeAlarms)

      The outcome alarm for practice runs is a required Amazon CloudWatch alarm that you specify that ends a practice run when the alarm is in an ALARM state.

      Configure the alarm to monitor the health of your application when traffic is shifted away from an Availability Zone during each practice run. You should configure the alarm to go into an ALARM state if your application is impacted by the zonal shift, and you want to stop the zonal shift, to let traffic for the resource return to the Availability Zone.

      Parameters:
      outcomeAlarms - The outcome alarm for practice runs is a required Amazon CloudWatch alarm that you specify that ends a practice run when the alarm is in an ALARM state.

      Configure the alarm to monitor the health of your application when traffic is shifted away from an Availability Zone during each practice run. You should configure the alarm to go into an ALARM state if your application is impacted by the zonal shift, and you want to stop the zonal shift, to let traffic for the resource return to the Availability Zone.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outcomeAlarms

      CreatePracticeRunConfigurationRequest.Builder outcomeAlarms(Consumer<ControlCondition.Builder>... outcomeAlarms)

      The outcome alarm for practice runs is a required Amazon CloudWatch alarm that you specify that ends a practice run when the alarm is in an ALARM state.

      Configure the alarm to monitor the health of your application when traffic is shifted away from an Availability Zone during each practice run. You should configure the alarm to go into an ALARM state if your application is impacted by the zonal shift, and you want to stop the zonal shift, to let traffic for the resource return to the Availability Zone.

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

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

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

    • overrideConfiguration

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

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