@Generated(value="software.amazon.awssdk:codegen") public final class PortMapping extends Object implements StructuredPojo, 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. 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.
Modifier and Type | Class and Description |
---|---|
static interface |
PortMapping.Builder |
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.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
TransportProtocol |
protocol()
The protocol used for the port mapping.
|
String |
protocolAsString()
The protocol used for the port mapping.
|
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() |
copy
public 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 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
). Port mappings that are
automatically assigned in this way do not count toward the 100 reserved ports limit of a container
instance.public 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 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 of 49153 to 65535 is used. You should 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 of 49153 to 65535 will always be used for Docker versions prior to 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, and a container instance may have up
to 100 reserved ports at a time, including the default reserved ports (automatically assigned ports do not count
toward the 100 reserved ports limit).
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 of 49153 to 65535 is used. You should 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 of 49153 to 65535 will always be used for Docker versions prior to 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,
and a container instance may have up to 100 reserved ports at a time, including the default reserved
ports (automatically assigned ports do not count toward the 100 reserved ports limit).
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()
.
tcp
and udp
. The
default is tcp
.TransportProtocol
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()
.
tcp
and udp
. The
default is tcp
.TransportProtocol
public PortMapping.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<PortMapping.Builder,PortMapping>
public static PortMapping.Builder builder()
public static Class<? extends PortMapping.Builder> serializableBuilderClass()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.