Class: Aws::ECS::Types::NetworkBinding

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

Overview

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.

[1]: docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bind_ip ⇒ String

The IP address that the container is bound to on the container instance.

Returns:

  • (String) 


7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
 
# File 'lib/aws-sdk-ecs/types.rb', line 7314

class NetworkBinding < Struct.new(
  :bind_ip,
  :container_port,
  :host_port,
  :protocol,
  :container_port_range,
  :host_port_range)
  SENSITIVE = []
  include Aws::Structure
end

#container_port ⇒ Integer

The port number on the container that’s used with the network binding.

Returns:

  • (Integer) 


7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
 
# File 'lib/aws-sdk-ecs/types.rb', line 7314

class NetworkBinding < Struct.new(
  :bind_ip,
  :container_port,
  :host_port,
  :protocol,
  :container_port_range,
  :host_port_range)
  SENSITIVE = []
  include Aws::Structure
end

#container_port_range ⇒ String

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 `hostPortRange` is set to the same value as the `containerPortRange`. 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` ][3] to view the `hostPortRange` which are the host ports that are bound to the container ports.

[1]: github.com/moby/moby/issues/11185 [2]: docs.aws.amazon.com/AmazonECS/latest/developerguide/bootstrap_container_instance.html#bootstrap_docker_daemon [3]: docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html

Returns:

  • (String) 


7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
 
# File 'lib/aws-sdk-ecs/types.rb', line 7314

class NetworkBinding < Struct.new(
  :bind_ip,
  :container_port,
  :host_port,
  :protocol,
  :container_port_range,
  :host_port_range)
  SENSITIVE = []
  include Aws::Structure
end

#host_port ⇒ Integer

The port number on the host that’s used with the network binding.

Returns:

  • (Integer) 


7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
 
# File 'lib/aws-sdk-ecs/types.rb', line 7314

class NetworkBinding < Struct.new(
  :bind_ip,
  :container_port,
  :host_port,
  :protocol,
  :container_port_range,
  :host_port_range)
  SENSITIVE = []
  include Aws::Structure
end

#host_port_range ⇒ String

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:

  • (String) 


7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
 
# File 'lib/aws-sdk-ecs/types.rb', line 7314

class NetworkBinding < Struct.new(
  :bind_ip,
  :container_port,
  :host_port,
  :protocol,
  :container_port_range,
  :host_port_range)
  SENSITIVE = []
  include Aws::Structure
end

#protocol ⇒ String

The protocol used for the network binding.

Returns:

  • (String) 


7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
 
# File 'lib/aws-sdk-ecs/types.rb', line 7314

class NetworkBinding < Struct.new(
  :bind_ip,
  :container_port,
  :host_port,
  :protocol,
  :container_port_range,
  :host_port_range)
  SENSITIVE = []
  include Aws::Structure
end