@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class NetworkBinding extends Object implements Serializable, Cloneable, StructuredPojo
Details on the network bindings between a container and its host container instance. 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.
Constructor and Description |
---|
NetworkBinding() |
Modifier and Type | Method and Description |
---|---|
NetworkBinding |
clone() |
boolean |
equals(Object obj) |
String |
getBindIP()
The IP address that the container is bound to on the container instance.
|
Integer |
getContainerPort()
The port number on the container that's used with the network binding.
|
String |
getContainerPortRange()
The port number range on the container that's bound to the dynamically mapped host port range.
|
Integer |
getHostPort()
The port number on the host that's used with the network binding.
|
String |
getHostPortRange()
The port number range on the host that's used with the network binding.
|
String |
getProtocol()
The protocol used for the network binding.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setBindIP(String bindIP)
The IP address that the container is bound to on the container instance.
|
void |
setContainerPort(Integer containerPort)
The port number on the container that's used with the network binding.
|
void |
setContainerPortRange(String containerPortRange)
The port number range on the container that's bound to the dynamically mapped host port range.
|
void |
setHostPort(Integer hostPort)
The port number on the host that's used with the network binding.
|
void |
setHostPortRange(String hostPortRange)
The port number range on the host that's used with the network binding.
|
void |
setProtocol(String protocol)
The protocol used for the network binding.
|
void |
setProtocol(TransportProtocol protocol)
The protocol used for the network binding.
|
String |
toString()
Returns a string representation of this object.
|
NetworkBinding |
withBindIP(String bindIP)
The IP address that the container is bound to on the container instance.
|
NetworkBinding |
withContainerPort(Integer containerPort)
The port number on the container that's used with the network binding.
|
NetworkBinding |
withContainerPortRange(String containerPortRange)
The port number range on the container that's bound to the dynamically mapped host port range.
|
NetworkBinding |
withHostPort(Integer hostPort)
The port number on the host that's used with the network binding.
|
NetworkBinding |
withHostPortRange(String hostPortRange)
The port number range on the host that's used with the network binding.
|
NetworkBinding |
withProtocol(String protocol)
The protocol used for the network binding.
|
NetworkBinding |
withProtocol(TransportProtocol protocol)
The protocol used for the network binding.
|
public void setBindIP(String bindIP)
The IP address that the container is bound to on the container instance.
bindIP
- The IP address that the container is bound to on the container instance.public String getBindIP()
The IP address that the container is bound to on the container instance.
public NetworkBinding withBindIP(String bindIP)
The IP address that the container is bound to on the container instance.
bindIP
- The IP address that the container is bound to on the container instance.public void setContainerPort(Integer containerPort)
The port number on the container that's used with the network binding.
containerPort
- The port number on the container that's used with the network binding.public Integer getContainerPort()
The port number on the container that's used with the network binding.
public NetworkBinding withContainerPort(Integer containerPort)
The port number on the container that's used with the network binding.
containerPort
- The port number on the container that's used with the network binding.public void setHostPort(Integer hostPort)
The port number on the host that's used with the network binding.
hostPort
- The port number on the host that's used with the network binding.public Integer getHostPort()
The port number on the host that's used with the network binding.
public NetworkBinding withHostPort(Integer hostPort)
The port number on the host that's used with the network binding.
hostPort
- The port number on the host that's used with the network binding.public void setProtocol(String protocol)
The protocol used for the network binding.
protocol
- The protocol used for the network binding.TransportProtocol
public String getProtocol()
The protocol used for the network binding.
TransportProtocol
public NetworkBinding withProtocol(String protocol)
The protocol used for the network binding.
protocol
- The protocol used for the network binding.TransportProtocol
public void setProtocol(TransportProtocol protocol)
The protocol used for the network binding.
protocol
- The protocol used for the network binding.TransportProtocol
public NetworkBinding withProtocol(TransportProtocol protocol)
The protocol used for the network binding.
protocol
- The protocol used for the network binding.TransportProtocol
public void setContainerPortRange(String containerPortRange)
The port number range on the container that's bound to the dynamically mapped host port range.
The following rules apply when you specify a containerPortRange
:
You must use either the bridge
network mode or the awsvpc
network mode.
This parameter is available for both the EC2 and Fargate launch types.
This parameter is available for both the Linux and Windows operating systems.
The container instance must have at least version 1.67.0 of the container agent and at least version 1.67.0-1 of
the ecs-init
package
You can specify a maximum of 100 port ranges per container.
You do not specify a hostPortRange
. The value of the hostPortRange
is set as follows:
For containers in a task with the awsvpc
network mode, the hostPortRange
is set to the
same value as the containerPortRange
. This is a static mapping strategy.
For containers in a task with the bridge
network mode, the Amazon ECS agent finds open host ports
from the default ephemeral range and passes it to docker to bind them to the container ports.
The containerPortRange
valid values are between 1 and 65535.
A port can only be included in one port mapping per container.
You cannot specify overlapping port ranges.
The first port in the range must be less than last port in the range.
Docker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports.
For more information, see Issue #11185 on the Github website.
For information about how to turn off the docker-proxy in the Docker daemon config file, see Docker daemon in the Amazon ECS Developer Guide.
You can call
DescribeTasks
to view the hostPortRange
which are the host ports that are bound to
the container ports.
containerPortRange
- The port number range on the container that's bound to the dynamically mapped host port range.
The following rules apply when you specify a containerPortRange
:
You must use either the bridge
network mode or the awsvpc
network mode.
This parameter is available for both the EC2 and Fargate launch types.
This parameter is available for both the Linux and Windows operating systems.
The container instance must have at least version 1.67.0 of the container agent and at least version
1.67.0-1 of the ecs-init
package
You can specify a maximum of 100 port ranges per container.
You do not specify a hostPortRange
. The value of the hostPortRange
is set as
follows:
For containers in a task with the awsvpc
network mode, the hostPortRange
is set
to the same value as the containerPortRange
. This is a static mapping strategy.
For containers in a task with the bridge
network mode, the Amazon ECS agent finds open host
ports from the default ephemeral range and passes it to docker to bind them to the container ports.
The containerPortRange
valid values are between 1 and 65535.
A port can only be included in one port mapping per container.
You cannot specify overlapping port ranges.
The first port in the range must be less than last port in the range.
Docker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports.
For more information, see Issue #11185 on the Github website.
For information about how to turn off the docker-proxy in the Docker daemon config file, see Docker daemon in the Amazon ECS Developer Guide.
You can call
DescribeTasks
to view the hostPortRange
which are the host ports that are
bound to the container ports.
public String getContainerPortRange()
The port number range on the container that's bound to the dynamically mapped host port range.
The following rules apply when you specify a containerPortRange
:
You must use either the bridge
network mode or the awsvpc
network mode.
This parameter is available for both the EC2 and Fargate launch types.
This parameter is available for both the Linux and Windows operating systems.
The container instance must have at least version 1.67.0 of the container agent and at least version 1.67.0-1 of
the ecs-init
package
You can specify a maximum of 100 port ranges per container.
You do not specify a hostPortRange
. The value of the hostPortRange
is set as follows:
For containers in a task with the awsvpc
network mode, the hostPortRange
is set to the
same value as the containerPortRange
. This is a static mapping strategy.
For containers in a task with the bridge
network mode, the Amazon ECS agent finds open host ports
from the default ephemeral range and passes it to docker to bind them to the container ports.
The containerPortRange
valid values are between 1 and 65535.
A port can only be included in one port mapping per container.
You cannot specify overlapping port ranges.
The first port in the range must be less than last port in the range.
Docker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports.
For more information, see Issue #11185 on the Github website.
For information about how to turn off the docker-proxy in the Docker daemon config file, see Docker daemon in the Amazon ECS Developer Guide.
You can call
DescribeTasks
to view the hostPortRange
which are the host ports that are bound to
the container ports.
The following rules apply when you specify a containerPortRange
:
You must use either the bridge
network mode or the awsvpc
network mode.
This parameter is available for both the EC2 and Fargate launch types.
This parameter is available for both the Linux and Windows operating systems.
The container instance must have at least version 1.67.0 of the container agent and at least version
1.67.0-1 of the ecs-init
package
You can specify a maximum of 100 port ranges per container.
You do not specify a hostPortRange
. The value of the hostPortRange
is set as
follows:
For containers in a task with the awsvpc
network mode, the hostPortRange
is set
to the same value as the containerPortRange
. This is a static mapping strategy.
For containers in a task with the bridge
network mode, the Amazon ECS agent finds open host
ports from the default ephemeral range and passes it to docker to bind them to the container ports.
The containerPortRange
valid values are between 1 and 65535.
A port can only be included in one port mapping per container.
You cannot specify overlapping port ranges.
The first port in the range must be less than last port in the range.
Docker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports.
For more information, see Issue #11185 on the Github website.
For information about how to turn off the docker-proxy in the Docker daemon config file, see Docker daemon in the Amazon ECS Developer Guide.
You can call
DescribeTasks
to view the hostPortRange
which are the host ports that are
bound to the container ports.
public NetworkBinding withContainerPortRange(String containerPortRange)
The port number range on the container that's bound to the dynamically mapped host port range.
The following rules apply when you specify a containerPortRange
:
You must use either the bridge
network mode or the awsvpc
network mode.
This parameter is available for both the EC2 and Fargate launch types.
This parameter is available for both the Linux and Windows operating systems.
The container instance must have at least version 1.67.0 of the container agent and at least version 1.67.0-1 of
the ecs-init
package
You can specify a maximum of 100 port ranges per container.
You do not specify a hostPortRange
. The value of the hostPortRange
is set as follows:
For containers in a task with the awsvpc
network mode, the hostPortRange
is set to the
same value as the containerPortRange
. This is a static mapping strategy.
For containers in a task with the bridge
network mode, the Amazon ECS agent finds open host ports
from the default ephemeral range and passes it to docker to bind them to the container ports.
The containerPortRange
valid values are between 1 and 65535.
A port can only be included in one port mapping per container.
You cannot specify overlapping port ranges.
The first port in the range must be less than last port in the range.
Docker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports.
For more information, see Issue #11185 on the Github website.
For information about how to turn off the docker-proxy in the Docker daemon config file, see Docker daemon in the Amazon ECS Developer Guide.
You can call
DescribeTasks
to view the hostPortRange
which are the host ports that are bound to
the container ports.
containerPortRange
- The port number range on the container that's bound to the dynamically mapped host port range.
The following rules apply when you specify a containerPortRange
:
You must use either the bridge
network mode or the awsvpc
network mode.
This parameter is available for both the EC2 and Fargate launch types.
This parameter is available for both the Linux and Windows operating systems.
The container instance must have at least version 1.67.0 of the container agent and at least version
1.67.0-1 of the ecs-init
package
You can specify a maximum of 100 port ranges per container.
You do not specify a hostPortRange
. The value of the hostPortRange
is set as
follows:
For containers in a task with the awsvpc
network mode, the hostPortRange
is set
to the same value as the containerPortRange
. This is a static mapping strategy.
For containers in a task with the bridge
network mode, the Amazon ECS agent finds open host
ports from the default ephemeral range and passes it to docker to bind them to the container ports.
The containerPortRange
valid values are between 1 and 65535.
A port can only be included in one port mapping per container.
You cannot specify overlapping port ranges.
The first port in the range must be less than last port in the range.
Docker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports.
For more information, see Issue #11185 on the Github website.
For information about how to turn off the docker-proxy in the Docker daemon config file, see Docker daemon in the Amazon ECS Developer Guide.
You can call
DescribeTasks
to view the hostPortRange
which are the host ports that are
bound to the container ports.
public void setHostPortRange(String hostPortRange)
The port number range on the host that's used with the network binding. This is assigned is assigned by Docker and delivered by the Amazon ECS agent.
hostPortRange
- The port number range on the host that's used with the network binding. This is assigned is assigned by
Docker and delivered by the Amazon ECS agent.public String getHostPortRange()
The port number range on the host that's used with the network binding. This is assigned is assigned by Docker and delivered by the Amazon ECS agent.
public NetworkBinding withHostPortRange(String hostPortRange)
The port number range on the host that's used with the network binding. This is assigned is assigned by Docker and delivered by the Amazon ECS agent.
hostPortRange
- The port number range on the host that's used with the network binding. This is assigned is assigned by
Docker and delivered by the Amazon ECS agent.public String toString()
toString
in class Object
Object.toString()
public NetworkBinding clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.