@Generated(value="software.amazon.awssdk:codegen") public class ContainerProperties extends Object implements StructuredPojo, ToCopyableBuilder<ContainerProperties.Builder,ContainerProperties>
Container properties are used in job definitions to describe the container that is launched as part of a job.
Modifier and Type | Class and Description |
---|---|
static interface |
ContainerProperties.Builder |
Modifier and Type | Method and Description |
---|---|
static ContainerProperties.Builder |
builder() |
List<String> |
command()
The command that is passed to the container.
|
List<KeyValuePair> |
environment()
The environment variables to pass to a container.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
String |
image()
The image used to start a container.
|
String |
jobRoleArn()
The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
Integer |
memory()
The hard limit (in MiB) of memory to present to the container.
|
List<MountPoint> |
mountPoints()
The mount points for data volumes in your container.
|
Boolean |
privileged()
When this parameter is true, the container is given elevated privileges on the host container instance (similar
to the
root user). |
Boolean |
readonlyRootFilesystem()
When this parameter is true, the container is given read-only access to its root file system.
|
static Class<? extends ContainerProperties.Builder> |
serializableBuilderClass() |
ContainerProperties.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
List<Ulimit> |
ulimits()
A list of
ulimits to set in the container. |
String |
user()
The user name to use inside the container.
|
Integer |
vcpus()
The number of vCPUs reserved for the container.
|
List<Volume> |
volumes()
A list of data volumes used in a job.
|
copy
public 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
. 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.
Images in Amazon ECR repositories use the full registry and repository URI (for example,
012345678910.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
).
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.
Images in Amazon ECR repositories use the full registry and repository URI (for example,
012345678910.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
).
public Integer vcpus()
The number of vCPUs reserved for the container. This parameter maps to CpuShares
in the Create a
container section of the Docker Remote API and the
--cpu-shares
option to docker run. Each
vCPU is equivalent to 1,024 CPU shares. You must specify at least 1 vCPU.
CpuShares
in the Create a
container section of the Docker Remote API and
the --cpu-shares
option to docker
run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least 1 vCPU.public Integer memory()
The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory
specified here, the container is killed. This parameter maps to Memory
in the Create a
container section of the Docker Remote API and the
--memory
option to docker run. You must
specify at least 4 MiB of memory for a job.
Memory
in the Create a
container section of the Docker Remote API and
the --memory
option to docker
run. You must specify at least 4 MiB of memory for a job.public List<String> command()
The command that is 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
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.public String jobRoleArn()
The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions.
public List<Volume> volumes()
A list of data volumes used in a job.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public List<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 do not recommend using plain text 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
Env
in the Create a
container section of the Docker Remote API and
the --env
option to docker
run. We do not recommend using plain text 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.
public List<MountPoint> 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
Volumes
in the
Create
a container section of the Docker Remote API and
the --volume
option to docker
run.public 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
.
ReadonlyRootfs
in the Create a
container section of the Docker Remote API and
the --read-only
option to docker run
.public Boolean privileged()
When this parameter is true, the container is given elevated privileges 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.
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.public List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
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.public String 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.
User
in the Create a
container section of the Docker Remote API and
the --user
option to docker run.public ContainerProperties.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<ContainerProperties.Builder,ContainerProperties>
public static ContainerProperties.Builder builder()
public static Class<? extends ContainerProperties.Builder> serializableBuilderClass()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.