Interface DatabaseClusterAttributes
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
DatabaseClusterAttributes.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
date="2023-06-19T16:30:49.105Z")
@Stability(Stable)
public interface DatabaseClusterAttributes
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.*; IClusterEngine clusterEngine; SecurityGroup securityGroup; DatabaseClusterAttributes databaseClusterAttributes = DatabaseClusterAttributes.builder() .clusterIdentifier("clusterIdentifier") // the properties below are optional .clusterEndpointAddress("clusterEndpointAddress") .engine(clusterEngine) .instanceEndpointAddresses(List.of("instanceEndpointAddresses")) .instanceIdentifiers(List.of("instanceIdentifiers")) .port(123) .readerEndpointAddress("readerEndpointAddress") .securityGroups(List.of(securityGroup)) .build();
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forDatabaseClusterAttributes
static final class
An implementation forDatabaseClusterAttributes
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default String
Cluster endpoint address.Identifier for the cluster.default IClusterEngine
The engine of the existing Cluster.Endpoint addresses of individual instances.Identifier for the instances.default Number
getPort()
The database port.default String
Reader endpoint address.default List<ISecurityGroup>
The security groups of the database cluster.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getClusterIdentifier
Identifier for the cluster. -
getClusterEndpointAddress
Cluster endpoint address.Default: - no endpoint address
-
getEngine
The engine of the existing Cluster.Default: - the imported Cluster's engine is unknown
-
getInstanceEndpointAddresses
Endpoint addresses of individual instances.Default: - no instance endpoints
-
getInstanceIdentifiers
Identifier for the instances.Default: - no instance identifiers
-
getPort
The database port.Default: - none
-
getReaderEndpointAddress
Reader endpoint address.Default: - no reader address
-
getSecurityGroups
The security groups of the database cluster.Default: - no security groups
-
builder
- Returns:
- a
DatabaseClusterAttributes.Builder
ofDatabaseClusterAttributes
-