You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::ECS::Types::PortMapping

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb

Overview

Note:

When making an API call, you may pass PortMapping data as a hash:

{
  container_port: 1,
  host_port: 1,
  protocol: "tcp", # accepts tcp, udp
}

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.

Instance Attribute Summary collapse

Instance Attribute Details

#container_portInteger

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.

Returns:

  • (Integer)


2753
2754
2755
2756
2757
2758
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 2753

class PortMapping < Struct.new(
  :container_port,
  :host_port,
  :protocol)
  include Aws::Structure
end

#host_portInteger

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).

Returns:

  • (Integer)


2753
2754
2755
2756
2757
2758
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 2753

class PortMapping < Struct.new(
  :container_port,
  :host_port,
  :protocol)
  include Aws::Structure
end

#protocolString

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

Returns:

  • (String)


2753
2754
2755
2756
2757
2758
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 2753

class PortMapping < Struct.new(
  :container_port,
  :host_port,
  :protocol)
  include Aws::Structure
end