@Stability(value=Stable) public static final class CfnJobDefinition.ContainerPropertiesProperty.Builder extends Object implements software.amazon.jsii.Builder<CfnJobDefinition.ContainerPropertiesProperty>
CfnJobDefinition.ContainerPropertiesProperty| Constructor and Description |
|---|
Builder() |
@Stability(value=Stable) public CfnJobDefinition.ContainerPropertiesProperty.Builder image(String image)
CfnJobDefinition.ContainerPropertiesProperty.getImage()image - The image used to start a container. This parameter is required.
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.
registry/repository[:tag] or registry/repository[@digest] naming conventions. For example, public.ecr.aws/ *registry_alias* / *my-web-app* : *latest* .012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name> ).ubuntu or mongo ).amazon/amazon-ecs-agent ).quay.io/assemblyline/ubuntu ).this@Stability(value=Stable) public CfnJobDefinition.ContainerPropertiesProperty.Builder command(List<String> command)
CfnJobDefinition.ContainerPropertiesProperty.getCommand()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 .this@Stability(value=Stable) public CfnJobDefinition.ContainerPropertiesProperty.Builder environment(IResolvable environment)
CfnJobDefinition.ContainerPropertiesProperty.getEnvironment()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 must not start with
AWS_BATCH; this naming convention is reserved for variables that are set by the AWS Batch service.
this@Stability(value=Stable) public CfnJobDefinition.ContainerPropertiesProperty.Builder environment(List<? extends Object> environment)
CfnJobDefinition.ContainerPropertiesProperty.getEnvironment()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 must not start with
AWS_BATCH; this naming convention is reserved for variables that are set by the AWS Batch service.
this@Stability(value=Stable) public CfnJobDefinition.ContainerPropertiesProperty.Builder executionRoleArn(String executionRoleArn)
CfnJobDefinition.ContainerPropertiesProperty.getExecutionRoleArn()executionRoleArn - 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 .this@Stability(value=Stable) public CfnJobDefinition.ContainerPropertiesProperty.Builder fargatePlatformConfiguration(CfnJobDefinition.FargatePlatformConfigurationProperty 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.this@Stability(value=Stable) public CfnJobDefinition.ContainerPropertiesProperty.Builder fargatePlatformConfiguration(IResolvable 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.this@Stability(value=Stable) public CfnJobDefinition.ContainerPropertiesProperty.Builder instanceType(String instanceType)
CfnJobDefinition.ContainerPropertiesProperty.getInstanceType()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.
this@Stability(value=Stable) public CfnJobDefinition.ContainerPropertiesProperty.Builder jobRoleArn(String jobRoleArn)
CfnJobDefinition.ContainerPropertiesProperty.getJobRoleArn()jobRoleArn - 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 .this@Stability(value=Stable) public CfnJobDefinition.ContainerPropertiesProperty.Builder linuxParameters(CfnJobDefinition.LinuxParametersProperty linuxParameters)
CfnJobDefinition.ContainerPropertiesProperty.getLinuxParameters()linuxParameters - Linux-specific modifications that are applied to the container, such as details for device mappings.this@Stability(value=Stable) public CfnJobDefinition.ContainerPropertiesProperty.Builder linuxParameters(IResolvable linuxParameters)
CfnJobDefinition.ContainerPropertiesProperty.getLinuxParameters()linuxParameters - Linux-specific modifications that are applied to the container, such as details for device mappings.this@Stability(value=Stable) public CfnJobDefinition.ContainerPropertiesProperty.Builder logConfiguration(CfnJobDefinition.LogConfigurationProperty logConfiguration)
CfnJobDefinition.ContainerPropertiesProperty.getLogConfiguration()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
LogConfigurationdata 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
ECS_AVAILABLE_LOGGING_DRIVERSenvironment 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@Stability(value=Stable) public CfnJobDefinition.ContainerPropertiesProperty.Builder logConfiguration(IResolvable logConfiguration)
CfnJobDefinition.ContainerPropertiesProperty.getLogConfiguration()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
LogConfigurationdata 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
ECS_AVAILABLE_LOGGING_DRIVERSenvironment 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@Stability(value=Stable) public CfnJobDefinition.ContainerPropertiesProperty.Builder memory(Number memory)
CfnJobDefinition.ContainerPropertiesProperty.getMemory()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 running 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.this@Stability(value=Stable) public CfnJobDefinition.ContainerPropertiesProperty.Builder mountPoints(IResolvable mountPoints)
CfnJobDefinition.ContainerPropertiesProperty.getMountPoints()mountPoints - 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 .this@Stability(value=Stable) public CfnJobDefinition.ContainerPropertiesProperty.Builder mountPoints(List<? extends Object> mountPoints)
CfnJobDefinition.ContainerPropertiesProperty.getMountPoints()mountPoints - 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 .this@Stability(value=Stable) public CfnJobDefinition.ContainerPropertiesProperty.Builder networkConfiguration(CfnJobDefinition.NetworkConfigurationProperty networkConfiguration)
CfnJobDefinition.ContainerPropertiesProperty.getNetworkConfiguration()networkConfiguration - The network configuration for jobs that are running on Fargate resources.
Jobs that are running on EC2 resources must not specify this parameter.this@Stability(value=Stable) public CfnJobDefinition.ContainerPropertiesProperty.Builder networkConfiguration(IResolvable networkConfiguration)
CfnJobDefinition.ContainerPropertiesProperty.getNetworkConfiguration()networkConfiguration - The network configuration for jobs that are running on Fargate resources.
Jobs that are running on EC2 resources must not specify this parameter.this@Stability(value=Stable) public CfnJobDefinition.ContainerPropertiesProperty.Builder privileged(Boolean privileged)
CfnJobDefinition.ContainerPropertiesProperty.getPrivileged()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.
this@Stability(value=Stable) public CfnJobDefinition.ContainerPropertiesProperty.Builder privileged(IResolvable privileged)
CfnJobDefinition.ContainerPropertiesProperty.getPrivileged()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.
this@Stability(value=Stable) public CfnJobDefinition.ContainerPropertiesProperty.Builder readonlyRootFilesystem(Boolean readonlyRootFilesystem)
CfnJobDefinition.ContainerPropertiesProperty.getReadonlyRootFilesystem()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 .this@Stability(value=Stable) public CfnJobDefinition.ContainerPropertiesProperty.Builder readonlyRootFilesystem(IResolvable readonlyRootFilesystem)
CfnJobDefinition.ContainerPropertiesProperty.getReadonlyRootFilesystem()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 .this@Stability(value=Stable) public CfnJobDefinition.ContainerPropertiesProperty.Builder resourceRequirements(IResolvable resourceRequirements)
CfnJobDefinition.ContainerPropertiesProperty.getResourceRequirements()resourceRequirements - The type and amount of resources to assign to a container.
The supported resources include GPU , MEMORY , and VCPU .this@Stability(value=Stable) public CfnJobDefinition.ContainerPropertiesProperty.Builder resourceRequirements(List<? extends Object> resourceRequirements)
CfnJobDefinition.ContainerPropertiesProperty.getResourceRequirements()resourceRequirements - The type and amount of resources to assign to a container.
The supported resources include GPU , MEMORY , and VCPU .this@Stability(value=Stable) public CfnJobDefinition.ContainerPropertiesProperty.Builder secrets(IResolvable secrets)
CfnJobDefinition.ContainerPropertiesProperty.getSecrets()secrets - The secrets for the container.
For more information, see Specifying sensitive data in the AWS Batch User Guide .this@Stability(value=Stable) public CfnJobDefinition.ContainerPropertiesProperty.Builder secrets(List<? extends Object> secrets)
CfnJobDefinition.ContainerPropertiesProperty.getSecrets()secrets - The secrets for the container.
For more information, see Specifying sensitive data in the AWS Batch User Guide .this@Stability(value=Stable) public CfnJobDefinition.ContainerPropertiesProperty.Builder ulimits(IResolvable ulimits)
CfnJobDefinition.ContainerPropertiesProperty.getUlimits()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@Stability(value=Stable) public CfnJobDefinition.ContainerPropertiesProperty.Builder ulimits(List<? extends Object> ulimits)
CfnJobDefinition.ContainerPropertiesProperty.getUlimits()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@Stability(value=Stable) public CfnJobDefinition.ContainerPropertiesProperty.Builder user(String user)
CfnJobDefinition.ContainerPropertiesProperty.getUser()user - 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 .this@Stability(value=Stable) public CfnJobDefinition.ContainerPropertiesProperty.Builder vcpus(Number vcpus)
CfnJobDefinition.ContainerPropertiesProperty.getVcpus()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.
this@Stability(value=Stable) public CfnJobDefinition.ContainerPropertiesProperty.Builder volumes(IResolvable volumes)
CfnJobDefinition.ContainerPropertiesProperty.getVolumes()volumes - A list of data volumes used in a job.this@Stability(value=Stable) public CfnJobDefinition.ContainerPropertiesProperty.Builder volumes(List<? extends Object> volumes)
CfnJobDefinition.ContainerPropertiesProperty.getVolumes()volumes - A list of data volumes used in a job.this@Stability(value=Stable) public CfnJobDefinition.ContainerPropertiesProperty build()
build in interface software.amazon.jsii.Builder<CfnJobDefinition.ContainerPropertiesProperty>CfnJobDefinition.ContainerPropertiesPropertyNullPointerException - if any required attribute was not providedCopyright © 2022. All rights reserved.