software.amazon.awscdk.services.ecs

Interface PortMapping

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

PortMapping.Jsii$Proxy

@Generated(value="jsii-pacmak/1.39.0 (build 8af72c2)",
           date="2021-10-14T05:49:31.965Z")
 @Stability(value=Stable)
public interface PortMapping
extends software.amazon.jsii.JsiiSerializable

Port mappings allow containers to access ports on the host container instance to send or receive traffic.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PortMapping.Builder A builder for PortMapping
static class	PortMapping.Jsii$Proxy An implementation for PortMapping

Method Summary

Modifier and Type	Method and Description
static PortMapping.Builder	builder()
Number	getContainerPort() The port number on the container that is bound to the user-specified or automatically assigned host port.
default Number	getHostPort() The port number on the container instance to reserve for your container.
default Protocol	getProtocol() The protocol used for the port mapping.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getContainerPort

@Stability(value=Stable)
 @NotNull
Number getContainerPort()

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.

getHostPort

@Stability(value=Stable)
 @Nullable
default Number getHostPort()

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.

getProtocol

@Stability(value=Stable)
 @Nullable
default Protocol getProtocol()

The protocol used for the port mapping.

Valid values are Protocol.TCP and Protocol.UDP.

Default: TCP

builder

@Stability(value=Stable)
static PortMapping.Builder builder()

Returns:

a PortMapping.Builder of PortMapping