Package software.amazon.awssdk.services.ecs.model

Interface NetworkBinding.Builder

All Superinterfaces:
Buildable, CopyableBuilder<NetworkBinding.Builder,NetworkBinding>, SdkBuilder<NetworkBinding.Builder,NetworkBinding>, SdkPojo
Enclosing class:
NetworkBinding
public static interface NetworkBinding.Builder extends SdkPojo, CopyableBuilder<NetworkBinding.Builder,NetworkBinding>

  • Method Details

    • bindIP

      NetworkBinding.Builder bindIP(String bindIP)

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

      Parameters:
      bindIP - The IP address that the container is bound to on the container instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • containerPort

      NetworkBinding.Builder containerPort(Integer containerPort)

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

      Parameters:
      containerPort - The port number on the container that's used with the network binding.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • hostPort

      NetworkBinding.Builder hostPort(Integer hostPort)

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

      Parameters:
      hostPort - The port number on the host that's used with the network binding.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • protocol

      NetworkBinding.Builder protocol(String protocol)

      The protocol used for the network binding.

      Parameters:
      protocol - The protocol used for the network binding.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • protocol

      NetworkBinding.Builder protocol(TransportProtocol protocol)

      The protocol used for the network binding.

      Parameters:
      protocol - The protocol used for the network binding.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • containerPortRange

      NetworkBinding.Builder containerPortRange(String 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 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.

      Parameters:
      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 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • hostPortRange

      NetworkBinding.Builder hostPortRange(String 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.