interface SubnetConfiguration
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.EC2.SubnetConfiguration |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsec2#SubnetConfiguration |
![]() | software.amazon.awscdk.services.ec2.SubnetConfiguration |
![]() | aws_cdk.aws_ec2.SubnetConfiguration |
![]() | aws-cdk-lib » aws_ec2 » 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 { aws_ec2 as ec2 } from 'aws-cdk-lib';
const subnetConfiguration: ec2.SubnetConfiguration = {
name: 'name',
subnetType: ec2.SubnetType.PRIVATE_ISOLATED,
// the properties below are optional
cidrMask: 123,
ipv6AssignAddressOnCreation: false,
mapPublicIpOnLaunch: false,
reserved: false,
};
Properties
Name | Type | Description |
---|---|---|
name | string | Logical name for the subnet group. |
subnet | Subnet | The type of Subnet to configure. |
cidr | number | The number of leading 1 bits in the routing mask. |
ipv6 | boolean | This property is specific to dual stack VPCs. |
map | boolean | Controls if a public IPv4 address is associated to an instance at launch. |
reserved? | boolean | Controls if subnet IP space needs to be reserved. |
name
Type:
string
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.
subnetType
Type:
Subnet
The type of Subnet to configure.
The Subnet type will control the ability to route and connect to the Internet.
cidrMask?
Type:
number
(optional, default: Available IP space is evenly divided across subnets.)
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.
ipv6AssignAddressOnCreation?
Type:
boolean
(optional, default: true)
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.
mapPublicIpOnLaunch?
Type:
boolean
(optional, default: true in Subnet.Public of IPV4_ONLY VPCs, false otherwise)
Controls if a public IPv4 address is associated to an instance at launch.
Note this is specific to IPv4 addresses.
reserved?
Type:
boolean
(optional, default: false)
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.