Package software.amazon.awssdk.services.batch.model

Interface ContainerProperties.Builder

    • Method Detail

      • image

        ContainerProperties.Builder image​(String image)

        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.<region-name>.amazonaws.com/<repository-name>).

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

        Parameters:
        image - 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.<region-name>.amazonaws.com/<repository-name>).

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • vcpus

        @Deprecated
ContainerProperties.Builder vcpus​(Integer vcpus)
        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 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.

        Parameters:
        vcpus - 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 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • memory

        @Deprecated
ContainerProperties.Builder memory​(Integer memory)
        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 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.

        Parameters:
        memory - 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 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • jobRoleArn

        ContainerProperties.Builder jobRoleArn​(String jobRoleArn)

        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.

        Parameters:
        jobRoleArn - 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • executionRoleArn

        ContainerProperties.Builder executionRoleArn​(String executionRoleArn)

        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.

        Parameters:
        executionRoleArn - 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • volumes

        ContainerProperties.Builder volumes​(Collection<Volume> volumes)

        A list of data volumes used in a job.

        Parameters:
        volumes - A list of data volumes used in a job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • volumes

        ContainerProperties.Builder volumes​(Volume... volumes)

        A list of data volumes used in a job.

        Parameters:
        volumes - A list of data volumes used in a job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • environment

        ContainerProperties.Builder environment​(Collection<KeyValuePair> 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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • environment

        ContainerProperties.Builder environment​(KeyValuePair... 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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • environment

        ContainerProperties.Builder environment​(Consumer<KeyValuePair.Builder>... 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.

        This is a convenience method that creates an instance of the KeyValuePair.Builder avoiding the need to create one manually via KeyValuePair.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #environment(List).

        Parameters:
        environment - a consumer that will call methods on KeyValuePair.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #environment(java.util.Collection)

      • readonlyRootFilesystem

        ContainerProperties.Builder readonlyRootFilesystem​(Boolean readonlyRootFilesystem)

        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.

        Parameters:
        readonlyRootFilesystem - 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • privileged

        ContainerProperties.Builder privileged​(Boolean privileged)

        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.

        Parameters:
        privileged - 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • ulimits

        ContainerProperties.Builder ulimits​(Collection<Ulimit> 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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • ulimits

        ContainerProperties.Builder ulimits​(Ulimit... 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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • ulimits

        ContainerProperties.Builder ulimits​(Consumer<Ulimit.Builder>... 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.

        This is a convenience method that creates an instance of the Ulimit.Builder avoiding the need to create one manually via Ulimit.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #ulimits(List).

        Parameters:
        ulimits - a consumer that will call methods on Ulimit.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #ulimits(java.util.Collection)

      • instanceType

        ContainerProperties.Builder instanceType​(String instanceType)

        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.

        Parameters:
        instanceType - 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • resourceRequirements

        ContainerProperties.Builder resourceRequirements​(Collection<ResourceRequirement> resourceRequirements)

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

        Parameters:
        resourceRequirements - The type and amount of resources to assign to a container. The supported resources include GPU, MEMORY, and VCPU.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • resourceRequirements

        ContainerProperties.Builder resourceRequirements​(ResourceRequirement... resourceRequirements)

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

        Parameters:
        resourceRequirements - The type and amount of resources to assign to a container. The supported resources include GPU, MEMORY, and VCPU.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • linuxParameters

        ContainerProperties.Builder linuxParameters​(LinuxParameters linuxParameters)

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

        Parameters:
        linuxParameters - Linux-specific modifications that are applied to the container, such as details for device mappings.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • logConfiguration

        ContainerProperties.Builder logConfiguration​(LogConfiguration 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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • logConfiguration

        default ContainerProperties.Builder logConfiguration​(Consumer<LogConfiguration.Builder> 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.

        This is a convenience method that creates an instance of the LogConfiguration.Builder avoiding the need to create one manually via LogConfiguration.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to logConfiguration(LogConfiguration).

        Parameters:
        logConfiguration - a consumer that will call methods on LogConfiguration.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        logConfiguration(LogConfiguration)

      • networkConfiguration

        ContainerProperties.Builder networkConfiguration​(NetworkConfiguration networkConfiguration)

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

        Parameters:
        networkConfiguration - The network configuration for jobs that are running on Fargate resources. Jobs that are running on EC2 resources must not specify this parameter.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • fargatePlatformConfiguration

        ContainerProperties.Builder fargatePlatformConfiguration​(FargatePlatformConfiguration fargatePlatformConfiguration)

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

        Parameters:
        fargatePlatformConfiguration - The platform configuration for jobs that are running on Fargate resources. Jobs that are running on EC2 resources must not specify this parameter.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • ephemeralStorage

        ContainerProperties.Builder ephemeralStorage​(EphemeralStorage 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • runtimePlatform

        ContainerProperties.Builder runtimePlatform​(RuntimePlatform runtimePlatform)
        Sets the value of the RuntimePlatform property for this object.
        Parameters:
        runtimePlatform - The new value for the RuntimePlatform property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.