Struct rusoto_batch::ContainerProperties
source · [−]pub struct ContainerProperties {Show 18 fields
pub command: Option<Vec<String>>,
pub environment: Option<Vec<KeyValuePair>>,
pub execution_role_arn: Option<String>,
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 mount_points: Option<Vec<MountPoint>>,
pub network_configuration: Option<NetworkConfiguration>,
pub privileged: Option<bool>,
pub readonly_root_filesystem: Option<bool>,
pub resource_requirements: Option<Vec<ResourceRequirement>>,
pub secrets: Option<Vec<Secret>>,
pub ulimits: Option<Vec<Ulimit>>,
pub user: Option<String>,
pub volumes: Option<Vec<Volume>>,
}
Expand description
Container properties are used in job definitions to describe the container that's launched as part of a job.
Fields
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.
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.
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 jobs that run on Fargate resources, you must provide an execution role. For more information, see AWS Batch execution IAM role in the AWS Batch User Guide.
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 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
. 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 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 repositories use the full registry and repository URI (for example,
012345678910.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
).
instance_type: Option<String>
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 for jobs that run on Fargate resources and shouldn't be provided.
job_role_arn: Option<String>
The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions. For more information, see IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide.
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 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).
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.
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.
network_configuration: Option<NetworkConfiguration>
The network configuration for jobs running on Fargate resources. Jobs running on EC2 resources must not specify this parameter.
privileged: Option<bool>
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 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
.
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 for the container. For more information, see Specifying sensitive data in the AWS Batch User Guide.
ulimits: Option<Vec<Ulimit>>
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 running on Fargate resources and shouldn't be provided.
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.
volumes: Option<Vec<Volume>>
A list of data volumes used in a job.
Trait Implementations
sourceimpl Clone for ContainerProperties
impl Clone for ContainerProperties
sourcefn clone(&self) -> ContainerProperties
fn clone(&self) -> ContainerProperties
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 ContainerProperties
impl Debug for ContainerProperties
sourceimpl Default for ContainerProperties
impl Default for ContainerProperties
sourcefn default() -> ContainerProperties
fn default() -> ContainerProperties
Returns the “default value” for a type. Read more
sourceimpl<'de> Deserialize<'de> for ContainerProperties
impl<'de> Deserialize<'de> for ContainerProperties
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<ContainerProperties> for ContainerProperties
impl PartialEq<ContainerProperties> for ContainerProperties
sourcefn eq(&self, other: &ContainerProperties) -> bool
fn eq(&self, other: &ContainerProperties) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &ContainerProperties) -> bool
fn ne(&self, other: &ContainerProperties) -> bool
This method tests for !=
.
sourceimpl Serialize for ContainerProperties
impl Serialize for ContainerProperties
impl StructuralPartialEq for ContainerProperties
Auto Trait Implementations
impl RefUnwindSafe for ContainerProperties
impl Send for ContainerProperties
impl Sync for ContainerProperties
impl Unpin for ContainerProperties
impl UnwindSafe for ContainerProperties
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