RegisterTaskDefinitionRequest (AWS Java SDK :: Services :: Amazon EC2 Container Service 2.17.33 API)

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.ecs.model.EcsRequest
    - - software.amazon.awssdk.services.ecs.model.RegisterTaskDefinitionRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<RegisterTaskDefinitionRequest.Builder,RegisterTaskDefinitionRequest>

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface RegisterTaskDefinitionRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`RegisterTaskDefinitionRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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.
`String`	`cpu()` The number of CPU units used by the task.
`EphemeralStorage`	`ephemeralStorage()` The amount of ephemeral storage to allocate for the task.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`executionRoleArn()` The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make Amazon Web Services API calls on your behalf.
`String`	`family()` You must specify a `family` for a task definition, which allows you to track multiple versions of the same task definition.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasContainerDefinitions()` For responses, this returns true if the service returned a value for the ContainerDefinitions property.
`int`	`hashCode()`
`boolean`	`hasInferenceAccelerators()` For responses, this returns true if the service returned a value for the InferenceAccelerators property.
`boolean`	`hasPlacementConstraints()` For responses, this returns true if the service returned a value for the PlacementConstraints property.
`boolean`	`hasRequiresCompatibilities()` For responses, this returns true if the service returned a value for the RequiresCompatibilities property.
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`boolean`	`hasVolumes()` For responses, this returns true if the service returned a value for the Volumes property.
`List<InferenceAccelerator>`	`inferenceAccelerators()` The Elastic Inference accelerators to use for the containers in the task.
`IpcMode`	`ipcMode()` The IPC resource namespace to use for the containers in the task.
`String`	`ipcModeAsString()` The IPC resource namespace to use for the containers in the task.
`String`	`memory()` The amount of memory (in MiB) used by the task.
`NetworkMode`	`networkMode()` The Docker networking mode to use for the containers in the task.
`String`	`networkModeAsString()` The Docker networking mode to use for the containers in the task.
`PidMode`	`pidMode()` The process namespace to use for the containers in the task.
`String`	`pidModeAsString()` The process namespace to use for the containers in the task.
`List<TaskDefinitionPlacementConstraint>`	`placementConstraints()` An array of placement constraint objects to use for the task.
`ProxyConfiguration`	`proxyConfiguration()` The configuration details for the App Mesh proxy.
`List<Compatibility>`	`requiresCompatibilities()` The task launch type that Amazon ECS should validate the task definition against.
`List<String>`	`requiresCompatibilitiesAsStrings()` The task launch type that Amazon ECS should validate the task definition against.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends RegisterTaskDefinitionRequest.Builder>`	`serializableBuilderClass()`
`List<Tag>`	`tags()` The metadata that you apply to the task definition to help you categorize and organize them.
`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()`
`String`	`toString()` Returns a string representation of this object.
`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.awscore.AwsRequest
overrideConfiguration

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
  - family
```
public final 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, underscores, and hyphens 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, underscores, and hyphens are allowed.
  - taskRoleArn
```
public final 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 Elastic 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 Elastic Container Service Developer Guide.
  - executionRoleArn
```
public final String executionRoleArn()
```
    The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make Amazon Web Services API calls on your behalf. The task execution IAM role is required depending on the requirements of your task. For more information, see Amazon ECS task execution IAM role in the Amazon Elastic Container Service Developer Guide.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make Amazon Web Services API calls on your behalf. The task execution IAM role is required depending on the requirements of your task. For more information, see Amazon ECS task execution IAM role in the Amazon Elastic Container Service Developer Guide.
  - networkMode
```
public final NetworkMode networkMode()
```
    The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host. If no network mode is specified, the default is bridge.
    
    For Amazon ECS tasks on Fargate, the awsvpc network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, <default> or awsvpc can be used. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the tasks 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 elastic network interface port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.
    
    When using the host network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.
    
    If the network mode is awsvpc, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.
    
    If the network mode is host, you cannot 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.
    
    If the service returns an enum value that is not available in the current SDK version, networkMode will return NetworkMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from networkModeAsString().
    
    Returns:
    
    The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host. If no network mode is specified, the default is bridge.
    
    For Amazon ECS tasks on Fargate, the awsvpc network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, <default> or awsvpc can be used. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the tasks 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 elastic network interface port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.
    
    When using the host network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.
    
    If the network mode is awsvpc, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.
    
    If the network mode is host, you cannot 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
  - networkModeAsString
```
public final String networkModeAsString()
```
    The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host. If no network mode is specified, the default is bridge.
    
    For Amazon ECS tasks on Fargate, the awsvpc network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, <default> or awsvpc can be used. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the tasks 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 elastic network interface port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.
    
    When using the host network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.
    
    If the network mode is awsvpc, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.
    
    If the network mode is host, you cannot 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.
    
    If the service returns an enum value that is not available in the current SDK version, networkMode will return NetworkMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from networkModeAsString().
    
    Returns:
    
    The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host. If no network mode is specified, the default is bridge.
    
    For Amazon ECS tasks on Fargate, the awsvpc network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, <default> or awsvpc can be used. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the tasks 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 elastic network interface port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.
    
    When using the host network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.
    
    If the network mode is awsvpc, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.
    
    If the network mode is host, you cannot 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
  - hasContainerDefinitions
```
public final boolean hasContainerDefinitions()
```
    For responses, this returns true if the service returned a value for the ContainerDefinitions 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.
  - containerDefinitions
```
public final List<ContainerDefinition> containerDefinitions()
```
    A list of container definitions in JSON format that describe the different containers that make up your task.
    
    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 hasContainerDefinitions() method.
    
    Returns:
    
    A list of container definitions in JSON format that describe the different containers that make up your task.
  - hasVolumes
```
public final boolean hasVolumes()
```
    For responses, this returns true if the service returned a value for the Volumes 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.
  - volumes
```
public final List<Volume> volumes()
```
    A list of volume definitions in JSON format that containers in your task may use.
    
    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 hasVolumes() method.
    
    Returns:
    
    A list of volume definitions in JSON format that containers in your task may use.
  - hasPlacementConstraints
```
public final boolean hasPlacementConstraints()
```
    For responses, this returns true if the service returned a value for the PlacementConstraints 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.
  - placementConstraints
```
public final 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 runtime).
    
    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 hasPlacementConstraints() method.
    
    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 runtime).
  - requiresCompatibilities
```
public final List<Compatibility> requiresCompatibilities()
```
    The task launch type that Amazon ECS should validate the task definition against. A client exception is returned if the task definition doesn't validate against the compatibilities specified. If no value is specified, the parameter is omitted from the response.
    
    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 hasRequiresCompatibilities() method.
    
    Returns:
    
    The task launch type that Amazon ECS should validate the task definition against. A client exception is returned if the task definition doesn't validate against the compatibilities specified. If no value is specified, the parameter is omitted from the response.
  - hasRequiresCompatibilities
```
public final boolean hasRequiresCompatibilities()
```
    For responses, this returns true if the service returned a value for the RequiresCompatibilities 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.
  - requiresCompatibilitiesAsStrings
```
public final List<String> requiresCompatibilitiesAsStrings()
```
    The task launch type that Amazon ECS should validate the task definition against. A client exception is returned if the task definition doesn't validate against the compatibilities specified. If no value is specified, the parameter is omitted from the response.
    
    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 hasRequiresCompatibilities() method.
    
    Returns:
    
    The task launch type that Amazon ECS should validate the task definition against. A client exception is returned if the task definition doesn't validate against the compatibilities specified. If no value is specified, the parameter is omitted from the response.
  - cpu
```
public final String cpu()
```
    The number of CPU units used by the task. It can be expressed as an integer using CPU units, for example 1024, or as a string using vCPUs, for example 1 vCPU or 1 vcpu, in a task definition. String values are converted to an integer indicating the CPU units when the task definition is registered.
    
    Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.
    
    If you are using the EC2 launch type, this field is optional. Supported values are between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs).
    
    If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the memory parameter:
    - 256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
    - 512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
    - 1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
    - 2048 (2 vCPU) - Available memory values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
    - 4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
    Returns:
    The number of CPU units used by the task. It can be expressed as an integer using CPU units, for example 1024, or as a string using vCPUs, for example 1 vCPU or 1 vcpu, in a task definition. String values are converted to an integer indicating the CPU units when the task definition is registered.
    
    Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.
    
    If you are using the EC2 launch type, this field is optional. Supported values are between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs).
    
    If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the memory parameter:
    
    256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
    
    512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
    
    1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
    
    2048 (2 vCPU) - Available memory values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
    
    4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
  - memory
```
public final String memory()
```
    The amount of memory (in MiB) used by the task. It can be expressed as an integer using MiB, for example 1024, or as a string using GB, for example 1GB or 1 GB, in a task definition. String values are converted to an integer indicating the MiB when the task definition is registered.
    
    Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.
    
    If using the EC2 launch type, this field is optional.
    
    If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the cpu parameter:
    - 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)
    - 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)
    - 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)
    - Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)
    - Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)
    Returns:
    The amount of memory (in MiB) used by the task. It can be expressed as an integer using MiB, for example 1024, or as a string using GB, for example 1GB or 1 GB, in a task definition. String values are converted to an integer indicating the MiB when the task definition is registered.
    
    Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.
    
    If using the EC2 launch type, this field is optional.
    
    If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the cpu parameter:
    
    512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)
    
    1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)
    
    2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)
    
    Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)
    
    Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags 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.
  - tags
```
public final List<Tag> tags()
```
    The metadata that you apply to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
    
    The following basic restrictions apply to tags:
    - Maximum number of tags per resource - 50
    - For each resource, each tag key must be unique, and each tag key can have only one value.
    - Maximum key length - 128 Unicode characters in UTF-8
    - Maximum value length - 256 Unicode characters in UTF-8
    - If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
    - Tag keys and values are case-sensitive.
    - Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
    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 hasTags() method.
    Returns:
    The metadata that you apply to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
    
    The following basic restrictions apply to tags:
    
    Maximum number of tags per resource - 50
    
    For each resource, each tag key must be unique, and each tag key can have only one value.
    
    Maximum key length - 128 Unicode characters in UTF-8
    
    Maximum value length - 256 Unicode characters in UTF-8
    
    If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
    
    Tag keys and values are case-sensitive.
    
    Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
  - pidMode
```
public final PidMode pidMode()
```
    The process namespace to use for the containers in the task. The valid values are host or task. If host is specified, then all containers within the tasks that specified the host PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same process namespace. If no value is specified, the default is a private namespace. For more information, see PID settings in the Docker run reference.
    
    If the host PID mode is used, be aware that there is a heightened risk of undesired process namespace expose. For more information, see Docker security.
    
    This parameter is not supported for Windows containers or tasks run on Fargate.
    
    If the service returns an enum value that is not available in the current SDK version, pidMode will return PidMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from pidModeAsString().
    
    Returns:
    
    The process namespace to use for the containers in the task. The valid values are host or task. If host is specified, then all containers within the tasks that specified the host PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same process namespace. If no value is specified, the default is a private namespace. For more information, see PID settings in the Docker run reference.
    
    If the host PID mode is used, be aware that there is a heightened risk of undesired process namespace expose. For more information, see Docker security.
    
    This parameter is not supported for Windows containers or tasks run on Fargate.
    
    See Also:
    
    PidMode
  - pidModeAsString
```
public final String pidModeAsString()
```
    The process namespace to use for the containers in the task. The valid values are host or task. If host is specified, then all containers within the tasks that specified the host PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same process namespace. If no value is specified, the default is a private namespace. For more information, see PID settings in the Docker run reference.
    
    If the host PID mode is used, be aware that there is a heightened risk of undesired process namespace expose. For more information, see Docker security.
    
    This parameter is not supported for Windows containers or tasks run on Fargate.
    
    If the service returns an enum value that is not available in the current SDK version, pidMode will return PidMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from pidModeAsString().
    
    Returns:
    
    The process namespace to use for the containers in the task. The valid values are host or task. If host is specified, then all containers within the tasks that specified the host PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same process namespace. If no value is specified, the default is a private namespace. For more information, see PID settings in the Docker run reference.
    
    If the host PID mode is used, be aware that there is a heightened risk of undesired process namespace expose. For more information, see Docker security.
    
    This parameter is not supported for Windows containers or tasks run on Fargate.
    
    See Also:
    
    PidMode
  - ipcMode
```
public final IpcMode ipcMode()
```
    The IPC resource namespace to use for the containers in the task. The valid values are host, task, or none. If host is specified, then all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same IPC resources. If none is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference.
    
    If the host IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see Docker security.
    
    If you are setting namespaced kernel parameters using systemControls for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls in the Amazon Elastic Container Service Developer Guide.
    - For tasks that use the host IPC mode, IPC namespace related systemControls are not supported.
    - For tasks that use the task IPC mode, IPC namespace related systemControls will apply to all containers within a task.
    This parameter is not supported for Windows containers or tasks run on Fargate.
    
    If the service returns an enum value that is not available in the current SDK version, ipcMode will return IpcMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ipcModeAsString().
    Returns:
    The IPC resource namespace to use for the containers in the task. The valid values are host, task, or none. If host is specified, then all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same IPC resources. If none is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference.
    
    If the host IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see Docker security.
    
    If you are setting namespaced kernel parameters using systemControls for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls in the Amazon Elastic Container Service Developer Guide.
    
    For tasks that use the host IPC mode, IPC namespace related systemControls are not supported.
    
    For tasks that use the task IPC mode, IPC namespace related systemControls will apply to all containers within a task.
    
    This parameter is not supported for Windows containers or tasks run on Fargate.
    See Also:
    
    IpcMode
  - ipcModeAsString
```
public final String ipcModeAsString()
```
    The IPC resource namespace to use for the containers in the task. The valid values are host, task, or none. If host is specified, then all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same IPC resources. If none is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference.
    
    If the host IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see Docker security.
    
    If you are setting namespaced kernel parameters using systemControls for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls in the Amazon Elastic Container Service Developer Guide.
    - For tasks that use the host IPC mode, IPC namespace related systemControls are not supported.
    - For tasks that use the task IPC mode, IPC namespace related systemControls will apply to all containers within a task.
    This parameter is not supported for Windows containers or tasks run on Fargate.
    
    If the service returns an enum value that is not available in the current SDK version, ipcMode will return IpcMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ipcModeAsString().
    Returns:
    The IPC resource namespace to use for the containers in the task. The valid values are host, task, or none. If host is specified, then all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same IPC resources. If none is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference.
    
    If the host IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see Docker security.
    
    If you are setting namespaced kernel parameters using systemControls for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls in the Amazon Elastic Container Service Developer Guide.
    
    For tasks that use the host IPC mode, IPC namespace related systemControls are not supported.
    
    For tasks that use the task IPC mode, IPC namespace related systemControls will apply to all containers within a task.
    
    This parameter is not supported for Windows containers or tasks run on Fargate.
    See Also:
    
    IpcMode
  - proxyConfiguration
```
public final ProxyConfiguration proxyConfiguration()
```
    The configuration details for the App Mesh proxy.
    
    For tasks hosted on Amazon EC2 instances, the container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ecs-init package to enable a proxy configuration. If your container instances are launched from the Amazon ECS-optimized AMI version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized AMI versions in the Amazon Elastic Container Service Developer Guide.
    
    Returns:
    
    The configuration details for the App Mesh proxy.
    
    For tasks hosted on Amazon EC2 instances, the container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ecs-init package to enable a proxy configuration. If your container instances are launched from the Amazon ECS-optimized AMI version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized AMI versions in the Amazon Elastic Container Service Developer Guide.
  - hasInferenceAccelerators
```
public final boolean hasInferenceAccelerators()
```
    For responses, this returns true if the service returned a value for the InferenceAccelerators 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.
  - inferenceAccelerators
```
public final List<InferenceAccelerator> inferenceAccelerators()
```
    The Elastic Inference accelerators to use for the containers in the task.
    
    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 hasInferenceAccelerators() method.
    
    Returns:
    
    The Elastic Inference accelerators to use for the containers in the task.
  - ephemeralStorage
```
public final EphemeralStorage ephemeralStorage()
```
    The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on Fargate. For more information, see Fargate task storage in the Amazon ECS User Guide for Fargate.
    
    This parameter is only supported for tasks hosted on Fargate using platform version 1.4.0 or later.
    
    Returns:
    
    The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on Fargate. For more information, see Fargate task storage in the Amazon ECS User Guide for Fargate.
    
    This parameter is only supported for tasks hosted on Fargate using platform version 1.4.0 or later.
  - toBuilder
```
public RegisterTaskDefinitionRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<RegisterTaskDefinitionRequest.Builder,RegisterTaskDefinitionRequest>
    
    Specified by:
    
    toBuilder in class EcsRequest
  - builder
```
public static RegisterTaskDefinitionRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends RegisterTaskDefinitionRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class RegisterTaskDefinitionRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

family

taskRoleArn

executionRoleArn

networkMode

networkModeAsString

hasContainerDefinitions

containerDefinitions

hasVolumes

volumes

hasPlacementConstraints

placementConstraints

requiresCompatibilities

hasRequiresCompatibilities

requiresCompatibilitiesAsStrings

cpu

memory

hasTags

tags

pidMode

pidModeAsString

ipcMode

ipcModeAsString

proxyConfiguration

hasInferenceAccelerators

inferenceAccelerators

ephemeralStorage

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields