software.amazon.awscdk.services.rds

Interface IDatabaseInstance

All Superinterfaces:

IConnectable, software.constructs.IConstruct, software.constructs.IDependable, IResource, ISecretAttachmentTarget, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IDatabaseInstance.Jsii$Default

All Known Implementing Classes:

DatabaseInstance, DatabaseInstanceBase, DatabaseInstanceFromSnapshot, DatabaseInstanceReadReplica, IDatabaseInstance.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.488Z")
 @Stability(value=Stable)
public interface IDatabaseInstance
extends software.amazon.jsii.JsiiSerializable, IResource, IConnectable, ISecretAttachmentTarget

A database instance.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
DatabaseProxy	addProxy(String id, DatabaseProxyOptions options) Add a new db proxy to this instance.
String	getDbInstanceEndpointAddress() The instance endpoint address.
String	getDbInstanceEndpointPort() The instance endpoint port.
default IInstanceEngine	getEngine() The engine of this database Instance.
String	getInstanceArn() The instance arn.
Endpoint	getInstanceEndpoint() The instance endpoint.
String	getInstanceIdentifier() The instance identifier.
Grant	grantConnect(IGrantable grantee) Grant the given identity connection access to the database.
Metric	metric(String metricName) Return the given named metric for this DBInstance.
Metric	metric(String metricName, MetricOptions props) Return the given named metric for this DBInstance.
Metric	metricCPUUtilization() The percentage of CPU utilization.
Metric	metricCPUUtilization(MetricOptions props) The percentage of CPU utilization.
Metric	metricDatabaseConnections() The number of database connections in use.
Metric	metricDatabaseConnections(MetricOptions props) The number of database connections in use.
Metric	metricFreeableMemory() The amount of available random access memory.
Metric	metricFreeableMemory(MetricOptions props) The amount of available random access memory.
Metric	metricFreeStorageSpace() The amount of available storage space.
Metric	metricFreeStorageSpace(MetricOptions props) The amount of available storage space.
Metric	metricReadIOPS() The average number of disk write I/O operations per second.
Metric	metricReadIOPS(MetricOptions props) The average number of disk write I/O operations per second.
Metric	metricWriteIOPS() The average number of disk read I/O operations per second.
Metric	metricWriteIOPS(MetricOptions props) The average number of disk read I/O operations per second.
Rule	onEvent(String id) Defines a CloudWatch event rule which triggers for instance events.
Rule	onEvent(String id, OnEventOptions options) Defines a CloudWatch event rule which triggers for instance events.

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.services.ec2.IConnectable

getConnections

Methods inherited from interface software.amazon.awscdk.services.secretsmanager.ISecretAttachmentTarget

asSecretAttachmentTarget

Method Detail

getDbInstanceEndpointAddress

@Stability(value=Stable)
 @NotNull
String getDbInstanceEndpointAddress()

The instance endpoint address.

getDbInstanceEndpointPort

@Stability(value=Stable)
 @NotNull
String getDbInstanceEndpointPort()

The instance endpoint port.

getInstanceArn

@Stability(value=Stable)
 @NotNull
String getInstanceArn()

The instance arn.

getInstanceEndpoint

@Stability(value=Stable)
 @NotNull
Endpoint getInstanceEndpoint()

The instance endpoint.

getInstanceIdentifier

@Stability(value=Stable)
 @NotNull
String getInstanceIdentifier()

The instance identifier.

getEngine

@Stability(value=Stable)
 @Nullable
default IInstanceEngine getEngine()

The engine of this database Instance.

May be not known for imported Instances if it wasn't provided explicitly, or for read replicas.

addProxy

@Stability(value=Stable)
 @NotNull
DatabaseProxy addProxy(@NotNull
                                                          String id,
                                                          @NotNull
                                                          DatabaseProxyOptions options)

Add a new db proxy to this instance.

Parameters:

id - This parameter is required.

options - This parameter is required.

grantConnect

@Stability(value=Stable)
 @NotNull
Grant grantConnect(@NotNull
                                                      IGrantable grantee)

Grant the given identity connection access to the database.

Note: this method does not currently work, see https://github.com/aws/aws-cdk/issues/11851 for details.

Parameters:

grantee - This parameter is required.

See Also:

https://github.com/aws/aws-cdk/issues/11851

metric

@Stability(value=Stable)
 @NotNull
Metric metric(@NotNull
                                                 String metricName,
                                                 @Nullable
                                                 MetricOptions props)

Return the given named metric for this DBInstance.

Parameters:

metricName - This parameter is required.

props -

metric

@Stability(value=Stable)
 @NotNull
Metric metric(@NotNull
                                                 String metricName)

Return the given named metric for this DBInstance.

Parameters:

metricName - This parameter is required.

metricCPUUtilization

@Stability(value=Stable)
 @NotNull
Metric metricCPUUtilization(@Nullable
                                                               MetricOptions props)

The percentage of CPU utilization.

Average over 5 minutes

Parameters:

props -

metricCPUUtilization

@Stability(value=Stable)
 @NotNull
Metric metricCPUUtilization()

The percentage of CPU utilization.

Average over 5 minutes

metricDatabaseConnections

@Stability(value=Stable)
 @NotNull
Metric metricDatabaseConnections(@Nullable
                                                                    MetricOptions props)

The number of database connections in use.

Average over 5 minutes

Parameters:

props -

metricDatabaseConnections

@Stability(value=Stable)
 @NotNull
Metric metricDatabaseConnections()

The number of database connections in use.

Average over 5 minutes

metricFreeableMemory

@Stability(value=Stable)
 @NotNull
Metric metricFreeableMemory(@Nullable
                                                               MetricOptions props)

The amount of available random access memory.

Average over 5 minutes

Parameters:

props -

metricFreeableMemory

@Stability(value=Stable)
 @NotNull
Metric metricFreeableMemory()

The amount of available random access memory.

Average over 5 minutes

metricFreeStorageSpace

@Stability(value=Stable)
 @NotNull
Metric metricFreeStorageSpace(@Nullable
                                                                 MetricOptions props)

The amount of available storage space.

Average over 5 minutes

Parameters:

props -

metricFreeStorageSpace

@Stability(value=Stable)
 @NotNull
Metric metricFreeStorageSpace()

The amount of available storage space.

Average over 5 minutes

metricReadIOPS

@Stability(value=Stable)
 @NotNull
Metric metricReadIOPS(@Nullable
                                                         MetricOptions props)

The average number of disk write I/O operations per second.

Average over 5 minutes

Parameters:

props -

metricReadIOPS

@Stability(value=Stable)
 @NotNull
Metric metricReadIOPS()

The average number of disk write I/O operations per second.

Average over 5 minutes

metricWriteIOPS

@Stability(value=Stable)
 @NotNull
Metric metricWriteIOPS(@Nullable
                                                          MetricOptions props)

The average number of disk read I/O operations per second.

Average over 5 minutes

Parameters:

props -

metricWriteIOPS

@Stability(value=Stable)
 @NotNull
Metric metricWriteIOPS()

The average number of disk read I/O operations per second.

Average over 5 minutes

onEvent

@Stability(value=Stable)
 @NotNull
Rule onEvent(@NotNull
                                                String id,
                                                @Nullable
                                                OnEventOptions options)

Defines a CloudWatch event rule which triggers for instance events.

Use rule.addEventPattern(pattern) to specify a filter.

Parameters:

id - This parameter is required.

options -

onEvent

@Stability(value=Stable)
 @NotNull
Rule onEvent(@NotNull
                                                String id)

Defines a CloudWatch event rule which triggers for instance events.

Use rule.addEventPattern(pattern) to specify a filter.

Parameters:

id - This parameter is required.