Package software.amazon.awscdk.services.ecs

Class PortMapping.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.ecs.PortMapping.Jsii$Proxy
All Implemented Interfaces:
PortMapping, software.amazon.jsii.JsiiSerializable
Enclosing interface:
PortMapping
@Stability(Stable) @Internal public static final class PortMapping.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements PortMapping
An implementation for PortMapping

  • Nested Class Summary

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

    Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ecs.PortMapping

    PortMapping.Builder, PortMapping.Jsii$Proxy

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Jsii$Proxy(PortMapping.Builder builder)
    Constructor that initializes the object based on literal property values passed by the PortMapping.Builder.
    protected
    Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
    Constructor that initializes the object based on values retrieved from the JsiiObject.

  • Method Summary

    Modifier and Type
    Method
    Description
    com.fasterxml.jackson.databind.JsonNode
    $jsii$toJson()
     
    final boolean
    equals(Object o)
     
    final AppProtocol
    getAppProtocol()
    The protocol used by Service Connect.
    final Number
    getContainerPort()
    The port number on the container that is bound to the user-specified or automatically assigned host port.
    final String
    getContainerPortRange()
    The port number range on the container that's bound to the dynamically mapped host port range.
    final Number
    getHostPort()
    The port number on the container instance to reserve for your container.
    final String
    getName()
    The name to give the port mapping.
    final Protocol
    getProtocol()
    The protocol used for the port mapping.
    final int
    hashCode()
     

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • Jsii$Proxy

      protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
      Constructor that initializes the object based on values retrieved from the JsiiObject.
      Parameters:
      objRef - Reference to the JSII managed object.

    • Jsii$Proxy

      protected Jsii$Proxy(PortMapping.Builder builder)
      Constructor that initializes the object based on literal property values passed by the PortMapping.Builder.

  • Method Details

    • getContainerPort

      public final Number getContainerPort()
      Description copied from interface: PortMapping
      The port number on the container that is bound to the user-specified or automatically assigned host port.

      If you are using containers in a task with the awsvpc or host network mode, exposed ports should be specified using containerPort. If you are using containers in a task with the bridge network mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range.

      For more information, see hostPort. Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance.

      If you want to expose a port range, you must specify CONTAINER_PORT_USE_RANGE as container port.

      Specified by:
      getContainerPort in interface PortMapping

    • getAppProtocol

      public final AppProtocol getAppProtocol()
      Description copied from interface: PortMapping
      The protocol used by Service Connect.

      Valid values are AppProtocol.http, AppProtocol.http2, and AppProtocol.grpc. The protocol determines what telemetry will be shown in the ECS Console for Service Connect services using this port mapping.

      This field may only be set when the task definition uses Bridge or Awsvpc network modes.

      Default: - no app protocol

      Specified by:
      getAppProtocol in interface PortMapping

    • getContainerPortRange

      public final String getContainerPortRange()
      Description copied from interface: PortMapping
      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 specify CONTAINER_PORT_USE_RANGE as containerPort
      • You must use either the bridge network mode or the awsvpc network mode.
      • 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.
      • 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.

      If you want to expose a single port, you must not set a range.

      Specified by:
      getContainerPortRange in interface PortMapping

    • getHostPort

      public final Number getHostPort()
      Description copied from interface: PortMapping
      The port number on the container instance to reserve for your container.

      If you are using containers in a task with the awsvpc or host network mode, the hostPort can either be left blank or set to the same value as the containerPort.

      If you are using containers in a task with the bridge network mode, you can specify a non-reserved host port for your container port mapping, or you can omit the hostPort (or set it to 0) while specifying a containerPort and your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version.

      Specified by:
      getHostPort in interface PortMapping

    • getName

      public final String getName()
      Description copied from interface: PortMapping
      The name to give the port mapping.

      Name is required in order to use the port mapping with ECS Service Connect. This field may only be set when the task definition uses Bridge or Awsvpc network modes.

      Default: - no port mapping name

      Specified by:
      getName in interface PortMapping

    • getProtocol

      public final Protocol getProtocol()
      Description copied from interface: PortMapping
      The protocol used for the port mapping.

      Valid values are Protocol.TCP and Protocol.UDP.

      Default: TCP

      Specified by:
      getProtocol in interface PortMapping

    • $jsii$toJson

      @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
      Specified by:
      $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

    • equals

      public final boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object