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

Class ContainerRestartPolicy

java.lang.Object

software.amazon.awssdk.services.ecs.model.ContainerRestartPolicy

All Implemented Interfaces:

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

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

You can enable a restart policy for each container defined in your task definition, to overcome transient failures faster and maintain task availability. When you enable a restart policy for a container, Amazon ECS can restart the container if it exits, without needing to replace the task. For more information, see Restart individual containers in Amazon ECS tasks with container restart policies in the Amazon Elastic Container Service Developer Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ContainerRestartPolicy.Builder

Method Summary

Modifier and Type	Method	Description
static ContainerRestartPolicy.Builder	builder()
Boolean	enabled()	Specifies whether a restart policy is enabled for the container.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasIgnoredExitCodes()	For responses, this returns true if the service returned a value for the IgnoredExitCodes property.
List<Integer>	ignoredExitCodes()	A list of exit codes that Amazon ECS will ignore and not attempt a restart on.
Integer	restartAttemptPeriod()	A period of time (in seconds) that the container must run for before a restart can be attempted.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ContainerRestartPolicy.Builder>	serializableBuilderClass()
ContainerRestartPolicy.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

enabled

public final Boolean enabled()

Specifies whether a restart policy is enabled for the container.

Returns:

Specifies whether a restart policy is enabled for the container.

hasIgnoredExitCodes

public final boolean hasIgnoredExitCodes()

For responses, this returns true if the service returned a value for the IgnoredExitCodes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

ignoredExitCodes

public final List<Integer> ignoredExitCodes()

A list of exit codes that Amazon ECS will ignore and not attempt a restart on. You can specify a maximum of 50 container exit codes. By default, Amazon ECS does not ignore any exit codes.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasIgnoredExitCodes() method.

Returns:

A list of exit codes that Amazon ECS will ignore and not attempt a restart on. You can specify a maximum of 50 container exit codes. By default, Amazon ECS does not ignore any exit codes.

restartAttemptPeriod

public final Integer restartAttemptPeriod()

A period of time (in seconds) that the container must run for before a restart can be attempted. A container can be restarted only once every restartAttemptPeriod seconds. If a container isn't able to run for this time period and exits early, it will not be restarted. You can set a minimum restartAttemptPeriod of 60 seconds and a maximum restartAttemptPeriod of 1800 seconds. By default, a container must run for 300 seconds before it can be restarted.

Returns:

A period of time (in seconds) that the container must run for before a restart can be attempted. A container can be restarted only once every restartAttemptPeriod seconds. If a container isn't able to run for this time period and exits early, it will not be restarted. You can set a minimum restartAttemptPeriod of 60 seconds and a maximum restartAttemptPeriod of 1800 seconds. By default, a container must run for 300 seconds before it can be restarted.

toBuilder

public ContainerRestartPolicy.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ContainerRestartPolicy.Builder,ContainerRestartPolicy>

builder

public static ContainerRestartPolicy.Builder builder()

serializableBuilderClass

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