/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace ECS { namespace Model { /** *

The details of a task definition which describes the container and volume * definitions of an Amazon Elastic Container Service task. You can specify which * Docker images to use, the required resources, and other configurations related * to launching the task definition through an Amazon ECS service or * task.

IAM roles for tasks on Windows require that the * -EnableTaskIAMRole option is set when you launch the Amazon * ECS-optimized Windows AMI. Your containers must also run some configuration code * in order to take advantage of the feature. For more information, see Windows * IAM Roles for Tasks in the Amazon Elastic Container Service Developer * Guide.

*/ inline const Aws::String& GetTaskRoleArn() const{ return m_taskRoleArn; } /** *

*/ inline bool TaskRoleArnHasBeenSet() const { return m_taskRoleArnHasBeenSet; } /** *

*/ inline void SetTaskRoleArn(const Aws::String& value) { m_taskRoleArnHasBeenSet = true; m_taskRoleArn = value; } /** *

*/ inline void SetTaskRoleArn(Aws::String&& value) { m_taskRoleArnHasBeenSet = true; m_taskRoleArn = std::move(value); } /** *

*/ inline void SetTaskRoleArn(const char* value) { m_taskRoleArnHasBeenSet = true; m_taskRoleArn.assign(value); } /** *

*/ inline TaskDefinition& WithTaskRoleArn(const Aws::String& value) { SetTaskRoleArn(value); return *this;} /** *

*/ inline TaskDefinition& WithTaskRoleArn(Aws::String&& value) { SetTaskRoleArn(std::move(value)); return *this;} /** *

*/ inline TaskDefinition& WithTaskRoleArn(const char* value) { SetTaskRoleArn(value); return *this;} /** *

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.

*/ inline const Aws::String& GetExecutionRoleArn() const{ return m_executionRoleArn; } /** *

*/ inline bool ExecutionRoleArnHasBeenSet() const { return m_executionRoleArnHasBeenSet; } /** *

*/ inline void SetExecutionRoleArn(const Aws::String& value) { m_executionRoleArnHasBeenSet = true; m_executionRoleArn = value; } /** *

*/ inline void SetExecutionRoleArn(Aws::String&& value) { m_executionRoleArnHasBeenSet = true; m_executionRoleArn = std::move(value); } /** *

*/ inline void SetExecutionRoleArn(const char* value) { m_executionRoleArnHasBeenSet = true; m_executionRoleArn.assign(value); } /** *

*/ inline TaskDefinition& WithExecutionRoleArn(const Aws::String& value) { SetExecutionRoleArn(value); return *this;} /** *

*/ inline TaskDefinition& WithExecutionRoleArn(Aws::String&& value) { SetExecutionRoleArn(std::move(value)); return *this;} /** *

*/ inline TaskDefinition& WithExecutionRoleArn(const char* value) { SetExecutionRoleArn(value); return *this;} /** *

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.

*/ inline const NetworkMode& GetNetworkMode() const{ return m_networkMode; } /** *

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.

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

*/ inline bool NetworkModeHasBeenSet() const { return m_networkModeHasBeenSet; } /** *

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.

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

*/ inline void SetNetworkMode(const NetworkMode& value) { m_networkModeHasBeenSet = true; m_networkMode = value; } /** *

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.

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

*/ inline void SetNetworkMode(NetworkMode&& value) { m_networkModeHasBeenSet = true; m_networkMode = std::move(value); } /** *

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.

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

*/ inline TaskDefinition& WithNetworkMode(const NetworkMode& value) { SetNetworkMode(value); return *this;} /** *

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.

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

*/ inline TaskDefinition& WithNetworkMode(NetworkMode&& value) { SetNetworkMode(std::move(value)); return *this;} /** *

The revision of the task in a particular family. The revision is a version * number of a task definition in a family. When you register a task definition for * the first time, the revision is 1. Each time that you register a * new revision of a task definition in the same family, the revision value always * increases by one, even if you have deregistered previous revisions in this * family.

*/ inline int GetRevision() const{ return m_revision; } /** *

*/ inline bool RevisionHasBeenSet() const { return m_revisionHasBeenSet; } /** *

*/ inline void SetRevision(int value) { m_revisionHasBeenSet = true; m_revision = value; } /** *

*/ inline TaskDefinition& WithRevision(int value) { SetRevision(value); return *this;} /** *