Package software.amazon.awscdk.services.ecs

Interface CfnTaskDefinition.RestartPolicyProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTaskDefinition.RestartPolicyProperty.Jsii$Proxy

Enclosing class:

CfnTaskDefinition

@Stability(Stable)
public static interface CfnTaskDefinition.RestartPolicyProperty
extends software.amazon.jsii.JsiiSerializable

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 .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ecs.*;
 RestartPolicyProperty restartPolicyProperty = RestartPolicyProperty.builder()
         .enabled(false)
         .ignoredExitCodes(List.of(123))
         .restartAttemptPeriod(123)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-restartpolicy.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnTaskDefinition.RestartPolicyProperty.Builder	A builder for CfnTaskDefinition.RestartPolicyProperty
static final class	CfnTaskDefinition.RestartPolicyProperty.Jsii$Proxy	An implementation for CfnTaskDefinition.RestartPolicyProperty

Method Summary

Modifier and Type	Method	Description
static CfnTaskDefinition.RestartPolicyProperty.Builder	builder()
default Object	getEnabled()	Specifies whether a restart policy is enabled for the container.
default Object	getIgnoredExitCodes()	A list of exit codes that Amazon ECS will ignore and not attempt a restart on.
default Number	getRestartAttemptPeriod()	A period of time (in seconds) that the container must run for before a restart can be attempted.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEnabled

@Stability(Stable)
@Nullable
default Object getEnabled()

Specifies whether a restart policy is enabled for the container.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-restartpolicy.html#cfn-ecs-taskdefinition-restartpolicy-enabled

getIgnoredExitCodes

@Stability(Stable)
@Nullable
default Object getIgnoredExitCodes()

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.

Returns union: either Listinvalid input: '<'Number> or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-restartpolicy.html#cfn-ecs-taskdefinition-restartpolicy-ignoredexitcodes

getRestartAttemptPeriod

@Stability(Stable)
@Nullable
default Number getRestartAttemptPeriod()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-restartpolicy.html#cfn-ecs-taskdefinition-restartpolicy-restartattemptperiod

builder

@Stability(Stable)
static CfnTaskDefinition.RestartPolicyProperty.Builder builder()

Returns:

a CfnTaskDefinition.RestartPolicyProperty.Builder of CfnTaskDefinition.RestartPolicyProperty