Interface DeploymentCircuitBreaker.Builder

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

  • Method Details

    • enable

      DeploymentCircuitBreaker.Builder enable(Boolean enable)

      Determines whether to use the deployment circuit breaker logic for the service.

      Parameters:
      enable - Determines whether to use the deployment circuit breaker logic for the service.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • rollback

      DeploymentCircuitBreaker.Builder rollback(Boolean rollback)

      Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is on, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.

      Parameters:
      rollback - Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is on, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resetOnHealthyTask

      DeploymentCircuitBreaker.Builder resetOnHealthyTask(Boolean resetOnHealthyTask)

      Specifies whether the deployment circuit breaker resets its failure count when a task reaches a healthy state. When set to true, a task that reaches a healthy state resets the failure count to 0. When set to false, Amazon ECS does not reset the failure count. The default is true.

      Parameters:
      resetOnHealthyTask - Specifies whether the deployment circuit breaker resets its failure count when a task reaches a healthy state. When set to true, a task that reaches a healthy state resets the failure count to 0. When set to false, Amazon ECS does not reset the failure count. The default is true.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • thresholdConfiguration

      DeploymentCircuitBreaker.Builder thresholdConfiguration(ThresholdConfiguration thresholdConfiguration)

      The threshold configuration that controls when the deployment circuit breaker triggers. The type and value together determine how many task failures are tolerated before the circuit breaker activates.

      Parameters:
      thresholdConfiguration - The threshold configuration that controls when the deployment circuit breaker triggers. The type and value together determine how many task failures are tolerated before the circuit breaker activates.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • thresholdConfiguration

      default DeploymentCircuitBreaker.Builder thresholdConfiguration(Consumer<ThresholdConfiguration.Builder> thresholdConfiguration)

      The threshold configuration that controls when the deployment circuit breaker triggers. The type and value together determine how many task failures are tolerated before the circuit breaker activates.

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

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

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