aws-cdk-lib.aws_docdb.CfnDBSubnetGroupProps

interface CfnDBSubnetGroupProps

LanguageType name
.NETAmazon.CDK.AWS.DocDB.CfnDBSubnetGroupProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsdocdb#CfnDBSubnetGroupProps
Javasoftware.amazon.awscdk.services.docdb.CfnDBSubnetGroupProps
Pythonaws_cdk.aws_docdb.CfnDBSubnetGroupProps
TypeScript aws-cdk-lib » aws_docdb » CfnDBSubnetGroupProps

Properties for defining a CfnDBSubnetGroup.

Example

// 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

NameTypeDescription
dbSubnetGroupDescriptionstringThe description for the subnet group.
subnetIdsstring[]The Amazon EC2 subnet IDs for the subnet group.
dbSubnetGroupName?stringThe name for the subnet group. This value is stored as a lowercase string.
tags?CfnTag[]The tags to be assigned to the subnet group.

dbSubnetGroupDescription

Type: string

The description for the subnet group.


subnetIds

Type: string[]

The Amazon EC2 subnet IDs for the subnet group.


dbSubnetGroupName?

Type: string (optional)

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?

Type: CfnTag[] (optional)

The tags to be assigned to the subnet group.