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

Class RegisterTaskDefinitionRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.ecs.model.RegisterTaskDefinitionRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<RegisterTaskDefinitionRequest.Builder,RegisterTaskDefinitionRequest>

@Generated("software.amazon.awssdk:codegen")
public class RegisterTaskDefinitionRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<RegisterTaskDefinitionRequest.Builder,RegisterTaskDefinitionRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RegisterTaskDefinitionRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static RegisterTaskDefinitionRequest.Builder	builder()
List<ContainerDefinition>	containerDefinitions()	A list of container definitions in JSON format that describe the different containers that make up your task.
boolean	equals(Object obj)
String	family()	You must specify a family for a task definition, which allows you to track multiple versions of the same task definition.
int	hashCode()
String	networkMode()	The Docker networking mode to use for the containers in the task.
List<TaskDefinitionPlacementConstraint>	placementConstraints()	An array of placement constraint objects to use for the task.
static Class<? extends RegisterTaskDefinitionRequest.Builder>	serializableBuilderClass()
String	taskRoleArn()	The short name or full Amazon Resource Name (ARN) of the IAM role that containers in this task can assume.
RegisterTaskDefinitionRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()
List<Volume>	volumes()	A list of volume definitions in JSON format that containers in your task may use.

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

family

public String family()

You must specify a family for a task definition, which allows you to track multiple versions of the same task definition. The family is used as a name for your task definition. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

Returns:

You must specify a family for a task definition, which allows you to track multiple versions of the same task definition. The family is used as a name for your task definition. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

taskRoleArn

public String taskRoleArn()

The short name or full Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role. For more information, see IAM Roles for Tasks in the Amazon EC2 Container Service Developer Guide.

Returns:

The short name or full Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role. For more information, see IAM Roles for Tasks in the Amazon EC2 Container Service Developer Guide.

networkMode

public String networkMode()

The Docker networking mode to use for the containers in the task. The valid values are none, bridge, and host.

The default Docker network mode is bridge. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the task's containers do not have external connectivity. The host network mode offers the highest networking performance for containers because they use the host network stack instead of the virtualized network stack provided by the bridge mode; however, exposed container ports are mapped directly to the corresponding host port, so you cannot take advantage of dynamic host port mappings or run multiple instantiations of the same task on a single container instance if port mappings are used.

For more information, see Network settings in the Docker run reference.

Returns:

The Docker networking mode to use for the containers in the task. The valid values are none, bridge, and host.

The default Docker network mode is bridge. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the task's containers do not have external connectivity. The host network mode offers the highest networking performance for containers because they use the host network stack instead of the virtualized network stack provided by the bridge mode; however, exposed container ports are mapped directly to the corresponding host port, so you cannot take advantage of dynamic host port mappings or run multiple instantiations of the same task on a single container instance if port mappings are used.

For more information, see Network settings in the Docker run reference.

See Also:

NetworkMode

containerDefinitions

public List<ContainerDefinition> containerDefinitions()

A list of container definitions in JSON format that describe the different containers that make up your task.

Returns:

A list of container definitions in JSON format that describe the different containers that make up your task.

volumes

public List<Volume> volumes()

A list of volume definitions in JSON format that containers in your task may use.

Returns:

A list of volume definitions in JSON format that containers in your task may use.

placementConstraints

public List<TaskDefinitionPlacementConstraint> placementConstraints()

An array of placement constraint objects to use for the task. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at run time).

Returns:

An array of placement constraint objects to use for the task. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at run time).

toBuilder

public RegisterTaskDefinitionRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<RegisterTaskDefinitionRequest.Builder,RegisterTaskDefinitionRequest>

Returns:

a builder for type T

builder

public static RegisterTaskDefinitionRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object