software.amazon.awscdk.services.docdb

Interface DatabaseClusterAttributes

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

DatabaseClusterAttributes.Jsii$Proxy

@Generated(value="jsii-pacmak/1.29.0 (build 41df200)",
           date="2021-06-02T09:55:16.886Z")
 @Stability(value=Experimental)
public interface DatabaseClusterAttributes
extends software.amazon.jsii.JsiiSerializable

(experimental) Properties that describe an existing cluster instance.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static DatabaseClusterAttributes.Builder	builder()
String	getClusterEndpointAddress() (experimental) Cluster endpoint address.
String	getClusterIdentifier() (experimental) Identifier for the cluster.
List<String>	getInstanceEndpointAddresses() (experimental) Endpoint addresses of individual instances.
List<String>	getInstanceIdentifiers() (experimental) Identifier for the instances.
Number	getPort() (experimental) The database port.
String	getReaderEndpointAddress() (experimental) Reader endpoint address.
ISecurityGroup	getSecurityGroup() (experimental) The security group of the database cluster.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getClusterEndpointAddress

@Stability(value=Experimental)
 @NotNull
String getClusterEndpointAddress()

(experimental) Cluster endpoint address.

getClusterIdentifier

@Stability(value=Experimental)
 @NotNull
String getClusterIdentifier()

(experimental) Identifier for the cluster.

getInstanceEndpointAddresses

@Stability(value=Experimental)
 @NotNull
List<String> getInstanceEndpointAddresses()

(experimental) Endpoint addresses of individual instances.

getInstanceIdentifiers

@Stability(value=Experimental)
 @NotNull
List<String> getInstanceIdentifiers()

(experimental) Identifier for the instances.

getPort

@Stability(value=Experimental)
 @NotNull
Number getPort()

(experimental) The database port.

getReaderEndpointAddress

@Stability(value=Experimental)
 @NotNull
String getReaderEndpointAddress()

(experimental) Reader endpoint address.

getSecurityGroup

@Stability(value=Experimental)
 @NotNull
ISecurityGroup getSecurityGroup()

(experimental) The security group of the database cluster.

builder

@Stability(value=Experimental)
static DatabaseClusterAttributes.Builder builder()

Returns:

a DatabaseClusterAttributes.Builder of DatabaseClusterAttributes