SubnetConfiguration

class aws_cdk.aws_ec2.SubnetConfiguration(*, name, subnet_type, cidr_mask=None, map_public_ip_on_launch=None, reserved=None)

Bases: object

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

Parameters
  • name (str) – 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.

  • subnet_type (SubnetType) – The type of Subnet to configure. The Subnet type will control the ability to route and connect to the Internet.

  • cidr_mask (Union[int, float, None]) – 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.

  • map_public_ip_on_launch (Optional[bool]) – Controls if a public IP is associated to an instance at launch. Default: true in Subnet.Public, false in Subnet.Private or Subnet.Isolated.

  • reserved (Optional[bool]) – 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

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_ec2 as ec2

subnet_configuration = ec2.SubnetConfiguration(
    name="name",
    subnet_type=ec2.SubnetType.ISOLATED,

    # the properties below are optional
    cidr_mask=123,
    map_public_ip_on_launch=False,
    reserved=False
)

Attributes

cidr_mask

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.

Return type

Union[int, float, None]

map_public_ip_on_launch

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

Default

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

Return type

Optional[bool]

name

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.

Return type

str

reserved

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

Return type

Optional[bool]

subnet_type

The type of Subnet to configure.

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

Return type

SubnetType