PortMapping
Port mappings allow containers to access ports on the host container instance to send or receive traffic. Port mappings are specified as part of the container definition.
If you use containers in a task with the awsvpc
or host
network mode, specify the exposed ports using containerPort
. The hostPort
can be left blank or it must be the same value as the containerPort
.
Most fields of this parameter (containerPort
, hostPort
, protocol
) maps to PortBindings
in the docker container create command and the --publish
option to docker run
. If the network mode of a task definition is set to host
, host ports must either be undefined or match the container port in the port mapping.
You can't expose the same container port for multiple protocols. If you attempt this, an error is returned.
After a task reaches the RUNNING
status, manual and automatic host and container port assignments are visible in the networkBindings
section of DescribeTasks API responses.
Types
Properties
The application protocol that's used for the port mapping. This parameter only applies to Service Connect. We recommend that you set this parameter to be consistent with the protocol that your application uses. If you set this parameter, Amazon ECS adds protocol-specific connection handling to the Service Connect proxy. If you set this parameter, Amazon ECS adds protocol-specific telemetry in the Amazon ECS console and CloudWatch.
The port number on the container that's bound to the user-specified or automatically assigned host port.
The port number range on the container that's bound to the dynamically mapped host port range.
The name that's used for the port mapping. This parameter is the name that you use in the serviceConnectConfiguration
and the vpcLatticeConfigurations
of a service. The name can include up to 64 characters. The characters can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen.
The protocol used for the port mapping. Valid values are tcp
and udp
. The default is tcp
. protocol
is immutable in a Service Connect service. Updating this field requires a service deletion and redeployment.