Interface IEksContainerDefinition.Jsii$Default
- All Superinterfaces:
software.constructs.IConstruct
,software.constructs.IConstruct.Jsii$Default
,software.constructs.IDependable
,software.constructs.IDependable.Jsii$Default
,IEksContainerDefinition
,software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
IEksContainerDefinition.Jsii$Proxy
- Enclosing interface:
IEksContainerDefinition
IEksContainerDefinition
.-
Nested Class Summary
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy
Nested classes/interfaces inherited from interface software.constructs.IDependable
software.constructs.IDependable.Jsii$Default, software.constructs.IDependable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.batch.IEksContainerDefinition
IEksContainerDefinition.Jsii$Default, IEksContainerDefinition.Jsii$Proxy
-
Method Summary
Modifier and TypeMethodDescriptiondefault void
Mount a Volume to this container.getArgs()
An array of arguments to the entrypoint.The entrypoint for the container.default Number
The hard limit of CPUs to present to this container.default Number
The soft limit of CPUs to reserve for the container Must be an even multiple of 0.25.getEnv()
The environment variables to pass to this container.default Number
The hard limit of GPUs to present to this container.default Number
The soft limit of CPUs to reserve for the container Must be an even multiple of 0.25.default ContainerImage
getImage()
The image that this container will run.default ImagePullPolicy
The image pull policy for this container.default Size
The amount (in MiB) of memory to present to the container.default Size
The soft limit (in MiB) of memory to reserve for the container.default String
getName()
The name of this container.default software.constructs.Node
getNode()
The tree node.default Boolean
If specified, gives this container elevated permissions on the host container instance.default Boolean
If specified, gives this container readonly access to its root file system.default Number
If specified, the container is run as the specified group ID (gid
).default Boolean
If specified, the container is run as a user with auid
other than 0.default Number
If specified, this container is run as the specified user ID (uid
).The Volumes to mount to this container.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getNode
@Stability(Stable) @NotNull default software.constructs.Node getNode()The tree node.- Specified by:
getNode
in interfacesoftware.constructs.IConstruct
- Specified by:
getNode
in interfacesoftware.constructs.IConstruct.Jsii$Default
-
getImage
The image that this container will run.- Specified by:
getImage
in interfaceIEksContainerDefinition
-
getVolumes
The Volumes to mount to this container.Automatically added to the Pod.
- Specified by:
getVolumes
in interfaceIEksContainerDefinition
- See Also:
-
getArgs
An array of arguments to the entrypoint.If this isn't specified, the CMD of the container image is used. This corresponds to the args member in the Entrypoint portion of the Pod in Kubernetes. Environment variable references are expanded using the container's environment. If the referenced environment variable doesn't exist, the reference in the command isn't changed. For example, if the reference is to "$(NAME1)" and the NAME1 environment variable doesn't exist, the command string will remain "$(NAME1)." $$ is replaced with $, and the resulting string isn't expanded. or example, $$(VAR_NAME) is passed as $(VAR_NAME) whether or not the VAR_NAME environment variable exists.
- Specified by:
getArgs
in interfaceIEksContainerDefinition
- See Also:
-
getCommand
The entrypoint for the container.This isn't run within a shell. If this isn't specified, the
ENTRYPOINT
of the container image is used. Environment variable references are expanded using the container's environment. If the referenced environment variable doesn't exist, the reference in the command isn't changed. For example, if the reference is to"$(NAME1)"
and theNAME1
environment variable doesn't exist, the command string will remain"$(NAME1)."
$$
is replaced with$
and the resulting string isn't expanded. For example,$$(VAR_NAME)
will be passed as$(VAR_NAME)
whether or not theVAR_NAME
environment variable exists.The entrypoint can't be updated.
- Specified by:
getCommand
in interfaceIEksContainerDefinition
- See Also:
-
getCpuLimit
The hard limit of CPUs to present to this container. Must be an even multiple of 0.25.If your container attempts to exceed this limit, it will be terminated.
At least one of
cpuReservation
andcpuLimit
is required. If both are specified, thencpuLimit
must be at least as large ascpuReservation
.Default: - No CPU limit
- Specified by:
getCpuLimit
in interfaceIEksContainerDefinition
- See Also:
-
getCpuReservation
The soft limit of CPUs to reserve for the container Must be an even multiple of 0.25.The container will given at least this many CPUs, but may consume more.
At least one of
cpuReservation
andcpuLimit
is required. If both are specified, thencpuLimit
must be at least as large ascpuReservation
.Default: - No CPUs reserved
- Specified by:
getCpuReservation
in interfaceIEksContainerDefinition
- See Also:
-
getEnv
The environment variables to pass to this container.Note: Environment variables cannot start with "AWS_BATCH". This naming convention is reserved for variables that AWS Batch sets.
- Specified by:
getEnv
in interfaceIEksContainerDefinition
-
getGpuLimit
The hard limit of GPUs to present to this container.If your container attempts to exceed this limit, it will be terminated.
If both
gpuReservation
andgpuLimit
are specified, thengpuLimit
must be equal togpuReservation
.Default: - No GPU limit
- Specified by:
getGpuLimit
in interfaceIEksContainerDefinition
- See Also:
-
getGpuReservation
The soft limit of CPUs to reserve for the container Must be an even multiple of 0.25.The container will given at least this many CPUs, but may consume more.
If both
gpuReservation
andgpuLimit
are specified, thengpuLimit
must be equal togpuReservation
.Default: - No GPUs reserved
- Specified by:
getGpuReservation
in interfaceIEksContainerDefinition
- See Also:
-
getImagePullPolicy
The image pull policy for this container.Default: - `ALWAYS` if the `:latest` tag is specified, `IF_NOT_PRESENT` otherwise
- Specified by:
getImagePullPolicy
in interfaceIEksContainerDefinition
- See Also:
-
getMemoryLimit
The amount (in MiB) of memory to present to the container.If your container attempts to exceed the allocated memory, it will be terminated.
Must be larger that 4 MiB
At least one of
memoryLimit
andmemoryReservation
is requiredNote: To maximize your resource utilization, provide your jobs with as much memory as possible for the specific instance type that you are using.
Default: - No memory limit
- Specified by:
getMemoryLimit
in interfaceIEksContainerDefinition
- See Also:
-
getMemoryReservation
The soft limit (in MiB) of memory to reserve for the container.Your container will be given at least this much memory, but may consume more.
Must be larger that 4 MiB
When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the memory parameter (if applicable), or all of the available memory on the container instance, whichever comes first.
At least one of
memoryLimit
andmemoryReservation
is required. If both are specified, thenmemoryLimit
must be equal tomemoryReservation
Note: To maximize your resource utilization, provide your jobs with as much memory as possible for the specific instance type that you are using.
Default: - No memory reserved
- Specified by:
getMemoryReservation
in interfaceIEksContainerDefinition
- See Also:
-
getName
The name of this container.Default: : `'Default'`
- Specified by:
getName
in interfaceIEksContainerDefinition
-
getPrivileged
If specified, gives this container elevated permissions on the host container instance.The level of permissions are similar to the root user permissions.
This parameter maps to
privileged
policy in the Privileged pod security policies in the Kubernetes documentation.Note: this is only compatible with Kubernetes < v1.25
Default: false
- Specified by:
getPrivileged
in interfaceIEksContainerDefinition
- See Also:
-
getReadonlyRootFilesystem
If specified, gives this container readonly access to its root file system.This parameter maps to
ReadOnlyRootFilesystem
policy in the Volumes and file systems pod security policies in the Kubernetes documentation.Note: this is only compatible with Kubernetes < v1.25
Default: false
- Specified by:
getReadonlyRootFilesystem
in interfaceIEksContainerDefinition
- See Also:
-
getRunAsGroup
If specified, the container is run as the specified group ID (gid
).If this parameter isn't specified, the default is the group that's specified in the image metadata. This parameter maps to
RunAsGroup
andMustRunAs
policy in the Users and groups pod security policies in the Kubernetes documentation.Note: this is only compatible with Kubernetes < v1.25
Default: none
- Specified by:
getRunAsGroup
in interfaceIEksContainerDefinition
- See Also:
-
getRunAsRoot
If specified, the container is run as a user with auid
other than 0.Otherwise, no such rule is enforced. This parameter maps to
RunAsUser
andMustRunAsNonRoot
policy in the Users and groups pod security policies in the Kubernetes documentation.Note: this is only compatible with Kubernetes < v1.25
Default: - the container is *not* required to run as a non-root user
- Specified by:
getRunAsRoot
in interfaceIEksContainerDefinition
- See Also:
-
getRunAsUser
If specified, this container is run as the specified user ID (uid
).This parameter maps to
RunAsUser
andMustRunAs
policy in the Users and groups pod security policies in the Kubernetes documentation.Note: this is only compatible with Kubernetes < v1.25
Default: - the user that is specified in the image metadata.
- Specified by:
getRunAsUser
in interfaceIEksContainerDefinition
- See Also:
-
addVolume
Mount a Volume to this container.Automatically added to the Pod.
- Specified by:
addVolume
in interfaceIEksContainerDefinition
- Parameters:
volume
- This parameter is required.
-