Package software.amazon.awssdk.services.ecs.model

Class CanaryConfiguration

java.lang.Object

software.amazon.awssdk.services.ecs.model.CanaryConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CanaryConfiguration.Builder,CanaryConfiguration>

@Generated("software.amazon.awssdk:codegen")
public final class CanaryConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CanaryConfiguration.Builder,CanaryConfiguration>

Configuration for a canary deployment strategy that shifts a fixed percentage of traffic to the new service revision, waits for a specified bake time, then shifts the remaining traffic.

This is only valid when you run CreateService or UpdateService with deploymentController set to ECS and a deploymentConfiguration with a strategy set to CANARY.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CanaryConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static CanaryConfiguration.Builder	builder()
Integer	canaryBakeTimeInMinutes()	The amount of time in minutes to wait during the canary phase before shifting the remaining production traffic to the new service revision.
Double	canaryPercent()	The percentage of production traffic to shift to the new service revision during the canary phase.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CanaryConfiguration.Builder>	serializableBuilderClass()
CanaryConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

canaryPercent

public final Double canaryPercent()

The percentage of production traffic to shift to the new service revision during the canary phase. Valid values are multiples of 0.1 from 0.1 to 100.0. The default value is 5.0.

Returns:

The percentage of production traffic to shift to the new service revision during the canary phase. Valid values are multiples of 0.1 from 0.1 to 100.0. The default value is 5.0.

canaryBakeTimeInMinutes

public final Integer canaryBakeTimeInMinutes()

The amount of time in minutes to wait during the canary phase before shifting the remaining production traffic to the new service revision. Valid values are 0 to 1440 minutes (24 hours). The default value is 10.

Returns:

The amount of time in minutes to wait during the canary phase before shifting the remaining production traffic to the new service revision. Valid values are 0 to 1440 minutes (24 hours). The default value is 10.

toBuilder

public CanaryConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CanaryConfiguration.Builder,CanaryConfiguration>

builder

public static CanaryConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends CanaryConfiguration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo