interface PortMapping
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.ECS.PortMapping |
 Java | software.amazon.awscdk.services.ecs.PortMapping |
 Python | aws_cdk.aws_ecs.PortMapping |
 TypeScript (source) | @aws-cdk/aws-ecs » PortMapping |
Obtainable from
Container.findPortMapping()
Port mappings allow containers to access ports on the host container instance to send or receive traffic.
Example
declare const container: ecs.ContainerDefinition;
container.addPortMappings({
containerPort: 3000,
});
Properties
| Name | Type | Description |
|---|---|---|
| container | number | The port number on the container that is bound to the user-specified or automatically assigned host port. |
| host | number | The port number on the container instance to reserve for your container. |
| protocol? | Protocol | The protocol used for the port mapping. |
containerPort
Type:
number
The port number on the container that is bound to the user-specified or automatically assigned host port.
If you are using containers in a task with the awsvpc or host network mode, exposed ports should be specified using containerPort. If you are using containers in a task with the bridge network mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range.
For more information, see hostPort. Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance.
hostPort?
Type:
number
(optional)
The port number on the container instance to reserve for your container.
If you are using containers in a task with the awsvpc or host network mode, the hostPort can either be left blank or set to the same value as the containerPort.
If you are using containers in a task with the bridge network mode, you can specify a non-reserved host port for your container port mapping, or you can omit the hostPort (or set it to 0) while specifying a containerPort and your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version.
protocol?
Type:
Protocol
(optional, default: TCP)
The protocol used for the port mapping.
Valid values are Protocol.TCP and Protocol.UDP.