com.amazonaws.services.ecs.model

Class PortMapping

java.lang.Object

com.amazonaws.services.ecs.model.PortMapping

All Implemented Interfaces:

Serializable, Cloneable

public class PortMapping
extends Object
implements 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.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PortMapping()

Method Summary

Methods

Modifier and Type	Method and Description
PortMapping	clone()
boolean	equals(Object obj)
Integer	getContainerPort() The port number on the container that is 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	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(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; useful for testing and debugging.
PortMapping	withContainerPort(Integer containerPort) The port number on the container that is 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

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PortMapping

public PortMapping()

Method Detail

getContainerPort

public Integer 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 will automatically receive a host port in the ephemeral port range (for more information, see hostPort).

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 will automatically receive a host port in the ephemeral port range (for more information, see hostPort).

setContainerPort

public void setContainerPort(Integer 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 will automatically receive a host port in the ephemeral port range (for more information, see hostPort).

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 will automatically receive a host port in the ephemeral port range (for more information, see hostPort).

withContainerPort

public PortMapping withContainerPort(Integer 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 will automatically receive a host port in the ephemeral port range (for more information, see hostPort).

Returns a reference to this object so that method calls can be chained together.

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 will automatically receive a host port in the ephemeral port range (for more information, see hostPort).

Returns:

A reference to this updated object so that method calls can be chained together.

getHostPort

public Integer 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 to 0) while specifying a containerPort and your container will automatically receive 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, since 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 (once 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 50 reserved ports at a time, including the default reserved ports (automatically assigned ports do not count toward this 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 to 0) while specifying a containerPort and your container will automatically receive 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, since 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 (once 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 50 reserved ports at a time, including the default reserved ports (automatically assigned ports do not count toward this limit).

setHostPort

public void setHostPort(Integer 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 the hostPort (or set it to 0) while specifying a containerPort and your container will automatically receive 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, since 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 (once 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 50 reserved ports at a time, including the default reserved ports (automatically assigned ports do not count toward this 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 the hostPort (or set it to 0) while specifying a containerPort and your container will automatically receive 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, since 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 (once 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 50 reserved ports at a time, including the default reserved ports (automatically assigned ports do not count toward this limit).

withHostPort

public PortMapping withHostPort(Integer 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 the hostPort (or set it to 0) while specifying a containerPort and your container will automatically receive 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, since 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 (once 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 50 reserved ports at a time, including the default reserved ports (automatically assigned ports do not count toward this limit).

Returns a reference to this object so that method calls can be chained together.

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 the hostPort (or set it to 0) while specifying a containerPort and your container will automatically receive 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, since 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 (once 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 50 reserved ports at a time, including the default reserved ports (automatically assigned ports do not count toward this limit).

Returns:

A reference to this updated object so that method calls can be chained together.

getProtocol

public String getProtocol()

The protocol used for the port mapping. Valid values are tcp and udp. The default is tcp.

Constraints:
Allowed Values: tcp, udp

Returns:

The protocol used for the port mapping. Valid values are tcp and udp. The default is tcp.

See Also:

TransportProtocol

setProtocol

public void setProtocol(String protocol)

The protocol used for the port mapping. Valid values are tcp and udp. The default is tcp.

Constraints:
Allowed Values: tcp, udp

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(String protocol)

The protocol used for the port mapping. Valid values are tcp and udp. The default is tcp.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: tcp, udp

Parameters:

protocol - The protocol used for the port mapping. Valid values are tcp and udp. The default is tcp.

Returns:

A reference to this updated 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.

Constraints:
Allowed Values: tcp, udp

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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: tcp, udp

Parameters:

protocol - The protocol used for the port mapping. Valid values are tcp and udp. The default is tcp.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

TransportProtocol

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public PortMapping clone()

Overrides:

clone in class Object