software.amazon.awscdk.services.ecs

Class ContainerDefinition

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.services.ecs.ContainerDefinition

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

Direct Known Subclasses:

FirelensLogRouter

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.684Z")
 @Stability(value=Stable)
public class ContainerDefinition
extends software.constructs.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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addContainerDependencies(ContainerDependency... containerDependencies) This method adds one or more container dependencies to the container.
void	addEnvironment(String name, String value) This method adds an environment variable to the container.
void	addInferenceAcceleratorResource(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, 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	addSecret(String name, Secret secret) This method adds a secret as environment variable 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(Number containerPort, Protocol protocol) Returns the host port for the requested container port if it exists.
List<ContainerDependency>	getContainerDependencies() An array dependencies defined for container startup and shutdown.
String	getContainerName() The name of this container.
Number	getContainerPort() The port the container will listen on.
List<EnvironmentFileConfig>	getEnvironmentFiles() The environment files for this container.
Boolean	getEssential() Specifies whether the container will be marked essential.
String	getImageName() The name of the image referenced by this container.
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.
Boolean	getMemoryLimitSpecified() Whether there was at least one memory limit specified in this definition.
List<MountPoint>	getMountPoints() The mount points for data volumes in your container.
List<PortMapping>	getPortMappings() The list of port mappings for the container.
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.
List<Ulimit>	getUlimits() An array of ulimits to set in the container.
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.constructs.Construct

getNode, isConstruct, toString

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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

ContainerDefinition

protected ContainerDefinition(software.amazon.jsii.JsiiObjectRef objRef)

ContainerDefinition

protected ContainerDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

ContainerDefinition

@Stability(value=Stable)
public ContainerDefinition(@NotNull
                                                    software.constructs.Construct scope,
                                                    @NotNull
                                                    String id,
                                                    @NotNull
                                                    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

@Stability(value=Stable)
public void addContainerDependencies(@NotNull
                                                              ContainerDependency... containerDependencies)

This method adds one or more container dependencies to the container.

Parameters:

containerDependencies - This parameter is required.

addEnvironment

@Stability(value=Stable)
public void addEnvironment(@NotNull
                                                    String name,
                                                    @NotNull
                                                    String value)

This method adds an environment variable to the container.

Parameters:

name - This parameter is required.

value - This parameter is required.

addInferenceAcceleratorResource

@Stability(value=Stable)
public void addInferenceAcceleratorResource(@NotNull
                                                                     String... inferenceAcceleratorResources)

This method adds one or more resources to the container.

Parameters:

inferenceAcceleratorResources - This parameter is required.

addLink

@Stability(value=Stable)
public void addLink(@NotNull
                                             ContainerDefinition container,
                                             @Nullable
                                             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

@Stability(value=Stable)
public void addLink(@NotNull
                                             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

@Stability(value=Stable)
public void addMountPoints(@NotNull
                                                    MountPoint... mountPoints)

This method adds one or more mount points for data volumes to the container.

Parameters:

mountPoints - This parameter is required.

addPortMappings

@Stability(value=Stable)
public void addPortMappings(@NotNull
                                                     PortMapping... portMappings)

This method adds one or more port mappings to the container.

Parameters:

portMappings - This parameter is required.

addScratch

@Stability(value=Stable)
public void addScratch(@NotNull
                                                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.

addSecret

@Stability(value=Stable)
public void addSecret(@NotNull
                                               String name,
                                               @NotNull
                                               Secret secret)

This method adds a secret as environment variable to the container.

Parameters:

name - This parameter is required.

secret - This parameter is required.

addToExecutionPolicy

@Stability(value=Stable)
public void addToExecutionPolicy(@NotNull
                                                          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

@Stability(value=Stable)
public void addUlimits(@NotNull
                                                Ulimit... ulimits)

This method adds one or more ulimits to the container.

Parameters:

ulimits - This parameter is required.

addVolumesFrom

@Stability(value=Stable)
public void addVolumesFrom(@NotNull
                                                    VolumeFrom... volumesFrom)

This method adds one or more volumes to the container.

Parameters:

volumesFrom - This parameter is required.

findPortMapping

@Stability(value=Stable)
 @Nullable
public PortMapping findPortMapping(@NotNull
                                                                       Number containerPort,
                                                                       @NotNull
                                                                       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

@Stability(value=Stable)
 @NotNull
public CfnTaskDefinition.ContainerDefinitionProperty renderContainerDefinition(@Nullable
                                                                                                                  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

@Stability(value=Stable)
 @NotNull
public CfnTaskDefinition.ContainerDefinitionProperty renderContainerDefinition()

Render this container definition to a CloudFormation object.

getContainerDependencies

@Stability(value=Stable)
 @NotNull
public List<ContainerDependency> getContainerDependencies()

An array dependencies defined for container startup and shutdown.

getContainerName

@Stability(value=Stable)
 @NotNull
public String getContainerName()

The name of this container.

getContainerPort

@Stability(value=Stable)
 @NotNull
public Number getContainerPort()

The port the container will listen on.

getEssential

@Stability(value=Stable)
 @NotNull
public 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

@Stability(value=Stable)
 @NotNull
public String getImageName()

The name of the image referenced by this container.

getIngressPort

@Stability(value=Stable)
 @NotNull
public 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

@Stability(value=Stable)
 @NotNull
public Boolean getMemoryLimitSpecified()

Whether there was at least one memory limit specified in this definition.

getMountPoints

@Stability(value=Stable)
 @NotNull
public List<MountPoint> getMountPoints()

The mount points for data volumes in your container.

getPortMappings

@Stability(value=Stable)
 @NotNull
public 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

@Stability(value=Stable)
 @NotNull
public TaskDefinition getTaskDefinition()

The name of the task definition that includes this container definition.

getUlimits

@Stability(value=Stable)
 @NotNull
public List<Ulimit> getUlimits()

An array of ulimits to set in the container.

getVolumesFrom

@Stability(value=Stable)
 @NotNull
public List<VolumeFrom> getVolumesFrom()

The data volumes to mount from another container in the same task definition.

getEnvironmentFiles

@Stability(value=Stable)
 @Nullable
public List<EnvironmentFileConfig> getEnvironmentFiles()

The environment files for this container.

getLinuxParameters

@Stability(value=Stable)
 @Nullable
public LinuxParameters getLinuxParameters()

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

getLogDriverConfig

@Stability(value=Stable)
 @Nullable
public LogDriverConfig getLogDriverConfig()

The log configuration specification for the container.

getReferencesSecretJsonField

@Stability(value=Stable)
 @Nullable
public Boolean getReferencesSecretJsonField()

Whether this container definition references a specific JSON field of a secret stored in Secrets Manager.