SubnetGroupProps

class aws_cdk.aws_rds.SubnetGroupProps(*, description, vpc, removal_policy=None, subnet_group_name=None, vpc_subnets=None)

Bases: object

Properties for creating a SubnetGroup.

Parameters
  • description (str) – Description of the subnet group.

  • vpc (IVpc) – The VPC to place the subnet group in.

  • removal_policy (Optional[RemovalPolicy]) – The removal policy to apply when the subnet group are removed from the stack or replaced during an update. Default: RemovalPolicy.DESTROY

  • subnet_group_name (Optional[str]) – The name of the subnet group. Default: - a name is generated

  • vpc_subnets (Union[SubnetSelection, Dict[str, Any], None]) – Which subnets within the VPC to associate with this group. Default: - private subnets

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
import aws_cdk.aws_rds as rds
import aws_cdk.core as cdk

# subnet: ec2.Subnet
# subnet_filter: ec2.SubnetFilter
# vpc: ec2.Vpc

subnet_group_props = rds.SubnetGroupProps(
    description="description",
    vpc=vpc,

    # the properties below are optional
    removal_policy=cdk.RemovalPolicy.DESTROY,
    subnet_group_name="subnetGroupName",
    vpc_subnets=ec2.SubnetSelection(
        availability_zones=["availabilityZones"],
        one_per_az=False,
        subnet_filters=[subnet_filter],
        subnet_group_name="subnetGroupName",
        subnet_name="subnetName",
        subnets=[subnet],
        subnet_type=ec2.SubnetType.ISOLATED
    )
)

Attributes

description

Description of the subnet group.

Return type

str

removal_policy

The removal policy to apply when the subnet group are removed from the stack or replaced during an update.

Default

RemovalPolicy.DESTROY

Return type

Optional[RemovalPolicy]

subnet_group_name

The name of the subnet group.

Default
  • a name is generated

Return type

Optional[str]

vpc

The VPC to place the subnet group in.

Return type

IVpc

vpc_subnets

Which subnets within the VPC to associate with this group.

Default
  • private subnets

Return type

Optional[SubnetSelection]