software.amazon.awscdk.services.ecs

Enum NetworkMode

java.lang.Object

java.lang.Enum<NetworkMode>

software.amazon.awscdk.services.ecs.NetworkMode

All Implemented Interfaces:

Serializable, Comparable<NetworkMode>

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.738Z")
 @Stability(value=Stable)
public enum NetworkMode
extends Enum<NetworkMode>

The networking mode to use for the containers in the task.

Example:

 Ec2TaskDefinition ec2TaskDefinition = Ec2TaskDefinition.Builder.create(this, "TaskDef")
         .networkMode(NetworkMode.BRIDGE)
         .build();
 ContainerDefinition container = ec2TaskDefinition.addContainer("WebContainer", ContainerDefinitionOptions.builder()
         // Use an image from DockerHub
         .image(ContainerImage.fromRegistry("amazon/amazon-ecs-sample"))
         .memoryLimitMiB(1024)
         .build());
 

Enum Constant Summary

Enum Constants

Enum Constant and Description
AWS_VPC The task is allocated an elastic network interface.
BRIDGE The task utilizes Docker's built-in virtual network which runs inside each container instance.
HOST The task bypasses Docker's built-in virtual network and maps container ports directly to the EC2 instance's network interface directly.
NAT The task utilizes NAT network mode required by Windows containers.
NONE The task's containers do not have external connectivity and port mappings can't be specified in the container definition.

Method Summary

Modifier and Type	Method and Description
static NetworkMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static NetworkMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

@Stability(value=Stable)
public static final NetworkMode NONE

The task's containers do not have external connectivity and port mappings can't be specified in the container definition.

BRIDGE

@Stability(value=Stable)
public static final NetworkMode BRIDGE

The task utilizes Docker's built-in virtual network which runs inside each container instance.

AWS_VPC

@Stability(value=Stable)
public static final NetworkMode AWS_VPC

The task is allocated an elastic network interface.

HOST

@Stability(value=Stable)
public static final NetworkMode HOST

The task bypasses Docker's built-in virtual network and maps container ports directly to the EC2 instance's network interface directly.

In this mode, you can't run multiple instantiations of the same task on a single container instance when port mappings are used.

NAT

@Stability(value=Stable)
public static final NetworkMode NAT

The task utilizes NAT network mode required by Windows containers.

This is the only supported network mode for Windows containers. For more information, see Task Definition Parameters.

Method Detail

values

public static NetworkMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (NetworkMode c : NetworkMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static NetworkMode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null