Class PortMapping
- All Implemented Interfaces:
Serializable
,Cloneable
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. 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.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
The port number on the container that is bound to the user-specified or automatically assigned host port.The port number on the container instance to reserve for your container.The protocol used for the port mapping.int
hashCode()
void
setContainerPort
(Integer containerPort) The port number on the container that is bound to the user-specified or automatically assigned host port.void
setHostPort
(Integer hostPort) The port number on the container instance to reserve for your container.void
setProtocol
(TransportProtocol protocol) The protocol used for the port mapping.void
setProtocol
(String protocol) The protocol used for the port mapping.toString()
Returns a string representation of this object; useful for testing and debugging.withContainerPort
(Integer containerPort) The port number on the container that is bound to the user-specified or automatically assigned host port.withHostPort
(Integer hostPort) The port number on the container instance to reserve for your container.withProtocol
(TransportProtocol protocol) The protocol used for the port mapping.withProtocol
(String protocol) The protocol used for the port mapping.
-
Constructor Details
-
PortMapping
public PortMapping()
-
-
Method Details
-
setContainerPort
The port number on the container that is bound to the user-specified or automatically assigned host port. If 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.- Parameters:
containerPort
- The port number on the container that is bound to the user-specified or automatically assigned host port. If 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, seehostPort
). Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance.
-
getContainerPort
The port number on the container that is bound to the user-specified or automatically assigned host port. If 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.- Returns:
- The port number on the container that is bound to the
user-specified or automatically assigned host port. If 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.
-
withContainerPort
The port number on the container that is bound to the user-specified or automatically assigned host port. If 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.- Parameters:
containerPort
- The port number on the container that is bound to the user-specified or automatically assigned host port. If 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, seehostPort
). Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setHostPort
The port number on the container instance to reserve for your container. You can specify a non-reserved host port for your container port mapping, or you can omit the
hostPort
(or set it to0
) while specifying acontainerPort
and your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version.The default ephemeral port range is 49153 to 65535, and this range is used for Docker versions prior to 1.6.0. For Docker version 1.6.0 and later, the Docker daemon tries to read the ephemeral port range from
/proc/sys/net/ipv4/ip_local_port_range
; if this kernel parameter is unavailable, the default ephemeral port range is used. You should not attempt to specify a host port in the ephemeral port range, because these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent port 51678. Any host port that was previously specified in a running task is also reserved while the task is running (after a task stops, the host port is released).The current reserved ports are displayed in the
remainingResources
of DescribeContainerInstances output, and a container instance may have up to 100 reserved ports at a time, including the default reserved ports (automatically assigned ports do not count toward the 100 reserved ports limit).- Parameters:
hostPort
- The port number on the container instance to reserve for your container. You can specify a non-reserved host port for your container port mapping, or you can omit thehostPort
(or set it to0
) while specifying acontainerPort
and your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version.The default ephemeral port range is 49153 to 65535, and this range is used for Docker versions prior to 1.6.0. For Docker version 1.6.0 and later, the Docker daemon tries to read the ephemeral port range from
/proc/sys/net/ipv4/ip_local_port_range
; if this kernel parameter is unavailable, the default ephemeral port range is used. You should not attempt to specify a host port in the ephemeral port range, because these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent port 51678. Any host port that was previously specified in a running task is also reserved while the task is running (after a task stops, the host port is released).The current reserved ports are displayed in the
remainingResources
of DescribeContainerInstances output, and a container instance may have up to 100 reserved ports at a time, including the default reserved ports (automatically assigned ports do not count toward the 100 reserved ports limit).
-
getHostPort
The port number on the container instance to reserve for your container. You can specify a non-reserved host port for your container port mapping, or you can omit the
hostPort
(or set it to0
) while specifying acontainerPort
and your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version.The default ephemeral port range is 49153 to 65535, and this range is used for Docker versions prior to 1.6.0. For Docker version 1.6.0 and later, the Docker daemon tries to read the ephemeral port range from
/proc/sys/net/ipv4/ip_local_port_range
; if this kernel parameter is unavailable, the default ephemeral port range is used. You should not attempt to specify a host port in the ephemeral port range, because these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent port 51678. Any host port that was previously specified in a running task is also reserved while the task is running (after a task stops, the host port is released).The current reserved ports are displayed in the
remainingResources
of DescribeContainerInstances output, and a container instance may have up to 100 reserved ports at a time, including the default reserved ports (automatically assigned ports do not count toward the 100 reserved ports limit).- Returns:
- The port number on the container instance to reserve for your
container. You can specify a non-reserved host port for your
container port mapping, or you can omit the
hostPort
(or set it to0
) while specifying acontainerPort
and your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version.The default ephemeral port range is 49153 to 65535, and this range is used for Docker versions prior to 1.6.0. For Docker version 1.6.0 and later, the Docker daemon tries to read the ephemeral port range from
/proc/sys/net/ipv4/ip_local_port_range
; if this kernel parameter is unavailable, the default ephemeral port range is used. You should not attempt to specify a host port in the ephemeral port range, because these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent port 51678. Any host port that was previously specified in a running task is also reserved while the task is running (after a task stops, the host port is released).The current reserved ports are displayed in the
remainingResources
of DescribeContainerInstances output, and a container instance may have up to 100 reserved ports at a time, including the default reserved ports (automatically assigned ports do not count toward the 100 reserved ports limit).
-
withHostPort
The port number on the container instance to reserve for your container. You can specify a non-reserved host port for your container port mapping, or you can omit the
hostPort
(or set it to0
) while specifying acontainerPort
and your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version.The default ephemeral port range is 49153 to 65535, and this range is used for Docker versions prior to 1.6.0. For Docker version 1.6.0 and later, the Docker daemon tries to read the ephemeral port range from
/proc/sys/net/ipv4/ip_local_port_range
; if this kernel parameter is unavailable, the default ephemeral port range is used. You should not attempt to specify a host port in the ephemeral port range, because these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent port 51678. Any host port that was previously specified in a running task is also reserved while the task is running (after a task stops, the host port is released).The current reserved ports are displayed in the
remainingResources
of DescribeContainerInstances output, and a container instance may have up to 100 reserved ports at a time, including the default reserved ports (automatically assigned ports do not count toward the 100 reserved ports limit).- Parameters:
hostPort
- The port number on the container instance to reserve for your container. You can specify a non-reserved host port for your container port mapping, or you can omit thehostPort
(or set it to0
) while specifying acontainerPort
and your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version.The default ephemeral port range is 49153 to 65535, and this range is used for Docker versions prior to 1.6.0. For Docker version 1.6.0 and later, the Docker daemon tries to read the ephemeral port range from
/proc/sys/net/ipv4/ip_local_port_range
; if this kernel parameter is unavailable, the default ephemeral port range is used. You should not attempt to specify a host port in the ephemeral port range, because these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent port 51678. Any host port that was previously specified in a running task is also reserved while the task is running (after a task stops, the host port is released).The current reserved ports are displayed in the
remainingResources
of DescribeContainerInstances output, and a container instance may have up to 100 reserved ports at a time, including the default reserved ports (automatically assigned ports do not count toward the 100 reserved ports limit).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setProtocol
The protocol used for the port mapping. Valid values are
tcp
andudp
. The default istcp
.- Parameters:
protocol
- The protocol used for the port mapping. Valid values aretcp
andudp
. The default istcp
.- See Also:
-
getProtocol
The protocol used for the port mapping. Valid values are
tcp
andudp
. The default istcp
.- Returns:
- The protocol used for the port mapping. Valid values are
tcp
andudp
. The default istcp
. - See Also:
-
withProtocol
The protocol used for the port mapping. Valid values are
tcp
andudp
. The default istcp
.- Parameters:
protocol
- The protocol used for the port mapping. Valid values aretcp
andudp
. The default istcp
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setProtocol
The protocol used for the port mapping. Valid values are
tcp
andudp
. The default istcp
.- Parameters:
protocol
- The protocol used for the port mapping. Valid values aretcp
andudp
. The default istcp
.- See Also:
-
withProtocol
The protocol used for the port mapping. Valid values are
tcp
andudp
. The default istcp
.- Parameters:
protocol
- The protocol used for the port mapping. Valid values aretcp
andudp
. The default istcp
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-