Package 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.103.1 (build bef2dea)",
           date="2024-09-19T18:11:58.621Z")
@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.docdb.*;
 import software.amazon.awscdk.services.ec2.*;
 SecurityGroup securityGroup;
 DatabaseClusterAttributes databaseClusterAttributes = DatabaseClusterAttributes.builder()
         .clusterIdentifier("clusterIdentifier")
         // the properties below are optional
         .clusterEndpointAddress("clusterEndpointAddress")
         .instanceEndpointAddresses(List.of("instanceEndpointAddresses"))
         .instanceIdentifiers(List.of("instanceIdentifiers"))
         .port(123)
         .readerEndpointAddress("readerEndpointAddress")
         .securityGroup(securityGroup)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

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

getInstanceEndpointAddresses

@Stability(Stable)
@Nullable
default List<String> getInstanceEndpointAddresses()

Endpoint addresses of individual instances.

Default: - no instance endpoint addresses

getInstanceIdentifiers

@Stability(Stable)
@Nullable
default List<String> getInstanceIdentifiers()

Identifier for the instances.

Default: - no instance identifiers

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 endpoint address

getSecurityGroup

@Stability(Stable)
@Nullable
default ISecurityGroup getSecurityGroup()

The security group of the database cluster.

Default: - no security groups

builder

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

Returns:

a DatabaseClusterAttributes.Builder of DatabaseClusterAttributes