/** * 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 #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.

The short name or full Amazon Resource Name (ARN) of the Identity and Access * Management role that grants containers in the task permission to call Amazon Web * Services APIs on your behalf. For more information, see Amazon * ECS Task Role in the Amazon Elastic Container Service Developer * Guide.

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 * to use 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 Amazon Web Services API calls on * your behalf. The task execution IAM role is required depending on the * requirements of your task. For more information, see Amazon * ECS task execution IAM role in the Amazon Elastic Container Service * Developer Guide.

*/ 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. If no network mode is specified, the default is * bridge.

For Amazon ECS tasks on Fargate, the * awsvpc network mode is required. For Amazon ECS tasks on Amazon EC2 * Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon * EC2 Windows instances, <default> or awsvpc can * be used. If the network mode is set to none, you cannot specify * port mappings in your container definitions, and the tasks containers do not * have external connectivity. The host and awsvpc * network modes offer the highest networking performance for containers because * they use the EC2 network stack instead of the virtualized network stack provided * by the bridge mode.

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

When using the host network mode, you should not run * containers using the root user (UID 0). It is considered best practice to use a * non-root user.

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

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

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

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

The Docker networking mode to use for the containers in the task. The valid * values are none, bridge, awsvpc, and * host. If no network mode is specified, the default is * bridge.

When using the host network mode, you should not run * containers using the root user (UID 0). It is considered best practice to use a * non-root user.

If the network mode is 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; } /** *

The Docker networking mode to use for the containers in the task. The valid * values are none, bridge, awsvpc, and * host. If no network mode is specified, the default is * bridge.

When using the host network mode, you should not run * containers using the root user (UID 0). It is considered best practice to use a * non-root user.

If the network mode is 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; } /** *

The Docker networking mode to use for the containers in the task. The valid * values are none, bridge, awsvpc, and * host. If no network mode is specified, the default is * bridge.

When using the host network mode, you should not run * containers using the root user (UID 0). It is considered best practice to use a * non-root user.

If the network mode is 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); } /** *

The Docker networking mode to use for the containers in the task. The valid * values are none, bridge, awsvpc, and * host. If no network mode is specified, the default is * bridge.

When using the host network mode, you should not run * containers using the root user (UID 0). It is considered best practice to use a * non-root user.

If the network mode is 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;} /** *

The Docker networking mode to use for the containers in the task. The valid * values are none, bridge, awsvpc, and * host. If no network mode is specified, the default is * bridge.

When using the host network mode, you should not run * containers using the root user (UID 0). It is considered best practice to use a * non-root user.

If the network mode is 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. This is even if you 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;} /** *

The list of data volume definitions for the task. For more information, see * Using * data volumes in tasks in the Amazon Elastic Container Service Developer * Guide.

The host and sourcePath * parameters aren't supported for tasks run on Fargate.

*/ inline const Aws::Vector& GetVolumes() const{ return m_volumes; } /** *

The list of data volume definitions for the task. For more information, see * Using * data volumes in tasks in the Amazon Elastic Container Service Developer * Guide.

The host and sourcePath * parameters aren't supported for tasks run on Fargate.

*/ inline bool VolumesHasBeenSet() const { return m_volumesHasBeenSet; } /** *

The list of data volume definitions for the task. For more information, see * Using * data volumes in tasks in the Amazon Elastic Container Service Developer * Guide.

The host and sourcePath * parameters aren't supported for tasks run on Fargate.

*/ inline void SetVolumes(const Aws::Vector& value) { m_volumesHasBeenSet = true; m_volumes = value; } /** *

The list of data volume definitions for the task. For more information, see * Using * data volumes in tasks in the Amazon Elastic Container Service Developer * Guide.

The host and sourcePath * parameters aren't supported for tasks run on Fargate.

*/ inline void SetVolumes(Aws::Vector&& value) { m_volumesHasBeenSet = true; m_volumes = std::move(value); } /** *

The list of data volume definitions for the task. For more information, see * Using * data volumes in tasks in the Amazon Elastic Container Service Developer * Guide.

The host and sourcePath * parameters aren't supported for tasks run on Fargate.

*/ inline TaskDefinition& WithVolumes(const Aws::Vector& value) { SetVolumes(value); return *this;} /** *

The list of data volume definitions for the task. For more information, see * Using * data volumes in tasks in the Amazon Elastic Container Service Developer * Guide.

The host and sourcePath * parameters aren't supported for tasks run on Fargate.

*/ inline TaskDefinition& WithVolumes(Aws::Vector&& value) { SetVolumes(std::move(value)); return *this;} /** *

The list of data volume definitions for the task. For more information, see * Using * data volumes in tasks in the Amazon Elastic Container Service Developer * Guide.

The host and sourcePath * parameters aren't supported for tasks run on Fargate.

*/ inline TaskDefinition& AddVolumes(const Volume& value) { m_volumesHasBeenSet = true; m_volumes.push_back(value); return *this; } /** *

The list of data volume definitions for the task. For more information, see * Using * data volumes in tasks in the Amazon Elastic Container Service Developer * Guide.

The host and sourcePath * parameters aren't supported for tasks run on Fargate.

*/ inline TaskDefinition& AddVolumes(Volume&& value) { m_volumesHasBeenSet = true; m_volumes.push_back(std::move(value)); return *this; } /** *

The status of the task definition.

*/ inline const TaskDefinitionStatus& GetStatus() const{ return m_status; } /** *

The status of the task definition.

*/ inline bool StatusHasBeenSet() const { return m_statusHasBeenSet; } /** *

The status of the task definition.

*/ inline void SetStatus(const TaskDefinitionStatus& value) { m_statusHasBeenSet = true; m_status = value; } /** *

The status of the task definition.

*/ inline void SetStatus(TaskDefinitionStatus&& value) { m_statusHasBeenSet = true; m_status = std::move(value); } /** *

The status of the task definition.

*/ inline TaskDefinition& WithStatus(const TaskDefinitionStatus& value) { SetStatus(value); return *this;} /** *

The status of the task definition.

*/ inline TaskDefinition& WithStatus(TaskDefinitionStatus&& value) { SetStatus(std::move(value)); return *this;} /** *

The container instance attributes required by your task. When an Amazon EC2 * instance is registered to your cluster, the Amazon ECS container agent assigns * some standard attributes to the instance. You can apply custom attributes. These * are specified as key-value pairs using the Amazon ECS console or the * PutAttributes API. These attributes are used when determining task * placement for tasks hosted on Amazon EC2 instances. For more information, see Attributes * in the Amazon Elastic Container Service Developer Guide.

This parameter isn't supported for tasks run on Fargate.

*/ inline const Aws::Vector& GetRequiresAttributes() const{ return m_requiresAttributes; } /** *

This parameter isn't supported for tasks run on Fargate.

*/ inline bool RequiresAttributesHasBeenSet() const { return m_requiresAttributesHasBeenSet; } /** *

This parameter isn't supported for tasks run on Fargate.

*/ inline void SetRequiresAttributes(const Aws::Vector& value) { m_requiresAttributesHasBeenSet = true; m_requiresAttributes = value; } /** *

This parameter isn't supported for tasks run on Fargate.

*/ inline void SetRequiresAttributes(Aws::Vector&& value) { m_requiresAttributesHasBeenSet = true; m_requiresAttributes = std::move(value); } /** *

This parameter isn't supported for tasks run on Fargate.

*/ inline TaskDefinition& WithRequiresAttributes(const Aws::Vector& value) { SetRequiresAttributes(value); return *this;} /** *

This parameter isn't supported for tasks run on Fargate.

*/ inline TaskDefinition& WithRequiresAttributes(Aws::Vector&& value) { SetRequiresAttributes(std::move(value)); return *this;} /** *

This parameter isn't supported for tasks run on Fargate.

*/ inline TaskDefinition& AddRequiresAttributes(const Attribute& value) { m_requiresAttributesHasBeenSet = true; m_requiresAttributes.push_back(value); return *this; } /** *

This parameter isn't supported for tasks run on Fargate.

*/ inline TaskDefinition& AddRequiresAttributes(Attribute&& value) { m_requiresAttributesHasBeenSet = true; m_requiresAttributes.push_back(std::move(value)); return *this; } /** *

An array of placement constraint objects to use for tasks.

This * parameter isn't supported for tasks run on Fargate.

*/ inline const Aws::Vector& GetPlacementConstraints() const{ return m_placementConstraints; } /** *

An array of placement constraint objects to use for tasks.

This * parameter isn't supported for tasks run on Fargate.

*/ inline bool PlacementConstraintsHasBeenSet() const { return m_placementConstraintsHasBeenSet; } /** *

An array of placement constraint objects to use for tasks.

This * parameter isn't supported for tasks run on Fargate.

*/ inline void SetPlacementConstraints(const Aws::Vector& value) { m_placementConstraintsHasBeenSet = true; m_placementConstraints = value; } /** *

An array of placement constraint objects to use for tasks.

This * parameter isn't supported for tasks run on Fargate.

*/ inline void SetPlacementConstraints(Aws::Vector&& value) { m_placementConstraintsHasBeenSet = true; m_placementConstraints = std::move(value); } /** *

An array of placement constraint objects to use for tasks.

This * parameter isn't supported for tasks run on Fargate.

*/ inline TaskDefinition& WithPlacementConstraints(const Aws::Vector& value) { SetPlacementConstraints(value); return *this;} /** *

An array of placement constraint objects to use for tasks.

This * parameter isn't supported for tasks run on Fargate.

*/ inline TaskDefinition& WithPlacementConstraints(Aws::Vector&& value) { SetPlacementConstraints(std::move(value)); return *this;} /** *

An array of placement constraint objects to use for tasks.

This * parameter isn't supported for tasks run on Fargate.

*/ inline TaskDefinition& AddPlacementConstraints(const TaskDefinitionPlacementConstraint& value) { m_placementConstraintsHasBeenSet = true; m_placementConstraints.push_back(value); return *this; } /** *

An array of placement constraint objects to use for tasks.

This * parameter isn't supported for tasks run on Fargate.

*/ inline TaskDefinition& AddPlacementConstraints(TaskDefinitionPlacementConstraint&& value) { m_placementConstraintsHasBeenSet = true; m_placementConstraints.push_back(std::move(value)); return *this; } /** *

The task launch types the task definition validated against during task * definition registration. For more information, see Amazon * ECS launch types in the Amazon Elastic Container Service Developer * Guide.

*/ inline const Aws::Vector& GetCompatibilities() const{ return m_compatibilities; } /** *

*/ inline bool CompatibilitiesHasBeenSet() const { return m_compatibilitiesHasBeenSet; } /** *

*/ inline void SetCompatibilities(const Aws::Vector& value) { m_compatibilitiesHasBeenSet = true; m_compatibilities = value; } /** *

*/ inline void SetCompatibilities(Aws::Vector&& value) { m_compatibilitiesHasBeenSet = true; m_compatibilities = std::move(value); } /** *

*/ inline TaskDefinition& WithCompatibilities(const Aws::Vector& value) { SetCompatibilities(value); return *this;} /** *

*/ inline TaskDefinition& WithCompatibilities(Aws::Vector&& value) { SetCompatibilities(std::move(value)); return *this;} /** *

*/ inline TaskDefinition& AddCompatibilities(const Compatibility& value) { m_compatibilitiesHasBeenSet = true; m_compatibilities.push_back(value); return *this; } /** *

*/ inline TaskDefinition& AddCompatibilities(Compatibility&& value) { m_compatibilitiesHasBeenSet = true; m_compatibilities.push_back(std::move(value)); return *this; } /** *

The operating system that your task definitions are running on. A platform * family is specified only for tasks using the Fargate launch type.

When * you specify a task in a service, this value must match the * runtimePlatform value of the service.

*/ inline const RuntimePlatform& GetRuntimePlatform() const{ return m_runtimePlatform; } /** *

The operating system that your task definitions are running on. A platform * family is specified only for tasks using the Fargate launch type.

When * you specify a task in a service, this value must match the * runtimePlatform value of the service.

*/ inline bool RuntimePlatformHasBeenSet() const { return m_runtimePlatformHasBeenSet; } /** *

The operating system that your task definitions are running on. A platform * family is specified only for tasks using the Fargate launch type.

When * you specify a task in a service, this value must match the * runtimePlatform value of the service.

*/ inline void SetRuntimePlatform(const RuntimePlatform& value) { m_runtimePlatformHasBeenSet = true; m_runtimePlatform = value; } /** *

The operating system that your task definitions are running on. A platform * family is specified only for tasks using the Fargate launch type.

When * you specify a task in a service, this value must match the * runtimePlatform value of the service.

*/ inline void SetRuntimePlatform(RuntimePlatform&& value) { m_runtimePlatformHasBeenSet = true; m_runtimePlatform = std::move(value); } /** *

The operating system that your task definitions are running on. A platform * family is specified only for tasks using the Fargate launch type.

When * you specify a task in a service, this value must match the * runtimePlatform value of the service.

*/ inline TaskDefinition& WithRuntimePlatform(const RuntimePlatform& value) { SetRuntimePlatform(value); return *this;} /** *

The operating system that your task definitions are running on. A platform * family is specified only for tasks using the Fargate launch type.

When * you specify a task in a service, this value must match the * runtimePlatform value of the service.

*/ inline TaskDefinition& WithRuntimePlatform(RuntimePlatform&& value) { SetRuntimePlatform(std::move(value)); return *this;} /** *