Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data NetworkBinding = NetworkBinding' {}
- newNetworkBinding :: NetworkBinding
- networkBinding_bindIP :: Lens' NetworkBinding (Maybe Text)
- networkBinding_containerPort :: Lens' NetworkBinding (Maybe Int)
- networkBinding_containerPortRange :: Lens' NetworkBinding (Maybe Text)
- networkBinding_hostPort :: Lens' NetworkBinding (Maybe Int)
- networkBinding_hostPortRange :: Lens' NetworkBinding (Maybe Text)
- networkBinding_protocol :: Lens' NetworkBinding (Maybe TransportProtocol)
Documentation
data NetworkBinding Source #
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.
NetworkBinding' | |
|
Instances
newNetworkBinding :: NetworkBinding Source #
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 theawsvpc
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 thehostPortRange
is set as follows:- For containers in a task with the
awsvpc
network mode, thehostPort
is set to the same value as thecontainerPort
. 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.
- For containers in a task with the
- 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) Source #
The IP address that the container is bound to on the container instance.
networkBinding_containerPort :: Lens' NetworkBinding (Maybe Int) Source #
The port number on the container that's used with the network binding.
networkBinding_containerPortRange :: Lens' NetworkBinding (Maybe Text) Source #
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 theawsvpc
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 thehostPortRange
is set as follows:- For containers in a task with the
awsvpc
network mode, thehostPort
is set to the same value as thecontainerPort
. 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.
- For containers in a task with the
- 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) Source #
The port number on the host that's used with the network binding.
networkBinding_hostPortRange :: Lens' NetworkBinding (Maybe Text) Source #
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) Source #
The protocol used for the network binding.