com.monsanto.arch.cloudformation.model.resource
JobContainerProperties
Companion object JobContainerProperties
case class JobContainerProperties(Image: Token[String], Memory: Token[Int], Vcpus: Token[Int], Command: Option[TokenSeq[String]] = None, Environment: Option[Seq[Environment]] = None, JobRoleArn: Option[Token[String]] = None, MountPoints: Option[Seq[MountPoint]] = None, Volumes: Option[Seq[VolumeDefinition]] = None, User: Option[Token[String]] = None, Privileged: Option[Boolean] = None, ReadonlyRootFilesystem: Option[Boolean] = None, Ulimits: Option[Seq[Ulimit]] = None) extends Product with Serializable
The ContainerProperties
property type specifies various properties specific to container-based jobs.
- 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 toImage
in the Create a container section of the Docker Remote API and theIMAGE
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
ormongo
). - 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
).
- Images in Amazon ECR repositories use the full registry and repository URI (for example,
- 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.- 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.- 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 theCOMMAND
parameter to docker run.- 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. Important We do not recommend using plain text environment variables for sensitive information, such as credential data.- JobRoleArn
The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions.
- 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.- Volumes
A list of data volumes used in a job.
- 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.- 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 toPrivileged
in the Create a container section of the Docker Remote API and the--privileged
option to docker run.- 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.- Ulimits
A list of
ulimits
to set in the container. This parameter maps toUlimits
in the Create a container section of the Docker Remote API and the--ulimit
option to docker run.
- Alphabetic
- By Inheritance
- JobContainerProperties
- Serializable
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
JobContainerProperties(Image: Token[String], Memory: Token[Int], Vcpus: Token[Int], Command: Option[TokenSeq[String]] = None, Environment: Option[Seq[Environment]] = None, JobRoleArn: Option[Token[String]] = None, MountPoints: Option[Seq[MountPoint]] = None, Volumes: Option[Seq[VolumeDefinition]] = None, User: Option[Token[String]] = None, Privileged: Option[Boolean] = None, ReadonlyRootFilesystem: Option[Boolean] = None, Ulimits: Option[Seq[Ulimit]] = None)
- 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 toImage
in the Create a container section of the Docker Remote API and theIMAGE
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
ormongo
). - 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
).
- Images in Amazon ECR repositories use the full registry and repository URI (for example,
- 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.- 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.- 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 theCOMMAND
parameter to docker run.- 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. Important We do not recommend using plain text environment variables for sensitive information, such as credential data.- JobRoleArn
The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions.
- 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.- Volumes
A list of data volumes used in a job.
- 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.- 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 toPrivileged
in the Create a container section of the Docker Remote API and the--privileged
option to docker run.- 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.- Ulimits
A list of
ulimits
to set in the container. This parameter maps toUlimits
in the Create a container section of the Docker Remote API and the--ulimit
option to docker run.
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val Command: Option[TokenSeq[String]]
- val Environment: Option[Seq[Environment]]
- val Image: Token[String]
- val JobRoleArn: Option[Token[String]]
- val Memory: Token[Int]
- val MountPoints: Option[Seq[MountPoint]]
- val Privileged: Option[Boolean]
- val ReadonlyRootFilesystem: Option[Boolean]
- val Ulimits: Option[Seq[Ulimit]]
- val User: Option[Token[String]]
- val Vcpus: Token[Int]
- val Volumes: Option[Seq[VolumeDefinition]]
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )