/** * 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 namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace Batch { namespace Model { /** *

Container properties are used for Amazon ECS based job definitions. These * properties to describe the container that's launched as part of a * job.

The image used to start a container. This string is passed directly to the * Docker daemon. Images in the Docker Hub registry are available by default. Other * repositories are specified with * repository-url/image:tag. It can be 255 characters * long. It can contain uppercase and lowercase letters, numbers, hyphens (-), * underscores (_), colons (:), periods (.), forward slashes (/), and number signs * (#). This parameter maps to Image in the Create a * container section of the Docker Remote API and the * IMAGE parameter of docker run.

Docker image architecture must match the processor architecture of the * compute resources that they're scheduled on. For example, ARM-based Docker * images can only run on ARM-based compute resources.

*
Images in Amazon ECR Public repositories use the full * registry/repository[:tag] or * registry/repository[@digest] naming conventions. For example, * public.ecr.aws/registry_alias/my-web-app:latest *.
Images in Amazon ECR repositories use the full * registry and repository URI (for example, * 123456789012.dkr.ecr.<region-name>.amazonaws.com/<repository-name>).
*
Images in official repositories on Docker Hub use a single name * (for example, ubuntu or mongo).
*
Images in other repositories on Docker Hub are qualified with an organization * name (for example, amazon/amazon-ecs-agent).
*
Images in other online repositories are qualified further by a domain name * (for example, quay.io/assemblyline/ubuntu).

*/ inline const Aws::String& GetImage() const{ return m_image; } /** *

*
Images in Amazon ECR Public repositories use the full * registry/repository[:tag] or * registry/repository[@digest] naming conventions. For example, * public.ecr.aws/registry_alias/my-web-app:latest *.
Images in Amazon ECR repositories use the full * registry and repository URI (for example, * 123456789012.dkr.ecr.<region-name>.amazonaws.com/<repository-name>).
*
Images in official repositories on Docker Hub use a single name * (for example, ubuntu or mongo).
*
Images in other repositories on Docker Hub are qualified with an organization * name (for example, amazon/amazon-ecs-agent).
*
Images in other online repositories are qualified further by a domain name * (for example, quay.io/assemblyline/ubuntu).

*/ inline bool ImageHasBeenSet() const { return m_imageHasBeenSet; } /** *

*
Images in Amazon ECR Public repositories use the full * registry/repository[:tag] or * registry/repository[@digest] naming conventions. For example, * public.ecr.aws/registry_alias/my-web-app:latest *.
Images in Amazon ECR repositories use the full * registry and repository URI (for example, * 123456789012.dkr.ecr.<region-name>.amazonaws.com/<repository-name>).
*
Images in official repositories on Docker Hub use a single name * (for example, ubuntu or mongo).
*
Images in other repositories on Docker Hub are qualified with an organization * name (for example, amazon/amazon-ecs-agent).
*
Images in other online repositories are qualified further by a domain name * (for example, quay.io/assemblyline/ubuntu).

*/ inline void SetImage(const Aws::String& value) { m_imageHasBeenSet = true; m_image = value; } /** *

*
Images in Amazon ECR Public repositories use the full * registry/repository[:tag] or * registry/repository[@digest] naming conventions. For example, * public.ecr.aws/registry_alias/my-web-app:latest *.
Images in Amazon ECR repositories use the full * registry and repository URI (for example, * 123456789012.dkr.ecr.<region-name>.amazonaws.com/<repository-name>).
*
Images in official repositories on Docker Hub use a single name * (for example, ubuntu or mongo).
*
Images in other repositories on Docker Hub are qualified with an organization * name (for example, amazon/amazon-ecs-agent).
*
Images in other online repositories are qualified further by a domain name * (for example, quay.io/assemblyline/ubuntu).

*/ inline void SetImage(Aws::String&& value) { m_imageHasBeenSet = true; m_image = std::move(value); } /** *

*
Images in Amazon ECR Public repositories use the full * registry/repository[:tag] or * registry/repository[@digest] naming conventions. For example, * public.ecr.aws/registry_alias/my-web-app:latest *.
Images in Amazon ECR repositories use the full * registry and repository URI (for example, * 123456789012.dkr.ecr.<region-name>.amazonaws.com/<repository-name>).
*
Images in official repositories on Docker Hub use a single name * (for example, ubuntu or mongo).
*
Images in other repositories on Docker Hub are qualified with an organization * name (for example, amazon/amazon-ecs-agent).
*
Images in other online repositories are qualified further by a domain name * (for example, quay.io/assemblyline/ubuntu).

*/ inline void SetImage(const char* value) { m_imageHasBeenSet = true; m_image.assign(value); } /** *

*
Images in Amazon ECR Public repositories use the full * registry/repository[:tag] or * registry/repository[@digest] naming conventions. For example, * public.ecr.aws/registry_alias/my-web-app:latest *.
Images in Amazon ECR repositories use the full * registry and repository URI (for example, * 123456789012.dkr.ecr.<region-name>.amazonaws.com/<repository-name>).
*
Images in official repositories on Docker Hub use a single name * (for example, ubuntu or mongo).
*
Images in other repositories on Docker Hub are qualified with an organization * name (for example, amazon/amazon-ecs-agent).
*
Images in other online repositories are qualified further by a domain name * (for example, quay.io/assemblyline/ubuntu).

*/ inline ContainerProperties& WithImage(const Aws::String& value) { SetImage(value); return *this;} /** *

*
Images in Amazon ECR Public repositories use the full * registry/repository[:tag] or * registry/repository[@digest] naming conventions. For example, * public.ecr.aws/registry_alias/my-web-app:latest *.
Images in Amazon ECR repositories use the full * registry and repository URI (for example, * 123456789012.dkr.ecr.<region-name>.amazonaws.com/<repository-name>).
*
Images in official repositories on Docker Hub use a single name * (for example, ubuntu or mongo).
*
Images in other repositories on Docker Hub are qualified with an organization * name (for example, amazon/amazon-ecs-agent).
*
Images in other online repositories are qualified further by a domain name * (for example, quay.io/assemblyline/ubuntu).

*/ inline ContainerProperties& WithImage(Aws::String&& value) { SetImage(std::move(value)); return *this;} /** *

*
Images in Amazon ECR Public repositories use the full * registry/repository[:tag] or * registry/repository[@digest] naming conventions. For example, * public.ecr.aws/registry_alias/my-web-app:latest *.
Images in Amazon ECR repositories use the full * registry and repository URI (for example, * 123456789012.dkr.ecr.<region-name>.amazonaws.com/<repository-name>).
*
Images in official repositories on Docker Hub use a single name * (for example, ubuntu or mongo).
*
Images in other repositories on Docker Hub are qualified with an organization * name (for example, amazon/amazon-ecs-agent).
*
Images in other online repositories are qualified further by a domain name * (for example, quay.io/assemblyline/ubuntu).

*/ inline ContainerProperties& WithImage(const char* value) { SetImage(value); return *this;} /** *

The command that's passed to the container. This parameter maps to * Cmd in the Create a * container section of the Docker Remote API and the * COMMAND parameter to docker run. For more * information, see https://docs.docker.com/engine/reference/builder/#cmd.

*/ inline const Aws::Vector& GetCommand() const{ return m_command; } /** *

*/ inline bool CommandHasBeenSet() const { return m_commandHasBeenSet; } /** *

*/ inline void SetCommand(const Aws::Vector& value) { m_commandHasBeenSet = true; m_command = value; } /** *

*/ inline void SetCommand(Aws::Vector&& value) { m_commandHasBeenSet = true; m_command = std::move(value); } /** *

*/ inline ContainerProperties& WithCommand(const Aws::Vector& value) { SetCommand(value); return *this;} /** *

*/ inline ContainerProperties& WithCommand(Aws::Vector&& value) { SetCommand(std::move(value)); return *this;} /** *

*/ inline ContainerProperties& AddCommand(const Aws::String& value) { m_commandHasBeenSet = true; m_command.push_back(value); return *this; } /** *

*/ inline ContainerProperties& AddCommand(Aws::String&& value) { m_commandHasBeenSet = true; m_command.push_back(std::move(value)); return *this; } /** *

*/ inline ContainerProperties& AddCommand(const char* value) { m_commandHasBeenSet = true; m_command.push_back(value); return *this; } /** *

The Amazon Resource Name (ARN) of the IAM role that the container can assume * for Amazon Web Services permissions. For more information, see IAM * roles for tasks in the Amazon Elastic Container Service Developer * Guide.

*/ inline const Aws::String& GetJobRoleArn() const{ return m_jobRoleArn; } /** *

*/ inline bool JobRoleArnHasBeenSet() const { return m_jobRoleArnHasBeenSet; } /** *

*/ inline void SetJobRoleArn(const Aws::String& value) { m_jobRoleArnHasBeenSet = true; m_jobRoleArn = value; } /** *

*/ inline void SetJobRoleArn(Aws::String&& value) { m_jobRoleArnHasBeenSet = true; m_jobRoleArn = std::move(value); } /** *

*/ inline void SetJobRoleArn(const char* value) { m_jobRoleArnHasBeenSet = true; m_jobRoleArn.assign(value); } /** *

*/ inline ContainerProperties& WithJobRoleArn(const Aws::String& value) { SetJobRoleArn(value); return *this;} /** *

*/ inline ContainerProperties& WithJobRoleArn(Aws::String&& value) { SetJobRoleArn(std::move(value)); return *this;} /** *

*/ inline ContainerProperties& WithJobRoleArn(const char* value) { SetJobRoleArn(value); return *this;} /** *

The Amazon Resource Name (ARN) of the execution role that Batch can assume. * For jobs that run on Fargate resources, you must provide an execution role. For * more information, see Batch * execution IAM role in the Batch User 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 ContainerProperties& WithExecutionRoleArn(const Aws::String& value) { SetExecutionRoleArn(value); return *this;} /** *

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

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

A list of data volumes used in a job.

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

A list of data volumes used in a job.

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

A list of data volumes used in a job.

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

A list of data volumes used in a job.

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

A list of data volumes used in a job.

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

A list of data volumes used in a job.

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

A list of data volumes used in a job.

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

A list of data volumes used in a job.

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

The environment variables to pass to a container. This parameter maps to * Env in the Create a * container section of the Docker Remote API and the * --env option to docker run.

We don't recommend using plaintext environment variables for * sensitive information, such as credential data.

Environment variables cannot start with "AWS_BATCH". This naming * convention is reserved for variables that Batch sets.

*/ inline const Aws::Vector& GetEnvironment() const{ return m_environment; } /** *

The environment variables to pass to a container. This parameter maps to * Env in the Create a * container section of the Docker Remote API and the * --env option to docker run.

We don't recommend using plaintext environment variables for * sensitive information, such as credential data.

Environment variables cannot start with "AWS_BATCH". This naming * convention is reserved for variables that Batch sets.

*/ inline bool EnvironmentHasBeenSet() const { return m_environmentHasBeenSet; } /** *

The environment variables to pass to a container. This parameter maps to * Env in the Create a * container section of the Docker Remote API and the * --env option to docker run.

We don't recommend using plaintext environment variables for * sensitive information, such as credential data.

Environment variables cannot start with "AWS_BATCH". This naming * convention is reserved for variables that Batch sets.

*/ inline void SetEnvironment(const Aws::Vector& value) { m_environmentHasBeenSet = true; m_environment = value; } /** *

The environment variables to pass to a container. This parameter maps to * Env in the Create a * container section of the Docker Remote API and the * --env option to docker run.

We don't recommend using plaintext environment variables for * sensitive information, such as credential data.

Environment variables cannot start with "AWS_BATCH". This naming * convention is reserved for variables that Batch sets.

*/ inline void SetEnvironment(Aws::Vector&& value) { m_environmentHasBeenSet = true; m_environment = std::move(value); } /** *

The environment variables to pass to a container. This parameter maps to * Env in the Create a * container section of the Docker Remote API and the * --env option to docker run.

We don't recommend using plaintext environment variables for * sensitive information, such as credential data.

Environment variables cannot start with "AWS_BATCH". This naming * convention is reserved for variables that Batch sets.

*/ inline ContainerProperties& WithEnvironment(const Aws::Vector& value) { SetEnvironment(value); return *this;} /** *

The environment variables to pass to a container. This parameter maps to * Env in the Create a * container section of the Docker Remote API and the * --env option to docker run.

We don't recommend using plaintext environment variables for * sensitive information, such as credential data.

Environment variables cannot start with "AWS_BATCH". This naming * convention is reserved for variables that Batch sets.

*/ inline ContainerProperties& WithEnvironment(Aws::Vector&& value) { SetEnvironment(std::move(value)); return *this;} /** *

The environment variables to pass to a container. This parameter maps to * Env in the Create a * container section of the Docker Remote API and the * --env option to docker run.

We don't recommend using plaintext environment variables for * sensitive information, such as credential data.

Environment variables cannot start with "AWS_BATCH". This naming * convention is reserved for variables that Batch sets.

*/ inline ContainerProperties& AddEnvironment(const KeyValuePair& value) { m_environmentHasBeenSet = true; m_environment.push_back(value); return *this; } /** *

The environment variables to pass to a container. This parameter maps to * Env in the Create a * container section of the Docker Remote API and the * --env option to docker run.

We don't recommend using plaintext environment variables for * sensitive information, such as credential data.

Environment variables cannot start with "AWS_BATCH". This naming * convention is reserved for variables that Batch sets.

*/ inline ContainerProperties& AddEnvironment(KeyValuePair&& value) { m_environmentHasBeenSet = true; m_environment.push_back(std::move(value)); return *this; } /** *

The mount points for data volumes in your container. This parameter maps to * Volumes in the Create a * container section of the Docker Remote API and the * --volume option to docker run.

*/ inline const Aws::Vector& GetMountPoints() const{ return m_mountPoints; } /** *

The mount points for data volumes in your container. This parameter maps to * Volumes in the Create a * container section of the Docker Remote API and the * --volume option to docker run.

*/ inline bool MountPointsHasBeenSet() const { return m_mountPointsHasBeenSet; } /** *

The mount points for data volumes in your container. This parameter maps to * Volumes in the Create a * container section of the Docker Remote API and the * --volume option to docker run.

*/ inline void SetMountPoints(const Aws::Vector& value) { m_mountPointsHasBeenSet = true; m_mountPoints = value; } /** *

The mount points for data volumes in your container. This parameter maps to * Volumes in the Create a * container section of the Docker Remote API and the * --volume option to docker run.

*/ inline void SetMountPoints(Aws::Vector&& value) { m_mountPointsHasBeenSet = true; m_mountPoints = std::move(value); } /** *

The mount points for data volumes in your container. This parameter maps to * Volumes in the Create a * container section of the Docker Remote API and the * --volume option to docker run.

*/ inline ContainerProperties& WithMountPoints(const Aws::Vector& value) { SetMountPoints(value); return *this;} /** *

The mount points for data volumes in your container. This parameter maps to * Volumes in the Create a * container section of the Docker Remote API and the * --volume option to docker run.

*/ inline ContainerProperties& WithMountPoints(Aws::Vector&& value) { SetMountPoints(std::move(value)); return *this;} /** *

The mount points for data volumes in your container. This parameter maps to * Volumes in the Create a * container section of the Docker Remote API and the * --volume option to docker run.

*/ inline ContainerProperties& AddMountPoints(const MountPoint& value) { m_mountPointsHasBeenSet = true; m_mountPoints.push_back(value); return *this; } /** *

The mount points for data volumes in your container. This parameter maps to * Volumes in the Create a * container section of the Docker Remote API and the * --volume option to docker run.

*/ inline ContainerProperties& AddMountPoints(MountPoint&& value) { m_mountPointsHasBeenSet = true; m_mountPoints.push_back(std::move(value)); return *this; } /** *

When this parameter is true, the container is given read-only access to its * root file system. This parameter maps to ReadonlyRootfs in the Create a * container section of the Docker Remote API and the * --read-only option to docker run.

*/ inline bool GetReadonlyRootFilesystem() const{ return m_readonlyRootFilesystem; } /** *

*/ inline bool ReadonlyRootFilesystemHasBeenSet() const { return m_readonlyRootFilesystemHasBeenSet; } /** *

*/ inline void SetReadonlyRootFilesystem(bool value) { m_readonlyRootFilesystemHasBeenSet = true; m_readonlyRootFilesystem = value; } /** *

*/ inline ContainerProperties& WithReadonlyRootFilesystem(bool value) { SetReadonlyRootFilesystem(value); return *this;} /** *

When this parameter is true, the container is given elevated permissions on * the host container instance (similar to the root user). This * parameter maps to Privileged in the Create a * container section of the Docker Remote API and the * --privileged option to docker run. The default * value is false.

This parameter isn't applicable to jobs that are * running on Fargate resources and shouldn't be provided, or specified as * false.

*/ inline bool GetPrivileged() const{ return m_privileged; } /** *

This parameter isn't applicable to jobs that are * running on Fargate resources and shouldn't be provided, or specified as * false.

*/ inline bool PrivilegedHasBeenSet() const { return m_privilegedHasBeenSet; } /** *

This parameter isn't applicable to jobs that are * running on Fargate resources and shouldn't be provided, or specified as * false.

*/ inline void SetPrivileged(bool value) { m_privilegedHasBeenSet = true; m_privileged = value; } /** *

This parameter isn't applicable to jobs that are * running on Fargate resources and shouldn't be provided, or specified as * false.

*/ inline ContainerProperties& WithPrivileged(bool value) { SetPrivileged(value); return *this;} /** *

A list of ulimits to set in the container. This parameter maps * to Ulimits in the Create a * container section of the Docker Remote API and the * --ulimit option to docker run.

This parameter isn't applicable to jobs that are running on Fargate resources * and shouldn't be provided.

*/ inline const Aws::Vector& GetUlimits() const{ return m_ulimits; } /** *

A list of ulimits to set in the container. This parameter maps * to Ulimits in the Create a * container section of the Docker Remote API and the * --ulimit option to docker run.

This parameter isn't applicable to jobs that are running on Fargate resources * and shouldn't be provided.

*/ inline bool UlimitsHasBeenSet() const { return m_ulimitsHasBeenSet; } /** *

A list of ulimits to set in the container. This parameter maps * to Ulimits in the Create a * container section of the Docker Remote API and the * --ulimit option to docker run.

This parameter isn't applicable to jobs that are running on Fargate resources * and shouldn't be provided.

*/ inline void SetUlimits(const Aws::Vector& value) { m_ulimitsHasBeenSet = true; m_ulimits = value; } /** *

A list of ulimits to set in the container. This parameter maps * to Ulimits in the Create a * container section of the Docker Remote API and the * --ulimit option to docker run.

This parameter isn't applicable to jobs that are running on Fargate resources * and shouldn't be provided.

*/ inline void SetUlimits(Aws::Vector&& value) { m_ulimitsHasBeenSet = true; m_ulimits = std::move(value); } /** *

A list of ulimits to set in the container. This parameter maps * to Ulimits in the Create a * container section of the Docker Remote API and the * --ulimit option to docker run.

This parameter isn't applicable to jobs that are running on Fargate resources * and shouldn't be provided.

*/ inline ContainerProperties& WithUlimits(const Aws::Vector& value) { SetUlimits(value); return *this;} /** *

A list of ulimits to set in the container. This parameter maps * to Ulimits in the Create a * container section of the Docker Remote API and the * --ulimit option to docker run.

This parameter isn't applicable to jobs that are running on Fargate resources * and shouldn't be provided.

*/ inline ContainerProperties& WithUlimits(Aws::Vector&& value) { SetUlimits(std::move(value)); return *this;} /** *

A list of ulimits to set in the container. This parameter maps * to Ulimits in the Create a * container section of the Docker Remote API and the * --ulimit option to docker run.

This parameter isn't applicable to jobs that are running on Fargate resources * and shouldn't be provided.

*/ inline ContainerProperties& AddUlimits(const Ulimit& value) { m_ulimitsHasBeenSet = true; m_ulimits.push_back(value); return *this; } /** *

A list of ulimits to set in the container. This parameter maps * to Ulimits in the Create a * container section of the Docker Remote API and the * --ulimit option to docker run.

This parameter isn't applicable to jobs that are running on Fargate resources * and shouldn't be provided.

*/ inline ContainerProperties& AddUlimits(Ulimit&& value) { m_ulimitsHasBeenSet = true; m_ulimits.push_back(std::move(value)); return *this; } /** *

The user name to use inside the container. This parameter maps to * User in the Create a * container section of the Docker Remote API and the * --user option to docker run.

*/ inline const Aws::String& GetUser() const{ return m_user; } /** *

The user name to use inside the container. This parameter maps to * User in the Create a * container section of the Docker Remote API and the * --user option to docker run.

*/ inline bool UserHasBeenSet() const { return m_userHasBeenSet; } /** *

The user name to use inside the container. This parameter maps to * User in the Create a * container section of the Docker Remote API and the * --user option to docker run.

*/ inline void SetUser(const Aws::String& value) { m_userHasBeenSet = true; m_user = value; } /** *

The user name to use inside the container. This parameter maps to * User in the Create a * container section of the Docker Remote API and the * --user option to docker run.

*/ inline void SetUser(Aws::String&& value) { m_userHasBeenSet = true; m_user = std::move(value); } /** *

The user name to use inside the container. This parameter maps to * User in the Create a * container section of the Docker Remote API and the * --user option to docker run.

*/ inline void SetUser(const char* value) { m_userHasBeenSet = true; m_user.assign(value); } /** *

The user name to use inside the container. This parameter maps to * User in the Create a * container section of the Docker Remote API and the * --user option to docker run.

*/ inline ContainerProperties& WithUser(const Aws::String& value) { SetUser(value); return *this;} /** *

The user name to use inside the container. This parameter maps to * User in the Create a * container section of the Docker Remote API and the * --user option to docker run.

*/ inline ContainerProperties& WithUser(Aws::String&& value) { SetUser(std::move(value)); return *this;} /** *

The user name to use inside the container. This parameter maps to * User in the Create a * container section of the Docker Remote API and the * --user option to docker run.

*/ inline ContainerProperties& WithUser(const char* value) { SetUser(value); return *this;} /** *