CfnDBSubnetGroupProps

class aws_cdk.aws_rds.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 DB subnet group.

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

  • db_subnet_group_name (Optional[str]) – The name for the DB subnet group. This value is stored as a lowercase string. Constraints: Must contain no more than 255 lowercase alphanumeric characters or hyphens. Must not be “Default”. Example: mysubnetgroup

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Tags to assign to the DB subnet group.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-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.
import aws_cdk.aws_rds as rds

cfn_dBSubnet_group_props = rds.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 DB subnet group.

Link

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

Return type

str

db_subnet_group_name

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

Constraints: Must contain no more than 255 lowercase alphanumeric characters or hyphens. Must not be “Default”.

Example: mysubnetgroup

Link

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

Return type

Optional[str]

subnet_ids

The EC2 Subnet IDs for the DB subnet group.

Link

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

Return type

List[str]

tags

Tags to assign to the DB subnet group.

Link

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

Return type

Optional[List[CfnTag]]