Package software.amazon.awscdk.services.rds

Interface ServerlessClusterAttributes

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ServerlessClusterAttributes.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:49.261Z")
@Stability(Stable)
public interface ServerlessClusterAttributes
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.ec2.*;
 import software.amazon.awscdk.services.rds.*;
 import software.amazon.awscdk.services.secretsmanager.*;
 Secret secret;
 SecurityGroup securityGroup;
 ServerlessClusterAttributes serverlessClusterAttributes = ServerlessClusterAttributes.builder()
         .clusterIdentifier("clusterIdentifier")
         // the properties below are optional
         .clusterEndpointAddress("clusterEndpointAddress")
         .port(123)
         .readerEndpointAddress("readerEndpointAddress")
         .secret(secret)
         .securityGroups(List.of(securityGroup))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	ServerlessClusterAttributes.Builder	A builder for ServerlessClusterAttributes
static final class	ServerlessClusterAttributes.Jsii$Proxy	An implementation for ServerlessClusterAttributes

Method Summary

Modifier and Type	Method	Description
static ServerlessClusterAttributes.Builder	builder()
default String	getClusterEndpointAddress()	Cluster endpoint address.
String	getClusterIdentifier()	Identifier for the cluster.
default Number	getPort()	The database port.
default String	getReaderEndpointAddress()	Reader endpoint address.
default ISecret	getSecret()	The secret attached to the database cluster.
default List<ISecurityGroup>	getSecurityGroups()	The security groups of the database cluster.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getClusterIdentifier

@Stability(Stable)
@NotNull
String getClusterIdentifier()

Identifier for the cluster.

getClusterEndpointAddress

@Stability(Stable)
@Nullable
default String getClusterEndpointAddress()

Cluster endpoint address.

Default: - no endpoint address

getPort

@Stability(Stable)
@Nullable
default Number getPort()

The database port.

Default: - none

getReaderEndpointAddress

@Stability(Stable)
@Nullable
default String getReaderEndpointAddress()

Reader endpoint address.

Default: - no reader address

getSecret

@Stability(Stable)
@Nullable
default ISecret getSecret()

The secret attached to the database cluster.

Default: - no secret

getSecurityGroups

@Stability(Stable)
@Nullable
default List<ISecurityGroup> getSecurityGroups()

The security groups of the database cluster.

Default: - no security groups

builder

@Stability(Stable)
static ServerlessClusterAttributes.Builder builder()

Returns:

a ServerlessClusterAttributes.Builder of ServerlessClusterAttributes