Skip to content
v2.275.0

CfnDBSubnetGroupProps Struct ​

Properties for defining a CfnDBSubnetGroup.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_docdb as docdb } from 'aws-cdk-lib';
const cfnDBSubnetGroupProps: docdb.CfnDBSubnetGroupProps = {
  dbSubnetGroupDescription: 'dbSubnetGroupDescription',
  subnetIds: ['subnetIds'],

  // the properties below are optional
  dbSubnetGroupName: 'dbSubnetGroupName',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties ​

dbSubnetGroupDescriptionstringdb_subnet_group_descriptionstrdbSubnetGroupDescriptionStringDbSubnetGroupDescriptionstringDbSubnetGroupDescription*stringrequired#
The description for the subnet group.
dbSubnetGroupNameoptionalstringdb_subnet_group_nameoptionalstrdbSubnetGroupNameoptionalStringDbSubnetGroupNameoptionalstringDbSubnetGroupNameoptional*string#
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

subnetIdsstring[]subnet_idstyping.List[str]subnetIdsList<String>SubnetIdsstring[]SubnetIds*[]*stringrequired#
The Amazon EC2 subnet IDs for the subnet group.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
The tags to be assigned to the subnet group.