software.amazon.awscdk.services.rds

Interface IDatabaseInstance.Jsii$Default

All Superinterfaces:

IConnectable, IConnectable.Jsii$Default, software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, IDatabaseInstance, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IResource, IResource.Jsii$Default, ISecretAttachmentTarget, ISecretAttachmentTarget.Jsii$Default, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IDatabaseInstance.Jsii$Proxy

Enclosing interface:

IDatabaseInstance

@Internal
public static interface IDatabaseInstance.Jsii$Default
extends IDatabaseInstance, IResource.Jsii$Default, IConnectable.Jsii$Default, ISecretAttachmentTarget.Jsii$Default

Internal default implementation for IDatabaseInstance.

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.rds.IDatabaseInstance

IDatabaseInstance.Jsii$Default, IDatabaseInstance.Jsii$Proxy

Method Summary

Modifier and Type	Method and Description
default DatabaseProxy	addProxy(String id, DatabaseProxyOptions options) Add a new db proxy to this instance.
default void	applyRemovalPolicy(RemovalPolicy policy) Apply the given removal policy to this resource.
default SecretAttachmentTargetProps	asSecretAttachmentTarget() Renders the target specifications.
default Connections	getConnections() The network connections associated with this resource.
default String	getDbInstanceEndpointAddress() The instance endpoint address.
default String	getDbInstanceEndpointPort() The instance endpoint port.
default IInstanceEngine	getEngine() The engine of this database Instance.
default ResourceEnvironment	getEnv() The environment this resource belongs to.
default String	getInstanceArn() The instance arn.
default Endpoint	getInstanceEndpoint() The instance endpoint.
default String	getInstanceIdentifier() The instance identifier.
default software.constructs.Node	getNode() The tree node.
default Stack	getStack() The stack in which this resource is defined.
default Grant	grantConnect(IGrantable grantee) Grant the given identity connection access to the database.
default Metric	metric(String metricName, MetricOptions props) Return the given named metric for this DBInstance.
default Metric	metricCPUUtilization(MetricOptions props) The percentage of CPU utilization.
default Metric	metricDatabaseConnections(MetricOptions props) The number of database connections in use.
default Metric	metricFreeableMemory(MetricOptions props) The amount of available random access memory.
default Metric	metricFreeStorageSpace(MetricOptions props) The amount of available storage space.
default Metric	metricReadIOPS(MetricOptions props) The average number of disk write I/O operations per second.
default Metric	metricWriteIOPS(MetricOptions props) The average number of disk read I/O operations per second.
default Rule	onEvent(String id, OnEventOptions options) Defines a CloudWatch event rule which triggers for instance events.

Methods inherited from interface software.amazon.awscdk.services.rds.IDatabaseInstance

metric, metricCPUUtilization, metricDatabaseConnections, metricFreeableMemory, metricFreeStorageSpace, metricReadIOPS, metricWriteIOPS, onEvent

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getNode

@Stability(value=Stable)
 @NotNull
default software.constructs.Node getNode()

The tree node.

Specified by:

getNode in interface software.constructs.IConstruct

Specified by:

getNode in interface software.constructs.IConstruct.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

getEnv

@Stability(value=Stable)
 @NotNull
default ResourceEnvironment getEnv()

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

Specified by:

getEnv in interface IResource

Specified by:

getEnv in interface IResource.Jsii$Default

getStack

@Stability(value=Stable)
 @NotNull
default Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

getConnections

@Stability(value=Stable)
 @NotNull
default Connections getConnections()

The network connections associated with this resource.

Specified by:

getConnections in interface IConnectable

Specified by:

getConnections in interface IConnectable.Jsii$Default

getDbInstanceEndpointAddress

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

The instance endpoint address.

Specified by:

getDbInstanceEndpointAddress in interface IDatabaseInstance

getDbInstanceEndpointPort

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

The instance endpoint port.

Specified by:

getDbInstanceEndpointPort in interface IDatabaseInstance

getInstanceArn

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

The instance arn.

Specified by:

getInstanceArn in interface IDatabaseInstance

getInstanceEndpoint

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

The instance endpoint.

Specified by:

getInstanceEndpoint in interface IDatabaseInstance

getInstanceIdentifier

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

The instance identifier.

Specified by:

getInstanceIdentifier in interface IDatabaseInstance

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.

Specified by:

getEngine in interface IDatabaseInstance

applyRemovalPolicy

@Stability(value=Stable)
default void applyRemovalPolicy(@NotNull
                                                         RemovalPolicy policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Specified by:

applyRemovalPolicy in interface IResource

Specified by:

applyRemovalPolicy in interface IResource.Jsii$Default

Parameters:

policy - This parameter is required.

asSecretAttachmentTarget

@Stability(value=Stable)
 @NotNull
default SecretAttachmentTargetProps asSecretAttachmentTarget()

Renders the target specifications.

Specified by:

asSecretAttachmentTarget in interface ISecretAttachmentTarget

Specified by:

asSecretAttachmentTarget in interface ISecretAttachmentTarget.Jsii$Default

addProxy

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

Add a new db proxy to this instance.

Specified by:

addProxy in interface IDatabaseInstance

Parameters:

id - This parameter is required.

options - This parameter is required.

grantConnect

@Stability(value=Stable)
 @NotNull
default 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.

Specified by:

grantConnect in interface IDatabaseInstance

Parameters:

grantee - This parameter is required.

See Also:

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

metric

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

Return the given named metric for this DBInstance.

Specified by:

metric in interface IDatabaseInstance

Parameters:

metricName - This parameter is required.

props -

metricCPUUtilization

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

The percentage of CPU utilization.

Average over 5 minutes

Specified by:

metricCPUUtilization in interface IDatabaseInstance

Parameters:

props -

metricDatabaseConnections

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

The number of database connections in use.

Average over 5 minutes

Specified by:

metricDatabaseConnections in interface IDatabaseInstance

Parameters:

props -

metricFreeableMemory

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

The amount of available random access memory.

Average over 5 minutes

Specified by:

metricFreeableMemory in interface IDatabaseInstance

Parameters:

props -

metricFreeStorageSpace

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

The amount of available storage space.

Average over 5 minutes

Specified by:

metricFreeStorageSpace in interface IDatabaseInstance

Parameters:

props -

metricReadIOPS

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

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

Average over 5 minutes

Specified by:

metricReadIOPS in interface IDatabaseInstance

Parameters:

props -

metricWriteIOPS

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

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

Average over 5 minutes

Specified by:

metricWriteIOPS in interface IDatabaseInstance

Parameters:

props -

onEvent

@Stability(value=Stable)
 @NotNull
default 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.

Specified by:

onEvent in interface IDatabaseInstance

Parameters:

id - This parameter is required.

options -