Interface DeploymentCircuitBreaker.Builder
- All Superinterfaces:
Buildable,CopyableBuilder<DeploymentCircuitBreaker.Builder,,DeploymentCircuitBreaker> SdkBuilder<DeploymentCircuitBreaker.Builder,,DeploymentCircuitBreaker> SdkPojo
- Enclosing class:
DeploymentCircuitBreaker
-
Method Summary
Modifier and TypeMethodDescriptionDetermines whether to use the deployment circuit breaker logic for the service.resetOnHealthyTask(Boolean resetOnHealthyTask) Determines whether the deployment circuit breaker resets its failure count when a task reaches a healthy state.Determines whether to configure Amazon ECS to roll back the service if a service deployment fails.default DeploymentCircuitBreaker.BuilderthresholdConfiguration(Consumer<ThresholdConfiguration.Builder> thresholdConfiguration) The threshold configuration that controls when the deployment circuit breaker triggers.thresholdConfiguration(ThresholdConfiguration thresholdConfiguration) The threshold configuration that controls when the deployment circuit breaker triggers.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
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
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
Determines whether the deployment circuit breaker resets its failure count when a task reaches a healthy state. When set to
true, a healthy task resets the failure count to0; whenfalse, it doesn't.- Parameters:
resetOnHealthyTask- Determines whether the deployment circuit breaker resets its failure count when a task reaches a healthy state. When set totrue, a healthy task resets the failure count to0; whenfalse, it doesn't.- 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.
- Parameters:
thresholdConfiguration- The threshold configuration that controls when the deployment circuit breaker triggers.- 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.
This is a convenience method that creates an instance of theThresholdConfiguration.Builderavoiding the need to create one manually viaThresholdConfiguration.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tothresholdConfiguration(ThresholdConfiguration).- Parameters:
thresholdConfiguration- a consumer that will call methods onThresholdConfiguration.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-