VpcSubnetGroup

class aws_cdk.cx_api.VpcSubnetGroup(*, name, subnets, type)

Bases: object

A group of subnets returned by the VPC provider.

The included subnets do NOT have to be symmetric!

Parameters
  • name (str) – The name of the subnet group, determined by looking at the tags of of the subnets that belong to it.

  • subnets (Sequence[Union[VpcSubnet, Dict[str, Any]]]) – The subnets that are part of this group. There is no condition that the subnets have to be symmetric in the group.

  • type (VpcSubnetGroupType) – The type of the subnet group.

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.cx_api as cx_api

vpc_subnet_group = cx_api.VpcSubnetGroup(
    name="name",
    subnets=[cx_api.VpcSubnet(
        availability_zone="availabilityZone",
        route_table_id="routeTableId",
        subnet_id="subnetId",

        # the properties below are optional
        cidr="cidr"
    )],
    type=cx_api.VpcSubnetGroupType.PUBLIC
)

Attributes

name

The name of the subnet group, determined by looking at the tags of of the subnets that belong to it.

Return type

str

subnets

The subnets that are part of this group.

There is no condition that the subnets have to be symmetric in the group.

Return type

List[VpcSubnet]

type

The type of the subnet group.

Return type

VpcSubnetGroupType