Package software.amazon.awscdk.services.rds

Interface IAuroraClusterInstance

All Superinterfaces:

software.constructs.IConstruct, software.constructs.IDependable, IEnvironmentAware, IResource, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IAuroraClusterInstance.Jsii$Default

All Known Implementing Classes:

IAuroraClusterInstance.Jsii$Proxy

@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
           date="2025-12-05T22:26:43.877Z")
@Stability(Stable)
public interface IAuroraClusterInstance
extends software.amazon.jsii.JsiiSerializable, IResource

An Aurora Cluster Instance.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IAuroraClusterInstance.Jsii$Default	Internal default implementation for IAuroraClusterInstance.
static final class	IAuroraClusterInstance.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method	Description
String	getDbInstanceArn()	The instance ARN.
String	getDbInstanceEndpointAddress()	The instance endpoint address.
String	getDbiResourceId()	The instance resource ID.
String	getInstanceIdentifier()	The instance identifier.
default String	getInstanceSize()	The instance size if the instance is a provisioned type.
default IKey	getPerformanceInsightEncryptionKey()	The AWS KMS key for encryption of Performance Insights data.
default PerformanceInsightRetention	getPerformanceInsightRetention()	The amount of time, in days, to retain Performance Insights data.
default Boolean	getPerformanceInsightsEnabled()	Whether Performance Insights is enabled.
Number	getTier()	The promotion tier the instance was created in.
InstanceType	getType()	The instance type (provisioned vs serverless v2).

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDbInstanceArn

@Stability(Stable)
@NotNull
String getDbInstanceArn()

The instance ARN.

getDbInstanceEndpointAddress

@Stability(Stable)
@NotNull
String getDbInstanceEndpointAddress()

The instance endpoint address.

getDbiResourceId

@Stability(Stable)
@NotNull
String getDbiResourceId()

The instance resource ID.

getInstanceIdentifier

@Stability(Stable)
@NotNull
String getInstanceIdentifier()

The instance identifier.

getTier

@Stability(Stable)
@NotNull
Number getTier()

The promotion tier the instance was created in.

getType

@Stability(Stable)
@NotNull
InstanceType getType()

The instance type (provisioned vs serverless v2).

getInstanceSize

@Stability(Stable)
@Nullable
default String getInstanceSize()

The instance size if the instance is a provisioned type.

getPerformanceInsightEncryptionKey

@Stability(Stable)
@Nullable
default IKey getPerformanceInsightEncryptionKey()

The AWS KMS key for encryption of Performance Insights data.

getPerformanceInsightRetention

@Stability(Stable)
@Nullable
default PerformanceInsightRetention getPerformanceInsightRetention()

The amount of time, in days, to retain Performance Insights data.

getPerformanceInsightsEnabled

@Stability(Stable)
@Nullable
default Boolean getPerformanceInsightsEnabled()

Whether Performance Insights is enabled.