software.amazon.awscdk.services.docdb

Interface DatabaseClusterAttributes

All Known Implementing Classes:

DatabaseClusterAttributes.Jsii$Proxy

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-17T17:31:16.710Z")
public interface DatabaseClusterAttributes

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 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()
default java.lang.String	getClusterEndpointAddress() Cluster endpoint address.
java.lang.String	getClusterIdentifier() Identifier for the cluster.
default java.util.List<java.lang.String>	getInstanceEndpointAddresses() Endpoint addresses of individual instances.
default java.util.List<java.lang.String>	getInstanceIdentifiers() Identifier for the instances.
default java.lang.Number	getPort() The database port.
default java.lang.String	getReaderEndpointAddress() Reader endpoint address.
default ISecurityGroup	getSecurityGroup() The security group of the database cluster.

Method Detail

getClusterIdentifier

java.lang.String getClusterIdentifier()

Identifier for the cluster.

getClusterEndpointAddress

default java.lang.String getClusterEndpointAddress()

Cluster endpoint address.

Default: - no cluster endpoint address

getInstanceEndpointAddresses

default java.util.List<java.lang.String> getInstanceEndpointAddresses()

Endpoint addresses of individual instances.

Default: - no instance endpoint addresses

getInstanceIdentifiers

default java.util.List<java.lang.String> getInstanceIdentifiers()

Identifier for the instances.

Default: - no instance identifiers

getPort

default java.lang.Number getPort()

The database port.

Default: - none

getReaderEndpointAddress

default java.lang.String getReaderEndpointAddress()

Reader endpoint address.

Default: - no reader endpoint address

getSecurityGroup

default ISecurityGroup getSecurityGroup()

The security group of the database cluster.

Default: - no security groups

builder

static DatabaseClusterAttributes.Builder builder()

Returns:

a DatabaseClusterAttributes.Builder of DatabaseClusterAttributes