# DatabaseClusterAttributes

Properties that describe an existing cluster instance.

- Source: [`aws-docdb/lib/cluster-ref.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0/packages/aws-cdk-lib/aws-docdb/lib/cluster-ref.ts#L47)
- Type last changed: v2.21.0 · 22 Apr 2022

## 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';
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

- `clusterEndpointAddress`: string — Cluster endpoint address.

  **Default:** no cluster endpoint address

- `clusterIdentifier`: string (required) — Identifier for the cluster.

- `instanceEndpointAddresses`: string[] — Endpoint addresses of individual instances.

  **Default:** no instance endpoint addresses

- `instanceIdentifiers`: string[] — Identifier for the instances.

  **Default:** no instance identifiers

- `port`: number = none — The database port.

- `readerEndpointAddress`: string — Reader endpoint address.

  **Default:** no reader endpoint address

- `securityGroup`: [ISecurityGroup](/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.ISecurityGroup.html) — The security group of the database cluster.

  **Default:** no security groups