Package software.amazon.awssdk.services.codedeploy.model

Class BlueInstanceTerminationOption

java.lang.Object

software.amazon.awssdk.services.codedeploy.model.BlueInstanceTerminationOption

All Implemented Interfaces:

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

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

Information about whether instances in the original environment are terminated when a blue/green deployment is successful. BlueInstanceTerminationOption does not apply to Lambda deployments.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BlueInstanceTerminationOption.Builder

Method Summary

Modifier and Type	Method	Description
InstanceAction	action()	The action to take on instances in the original environment after a successful blue/green deployment.
String	actionAsString()	The action to take on instances in the original environment after a successful blue/green deployment.
static BlueInstanceTerminationOption.Builder	builder()
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 BlueInstanceTerminationOption.Builder>	serializableBuilderClass()
Integer	terminationWaitTimeInMinutes()	For an Amazon EC2 deployment, the number of minutes to wait after a successful blue/green deployment before terminating instances from the original environment.
BlueInstanceTerminationOption.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

action

public final InstanceAction action()

The action to take on instances in the original environment after a successful blue/green deployment.

• TERMINATE: Instances are terminated after a specified wait time.

• KEEP_ALIVE: Instances are left running after they are deregistered from the load balancer and removed from the deployment group.

If the service returns an enum value that is not available in the current SDK version, action will return InstanceAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from actionAsString().

Returns:

The action to take on instances in the original environment after a successful blue/green deployment.

• TERMINATE: Instances are terminated after a specified wait time.

• KEEP_ALIVE: Instances are left running after they are deregistered from the load balancer and removed from the deployment group.

See Also:

InstanceAction

actionAsString

public final String actionAsString()

The action to take on instances in the original environment after a successful blue/green deployment.

• TERMINATE: Instances are terminated after a specified wait time.

• KEEP_ALIVE: Instances are left running after they are deregistered from the load balancer and removed from the deployment group.

If the service returns an enum value that is not available in the current SDK version, action will return InstanceAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from actionAsString().

Returns:

The action to take on instances in the original environment after a successful blue/green deployment.

• TERMINATE: Instances are terminated after a specified wait time.

• KEEP_ALIVE: Instances are left running after they are deregistered from the load balancer and removed from the deployment group.

See Also:

InstanceAction

terminationWaitTimeInMinutes

public final Integer terminationWaitTimeInMinutes()

For an Amazon EC2 deployment, the number of minutes to wait after a successful blue/green deployment before terminating instances from the original environment.

For an Amazon ECS deployment, the number of minutes before deleting the original (blue) task set. During an Amazon ECS deployment, CodeDeploy shifts traffic from the original (blue) task set to a replacement (green) task set.

The maximum setting is 2880 minutes (2 days).

Returns:

For an Amazon EC2 deployment, the number of minutes to wait after a successful blue/green deployment before terminating instances from the original environment.

For an Amazon ECS deployment, the number of minutes before deleting the original (blue) task set. During an Amazon ECS deployment, CodeDeploy shifts traffic from the original (blue) task set to a replacement (green) task set.

The maximum setting is 2880 minutes (2 days).

toBuilder

public BlueInstanceTerminationOption.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BlueInstanceTerminationOption.Builder,BlueInstanceTerminationOption>

builder

public static BlueInstanceTerminationOption.Builder builder()

serializableBuilderClass

public static Class<? extends BlueInstanceTerminationOption.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