software.amazon.awscdk.services.rds

Class DatabaseInstanceBase

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.rds.DatabaseInstanceBase

All Implemented Interfaces:

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

Direct Known Subclasses:

DatabaseInstance, DatabaseInstanceFromSnapshot, DatabaseInstanceReadReplica

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.454Z")
 @Stability(value=Stable)
public abstract class DatabaseInstanceBase
extends Resource
implements IDatabaseInstance

A new or imported database instance.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ec2.*;
 import software.amazon.awscdk.services.rds.*;
 IInstanceEngine instanceEngine;
 SecurityGroup securityGroup;
 IDatabaseInstance databaseInstanceBase = DatabaseInstanceBase.fromDatabaseInstanceAttributes(this, "MyDatabaseInstanceBase", DatabaseInstanceAttributes.builder()
         .instanceEndpointAddress("instanceEndpointAddress")
         .instanceIdentifier("instanceIdentifier")
         .port(123)
         .securityGroups(List.of(securityGroup))
         // the properties below are optional
         .engine(instanceEngine)
         .build());
 

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.rds.IDatabaseInstance

IDatabaseInstance.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DatabaseInstanceBase(software.constructs.Construct scope, String id)
protected	DatabaseInstanceBase(software.constructs.Construct scope, String id, ResourceProps props)
protected	DatabaseInstanceBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	DatabaseInstanceBase(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
DatabaseProxy	addProxy(String id, DatabaseProxyOptions options) Add a new db proxy to this instance.
SecretAttachmentTargetProps	asSecretAttachmentTarget() Renders the secret attachment target specifications.
static IDatabaseInstance	fromDatabaseInstanceAttributes(software.constructs.Construct scope, String id, DatabaseInstanceAttributes attrs) Import an existing database instance.
abstract Connections	getConnections() Access to network connections.
abstract String	getDbInstanceEndpointAddress() The instance endpoint address.
abstract String	getDbInstanceEndpointPort() The instance endpoint port.
protected abstract Boolean	getEnableIamAuthentication()
abstract IInstanceEngine	getEngine() The engine of this database Instance.
String	getInstanceArn() The instance arn.
abstract Endpoint	getInstanceEndpoint() The instance endpoint.
abstract 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.
protected abstract void	setEnableIamAuthentication(Boolean value)

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

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, wait, wait, wait

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

Constructor Detail

DatabaseInstanceBase

protected DatabaseInstanceBase(software.amazon.jsii.JsiiObjectRef objRef)

DatabaseInstanceBase

protected DatabaseInstanceBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

DatabaseInstanceBase

@Stability(value=Stable)
protected DatabaseInstanceBase(@NotNull
                                                        software.constructs.Construct scope,
                                                        @NotNull
                                                        String id,
                                                        @Nullable
                                                        ResourceProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

DatabaseInstanceBase

@Stability(value=Stable)
protected DatabaseInstanceBase(@NotNull
                                                        software.constructs.Construct scope,
                                                        @NotNull
                                                        String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

fromDatabaseInstanceAttributes

@Stability(value=Stable)
 @NotNull
public static IDatabaseInstance fromDatabaseInstanceAttributes(@NotNull
                                                                                                  software.constructs.Construct scope,
                                                                                                  @NotNull
                                                                                                  String id,
                                                                                                  @NotNull
                                                                                                  DatabaseInstanceAttributes attrs)

Import an existing database instance.

Parameters:

scope - This parameter is required.

id - This parameter is required.

attrs - This parameter is required.

addProxy

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

asSecretAttachmentTarget

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

Renders the secret attachment target specifications.

Specified by:

asSecretAttachmentTarget in interface ISecretAttachmentTarget

grantConnect

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

metric

@Stability(value=Stable)
 @NotNull
public 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(value=Stable)
 @NotNull
public Metric metricCPUUtilization(@Nullable
                                                                      MetricOptions props)

The percentage of CPU utilization.

Average over 5 minutes

Specified by:

metricCPUUtilization in interface IDatabaseInstance

Parameters:

props -

metricCPUUtilization

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

The percentage of CPU utilization.

Average over 5 minutes

Specified by:

metricCPUUtilization in interface IDatabaseInstance

metricDatabaseConnections

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

The number of database connections in use.

Average over 5 minutes

Specified by:

metricDatabaseConnections in interface IDatabaseInstance

Parameters:

props -

metricDatabaseConnections

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

The number of database connections in use.

Average over 5 minutes

Specified by:

metricDatabaseConnections in interface IDatabaseInstance

metricFreeableMemory

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

The amount of available random access memory.

Average over 5 minutes

Specified by:

metricFreeableMemory in interface IDatabaseInstance

Parameters:

props -

metricFreeableMemory

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

The amount of available random access memory.

Average over 5 minutes

Specified by:

metricFreeableMemory in interface IDatabaseInstance

metricFreeStorageSpace

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

The amount of available storage space.

Average over 5 minutes

Specified by:

metricFreeStorageSpace in interface IDatabaseInstance

Parameters:

props -

metricFreeStorageSpace

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

The amount of available storage space.

Average over 5 minutes

Specified by:

metricFreeStorageSpace in interface IDatabaseInstance

metricReadIOPS

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

metricReadIOPS

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

metricWriteIOPS

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

onEvent

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

getConnections

@Stability(value=Stable)
 @NotNull
public abstract Connections getConnections()

Access to network connections.

Specified by:

getConnections in interface IConnectable

getDbInstanceEndpointAddress

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

The instance endpoint address.

Specified by:

getDbInstanceEndpointAddress in interface IDatabaseInstance

getDbInstanceEndpointPort

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

The instance endpoint port.

Specified by:

getDbInstanceEndpointPort in interface IDatabaseInstance

getInstanceArn

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

The instance arn.

Specified by:

getInstanceArn in interface IDatabaseInstance

getInstanceEndpoint

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

The instance endpoint.

Specified by:

getInstanceEndpoint in interface IDatabaseInstance

getInstanceIdentifier

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

The instance identifier.

Specified by:

getInstanceIdentifier in interface IDatabaseInstance

getEngine

@Stability(value=Stable)
 @Nullable
public abstract 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

getEnableIamAuthentication

@Stability(value=Stable)
 @Nullable
protected abstract Boolean getEnableIamAuthentication()

setEnableIamAuthentication

@Stability(value=Stable)
protected abstract void setEnableIamAuthentication(@Nullable
                                                                            Boolean value)