Class DatabaseClusterBase
- All Implemented Interfaces:
IResource
,IConnectable
,IDatabaseCluster
,ISecretAttachmentTarget
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
- Direct Known Subclasses:
DatabaseCluster
,DatabaseClusterFromSnapshot
-
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.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.rds.IDatabaseCluster
IDatabaseCluster.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource
IResource.Jsii$Default
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
DatabaseClusterBase
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
DatabaseClusterBase
(software.amazon.jsii.JsiiObjectRef objRef) protected
DatabaseClusterBase
(software.constructs.Construct scope, String id) protected
DatabaseClusterBase
(software.constructs.Construct scope, String id, ResourceProps props) -
Method Summary
Modifier and TypeMethodDescriptionaddProxy
(String id, DatabaseProxyOptions options) Add a new db proxy to this cluster.Renders the secret attachment target specifications.The ARN of the cluster.abstract Endpoint
The endpoint to use for read/write operations.abstract String
Identifier of the cluster.abstract Endpoint
Endpoint to use for load-balanced read-only operations.abstract String
The immutable identifier for the cluster; for example: cluster-ABCD1234EFGH5678IJKL90MNOP.abstract Connections
Access to the network connections.protected abstract Boolean
abstract IClusterEngine
The engine of this Cluster.Endpoints which address each individual replica.Identifiers of the replicas.abstract ISecret
The secret attached to this cluster.grantConnect
(IGrantable grantee, String dbUser) Grant the given identity connection access to the Cluster.grantDataApiAccess
(IGrantable grantee) Grant the given identity to access the Data API.Return the given named metric for this DBCluster.metric
(String metricName, MetricOptions props) Return the given named metric for this DBCluster.The percentage of CPU utilization.The percentage of CPU utilization.The number of database connections in use.The number of database connections in use.The average number of deadlocks in the database per second.metricDeadlocks
(MetricOptions props) The average number of deadlocks in the database per second.The amount of time that the instance has been running, in seconds.metricEngineUptime
(MetricOptions props) The amount of time that the instance has been running, in seconds.The amount of available random access memory, in bytes.The amount of available random access memory, in bytes.The amount of local storage available, in bytes.The amount of local storage available, in bytes.The amount of network throughput received from clients by each instance, in bytes per second.The amount of network throughput received from clients by each instance, in bytes per second.The amount of network throughput both received from and transmitted to clients by each instance, in bytes per second.The amount of network throughput both received from and transmitted to clients by each instance, in bytes per second.The amount of network throughput sent to clients by each instance, in bytes per second.The amount of network throughput sent to clients by each instance, in bytes per second.The total amount of backup storage in bytes consumed by all Aurora snapshots outside its backup retention window.The total amount of backup storage in bytes consumed by all Aurora snapshots outside its backup retention window.The total amount of backup storage in bytes for which you are billed.The total amount of backup storage in bytes for which you are billed.The amount of storage used by your Aurora DB instance, in bytes.The amount of storage used by your Aurora DB instance, in bytes.The number of billed read I/O operations from a cluster volume, reported at 5-minute intervals.The number of billed read I/O operations from a cluster volume, reported at 5-minute intervals.The number of write disk I/O operations to the cluster volume, reported at 5-minute intervals.The number of write disk I/O operations to the cluster volume, reported at 5-minute intervals.protected abstract void
setEnableDataApi
(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.constructs.IConstruct
getNode
Methods inherited from interface software.amazon.awscdk.IResource
applyRemovalPolicy, getEnv, getStack
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Constructor Details
-
DatabaseClusterBase
protected DatabaseClusterBase(software.amazon.jsii.JsiiObjectRef objRef) -
DatabaseClusterBase
protected DatabaseClusterBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
DatabaseClusterBase
@Stability(Stable) protected DatabaseClusterBase(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable ResourceProps props) - Parameters:
scope
- This parameter is required.id
- This parameter is required.props
-
-
DatabaseClusterBase
@Stability(Stable) protected DatabaseClusterBase(@NotNull software.constructs.Construct scope, @NotNull String id) - Parameters:
scope
- This parameter is required.id
- This parameter is required.
-
-
Method Details
-
addProxy
@Stability(Stable) @NotNull public DatabaseProxy addProxy(@NotNull String id, @NotNull DatabaseProxyOptions options) Add a new db proxy to this cluster.- Specified by:
addProxy
in interfaceIDatabaseCluster
- Parameters:
id
- This parameter is required.options
- This parameter is required.
-
asSecretAttachmentTarget
Renders the secret attachment target specifications.- Specified by:
asSecretAttachmentTarget
in interfaceISecretAttachmentTarget
-
grantConnect
@Stability(Stable) @NotNull public Grant grantConnect(@NotNull IGrantable grantee, @NotNull String dbUser) Grant the given identity connection access to the Cluster.- Specified by:
grantConnect
in interfaceIDatabaseCluster
- Parameters:
grantee
- This parameter is required.dbUser
- This parameter is required.
-
grantDataApiAccess
Grant the given identity to access the Data API.- Specified by:
grantDataApiAccess
in interfaceIDatabaseCluster
- Parameters:
grantee
- This parameter is required.
-
metric
@Stability(Stable) @NotNull public Metric metric(@NotNull String metricName, @Nullable MetricOptions props) Return the given named metric for this DBCluster.- Specified by:
metric
in interfaceIDatabaseCluster
- Parameters:
metricName
- This parameter is required.props
-
-
metric
Return the given named metric for this DBCluster.- Specified by:
metric
in interfaceIDatabaseCluster
- Parameters:
metricName
- This parameter is required.
-
metricCPUUtilization
The percentage of CPU utilization.Average over 5 minutes
- Specified by:
metricCPUUtilization
in interfaceIDatabaseCluster
- Parameters:
props
-
-
metricCPUUtilization
The percentage of CPU utilization.Average over 5 minutes
- Specified by:
metricCPUUtilization
in interfaceIDatabaseCluster
-
metricDatabaseConnections
The number of database connections in use.Average over 5 minutes
- Specified by:
metricDatabaseConnections
in interfaceIDatabaseCluster
- Parameters:
props
-
-
metricDatabaseConnections
The number of database connections in use.Average over 5 minutes
- Specified by:
metricDatabaseConnections
in interfaceIDatabaseCluster
-
metricDeadlocks
The average number of deadlocks in the database per second.Average over 5 minutes
- Specified by:
metricDeadlocks
in interfaceIDatabaseCluster
- Parameters:
props
-
-
metricDeadlocks
The average number of deadlocks in the database per second.Average over 5 minutes
- Specified by:
metricDeadlocks
in interfaceIDatabaseCluster
-
metricEngineUptime
The amount of time that the instance has been running, in seconds.Average over 5 minutes
- Specified by:
metricEngineUptime
in interfaceIDatabaseCluster
- Parameters:
props
-
-
metricEngineUptime
The amount of time that the instance has been running, in seconds.Average over 5 minutes
- Specified by:
metricEngineUptime
in interfaceIDatabaseCluster
-
metricFreeableMemory
The amount of available random access memory, in bytes.Average over 5 minutes
- Specified by:
metricFreeableMemory
in interfaceIDatabaseCluster
- Parameters:
props
-
-
metricFreeableMemory
The amount of available random access memory, in bytes.Average over 5 minutes
- Specified by:
metricFreeableMemory
in interfaceIDatabaseCluster
-
metricFreeLocalStorage
The amount of local storage available, in bytes.Average over 5 minutes
- Specified by:
metricFreeLocalStorage
in interfaceIDatabaseCluster
- Parameters:
props
-
-
metricFreeLocalStorage
The amount of local storage available, in bytes.Average over 5 minutes
- Specified by:
metricFreeLocalStorage
in interfaceIDatabaseCluster
-
metricNetworkReceiveThroughput
@Stability(Stable) @NotNull public Metric metricNetworkReceiveThroughput(@Nullable MetricOptions props) The amount of network throughput received from clients by each instance, in bytes per second.Average over 5 minutes
- Specified by:
metricNetworkReceiveThroughput
in interfaceIDatabaseCluster
- Parameters:
props
-
-
metricNetworkReceiveThroughput
The amount of network throughput received from clients by each instance, in bytes per second.Average over 5 minutes
- Specified by:
metricNetworkReceiveThroughput
in interfaceIDatabaseCluster
-
metricNetworkThroughput
The amount of network throughput both received from and transmitted to clients by each instance, in bytes per second.Average over 5 minutes
- Specified by:
metricNetworkThroughput
in interfaceIDatabaseCluster
- Parameters:
props
-
-
metricNetworkThroughput
The amount of network throughput both received from and transmitted to clients by each instance, in bytes per second.Average over 5 minutes
- Specified by:
metricNetworkThroughput
in interfaceIDatabaseCluster
-
metricNetworkTransmitThroughput
@Stability(Stable) @NotNull public Metric metricNetworkTransmitThroughput(@Nullable MetricOptions props) The amount of network throughput sent to clients by each instance, in bytes per second.Average over 5 minutes
- Specified by:
metricNetworkTransmitThroughput
in interfaceIDatabaseCluster
- Parameters:
props
-
-
metricNetworkTransmitThroughput
The amount of network throughput sent to clients by each instance, in bytes per second.Average over 5 minutes
- Specified by:
metricNetworkTransmitThroughput
in interfaceIDatabaseCluster
-
metricSnapshotStorageUsed
The total amount of backup storage in bytes consumed by all Aurora snapshots outside its backup retention window.Average over 5 minutes
- Specified by:
metricSnapshotStorageUsed
in interfaceIDatabaseCluster
- Parameters:
props
-
-
metricSnapshotStorageUsed
The total amount of backup storage in bytes consumed by all Aurora snapshots outside its backup retention window.Average over 5 minutes
- Specified by:
metricSnapshotStorageUsed
in interfaceIDatabaseCluster
-
metricTotalBackupStorageBilled
@Stability(Stable) @NotNull public Metric metricTotalBackupStorageBilled(@Nullable MetricOptions props) The total amount of backup storage in bytes for which you are billed.Average over 5 minutes
- Specified by:
metricTotalBackupStorageBilled
in interfaceIDatabaseCluster
- Parameters:
props
-
-
metricTotalBackupStorageBilled
The total amount of backup storage in bytes for which you are billed.Average over 5 minutes
- Specified by:
metricTotalBackupStorageBilled
in interfaceIDatabaseCluster
-
metricVolumeBytesUsed
The amount of storage used by your Aurora DB instance, in bytes.Average over 5 minutes
- Specified by:
metricVolumeBytesUsed
in interfaceIDatabaseCluster
- Parameters:
props
-
-
metricVolumeBytesUsed
The amount of storage used by your Aurora DB instance, in bytes.Average over 5 minutes
- Specified by:
metricVolumeBytesUsed
in interfaceIDatabaseCluster
-
metricVolumeReadIOPs
The number of billed read I/O operations from a cluster volume, reported at 5-minute intervals.Average over 5 minutes
- Specified by:
metricVolumeReadIOPs
in interfaceIDatabaseCluster
- Parameters:
props
-
-
metricVolumeReadIOPs
The number of billed read I/O operations from a cluster volume, reported at 5-minute intervals.Average over 5 minutes
- Specified by:
metricVolumeReadIOPs
in interfaceIDatabaseCluster
-
metricVolumeWriteIOPs
The number of write disk I/O operations to the cluster volume, reported at 5-minute intervals.Average over 5 minutes
- Specified by:
metricVolumeWriteIOPs
in interfaceIDatabaseCluster
- Parameters:
props
-
-
metricVolumeWriteIOPs
The number of write disk I/O operations to the cluster volume, reported at 5-minute intervals.Average over 5 minutes
- Specified by:
metricVolumeWriteIOPs
in interfaceIDatabaseCluster
-
getClusterArn
The ARN of the cluster.- Specified by:
getClusterArn
in interfaceIDatabaseCluster
-
getClusterEndpoint
The endpoint to use for read/write operations.- Specified by:
getClusterEndpoint
in interfaceIDatabaseCluster
-
getClusterIdentifier
Identifier of the cluster.- Specified by:
getClusterIdentifier
in interfaceIDatabaseCluster
-
getClusterReadEndpoint
Endpoint to use for load-balanced read-only operations.- Specified by:
getClusterReadEndpoint
in interfaceIDatabaseCluster
-
getClusterResourceIdentifier
The immutable identifier for the cluster; for example: cluster-ABCD1234EFGH5678IJKL90MNOP.This AWS Region-unique identifier is used in things like IAM authentication policies.
- Specified by:
getClusterResourceIdentifier
in interfaceIDatabaseCluster
-
getConnections
Access to the network connections.- Specified by:
getConnections
in interfaceIConnectable
-
getInstanceEndpoints
Endpoints which address each individual replica.- Specified by:
getInstanceEndpoints
in interfaceIDatabaseCluster
-
getInstanceIdentifiers
Identifiers of the replicas.- Specified by:
getInstanceIdentifiers
in interfaceIDatabaseCluster
-
getEngine
The engine of this Cluster.May be not known for imported Clusters if it wasn't provided explicitly.
- Specified by:
getEngine
in interfaceIDatabaseCluster
-
getSecret
The secret attached to this cluster. -
getEnableDataApi
-
setEnableDataApi
-