AWS SDK for C++  1.9.71
AWS SDK for C++
Public Member Functions | List of all members
Aws::ECS::Model::PortMapping Class Reference

#include <PortMapping.h>

Public Member Functions

 PortMapping ()
 
 PortMapping (Aws::Utils::Json::JsonView jsonValue)
 
PortMappingoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
int GetContainerPort () const
 
bool ContainerPortHasBeenSet () const
 
void SetContainerPort (int value)
 
PortMappingWithContainerPort (int value)
 
int GetHostPort () const
 
bool HostPortHasBeenSet () const
 
void SetHostPort (int value)
 
PortMappingWithHostPort (int value)
 
const TransportProtocolGetProtocol () const
 
bool ProtocolHasBeenSet () const
 
void SetProtocol (const TransportProtocol &value)
 
void SetProtocol (TransportProtocol &&value)
 
PortMappingWithProtocol (const TransportProtocol &value)
 
PortMappingWithProtocol (TransportProtocol &&value)
 

Detailed Description

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.

You cannot expose the same container port for multiple protocols. An error will be returned if this is attempted

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 Reference

Definition at line 41 of file PortMapping.h.

Constructor & Destructor Documentation

◆ PortMapping() [1/2]

Aws::ECS::Model::PortMapping::PortMapping ( )

◆ PortMapping() [2/2]

Aws::ECS::Model::PortMapping::PortMapping ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ ContainerPortHasBeenSet()

bool Aws::ECS::Model::PortMapping::ContainerPortHasBeenSet ( ) const
inline

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.

Definition at line 74 of file PortMapping.h.

◆ GetContainerPort()

int Aws::ECS::Model::PortMapping::GetContainerPort ( ) const
inline

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.

Definition at line 61 of file PortMapping.h.

◆ GetHostPort()

int Aws::ECS::Model::PortMapping::GetHostPort ( ) const
inline

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-51680. 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 can have up to 100 reserved ports at a time, including the default reserved ports. Automatically assigned ports don't count toward the 100 reserved ports limit.

Definition at line 131 of file PortMapping.h.

◆ GetProtocol()

const TransportProtocol& Aws::ECS::Model::PortMapping::GetProtocol ( ) const
inline

The protocol used for the port mapping. Valid values are tcp and udp. The default is tcp.

Definition at line 228 of file PortMapping.h.

◆ HostPortHasBeenSet()

bool Aws::ECS::Model::PortMapping::HostPortHasBeenSet ( ) const
inline

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-51680. 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 can have up to 100 reserved ports at a time, including the default reserved ports. Automatically assigned ports don't count toward the 100 reserved ports limit.

Definition at line 161 of file PortMapping.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::ECS::Model::PortMapping::Jsonize ( ) const

◆ operator=()

PortMapping& Aws::ECS::Model::PortMapping::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ ProtocolHasBeenSet()

bool Aws::ECS::Model::PortMapping::ProtocolHasBeenSet ( ) const
inline

The protocol used for the port mapping. Valid values are tcp and udp. The default is tcp.

Definition at line 234 of file PortMapping.h.

◆ SetContainerPort()

void Aws::ECS::Model::PortMapping::SetContainerPort ( int  value)
inline

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.

Definition at line 87 of file PortMapping.h.

◆ SetHostPort()

void Aws::ECS::Model::PortMapping::SetHostPort ( int  value)
inline

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-51680. 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 can have up to 100 reserved ports at a time, including the default reserved ports. Automatically assigned ports don't count toward the 100 reserved ports limit.

Definition at line 191 of file PortMapping.h.

◆ SetProtocol() [1/2]

void Aws::ECS::Model::PortMapping::SetProtocol ( const TransportProtocol value)
inline

The protocol used for the port mapping. Valid values are tcp and udp. The default is tcp.

Definition at line 240 of file PortMapping.h.

◆ SetProtocol() [2/2]

void Aws::ECS::Model::PortMapping::SetProtocol ( TransportProtocol &&  value)
inline

The protocol used for the port mapping. Valid values are tcp and udp. The default is tcp.

Definition at line 246 of file PortMapping.h.

◆ WithContainerPort()

PortMapping& Aws::ECS::Model::PortMapping::WithContainerPort ( int  value)
inline

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.

Definition at line 100 of file PortMapping.h.

◆ WithHostPort()

PortMapping& Aws::ECS::Model::PortMapping::WithHostPort ( int  value)
inline

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-51680. 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 can have up to 100 reserved ports at a time, including the default reserved ports. Automatically assigned ports don't count toward the 100 reserved ports limit.

Definition at line 221 of file PortMapping.h.

◆ WithProtocol() [1/2]

PortMapping& Aws::ECS::Model::PortMapping::WithProtocol ( const TransportProtocol value)
inline

The protocol used for the port mapping. Valid values are tcp and udp. The default is tcp.

Definition at line 252 of file PortMapping.h.

◆ WithProtocol() [2/2]

PortMapping& Aws::ECS::Model::PortMapping::WithProtocol ( TransportProtocol &&  value)
inline

The protocol used for the port mapping. Valid values are tcp and udp. The default is tcp.

Definition at line 258 of file PortMapping.h.


The documentation for this class was generated from the following file: