Package software.amazon.awscdk.services.ec2

Enum SubnetType

java.lang.Object

java.lang.Enum<SubnetType>

software.amazon.awscdk.services.ec2.SubnetType

All Implemented Interfaces:

Serializable, Comparable<SubnetType>, java.lang.constant.Constable

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:06.253Z")
@Stability(Stable)
public enum SubnetType
extends Enum<SubnetType>

The type of Subnet.

Example:

 Vpc vpc;
 DatabaseCluster cluster = DatabaseCluster.Builder.create(this, "Database")
         .engine(DatabaseClusterEngine.auroraMysql(AuroraMysqlClusterEngineProps.builder()
                 .version(AuroraMysqlEngineVersion.VER_3_03_0)
                 .build()))
         .instances(2)
         .instanceProps(InstanceProps.builder()
                 .instanceType(InstanceType.of(InstanceClass.BURSTABLE3, InstanceSize.SMALL))
                 .vpcSubnets(SubnetSelection.builder().subnetType(SubnetType.PUBLIC).build())
                 .vpc(vpc)
                 .build())
         .build();
 

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
PRIVATE_ISOLATED	Isolated Subnets do not route traffic to the Internet (in this VPC), and as such, do not require NAT gateways.
PRIVATE_WITH_EGRESS	Subnet that routes to the internet, but not vice versa.
PRIVATE_WITH_NAT	Deprecated. use PRIVATE_WITH_EGRESS
PUBLIC	Subnet connected to the Internet.

Method Summary

Modifier and Type	Method	Description
static SubnetType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SubnetType[]	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PRIVATE_ISOLATED

@Stability(Stable)
public static final SubnetType PRIVATE_ISOLATED

Isolated Subnets do not route traffic to the Internet (in this VPC), and as such, do not require NAT gateways.

Isolated subnets can only connect to or be connected to from other instances in the same VPC. A default VPC configuration will not include isolated subnets.

This can be good for subnets with RDS or Elasticache instances, or which route Internet traffic through a peer VPC.

PRIVATE_WITH_EGRESS

@Stability(Stable)
public static final SubnetType PRIVATE_WITH_EGRESS

Subnet that routes to the internet, but not vice versa.

Instances in a private subnet can connect to the Internet, but will not allow connections to be initiated from the Internet. Egress to the internet will need to be provided. NAT Gateway(s) are the default solution to providing this subnet type the ability to route Internet traffic. If a NAT Gateway is not required or desired, set natGateways:0 or use SubnetType.PRIVATE_ISOLATED instead.

By default, a NAT gateway is created in every public subnet for maximum availability. Be aware that you will be charged for NAT gateways.

Normally a Private subnet will use a NAT gateway in the same AZ, but if natGateways is used to reduce the number of NAT gateways, a NAT gateway from another AZ will be used instead.

PRIVATE_WITH_NAT

@Stability(Deprecated)
@Deprecated
public static final SubnetType PRIVATE_WITH_NAT

Deprecated.

use PRIVATE_WITH_EGRESS

(deprecated) Subnet that routes to the internet (via a NAT gateway), but not vice versa.

Instances in a private subnet can connect to the Internet, but will not allow connections to be initiated from the Internet. NAT Gateway(s) are required with this subnet type to route the Internet traffic through. If a NAT Gateway is not required or desired, use SubnetType.PRIVATE_ISOLATED instead.

By default, a NAT gateway is created in every public subnet for maximum availability. Be aware that you will be charged for NAT gateways.

Normally a Private subnet will use a NAT gateway in the same AZ, but if natGateways is used to reduce the number of NAT gateways, a NAT gateway from another AZ will be used instead.

PUBLIC

@Stability(Stable)
public static final SubnetType PUBLIC

Subnet connected to the Internet.

Instances in a Public subnet can connect to the Internet and can be connected to from the Internet as long as they are launched with public IPs (controlled on the AutoScalingGroup or other constructs that launch instances).

Public subnets route outbound traffic via an Internet Gateway.

Method Details

values

public static SubnetType[] values()

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

Returns:

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

valueOf

public static SubnetType 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