Struct TaskContainerDetails

#[non_exhaustive]
pub struct TaskContainerDetails {

    pub command: Option<Vec<String>>,
    pub depends_on: Option<Vec<TaskContainerDependency>>,
    pub environment: Option<Vec<KeyValuePair>>,
    pub essential: Option<bool>,
    pub firelens_configuration: Option<FirelensConfiguration>,
    pub image: Option<String>,
    pub linux_parameters: Option<LinuxParameters>,
    pub log_configuration: Option<LogConfiguration>,
    pub mount_points: Option<Vec<MountPoint>>,
    pub name: Option<String>,
    pub privileged: Option<bool>,
    pub readonly_root_filesystem: Option<bool>,
    pub repository_credentials: Option<RepositoryCredentials>,
    pub resource_requirements: Option<Vec<ResourceRequirement>>,
    pub secrets: Option<Vec<Secret>>,
    pub ulimits: Option<Vec<Ulimit>>,
    pub user: Option<String>,
    pub exit_code: Option<i32>,
    pub reason: Option<String>,
    pub log_stream_name: Option<String>,
    pub network_interfaces: Option<Vec<NetworkInterface>>,
}

The details for the container in this task attempt.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

command: Option<Vec<String>>

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.

depends_on: Option<Vec<TaskContainerDependency>>

A list of containers that this container depends on.

environment: Option<Vec<KeyValuePair>>

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.

essential: Option<bool>

If the essential parameter of a container is marked as true, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the essential parameter of a container is marked as false, its failure doesn't affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.

All jobs must have at least one essential container. If you have an application that's composed of multiple containers, group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon Elastic Container Service Developer Guide.

firelens_configuration: Option<FirelensConfiguration>

The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom log routing in the Amazon Elastic Container Service Developer Guide.

image: Option<String>

The image used to start a container. This string is passed directly to the Docker daemon. By default, images in the Docker Hub registry are available. Other repositories are specified with either repository-url/image:tag or repository-url/image@digest. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of the docker run .

linux_parameters: Option<LinuxParameters>

Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information, see KernelCapabilities.

This parameter is not supported for Windows containers.

log_configuration: Option<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 can 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 about the options for different supported log drivers, see Configure logging drivers in the Docker documentation.

Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent.

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 --format '{{.Server.APIVersion}}'

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.

mount_points: Option<Vec<MountPoint>>

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.

Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers can't mount directories on a different drive, and mount point can't be across drives.

name: Option<String>

The name of a container.

privileged: Option<bool>

When this parameter is true, the container is given elevated privileges 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.

This parameter is not supported for Windows containers or tasks run on Fargate.

readonly_root_filesystem: Option<bool>

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.

This parameter is not supported for Windows containers.

repository_credentials: Option<RepositoryCredentials>

The private repository authentication credentials to use.

resource_requirements: Option<Vec<ResourceRequirement>>

The type and amount of a resource to assign to a container. The only supported resource is a GPU.

secrets: Option<Vec<Secret>>

The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.

ulimits: Option<Vec<Ulimit>>

A list of ulimits to set in the container. If a ulimit value is specified in a task definition, it overrides the default values set by Docker. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run.

Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating system with the exception of the nofile resource limit parameter which Fargate overrides. The nofile resource limit sets a restriction on the number of open files that a container can use. The default nofile soft limit is 1024 and the default hard limit is 65535.

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 --format '{{.Server.APIVersion}}'

This parameter is not supported for Windows containers.

user: Option<String>

The user 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.

When running tasks using the host network mode, don't run containers using the root user (UID 0). We recommend using a non-root user for better security.

You can specify the user using the following formats. If specifying a UID or GID, you must specify it as a positive integer.

• user

• user:group

• uid

• uid:gid

• user:gi

• uid:group

This parameter is not supported for Windows containers.

exit_code: Option<i32>

The exit code returned upon completion.

reason: Option<String>

A short (255 max characters) human-readable string to provide additional details for a running or stopped container.

log_stream_name: Option<String>

The name of the CloudWatch Logs log stream that's associated with the container. The log group for Batch jobs is /aws/batch/job. Each container attempt receives a log stream name when they reach the RUNNING status.

network_interfaces: Option<Vec<NetworkInterface>>

The network interfaces that are associated with the job.

Implementations

impl TaskContainerDetails

pub fn command(&self) -> &[String]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .command.is_none().

pub fn depends_on(&self) -> &[TaskContainerDependency]

A list of containers that this container depends on.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .depends_on.is_none().

pub fn environment(&self) -> &[KeyValuePair]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .environment.is_none().

pub fn essential(&self) -> Option<bool>

If the essential parameter of a container is marked as true, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the essential parameter of a container is marked as false, its failure doesn't affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.

All jobs must have at least one essential container. If you have an application that's composed of multiple containers, group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon Elastic Container Service Developer Guide.

pub fn firelens_configuration(&self) -> Option<&FirelensConfiguration>

The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom log routing in the Amazon Elastic Container Service Developer Guide.

pub fn image(&self) -> Option<&str>

The image used to start a container. This string is passed directly to the Docker daemon. By default, images in the Docker Hub registry are available. Other repositories are specified with either repository-url/image:tag or repository-url/image@digest. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of the docker run .

pub fn linux_parameters(&self) -> Option<&LinuxParameters>

Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information, see KernelCapabilities.

This parameter is not supported for Windows containers.

pub fn log_configuration(&self) -> Option<&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 can 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 about the options for different supported log drivers, see Configure logging drivers in the Docker documentation.

Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent.

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 --format '{{.Server.APIVersion}}'

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.

pub fn mount_points(&self) -> &[MountPoint]

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.

Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers can't mount directories on a different drive, and mount point can't be across drives.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .mount_points.is_none().

pub fn name(&self) -> Option<&str>

The name of a container.

pub fn privileged(&self) -> Option<bool>

When this parameter is true, the container is given elevated privileges 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.

This parameter is not supported for Windows containers or tasks run on Fargate.

pub fn readonly_root_filesystem(&self) -> Option<bool>

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.

This parameter is not supported for Windows containers.

pub fn repository_credentials(&self) -> Option<&RepositoryCredentials>

The private repository authentication credentials to use.

pub fn resource_requirements(&self) -> &[ResourceRequirement]

The type and amount of a resource to assign to a container. The only supported resource is a GPU.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .resource_requirements.is_none().

pub fn secrets(&self) -> &[Secret]

The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .secrets.is_none().

pub fn ulimits(&self) -> &[Ulimit]

A list of ulimits to set in the container. If a ulimit value is specified in a task definition, it overrides the default values set by Docker. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run.

Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating system with the exception of the nofile resource limit parameter which Fargate overrides. The nofile resource limit sets a restriction on the number of open files that a container can use. The default nofile soft limit is 1024 and the default hard limit is 65535.

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 --format '{{.Server.APIVersion}}'

This parameter is not supported for Windows containers.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .ulimits.is_none().

pub fn user(&self) -> Option<&str>

The user 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.

When running tasks using the host network mode, don't run containers using the root user (UID 0). We recommend using a non-root user for better security.

You can specify the user using the following formats. If specifying a UID or GID, you must specify it as a positive integer.

• user

• user:group

• uid

• uid:gid

• user:gi

• uid:group

This parameter is not supported for Windows containers.

pub fn exit_code(&self) -> Option<i32>

The exit code returned upon completion.

pub fn reason(&self) -> Option<&str>

A short (255 max characters) human-readable string to provide additional details for a running or stopped container.

pub fn log_stream_name(&self) -> Option<&str>

The name of the CloudWatch Logs log stream that's associated with the container. The log group for Batch jobs is /aws/batch/job. Each container attempt receives a log stream name when they reach the RUNNING status.

pub fn network_interfaces(&self) -> &[NetworkInterface]

The network interfaces that are associated with the job.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .network_interfaces.is_none().

impl TaskContainerDetails

pub fn builder() -> TaskContainerDetailsBuilder

Creates a new builder-style object to manufacture TaskContainerDetails.

Trait Implementations

impl Clone for TaskContainerDetails

fn clone(&self) -> TaskContainerDetails

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TaskContainerDetails

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for TaskContainerDetails

fn eq(&self, other: &TaskContainerDetails) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for TaskContainerDetails