aws-cdk-lib.aws_rds.DatabaseClusterAttributes

interface DatabaseClusterAttributes

LanguageType name
.NETAmazon.CDK.AWS.RDS.DatabaseClusterAttributes
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsrds#DatabaseClusterAttributes
Javasoftware.amazon.awscdk.services.rds.DatabaseClusterAttributes
Pythonaws_cdk.aws_rds.DatabaseClusterAttributes
TypeScript (source)aws-cdk-lib » aws_rds » 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_ec2 as ec2 } from 'aws-cdk-lib';
import { aws_rds as rds } from 'aws-cdk-lib';

declare const clusterEngine: rds.IClusterEngine;
declare const securityGroup: ec2.SecurityGroup;
const databaseClusterAttributes: rds.DatabaseClusterAttributes = {
  clusterIdentifier: 'clusterIdentifier',

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

Properties

NameTypeDescription
clusterIdentifierstringIdentifier for the cluster.
clusterEndpointAddress?stringCluster endpoint address.
clusterResourceIdentifier?stringThe immutable identifier for the cluster; for example: cluster-ABCD1234EFGH5678IJKL90MNOP.
engine?IClusterEngineThe engine of the existing Cluster.
instanceEndpointAddresses?string[]Endpoint addresses of individual instances.
instanceIdentifiers?string[]Identifier for the instances.
port?numberThe database port.
readerEndpointAddress?stringReader endpoint address.
securityGroups?ISecurityGroup[]The security groups of the database cluster.

clusterIdentifier

Type: string

Identifier for the cluster.


clusterEndpointAddress?

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

Cluster endpoint address.


clusterResourceIdentifier?

Type: string (optional, default: none)

The immutable identifier for the cluster; for example: cluster-ABCD1234EFGH5678IJKL90MNOP.

This AWS Region-unique identifier is used to grant access to the cluster.


engine?

Type: IClusterEngine (optional, default: the imported Cluster's engine is unknown)

The engine of the existing Cluster.


instanceEndpointAddresses?

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

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 address)

Reader endpoint address.


securityGroups?

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

The security groups of the database cluster.