software.amazon.awscdk.services.ec2

Interface SubnetConfiguration

All Known Implementing Classes:

SubnetConfiguration.Jsii$Proxy

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-09T19:16:37.591Z")
public interface SubnetConfiguration

Specify configuration parameters for a single subnet group in a VPC.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ec2.*;
 SubnetConfiguration subnetConfiguration = SubnetConfiguration.builder()
         .name("name")
         .subnetType(SubnetType.ISOLATED)
         // the properties below are optional
         .cidrMask(123)
         .mapPublicIpOnLaunch(false)
         .reserved(false)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static SubnetConfiguration.Builder	builder()
default java.lang.Number	getCidrMask() The number of leading 1 bits in the routing mask.
default java.lang.Boolean	getMapPublicIpOnLaunch() Controls if a public IP is associated to an instance at launch.
java.lang.String	getName() Logical name for the subnet group.
default java.lang.Boolean	getReserved() Controls if subnet IP space needs to be reserved.
SubnetType	getSubnetType() The type of Subnet to configure.

Method Detail

getName

java.lang.String getName()

Logical name for the subnet group.

This name can be used when selecting VPC subnets to distinguish between different subnet groups of the same type.

getSubnetType

SubnetType getSubnetType()

The type of Subnet to configure.

The Subnet type will control the ability to route and connect to the Internet.

getCidrMask

default java.lang.Number getCidrMask()

The number of leading 1 bits in the routing mask.

The number of available IP addresses in each subnet of this group will be equal to 2^(32 - cidrMask) - 2.

Valid values are 16--28.

Default: - Available IP space is evenly divided across subnets.

getMapPublicIpOnLaunch

default java.lang.Boolean getMapPublicIpOnLaunch()

Controls if a public IP is associated to an instance at launch.

Default: true in Subnet.Public, false in Subnet.Private or Subnet.Isolated.

getReserved

default java.lang.Boolean getReserved()

Controls if subnet IP space needs to be reserved.

When true, the IP space for the subnet is reserved but no actual resources are provisioned. This space is only dependent on the number of availability zones and on cidrMask - all other subnet properties are ignored.

Default: false

builder

static SubnetConfiguration.Builder builder()

Returns:

a SubnetConfiguration.Builder of SubnetConfiguration