Class DatabaseInstance

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.rds.DatabaseInstanceBase

software.amazon.awscdk.services.rds.DatabaseInstance

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.112.0 (build de1bc80)",
           date="2025-05-19T18:25:56.179Z")
@Stability(Stable)
public class DatabaseInstance
extends DatabaseInstanceBase
implements IDatabaseInstance

A database instance.

Example:

 Vpc vpc;
 DatabaseInstance iopsInstance = DatabaseInstance.Builder.create(this, "IopsInstance")
         .engine(DatabaseInstanceEngine.mysql(MySqlInstanceEngineProps.builder().version(MysqlEngineVersion.VER_8_0_39).build()))
         .vpc(vpc)
         .storageType(StorageType.IO1)
         .iops(5000)
         .build();
 DatabaseInstance gp3Instance = DatabaseInstance.Builder.create(this, "Gp3Instance")
         .engine(DatabaseInstanceEngine.mysql(MySqlInstanceEngineProps.builder().version(MysqlEngineVersion.VER_8_0_39).build()))
         .vpc(vpc)
         .allocatedStorage(500)
         .storageType(StorageType.GP3)
         .storageThroughput(500)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	DatabaseInstance.Builder	A fluent builder for DatabaseInstance.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

software.constructs.IConstruct.Jsii$Default

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.amazon.awscdk.IResource

IResource.Jsii$Default

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_INJECTION_ID	Uniquely identifies this class.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
SecretRotation	addRotationMultiUser(String id, RotationMultiUserOptions options)	Adds the multi user rotation to this instance.
SecretRotation	addRotationSingleUser()	Adds the single user rotation of the master password to this instance.
SecretRotation	addRotationSingleUser(RotationSingleUserOptions options)	Adds the single user rotation of the master password to this instance.
Map<String,ILogGroup>	getCloudwatchLogGroups()	The log group is created when cloudwatchLogsExports is set.
Connections	getConnections()	Access to network connections.
String	getDbInstanceEndpointAddress()	The instance endpoint address.
String	getDbInstanceEndpointPort()	The instance endpoint port.
protected Boolean	getEnableIamAuthentication()
IInstanceEngine	getEngine()	The engine of this database Instance.
Endpoint	getInstanceEndpoint()	The instance endpoint.
String	getInstanceIdentifier()	The instance identifier.
String	getInstanceResourceId()	The AWS Region-unique, immutable identifier for the DB instance.
protected InstanceType	getInstanceType()
protected CfnDBInstanceProps	getNewCfnProps()
ISecret	getSecret()	The AWS Secrets Manager secret attached to the instance.
protected CfnDBInstanceProps	getSourceCfnProps()
IVpc	getVpc()	The VPC where this database instance is deployed.
protected SubnetSelection	getVpcPlacement()
Grant	grantConnect(IGrantable grantee)	Grant the given identity connection access to the database.
Grant	grantConnect(IGrantable grantee, String dbUser)	Grant the given identity connection access to the database.
protected void	setEnableIamAuthentication(Boolean value)
protected void	setLogRetention()

Methods inherited from class software.amazon.awscdk.services.rds.DatabaseInstanceBase

addProxy, asSecretAttachmentTarget, fromDatabaseInstanceAttributes, fromLookup, getInstanceArn, metric, metric, metricCPUUtilization, metricCPUUtilization, metricDatabaseConnections, metricDatabaseConnections, metricFreeableMemory, metricFreeableMemory, metricFreeStorageSpace, metricFreeStorageSpace, metricReadIOPS, metricReadIOPS, metricWriteIOPS, metricWriteIOPS, onEvent, onEvent

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.constructs.IConstruct

getNode

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

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

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.services.secretsmanager.ISecretAttachmentTarget

asSecretAttachmentTarget

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

PROPERTY_INJECTION_ID

@Stability(Stable)
public static final String PROPERTY_INJECTION_ID

Uniquely identifies this class.

Constructor Details

DatabaseInstance

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

DatabaseInstance

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

DatabaseInstance

@Stability(Stable)
public DatabaseInstance(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 DatabaseInstanceProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

addRotationMultiUser

@Stability(Stable)
@NotNull
public SecretRotation addRotationMultiUser(@NotNull
 String id,
 @NotNull
 RotationMultiUserOptions options)

Adds the multi user rotation to this instance.

Parameters:

id - This parameter is required.

options - This parameter is required.

addRotationSingleUser

@Stability(Stable)
@NotNull
public SecretRotation addRotationSingleUser(@Nullable
 RotationSingleUserOptions options)

Adds the single user rotation of the master password to this instance.

Parameters:

options - the options for the rotation, if you want to override the defaults.

addRotationSingleUser

@Stability(Stable)
@NotNull
public SecretRotation addRotationSingleUser()

Adds the single user rotation of the master password to this instance.

grantConnect

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

Grant the given identity connection access to the database.

Specified by:

grantConnect in interface IDatabaseInstance

Overrides:

grantConnect in class DatabaseInstanceBase

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, or the default database user, obtained from the Secret, if not specified.

grantConnect

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

Grant the given identity connection access to the database.

Specified by:

grantConnect in interface IDatabaseInstance

Overrides:

grantConnect in class DatabaseInstanceBase

Parameters:

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

setLogRetention

@Stability(Stable)
protected void setLogRetention()

getCloudwatchLogGroups

@Stability(Stable)
@NotNull
public Map<String,ILogGroup> getCloudwatchLogGroups()

The log group is created when cloudwatchLogsExports is set.

Each export value will create a separate log group.

getConnections

@Stability(Stable)
@NotNull
public Connections getConnections()

Access to network connections.

Specified by:

getConnections in interface IConnectable

Specified by:

getConnections in class DatabaseInstanceBase

getDbInstanceEndpointAddress

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

The instance endpoint address.

Specified by:

getDbInstanceEndpointAddress in interface IDatabaseInstance

Specified by:

getDbInstanceEndpointAddress in class DatabaseInstanceBase

getDbInstanceEndpointPort

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

The instance endpoint port.

Specified by:

getDbInstanceEndpointPort in interface IDatabaseInstance

Specified by:

getDbInstanceEndpointPort in class DatabaseInstanceBase

getInstanceEndpoint

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

The instance endpoint.

Specified by:

getInstanceEndpoint in interface IDatabaseInstance

Specified by:

getInstanceEndpoint in class DatabaseInstanceBase

getInstanceIdentifier

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

The instance identifier.

Specified by:

getInstanceIdentifier in interface IDatabaseInstance

Specified by:

getInstanceIdentifier in class DatabaseInstanceBase

getInstanceType

@Stability(Stable)
@NotNull
protected InstanceType getInstanceType()

getNewCfnProps

@Stability(Stable)
@NotNull
protected CfnDBInstanceProps getNewCfnProps()

getSourceCfnProps

@Stability(Stable)
@NotNull
protected CfnDBInstanceProps getSourceCfnProps()

getVpc

@Stability(Stable)
@NotNull
public IVpc getVpc()

The VPC where this database instance is deployed.

getEngine

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

getInstanceResourceId

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

See Also:

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

getSecret

@Stability(Stable)
@Nullable
public ISecret getSecret()

The AWS Secrets Manager secret attached to the instance.

getVpcPlacement

@Stability(Stable)
@Nullable
protected SubnetSelection getVpcPlacement()

getEnableIamAuthentication

@Stability(Stable)
@Nullable
protected Boolean getEnableIamAuthentication()

Specified by:

getEnableIamAuthentication in class DatabaseInstanceBase

setEnableIamAuthentication

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

Specified by:

setEnableIamAuthentication in class DatabaseInstanceBase