software.amazon.awscdk.services.rds

Class IDatabaseInstance.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.rds.IDatabaseInstance.Jsii$Proxy

All Implemented Interfaces:

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

Enclosing interface:

IDatabaseInstance

public static final class IDatabaseInstance.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements IDatabaseInstance.Jsii$Default

A proxy class which represents a concrete javascript instance of this type.

Nested Class Summary

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

IDatabaseInstance.Jsii$Default, IDatabaseInstance.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
DatabaseProxy	addProxy(java.lang.String id, DatabaseProxyOptions options) Add a new db proxy to this instance.
void	applyRemovalPolicy(RemovalPolicy policy) Apply the given removal policy to this resource.
SecretAttachmentTargetProps	asSecretAttachmentTarget() Renders the target specifications.
Connections	getConnections() The network connections associated with this resource.
java.lang.String	getDbInstanceEndpointAddress() The instance endpoint address.
java.lang.String	getDbInstanceEndpointPort() The instance endpoint port.
IInstanceEngine	getEngine() The engine of this database Instance.
ResourceEnvironment	getEnv() The environment this resource belongs to.
java.lang.String	getInstanceArn() The instance arn.
Endpoint	getInstanceEndpoint() The instance endpoint.
java.lang.String	getInstanceIdentifier() The instance identifier.
ConstructNode	getNode() The construct tree node for this construct.
Stack	getStack() The stack in which this resource is defined.
Grant	grantConnect(IGrantable grantee) Grant the given identity connection access to the database.
Metric	metric(java.lang.String metricName) Return the given named metric for this DBInstance.
Metric	metric(java.lang.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(java.lang.String id) Defines a CloudWatch event rule which triggers for instance events.
Rule	onEvent(java.lang.String id, OnEventOptions options) Defines a CloudWatch event rule which triggers for instance events.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Method Detail

getNode

public final 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

Specified by:

getNode in interface IDatabaseInstance.Jsii$Default

getEnv

public final 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

Specified by:

getEnv in interface IDatabaseInstance.Jsii$Default

getStack

public final Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

Specified by:

getStack in interface IDatabaseInstance.Jsii$Default

getConnections

public final Connections getConnections()

The network connections associated with this resource.

Specified by:

getConnections in interface IConnectable

Specified by:

getConnections in interface IConnectable.Jsii$Default

Specified by:

getConnections in interface IDatabaseInstance.Jsii$Default

getDbInstanceEndpointAddress

public final java.lang.String getDbInstanceEndpointAddress()

The instance endpoint address.

Specified by:

getDbInstanceEndpointAddress in interface IDatabaseInstance

Specified by:

getDbInstanceEndpointAddress in interface IDatabaseInstance.Jsii$Default

getDbInstanceEndpointPort

public final java.lang.String getDbInstanceEndpointPort()

The instance endpoint port.

Specified by:

getDbInstanceEndpointPort in interface IDatabaseInstance

Specified by:

getDbInstanceEndpointPort in interface IDatabaseInstance.Jsii$Default

getInstanceArn

public final java.lang.String getInstanceArn()

The instance arn.

Specified by:

getInstanceArn in interface IDatabaseInstance

Specified by:

getInstanceArn in interface IDatabaseInstance.Jsii$Default

getInstanceEndpoint

public final Endpoint getInstanceEndpoint()

The instance endpoint.

Specified by:

getInstanceEndpoint in interface IDatabaseInstance

Specified by:

getInstanceEndpoint in interface IDatabaseInstance.Jsii$Default

getInstanceIdentifier

public final java.lang.String getInstanceIdentifier()

The instance identifier.

Specified by:

getInstanceIdentifier in interface IDatabaseInstance

Specified by:

getInstanceIdentifier in interface IDatabaseInstance.Jsii$Default

getEngine

public final 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

Specified by:

getEngine in interface IDatabaseInstance.Jsii$Default

applyRemovalPolicy

public final 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

Specified by:

applyRemovalPolicy in interface IDatabaseInstance.Jsii$Default

Parameters:

policy - This parameter is required.

asSecretAttachmentTarget

public final SecretAttachmentTargetProps asSecretAttachmentTarget()

Renders the target specifications.

Specified by:

asSecretAttachmentTarget in interface IDatabaseInstance.Jsii$Default

Specified by:

asSecretAttachmentTarget in interface ISecretAttachmentTarget

Specified by:

asSecretAttachmentTarget in interface ISecretAttachmentTarget.Jsii$Default

addProxy

public final DatabaseProxy addProxy(java.lang.String id,
                                    DatabaseProxyOptions options)

Add a new db proxy to this instance.

Specified by:

addProxy in interface IDatabaseInstance

Specified by:

addProxy in interface IDatabaseInstance.Jsii$Default

Parameters:

id - This parameter is required.

options - This parameter is required.

grantConnect

public final 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

Specified by:

grantConnect in interface IDatabaseInstance.Jsii$Default

Parameters:

grantee - This parameter is required.

See Also:

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

metric

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

Return the given named metric for this DBInstance.

Specified by:

metric in interface IDatabaseInstance

Specified by:

metric in interface IDatabaseInstance.Jsii$Default

Parameters:

metricName - This parameter is required.

props -

metric

public final Metric metric(java.lang.String metricName)

Return the given named metric for this DBInstance.

Specified by:

metric in interface IDatabaseInstance

Parameters:

metricName - This parameter is required.

metricCPUUtilization

public final Metric metricCPUUtilization(MetricOptions props)

The percentage of CPU utilization.

Average over 5 minutes

Specified by:

metricCPUUtilization in interface IDatabaseInstance

Specified by:

metricCPUUtilization in interface IDatabaseInstance.Jsii$Default

Parameters:

props -

metricCPUUtilization

public final Metric metricCPUUtilization()

The percentage of CPU utilization.

Average over 5 minutes

Specified by:

metricCPUUtilization in interface IDatabaseInstance

metricDatabaseConnections

public final Metric metricDatabaseConnections(MetricOptions props)

The number of database connections in use.

Average over 5 minutes

Specified by:

metricDatabaseConnections in interface IDatabaseInstance

Specified by:

metricDatabaseConnections in interface IDatabaseInstance.Jsii$Default

Parameters:

props -

metricDatabaseConnections

public final Metric metricDatabaseConnections()

The number of database connections in use.

Average over 5 minutes

Specified by:

metricDatabaseConnections in interface IDatabaseInstance

metricFreeableMemory

public final Metric metricFreeableMemory(MetricOptions props)

The amount of available random access memory.

Average over 5 minutes

Specified by:

metricFreeableMemory in interface IDatabaseInstance

Specified by:

metricFreeableMemory in interface IDatabaseInstance.Jsii$Default

Parameters:

props -

metricFreeableMemory

public final Metric metricFreeableMemory()

The amount of available random access memory.

Average over 5 minutes

Specified by:

metricFreeableMemory in interface IDatabaseInstance

metricFreeStorageSpace

public final Metric metricFreeStorageSpace(MetricOptions props)

The amount of available storage space.

Average over 5 minutes

Specified by:

metricFreeStorageSpace in interface IDatabaseInstance

Specified by:

metricFreeStorageSpace in interface IDatabaseInstance.Jsii$Default

Parameters:

props -

metricFreeStorageSpace

public final Metric metricFreeStorageSpace()

The amount of available storage space.

Average over 5 minutes

Specified by:

metricFreeStorageSpace in interface IDatabaseInstance

metricReadIOPS

public final 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

Specified by:

metricReadIOPS in interface IDatabaseInstance.Jsii$Default

Parameters:

props -

metricReadIOPS

public final Metric metricReadIOPS()

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

Average over 5 minutes

Specified by:

metricReadIOPS in interface IDatabaseInstance

metricWriteIOPS

public final 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

Specified by:

metricWriteIOPS in interface IDatabaseInstance.Jsii$Default

Parameters:

props -

metricWriteIOPS

public final Metric metricWriteIOPS()

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

Average over 5 minutes

Specified by:

metricWriteIOPS in interface IDatabaseInstance

onEvent

public final 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

Specified by:

onEvent in interface IDatabaseInstance.Jsii$Default

Parameters:

id - This parameter is required.

options -

onEvent

public final Rule onEvent(java.lang.String id)

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.