Struct aws_sdk_batch::types::EcsTaskProperties

#[non_exhaustive]
pub struct EcsTaskProperties {
    pub containers: Option<Vec<TaskContainerProperties>>,
    pub ephemeral_storage: Option<EphemeralStorage>,
    pub execution_role_arn: Option<String>,
    pub platform_version: Option<String>,
    pub ipc_mode: Option<String>,
    pub task_role_arn: Option<String>,
    pub pid_mode: Option<String>,
    pub network_configuration: Option<NetworkConfiguration>,
    pub runtime_platform: Option<RuntimePlatform>,
    pub volumes: Option<Vec<Volume>>,
}

The properties for a task definition that describes the container and volume definitions of an Amazon ECS task. You can specify which Docker images to use, the required resources, and other configurations related to launching the task definition through an Amazon ECS service or task.

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.

containers: Option<Vec<TaskContainerProperties>>

This object is a list of containers.

ephemeral_storage: Option<EphemeralStorage>

The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on Fargate.

execution_role_arn: Option<String>

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.

platform_version: Option<String>

The Fargate platform version where the jobs are running. A platform version is specified only for jobs that are running on Fargate resources. If one isn't specified, the LATEST platform version is used by default. This uses a recent, approved version of the Fargate platform for compute resources. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.

ipc_mode: Option<String>

The IPC resource namespace to use for the containers in the task. The valid values are host, task, or none.

If host is specified, all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance.

If task is specified, all containers within the specified task share the same IPC resources.

If none is specified, the IPC resources within the containers of a task are private, and are not shared with other containers in a task or on the container instance.

If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference.

task_role_arn: Option<String>

The Amazon Resource Name (ARN) that's associated with the Amazon ECS task.

This is object is comparable to ContainerProperties:jobRoleArn.

pid_mode: Option<String>

The process namespace to use for the containers in the task. The valid values are host or task. For example, monitoring sidecars might need pidMode to access information about other containers running in the same task.

If host is specified, all containers within the tasks that specified the host PID mode on the same container instance share the process namespace with the host Amazon EC2 instance.

If task is specified, all containers within the specified task share the same process namespace.

If no value is specified, the default is a private namespace for each container. For more information, see PID settings in the Docker run reference.

network_configuration: Option<NetworkConfiguration>

The network configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter.

runtime_platform: Option<RuntimePlatform>

An object that represents the compute environment architecture for Batch jobs on Fargate.

volumes: Option<Vec<Volume>>

A list of volumes that are associated with the job.

Implementations

impl EcsTaskProperties

pub fn containers(&self) -> &[TaskContainerProperties]

This object is a list of 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 .containers.is_none().

pub fn ephemeral_storage(&self) -> Option<&EphemeralStorage>

The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on Fargate.

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

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.

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

The Fargate platform version where the jobs are running. A platform version is specified only for jobs that are running on Fargate resources. If one isn't specified, the LATEST platform version is used by default. This uses a recent, approved version of the Fargate platform for compute resources. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.

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

The IPC resource namespace to use for the containers in the task. The valid values are host, task, or none.

If host is specified, all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance.

If task is specified, all containers within the specified task share the same IPC resources.

If none is specified, the IPC resources within the containers of a task are private, and are not shared with other containers in a task or on the container instance.

If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference.

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

The Amazon Resource Name (ARN) that's associated with the Amazon ECS task.

This is object is comparable to ContainerProperties:jobRoleArn.

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

The process namespace to use for the containers in the task. The valid values are host or task. For example, monitoring sidecars might need pidMode to access information about other containers running in the same task.

If host is specified, all containers within the tasks that specified the host PID mode on the same container instance share the process namespace with the host Amazon EC2 instance.

If task is specified, all containers within the specified task share the same process namespace.

If no value is specified, the default is a private namespace for each container. For more information, see PID settings in the Docker run reference.

pub fn network_configuration(&self) -> Option<&NetworkConfiguration>

The network configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter.

pub fn runtime_platform(&self) -> Option<&RuntimePlatform>

An object that represents the compute environment architecture for Batch jobs on Fargate.

pub fn volumes(&self) -> &[Volume]

A list of volumes 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 .volumes.is_none().

impl EcsTaskProperties

pub fn builder() -> EcsTaskPropertiesBuilder

Creates a new builder-style object to manufacture EcsTaskProperties.

Trait Implementations

impl Clone for EcsTaskProperties

fn clone(&self) -> EcsTaskProperties

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EcsTaskProperties

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

Formats the value using the given formatter.

impl PartialEq for EcsTaskProperties

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for EcsTaskProperties