software.amazon.awssdk.services.ecs.model.DeploymentConfiguration Maven / Gradle / Ivy
Show all versions of ecs Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.ecs.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Optional deployment parameters that control how many tasks run during a deployment and the ordering of stopping and
* starting tasks.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class DeploymentConfiguration implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField DEPLOYMENT_CIRCUIT_BREAKER_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("deploymentCircuitBreaker")
.getter(getter(DeploymentConfiguration::deploymentCircuitBreaker)).setter(setter(Builder::deploymentCircuitBreaker))
.constructor(DeploymentCircuitBreaker::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("deploymentCircuitBreaker").build())
.build();
private static final SdkField MAXIMUM_PERCENT_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("maximumPercent").getter(getter(DeploymentConfiguration::maximumPercent))
.setter(setter(Builder::maximumPercent))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("maximumPercent").build()).build();
private static final SdkField MINIMUM_HEALTHY_PERCENT_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("minimumHealthyPercent").getter(getter(DeploymentConfiguration::minimumHealthyPercent))
.setter(setter(Builder::minimumHealthyPercent))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("minimumHealthyPercent").build())
.build();
private static final SdkField ALARMS_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("alarms").getter(getter(DeploymentConfiguration::alarms)).setter(setter(Builder::alarms))
.constructor(DeploymentAlarms::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("alarms").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(
DEPLOYMENT_CIRCUIT_BREAKER_FIELD, MAXIMUM_PERCENT_FIELD, MINIMUM_HEALTHY_PERCENT_FIELD, ALARMS_FIELD));
private static final long serialVersionUID = 1L;
private final DeploymentCircuitBreaker deploymentCircuitBreaker;
private final Integer maximumPercent;
private final Integer minimumHealthyPercent;
private final DeploymentAlarms alarms;
private DeploymentConfiguration(BuilderImpl builder) {
this.deploymentCircuitBreaker = builder.deploymentCircuitBreaker;
this.maximumPercent = builder.maximumPercent;
this.minimumHealthyPercent = builder.minimumHealthyPercent;
this.alarms = builder.alarms;
}
/**
*
*
* The deployment circuit breaker can only be used for services using the rolling update (ECS
)
* deployment type.
*
*
*
* The deployment circuit breaker determines whether a service deployment will fail if the service can't
* reach a steady state. If you use the deployment circuit breaker, a service deployment will transition to a failed
* state and stop launching new tasks. If you use the rollback option, when a service deployment fails, the service
* is rolled back to the last deployment that completed successfully. For more information, see Rolling update in
* the Amazon Elastic Container Service Developer Guide
*
*
* @return
* The deployment circuit breaker can only be used for services using the rolling update (ECS
)
* deployment type.
*
*
*
* The deployment circuit breaker determines whether a service deployment will fail if the service
* can't reach a steady state. If you use the deployment circuit breaker, a service deployment will
* transition to a failed state and stop launching new tasks. If you use the rollback option, when a service
* deployment fails, the service is rolled back to the last deployment that completed successfully. For more
* information, see Rolling
* update in the Amazon Elastic Container Service Developer Guide
*/
public final DeploymentCircuitBreaker deploymentCircuitBreaker() {
return deploymentCircuitBreaker;
}
/**
*
* If a service is using the rolling update (ECS
) deployment type, the maximumPercent
* parameter represents an upper limit on the number of your service's tasks that are allowed in the
* RUNNING
or PENDING
state during a deployment, as a percentage of the
* desiredCount
(rounded down to the nearest integer). This parameter enables you to define the
* deployment batch size. For example, if your service is using the REPLICA
service scheduler and has a
* desiredCount
of four tasks and a maximumPercent
value of 200%, the scheduler may start
* four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are
* available). The default maximumPercent
value for a service using the REPLICA
service
* scheduler is 200%.
*
*
* If a service is using either the blue/green (CODE_DEPLOY
) or EXTERNAL
deployment types
* and tasks that use the EC2 launch type, the maximum percent value is set to the default value and is used
* to define the upper limit on the number of the tasks in the service that remain in the RUNNING
state
* while the container instances are in the DRAINING
state. If the tasks in the service use the Fargate
* launch type, the maximum percent value is not used, although it is returned when describing your service.
*
*
* @return If a service is using the rolling update (ECS
) deployment type, the
* maximumPercent
parameter represents an upper limit on the number of your service's tasks
* that are allowed in the RUNNING
or PENDING
state during a deployment, as a
* percentage of the desiredCount
(rounded down to the nearest integer). This parameter enables
* you to define the deployment batch size. For example, if your service is using the REPLICA
* service scheduler and has a desiredCount
of four tasks and a maximumPercent
* value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that
* the cluster resources required to do this are available). The default maximumPercent
value
* for a service using the REPLICA
service scheduler is 200%.
*
* If a service is using either the blue/green (CODE_DEPLOY
) or EXTERNAL
* deployment types and tasks that use the EC2 launch type, the maximum percent value is set to the
* default value and is used to define the upper limit on the number of the tasks in the service that remain
* in the RUNNING
state while the container instances are in the DRAINING
state.
* If the tasks in the service use the Fargate launch type, the maximum percent value is not used, although
* it is returned when describing your service.
*/
public final Integer maximumPercent() {
return maximumPercent;
}
/**
*
* If a service is using the rolling update (ECS
) deployment type, the
* minimumHealthyPercent
represents a lower limit on the number of your service's tasks that must
* remain in the RUNNING
state during a deployment, as a percentage of the desiredCount
* (rounded up to the nearest integer). This parameter enables you to deploy without using additional cluster
* capacity. For example, if your service has a desiredCount
of four tasks and a
* minimumHealthyPercent
of 50%, the service scheduler may stop two existing tasks to free up cluster
* capacity before starting two new tasks.
*
*
* For services that do not use a load balancer, the following should be noted:
*
*
* -
*
* A service is considered healthy if all essential containers within the tasks in the service pass their health
* checks.
*
*
* -
*
* If a task has no essential containers with a health check defined, the service scheduler will wait for 40 seconds
* after a task reaches a RUNNING
state before the task is counted towards the minimum healthy percent
* total.
*
*
* -
*
* If a task has one or more essential containers with a health check defined, the service scheduler will wait for
* the task to reach a healthy status before counting it towards the minimum healthy percent total. A task is
* considered healthy when all essential containers within the task have passed their health checks. The amount of
* time the service scheduler can wait for is determined by the container health check settings.
*
*
*
*
* For services are that do use a load balancer, the following should be noted:
*
*
* -
*
* If a task has no essential containers with a health check defined, the service scheduler will wait for the load
* balancer target group health check to return a healthy status before counting the task towards the minimum
* healthy percent total.
*
*
* -
*
* If a task has an essential container with a health check defined, the service scheduler will wait for both the
* task to reach a healthy status and the load balancer target group health check to return a healthy status before
* counting the task towards the minimum healthy percent total.
*
*
*
*
* If a service is using either the blue/green (CODE_DEPLOY
) or EXTERNAL
deployment types
* and is running tasks that use the EC2 launch type, the minimum healthy percent value is set to the default
* value and is used to define the lower limit on the number of the tasks in the service that remain in the
* RUNNING
state while the container instances are in the DRAINING
state. If a service is
* using either the blue/green (CODE_DEPLOY
) or EXTERNAL
deployment types and is running
* tasks that use the Fargate launch type, the minimum healthy percent value is not used, although it is returned
* when describing your service.
*
*
* @return If a service is using the rolling update (ECS
) deployment type, the
* minimumHealthyPercent
represents a lower limit on the number of your service's tasks that
* must remain in the RUNNING
state during a deployment, as a percentage of the
* desiredCount
(rounded up to the nearest integer). This parameter enables you to deploy
* without using additional cluster capacity. For example, if your service has a desiredCount
* of four tasks and a minimumHealthyPercent
of 50%, the service scheduler may stop two
* existing tasks to free up cluster capacity before starting two new tasks.
*
* For services that do not use a load balancer, the following should be noted:
*
*
* -
*
* A service is considered healthy if all essential containers within the tasks in the service pass their
* health checks.
*
*
* -
*
* If a task has no essential containers with a health check defined, the service scheduler will wait for 40
* seconds after a task reaches a RUNNING
state before the task is counted towards the minimum
* healthy percent total.
*
*
* -
*
* If a task has one or more essential containers with a health check defined, the service scheduler will
* wait for the task to reach a healthy status before counting it towards the minimum healthy percent total.
* A task is considered healthy when all essential containers within the task have passed their health
* checks. The amount of time the service scheduler can wait for is determined by the container health check
* settings.
*
*
*
*
* For services are that do use a load balancer, the following should be noted:
*
*
* -
*
* If a task has no essential containers with a health check defined, the service scheduler will wait for
* the load balancer target group health check to return a healthy status before counting the task towards
* the minimum healthy percent total.
*
*
* -
*
* If a task has an essential container with a health check defined, the service scheduler will wait for
* both the task to reach a healthy status and the load balancer target group health check to return a
* healthy status before counting the task towards the minimum healthy percent total.
*
*
*
*
* If a service is using either the blue/green (CODE_DEPLOY
) or EXTERNAL
* deployment types and is running tasks that use the EC2 launch type, the minimum healthy percent
* value is set to the default value and is used to define the lower limit on the number of the tasks in the
* service that remain in the RUNNING
state while the container instances are in the
* DRAINING
state. If a service is using either the blue/green (CODE_DEPLOY
) or
* EXTERNAL
deployment types and is running tasks that use the Fargate launch type, the minimum
* healthy percent value is not used, although it is returned when describing your service.
*/
public final Integer minimumHealthyPercent() {
return minimumHealthyPercent;
}
/**
*
* Information about the CloudWatch alarms.
*
*
* @return Information about the CloudWatch alarms.
*/
public final DeploymentAlarms alarms() {
return alarms;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class extends Builder> serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(deploymentCircuitBreaker());
hashCode = 31 * hashCode + Objects.hashCode(maximumPercent());
hashCode = 31 * hashCode + Objects.hashCode(minimumHealthyPercent());
hashCode = 31 * hashCode + Objects.hashCode(alarms());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof DeploymentConfiguration)) {
return false;
}
DeploymentConfiguration other = (DeploymentConfiguration) obj;
return Objects.equals(deploymentCircuitBreaker(), other.deploymentCircuitBreaker())
&& Objects.equals(maximumPercent(), other.maximumPercent())
&& Objects.equals(minimumHealthyPercent(), other.minimumHealthyPercent())
&& Objects.equals(alarms(), other.alarms());
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*/
@Override
public final String toString() {
return ToString.builder("DeploymentConfiguration").add("DeploymentCircuitBreaker", deploymentCircuitBreaker())
.add("MaximumPercent", maximumPercent()).add("MinimumHealthyPercent", minimumHealthyPercent())
.add("Alarms", alarms()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "deploymentCircuitBreaker":
return Optional.ofNullable(clazz.cast(deploymentCircuitBreaker()));
case "maximumPercent":
return Optional.ofNullable(clazz.cast(maximumPercent()));
case "minimumHealthyPercent":
return Optional.ofNullable(clazz.cast(minimumHealthyPercent()));
case "alarms":
return Optional.ofNullable(clazz.cast(alarms()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function