interface DatabaseClusterAttributes

Language	Type name
.NET	Amazon.CDK.AWS.DocDB.DatabaseClusterAttributes
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsdocdb#DatabaseClusterAttributes
Java	software.amazon.awscdk.services.docdb.DatabaseClusterAttributes
Python	aws_cdk.aws_docdb.DatabaseClusterAttributes
TypeScript (source)	aws-cdk-lib » aws_docdb » DatabaseClusterAttributes

Properties that describe an existing cluster instance.

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';
import { aws_ec2 as ec2 } from 'aws-cdk-lib';

declare const securityGroup: ec2.SecurityGroup;
const databaseClusterAttributes: docdb.DatabaseClusterAttributes = {
  clusterIdentifier: 'clusterIdentifier',

  // the properties below are optional
  clusterEndpointAddress: 'clusterEndpointAddress',
  instanceEndpointAddresses: ['instanceEndpointAddresses'],
  instanceIdentifiers: ['instanceIdentifiers'],
  port: 123,
  readerEndpointAddress: 'readerEndpointAddress',
  securityGroup: securityGroup,
};

Properties

Name	Type	Description
clusterIdentifier	string	Identifier for the cluster.
clusterEndpointAddress?	string	Cluster endpoint address.
instanceEndpointAddresses?	string[]	Endpoint addresses of individual instances.
instanceIdentifiers?	string[]	Identifier for the instances.
port?	number	The database port.
readerEndpointAddress?	string	Reader endpoint address.
securityGroup?	ISecurityGroup	The security group of the database cluster.

---

clusterIdentifier

Type: string

Identifier for the cluster.

---

clusterEndpointAddress?

Type: string (optional, default: no cluster endpoint address)

Cluster endpoint address.

---

instanceEndpointAddresses?

Type: string[] (optional, default: no instance endpoint addresses)

Endpoint addresses of individual instances.

---

instanceIdentifiers?

Type: string[] (optional, default: no instance identifiers)

Identifier for the instances.

---

port?

Type: number (optional, default: none)

The database port.

---

readerEndpointAddress?

Type: string (optional, default: no reader endpoint address)

Reader endpoint address.

---

securityGroup?

Type: ISecurityGroup (optional, default: no security groups)

The security group of the database cluster.