Package software.amazon.awscdk.services.ecs

Class ContainerDefinitionOptions.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.ecs.ContainerDefinitionOptions.Jsii$Proxy

All Implemented Interfaces:

ContainerDefinitionOptions, software.amazon.jsii.JsiiSerializable

Enclosing interface:

ContainerDefinitionOptions

@Stability(Stable)
@Internal
public static final class ContainerDefinitionOptions.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements ContainerDefinitionOptions

An implementation for ContainerDefinitionOptions

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ecs.ContainerDefinitionOptions

ContainerDefinitionOptions.Builder, ContainerDefinitionOptions.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(ContainerDefinitionOptions.Builder builder)	Constructor that initializes the object based on literal property values passed by the ContainerDefinitionOptions.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final List<String>	getCommand()	The command that is passed to the container.
final String	getContainerName()	The name of the container.
final Number	getCpu()	The minimum number of CPU units to reserve for the container.
final Boolean	getDisableNetworking()	Specifies whether networking is disabled within the container.
final List<String>	getDnsSearchDomains()	A list of DNS search domains that are presented to the container.
final List<String>	getDnsServers()	A list of DNS servers that are presented to the container.
final Map<String,String>	getDockerLabels()	A key/value map of labels to add to the container.
final List<String>	getDockerSecurityOptions()	A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems.
final List<String>	getEntryPoint()	The ENTRYPOINT value to pass to the container.
final Map<String,String>	getEnvironment()	The environment variables to pass to the container.
final List<EnvironmentFile>	getEnvironmentFiles()	The environment files to pass to the container.
final Boolean	getEssential()	Specifies whether the container is marked essential.
final Map<String,String>	getExtraHosts()	A list of hostnames and IP address mappings to append to the /etc/hosts file on the container.
final Number	getGpuCount()	The number of GPUs assigned to the container.
final HealthCheck	getHealthCheck()	The health check command and associated configuration parameters for the container.
final String	getHostname()	The hostname to use for your container.
final ContainerImage	getImage()	The image used to start a container.
final List<String>	getInferenceAcceleratorResources()	The inference accelerators referenced by the container.
final LinuxParameters	getLinuxParameters()	Linux-specific modifications that are applied to the container, such as Linux kernel capabilities.
final LogDriver	getLogging()	The log configuration specification for the container.
final Number	getMemoryLimitMiB()	The amount (in MiB) of memory to present to the container.
final Number	getMemoryReservationMiB()	The soft limit (in MiB) of memory to reserve for the container.
final List<PortMapping>	getPortMappings()	The port mappings to add to the container definition.
final Boolean	getPrivileged()	Specifies whether the container is marked as privileged.
final Boolean	getReadonlyRootFilesystem()	When this parameter is true, the container is given read-only access to its root file system.
final Map<String,Secret>	getSecrets()	The secret environment variables to pass to the container.
final Duration	getStartTimeout()	Time duration (in seconds) to wait before giving up on resolving dependencies for a container.
final Duration	getStopTimeout()	Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own.
final List<SystemControl>	getSystemControls()	A list of namespaced kernel parameters to set in the container.
final String	getUser()	The user name to use inside the container.
final String	getWorkingDirectory()	The working directory in which to run commands inside the container.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(ContainerDefinitionOptions.Builder builder)

Constructor that initializes the object based on literal property values passed by the ContainerDefinitionOptions.Builder.

Method Details

getImage

public final ContainerImage getImage()

Description copied from interface: ContainerDefinitionOptions

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 either repository-url/image:tag or repository-url/image@digest. TODO: Update these to specify using classes of IContainerImage

Specified by:

getImage in interface ContainerDefinitionOptions

getCommand

public final List<String> getCommand()

Description copied from interface: ContainerDefinitionOptions

The command that is passed to the container.

If you provide a shell command as a single string, you have to quote command-line arguments.

Default: - CMD value built into container image.

Specified by:

getCommand in interface ContainerDefinitionOptions

getContainerName

public final String getContainerName()

Description copied from interface: ContainerDefinitionOptions

The name of the container.

Default: - id of node associated with ContainerDefinition.

Specified by:

getContainerName in interface ContainerDefinitionOptions

getCpu

public final Number getCpu()

Description copied from interface: ContainerDefinitionOptions

The minimum number of CPU units to reserve for the container.

Default: - No minimum CPU units reserved.

Specified by:

getCpu in interface ContainerDefinitionOptions

getDisableNetworking

public final Boolean getDisableNetworking()

Description copied from interface: ContainerDefinitionOptions

Specifies whether networking is disabled within the container.

When this parameter is true, networking is disabled within the container.

Default: false

Specified by:

getDisableNetworking in interface ContainerDefinitionOptions

getDnsSearchDomains

public final List<String> getDnsSearchDomains()

Description copied from interface: ContainerDefinitionOptions

A list of DNS search domains that are presented to the container.

Default: - No search domains.

Specified by:

getDnsSearchDomains in interface ContainerDefinitionOptions

getDnsServers

public final List<String> getDnsServers()

Description copied from interface: ContainerDefinitionOptions

A list of DNS servers that are presented to the container.

Default: - Default DNS servers.

Specified by:

getDnsServers in interface ContainerDefinitionOptions

getDockerLabels

public final Map<String,String> getDockerLabels()

Description copied from interface: ContainerDefinitionOptions

A key/value map of labels to add to the container.

Default: - No labels.

Specified by:

getDockerLabels in interface ContainerDefinitionOptions

getDockerSecurityOptions

public final List<String> getDockerSecurityOptions()

Description copied from interface: ContainerDefinitionOptions

A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems.

Default: - No security labels.

Specified by:

getDockerSecurityOptions in interface ContainerDefinitionOptions

getEntryPoint

public final List<String> getEntryPoint()

Description copied from interface: ContainerDefinitionOptions

The ENTRYPOINT value to pass to the container.

Default: - Entry point configured in container.

Specified by:

getEntryPoint in interface ContainerDefinitionOptions

See Also:

• https://docs.docker.com/engine/reference/builder/#entrypoint

getEnvironment

public final Map<String,String> getEnvironment()

Description copied from interface: ContainerDefinitionOptions

The environment variables to pass to the container.

Default: - No environment variables.

Specified by:

getEnvironment in interface ContainerDefinitionOptions

getEnvironmentFiles

public final List<EnvironmentFile> getEnvironmentFiles()

Description copied from interface: ContainerDefinitionOptions

The environment files to pass to the container.

Default: - No environment files.

Specified by:

getEnvironmentFiles in interface ContainerDefinitionOptions

See Also:

• https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html

getEssential

public final Boolean getEssential()

Description copied from interface: ContainerDefinitionOptions

Specifies whether the container is marked essential.

If the essential parameter of a container is marked as true, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the essential parameter of a container is marked as false, then its failure does not affect the rest of the containers in a task. All tasks must have at least one essential container.

If this parameter is omitted, a container is assumed to be essential.

Default: true

Specified by:

getEssential in interface ContainerDefinitionOptions

getExtraHosts

public final Map<String,String> getExtraHosts()

Description copied from interface: ContainerDefinitionOptions

A list of hostnames and IP address mappings to append to the /etc/hosts file on the container.

Default: - No extra hosts.

Specified by:

getExtraHosts in interface ContainerDefinitionOptions

getGpuCount

public final Number getGpuCount()

Description copied from interface: ContainerDefinitionOptions

The number of GPUs assigned to the container.

Default: - No GPUs assigned.

Specified by:

getGpuCount in interface ContainerDefinitionOptions

getHealthCheck

public final HealthCheck getHealthCheck()

Description copied from interface: ContainerDefinitionOptions

The health check command and associated configuration parameters for the container.

Default: - Health check configuration from container.

Specified by:

getHealthCheck in interface ContainerDefinitionOptions

getHostname

public final String getHostname()

Description copied from interface: ContainerDefinitionOptions

The hostname to use for your container.

Default: - Automatic hostname.

Specified by:

getHostname in interface ContainerDefinitionOptions

getInferenceAcceleratorResources

public final List<String> getInferenceAcceleratorResources()

Description copied from interface: ContainerDefinitionOptions

The inference accelerators referenced by the container.

Default: - No inference accelerators assigned.

Specified by:

getInferenceAcceleratorResources in interface ContainerDefinitionOptions

getLinuxParameters

public final LinuxParameters getLinuxParameters()

Description copied from interface: ContainerDefinitionOptions

Linux-specific modifications that are applied to the container, such as Linux kernel capabilities.

For more information see KernelCapabilities.

Default: - No Linux parameters.

Specified by:

getLinuxParameters in interface ContainerDefinitionOptions

getLogging

public final LogDriver getLogging()

Description copied from interface: ContainerDefinitionOptions

The log configuration specification for the container.

Default: - Containers use the same logging driver that the Docker daemon uses.

Specified by:

getLogging in interface ContainerDefinitionOptions

getMemoryLimitMiB

public final Number getMemoryLimitMiB()

Description copied from interface: ContainerDefinitionOptions

The amount (in MiB) of memory to present to the container.

If your container attempts to exceed the allocated memory, the container is terminated.

At least one of memoryLimitMiB and memoryReservationMiB is required for non-Fargate services.

Default: - No memory limit.

Specified by:

getMemoryLimitMiB in interface ContainerDefinitionOptions

getMemoryReservationMiB

public final Number getMemoryReservationMiB()

Description copied from interface: ContainerDefinitionOptions

The soft limit (in MiB) of memory to reserve for the container.

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 memoryLimitMiB and memoryReservationMiB is required for non-Fargate services.

Default: - No memory reserved.

Specified by:

getMemoryReservationMiB in interface ContainerDefinitionOptions

getPortMappings

public final List<PortMapping> getPortMappings()

Description copied from interface: ContainerDefinitionOptions

The port mappings to add to the container definition.

Default: - No ports are mapped.

Specified by:

getPortMappings in interface ContainerDefinitionOptions

getPrivileged

public final Boolean getPrivileged()

Description copied from interface: ContainerDefinitionOptions

Specifies whether the container is marked as privileged.

When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user).

Default: false

Specified by:

getPrivileged in interface ContainerDefinitionOptions

getReadonlyRootFilesystem

public final Boolean getReadonlyRootFilesystem()

Description copied from interface: ContainerDefinitionOptions

When this parameter is true, the container is given read-only access to its root file system.

Default: false

Specified by:

getReadonlyRootFilesystem in interface ContainerDefinitionOptions

getSecrets

public final Map<String,Secret> getSecrets()

Description copied from interface: ContainerDefinitionOptions

The secret environment variables to pass to the container.

Default: - No secret environment variables.

Specified by:

getSecrets in interface ContainerDefinitionOptions

getStartTimeout

public final Duration getStartTimeout()

Description copied from interface: ContainerDefinitionOptions

Time duration (in seconds) to wait before giving up on resolving dependencies for a container.

Default: - none

Specified by:

getStartTimeout in interface ContainerDefinitionOptions

getStopTimeout

public final Duration getStopTimeout()

Description copied from interface: ContainerDefinitionOptions

Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own.

Default: - none

Specified by:

getStopTimeout in interface ContainerDefinitionOptions

getSystemControls

public final List<SystemControl> getSystemControls()

Description copied from interface: ContainerDefinitionOptions

A list of namespaced kernel parameters to set in the container.

Default: - No system controls are set.

Specified by:

getSystemControls in interface ContainerDefinitionOptions

See Also:

• https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#container_definition_systemcontrols

getUser

public final String getUser()

Description copied from interface: ContainerDefinitionOptions

The user name to use inside the container.

Default: root

Specified by:

getUser in interface ContainerDefinitionOptions

getWorkingDirectory

public final String getWorkingDirectory()

Description copied from interface: ContainerDefinitionOptions

The working directory in which to run commands inside the container.

Default: /

Specified by:

getWorkingDirectory in interface ContainerDefinitionOptions

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object