Interface SubnetConfiguration

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
SubnetConfiguration.Jsii$Proxy

@Generated(value="jsii-pacmak/1.95.0 (build f1ff514)", date="2024-03-26T18:09:22.876Z") @Stability(Stable) public interface SubnetConfiguration extends software.amazon.jsii.JsiiSerializable
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.PRIVATE_ISOLATED)
         // the properties below are optional
         .cidrMask(123)
         .ipv6AssignAddressOnCreation(false)
         .mapPublicIpOnLaunch(false)
         .reserved(false)
         .build();
 
  • Method Details

    • getName

      @Stability(Stable) @NotNull 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

      @Stability(Stable) @NotNull SubnetType getSubnetType()
      The type of Subnet to configure.

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

    • getCidrMask

      @Stability(Stable) @Nullable default 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.

      Note this is specific to IPv4 addresses.

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

    • getIpv6AssignAddressOnCreation

      @Stability(Stable) @Nullable default Boolean getIpv6AssignAddressOnCreation()
      This property is specific to dual stack VPCs.

      If set to false, then an IPv6 address will not be automatically assigned.

      Note this is specific to IPv6 addresses.

      Default: true

    • getMapPublicIpOnLaunch

      @Stability(Stable) @Nullable default Boolean getMapPublicIpOnLaunch()
      Controls if a public IPv4 address is associated to an instance at launch.

      Note this is specific to IPv4 addresses.

      Default: true in Subnet.Public of IPV4_ONLY VPCs, false otherwise

    • getReserved

      @Stability(Stable) @Nullable default 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

      @Stability(Stable) static SubnetConfiguration.Builder builder()
      Returns:
      a SubnetConfiguration.Builder of SubnetConfiguration