Struct ContainerPropertiesBuilder

#[non_exhaustive]
pub struct ContainerPropertiesBuilder { /* private fields */ }

A builder for ContainerProperties.

Implementations

impl ContainerPropertiesBuilder

pub fn image(self, input: impl Into<String>) -> Self

Required. 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\] or registry/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. .amazonaws.com/ ).

• Images in official repositories on Docker Hub use a single name (for example, ubuntu or mongo).

• 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).

pub fn set_image(self, input: Option<String>) -> Self

Required. 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\] or registry/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. .amazonaws.com/ ).

• Images in official repositories on Docker Hub use a single name (for example, ubuntu or mongo).

• 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).

pub fn get_image(&self) -> &Option<String>

Required. 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\] or registry/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. .amazonaws.com/ ).

• Images in official repositories on Docker Hub use a single name (for example, ubuntu or mongo).

• 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).

pub fn vcpus(self, input: i32) -> Self

👎Deprecated: This field is deprecated, use resourceRequirements instead.

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 Amazon 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.

pub fn set_vcpus(self, input: Option<i32>) -> Self

👎Deprecated: This field is deprecated, use resourceRequirements instead.

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 Amazon 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.

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

👎Deprecated: This field is deprecated, use resourceRequirements instead.

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 Amazon 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.

pub fn memory(self, input: i32) -> Self

👎Deprecated: This field is deprecated, use resourceRequirements instead.

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 Amazon 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.

pub fn set_memory(self, input: Option<i32>) -> Self

👎Deprecated: This field is deprecated, use resourceRequirements instead.

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 Amazon 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.

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

👎Deprecated: This field is deprecated, use resourceRequirements instead.

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 Amazon 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.

pub fn command(self, input: impl Into<String>) -> Self

Appends an item to command.

To override the contents of this collection use set_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.

pub fn set_command(self, input: Option<Vec<String>>) -> Self

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.

pub fn get_command(&self) -> &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.

pub fn job_role_arn(self, input: impl Into<String>) -> Self

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.

pub fn set_job_role_arn(self, input: Option<String>) -> Self

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.

pub fn get_job_role_arn(&self) -> &Option<String>

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.

pub fn execution_role_arn(self, input: impl Into<String>) -> Self

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 set_execution_role_arn(self, input: Option<String>) -> Self

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 get_execution_role_arn(&self) -> &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.

pub fn volumes(self, input: Volume) -> Self

Appends an item to volumes.

To override the contents of this collection use set_volumes.

A list of data volumes used in a job.

pub fn set_volumes(self, input: Option<Vec<Volume>>) -> Self

A list of data volumes used in a job.

pub fn get_volumes(&self) -> &Option<Vec<Volume>>

A list of data volumes used in a job.

pub fn environment(self, input: KeyValuePair) -> Self

Appends an item to environment.

To override the contents of this collection use set_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.

pub fn set_environment(self, input: Option<Vec<KeyValuePair>>) -> Self

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.

pub fn get_environment(&self) -> &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 cannot start with "AWS_BATCH". This naming convention is reserved for variables that Batch sets.

pub fn mount_points(self, input: MountPoint) -> Self

Appends an item to mount_points.

To override the contents of this collection use set_mount_points.

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.

pub fn set_mount_points(self, input: Option<Vec<MountPoint>>) -> Self

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.

pub fn get_mount_points(&self) -> &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.

pub fn readonly_root_filesystem(self, input: bool) -> Self

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.

pub fn set_readonly_root_filesystem(self, input: Option<bool>) -> Self

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.

pub fn get_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.

pub fn privileged(self, input: bool) -> Self

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.

pub fn set_privileged(self, input: Option<bool>) -> Self

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.

pub fn get_privileged(&self) -> &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 that are running on Fargate resources and shouldn't be provided, or specified as false.

pub fn ulimits(self, input: Ulimit) -> Self

Appends an item to ulimits.

To override the contents of this collection use set_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.

pub fn set_ulimits(self, input: Option<Vec<Ulimit>>) -> Self

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.

pub fn get_ulimits(&self) -> &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 that are running on Fargate resources and shouldn't be provided.

pub fn user(self, input: impl Into<String>) -> Self

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.

pub fn set_user(self, input: Option<String>) -> Self

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.

pub fn get_user(&self) -> &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.

pub fn instance_type(self, input: impl Into<String>) -> Self

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.

pub fn set_instance_type(self, input: Option<String>) -> Self

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.

pub fn get_instance_type(&self) -> &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 jobs that run on Fargate resources, and shouldn't be provided.

pub fn resource_requirements(self, input: ResourceRequirement) -> Self

Appends an item to resource_requirements.

To override the contents of this collection use set_resource_requirements.

The type and amount of resources to assign to a container. The supported resources include GPU, MEMORY, and VCPU.

pub fn set_resource_requirements( self, input: Option<Vec<ResourceRequirement>>, ) -> Self

The type and amount of resources to assign to a container. The supported resources include GPU, MEMORY, and VCPU.

pub fn get_resource_requirements(&self) -> &Option<Vec<ResourceRequirement>>

The type and amount of resources to assign to a container. The supported resources include GPU, MEMORY, and VCPU.

pub fn linux_parameters(self, input: LinuxParameters) -> Self

Linux-specific modifications that are applied to the container, such as details for device mappings.

pub fn set_linux_parameters(self, input: Option<LinuxParameters>) -> Self

Linux-specific modifications that are applied to the container, such as details for device mappings.

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

Linux-specific modifications that are applied to the container, such as details for device mappings.

pub fn log_configuration(self, input: LogConfiguration) -> Self

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.

pub fn set_log_configuration(self, input: Option<LogConfiguration>) -> Self

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.

pub fn get_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 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.

pub fn secrets(self, input: Secret) -> Self

Appends an item to secrets.

To override the contents of this collection use set_secrets.

The secrets for the container. For more information, see Specifying sensitive data in the Batch User Guide.

pub fn set_secrets(self, input: Option<Vec<Secret>>) -> Self

The secrets for the container. For more information, see Specifying sensitive data in the Batch User Guide.

pub fn get_secrets(&self) -> &Option<Vec<Secret>>

The secrets for the container. For more information, see Specifying sensitive data in the Batch User Guide.

pub fn network_configuration(self, input: NetworkConfiguration) -> Self

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 set_network_configuration( self, input: Option<NetworkConfiguration>, ) -> Self

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 get_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 fargate_platform_configuration( self, input: FargatePlatformConfiguration, ) -> Self

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

pub fn set_fargate_platform_configuration( self, input: Option<FargatePlatformConfiguration>, ) -> Self

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

pub fn get_fargate_platform_configuration( &self, ) -> &Option<FargatePlatformConfiguration>

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

pub fn enable_execute_command(self, input: bool) -> Self

Determines whether execute command functionality is turned on for this task. If true, execute command functionality is turned on all the containers in the task.

pub fn set_enable_execute_command(self, input: Option<bool>) -> Self

Determines whether execute command functionality is turned on for this task. If true, execute command functionality is turned on all the containers in the task.

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

Determines whether execute command functionality is turned on for this task. If true, execute command functionality is turned on all the containers in the task.

pub fn ephemeral_storage(self, input: EphemeralStorage) -> Self

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 set_ephemeral_storage(self, input: Option<EphemeralStorage>) -> Self

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 get_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 runtime_platform(self, input: RuntimePlatform) -> Self

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

pub fn set_runtime_platform(self, input: Option<RuntimePlatform>) -> Self

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

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

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

pub fn repository_credentials(self, input: RepositoryCredentials) -> Self

The private repository authentication credentials to use.

pub fn set_repository_credentials( self, input: Option<RepositoryCredentials>, ) -> Self

The private repository authentication credentials to use.

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

The private repository authentication credentials to use.

pub fn build(self) -> ContainerProperties

Consumes the builder and constructs a ContainerProperties.

Trait Implementations

impl Clone for ContainerPropertiesBuilder

fn clone(&self) -> ContainerPropertiesBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ContainerPropertiesBuilder

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

Formats the value using the given formatter.

impl Default for ContainerPropertiesBuilder

fn default() -> ContainerPropertiesBuilder

Returns the “default value” for a type.

impl PartialEq for ContainerPropertiesBuilder

fn eq(&self, other: &ContainerPropertiesBuilder) -> 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 ContainerPropertiesBuilder