software.amazon.awscdk.services.ecs

Class CfnTaskDefinition.PortMappingProperty.Builder

java.lang.Object

software.amazon.awscdk.services.ecs.CfnTaskDefinition.PortMappingProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnTaskDefinition.PortMappingProperty>

Enclosing interface:

CfnTaskDefinition.PortMappingProperty

@Stability(value=Stable)
public static final class CfnTaskDefinition.PortMappingProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnTaskDefinition.PortMappingProperty>

A builder for CfnTaskDefinition.PortMappingProperty

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnTaskDefinition.PortMappingProperty	build() Builds the configured instance.
CfnTaskDefinition.PortMappingProperty.Builder	containerPort(Number containerPort) Sets the value of CfnTaskDefinition.PortMappingProperty.getContainerPort()
CfnTaskDefinition.PortMappingProperty.Builder	hostPort(Number hostPort) Sets the value of CfnTaskDefinition.PortMappingProperty.getHostPort()
CfnTaskDefinition.PortMappingProperty.Builder	protocol(String protocol) Sets the value of CfnTaskDefinition.PortMappingProperty.getProtocol()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

containerPort

@Stability(value=Stable)
public CfnTaskDefinition.PortMappingProperty.Builder containerPort(Number containerPort)

Sets the value of CfnTaskDefinition.PortMappingProperty.getContainerPort()

Parameters:

containerPort - The port number on the container that's bound to the user-specified or automatically assigned host port. If you use containers in a task with the awsvpc or host network mode, specify the exposed ports using containerPort .

If you use 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.

Returns:

this

hostPort

@Stability(value=Stable)
public CfnTaskDefinition.PortMappingProperty.Builder hostPort(Number hostPort)

Sets the value of CfnTaskDefinition.PortMappingProperty.getHostPort()

Parameters:

hostPort - 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.

The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under /proc/sys/net/ipv4/ip_local_port_range . If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 is used. Do not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.

The default ephemeral port range from 49153 through 65535 is always used for Docker versions before 1.6.0.

The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678-51680. Any host port that was previously specified in a running task is also reserved while the task is running (after a task stops, the host port is released). The current reserved ports are displayed in the remainingResources of DescribeContainerInstances output. A container instance can have up to 100 reserved ports at a time, including the default reserved ports. Automatically assigned ports don't count toward the 100 reserved ports limit.

Returns:

this

protocol

@Stability(value=Stable)
public CfnTaskDefinition.PortMappingProperty.Builder protocol(String protocol)

Sets the value of CfnTaskDefinition.PortMappingProperty.getProtocol()

Parameters:

protocol - The protocol used for the port mapping. Valid values are tcp and udp . The default is tcp .

Returns:

this

build

@Stability(value=Stable)
public CfnTaskDefinition.PortMappingProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnTaskDefinition.PortMappingProperty>

Returns:

a new instance of CfnTaskDefinition.PortMappingProperty

Throws:

NullPointerException - if any required attribute was not provided