Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data ContainerProperties = ContainerProperties' {
- command :: Maybe [Text]
- environment :: Maybe [KeyValuePair]
- executionRoleArn :: Maybe Text
- fargatePlatformConfiguration :: Maybe FargatePlatformConfiguration
- image :: Maybe Text
- instanceType :: Maybe Text
- jobRoleArn :: Maybe Text
- linuxParameters :: Maybe LinuxParameters
- logConfiguration :: Maybe LogConfiguration
- memory :: Maybe Int
- mountPoints :: Maybe [MountPoint]
- networkConfiguration :: Maybe NetworkConfiguration
- privileged :: Maybe Bool
- readonlyRootFilesystem :: Maybe Bool
- resourceRequirements :: Maybe [ResourceRequirement]
- secrets :: Maybe [Secret]
- ulimits :: Maybe [Ulimit]
- user :: Maybe Text
- vcpus :: Maybe Int
- volumes :: Maybe [Volume]
- newContainerProperties :: ContainerProperties
- containerProperties_command :: Lens' ContainerProperties (Maybe [Text])
- containerProperties_environment :: Lens' ContainerProperties (Maybe [KeyValuePair])
- containerProperties_executionRoleArn :: Lens' ContainerProperties (Maybe Text)
- containerProperties_fargatePlatformConfiguration :: Lens' ContainerProperties (Maybe FargatePlatformConfiguration)
- containerProperties_image :: Lens' ContainerProperties (Maybe Text)
- containerProperties_instanceType :: Lens' ContainerProperties (Maybe Text)
- containerProperties_jobRoleArn :: Lens' ContainerProperties (Maybe Text)
- containerProperties_linuxParameters :: Lens' ContainerProperties (Maybe LinuxParameters)
- containerProperties_logConfiguration :: Lens' ContainerProperties (Maybe LogConfiguration)
- containerProperties_memory :: Lens' ContainerProperties (Maybe Int)
- containerProperties_mountPoints :: Lens' ContainerProperties (Maybe [MountPoint])
- containerProperties_networkConfiguration :: Lens' ContainerProperties (Maybe NetworkConfiguration)
- containerProperties_privileged :: Lens' ContainerProperties (Maybe Bool)
- containerProperties_readonlyRootFilesystem :: Lens' ContainerProperties (Maybe Bool)
- containerProperties_resourceRequirements :: Lens' ContainerProperties (Maybe [ResourceRequirement])
- containerProperties_secrets :: Lens' ContainerProperties (Maybe [Secret])
- containerProperties_ulimits :: Lens' ContainerProperties (Maybe [Ulimit])
- containerProperties_user :: Lens' ContainerProperties (Maybe Text)
- containerProperties_vcpus :: Lens' ContainerProperties (Maybe Int)
- containerProperties_volumes :: Lens' ContainerProperties (Maybe [Volume])
Documentation
data ContainerProperties Source #
Container properties are used for Amazon ECS based job definitions. These properties to describe the container that's launched as part of a job.
See: newContainerProperties
smart constructor.
ContainerProperties' | |
|
Instances
newContainerProperties :: ContainerProperties Source #
Create a value of ContainerProperties
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:command:ContainerProperties'
, containerProperties_command
- 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.
$sel:environment:ContainerProperties'
, containerProperties_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.
$sel:executionRoleArn:ContainerProperties'
, containerProperties_executionRoleArn
- 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.
$sel:fargatePlatformConfiguration:ContainerProperties'
, containerProperties_fargatePlatformConfiguration
- The platform configuration for jobs that are running on Fargate
resources. Jobs that are running on EC2 resources must not specify this
parameter.
$sel:image:ContainerProperties'
, containerProperties_image
- 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]
orregistry/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
ormongo
). - 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
).
$sel:instanceType:ContainerProperties'
, containerProperties_instanceType
- The instance type to use for a multi-node parallel job. All node groups
in a multi-node parallel job must use the same instance type.
This parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and shouldn't be provided.
$sel:jobRoleArn:ContainerProperties'
, containerProperties_jobRoleArn
- 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.
$sel:linuxParameters:ContainerProperties'
, containerProperties_linuxParameters
- Linux-specific modifications that are applied to the container, such as
details for device mappings.
$sel:logConfiguration:ContainerProperties'
, containerProperties_logConfiguration
- The log configuration specification for the container.
This parameter maps to LogConfig
in the
Create a container
section of the
Docker Remote API and the
--log-driver
option to
docker run. By default,
containers use the same logging driver that the Docker daemon uses.
However the container might use a different logging driver than the
Docker daemon by specifying a log driver with this parameter in the
container definition. To use a different logging driver for a container,
the log system must be configured properly on the container instance (or
on a different log server for remote logging options). For more
information on the options for different supported log drivers, see
Configure logging drivers
in the Docker documentation.
Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type).
This parameter requires version 1.18 of the Docker Remote API or greater
on your container instance. To check the Docker Remote API version on
your container instance, log in to your container instance and run the
following command: sudo docker version | grep "Server API version"
The Amazon ECS container agent running on a container instance must
register the logging drivers available on that instance with the
ECS_AVAILABLE_LOGGING_DRIVERS
environment variable before containers
placed on that instance can use these log configuration options. For
more information, see
Amazon ECS container agent configuration
in the Amazon Elastic Container Service Developer Guide.
$sel:memory:ContainerProperties'
, containerProperties_memory
- This parameter is deprecated, use resourceRequirements
to specify the
memory requirements for the job definition. It's not supported for jobs
running on Fargate resources. For jobs that run on EC2 resources, it
specifies the memory hard limit (in MiB) for a container. If your
container attempts to exceed the specified number, it's terminated. You
must specify at least 4 MiB of memory for a job using this parameter.
The memory hard limit can be specified in several places. It must be
specified for each node at least once.
$sel:mountPoints:ContainerProperties'
, containerProperties_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.
$sel:networkConfiguration:ContainerProperties'
, containerProperties_networkConfiguration
- The network configuration for jobs that are running on Fargate
resources. Jobs that are running on EC2 resources must not specify this
parameter.
$sel:privileged:ContainerProperties'
, containerProperties_privileged
- 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.
$sel:readonlyRootFilesystem:ContainerProperties'
, containerProperties_readonlyRootFilesystem
- 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
.
$sel:resourceRequirements:ContainerProperties'
, containerProperties_resourceRequirements
- The type and amount of resources to assign to a container. The supported
resources include GPU
, MEMORY
, and VCPU
.
$sel:secrets:ContainerProperties'
, containerProperties_secrets
- The secrets for the container. For more information, see
Specifying sensitive data
in the Batch User Guide.
$sel:ulimits:ContainerProperties'
, containerProperties_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.
$sel:user:ContainerProperties'
, containerProperties_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.
$sel:vcpus:ContainerProperties'
, containerProperties_vcpus
- This parameter is deprecated, use resourceRequirements
to specify the
vCPU requirements for the job definition. It's not supported for jobs
running on Fargate resources. For jobs running on EC2 resources, it
specifies the number of vCPUs reserved for the job.
Each vCPU is equivalent to 1,024 CPU shares. This parameter maps to
CpuShares
in the
Create a container
section of the
Docker Remote API and the
--cpu-shares
option to
docker run. The number
of vCPUs must be specified but can be specified in several places. You
must specify it at least once for each node.
$sel:volumes:ContainerProperties'
, containerProperties_volumes
- A list of data volumes used in a job.
containerProperties_command :: Lens' ContainerProperties (Maybe [Text]) Source #
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.
containerProperties_environment :: Lens' ContainerProperties (Maybe [KeyValuePair]) Source #
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.
containerProperties_executionRoleArn :: Lens' ContainerProperties (Maybe Text) Source #
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.
containerProperties_fargatePlatformConfiguration :: Lens' ContainerProperties (Maybe FargatePlatformConfiguration) Source #
The platform configuration for jobs that are running on Fargate resources. Jobs that are running on EC2 resources must not specify this parameter.
containerProperties_image :: Lens' ContainerProperties (Maybe Text) Source #
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]
orregistry/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
ormongo
). - 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
).
containerProperties_instanceType :: Lens' ContainerProperties (Maybe Text) Source #
The instance type to use for a multi-node parallel job. All node groups in a multi-node parallel job must use the same instance type.
This parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and shouldn't be provided.
containerProperties_jobRoleArn :: Lens' ContainerProperties (Maybe Text) Source #
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.
containerProperties_linuxParameters :: Lens' ContainerProperties (Maybe LinuxParameters) Source #
Linux-specific modifications that are applied to the container, such as details for device mappings.
containerProperties_logConfiguration :: Lens' ContainerProperties (Maybe LogConfiguration) Source #
The log configuration specification for the container.
This parameter maps to LogConfig
in the
Create a container
section of the
Docker Remote API and the
--log-driver
option to
docker run. By default,
containers use the same logging driver that the Docker daemon uses.
However the container might use a different logging driver than the
Docker daemon by specifying a log driver with this parameter in the
container definition. To use a different logging driver for a container,
the log system must be configured properly on the container instance (or
on a different log server for remote logging options). For more
information on the options for different supported log drivers, see
Configure logging drivers
in the Docker documentation.
Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type).
This parameter requires version 1.18 of the Docker Remote API or greater
on your container instance. To check the Docker Remote API version on
your container instance, log in to your container instance and run the
following command: sudo docker version | grep "Server API version"
The Amazon ECS container agent running on a container instance must
register the logging drivers available on that instance with the
ECS_AVAILABLE_LOGGING_DRIVERS
environment variable before containers
placed on that instance can use these log configuration options. For
more information, see
Amazon ECS container agent configuration
in the Amazon Elastic Container Service Developer Guide.
containerProperties_memory :: Lens' ContainerProperties (Maybe Int) Source #
This parameter is deprecated, use resourceRequirements
to specify the
memory requirements for the job definition. It's not supported for jobs
running on Fargate resources. For jobs that run on EC2 resources, it
specifies the memory hard limit (in MiB) for a container. If your
container attempts to exceed the specified number, it's terminated. You
must specify at least 4 MiB of memory for a job using this parameter.
The memory hard limit can be specified in several places. It must be
specified for each node at least once.
containerProperties_mountPoints :: Lens' ContainerProperties (Maybe [MountPoint]) Source #
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.
containerProperties_networkConfiguration :: Lens' ContainerProperties (Maybe NetworkConfiguration) Source #
The network configuration for jobs that are running on Fargate resources. Jobs that are running on EC2 resources must not specify this parameter.
containerProperties_privileged :: Lens' ContainerProperties (Maybe Bool) Source #
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.
containerProperties_readonlyRootFilesystem :: Lens' ContainerProperties (Maybe Bool) Source #
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
.
containerProperties_resourceRequirements :: Lens' ContainerProperties (Maybe [ResourceRequirement]) Source #
The type and amount of resources to assign to a container. The supported
resources include GPU
, MEMORY
, and VCPU
.
containerProperties_secrets :: Lens' ContainerProperties (Maybe [Secret]) Source #
The secrets for the container. For more information, see Specifying sensitive data in the Batch User Guide.
containerProperties_ulimits :: Lens' ContainerProperties (Maybe [Ulimit]) Source #
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.
containerProperties_user :: Lens' ContainerProperties (Maybe Text) Source #
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.
containerProperties_vcpus :: Lens' ContainerProperties (Maybe Int) Source #
This parameter is deprecated, use resourceRequirements
to specify the
vCPU requirements for the job definition. It's not supported for jobs
running on Fargate resources. For jobs running on EC2 resources, it
specifies the number of vCPUs reserved for the job.
Each vCPU is equivalent to 1,024 CPU shares. This parameter maps to
CpuShares
in the
Create a container
section of the
Docker Remote API and the
--cpu-shares
option to
docker run. The number
of vCPUs must be specified but can be specified in several places. You
must specify it at least once for each node.
containerProperties_volumes :: Lens' ContainerProperties (Maybe [Volume]) Source #
A list of data volumes used in a job.