NetworkBinding (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@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.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

NetworkBinding()

Constructors
Constructor and Description
`NetworkBinding()`

Method Summary

All Methods Instance Methods Concrete Methods
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.

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

- Constructor Detail
  - NetworkBinding
```
public NetworkBinding()
```
- Method Detail
  - setBindIP
```
public void setBindIP(String bindIP)
```
    The IP address that the container is bound to on the container instance.
    
    Parameters:
    
    bindIP - The IP address that the container is bound to on the container instance.
  - getBindIP
```
public String getBindIP()
```
    The IP address that the container is bound to on the container instance.
    
    Returns:
    
    The IP address that the container is bound to on the container instance.
  - withBindIP
```
public NetworkBinding withBindIP(String bindIP)
```
    The IP address that the container is bound to on the container instance.
    
    Parameters:
    
    bindIP - The IP address that the container is bound to on the container instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setContainerPort
```
public void setContainerPort(Integer containerPort)
```
    The port number on the container that's used with the network binding.
    
    Parameters:
    
    containerPort - The port number on the container that's used with the network binding.
  - getContainerPort
```
public Integer getContainerPort()
```
    The port number on the container that's used with the network binding.
    
    Returns:
    
    The port number on the container that's used with the network binding.
  - withContainerPort
```
public NetworkBinding withContainerPort(Integer containerPort)
```
    The port number on the container that's used with the network binding.
    
    Parameters:
    
    containerPort - The port number on the container that's used with the network binding.
    
    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 host that's used with the network binding.
    
    Parameters:
    
    hostPort - The port number on the host that's used with the network binding.
  - getHostPort
```
public Integer getHostPort()
```
    The port number on the host that's used with the network binding.
    
    Returns:
    
    The port number on the host that's used with the network binding.
  - withHostPort
```
public NetworkBinding withHostPort(Integer hostPort)
```
    The port number on the host that's used with the network binding.
    
    Parameters:
    
    hostPort - The port number on the host that's used with the network binding.
    
    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 network binding.
    
    Parameters:
    
    protocol - The protocol used for the network binding.
    
    See Also:
    
    TransportProtocol
  - getProtocol
```
public String getProtocol()
```
    The protocol used for the network binding.
    
    Returns:
    
    The protocol used for the network binding.
    
    See Also:
    
    TransportProtocol
  - withProtocol
```
public NetworkBinding withProtocol(String protocol)
```
    The protocol used for the network binding.
    
    Parameters:
    
    protocol - The protocol used for the network binding.
    
    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 network binding.
    
    Parameters:
    
    protocol - The protocol used for the network binding.
    
    See Also:
    
    TransportProtocol
  - withProtocol
```
public NetworkBinding withProtocol(TransportProtocol protocol)
```
    The protocol used for the network binding.
    
    Parameters:
    
    protocol - The protocol used for the network binding.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TransportProtocol
  - setContainerPortRange
```
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.
    Parameters:
    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.
  - getContainerPortRange
```
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.
    Returns:
    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.
  - withContainerPortRange
```
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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHostPortRange
```
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.
    
    Parameters:
    
    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.
  - getHostPortRange
```
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.
    
    Returns:
    
    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.
  - withHostPortRange
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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 NetworkBinding 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.

AWS SDK for Java 1.x API Reference - 1.12.792

Class NetworkBinding

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

NetworkBinding

Method Detail

setBindIP

getBindIP

withBindIP

setContainerPort

getContainerPort

withContainerPort

setHostPort

getHostPort

withHostPort

setProtocol

getProtocol

withProtocol

setProtocol

withProtocol

setContainerPortRange

getContainerPortRange

withContainerPortRange

setHostPortRange

getHostPortRange

withHostPortRange

toString

equals

hashCode

clone

marshall