NetworkBinding (AWS Java SDK :: Services :: Amazon EC2 Container Service 2.19.32 API)

java.lang.Object
- software.amazon.awssdk.services.ecs.model.NetworkBinding

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<NetworkBinding.Builder,NetworkBinding>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class NetworkBinding
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<NetworkBinding.Builder,NetworkBinding>
```
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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface NetworkBinding.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`NetworkBinding.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`bindIP()` The IP address that the container is bound to on the container instance.
`static NetworkBinding.Builder`	`builder()`
`Integer`	`containerPort()` The port number on the container that's used with the network binding.
`String`	`containerPortRange()` The port number range on the container that's bound to the dynamically mapped host port range.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Integer`	`hostPort()` The port number on the host that's used with the network binding.
`String`	`hostPortRange()` The port number range on the host that's used with the network binding.
`TransportProtocol`	`protocol()` The protocol used for the network binding.
`String`	`protocolAsString()` The protocol used for the network binding.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends NetworkBinding.Builder>`	`serializableBuilderClass()`
`NetworkBinding.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - bindIP
```
public final String bindIP()
```
    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.
  - containerPort
```
public final Integer containerPort()
```
    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.
  - hostPort
```
public final Integer hostPort()
```
    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.
  - protocol
```
public final TransportProtocol protocol()
```
    The protocol used for the network binding.
    
    If the service returns an enum value that is not available in the current SDK version, protocol will return TransportProtocol.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from protocolAsString().
    
    Returns:
    
    The protocol used for the network binding.
    
    See Also:
    
    TransportProtocol
  - protocolAsString
```
public final String protocolAsString()
```
    The protocol used for the network binding.
    
    If the service returns an enum value that is not available in the current SDK version, protocol will return TransportProtocol.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from protocolAsString().
    
    Returns:
    
    The protocol used for the network binding.
    
    See Also:
    
    TransportProtocol
  - containerPortRange
```
public final 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 hostPort is set to the same value as the containerPort. 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 hostPort is set to the same value as the containerPort. 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.
  - hostPortRange
```
public final 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.
    
    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.
  - toBuilder
```
public NetworkBinding.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<NetworkBinding.Builder,NetworkBinding>
  - builder
```
public static NetworkBinding.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends NetworkBinding.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class NetworkBinding

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

bindIP

containerPort

hostPort

protocol

protocolAsString

containerPortRange

hostPortRange

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields