software.amazon.awscdk.services.rds

Interface IDatabaseInstance.Jsii$Default

All Superinterfaces:

IConnectable, IConnectable.Jsii$Default, IConstruct, IConstruct.Jsii$Default, IDatabaseInstance, IDependable, IDependable.Jsii$Default, IResource, IResource.Jsii$Default, ISecretAttachmentTarget, ISecretAttachmentTarget.Jsii$Default

All Known Implementing Classes:

IDatabaseInstance.Jsii$Proxy

Enclosing interface:

IDatabaseInstance

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(java.lang.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 java.lang.String	getDbInstanceEndpointAddress() The instance endpoint address.
default java.lang.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 java.lang.String	getInstanceArn() The instance arn.
default Endpoint	getInstanceEndpoint() The instance endpoint.
default java.lang.String	getInstanceIdentifier() The instance identifier.
default ConstructNode	getNode() The construct tree node for this construct.
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(java.lang.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(java.lang.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

Method Detail

getNode

default ConstructNode getNode()

The construct tree node for this construct.

Specified by:

getNode in interface IConstruct

Specified by:

getNode in interface IConstruct.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

getEnv

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

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

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

default java.lang.String getDbInstanceEndpointAddress()

The instance endpoint address.

Specified by:

getDbInstanceEndpointAddress in interface IDatabaseInstance

getDbInstanceEndpointPort

default java.lang.String getDbInstanceEndpointPort()

The instance endpoint port.

Specified by:

getDbInstanceEndpointPort in interface IDatabaseInstance

getInstanceArn

default java.lang.String getInstanceArn()

The instance arn.

Specified by:

getInstanceArn in interface IDatabaseInstance

getInstanceEndpoint

default Endpoint getInstanceEndpoint()

The instance endpoint.

Specified by:

getInstanceEndpoint in interface IDatabaseInstance

getInstanceIdentifier

default java.lang.String getInstanceIdentifier()

The instance identifier.

Specified by:

getInstanceIdentifier in interface IDatabaseInstance

getEngine

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

default void applyRemovalPolicy(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

default SecretAttachmentTargetProps asSecretAttachmentTarget()

Renders the target specifications.

Specified by:

asSecretAttachmentTarget in interface ISecretAttachmentTarget

Specified by:

asSecretAttachmentTarget in interface ISecretAttachmentTarget.Jsii$Default

addProxy

default DatabaseProxy addProxy(java.lang.String id,
                               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

default Grant grantConnect(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

default Metric metric(java.lang.String metricName,
                      MetricOptions props)

Return the given named metric for this DBInstance.

Specified by:

metric in interface IDatabaseInstance

Parameters:

metricName - This parameter is required.

props -

metricCPUUtilization

default Metric metricCPUUtilization(MetricOptions props)

The percentage of CPU utilization.

Average over 5 minutes

Specified by:

metricCPUUtilization in interface IDatabaseInstance

Parameters:

props -

metricDatabaseConnections

default Metric metricDatabaseConnections(MetricOptions props)

The number of database connections in use.

Average over 5 minutes

Specified by:

metricDatabaseConnections in interface IDatabaseInstance

Parameters:

props -

metricFreeableMemory

default Metric metricFreeableMemory(MetricOptions props)

The amount of available random access memory.

Average over 5 minutes

Specified by:

metricFreeableMemory in interface IDatabaseInstance

Parameters:

props -

metricFreeStorageSpace

default Metric metricFreeStorageSpace(MetricOptions props)

The amount of available storage space.

Average over 5 minutes

Specified by:

metricFreeStorageSpace in interface IDatabaseInstance

Parameters:

props -

metricReadIOPS

default Metric metricReadIOPS(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

default Metric metricWriteIOPS(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

default Rule onEvent(java.lang.String id,
                     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 -