Struct rusoto_batch::ContainerDetail
source · [−]pub struct ContainerDetail {Show 26 fields
pub command: Option<Vec<String>>,
pub container_instance_arn: Option<String>,
pub environment: Option<Vec<KeyValuePair>>,
pub execution_role_arn: Option<String>,
pub exit_code: Option<i64>,
pub fargate_platform_configuration: Option<FargatePlatformConfiguration>,
pub image: Option<String>,
pub instance_type: Option<String>,
pub job_role_arn: Option<String>,
pub linux_parameters: Option<LinuxParameters>,
pub log_configuration: Option<LogConfiguration>,
pub log_stream_name: Option<String>,
pub memory: Option<i64>,
pub mount_points: Option<Vec<MountPoint>>,
pub network_configuration: Option<NetworkConfiguration>,
pub network_interfaces: Option<Vec<NetworkInterface>>,
pub privileged: Option<bool>,
pub readonly_root_filesystem: Option<bool>,
pub reason: Option<String>,
pub resource_requirements: Option<Vec<ResourceRequirement>>,
pub secrets: Option<Vec<Secret>>,
pub task_arn: Option<String>,
pub ulimits: Option<Vec<Ulimit>>,
pub user: Option<String>,
pub vcpus: Option<i64>,
pub volumes: Option<Vec<Volume>>,
}
Expand description
An object representing the details of a container that's part of a job.
Fields
command: Option<Vec<String>>
The command that's passed to the container.
container_instance_arn: Option<String>
The Amazon Resource Name (ARN) of the container instance that the container is running on.
environment: Option<Vec<KeyValuePair>>
The environment variables to pass to a container.
Environment variables must not start with AWS_BATCH
; this naming convention is reserved for variables that are set by the AWS Batch service.
execution_role_arn: Option<String>
The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume. For more information, see AWS Batch execution IAM role in the AWS Batch User Guide.
exit_code: Option<i64>
The exit code to return upon completion.
fargate_platform_configuration: Option<FargatePlatformConfiguration>
The platform configuration for jobs running on Fargate resources. Jobs running on EC2 resources must not specify this parameter.
image: Option<String>
The image used to start the container.
instance_type: Option<String>
The instance type of the underlying host infrastructure of a multi-node parallel job.
This parameter isn't applicable to jobs running on Fargate resources.
job_role_arn: Option<String>
The Amazon Resource Name (ARN) associated with the job upon execution.
linux_parameters: Option<LinuxParameters>
Linux-specific modifications that are applied to the container, such as details for device mappings.
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 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, alternatively, it must be configured 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.
AWS Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers might 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 into 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 ECSAVAILABLELOGGING_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.
log_stream_name: Option<String>
The name of the CloudWatch Logs log stream associated with the container. The log group for AWS Batch jobs is /aws/batch/job
. Each container attempt receives a log stream name when they reach the RUNNING
status.
memory: Option<i64>
For jobs run on EC2 resources that didn't specify memory requirements using ResourceRequirement
, the number of MiB of memory reserved for the job. For other jobs, including all run on Fargate resources, see resourceRequirements
.
mount_points: Option<Vec<MountPoint>>
The mount points for data volumes in your container.
network_configuration: Option<NetworkConfiguration>
The network configuration for jobs running on Fargate resources. Jobs running on EC2 resources must not specify this parameter.
network_interfaces: Option<Vec<NetworkInterface>>
The network interfaces associated with the job.
privileged: Option<bool>
When this parameter is true, the container is given elevated permissions on the host container instance (similar to the root
user). The default value is false.
This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided, or specified as false.
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
.
reason: Option<String>
A short (255 max characters) human-readable string to provide additional details about a running or stopped container.
resource_requirements: Option<Vec<ResourceRequirement>>
The type and amount of resources to assign to a container. The supported resources include GPU
, MEMORY
, and VCPU
.
secrets: Option<Vec<Secret>>
The secrets to pass to the container. For more information, see Specifying sensitive data in the AWS Batch User Guide.
task_arn: Option<String>
The Amazon Resource Name (ARN) of the Amazon ECS task that's associated with the container job. Each container attempt receives a task ARN when they reach the STARTING
status.
ulimits: Option<Vec<Ulimit>>
A list of ulimit
values 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 running on Fargate resources.
user: Option<String>
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.
vcpus: Option<i64>
The number of vCPUs reserved for the container. For jobs that run on EC2 resources, you can specify the vCPU requirement for the job using resourceRequirements
, but you can't specify the vCPU requirements in both the vcpus
and resourceRequirement
object. This parameter maps to CpuShares
in the Create a container section of the Docker Remote API and the --cpu-shares
option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU. This is required but can be specified in several places. It must be specified for each node at least once.
This parameter isn't applicable to jobs that run on Fargate resources. For jobs that run on Fargate resources, you must specify the vCPU requirement for the job using resourceRequirements
.
volumes: Option<Vec<Volume>>
A list of volumes associated with the job.
Trait Implementations
sourceimpl Clone for ContainerDetail
impl Clone for ContainerDetail
sourcefn clone(&self) -> ContainerDetail
fn clone(&self) -> ContainerDetail
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for ContainerDetail
impl Debug for ContainerDetail
sourceimpl Default for ContainerDetail
impl Default for ContainerDetail
sourcefn default() -> ContainerDetail
fn default() -> ContainerDetail
Returns the “default value” for a type. Read more
sourceimpl<'de> Deserialize<'de> for ContainerDetail
impl<'de> Deserialize<'de> for ContainerDetail
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl PartialEq<ContainerDetail> for ContainerDetail
impl PartialEq<ContainerDetail> for ContainerDetail
sourcefn eq(&self, other: &ContainerDetail) -> bool
fn eq(&self, other: &ContainerDetail) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &ContainerDetail) -> bool
fn ne(&self, other: &ContainerDetail) -> bool
This method tests for !=
.
impl StructuralPartialEq for ContainerDetail
Auto Trait Implementations
impl RefUnwindSafe for ContainerDetail
impl Send for ContainerDetail
impl Sync for ContainerDetail
impl Unpin for ContainerDetail
impl UnwindSafe for ContainerDetail
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more