Class DatabaseInstanceReadReplica
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.DatabaseInstanceReadReplica
- All Implemented Interfaces:
IResource
,IConnectable
,IDatabaseInstance
,ISecretAttachmentTarget
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
date="2024-08-29T22:54:24.576Z")
@Stability(Stable)
public class DatabaseInstanceReadReplica
extends DatabaseInstanceBase
implements IDatabaseInstance
A read replica database instance.
Example:
Vpc vpc; DatabaseInstance sourceInstance; DatabaseInstanceFromSnapshot.Builder.create(this, "Instance") .snapshotIdentifier("my-snapshot") .engine(DatabaseInstanceEngine.postgres(PostgresInstanceEngineProps.builder().version(PostgresEngineVersion.VER_16_3).build())) // optional, defaults to m5.large .instanceType(InstanceType.of(InstanceClass.BURSTABLE2, InstanceSize.LARGE)) .vpc(vpc) .build(); DatabaseInstanceReadReplica.Builder.create(this, "ReadReplica") .sourceDatabaseInstance(sourceInstance) .instanceType(InstanceType.of(InstanceClass.BURSTABLE2, InstanceSize.LARGE)) .vpc(vpc) .build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
A fluent builder forDatabaseInstanceReadReplica
.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
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
DatabaseInstanceReadReplica
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
DatabaseInstanceReadReplica
(software.amazon.jsii.JsiiObjectRef objRef) DatabaseInstanceReadReplica
(software.constructs.Construct scope, String id, DatabaseInstanceReadReplicaProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe log group is created whencloudwatchLogsExports
is set.Access to network connections.The instance endpoint address.The instance endpoint port.protected Boolean
The engine of this database Instance.The instance endpoint.The instance identifier.The AWS Region-unique, immutable identifier for the DB instance.protected InstanceType
protected CfnDBInstanceProps
getVpc()
The VPC where this database instance is deployed.protected SubnetSelection
protected void
protected void
Methods inherited from class software.amazon.awscdk.services.rds.DatabaseInstanceBase
addProxy, asSecretAttachmentTarget, fromDatabaseInstanceAttributes, getInstanceArn, grantConnect, 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.constructs.IConstruct
getNode
Methods inherited from interface software.amazon.awscdk.services.rds.IDatabaseInstance
addProxy, getInstanceArn, grantConnect, 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.amazon.awscdk.services.secretsmanager.ISecretAttachmentTarget
asSecretAttachmentTarget
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Constructor Details
-
DatabaseInstanceReadReplica
protected DatabaseInstanceReadReplica(software.amazon.jsii.JsiiObjectRef objRef) -
DatabaseInstanceReadReplica
protected DatabaseInstanceReadReplica(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
DatabaseInstanceReadReplica
@Stability(Stable) public DatabaseInstanceReadReplica(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull DatabaseInstanceReadReplicaProps props) - Parameters:
scope
- This parameter is required.id
- This parameter is required.props
- This parameter is required.
-
-
Method Details
-
setLogRetention
@Stability(Stable) protected void setLogRetention() -
getCloudwatchLogGroups
The log group is created whencloudwatchLogsExports
is set.Each export value will create a separate log group.
-
getConnections
Access to network connections.- Specified by:
getConnections
in interfaceIConnectable
- Specified by:
getConnections
in classDatabaseInstanceBase
-
getDbInstanceEndpointAddress
The instance endpoint address.- Specified by:
getDbInstanceEndpointAddress
in interfaceIDatabaseInstance
- Specified by:
getDbInstanceEndpointAddress
in classDatabaseInstanceBase
-
getDbInstanceEndpointPort
The instance endpoint port.- Specified by:
getDbInstanceEndpointPort
in interfaceIDatabaseInstance
- Specified by:
getDbInstanceEndpointPort
in classDatabaseInstanceBase
-
getInstanceEndpoint
The instance endpoint.- Specified by:
getInstanceEndpoint
in interfaceIDatabaseInstance
- Specified by:
getInstanceEndpoint
in classDatabaseInstanceBase
-
getInstanceIdentifier
The instance identifier.- Specified by:
getInstanceIdentifier
in interfaceIDatabaseInstance
- Specified by:
getInstanceIdentifier
in classDatabaseInstanceBase
-
getInstanceType
-
getNewCfnProps
-
getVpc
The VPC where this database instance is deployed. -
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 interfaceIDatabaseInstance
- Specified by:
getEngine
in classDatabaseInstanceBase
-
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 interfaceIDatabaseInstance
- Specified by:
getInstanceResourceId
in classDatabaseInstanceBase
- See Also:
-
getVpcPlacement
-
getEnableIamAuthentication
- Specified by:
getEnableIamAuthentication
in classDatabaseInstanceBase
-
setEnableIamAuthentication
- Specified by:
setEnableIamAuthentication
in classDatabaseInstanceBase
-