Struct NetworkBinding

#[non_exhaustive]
pub struct NetworkBinding {
    pub bind_ip: Option<String>,
    pub container_port: Option<i32>,
    pub host_port: Option<i32>,
    pub protocol: Option<TransportProtocol>,
    pub container_port_range: Option<String>,
    pub host_port_range: Option<String>,
}

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

bind_ip: Option<String>

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

container_port: Option<i32>

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

host_port: Option<i32>

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

protocol: Option<TransportProtocol>

The protocol used for the network binding.

container_port_range: Option<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 to view the hostPortRange which are the host ports that are bound to the container ports.

host_port_range: Option<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.

Implementations

impl NetworkBinding

pub fn bind_ip(&self) -> Option<&str>

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

pub fn container_port(&self) -> Option<i32>

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

pub fn host_port(&self) -> Option<i32>

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

pub fn protocol(&self) -> Option<&TransportProtocol>

The protocol used for the network binding.

pub fn container_port_range(&self) -> Option<&str>

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 to view the hostPortRange which are the host ports that are bound to the container ports.

pub fn host_port_range(&self) -> Option<&str>

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.

impl NetworkBinding

pub fn builder() -> NetworkBindingBuilder

Creates a new builder-style object to manufacture NetworkBinding.

Trait Implementations

impl Clone for NetworkBinding

fn clone(&self) -> NetworkBinding

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for NetworkBinding

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for NetworkBinding

fn eq(&self, other: &NetworkBinding) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for NetworkBinding