Package software.amazon.awscdk.services.neptune.alpha

Interface DatabaseClusterAttributes

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

DatabaseClusterAttributes.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:11.770Z")
@Stability(Experimental)
public interface DatabaseClusterAttributes
extends software.amazon.jsii.JsiiSerializable

(experimental) 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.neptune.alpha.*;
 import software.amazon.awscdk.services.ec2.*;
 SecurityGroup securityGroup;
 DatabaseClusterAttributes databaseClusterAttributes = DatabaseClusterAttributes.builder()
         .clusterEndpointAddress("clusterEndpointAddress")
         .clusterIdentifier("clusterIdentifier")
         .clusterResourceIdentifier("clusterResourceIdentifier")
         .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()
String	getClusterEndpointAddress()	(experimental) Cluster endpoint address.
String	getClusterIdentifier()	(experimental) Identifier for the cluster.
String	getClusterResourceIdentifier()	(experimental) Resource Identifier for the cluster.
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 Details

getClusterEndpointAddress

@Stability(Experimental)
@NotNull
String getClusterEndpointAddress()

(experimental) Cluster endpoint address.

getClusterIdentifier

@Stability(Experimental)
@NotNull
String getClusterIdentifier()

(experimental) Identifier for the cluster.

getClusterResourceIdentifier

@Stability(Experimental)
@NotNull
String getClusterResourceIdentifier()

(experimental) Resource Identifier for the cluster.

getPort

@Stability(Experimental)
@NotNull
Number getPort()

(experimental) The database port.

getReaderEndpointAddress

@Stability(Experimental)
@NotNull
String getReaderEndpointAddress()

(experimental) Reader endpoint address.

getSecurityGroup

@Stability(Experimental)
@NotNull
ISecurityGroup getSecurityGroup()

(experimental) The security group of the database cluster.

builder

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

Returns:

a DatabaseClusterAttributes.Builder of DatabaseClusterAttributes