PortMapping (AWS SDK for Java

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

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<PortMapping.Builder,PortMapping>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class PortMapping
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<PortMapping.Builder,PortMapping>
```
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 are using containers in a task with the awsvpc or host network mode, exposed ports should be specified using containerPort. The hostPort can be left blank or it must be the same value as the containerPort.

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 PortMapping.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static PortMapping.Builder`	`builder()`
`Integer`	`containerPort()` The port number on the container that is bound to the user-specified or automatically assigned host port.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Integer`	`hostPort()` The port number on the container instance to reserve for your container.
`TransportProtocol`	`protocol()` The protocol used for the port mapping.
`String`	`protocolAsString()` The protocol used for the port mapping.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends PortMapping.Builder>`	`serializableBuilderClass()`
`PortMapping.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

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

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

- Method Detail
  - containerPort
```
public Integer containerPort()
```
    The port number on the container that is bound to the user-specified or automatically assigned host port.
    
    If you are using containers in a task with the awsvpc or host network mode, exposed ports should be specified using containerPort.
    
    If you are using 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 is bound to the user-specified or automatically assigned host port.
    
    If you are using containers in a task with the awsvpc or host network mode, exposed ports should be specified using containerPort.
    
    If you are using 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.
  - hostPort
```
public Integer hostPort()
```
    The port number on the container instance to reserve for your container.
    
    If you are using 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 are using 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 and 51679. Any host port that was previously specified in a running task is also reserved while the task is running (after a task stops, the host port is released). The current reserved ports are displayed in the remainingResources of DescribeContainerInstances output. A container instance may have up to 100 reserved ports at a time, including the default reserved ports. Aautomatically assigned ports do not count toward the 100 reserved ports limit.
    
    Returns:
    
    The port number on the container instance to reserve for your container.
    
    If you are using 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 are using 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 and 51679. Any host port that was previously specified in a running task is also reserved while the task is running (after a task stops, the host port is released). The current reserved ports are displayed in the remainingResources of DescribeContainerInstances output. A container instance may have up to 100 reserved ports at a time, including the default reserved ports. Aautomatically assigned ports do not count toward the 100 reserved ports limit.
  - protocol
```
public TransportProtocol protocol()
```
    The protocol used for the port mapping. Valid values are tcp and udp. The default is tcp.
    
    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 port mapping. Valid values are tcp and udp. The default is tcp.
    
    See Also:
    
    TransportProtocol
  - protocolAsString
```
public String protocolAsString()
```
    The protocol used for the port mapping. Valid values are tcp and udp. The default is tcp.
    
    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 port mapping. Valid values are tcp and udp. The default is tcp.
    
    See Also:
    
    TransportProtocol
  - toBuilder
```
public PortMapping.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<PortMapping.Builder,PortMapping>
    
    Returns:
    
    a builder for type T
  - builder
```
public static PortMapping.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends PortMapping.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class PortMapping

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

containerPort

hostPort

protocol

protocolAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields