ContainerDefinitionProps.Jsii$Proxy (software.amazon.awscdk:aws-cdk-lib 2.0.0-rc.10 API)

java.lang.Object
- software.amazon.jsii.JsiiObject
- - software.amazon.awscdk.services.ecs.ContainerDefinitionProps.Jsii$Proxy

All Implemented Interfaces:

ContainerDefinitionOptions, ContainerDefinitionProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

ContainerDefinitionProps
```
@Stability(value=Experimental)
 @Internal
public static final class ContainerDefinitionProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements ContainerDefinitionProps
```
An implementation for ContainerDefinitionProps

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.ContainerDefinitionProps
  ContainerDefinitionProps.Builder, ContainerDefinitionProps.Jsii$Proxy

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)` Constructor that initializes the object based on values retrieved from the JsiiObject.
`protected`	Jsii$Proxy(TaskDefinition taskDefinition, ContainerImage image, List<String> command, String containerName, Number cpu, Boolean disableNetworking, List<String> dnsSearchDomains, List<String> dnsServers, Map<String,String> dockerLabels, List<String> dockerSecurityOptions, List<String> entryPoint, Map<String,String> environment, List<? extends EnvironmentFile> environmentFiles, Boolean essential, Map<String,String> extraHosts, Number gpuCount, HealthCheck healthCheck, String hostname, List<String> inferenceAcceleratorResources, LinuxParameters linuxParameters, LogDriver logging, Number memoryLimitMiB, Number memoryReservationMiB, List<? extends PortMapping> portMappings, Boolean privileged, Boolean readonlyRootFilesystem, Map<String,? extends Secret> secrets, Duration startTimeout, Duration stopTimeout, String user, String workingDirectory) Constructor that initializes the object based on literal property values passed by the `ContainerDefinitionProps.Builder`.

Method Summary

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

Methods inherited from interface software.amazon.awscdk.services.ecs.ContainerDefinitionProps
builder

- Constructor Detail
  - 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(TaskDefinition taskDefinition,
                     ContainerImage image,
                     List<String> command,
                     String containerName,
                     Number cpu,
                     Boolean disableNetworking,
                     List<String> dnsSearchDomains,
                     List<String> dnsServers,
                     Map<String,String> dockerLabels,
                     List<String> dockerSecurityOptions,
                     List<String> entryPoint,
                     Map<String,String> environment,
                     List<? extends EnvironmentFile> environmentFiles,
                     Boolean essential,
                     Map<String,String> extraHosts,
                     Number gpuCount,
                     HealthCheck healthCheck,
                     String hostname,
                     List<String> inferenceAcceleratorResources,
                     LinuxParameters linuxParameters,
                     LogDriver logging,
                     Number memoryLimitMiB,
                     Number memoryReservationMiB,
                     List<? extends PortMapping> portMappings,
                     Boolean privileged,
                     Boolean readonlyRootFilesystem,
                     Map<String,? extends Secret> secrets,
                     Duration startTimeout,
                     Duration stopTimeout,
                     String user,
                     String workingDirectory)
```
    Constructor that initializes the object based on literal property values passed by the ContainerDefinitionProps.Builder.
- Method Detail
  - getTaskDefinition
```
public final TaskDefinition getTaskDefinition()
```
    Description copied from interface: ContainerDefinitionProps
    
    (experimental) The name of the task definition that includes this container definition.
    [disable-awslint:ref-via-interface]
    
    Specified by:
    
    getTaskDefinition in interface ContainerDefinitionProps
  - getImage
```
public final ContainerImage getImage()
```
    Description copied from interface: ContainerDefinitionOptions
    
    (experimental) 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
    
    (experimental) 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
    
    (experimental) 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
    
    (experimental) 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
    
    (experimental) 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
    
    (experimental) 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
    
    (experimental) 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
    
    (experimental) 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
    
    (experimental) 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
    
    (experimental) 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
    
    (experimental) 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
    
    (experimental) 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
    
    (experimental) 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
    
    (experimental) 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
    
    (experimental) 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
    
    (experimental) 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
    
    (experimental) 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
    
    (experimental) 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
    
    (experimental) 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
    
    (experimental) 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
    
    (experimental) 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
    
    (experimental) 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
    
    (experimental) 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
    
    (experimental) 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
    
    (experimental) 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
    
    (experimental) 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
    
    (experimental) 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
    
    (experimental) 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
  - getUser
```
public final String getUser()
```
    Description copied from interface: ContainerDefinitionOptions
    
    (experimental) 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
    
    (experimental) 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

Class ContainerDefinitionProps.Jsii$Proxy

Nested Class Summary

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

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

Constructor Summary

Method Summary

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awscdk.services.ecs.ContainerDefinitionProps

Constructor Detail

Jsii$Proxy

Jsii$Proxy

Method Detail

getTaskDefinition

getImage

getCommand

getContainerName

getCpu

getDisableNetworking

getDnsSearchDomains

getDnsServers

getDockerLabels

getDockerSecurityOptions

getEntryPoint

getEnvironment

getEnvironmentFiles

getEssential

getExtraHosts

getGpuCount

getHealthCheck

getHostname

getInferenceAcceleratorResources

getLinuxParameters

getLogging

getMemoryLimitMiB

getMemoryReservationMiB

getPortMappings

getPrivileged

getReadonlyRootFilesystem

getSecrets

getStartTimeout

getStopTimeout

getUser

getWorkingDirectory

$jsii$toJson

equals

hashCode