public static final class CfnJobDefinition.ContainerPropertiesProperty.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CfnJobDefinition.ContainerPropertiesProperty
CfnJobDefinition.ContainerPropertiesProperty
CfnJobDefinition.ContainerPropertiesProperty.Builder, CfnJobDefinition.ContainerPropertiesProperty.Jsii$Proxy
Modifier | Constructor and Description |
---|---|
protected |
Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
Constructor that initializes the object based on values retrieved from the JsiiObject.
|
Modifier and Type | Method and Description |
---|---|
com.fasterxml.jackson.databind.JsonNode |
$jsii$toJson() |
boolean |
equals(java.lang.Object o) |
java.util.List<java.lang.String> |
getCommand()
The command that's passed to the container.
|
java.lang.Object |
getEnvironment()
The environment variables to pass to a container.
|
java.lang.String |
getExecutionRoleArn()
The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume.
|
java.lang.Object |
getFargatePlatformConfiguration()
The platform configuration for jobs that are running on Fargate resources.
|
java.lang.String |
getImage()
The image used to start a container.
|
java.lang.String |
getInstanceType()
The instance type to use for a multi-node parallel job.
|
java.lang.String |
getJobRoleArn()
The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions.
|
java.lang.Object |
getLinuxParameters()
Linux-specific modifications that are applied to the container, such as details for device mappings.
|
java.lang.Object |
getLogConfiguration()
The log configuration specification for the container.
|
java.lang.Number |
getMemory()
This parameter is deprecated, use `resourceRequirements` to specify the memory requirements for the job definition.
|
java.lang.Object |
getMountPoints()
The mount points for data volumes in your container.
|
java.lang.Object |
getNetworkConfiguration()
The network configuration for jobs that are running on Fargate resources.
|
java.lang.Object |
getPrivileged()
When this parameter is true, the container is given elevated permissions on the host container instance (similar to the `root` user).
|
java.lang.Object |
getReadonlyRootFilesystem()
When this parameter is true, the container is given read-only access to its root file system.
|
java.lang.Object |
getResourceRequirements()
The type and amount of resources to assign to a container.
|
java.lang.Object |
getSecrets()
The secrets for the container.
|
java.lang.Object |
getUlimits()
A list of `ulimits` to set in the container.
|
java.lang.String |
getUser()
The user name to use inside the container.
|
java.lang.Number |
getVcpus()
This parameter is deprecated, use `resourceRequirements` to specify the vCPU requirements for the job definition.
|
java.lang.Object |
getVolumes()
A list of data volumes used in a job.
|
int |
hashCode() |
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
builder
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
objRef
- Reference to the JSII managed object.public final java.lang.String getImage()
CfnJobDefinition.ContainerPropertiesProperty
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
).getImage
in interface CfnJobDefinition.ContainerPropertiesProperty
public final java.util.List<java.lang.String> getCommand()
CfnJobDefinition.ContainerPropertiesProperty
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 .
getCommand
in interface CfnJobDefinition.ContainerPropertiesProperty
public final java.lang.Object getEnvironment()
CfnJobDefinition.ContainerPropertiesProperty
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.
getEnvironment
in interface CfnJobDefinition.ContainerPropertiesProperty
public final java.lang.String getExecutionRoleArn()
CfnJobDefinition.ContainerPropertiesProperty
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 .
getExecutionRoleArn
in interface CfnJobDefinition.ContainerPropertiesProperty
public final java.lang.Object getFargatePlatformConfiguration()
CfnJobDefinition.ContainerPropertiesProperty
Jobs that are running on EC2 resources must not specify this parameter.
getFargatePlatformConfiguration
in interface CfnJobDefinition.ContainerPropertiesProperty
public final java.lang.String getInstanceType()
CfnJobDefinition.ContainerPropertiesProperty
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.
getInstanceType
in interface CfnJobDefinition.ContainerPropertiesProperty
public final java.lang.String getJobRoleArn()
CfnJobDefinition.ContainerPropertiesProperty
For more information, see IAM roles for tasks in the Amazon Elastic Container Service Developer Guide .
getJobRoleArn
in interface CfnJobDefinition.ContainerPropertiesProperty
public final java.lang.Object getLinuxParameters()
CfnJobDefinition.ContainerPropertiesProperty
getLinuxParameters
in interface CfnJobDefinition.ContainerPropertiesProperty
public final java.lang.Object getLogConfiguration()
CfnJobDefinition.ContainerPropertiesProperty
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
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 .
getLogConfiguration
in interface CfnJobDefinition.ContainerPropertiesProperty
public final java.lang.Number getMemory()
CfnJobDefinition.ContainerPropertiesProperty
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.
getMemory
in interface CfnJobDefinition.ContainerPropertiesProperty
public final java.lang.Object getMountPoints()
CfnJobDefinition.ContainerPropertiesProperty
This parameter maps to Volumes
in the Create a container section of the Docker Remote API and the --volume
option to docker run .
getMountPoints
in interface CfnJobDefinition.ContainerPropertiesProperty
public final java.lang.Object getNetworkConfiguration()
CfnJobDefinition.ContainerPropertiesProperty
Jobs that are running on EC2 resources must not specify this parameter.
getNetworkConfiguration
in interface CfnJobDefinition.ContainerPropertiesProperty
public final java.lang.Object getPrivileged()
CfnJobDefinition.ContainerPropertiesProperty
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.
getPrivileged
in interface CfnJobDefinition.ContainerPropertiesProperty
public final java.lang.Object getReadonlyRootFilesystem()
CfnJobDefinition.ContainerPropertiesProperty
This parameter maps to ReadonlyRootfs
in the Create a container section of the Docker Remote API and the --read-only
option to docker run
.
getReadonlyRootFilesystem
in interface CfnJobDefinition.ContainerPropertiesProperty
public final java.lang.Object getResourceRequirements()
CfnJobDefinition.ContainerPropertiesProperty
The supported resources include GPU
, MEMORY
, and VCPU
.
getResourceRequirements
in interface CfnJobDefinition.ContainerPropertiesProperty
public final java.lang.Object getSecrets()
CfnJobDefinition.ContainerPropertiesProperty
For more information, see Specifying sensitive data in the AWS Batch User Guide .
getSecrets
in interface CfnJobDefinition.ContainerPropertiesProperty
public final java.lang.Object getUlimits()
CfnJobDefinition.ContainerPropertiesProperty
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.
getUlimits
in interface CfnJobDefinition.ContainerPropertiesProperty
public final java.lang.String getUser()
CfnJobDefinition.ContainerPropertiesProperty
This parameter maps to User
in the Create a container section of the Docker Remote API and the --user
option to docker run .
getUser
in interface CfnJobDefinition.ContainerPropertiesProperty
public final java.lang.Number getVcpus()
CfnJobDefinition.ContainerPropertiesProperty
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.
getVcpus
in interface CfnJobDefinition.ContainerPropertiesProperty
public final java.lang.Object getVolumes()
CfnJobDefinition.ContainerPropertiesProperty
getVolumes
in interface CfnJobDefinition.ContainerPropertiesProperty
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
public final boolean equals(java.lang.Object o)
public final int hashCode()