interface ServerlessClusterAttributes
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.RDS.ServerlessClusterAttributes |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsrds#ServerlessClusterAttributes |
![]() | software.amazon.awscdk.services.rds.ServerlessClusterAttributes |
![]() | aws_cdk.aws_rds.ServerlessClusterAttributes |
![]() | 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
Name | Type | Description |
---|---|---|
cluster | string | Identifier for the cluster. |
cluster | string | Cluster endpoint address. |
port? | number | The database port. |
reader | string | Reader endpoint address. |
secret? | ISecret | The secret attached to the database cluster. |
security | ISecurity [] | 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:
ISecurity
[]
(optional, default: no security groups)
The security groups of the database cluster.