Package software.amazon.awscdk.services.rds

Interface DatabaseClusterAttributes

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
DatabaseClusterAttributes.Jsii$Proxy
@Generated(value="jsii-pacmak/1.93.0 (build 1706ca5)", date="2024-01-03T18:29:31.591Z") @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")
         .clusterResourceIdentifier("clusterResourceIdentifier")
         .engine(clusterEngine)
         .instanceEndpointAddresses(List.of("instanceEndpointAddresses"))
         .instanceIdentifiers(List.of("instanceIdentifiers"))
         .port(123)
         .readerEndpointAddress("readerEndpointAddress")
         .securityGroups(List.of(securityGroup))
         .build();

  • Method Details

    • getClusterIdentifier

      @Stability(Stable) @NotNull String getClusterIdentifier()
      Identifier for the cluster.

    • getClusterEndpointAddress

      @Stability(Stable) @Nullable default String getClusterEndpointAddress()
      Cluster endpoint address.

      Default: - no endpoint address

    • getClusterResourceIdentifier

      @Stability(Stable) @Nullable default String getClusterResourceIdentifier()
      The immutable identifier for the cluster; for example: cluster-ABCD1234EFGH5678IJKL90MNOP.

      This AWS Region-unique identifier is used to grant access to the cluster.

      Default: none

    • getEngine

      @Stability(Stable) @Nullable default IClusterEngine getEngine()
      The engine of the existing Cluster.

      Default: - the imported Cluster's engine is unknown

    • getInstanceEndpointAddresses

      @Stability(Stable) @Nullable default List<String> getInstanceEndpointAddresses()
      Endpoint addresses of individual instances.

      Default: - no instance endpoints

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

    • getSecurityGroups

      @Stability(Stable) @Nullable default List<ISecurityGroup> getSecurityGroups()
      The security groups of the database cluster.

      Default: - no security groups

    • builder

      @Stability(Stable) static DatabaseClusterAttributes.Builder builder()
      Returns:
      a DatabaseClusterAttributes.Builder of DatabaseClusterAttributes