software.amazon.awscdk.services.ecs

Class PortMapping.Builder

java.lang.Object

software.amazon.awscdk.services.ecs.PortMapping.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<PortMapping>

Enclosing interface:

PortMapping

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

A builder for PortMapping

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
PortMapping	build() Builds the configured instance.
PortMapping.Builder	containerPort(Number containerPort) Sets the value of PortMapping.getContainerPort()
PortMapping.Builder	hostPort(Number hostPort) Sets the value of PortMapping.getHostPort()
PortMapping.Builder	protocol(Protocol protocol) Sets the value of PortMapping.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 PortMapping.Builder containerPort(Number containerPort)

Sets the value of PortMapping.getContainerPort()

Parameters:

containerPort - The port number on the container that is bound to the user-specified or automatically assigned host port. This parameter is required. 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.

Returns:

this

hostPort

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

Sets the value of PortMapping.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.

Returns:

this

protocol

@Stability(value=Stable)
public PortMapping.Builder protocol(Protocol protocol)

Sets the value of PortMapping.getProtocol()

Parameters:

protocol - The protocol used for the port mapping. Valid values are Protocol.TCP and Protocol.UDP.

Returns:

this

build

@Stability(value=Stable)
public PortMapping build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<PortMapping>

Returns:

a new instance of PortMapping

Throws:

NullPointerException - if any required attribute was not provided