ContainerDefinition

java.lang.Object
- software.constructs.Construct
- - software.amazon.awscdk.core.Construct
  - - software.amazon.awscdk.services.ecs.ContainerDefinition

All Implemented Interfaces:: IConstruct, IDependable

Direct Known Subclasses:: FirelensLogRouter

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-28T18:14:44.824Z")
public class ContainerDefinition
extends Construct

A container definition is used in a task definition to describe the containers that are launched as part of a task.

Example:

 TaskDefinition taskDefinition;
 Cluster cluster;
 // Add a container to the task definition
 ContainerDefinition specificContainer = taskDefinition.addContainer("Container", ContainerDefinitionOptions.builder()
         .image(ContainerImage.fromRegistry("/aws/aws-example-app"))
         .memoryLimitMiB(2048)
         .build());
 // Add a port mapping
 specificContainer.addPortMappings(PortMapping.builder()
         .containerPort(7600)
         .protocol(Protocol.TCP)
         .build());
 Ec2Service.Builder.create(this, "Service")
         .cluster(cluster)
         .taskDefinition(taskDefinition)
         .cloudMapOptions(CloudMapOptions.builder()
                 // Create SRV records - useful for bridge networking
                 .dnsRecordType(DnsRecordType.SRV)
                 // Targets port TCP port 7600 `specificContainer`
                 .container(specificContainer)
                 .containerPort(7600)
                 .build())
         .build();

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ContainerDefinition.Builder
A fluent builder for ContainerDefinition.
- Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
  IConstruct.Jsii$Default, IConstruct.Jsii$Proxy

Nested Classes
Modifier and Type	Class and Description
`static class`	`ContainerDefinition.Builder` A fluent builder for `ContainerDefinition`.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`ContainerDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`ContainerDefinition(software.amazon.jsii.JsiiObjectRef objRef)`
	`ContainerDefinition(software.constructs.Construct scope, java.lang.String id, ContainerDefinitionProps props)` Constructs a new instance of the ContainerDefinition class.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addContainerDependencies(ContainerDependency... containerDependencies)` This method adds one or more container dependencies to the container.
`void`	`addEnvironment(java.lang.String name, java.lang.String value)` This method adds an environment variable to the container.
`void`	`addInferenceAcceleratorResource(java.lang.String... inferenceAcceleratorResources)` This method adds one or more resources to the container.
`void`	`addLink(ContainerDefinition container)` This method adds a link which allows containers to communicate with each other without the need for port mappings.
`void`	`addLink(ContainerDefinition container, java.lang.String alias)` This method adds a link which allows containers to communicate with each other without the need for port mappings.
`void`	`addMountPoints(MountPoint... mountPoints)` This method adds one or more mount points for data volumes to the container.
`void`	`addPortMappings(PortMapping... portMappings)` This method adds one or more port mappings to the container.
`void`	`addScratch(ScratchSpace scratch)` This method mounts temporary disk space to the container.
`void`	`addToExecutionPolicy(PolicyStatement statement)` This method adds the specified statement to the IAM task execution policy in the task definition.
`void`	`addUlimits(Ulimit... ulimits)` This method adds one or more ulimits to the container.
`void`	`addVolumesFrom(VolumeFrom... volumesFrom)` This method adds one or more volumes to the container.
`PortMapping`	`findPortMapping(java.lang.Number containerPort, Protocol protocol)` Returns the host port for the requested container port if it exists.
`java.util.List<ContainerDependency>`	`getContainerDependencies()` An array dependencies defined for container startup and shutdown.
`java.lang.String`	`getContainerName()` The name of this container.
`java.lang.Number`	`getContainerPort()` The port the container will listen on.
`java.util.List<EnvironmentFileConfig>`	`getEnvironmentFiles()` The environment files for this container.
`java.lang.Boolean`	`getEssential()` Specifies whether the container will be marked essential.
`java.lang.String`	`getImageName()` The name of the image referenced by this container.
`java.lang.Number`	`getIngressPort()` The inbound rules associated with the security group the task or service will use.
`LinuxParameters`	`getLinuxParameters()` The Linux-specific modifications that are applied to the container, such as Linux kernel capabilities.
`LogDriverConfig`	`getLogDriverConfig()` The log configuration specification for the container.
`java.lang.Boolean`	`getMemoryLimitSpecified()` Whether there was at least one memory limit specified in this definition.
`java.util.List<MountPoint>`	`getMountPoints()` The mount points for data volumes in your container.
`java.util.List<PortMapping>`	`getPortMappings()` The list of port mappings for the container.
`java.lang.Boolean`	`getReferencesSecretJsonField()` Whether this container definition references a specific JSON field of a secret stored in Secrets Manager.
`TaskDefinition`	`getTaskDefinition()` The name of the task definition that includes this container definition.
`java.util.List<Ulimit>`	`getUlimits()` An array of ulimits to set in the container.
`java.util.List<VolumeFrom>`	`getVolumesFrom()` The data volumes to mount from another container in the same task definition.
`CfnTaskDefinition.ContainerDefinitionProperty`	`renderContainerDefinition()` Render this container definition to a CloudFormation object.
`CfnTaskDefinition.ContainerDefinitionProperty`	`renderContainerDefinition(TaskDefinition _taskDefinition)` Render this container definition to a CloudFormation object.

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ContainerDefinition
```
protected ContainerDefinition(software.amazon.jsii.JsiiObjectRef objRef)
```
  - ContainerDefinition
```
protected ContainerDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - ContainerDefinition
```
public ContainerDefinition(software.constructs.Construct scope,
                           java.lang.String id,
                           ContainerDefinitionProps props)
```
    Constructs a new instance of the ContainerDefinition class.
    
    Parameters:
    
    scope - This parameter is required.
    
    id - This parameter is required.
    
    props - This parameter is required.
- Method Detail
  - addContainerDependencies
```
public void addContainerDependencies(ContainerDependency... containerDependencies)
```
    This method adds one or more container dependencies to the container.
    
    Parameters:
    
    containerDependencies - This parameter is required.
  - addEnvironment
```
public void addEnvironment(java.lang.String name,
                           java.lang.String value)
```
    This method adds an environment variable to the container.
    
    Parameters:
    
    name - This parameter is required.
    
    value - This parameter is required.
  - addInferenceAcceleratorResource
```
public void addInferenceAcceleratorResource(java.lang.String... inferenceAcceleratorResources)
```
    This method adds one or more resources to the container.
    
    Parameters:
    
    inferenceAcceleratorResources - This parameter is required.
  - addLink
```
public void addLink(ContainerDefinition container,
                    java.lang.String alias)
```
    This method adds a link which allows containers to communicate with each other without the need for port mappings.
    This parameter is only supported if the task definition is using the bridge network mode. Warning: The --link flag is a legacy feature of Docker. It may eventually be removed.
    
    Parameters:
    
    container - This parameter is required.
    
    alias -
  - addLink
```
public void addLink(ContainerDefinition container)
```
    This method adds a link which allows containers to communicate with each other without the need for port mappings.
    This parameter is only supported if the task definition is using the bridge network mode. Warning: The --link flag is a legacy feature of Docker. It may eventually be removed.
    
    Parameters:
    
    container - This parameter is required.
  - addMountPoints
```
public void addMountPoints(MountPoint... mountPoints)
```
    This method adds one or more mount points for data volumes to the container.
    
    Parameters:
    
    mountPoints - This parameter is required.
  - addPortMappings
```
public void addPortMappings(PortMapping... portMappings)
```
    This method adds one or more port mappings to the container.
    
    Parameters:
    
    portMappings - This parameter is required.
  - addScratch
```
public void addScratch(ScratchSpace scratch)
```
    This method mounts temporary disk space to the container.
    This adds the correct container mountPoint and task definition volume.
    
    Parameters:
    
    scratch - This parameter is required.
  - addToExecutionPolicy
```
public void addToExecutionPolicy(PolicyStatement statement)
```
    This method adds the specified statement to the IAM task execution policy in the task definition.
    
    Parameters:
    
    statement - This parameter is required.
  - addUlimits
```
public void addUlimits(Ulimit... ulimits)
```
    This method adds one or more ulimits to the container.
    
    Parameters:
    
    ulimits - This parameter is required.
  - addVolumesFrom
```
public void addVolumesFrom(VolumeFrom... volumesFrom)
```
    This method adds one or more volumes to the container.
    
    Parameters:
    
    volumesFrom - This parameter is required.
  - findPortMapping
```
public PortMapping findPortMapping(java.lang.Number containerPort,
                                   Protocol protocol)
```
    Returns the host port for the requested container port if it exists.
    
    Parameters:
    
    containerPort - This parameter is required.
    
    protocol - This parameter is required.
  - renderContainerDefinition
```
public CfnTaskDefinition.ContainerDefinitionProperty renderContainerDefinition(TaskDefinition _taskDefinition)
```
    Render this container definition to a CloudFormation object.
    
    Parameters:
    
    _taskDefinition - [disable-awslint:ref-via-interface] (unused but kept to avoid breaking change).
  - renderContainerDefinition
```
public CfnTaskDefinition.ContainerDefinitionProperty renderContainerDefinition()
```
    Render this container definition to a CloudFormation object.
  - getContainerDependencies
```
public java.util.List<ContainerDependency> getContainerDependencies()
```
    An array dependencies defined for container startup and shutdown.
  - getContainerName
```
public java.lang.String getContainerName()
```
    The name of this container.
  - getContainerPort
```
public java.lang.Number getContainerPort()
```
    The port the container will listen on.
  - getEssential
```
public java.lang.Boolean getEssential()
```
    Specifies whether the container will be 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.
    If this parameter is omitted, a container is assumed to be essential.
  - getImageName
```
public java.lang.String getImageName()
```
    The name of the image referenced by this container.
  - getIngressPort
```
public java.lang.Number getIngressPort()
```
    The inbound rules associated with the security group the task or service will use.
    This property is only used for tasks that use the awsvpc network mode.
  - getMemoryLimitSpecified
```
public java.lang.Boolean getMemoryLimitSpecified()
```
    Whether there was at least one memory limit specified in this definition.
  - getMountPoints
```
public java.util.List<MountPoint> getMountPoints()
```
    The mount points for data volumes in your container.
  - getPortMappings
```
public java.util.List<PortMapping> getPortMappings()
```
    The list of port mappings for the container.
    Port mappings allow containers to access ports on the host container instance to send or receive traffic.
  - getTaskDefinition
```
public TaskDefinition getTaskDefinition()
```
    The name of the task definition that includes this container definition.
  - getUlimits
```
public java.util.List<Ulimit> getUlimits()
```
    An array of ulimits to set in the container.
  - getVolumesFrom
```
public java.util.List<VolumeFrom> getVolumesFrom()
```
    The data volumes to mount from another container in the same task definition.
  - getEnvironmentFiles
```
public java.util.List<EnvironmentFileConfig> getEnvironmentFiles()
```
    The environment files for this container.
  - getLinuxParameters
```
public LinuxParameters getLinuxParameters()
```
    The Linux-specific modifications that are applied to the container, such as Linux kernel capabilities.
  - getLogDriverConfig
```
public LogDriverConfig getLogDriverConfig()
```
    The log configuration specification for the container.
  - getReferencesSecretJsonField
```
public java.lang.Boolean getReferencesSecretJsonField()
```
    Whether this container definition references a specific JSON field of a secret stored in Secrets Manager.

Class ContainerDefinition

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Constructor Detail

ContainerDefinition

ContainerDefinition

ContainerDefinition

Method Detail

addContainerDependencies

addEnvironment

addInferenceAcceleratorResource

addLink

addLink

addMountPoints

addPortMappings

addScratch

addToExecutionPolicy

addUlimits

addVolumesFrom

findPortMapping

renderContainerDefinition

renderContainerDefinition

getContainerDependencies

getContainerName

getContainerPort

getEssential

getImageName

getIngressPort

getMemoryLimitSpecified

getMountPoints

getPortMappings

getTaskDefinition

getUlimits

getVolumesFrom

getEnvironmentFiles

getLinuxParameters

getLogDriverConfig

getReferencesSecretJsonField