AWS SDK for C++  1.8.51
AWS SDK for C++
Public Member Functions | List of all members
Aws::ECS::Model::RegisterTaskDefinitionRequest Class Reference

#include <RegisterTaskDefinitionRequest.h>

+ Inheritance diagram for Aws::ECS::Model::RegisterTaskDefinitionRequest:

Public Member Functions

 RegisterTaskDefinitionRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetFamily () const
 
bool FamilyHasBeenSet () const
 
void SetFamily (const Aws::String &value)
 
void SetFamily (Aws::String &&value)
 
void SetFamily (const char *value)
 
RegisterTaskDefinitionRequestWithFamily (const Aws::String &value)
 
RegisterTaskDefinitionRequestWithFamily (Aws::String &&value)
 
RegisterTaskDefinitionRequestWithFamily (const char *value)
 
const Aws::StringGetTaskRoleArn () const
 
bool TaskRoleArnHasBeenSet () const
 
void SetTaskRoleArn (const Aws::String &value)
 
void SetTaskRoleArn (Aws::String &&value)
 
void SetTaskRoleArn (const char *value)
 
RegisterTaskDefinitionRequestWithTaskRoleArn (const Aws::String &value)
 
RegisterTaskDefinitionRequestWithTaskRoleArn (Aws::String &&value)
 
RegisterTaskDefinitionRequestWithTaskRoleArn (const char *value)
 
const Aws::StringGetExecutionRoleArn () const
 
bool ExecutionRoleArnHasBeenSet () const
 
void SetExecutionRoleArn (const Aws::String &value)
 
void SetExecutionRoleArn (Aws::String &&value)
 
void SetExecutionRoleArn (const char *value)
 
RegisterTaskDefinitionRequestWithExecutionRoleArn (const Aws::String &value)
 
RegisterTaskDefinitionRequestWithExecutionRoleArn (Aws::String &&value)
 
RegisterTaskDefinitionRequestWithExecutionRoleArn (const char *value)
 
const NetworkModeGetNetworkMode () const
 
bool NetworkModeHasBeenSet () const
 
void SetNetworkMode (const NetworkMode &value)
 
void SetNetworkMode (NetworkMode &&value)
 
RegisterTaskDefinitionRequestWithNetworkMode (const NetworkMode &value)
 
RegisterTaskDefinitionRequestWithNetworkMode (NetworkMode &&value)
 
const Aws::Vector< ContainerDefinition > & GetContainerDefinitions () const
 
bool ContainerDefinitionsHasBeenSet () const
 
void SetContainerDefinitions (const Aws::Vector< ContainerDefinition > &value)
 
void SetContainerDefinitions (Aws::Vector< ContainerDefinition > &&value)
 
RegisterTaskDefinitionRequestWithContainerDefinitions (const Aws::Vector< ContainerDefinition > &value)
 
RegisterTaskDefinitionRequestWithContainerDefinitions (Aws::Vector< ContainerDefinition > &&value)
 
RegisterTaskDefinitionRequestAddContainerDefinitions (const ContainerDefinition &value)
 
RegisterTaskDefinitionRequestAddContainerDefinitions (ContainerDefinition &&value)
 
const Aws::Vector< Volume > & GetVolumes () const
 
bool VolumesHasBeenSet () const
 
void SetVolumes (const Aws::Vector< Volume > &value)
 
void SetVolumes (Aws::Vector< Volume > &&value)
 
RegisterTaskDefinitionRequestWithVolumes (const Aws::Vector< Volume > &value)
 
RegisterTaskDefinitionRequestWithVolumes (Aws::Vector< Volume > &&value)
 
RegisterTaskDefinitionRequestAddVolumes (const Volume &value)
 
RegisterTaskDefinitionRequestAddVolumes (Volume &&value)
 
const Aws::Vector< TaskDefinitionPlacementConstraint > & GetPlacementConstraints () const
 
bool PlacementConstraintsHasBeenSet () const
 
void SetPlacementConstraints (const Aws::Vector< TaskDefinitionPlacementConstraint > &value)
 
void SetPlacementConstraints (Aws::Vector< TaskDefinitionPlacementConstraint > &&value)
 
RegisterTaskDefinitionRequestWithPlacementConstraints (const Aws::Vector< TaskDefinitionPlacementConstraint > &value)
 
RegisterTaskDefinitionRequestWithPlacementConstraints (Aws::Vector< TaskDefinitionPlacementConstraint > &&value)
 
RegisterTaskDefinitionRequestAddPlacementConstraints (const TaskDefinitionPlacementConstraint &value)
 
RegisterTaskDefinitionRequestAddPlacementConstraints (TaskDefinitionPlacementConstraint &&value)
 
const Aws::Vector< Compatibility > & GetRequiresCompatibilities () const
 
bool RequiresCompatibilitiesHasBeenSet () const
 
void SetRequiresCompatibilities (const Aws::Vector< Compatibility > &value)
 
void SetRequiresCompatibilities (Aws::Vector< Compatibility > &&value)
 
RegisterTaskDefinitionRequestWithRequiresCompatibilities (const Aws::Vector< Compatibility > &value)
 
RegisterTaskDefinitionRequestWithRequiresCompatibilities (Aws::Vector< Compatibility > &&value)
 
RegisterTaskDefinitionRequestAddRequiresCompatibilities (const Compatibility &value)
 
RegisterTaskDefinitionRequestAddRequiresCompatibilities (Compatibility &&value)
 
const Aws::StringGetCpu () const
 
bool CpuHasBeenSet () const
 
void SetCpu (const Aws::String &value)
 
void SetCpu (Aws::String &&value)
 
void SetCpu (const char *value)
 
RegisterTaskDefinitionRequestWithCpu (const Aws::String &value)
 
RegisterTaskDefinitionRequestWithCpu (Aws::String &&value)
 
RegisterTaskDefinitionRequestWithCpu (const char *value)
 
const Aws::StringGetMemory () const
 
bool MemoryHasBeenSet () const
 
void SetMemory (const Aws::String &value)
 
void SetMemory (Aws::String &&value)
 
void SetMemory (const char *value)
 
RegisterTaskDefinitionRequestWithMemory (const Aws::String &value)
 
RegisterTaskDefinitionRequestWithMemory (Aws::String &&value)
 
RegisterTaskDefinitionRequestWithMemory (const char *value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
RegisterTaskDefinitionRequestWithTags (const Aws::Vector< Tag > &value)
 
RegisterTaskDefinitionRequestWithTags (Aws::Vector< Tag > &&value)
 
RegisterTaskDefinitionRequestAddTags (const Tag &value)
 
RegisterTaskDefinitionRequestAddTags (Tag &&value)
 
const PidModeGetPidMode () const
 
bool PidModeHasBeenSet () const
 
void SetPidMode (const PidMode &value)
 
void SetPidMode (PidMode &&value)
 
RegisterTaskDefinitionRequestWithPidMode (const PidMode &value)
 
RegisterTaskDefinitionRequestWithPidMode (PidMode &&value)
 
const IpcModeGetIpcMode () const
 
bool IpcModeHasBeenSet () const
 
void SetIpcMode (const IpcMode &value)
 
void SetIpcMode (IpcMode &&value)
 
RegisterTaskDefinitionRequestWithIpcMode (const IpcMode &value)
 
RegisterTaskDefinitionRequestWithIpcMode (IpcMode &&value)
 
const ProxyConfigurationGetProxyConfiguration () const
 
bool ProxyConfigurationHasBeenSet () const
 
void SetProxyConfiguration (const ProxyConfiguration &value)
 
void SetProxyConfiguration (ProxyConfiguration &&value)
 
RegisterTaskDefinitionRequestWithProxyConfiguration (const ProxyConfiguration &value)
 
RegisterTaskDefinitionRequestWithProxyConfiguration (ProxyConfiguration &&value)
 
const Aws::Vector< InferenceAccelerator > & GetInferenceAccelerators () const
 
bool InferenceAcceleratorsHasBeenSet () const
 
void SetInferenceAccelerators (const Aws::Vector< InferenceAccelerator > &value)
 
void SetInferenceAccelerators (Aws::Vector< InferenceAccelerator > &&value)
 
RegisterTaskDefinitionRequestWithInferenceAccelerators (const Aws::Vector< InferenceAccelerator > &value)
 
RegisterTaskDefinitionRequestWithInferenceAccelerators (Aws::Vector< InferenceAccelerator > &&value)
 
RegisterTaskDefinitionRequestAddInferenceAccelerators (const InferenceAccelerator &value)
 
RegisterTaskDefinitionRequestAddInferenceAccelerators (InferenceAccelerator &&value)
 
- Public Member Functions inherited from Aws::ECS::ECSRequest
virtual ~ECSRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 32 of file RegisterTaskDefinitionRequest.h.

Constructor & Destructor Documentation

◆ RegisterTaskDefinitionRequest()

Aws::ECS::Model::RegisterTaskDefinitionRequest::RegisterTaskDefinitionRequest ( )

Member Function Documentation

◆ AddContainerDefinitions() [1/2]

RegisterTaskDefinitionRequest& Aws::ECS::Model::RegisterTaskDefinitionRequest::AddContainerDefinitions ( const ContainerDefinition value)
inline

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

Definition at line 546 of file RegisterTaskDefinitionRequest.h.

◆ AddContainerDefinitions() [2/2]

RegisterTaskDefinitionRequest& Aws::ECS::Model::RegisterTaskDefinitionRequest::AddContainerDefinitions ( ContainerDefinition &&  value)
inline

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

Definition at line 552 of file RegisterTaskDefinitionRequest.h.

◆ AddInferenceAccelerators() [1/2]

RegisterTaskDefinitionRequest& Aws::ECS::Model::RegisterTaskDefinitionRequest::AddInferenceAccelerators ( const InferenceAccelerator value)
inline

The Elastic Inference accelerators to use for the containers in the task.

Definition at line 1605 of file RegisterTaskDefinitionRequest.h.

◆ AddInferenceAccelerators() [2/2]

RegisterTaskDefinitionRequest& Aws::ECS::Model::RegisterTaskDefinitionRequest::AddInferenceAccelerators ( InferenceAccelerator &&  value)
inline

The Elastic Inference accelerators to use for the containers in the task.

Definition at line 1610 of file RegisterTaskDefinitionRequest.h.

◆ AddPlacementConstraints() [1/2]

RegisterTaskDefinitionRequest& Aws::ECS::Model::RegisterTaskDefinitionRequest::AddPlacementConstraints ( const TaskDefinitionPlacementConstraint value)
inline

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

Definition at line 651 of file RegisterTaskDefinitionRequest.h.

◆ AddPlacementConstraints() [2/2]

RegisterTaskDefinitionRequest& Aws::ECS::Model::RegisterTaskDefinitionRequest::AddPlacementConstraints ( TaskDefinitionPlacementConstraint &&  value)
inline

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

Definition at line 658 of file RegisterTaskDefinitionRequest.h.

◆ AddRequiresCompatibilities() [1/2]

RegisterTaskDefinitionRequest& Aws::ECS::Model::RegisterTaskDefinitionRequest::AddRequiresCompatibilities ( const Compatibility value)
inline

The launch type required by the task. If no value is specified, it defaults to EC2.

Definition at line 701 of file RegisterTaskDefinitionRequest.h.

◆ AddRequiresCompatibilities() [2/2]

RegisterTaskDefinitionRequest& Aws::ECS::Model::RegisterTaskDefinitionRequest::AddRequiresCompatibilities ( Compatibility &&  value)
inline

The launch type required by the task. If no value is specified, it defaults to EC2.

Definition at line 707 of file RegisterTaskDefinitionRequest.h.

◆ AddTags() [1/2]

RegisterTaskDefinitionRequest& Aws::ECS::Model::RegisterTaskDefinitionRequest::AddTags ( const Tag value)
inline

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

Definition at line 1234 of file RegisterTaskDefinitionRequest.h.

◆ AddTags() [2/2]

RegisterTaskDefinitionRequest& Aws::ECS::Model::RegisterTaskDefinitionRequest::AddTags ( Tag &&  value)
inline

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

Definition at line 1254 of file RegisterTaskDefinitionRequest.h.

◆ AddVolumes() [1/2]

RegisterTaskDefinitionRequest& Aws::ECS::Model::RegisterTaskDefinitionRequest::AddVolumes ( const Volume value)
inline

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

Definition at line 595 of file RegisterTaskDefinitionRequest.h.

◆ AddVolumes() [2/2]

RegisterTaskDefinitionRequest& Aws::ECS::Model::RegisterTaskDefinitionRequest::AddVolumes ( Volume &&  value)
inline

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

Definition at line 601 of file RegisterTaskDefinitionRequest.h.

◆ ContainerDefinitionsHasBeenSet()

bool Aws::ECS::Model::RegisterTaskDefinitionRequest::ContainerDefinitionsHasBeenSet ( ) const
inline

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

Definition at line 516 of file RegisterTaskDefinitionRequest.h.

◆ CpuHasBeenSet()

bool Aws::ECS::Model::RegisterTaskDefinitionRequest::CpuHasBeenSet ( ) const
inline

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)

Definition at line 758 of file RegisterTaskDefinitionRequest.h.

◆ ExecutionRoleArnHasBeenSet()

bool Aws::ECS::Model::RegisterTaskDefinitionRequest::ExecutionRoleArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make AWS 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.

Definition at line 214 of file RegisterTaskDefinitionRequest.h.

◆ FamilyHasBeenSet()

bool Aws::ECS::Model::RegisterTaskDefinitionRequest::FamilyHasBeenSet ( ) const
inline

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, and hyphens are allowed.

Definition at line 62 of file RegisterTaskDefinitionRequest.h.

◆ GetContainerDefinitions()

const Aws::Vector<ContainerDefinition>& Aws::ECS::Model::RegisterTaskDefinitionRequest::GetContainerDefinitions ( ) const
inline

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

Definition at line 510 of file RegisterTaskDefinitionRequest.h.

◆ GetCpu()

const Aws::String& Aws::ECS::Model::RegisterTaskDefinitionRequest::GetCpu ( ) const
inline

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)

Definition at line 733 of file RegisterTaskDefinitionRequest.h.

◆ GetExecutionRoleArn()

const Aws::String& Aws::ECS::Model::RegisterTaskDefinitionRequest::GetExecutionRoleArn ( ) const
inline

The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make AWS 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.

Definition at line 203 of file RegisterTaskDefinitionRequest.h.

◆ GetFamily()

const Aws::String& Aws::ECS::Model::RegisterTaskDefinitionRequest::GetFamily ( ) const
inline

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, and hyphens are allowed.

Definition at line 54 of file RegisterTaskDefinitionRequest.h.

◆ GetInferenceAccelerators()

const Aws::Vector<InferenceAccelerator>& Aws::ECS::Model::RegisterTaskDefinitionRequest::GetInferenceAccelerators ( ) const
inline

The Elastic Inference accelerators to use for the containers in the task.

Definition at line 1575 of file RegisterTaskDefinitionRequest.h.

◆ GetIpcMode()

const IpcMode& Aws::ECS::Model::RegisterTaskDefinitionRequest::GetIpcMode ( ) const
inline

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 using the Fargate launch type.

Definition at line 1395 of file RegisterTaskDefinitionRequest.h.

◆ GetMemory()

const Aws::String& Aws::ECS::Model::RegisterTaskDefinitionRequest::GetMemory ( ) const
inline

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)

Definition at line 932 of file RegisterTaskDefinitionRequest.h.

◆ GetNetworkMode()

const NetworkMode& Aws::ECS::Model::RegisterTaskDefinitionRequest::GetNetworkMode ( ) const
inline

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 you are using the Fargate launch type, the awsvpc network mode is required. If you are using the EC2 launch type, any network mode 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.

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.

Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the ecs-init package, or AWS Fargate infrastructure support the awsvpc network mode.

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.

Docker for Windows uses different network modes than Docker for Linux. When you register a task definition with Windows containers, you must not specify a network mode. If you use the console to register a task definition with Windows containers, you must choose the <default> network mode object.

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

Definition at line 318 of file RegisterTaskDefinitionRequest.h.

◆ GetPidMode()

const PidMode& Aws::ECS::Model::RegisterTaskDefinitionRequest::GetPidMode ( ) const
inline

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 using the Fargate launch type.

Definition at line 1273 of file RegisterTaskDefinitionRequest.h.

◆ GetPlacementConstraints()

const Aws::Vector<TaskDefinitionPlacementConstraint>& Aws::ECS::Model::RegisterTaskDefinitionRequest::GetPlacementConstraints ( ) const
inline

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

Definition at line 609 of file RegisterTaskDefinitionRequest.h.

◆ GetProxyConfiguration()

const ProxyConfiguration& Aws::ECS::Model::RegisterTaskDefinitionRequest::GetProxyConfiguration ( ) const
inline

Definition at line 1554 of file RegisterTaskDefinitionRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::ECS::Model::RegisterTaskDefinitionRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::ECS::ECSRequest.

◆ GetRequiresCompatibilities()

const Aws::Vector<Compatibility>& Aws::ECS::Model::RegisterTaskDefinitionRequest::GetRequiresCompatibilities ( ) const
inline

The launch type required by the task. If no value is specified, it defaults to EC2.

Definition at line 665 of file RegisterTaskDefinitionRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::ECS::Model::RegisterTaskDefinitionRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 41 of file RegisterTaskDefinitionRequest.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::ECS::Model::RegisterTaskDefinitionRequest::GetTags ( ) const
inline

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

Definition at line 1114 of file RegisterTaskDefinitionRequest.h.

◆ GetTaskRoleArn()

const Aws::String& Aws::ECS::Model::RegisterTaskDefinitionRequest::GetTaskRoleArn ( ) const
inline

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.

Definition at line 121 of file RegisterTaskDefinitionRequest.h.

◆ GetVolumes()

const Aws::Vector<Volume>& Aws::ECS::Model::RegisterTaskDefinitionRequest::GetVolumes ( ) const
inline

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

Definition at line 559 of file RegisterTaskDefinitionRequest.h.

◆ InferenceAcceleratorsHasBeenSet()

bool Aws::ECS::Model::RegisterTaskDefinitionRequest::InferenceAcceleratorsHasBeenSet ( ) const
inline

The Elastic Inference accelerators to use for the containers in the task.

Definition at line 1580 of file RegisterTaskDefinitionRequest.h.

◆ IpcModeHasBeenSet()

bool Aws::ECS::Model::RegisterTaskDefinitionRequest::IpcModeHasBeenSet ( ) const
inline

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 using the Fargate launch type.

Definition at line 1426 of file RegisterTaskDefinitionRequest.h.

◆ MemoryHasBeenSet()

bool Aws::ECS::Model::RegisterTaskDefinitionRequest::MemoryHasBeenSet ( ) const
inline

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)

Definition at line 955 of file RegisterTaskDefinitionRequest.h.

◆ NetworkModeHasBeenSet()

bool Aws::ECS::Model::RegisterTaskDefinitionRequest::NetworkModeHasBeenSet ( ) const
inline

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 you are using the Fargate launch type, the awsvpc network mode is required. If you are using the EC2 launch type, any network mode 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.

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.

Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the ecs-init package, or AWS Fargate infrastructure support the awsvpc network mode.

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.

Docker for Windows uses different network modes than Docker for Linux. When you register a task definition with Windows containers, you must not specify a network mode. If you use the console to register a task definition with Windows containers, you must choose the <default> network mode object.

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

Definition at line 355 of file RegisterTaskDefinitionRequest.h.

◆ PidModeHasBeenSet()

bool Aws::ECS::Model::RegisterTaskDefinitionRequest::PidModeHasBeenSet ( ) const
inline

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 using the Fargate launch type.

Definition at line 1291 of file RegisterTaskDefinitionRequest.h.

◆ PlacementConstraintsHasBeenSet()

bool Aws::ECS::Model::RegisterTaskDefinitionRequest::PlacementConstraintsHasBeenSet ( ) const
inline

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

Definition at line 616 of file RegisterTaskDefinitionRequest.h.

◆ ProxyConfigurationHasBeenSet()

bool Aws::ECS::Model::RegisterTaskDefinitionRequest::ProxyConfigurationHasBeenSet ( ) const
inline

Definition at line 1557 of file RegisterTaskDefinitionRequest.h.

◆ RequiresCompatibilitiesHasBeenSet()

bool Aws::ECS::Model::RegisterTaskDefinitionRequest::RequiresCompatibilitiesHasBeenSet ( ) const
inline

The launch type required by the task. If no value is specified, it defaults to EC2.

Definition at line 671 of file RegisterTaskDefinitionRequest.h.

◆ SerializePayload()

Aws::String Aws::ECS::Model::RegisterTaskDefinitionRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetContainerDefinitions() [1/2]

void Aws::ECS::Model::RegisterTaskDefinitionRequest::SetContainerDefinitions ( const Aws::Vector< ContainerDefinition > &  value)
inline

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

Definition at line 522 of file RegisterTaskDefinitionRequest.h.

◆ SetContainerDefinitions() [2/2]

void Aws::ECS::Model::RegisterTaskDefinitionRequest::SetContainerDefinitions ( Aws::Vector< ContainerDefinition > &&  value)
inline

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

Definition at line 528 of file RegisterTaskDefinitionRequest.h.

◆ SetCpu() [1/3]

void Aws::ECS::Model::RegisterTaskDefinitionRequest::SetCpu ( const Aws::String value)
inline

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)

Definition at line 783 of file RegisterTaskDefinitionRequest.h.

◆ SetCpu() [2/3]

void Aws::ECS::Model::RegisterTaskDefinitionRequest::SetCpu ( Aws::String &&  value)
inline

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)

Definition at line 808 of file RegisterTaskDefinitionRequest.h.

◆ SetCpu() [3/3]

void Aws::ECS::Model::RegisterTaskDefinitionRequest::SetCpu ( const char *  value)
inline

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)

Definition at line 833 of file RegisterTaskDefinitionRequest.h.

◆ SetExecutionRoleArn() [1/3]

void Aws::ECS::Model::RegisterTaskDefinitionRequest::SetExecutionRoleArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make AWS 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.

Definition at line 225 of file RegisterTaskDefinitionRequest.h.

◆ SetExecutionRoleArn() [2/3]

void Aws::ECS::Model::RegisterTaskDefinitionRequest::SetExecutionRoleArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make AWS 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.

Definition at line 236 of file RegisterTaskDefinitionRequest.h.

◆ SetExecutionRoleArn() [3/3]

void Aws::ECS::Model::RegisterTaskDefinitionRequest::SetExecutionRoleArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make AWS 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.

Definition at line 247 of file RegisterTaskDefinitionRequest.h.

◆ SetFamily() [1/3]

void Aws::ECS::Model::RegisterTaskDefinitionRequest::SetFamily ( const Aws::String value)
inline

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, and hyphens are allowed.

Definition at line 70 of file RegisterTaskDefinitionRequest.h.

◆ SetFamily() [2/3]

void Aws::ECS::Model::RegisterTaskDefinitionRequest::SetFamily ( Aws::String &&  value)
inline

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, and hyphens are allowed.

Definition at line 78 of file RegisterTaskDefinitionRequest.h.

◆ SetFamily() [3/3]

void Aws::ECS::Model::RegisterTaskDefinitionRequest::SetFamily ( const char *  value)
inline

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, and hyphens are allowed.

Definition at line 86 of file RegisterTaskDefinitionRequest.h.

◆ SetInferenceAccelerators() [1/2]

void Aws::ECS::Model::RegisterTaskDefinitionRequest::SetInferenceAccelerators ( const Aws::Vector< InferenceAccelerator > &  value)
inline

The Elastic Inference accelerators to use for the containers in the task.

Definition at line 1585 of file RegisterTaskDefinitionRequest.h.

◆ SetInferenceAccelerators() [2/2]

void Aws::ECS::Model::RegisterTaskDefinitionRequest::SetInferenceAccelerators ( Aws::Vector< InferenceAccelerator > &&  value)
inline

The Elastic Inference accelerators to use for the containers in the task.

Definition at line 1590 of file RegisterTaskDefinitionRequest.h.

◆ SetIpcMode() [1/2]

void Aws::ECS::Model::RegisterTaskDefinitionRequest::SetIpcMode ( const IpcMode value)
inline

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 using the Fargate launch type.

Definition at line 1457 of file RegisterTaskDefinitionRequest.h.

◆ SetIpcMode() [2/2]

void Aws::ECS::Model::RegisterTaskDefinitionRequest::SetIpcMode ( IpcMode &&  value)
inline

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 using the Fargate launch type.

Definition at line 1488 of file RegisterTaskDefinitionRequest.h.

◆ SetMemory() [1/3]

void Aws::ECS::Model::RegisterTaskDefinitionRequest::SetMemory ( const Aws::String value)
inline

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)

Definition at line 978 of file RegisterTaskDefinitionRequest.h.

◆ SetMemory() [2/3]

void Aws::ECS::Model::RegisterTaskDefinitionRequest::SetMemory ( Aws::String &&  value)
inline

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)

Definition at line 1001 of file RegisterTaskDefinitionRequest.h.

◆ SetMemory() [3/3]

void Aws::ECS::Model::RegisterTaskDefinitionRequest::SetMemory ( const char *  value)
inline

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)

Definition at line 1024 of file RegisterTaskDefinitionRequest.h.

◆ SetNetworkMode() [1/2]

void Aws::ECS::Model::RegisterTaskDefinitionRequest::SetNetworkMode ( const NetworkMode value)
inline

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 you are using the Fargate launch type, the awsvpc network mode is required. If you are using the EC2 launch type, any network mode 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.

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.

Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the ecs-init package, or AWS Fargate infrastructure support the awsvpc network mode.

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.

Docker for Windows uses different network modes than Docker for Linux. When you register a task definition with Windows containers, you must not specify a network mode. If you use the console to register a task definition with Windows containers, you must choose the <default> network mode object.

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

Definition at line 392 of file RegisterTaskDefinitionRequest.h.

◆ SetNetworkMode() [2/2]

void Aws::ECS::Model::RegisterTaskDefinitionRequest::SetNetworkMode ( NetworkMode &&  value)
inline

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 you are using the Fargate launch type, the awsvpc network mode is required. If you are using the EC2 launch type, any network mode 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.

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.

Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the ecs-init package, or AWS Fargate infrastructure support the awsvpc network mode.

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.

Docker for Windows uses different network modes than Docker for Linux. When you register a task definition with Windows containers, you must not specify a network mode. If you use the console to register a task definition with Windows containers, you must choose the <default> network mode object.

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

Definition at line 429 of file RegisterTaskDefinitionRequest.h.

◆ SetPidMode() [1/2]

void Aws::ECS::Model::RegisterTaskDefinitionRequest::SetPidMode ( const PidMode value)
inline

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 using the Fargate launch type.

Definition at line 1309 of file RegisterTaskDefinitionRequest.h.

◆ SetPidMode() [2/2]

void Aws::ECS::Model::RegisterTaskDefinitionRequest::SetPidMode ( PidMode &&  value)
inline

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 using the Fargate launch type.

Definition at line 1327 of file RegisterTaskDefinitionRequest.h.

◆ SetPlacementConstraints() [1/2]

void Aws::ECS::Model::RegisterTaskDefinitionRequest::SetPlacementConstraints ( const Aws::Vector< TaskDefinitionPlacementConstraint > &  value)
inline

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

Definition at line 623 of file RegisterTaskDefinitionRequest.h.

◆ SetPlacementConstraints() [2/2]

void Aws::ECS::Model::RegisterTaskDefinitionRequest::SetPlacementConstraints ( Aws::Vector< TaskDefinitionPlacementConstraint > &&  value)
inline

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

Definition at line 630 of file RegisterTaskDefinitionRequest.h.

◆ SetProxyConfiguration() [1/2]

void Aws::ECS::Model::RegisterTaskDefinitionRequest::SetProxyConfiguration ( const ProxyConfiguration value)
inline

Definition at line 1560 of file RegisterTaskDefinitionRequest.h.

◆ SetProxyConfiguration() [2/2]

void Aws::ECS::Model::RegisterTaskDefinitionRequest::SetProxyConfiguration ( ProxyConfiguration &&  value)
inline

Definition at line 1563 of file RegisterTaskDefinitionRequest.h.

◆ SetRequiresCompatibilities() [1/2]

void Aws::ECS::Model::RegisterTaskDefinitionRequest::SetRequiresCompatibilities ( const Aws::Vector< Compatibility > &  value)
inline

The launch type required by the task. If no value is specified, it defaults to EC2.

Definition at line 677 of file RegisterTaskDefinitionRequest.h.

◆ SetRequiresCompatibilities() [2/2]

void Aws::ECS::Model::RegisterTaskDefinitionRequest::SetRequiresCompatibilities ( Aws::Vector< Compatibility > &&  value)
inline

The launch type required by the task. If no value is specified, it defaults to EC2.

Definition at line 683 of file RegisterTaskDefinitionRequest.h.

◆ SetTags() [1/2]

void Aws::ECS::Model::RegisterTaskDefinitionRequest::SetTags ( const Aws::Vector< Tag > &  value)
inline

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

Definition at line 1154 of file RegisterTaskDefinitionRequest.h.

◆ SetTags() [2/2]

void Aws::ECS::Model::RegisterTaskDefinitionRequest::SetTags ( Aws::Vector< Tag > &&  value)
inline

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

Definition at line 1174 of file RegisterTaskDefinitionRequest.h.

◆ SetTaskRoleArn() [1/3]

void Aws::ECS::Model::RegisterTaskDefinitionRequest::SetTaskRoleArn ( const Aws::String value)
inline

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.

Definition at line 141 of file RegisterTaskDefinitionRequest.h.

◆ SetTaskRoleArn() [2/3]

void Aws::ECS::Model::RegisterTaskDefinitionRequest::SetTaskRoleArn ( Aws::String &&  value)
inline

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.

Definition at line 151 of file RegisterTaskDefinitionRequest.h.

◆ SetTaskRoleArn() [3/3]

void Aws::ECS::Model::RegisterTaskDefinitionRequest::SetTaskRoleArn ( const char *  value)
inline

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.

Definition at line 161 of file RegisterTaskDefinitionRequest.h.

◆ SetVolumes() [1/2]

void Aws::ECS::Model::RegisterTaskDefinitionRequest::SetVolumes ( const Aws::Vector< Volume > &  value)
inline

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

Definition at line 571 of file RegisterTaskDefinitionRequest.h.

◆ SetVolumes() [2/2]

void Aws::ECS::Model::RegisterTaskDefinitionRequest::SetVolumes ( Aws::Vector< Volume > &&  value)
inline

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

Definition at line 577 of file RegisterTaskDefinitionRequest.h.

◆ TagsHasBeenSet()

bool Aws::ECS::Model::RegisterTaskDefinitionRequest::TagsHasBeenSet ( ) const
inline

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

Definition at line 1134 of file RegisterTaskDefinitionRequest.h.

◆ TaskRoleArnHasBeenSet()

bool Aws::ECS::Model::RegisterTaskDefinitionRequest::TaskRoleArnHasBeenSet ( ) const
inline

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.

Definition at line 131 of file RegisterTaskDefinitionRequest.h.

◆ VolumesHasBeenSet()

bool Aws::ECS::Model::RegisterTaskDefinitionRequest::VolumesHasBeenSet ( ) const
inline

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

Definition at line 565 of file RegisterTaskDefinitionRequest.h.

◆ WithContainerDefinitions() [1/2]

RegisterTaskDefinitionRequest& Aws::ECS::Model::RegisterTaskDefinitionRequest::WithContainerDefinitions ( const Aws::Vector< ContainerDefinition > &  value)
inline

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

Definition at line 534 of file RegisterTaskDefinitionRequest.h.

◆ WithContainerDefinitions() [2/2]

RegisterTaskDefinitionRequest& Aws::ECS::Model::RegisterTaskDefinitionRequest::WithContainerDefinitions ( Aws::Vector< ContainerDefinition > &&  value)
inline

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

Definition at line 540 of file RegisterTaskDefinitionRequest.h.

◆ WithCpu() [1/3]

RegisterTaskDefinitionRequest& Aws::ECS::Model::RegisterTaskDefinitionRequest::WithCpu ( const Aws::String value)
inline

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)

Definition at line 858 of file RegisterTaskDefinitionRequest.h.

◆ WithCpu() [2/3]

RegisterTaskDefinitionRequest& Aws::ECS::Model::RegisterTaskDefinitionRequest::WithCpu ( Aws::String &&  value)
inline

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)

Definition at line 883 of file RegisterTaskDefinitionRequest.h.

◆ WithCpu() [3/3]

RegisterTaskDefinitionRequest& Aws::ECS::Model::RegisterTaskDefinitionRequest::WithCpu ( const char *  value)
inline

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)

Definition at line 908 of file RegisterTaskDefinitionRequest.h.

◆ WithExecutionRoleArn() [1/3]

RegisterTaskDefinitionRequest& Aws::ECS::Model::RegisterTaskDefinitionRequest::WithExecutionRoleArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make AWS 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.

Definition at line 258 of file RegisterTaskDefinitionRequest.h.

◆ WithExecutionRoleArn() [2/3]

RegisterTaskDefinitionRequest& Aws::ECS::Model::RegisterTaskDefinitionRequest::WithExecutionRoleArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make AWS 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.

Definition at line 269 of file RegisterTaskDefinitionRequest.h.

◆ WithExecutionRoleArn() [3/3]

RegisterTaskDefinitionRequest& Aws::ECS::Model::RegisterTaskDefinitionRequest::WithExecutionRoleArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make AWS 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.

Definition at line 280 of file RegisterTaskDefinitionRequest.h.

◆ WithFamily() [1/3]

RegisterTaskDefinitionRequest& Aws::ECS::Model::RegisterTaskDefinitionRequest::WithFamily ( const Aws::String value)
inline

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, and hyphens are allowed.

Definition at line 94 of file RegisterTaskDefinitionRequest.h.

◆ WithFamily() [2/3]

RegisterTaskDefinitionRequest& Aws::ECS::Model::RegisterTaskDefinitionRequest::WithFamily ( Aws::String &&  value)
inline

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, and hyphens are allowed.

Definition at line 102 of file RegisterTaskDefinitionRequest.h.

◆ WithFamily() [3/3]

RegisterTaskDefinitionRequest& Aws::ECS::Model::RegisterTaskDefinitionRequest::WithFamily ( const char *  value)
inline

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, and hyphens are allowed.

Definition at line 110 of file RegisterTaskDefinitionRequest.h.

◆ WithInferenceAccelerators() [1/2]

RegisterTaskDefinitionRequest& Aws::ECS::Model::RegisterTaskDefinitionRequest::WithInferenceAccelerators ( const Aws::Vector< InferenceAccelerator > &  value)
inline

The Elastic Inference accelerators to use for the containers in the task.

Definition at line 1595 of file RegisterTaskDefinitionRequest.h.

◆ WithInferenceAccelerators() [2/2]

RegisterTaskDefinitionRequest& Aws::ECS::Model::RegisterTaskDefinitionRequest::WithInferenceAccelerators ( Aws::Vector< InferenceAccelerator > &&  value)
inline

The Elastic Inference accelerators to use for the containers in the task.

Definition at line 1600 of file RegisterTaskDefinitionRequest.h.

◆ WithIpcMode() [1/2]

RegisterTaskDefinitionRequest& Aws::ECS::Model::RegisterTaskDefinitionRequest::WithIpcMode ( const IpcMode value)
inline

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 using the Fargate launch type.

Definition at line 1519 of file RegisterTaskDefinitionRequest.h.

◆ WithIpcMode() [2/2]

RegisterTaskDefinitionRequest& Aws::ECS::Model::RegisterTaskDefinitionRequest::WithIpcMode ( IpcMode &&  value)
inline

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 using the Fargate launch type.

Definition at line 1550 of file RegisterTaskDefinitionRequest.h.

◆ WithMemory() [1/3]

RegisterTaskDefinitionRequest& Aws::ECS::Model::RegisterTaskDefinitionRequest::WithMemory ( const Aws::String value)
inline

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)

Definition at line 1047 of file RegisterTaskDefinitionRequest.h.

◆ WithMemory() [2/3]

RegisterTaskDefinitionRequest& Aws::ECS::Model::RegisterTaskDefinitionRequest::WithMemory ( Aws::String &&  value)
inline

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)

Definition at line 1070 of file RegisterTaskDefinitionRequest.h.

◆ WithMemory() [3/3]

RegisterTaskDefinitionRequest& Aws::ECS::Model::RegisterTaskDefinitionRequest::WithMemory ( const char *  value)
inline

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)

Definition at line 1093 of file RegisterTaskDefinitionRequest.h.

◆ WithNetworkMode() [1/2]

RegisterTaskDefinitionRequest& Aws::ECS::Model::RegisterTaskDefinitionRequest::WithNetworkMode ( const NetworkMode value)
inline

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 you are using the Fargate launch type, the awsvpc network mode is required. If you are using the EC2 launch type, any network mode 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.

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.

Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the ecs-init package, or AWS Fargate infrastructure support the awsvpc network mode.

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.

Docker for Windows uses different network modes than Docker for Linux. When you register a task definition with Windows containers, you must not specify a network mode. If you use the console to register a task definition with Windows containers, you must choose the <default> network mode object.

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

Definition at line 466 of file RegisterTaskDefinitionRequest.h.

◆ WithNetworkMode() [2/2]

RegisterTaskDefinitionRequest& Aws::ECS::Model::RegisterTaskDefinitionRequest::WithNetworkMode ( NetworkMode &&  value)
inline

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 you are using the Fargate launch type, the awsvpc network mode is required. If you are using the EC2 launch type, any network mode 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.

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.

Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the ecs-init package, or AWS Fargate infrastructure support the awsvpc network mode.

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.

Docker for Windows uses different network modes than Docker for Linux. When you register a task definition with Windows containers, you must not specify a network mode. If you use the console to register a task definition with Windows containers, you must choose the <default> network mode object.

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

Definition at line 503 of file RegisterTaskDefinitionRequest.h.

◆ WithPidMode() [1/2]

RegisterTaskDefinitionRequest& Aws::ECS::Model::RegisterTaskDefinitionRequest::WithPidMode ( const PidMode value)
inline

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 using the Fargate launch type.

Definition at line 1345 of file RegisterTaskDefinitionRequest.h.

◆ WithPidMode() [2/2]

RegisterTaskDefinitionRequest& Aws::ECS::Model::RegisterTaskDefinitionRequest::WithPidMode ( PidMode &&  value)
inline

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 using the Fargate launch type.

Definition at line 1363 of file RegisterTaskDefinitionRequest.h.

◆ WithPlacementConstraints() [1/2]

RegisterTaskDefinitionRequest& Aws::ECS::Model::RegisterTaskDefinitionRequest::WithPlacementConstraints ( const Aws::Vector< TaskDefinitionPlacementConstraint > &  value)
inline

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

Definition at line 637 of file RegisterTaskDefinitionRequest.h.

◆ WithPlacementConstraints() [2/2]

RegisterTaskDefinitionRequest& Aws::ECS::Model::RegisterTaskDefinitionRequest::WithPlacementConstraints ( Aws::Vector< TaskDefinitionPlacementConstraint > &&  value)
inline

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

Definition at line 644 of file RegisterTaskDefinitionRequest.h.

◆ WithProxyConfiguration() [1/2]

RegisterTaskDefinitionRequest& Aws::ECS::Model::RegisterTaskDefinitionRequest::WithProxyConfiguration ( const ProxyConfiguration value)
inline

Definition at line 1566 of file RegisterTaskDefinitionRequest.h.

◆ WithProxyConfiguration() [2/2]

RegisterTaskDefinitionRequest& Aws::ECS::Model::RegisterTaskDefinitionRequest::WithProxyConfiguration ( ProxyConfiguration &&  value)
inline

Definition at line 1569 of file RegisterTaskDefinitionRequest.h.

◆ WithRequiresCompatibilities() [1/2]

RegisterTaskDefinitionRequest& Aws::ECS::Model::RegisterTaskDefinitionRequest::WithRequiresCompatibilities ( const Aws::Vector< Compatibility > &  value)
inline

The launch type required by the task. If no value is specified, it defaults to EC2.

Definition at line 689 of file RegisterTaskDefinitionRequest.h.

◆ WithRequiresCompatibilities() [2/2]

RegisterTaskDefinitionRequest& Aws::ECS::Model::RegisterTaskDefinitionRequest::WithRequiresCompatibilities ( Aws::Vector< Compatibility > &&  value)
inline

The launch type required by the task. If no value is specified, it defaults to EC2.

Definition at line 695 of file RegisterTaskDefinitionRequest.h.

◆ WithTags() [1/2]

RegisterTaskDefinitionRequest& Aws::ECS::Model::RegisterTaskDefinitionRequest::WithTags ( const Aws::Vector< Tag > &  value)
inline

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

Definition at line 1194 of file RegisterTaskDefinitionRequest.h.

◆ WithTags() [2/2]

RegisterTaskDefinitionRequest& Aws::ECS::Model::RegisterTaskDefinitionRequest::WithTags ( Aws::Vector< Tag > &&  value)
inline

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

Definition at line 1214 of file RegisterTaskDefinitionRequest.h.

◆ WithTaskRoleArn() [1/3]

RegisterTaskDefinitionRequest& Aws::ECS::Model::RegisterTaskDefinitionRequest::WithTaskRoleArn ( const Aws::String value)
inline

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.

Definition at line 171 of file RegisterTaskDefinitionRequest.h.

◆ WithTaskRoleArn() [2/3]

RegisterTaskDefinitionRequest& Aws::ECS::Model::RegisterTaskDefinitionRequest::WithTaskRoleArn ( Aws::String &&  value)
inline

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.

Definition at line 181 of file RegisterTaskDefinitionRequest.h.

◆ WithTaskRoleArn() [3/3]

RegisterTaskDefinitionRequest& Aws::ECS::Model::RegisterTaskDefinitionRequest::WithTaskRoleArn ( const char *  value)
inline

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.

Definition at line 191 of file RegisterTaskDefinitionRequest.h.

◆ WithVolumes() [1/2]

RegisterTaskDefinitionRequest& Aws::ECS::Model::RegisterTaskDefinitionRequest::WithVolumes ( const Aws::Vector< Volume > &  value)
inline

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

Definition at line 583 of file RegisterTaskDefinitionRequest.h.

◆ WithVolumes() [2/2]

RegisterTaskDefinitionRequest& Aws::ECS::Model::RegisterTaskDefinitionRequest::WithVolumes ( Aws::Vector< Volume > &&  value)
inline

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

Definition at line 589 of file RegisterTaskDefinitionRequest.h.


The documentation for this class was generated from the following file: