@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
date="2023-03-28T21:34:30.465Z")
public class DatabaseInstance
extends DatabaseInstanceBase
implements IDatabaseInstance
Example:
Vpc vpc;
IInstanceEngine engine = DatabaseInstanceEngine.postgres(PostgresInstanceEngineProps.builder().version(PostgresEngineVersion.VER_12_3).build());
DatabaseInstance.Builder.create(this, "InstanceWithUsername")
.engine(engine)
.vpc(vpc)
.credentials(Credentials.fromGeneratedSecret("postgres"))
.build();
DatabaseInstance.Builder.create(this, "InstanceWithUsernameAndPassword")
.engine(engine)
.vpc(vpc)
.credentials(Credentials.fromPassword("postgres", SecretValue.ssmSecure("/dbPassword", "1")))
.build();
ISecret mySecret = Secret.fromSecretName(this, "DBSecret", "myDBLoginInfo");
DatabaseInstance.Builder.create(this, "InstanceWithSecretLogin")
.engine(engine)
.vpc(vpc)
.credentials(Credentials.fromSecret(mySecret))
.build();
| Modifier and Type | Class and Description |
|---|---|
static class |
DatabaseInstance.Builder
A fluent builder for
DatabaseInstance. |
IDatabaseInstance.Jsii$Default, IDatabaseInstance.Jsii$Proxy| Modifier | Constructor and Description |
|---|---|
protected |
DatabaseInstance(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
DatabaseInstance(software.amazon.jsii.JsiiObjectRef objRef) |
|
DatabaseInstance(software.constructs.Construct scope,
java.lang.String id,
DatabaseInstanceProps props) |
| Modifier and Type | Method and Description |
|---|---|
SecretRotation |
addRotationMultiUser(java.lang.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.
|
java.lang.String |
getDbInstanceEndpointAddress()
The instance endpoint address.
|
java.lang.String |
getDbInstanceEndpointPort()
The instance endpoint port.
|
protected java.lang.Boolean |
getEnableIamAuthentication() |
IInstanceEngine |
getEngine()
The engine of this database Instance.
|
Endpoint |
getInstanceEndpoint()
The instance endpoint.
|
java.lang.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(java.lang.Boolean value) |
protected void |
setLogRetention() |
addProxy, asSecretAttachmentTarget, fromDatabaseInstanceAttributes, getInstanceArn, grantConnect, metric, metric, metricCPUUtilization, metricCPUUtilization, metricDatabaseConnections, metricDatabaseConnections, metricFreeableMemory, metricFreeableMemory, metricFreeStorageSpace, metricFreeStorageSpace, metricReadIOPS, metricReadIOPS, metricWriteIOPS, metricWriteIOPS, onEvent, onEventapplyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResourcegetNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validateclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitaddProxy, getInstanceArn, grantConnect, metric, metric, metricCPUUtilization, metricCPUUtilization, metricDatabaseConnections, metricDatabaseConnections, metricFreeableMemory, metricFreeableMemory, metricFreeStorageSpace, metricFreeStorageSpace, metricReadIOPS, metricReadIOPS, metricWriteIOPS, metricWriteIOPS, onEvent, onEventapplyRemovalPolicy, getEnv, getStackgetNodeasSecretAttachmentTargetprotected DatabaseInstance(software.amazon.jsii.JsiiObjectRef objRef)
protected DatabaseInstance(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public DatabaseInstance(software.constructs.Construct scope,
java.lang.String id,
DatabaseInstanceProps props)
scope - This parameter is required.id - This parameter is required.props - This parameter is required.public SecretRotation addRotationMultiUser(java.lang.String id, RotationMultiUserOptions options)
id - This parameter is required.options - This parameter is required.public SecretRotation addRotationSingleUser(RotationSingleUserOptions options)
options - the options for the rotation, if you want to override the defaults.public SecretRotation addRotationSingleUser()
protected void setLogRetention()
public Connections getConnections()
getConnections in interface IConnectablegetConnections in class DatabaseInstanceBasepublic java.lang.String getDbInstanceEndpointAddress()
getDbInstanceEndpointAddress in interface IDatabaseInstancegetDbInstanceEndpointAddress in class DatabaseInstanceBasepublic java.lang.String getDbInstanceEndpointPort()
getDbInstanceEndpointPort in interface IDatabaseInstancegetDbInstanceEndpointPort in class DatabaseInstanceBasepublic Endpoint getInstanceEndpoint()
getInstanceEndpoint in interface IDatabaseInstancegetInstanceEndpoint in class DatabaseInstanceBasepublic java.lang.String getInstanceIdentifier()
getInstanceIdentifier in interface IDatabaseInstancegetInstanceIdentifier in class DatabaseInstanceBaseprotected InstanceType getInstanceType()
protected CfnDBInstanceProps getNewCfnProps()
protected CfnDBInstanceProps getSourceCfnProps()
public IVpc getVpc()
public IInstanceEngine getEngine()
May be not known for imported Instances if it wasn't provided explicitly, or for read replicas.
getEngine in interface IDatabaseInstancegetEngine in class DatabaseInstanceBasepublic ISecret getSecret()
protected SubnetSelection getVpcPlacement()
protected java.lang.Boolean getEnableIamAuthentication()
getEnableIamAuthentication in class DatabaseInstanceBaseprotected void setEnableIamAuthentication(java.lang.Boolean value)
setEnableIamAuthentication in class DatabaseInstanceBase