CfnDBSubnetGroupProps

class aws_cdk.aws_docdb.CfnDBSubnetGroupProps(*, db_subnet_group_description, subnet_ids, db_subnet_group_name=None, tags=None)

Bases: object

Properties for defining a CfnDBSubnetGroup.

Parameters:
  • db_subnet_group_description (str) – The description for the subnet group.

  • subnet_ids (Sequence[str]) – The Amazon EC2 subnet IDs for the subnet group.

  • db_subnet_group_name (Optional[str]) – The name for the subnet group. This value is stored as a lowercase string. Constraints: Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. Must not be default. Example: mySubnetgroup

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags to be assigned to the subnet group.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbsubnetgroup.html

ExampleMetadata:

fixture=_generated

Example:

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

cfn_dBSubnet_group_props = docdb.CfnDBSubnetGroupProps(
    db_subnet_group_description="dbSubnetGroupDescription",
    subnet_ids=["subnetIds"],

    # the properties below are optional
    db_subnet_group_name="dbSubnetGroupName",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

db_subnet_group_description

The description for the subnet group.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbsubnetgroup.html#cfn-docdb-dbsubnetgroup-dbsubnetgroupdescription

db_subnet_group_name

The name for the subnet group. This value is stored as a lowercase string.

Constraints: Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. Must not be default.

Example: mySubnetgroup

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbsubnetgroup.html#cfn-docdb-dbsubnetgroup-dbsubnetgroupname

subnet_ids

The Amazon EC2 subnet IDs for the subnet group.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbsubnetgroup.html#cfn-docdb-dbsubnetgroup-subnetids

tags

The tags to be assigned to the subnet group.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbsubnetgroup.html#cfn-docdb-dbsubnetgroup-tags