software.amazon.awscdk.services.rds

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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.452Z")
 @Stability(value=Stable)
public class DatabaseInstance
extends DatabaseInstanceBase
implements IDatabaseInstance

A database instance.

Example:

 Vpc vpc;
 // Simple secret
 Secret secret = new Secret(this, "Secret");
 // Using the secret
 DatabaseInstance instance1 = DatabaseInstance.Builder.create(this, "PostgresInstance1")
         .engine(DatabaseInstanceEngine.POSTGRES)
         .credentials(Credentials.fromSecret(secret))
         .vpc(vpc)
         .build();
 // Templated secret with username and password fields
 Secret templatedSecret = Secret.Builder.create(this, "TemplatedSecret")
         .generateSecretString(SecretStringGenerator.builder()
                 .secretStringTemplate(JSON.stringify(Map.of("username", "postgres")))
                 .generateStringKey("password")
                 .build())
         .build();
 // Using the templated secret as credentials
 DatabaseInstance instance2 = DatabaseInstance.Builder.create(this, "PostgresInstance2")
         .engine(DatabaseInstanceEngine.POSTGRES)
         .credentials(Map.of(
                 "username", templatedSecret.secretValueFromJson("username").toString(),
                 "password", templatedSecret.secretValueFromJson("password")))
         .vpc(vpc)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static 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.amazon.awscdk.services.rds.IDatabaseInstance

IDatabaseInstance.Jsii$Default, IDatabaseInstance.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and 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.
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.
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()
protected void	setEnableIamAuthentication(Boolean value)
protected void	setLogRetention()

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

addProxy, asSecretAttachmentTarget, fromDatabaseInstanceAttributes, getInstanceArn, grantConnect, 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.amazon.awscdk.services.rds.IDatabaseInstance

addProxy, getInstanceArn, grantConnect, 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.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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

asSecretAttachmentTarget

Constructor Detail

DatabaseInstance

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

DatabaseInstance

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

DatabaseInstance

@Stability(value=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 Detail

addRotationMultiUser

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

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

setLogRetention

@Stability(value=Stable)
protected void setLogRetention()

getConnections

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

Access to network connections.

Specified by:

getConnections in interface IConnectable

Specified by:

getConnections in class DatabaseInstanceBase

getDbInstanceEndpointAddress

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

The instance endpoint address.

Specified by:

getDbInstanceEndpointAddress in interface IDatabaseInstance

Specified by:

getDbInstanceEndpointAddress in class DatabaseInstanceBase

getDbInstanceEndpointPort

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

The instance endpoint port.

Specified by:

getDbInstanceEndpointPort in interface IDatabaseInstance

Specified by:

getDbInstanceEndpointPort in class DatabaseInstanceBase

getInstanceEndpoint

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

The instance endpoint.

Specified by:

getInstanceEndpoint in interface IDatabaseInstance

Specified by:

getInstanceEndpoint in class DatabaseInstanceBase

getInstanceIdentifier

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

The instance identifier.

Specified by:

getInstanceIdentifier in interface IDatabaseInstance

Specified by:

getInstanceIdentifier in class DatabaseInstanceBase

getInstanceType

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

getNewCfnProps

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

getSourceCfnProps

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

getVpc

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

The VPC where this database instance is deployed.

getEngine

@Stability(value=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

getSecret

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

The AWS Secrets Manager secret attached to the instance.

getVpcPlacement

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

getEnableIamAuthentication

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

Specified by:

getEnableIamAuthentication in class DatabaseInstanceBase

setEnableIamAuthentication

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

Specified by:

setEnableIamAuthentication in class DatabaseInstanceBase