Amazonka.ECS.Types.NetworkBinding

Documentation

data NetworkBinding

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.

See: newNetworkBinding smart constructor.

Constructors

NetworkBinding'

Fields

• bindIP :: Maybe Text

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

• containerPort :: Maybe Int

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

• containerPortRange :: Maybe Text

  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 hostPort is set to the same value as the containerPort. 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 to view the hostPortRange which are the host ports that are bound to the container ports.

• hostPort :: Maybe Int

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

• hostPortRange :: Maybe Text

  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.

• protocol :: Maybe TransportProtocol

  The protocol used for the network binding.

Instances

FromJSON NetworkBinding

Defined in Amazonka.ECS.Types.NetworkBinding

Methods

parseJSON :: Value -> Parser NetworkBinding

parseJSONList :: Value -> Parser [NetworkBinding]

ToJSON NetworkBinding

Defined in Amazonka.ECS.Types.NetworkBinding

Methods

toJSON :: NetworkBinding -> Value

toEncoding :: NetworkBinding -> Encoding

toJSONList :: [NetworkBinding] -> Value

toEncodingList :: [NetworkBinding] -> Encoding

Generic NetworkBinding

Defined in Amazonka.ECS.Types.NetworkBinding

Associated Types

type Rep NetworkBinding :: Type -> Type

Methods

from :: NetworkBinding -> Rep NetworkBinding x

to :: Rep NetworkBinding x -> NetworkBinding

Read NetworkBinding

Defined in Amazonka.ECS.Types.NetworkBinding

Methods

readsPrec :: Int -> ReadS NetworkBinding

readList :: ReadS [NetworkBinding]

readPrec :: ReadPrec NetworkBinding

readListPrec :: ReadPrec [NetworkBinding]

Show NetworkBinding

Defined in Amazonka.ECS.Types.NetworkBinding

Methods

showsPrec :: Int -> NetworkBinding -> ShowS

show :: NetworkBinding -> String

showList :: [NetworkBinding] -> ShowS

NFData NetworkBinding

Defined in Amazonka.ECS.Types.NetworkBinding

Methods

rnf :: NetworkBinding -> ()

Eq NetworkBinding

Defined in Amazonka.ECS.Types.NetworkBinding

Methods

(==) :: NetworkBinding -> NetworkBinding -> Bool

(/=) :: NetworkBinding -> NetworkBinding -> Bool

Hashable NetworkBinding

Defined in Amazonka.ECS.Types.NetworkBinding

Methods

hashWithSalt :: Int -> NetworkBinding -> Int

hash :: NetworkBinding -> Int

type Rep NetworkBinding

Defined in Amazonka.ECS.Types.NetworkBinding

type Rep NetworkBinding = D1 ('MetaData "NetworkBinding" "Amazonka.ECS.Types.NetworkBinding" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "NetworkBinding'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "bindIP") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "containerPort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "containerPortRange") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "hostPort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "hostPortRange") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "protocol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TransportProtocol))))))

newNetworkBinding :: NetworkBinding

Create a value of NetworkBinding with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:bindIP:NetworkBinding', networkBinding_bindIP - The IP address that the container is bound to on the container instance.

$sel:containerPort:NetworkBinding', networkBinding_containerPort - The port number on the container that's used with the network binding.

$sel:containerPortRange:NetworkBinding', networkBinding_containerPortRange - 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 hostPort is set to the same value as the containerPort. 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 to view the hostPortRange which are the host ports that are bound to the container ports.

$sel:hostPort:NetworkBinding', networkBinding_hostPort - The port number on the host that's used with the network binding.

$sel:hostPortRange:NetworkBinding', networkBinding_hostPortRange - 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.

$sel:protocol:NetworkBinding', networkBinding_protocol - The protocol used for the network binding.

networkBinding_bindIP :: Lens' NetworkBinding (Maybe Text)

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

networkBinding_containerPort :: Lens' NetworkBinding (Maybe Int)

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

networkBinding_containerPortRange :: Lens' NetworkBinding (Maybe Text)

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 hostPort is set to the same value as the containerPort. 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 to view the hostPortRange which are the host ports that are bound to the container ports.

networkBinding_hostPort :: Lens' NetworkBinding (Maybe Int)

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

networkBinding_hostPortRange :: Lens' NetworkBinding (Maybe Text)

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.

networkBinding_protocol :: Lens' NetworkBinding (Maybe TransportProtocol)

The protocol used for the network binding.