Interface DeploymentEarlySuccessCriteria.Builder

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

  • Method Details

    • enable

      DeploymentEarlySuccessCriteria.Builder enable(Boolean enable)

      Specifies whether to use the early success criteria for the service deployment. When set to false, the deployment uses the default behavior, where Amazon ECS considers the deployment successful when the target service revision fully stabilizes and the previous tasks are removed. The default value is false.

      When set to true, Amazon ECS monitors the deployment to meet early success criteria. You must also specify healthyPercent and sourceServiceRevisionCleanup.

      Parameters:
      enable - Specifies whether to use the early success criteria for the service deployment. When set to false, the deployment uses the default behavior, where Amazon ECS considers the deployment successful when the target service revision fully stabilizes and the previous tasks are removed. The default value is false.

      When set to true, Amazon ECS monitors the deployment to meet early success criteria. You must also specify healthyPercent and sourceServiceRevisionCleanup.

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

    • healthyPercent

      DeploymentEarlySuccessCriteria.Builder healthyPercent(Integer healthyPercent)

      The percentage of healthy tasks that the target service revision must reach before Amazon ECS considers the deployment successful. This percentage is relative to the service's desiredCount and must be an integer between 0 and 100. This value must be greater than or equal to the minimumHealthyPercent value.

      After this percentage of tasks is healthy and the bake time elapses, Amazon ECS completes the deployment. Amazon ECS continues to scale the target service revision to 100 percent in the background.

      Parameters:
      healthyPercent - The percentage of healthy tasks that the target service revision must reach before Amazon ECS considers the deployment successful. This percentage is relative to the service's desiredCount and must be an integer between 0 and 100. This value must be greater than or equal to the minimumHealthyPercent value.

      After this percentage of tasks is healthy and the bake time elapses, Amazon ECS completes the deployment. Amazon ECS continues to scale the target service revision to 100 percent in the background.

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

    • sourceServiceRevisionCleanup

      DeploymentEarlySuccessCriteria.Builder sourceServiceRevisionCleanup(String sourceServiceRevisionCleanup)

      The time when Amazon ECS removes the source revisions' tasks relative to deployment completion. The valid values are:

      • BLOCKING—Amazon ECS removes the previous tasks before it marks the deployment as successful.

      • DEFERRED—Amazon ECS marks the deployment successful, and then removes the previous tasks in the background.

      Parameters:
      sourceServiceRevisionCleanup - The time when Amazon ECS removes the source revisions' tasks relative to deployment completion. The valid values are:

      • BLOCKING—Amazon ECS removes the previous tasks before it marks the deployment as successful.

      • DEFERRED—Amazon ECS marks the deployment successful, and then removes the previous tasks in the background.

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

    • sourceServiceRevisionCleanup

      DeploymentEarlySuccessCriteria.Builder sourceServiceRevisionCleanup(ServiceRevisionCleanup sourceServiceRevisionCleanup)

      The time when Amazon ECS removes the source revisions' tasks relative to deployment completion. The valid values are:

      • BLOCKING—Amazon ECS removes the previous tasks before it marks the deployment as successful.

      • DEFERRED—Amazon ECS marks the deployment successful, and then removes the previous tasks in the background.

      Parameters:
      sourceServiceRevisionCleanup - The time when Amazon ECS removes the source revisions' tasks relative to deployment completion. The valid values are:

      • BLOCKING—Amazon ECS removes the previous tasks before it marks the deployment as successful.

      • DEFERRED—Amazon ECS marks the deployment successful, and then removes the previous tasks in the background.

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