aws-cdk-lib.aws_rds.ServerlessClusterAttributes

interface ServerlessClusterAttributes

LanguageType name
.NETAmazon.CDK.AWS.RDS.ServerlessClusterAttributes
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsrds#ServerlessClusterAttributes
Javasoftware.amazon.awscdk.services.rds.ServerlessClusterAttributes
Pythonaws_cdk.aws_rds.ServerlessClusterAttributes
TypeScript (source)aws-cdk-lib » aws_rds » ServerlessClusterAttributes

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

declare const secret: secretsmanager.Secret;
declare const securityGroup: ec2.SecurityGroup;
const serverlessClusterAttributes: rds.ServerlessClusterAttributes = {
  clusterIdentifier: 'clusterIdentifier',

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

Properties

NameTypeDescription
clusterIdentifierstringIdentifier for the cluster.
clusterEndpointAddress?stringCluster endpoint address.
port?numberThe database port.
readerEndpointAddress?stringReader endpoint address.
secret?ISecretThe secret attached to the database cluster.
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.


port?

Type: number (optional, default: none)

The database port.


readerEndpointAddress?

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

Reader endpoint address.


secret?

Type: ISecret (optional, default: no secret)

The secret attached to the database cluster.


securityGroups?

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

The security groups of the database cluster.