Package 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:

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

Enclosing interface:

IDatabaseInstance

@Internal
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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ec2.IConnectable

IConnectable.Jsii$Default, IConnectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

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

IDatabaseInstance.Jsii$Default, IDatabaseInstance.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IDependable

software.constructs.IDependable.Jsii$Default, software.constructs.IDependable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

IEnvironmentAware.Jsii$Default, IEnvironmentAware.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default, IResource.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.secretsmanager.ISecretAttachmentTarget

ISecretAttachmentTarget.Jsii$Default, ISecretAttachmentTarget.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

Jsii$Proxy

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

Method Details

getNode

@Stability(Stable)
@NotNull
public final 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 IDatabaseInstance.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

getEnv

@Stability(Stable)
@NotNull
public final ResourceEnvironment getEnv()

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Specified by:

getEnv in interface IDatabaseInstance.Jsii$Default

Specified by:

getEnv in interface IEnvironmentAware

Specified by:

getEnv in interface IEnvironmentAware.Jsii$Default

Specified by:

getEnv in interface IResource.Jsii$Default

getStack

@Stability(Stable)
@NotNull
public final Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IDatabaseInstance.Jsii$Default

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

getConnections

@Stability(Stable)
@NotNull
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

@Stability(Stable)
@NotNull
public final String getDbInstanceEndpointAddress()

The instance endpoint address.

Specified by:

getDbInstanceEndpointAddress in interface IDatabaseInstance

Specified by:

getDbInstanceEndpointAddress in interface IDatabaseInstance.Jsii$Default

getDbInstanceEndpointPort

@Stability(Stable)
@NotNull
public final String getDbInstanceEndpointPort()

The instance endpoint port.

Specified by:

getDbInstanceEndpointPort in interface IDatabaseInstance

Specified by:

getDbInstanceEndpointPort in interface IDatabaseInstance.Jsii$Default

getInstanceArn

@Stability(Stable)
@NotNull
public final String getInstanceArn()

The instance arn.

Specified by:

getInstanceArn in interface IDatabaseInstance

Specified by:

getInstanceArn in interface IDatabaseInstance.Jsii$Default

getInstanceEndpoint

@Stability(Stable)
@NotNull
public final Endpoint getInstanceEndpoint()

The instance endpoint.

Specified by:

getInstanceEndpoint in interface IDatabaseInstance

Specified by:

getInstanceEndpoint in interface IDatabaseInstance.Jsii$Default

getInstanceIdentifier

@Stability(Stable)
@NotNull
public final String getInstanceIdentifier()

The instance identifier.

Specified by:

getInstanceIdentifier in interface IDatabaseInstance

Specified by:

getInstanceIdentifier in interface IDatabaseInstance.Jsii$Default

getEngine

@Stability(Stable)
@Nullable
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

getInstanceResourceId

@Stability(Stable)
@Nullable
public final String getInstanceResourceId()

The AWS Region-unique, immutable identifier for the DB instance.

This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed.

Specified by:

getInstanceResourceId in interface IDatabaseInstance

Specified by:

getInstanceResourceId in interface IDatabaseInstance.Jsii$Default

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#aws-resource-rds-dbinstance-return-values

applyRemovalPolicy

@Stability(Stable)
public final 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 IDatabaseInstance.Jsii$Default

Specified by:

applyRemovalPolicy in interface IResource

Specified by:

applyRemovalPolicy in interface IResource.Jsii$Default

Parameters:

policy - This parameter is required.

asSecretAttachmentTarget

@Stability(Stable)
@NotNull
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

@Stability(Stable)
@NotNull
public final DatabaseProxy addProxy(@NotNull
 String id,
 @NotNull
 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

@Stability(Stable)
@NotNull
public final Grant grantConnect(@NotNull
 IGrantable grantee,
 @Nullable
 String dbUser)

Grant the given identity connection access to the database.

Specified by:

grantConnect in interface IDatabaseInstance

Specified by:

grantConnect in interface IDatabaseInstance.Jsii$Default

Parameters:

grantee - the Principal to grant the permissions to. This parameter is required.

dbUser - the name of the database user to allow connecting as to the db instance.

grantConnect

@Stability(Stable)
@NotNull
public final Grant grantConnect(@NotNull
 IGrantable grantee)

Grant the given identity connection access to the database.

Specified by:

grantConnect in interface IDatabaseInstance

Parameters:

grantee - the Principal to grant the permissions to. This parameter is required.

metric

@Stability(Stable)
@NotNull
public final Metric metric(@NotNull
 String metricName,
 @Nullable
 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

@Stability(Stable)
@NotNull
public final Metric metric(@NotNull
 String metricName)

Return the given named metric for this DBInstance.

Specified by:

metric in interface IDatabaseInstance

Parameters:

metricName - This parameter is required.

metricCPUUtilization

@Stability(Stable)
@NotNull
public final Metric metricCPUUtilization(@Nullable
 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

@Stability(Stable)
@NotNull
public final Metric metricCPUUtilization()

The percentage of CPU utilization.

Average over 5 minutes

Specified by:

metricCPUUtilization in interface IDatabaseInstance

metricDatabaseConnections

@Stability(Stable)
@NotNull
public final Metric metricDatabaseConnections(@Nullable
 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

@Stability(Stable)
@NotNull
public final Metric metricDatabaseConnections()

The number of database connections in use.

Average over 5 minutes

Specified by:

metricDatabaseConnections in interface IDatabaseInstance

metricFreeableMemory

@Stability(Stable)
@NotNull
public final Metric metricFreeableMemory(@Nullable
 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

@Stability(Stable)
@NotNull
public final Metric metricFreeableMemory()

The amount of available random access memory.

Average over 5 minutes

Specified by:

metricFreeableMemory in interface IDatabaseInstance

metricFreeStorageSpace

@Stability(Stable)
@NotNull
public final Metric metricFreeStorageSpace(@Nullable
 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

@Stability(Stable)
@NotNull
public final Metric metricFreeStorageSpace()

The amount of available storage space.

Average over 5 minutes

Specified by:

metricFreeStorageSpace in interface IDatabaseInstance

metricReadIOPS

@Stability(Stable)
@NotNull
public final 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

Specified by:

metricReadIOPS in interface IDatabaseInstance.Jsii$Default

Parameters:

props -

metricReadIOPS

@Stability(Stable)
@NotNull
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

@Stability(Stable)
@NotNull
public final 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

Specified by:

metricWriteIOPS in interface IDatabaseInstance.Jsii$Default

Parameters:

props -

metricWriteIOPS

@Stability(Stable)
@NotNull
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

@Stability(Stable)
@NotNull
public final 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

Specified by:

onEvent in interface IDatabaseInstance.Jsii$Default

Parameters:

id - This parameter is required.

options -

onEvent

@Stability(Stable)
@NotNull
public final Rule onEvent(@NotNull
 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.