Skip to content

DBSubnetGroup

Source code in docs_src/capo_docdb/types/db_subnet_group.py
class DBSubnetGroup(TypedDict, closed=True):
    db_subnet_group_name: NotRequired["capo_docdb.types.string.String"]
    """<p>The name of the subnet group.</p>"""
    db_subnet_group_description: NotRequired["capo_docdb.types.string.String"]
    """<p>Provides the description of the subnet group.</p>"""
    vpc_id: NotRequired["capo_docdb.types.string.String"]
    """<p>Provides the virtual private cloud (VPC) ID of the subnet group.</p>"""
    subnet_group_status: NotRequired["capo_docdb.types.string.String"]
    """<p>Provides the status of the subnet group.</p>"""
    subnets: NotRequired["capo_docdb.types.subnet_list.SubnetList"]
    """<p>Detailed information about one or more subnets within a subnet group.</p>"""
    db_subnet_group_arn: NotRequired["capo_docdb.types.string.String"]
    """<p>The Amazon Resource Name (ARN) for the DB subnet group.</p>"""
    supported_network_types: NotRequired[
        "capo_docdb.types.network_type_list.NetworkTypeList"
    ]
    """<p>The network type of the DB subnet group.</p> <p>Valid Values: <code>IPV4</code> | <code>DUAL</code> </p> <p>A <code>DBSubnetGroup</code> can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).</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 subnet group.

db_subnet_group_name instance-attribute

db_subnet_group_name: NotRequired[String]

The name of the subnet group.

subnet_group_status instance-attribute

subnet_group_status: NotRequired[String]

Provides the status of the subnet group.

subnets instance-attribute

subnets: NotRequired[SubnetList]

Detailed information about one or more subnets within a subnet group.

supported_network_types instance-attribute

supported_network_types: NotRequired[NetworkTypeList]

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).

vpc_id instance-attribute

vpc_id: NotRequired[String]

Provides the virtual private cloud (VPC) ID of the subnet group.