Skip to content

DBSubnetGroup

Source code in docs_src/capo_rds/types/db_subnet_group.py
class DBSubnetGroup(TypedDict, closed=True):
    db_subnet_group_name: NotRequired["capo_rds.types.string.String"]
    """<p>The name of the DB subnet group.</p>"""
    db_subnet_group_description: NotRequired["capo_rds.types.string.String"]
    """<p>Provides the description of the DB subnet group.</p>"""
    vpc_id: NotRequired["capo_rds.types.string.String"]
    """<p>Provides the VpcId of the DB subnet group.</p>"""
    subnet_group_status: NotRequired["capo_rds.types.string.String"]
    """<p>Provides the status of the DB subnet group.</p>"""
    subnets: NotRequired["capo_rds.types.subnet_list.SubnetList"]
    """<p>Contains a list of <code>Subnet</code> elements. The list of subnets shown here might not reflect the current state of your VPC. For the most up-to-date information, we recommend checking your VPC configuration directly.</p>"""
    db_subnet_group_arn: NotRequired["capo_rds.types.string.String"]
    """<p>The Amazon Resource Name (ARN) for the DB subnet group.</p>"""
    supported_network_types: NotRequired["capo_rds.types.string_list.StringList"]
    """<p>The network type of the DB subnet group.</p> <p>Valid values:</p> <ul> <li> <p> <code>IPV4</code> </p> </li> <li> <p> <code>DUAL</code> </p> </li> </ul> <p>A <code>DBSubnetGroup</code> can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (<code>DUAL</code>).</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html"> Working with a DB instance in a VPC</a> in the <i>Amazon RDS User Guide.</i> </p>"""

db_subnet_group_arn instance-attribute

db_subnet_group_arn: NotRequired[String]

The Amazon Resource Name (ARN) for the DB subnet group.

db_subnet_group_description instance-attribute

db_subnet_group_description: NotRequired[String]

Provides the description of the DB subnet group.

db_subnet_group_name instance-attribute

db_subnet_group_name: NotRequired[String]

The name of the DB subnet group.

subnet_group_status instance-attribute

subnet_group_status: NotRequired[String]

Provides the status of the DB subnet group.

subnets instance-attribute

subnets: NotRequired[SubnetList]

Contains a list of Subnet elements. The list of subnets shown here might not reflect the current state of your VPC. For the most up-to-date information, we recommend checking your VPC configuration directly.

supported_network_types instance-attribute

supported_network_types: NotRequired[StringList]

The network type of the DB subnet group.

Valid values:

  • IPV4

  • DUAL

A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).

For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

vpc_id instance-attribute

vpc_id: NotRequired[String]

Provides the VpcId of the DB subnet group.