ServerlessClusterAttributes Struct
Properties that describe an existing cluster instance.
Example
ts
// 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
clusterEndpointAddressoptionalstringcluster_endpoint_addressoptionalstrclusterEndpointAddressoptionalStringClusterEndpointAddressoptionalstringClusterEndpointAddressoptional*string#Cluster endpoint address.
Default: no endpoint address
clusterIdentifierstringcluster_identifierstrclusterIdentifierStringClusterIdentifierstringClusterIdentifier*stringrequired#Identifier for the cluster.
portoptionalnumberportoptionalint | floatportoptionalNumberPortoptionaldoublePortoptional*float64= none#The database port.
readerEndpointAddressoptionalstringreader_endpoint_addressoptionalstrreaderEndpointAddressoptionalStringReaderEndpointAddressoptionalstringReaderEndpointAddressoptional*string#Reader endpoint address.
Default: no reader address
secretoptionalISecretsecretoptionalISecretsecretoptionalISecretSecretoptionalISecretSecretoptionalISecret#The secret attached to the database cluster.
Default: no secret
securityGroupsoptionalISecurityGroup[]security_groupsoptionaltyping.List[ISecurityGroup]securityGroupsoptionalList<ISecurityGroup>SecurityGroupsoptionalISecurityGroup[]SecurityGroupsoptional*[]ISecurityGroup#The security groups of the database cluster.
Default: no security groups