com.amazonaws.services.ecs.model

Class RegisterTaskDefinitionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ecs.model.RegisterTaskDefinitionRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RegisterTaskDefinitionRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
RegisterTaskDefinitionRequest()

Method Summary

Modifier and Type	Method and Description
RegisterTaskDefinitionRequest	clone()
boolean	equals(Object obj)
List<ContainerDefinition>	getContainerDefinitions() A list of container definitions in JSON format that describe the different containers that make up your task.
String	getFamily() You must specify a family for a task definition, which allows you to track multiple versions of the same task definition.
String	getNetworkMode() The Docker networking mode to use for the containers in the task.
List<TaskDefinitionPlacementConstraint>	getPlacementConstraints() An array of placement constraint objects to use for the task.
String	getTaskRoleArn() The short name or full Amazon Resource Name (ARN) of the IAM role that containers in this task can assume.
List<Volume>	getVolumes() A list of volume definitions in JSON format that containers in your task may use.
int	hashCode()
void	setContainerDefinitions(Collection<ContainerDefinition> containerDefinitions) A list of container definitions in JSON format that describe the different containers that make up your task.
void	setFamily(String family) You must specify a family for a task definition, which allows you to track multiple versions of the same task definition.
void	setNetworkMode(NetworkMode networkMode) The Docker networking mode to use for the containers in the task.
void	setNetworkMode(String networkMode) The Docker networking mode to use for the containers in the task.
void	setPlacementConstraints(Collection<TaskDefinitionPlacementConstraint> placementConstraints) An array of placement constraint objects to use for the task.
void	setTaskRoleArn(String taskRoleArn) The short name or full Amazon Resource Name (ARN) of the IAM role that containers in this task can assume.
void	setVolumes(Collection<Volume> volumes) A list of volume definitions in JSON format that containers in your task may use.
String	toString() Returns a string representation of this object; useful for testing and debugging.
RegisterTaskDefinitionRequest	withContainerDefinitions(Collection<ContainerDefinition> containerDefinitions) A list of container definitions in JSON format that describe the different containers that make up your task.
RegisterTaskDefinitionRequest	withContainerDefinitions(ContainerDefinition... containerDefinitions) A list of container definitions in JSON format that describe the different containers that make up your task.
RegisterTaskDefinitionRequest	withFamily(String family) You must specify a family for a task definition, which allows you to track multiple versions of the same task definition.
RegisterTaskDefinitionRequest	withNetworkMode(NetworkMode networkMode) The Docker networking mode to use for the containers in the task.
RegisterTaskDefinitionRequest	withNetworkMode(String networkMode) The Docker networking mode to use for the containers in the task.
RegisterTaskDefinitionRequest	withPlacementConstraints(Collection<TaskDefinitionPlacementConstraint> placementConstraints) An array of placement constraint objects to use for the task.
RegisterTaskDefinitionRequest	withPlacementConstraints(TaskDefinitionPlacementConstraint... placementConstraints) An array of placement constraint objects to use for the task.
RegisterTaskDefinitionRequest	withTaskRoleArn(String taskRoleArn) The short name or full Amazon Resource Name (ARN) of the IAM role that containers in this task can assume.
RegisterTaskDefinitionRequest	withVolumes(Collection<Volume> volumes) A list of volume definitions in JSON format that containers in your task may use.
RegisterTaskDefinitionRequest	withVolumes(Volume... volumes) A list of volume definitions in JSON format that containers in your task may use.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

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

Constructor Detail

RegisterTaskDefinitionRequest

public RegisterTaskDefinitionRequest()

Method Detail

setFamily

public void setFamily(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.

Parameters:

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.

getFamily

public String getFamily()

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.

withFamily

public RegisterTaskDefinitionRequest withFamily(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setTaskRoleArn

public void setTaskRoleArn(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.

Parameters:

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.

getTaskRoleArn

public String getTaskRoleArn()

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.

withTaskRoleArn

public RegisterTaskDefinitionRequest withTaskRoleArn(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setNetworkMode

public void setNetworkMode(String networkMode)

The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, 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 and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.

With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached ENI port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.

If the network mode is awsvpc, the task is allocated an Elastic Network Interface, and you must specify a NetworkConfiguration when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon EC2 Container Service Developer Guide.

If the network mode is host, you can not run multiple instantiations of the same task on a single container instance when port mappings are used.

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

Parameters:

networkMode - The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, 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 and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.

With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached ENI port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.

If the network mode is awsvpc, the task is allocated an Elastic Network Interface, and you must specify a NetworkConfiguration when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon EC2 Container Service Developer Guide.

If the network mode is host, you can not run multiple instantiations of the same task on a single container instance when port mappings are used.

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

See Also:

NetworkMode

getNetworkMode

public String getNetworkMode()

The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, 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 and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.

With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached ENI port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.

If the network mode is awsvpc, the task is allocated an Elastic Network Interface, and you must specify a NetworkConfiguration when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon EC2 Container Service Developer Guide.

If the network mode is host, you can not run multiple instantiations of the same task on a single container instance when 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, awsvpc, 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 and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.

With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached ENI port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.

If the network mode is awsvpc, the task is allocated an Elastic Network Interface, and you must specify a NetworkConfiguration when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon EC2 Container Service Developer Guide.

If the network mode is host, you can not run multiple instantiations of the same task on a single container instance when port mappings are used.

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

See Also:

NetworkMode

withNetworkMode

public RegisterTaskDefinitionRequest withNetworkMode(String networkMode)

The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, 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 and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.

With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached ENI port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.

If the network mode is awsvpc, the task is allocated an Elastic Network Interface, and you must specify a NetworkConfiguration when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon EC2 Container Service Developer Guide.

If the network mode is host, you can not run multiple instantiations of the same task on a single container instance when port mappings are used.

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

Parameters:

networkMode - The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, 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 and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.

With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached ENI port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.

If the network mode is awsvpc, the task is allocated an Elastic Network Interface, and you must specify a NetworkConfiguration when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon EC2 Container Service Developer Guide.

If the network mode is host, you can not run multiple instantiations of the same task on a single container instance when port mappings are used.

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

NetworkMode

setNetworkMode

public void setNetworkMode(NetworkMode networkMode)

The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, 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 and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.

With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached ENI port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.

If the network mode is awsvpc, the task is allocated an Elastic Network Interface, and you must specify a NetworkConfiguration when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon EC2 Container Service Developer Guide.

If the network mode is host, you can not run multiple instantiations of the same task on a single container instance when port mappings are used.

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

Parameters:

networkMode - The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, 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 and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.

With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached ENI port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.

If the network mode is awsvpc, the task is allocated an Elastic Network Interface, and you must specify a NetworkConfiguration when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon EC2 Container Service Developer Guide.

If the network mode is host, you can not run multiple instantiations of the same task on a single container instance when port mappings are used.

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

See Also:

NetworkMode

withNetworkMode

public RegisterTaskDefinitionRequest withNetworkMode(NetworkMode networkMode)

The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, 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 and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.

With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached ENI port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.

If the network mode is awsvpc, the task is allocated an Elastic Network Interface, and you must specify a NetworkConfiguration when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon EC2 Container Service Developer Guide.

If the network mode is host, you can not run multiple instantiations of the same task on a single container instance when port mappings are used.

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

Parameters:

networkMode - The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, 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 and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.

With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached ENI port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.

If the network mode is awsvpc, the task is allocated an Elastic Network Interface, and you must specify a NetworkConfiguration when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon EC2 Container Service Developer Guide.

If the network mode is host, you can not run multiple instantiations of the same task on a single container instance when port mappings are used.

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

NetworkMode

getContainerDefinitions

public List<ContainerDefinition> getContainerDefinitions()

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.

setContainerDefinitions

public void setContainerDefinitions(Collection<ContainerDefinition> containerDefinitions)

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

Parameters:

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

withContainerDefinitions

public RegisterTaskDefinitionRequest withContainerDefinitions(ContainerDefinition... containerDefinitions)

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

NOTE: This method appends the values to the existing list (if any). Use setContainerDefinitions(java.util.Collection) or withContainerDefinitions(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withContainerDefinitions

public RegisterTaskDefinitionRequest withContainerDefinitions(Collection<ContainerDefinition> containerDefinitions)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

getVolumes

public List<Volume> getVolumes()

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.

setVolumes

public void setVolumes(Collection<Volume> volumes)

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

Parameters:

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

withVolumes

public RegisterTaskDefinitionRequest withVolumes(Volume... volumes)

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

NOTE: This method appends the values to the existing list (if any). Use setVolumes(java.util.Collection) or withVolumes(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withVolumes

public RegisterTaskDefinitionRequest withVolumes(Collection<Volume> volumes)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

getPlacementConstraints

public List<TaskDefinitionPlacementConstraint> getPlacementConstraints()

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).

setPlacementConstraints

public void setPlacementConstraints(Collection<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).

Parameters:

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).

withPlacementConstraints

public RegisterTaskDefinitionRequest withPlacementConstraints(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).

NOTE: This method appends the values to the existing list (if any). Use setPlacementConstraints(java.util.Collection) or withPlacementConstraints(java.util.Collection) if you want to override the existing values.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

withPlacementConstraints

public RegisterTaskDefinitionRequest withPlacementConstraints(Collection<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).

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public RegisterTaskDefinitionRequest clone()

Overrides:

clone in class AmazonWebServiceRequest