PortMapping (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.ecs.model.PortMapping

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PortMapping
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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.

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.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

PortMapping()

Constructors
Constructor and Description
`PortMapping()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PortMapping`	`clone()`
`boolean`	`equals(Object obj)`
`Integer`	`getContainerPort()` The port number on the container that's bound to the user-specified or automatically assigned host port.
`Integer`	`getHostPort()` The port number on the container instance to reserve for your container.
`String`	`getProtocol()` The protocol used for the port mapping.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setContainerPort(Integer containerPort)` The port number on the container that's 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(String protocol)` The protocol used for the port mapping.
`void`	`setProtocol(TransportProtocol protocol)` The protocol used for the port mapping.
`String`	`toString()` Returns a string representation of this object.
`PortMapping`	`withContainerPort(Integer containerPort)` The port number on the container that's bound to the user-specified or automatically assigned host port.
`PortMapping`	`withHostPort(Integer hostPort)` The port number on the container instance to reserve for your container.
`PortMapping`	`withProtocol(String protocol)` The protocol used for the port mapping.
`PortMapping`	`withProtocol(TransportProtocol protocol)` The protocol used for the port mapping.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PortMapping
```
public PortMapping()
```
- Method Detail
  - setContainerPort
```
public void setContainerPort(Integer containerPort)
```
    The port number on the container that's bound to the user-specified or automatically assigned host port.
    
    If you use containers in a task with the awsvpc or host network mode, specify the exposed ports using containerPort.
    
    If you use 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.
    
    Parameters:
    
    containerPort - The port number on the container that's bound to the user-specified or automatically assigned host port.
    
    If you use containers in a task with the awsvpc or host network mode, specify the exposed ports using containerPort.
    
    If you use 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.
  - getContainerPort
```
public Integer getContainerPort()
```
    The port number on the container that's bound to the user-specified or automatically assigned host port.
    
    If you use containers in a task with the awsvpc or host network mode, specify the exposed ports using containerPort.
    
    If you use 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.
    
    Returns:
    
    The port number on the container that's bound to the user-specified or automatically assigned host port.
    
    If you use containers in a task with the awsvpc or host network mode, specify the exposed ports using containerPort.
    
    If you use 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.
  - withContainerPort
```
public PortMapping withContainerPort(Integer containerPort)
```
    The port number on the container that's bound to the user-specified or automatically assigned host port.
    
    If you use containers in a task with the awsvpc or host network mode, specify the exposed ports using containerPort.
    
    If you use 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.
    
    Parameters:
    
    containerPort - The port number on the container that's bound to the user-specified or automatically assigned host port.
    
    If you use containers in a task with the awsvpc or host network mode, specify the exposed ports using containerPort.
    
    If you use 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHostPort
```
public void setHostPort(Integer hostPort)
```
    The port number on the container instance to reserve for your container.
    
    If you use 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 use 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.
    
    The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under /proc/sys/net/ipv4/ip_local_port_range. If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 is used. Do not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.
    
    The default ephemeral port range from 49153 through 65535 is always used for Docker versions before 1.6.0.
    
    The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678-51680. Any host port that was previously specified in a running task is also reserved while the task is running. That is, after a task stops, the host port is released. The current reserved ports are displayed in the remainingResources of DescribeContainerInstances output. A container instance can have up to 100 reserved ports at a time. This number includes the default reserved ports. Automatically assigned ports aren't included in the 100 reserved ports quota.
    
    Parameters:
    
    hostPort - The port number on the container instance to reserve for your container.
    
    If you use 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 use 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.
    
    The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under /proc/sys/net/ipv4/ip_local_port_range. If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 is used. Do not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.
    
    The default ephemeral port range from 49153 through 65535 is always used for Docker versions before 1.6.0.
    
    The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678-51680. Any host port that was previously specified in a running task is also reserved while the task is running. That is, after a task stops, the host port is released. The current reserved ports are displayed in the remainingResources of DescribeContainerInstances output. A container instance can have up to 100 reserved ports at a time. This number includes the default reserved ports. Automatically assigned ports aren't included in the 100 reserved ports quota.
  - getHostPort
```
public Integer getHostPort()
```
    The port number on the container instance to reserve for your container.
    
    If you use 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 use 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.
    
    The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under /proc/sys/net/ipv4/ip_local_port_range. If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 is used. Do not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.
    
    The default ephemeral port range from 49153 through 65535 is always used for Docker versions before 1.6.0.
    
    The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678-51680. Any host port that was previously specified in a running task is also reserved while the task is running. That is, after a task stops, the host port is released. The current reserved ports are displayed in the remainingResources of DescribeContainerInstances output. A container instance can have up to 100 reserved ports at a time. This number includes the default reserved ports. Automatically assigned ports aren't included in the 100 reserved ports quota.
    
    Returns:
    
    The port number on the container instance to reserve for your container.
    
    If you use 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 use 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.
    
    The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under /proc/sys/net/ipv4/ip_local_port_range. If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 is used. Do not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.
    
    The default ephemeral port range from 49153 through 65535 is always used for Docker versions before 1.6.0.
    
    The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678-51680. Any host port that was previously specified in a running task is also reserved while the task is running. That is, after a task stops, the host port is released. The current reserved ports are displayed in the remainingResources of DescribeContainerInstances output. A container instance can have up to 100 reserved ports at a time. This number includes the default reserved ports. Automatically assigned ports aren't included in the 100 reserved ports quota.
  - withHostPort
```
public PortMapping withHostPort(Integer hostPort)
```
    The port number on the container instance to reserve for your container.
    
    If you use 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 use 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.
    
    The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under /proc/sys/net/ipv4/ip_local_port_range. If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 is used. Do not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.
    
    The default ephemeral port range from 49153 through 65535 is always used for Docker versions before 1.6.0.
    
    The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678-51680. Any host port that was previously specified in a running task is also reserved while the task is running. That is, after a task stops, the host port is released. The current reserved ports are displayed in the remainingResources of DescribeContainerInstances output. A container instance can have up to 100 reserved ports at a time. This number includes the default reserved ports. Automatically assigned ports aren't included in the 100 reserved ports quota.
    
    Parameters:
    
    hostPort - The port number on the container instance to reserve for your container.
    
    If you use 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 use 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.
    
    The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under /proc/sys/net/ipv4/ip_local_port_range. If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 is used. Do not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.
    
    The default ephemeral port range from 49153 through 65535 is always used for Docker versions before 1.6.0.
    
    The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678-51680. Any host port that was previously specified in a running task is also reserved while the task is running. That is, after a task stops, the host port is released. The current reserved ports are displayed in the remainingResources of DescribeContainerInstances output. A container instance can have up to 100 reserved ports at a time. This number includes the default reserved ports. Automatically assigned ports aren't included in the 100 reserved ports quota.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setProtocol
```
public void setProtocol(String protocol)
```
    The protocol used for the port mapping. Valid values are tcp and udp. The default is tcp.
    
    Parameters:
    
    protocol - The protocol used for the port mapping. Valid values are tcp and udp. The default is tcp.
    
    See Also:
    
    TransportProtocol
  - getProtocol
```
public String getProtocol()
```
    The protocol used for the port mapping. Valid values are tcp and udp. The default is tcp.
    
    Returns:
    
    The protocol used for the port mapping. Valid values are tcp and udp. The default is tcp.
    
    See Also:
    
    TransportProtocol
  - withProtocol
```
public PortMapping withProtocol(String protocol)
```
    The protocol used for the port mapping. Valid values are tcp and udp. The default is tcp.
    
    Parameters:
    
    protocol - The protocol used for the port mapping. Valid values are tcp and udp. The default is tcp.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TransportProtocol
  - setProtocol
```
public void setProtocol(TransportProtocol protocol)
```
    The protocol used for the port mapping. Valid values are tcp and udp. The default is tcp.
    
    Parameters:
    
    protocol - The protocol used for the port mapping. Valid values are tcp and udp. The default is tcp.
    
    See Also:
    
    TransportProtocol
  - withProtocol
```
public PortMapping withProtocol(TransportProtocol protocol)
```
    The protocol used for the port mapping. Valid values are tcp and udp. The default is tcp.
    
    Parameters:
    
    protocol - The protocol used for the port mapping. Valid values are tcp and udp. The default is tcp.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TransportProtocol
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public PortMapping clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class PortMapping

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PortMapping

Method Detail

setContainerPort

getContainerPort

withContainerPort

setHostPort

getHostPort

withHostPort

setProtocol

getProtocol

withProtocol

setProtocol

withProtocol

toString

equals

hashCode

clone

marshall