Package software.amazon.awscdk.services.rds

Interface DatabaseClusterLookupOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

DatabaseClusterLookupOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.112.0 (build de1bc80)",
           date="2025-07-16T11:43:21.513Z")
@Stability(Stable)
public interface DatabaseClusterLookupOptions
extends software.amazon.jsii.JsiiSerializable

Properties for looking up an existing DatabaseCluster.

Example:

 Role myUserRole;
 IDatabaseCluster clusterFromLookup = DatabaseCluster.fromLookup(this, "ClusterFromLookup", DatabaseClusterLookupOptions.builder()
         .clusterIdentifier("my-cluster-id")
         .build());
 // Grant a connection
 clusterFromLookup.grantConnect(myUserRole, "my-user-id");
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static DatabaseClusterLookupOptions.Builder	builder()
String	getClusterIdentifier()	The cluster identifier of the DatabaseCluster.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getClusterIdentifier

@Stability(Stable)
@NotNull
String getClusterIdentifier()

The cluster identifier of the DatabaseCluster.

builder

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

Returns:

a DatabaseClusterLookupOptions.Builder of DatabaseClusterLookupOptions