Class IDatabaseCluster.Jsii$Proxy
- All Implemented Interfaces:
IResource
,IResource.Jsii$Default
,IConnectable
,IConnectable.Jsii$Default
,IDatabaseCluster
,IDatabaseCluster.Jsii$Default
,ISecretAttachmentTarget
,ISecretAttachmentTarget.Jsii$Default
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IConstruct.Jsii$Default
,software.constructs.IDependable
,software.constructs.IDependable.Jsii$Default
- Enclosing interface:
IDatabaseCluster
-
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.amazon.awscdk.services.ec2.IConnectable
IConnectable.Jsii$Default, IConnectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.rds.IDatabaseCluster
IDatabaseCluster.Jsii$Default, IDatabaseCluster.Jsii$Proxy
Nested classes/interfaces inherited from interface software.constructs.IDependable
software.constructs.IDependable.Jsii$Default, software.constructs.IDependable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource
IResource.Jsii$Default, IResource.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.secretsmanager.ISecretAttachmentTarget
ISecretAttachmentTarget.Jsii$Default, ISecretAttachmentTarget.Jsii$Proxy
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfinal DatabaseProxy
addProxy
(String id, DatabaseProxyOptions options) Add a new db proxy to this cluster.final void
applyRemovalPolicy
(RemovalPolicy policy) Apply the given removal policy to this resource.Renders the target specifications.final String
The ARN of the database cluster.final Endpoint
The endpoint to use for read/write operations.final String
Identifier of the cluster.final Endpoint
Endpoint to use for load-balanced read-only operations.final String
The immutable identifier for the cluster; for example: cluster-ABCD1234EFGH5678IJKL90MNOP.final Connections
The network connections associated with this resource.final IClusterEngine
The engine of this Cluster.final ResourceEnvironment
getEnv()
The environment this resource belongs to.Endpoints which address each individual replica.Identifiers of the replicas.final software.constructs.Node
getNode()
The tree node.final Stack
getStack()
The stack in which this resource is defined.final Grant
grantConnect
(IGrantable grantee, String dbUser) Grant the given identity connection access to the Cluster.final Grant
grantDataApiAccess
(IGrantable grantee) Grant the given identity to access to the Data API.final Metric
Return the given named metric for this DBCluster.final Metric
metric
(String metricName, MetricOptions props) Return the given named metric for this DBCluster.final Metric
The percentage of CPU utilization.final Metric
The percentage of CPU utilization.final Metric
The number of database connections in use.final Metric
The number of database connections in use.final Metric
The average number of deadlocks in the database per second.final Metric
metricDeadlocks
(MetricOptions props) The average number of deadlocks in the database per second.final Metric
The amount of time that the instance has been running, in seconds.final Metric
metricEngineUptime
(MetricOptions props) The amount of time that the instance has been running, in seconds.final Metric
The amount of available random access memory, in bytes.final Metric
The amount of available random access memory, in bytes.final Metric
The amount of local storage available, in bytes.final Metric
The amount of local storage available, in bytes.final Metric
The amount of network throughput received from clients by each instance, in bytes per second.final Metric
The amount of network throughput received from clients by each instance, in bytes per second.final Metric
The amount of network throughput both received from and transmitted to clients by each instance, in bytes per second.final Metric
The amount of network throughput both received from and transmitted to clients by each instance, in bytes per second.final Metric
The amount of network throughput sent to clients by each instance, in bytes per second.final Metric
The amount of network throughput sent to clients by each instance, in bytes per second.final Metric
The total amount of backup storage in bytes consumed by all Aurora snapshots outside its backup retention window.final Metric
The total amount of backup storage in bytes consumed by all Aurora snapshots outside its backup retention window.final Metric
The total amount of backup storage in bytes for which you are billed.final Metric
The total amount of backup storage in bytes for which you are billed.final Metric
The amount of storage used by your Aurora DB instance, in bytes.final Metric
The amount of storage used by your Aurora DB instance, in bytes.final Metric
The number of billed read I/O operations from a cluster volume, reported at 5-minute intervals.final Metric
The number of billed read I/O operations from a cluster volume, reported at 5-minute intervals.final Metric
The number of write disk I/O operations to the cluster volume, reported at 5-minute intervals.final Metric
The number of write disk I/O operations to the cluster volume, reported at 5-minute intervals.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, toString, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Constructor Details
-
Jsii$Proxy
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
-
-
Method Details
-
getNode
@Stability(Stable) @NotNull public final software.constructs.Node getNode()The tree node.- Specified by:
getNode
in interfacesoftware.constructs.IConstruct
- Specified by:
getNode
in interfacesoftware.constructs.IConstruct.Jsii$Default
- Specified by:
getNode
in interfaceIDatabaseCluster.Jsii$Default
- Specified by:
getNode
in interfaceIResource.Jsii$Default
-
getEnv
The environment this resource belongs to.For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
- Specified by:
getEnv
in interfaceIDatabaseCluster.Jsii$Default
- Specified by:
getEnv
in interfaceIResource
- Specified by:
getEnv
in interfaceIResource.Jsii$Default
-
getStack
The stack in which this resource is defined.- Specified by:
getStack
in interfaceIDatabaseCluster.Jsii$Default
- Specified by:
getStack
in interfaceIResource
- Specified by:
getStack
in interfaceIResource.Jsii$Default
-
getConnections
The network connections associated with this resource.- Specified by:
getConnections
in interfaceIConnectable
- Specified by:
getConnections
in interfaceIConnectable.Jsii$Default
- Specified by:
getConnections
in interfaceIDatabaseCluster.Jsii$Default
-
getClusterArn
The ARN of the database cluster.- Specified by:
getClusterArn
in interfaceIDatabaseCluster
- Specified by:
getClusterArn
in interfaceIDatabaseCluster.Jsii$Default
-
getClusterEndpoint
The endpoint to use for read/write operations.- Specified by:
getClusterEndpoint
in interfaceIDatabaseCluster
- Specified by:
getClusterEndpoint
in interfaceIDatabaseCluster.Jsii$Default
-
getClusterIdentifier
Identifier of the cluster.- Specified by:
getClusterIdentifier
in interfaceIDatabaseCluster
- Specified by:
getClusterIdentifier
in interfaceIDatabaseCluster.Jsii$Default
-
getClusterReadEndpoint
Endpoint to use for load-balanced read-only operations.- Specified by:
getClusterReadEndpoint
in interfaceIDatabaseCluster
- Specified by:
getClusterReadEndpoint
in interfaceIDatabaseCluster.Jsii$Default
-
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
- Specified by:
getClusterResourceIdentifier
in interfaceIDatabaseCluster.Jsii$Default
-
getInstanceEndpoints
Endpoints which address each individual replica.- Specified by:
getInstanceEndpoints
in interfaceIDatabaseCluster
- Specified by:
getInstanceEndpoints
in interfaceIDatabaseCluster.Jsii$Default
-
getInstanceIdentifiers
Identifiers of the replicas.- Specified by:
getInstanceIdentifiers
in interfaceIDatabaseCluster
- Specified by:
getInstanceIdentifiers
in interfaceIDatabaseCluster.Jsii$Default
-
getEngine
The engine of this Cluster.May be not known for imported Clusters if it wasn't provided explicitly.
- Specified by:
getEngine
in interfaceIDatabaseCluster
- Specified by:
getEngine
in interfaceIDatabaseCluster.Jsii$Default
-
applyRemovalPolicy
Apply the given removal policy to this resource.The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY
), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN
).- Specified by:
applyRemovalPolicy
in interfaceIDatabaseCluster.Jsii$Default
- Specified by:
applyRemovalPolicy
in interfaceIResource
- Specified by:
applyRemovalPolicy
in interfaceIResource.Jsii$Default
- Parameters:
policy
- This parameter is required.
-
asSecretAttachmentTarget
Renders the target specifications.- Specified by:
asSecretAttachmentTarget
in interfaceIDatabaseCluster.Jsii$Default
- Specified by:
asSecretAttachmentTarget
in interfaceISecretAttachmentTarget
- Specified by:
asSecretAttachmentTarget
in interfaceISecretAttachmentTarget.Jsii$Default
-
addProxy
@Stability(Stable) @NotNull public final DatabaseProxy addProxy(@NotNull String id, @NotNull DatabaseProxyOptions options) Add a new db proxy to this cluster.- Specified by:
addProxy
in interfaceIDatabaseCluster
- Specified by:
addProxy
in interfaceIDatabaseCluster.Jsii$Default
- Parameters:
id
- This parameter is required.options
- This parameter is required.
-
grantConnect
@Stability(Stable) @NotNull public final Grant grantConnect(@NotNull IGrantable grantee, @NotNull String dbUser) Grant the given identity connection access to the Cluster.- Specified by:
grantConnect
in interfaceIDatabaseCluster
- Specified by:
grantConnect
in interfaceIDatabaseCluster.Jsii$Default
- Parameters:
grantee
- the Principal to grant the permissions to. This parameter is required.dbUser
- the name of the database user to allow connecting. This parameter is required.
-
grantDataApiAccess
Grant the given identity to access to the Data API.- Specified by:
grantDataApiAccess
in interfaceIDatabaseCluster
- Specified by:
grantDataApiAccess
in interfaceIDatabaseCluster.Jsii$Default
- Parameters:
grantee
- The principal to grant access to. This parameter is required.
-
metric
@Stability(Stable) @NotNull public final Metric metric(@NotNull String metricName, @Nullable MetricOptions props) Return the given named metric for this DBCluster.- Specified by:
metric
in interfaceIDatabaseCluster
- Specified by:
metric
in interfaceIDatabaseCluster.Jsii$Default
- 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
- Specified by:
metricCPUUtilization
in interfaceIDatabaseCluster.Jsii$Default
- Parameters:
props
-
-
metricCPUUtilization
The percentage of CPU utilization.Average over 5 minutes
- Specified by:
metricCPUUtilization
in interfaceIDatabaseCluster
-
metricDatabaseConnections
@Stability(Stable) @NotNull public final Metric metricDatabaseConnections(@Nullable MetricOptions props) The number of database connections in use.Average over 5 minutes
- Specified by:
metricDatabaseConnections
in interfaceIDatabaseCluster
- Specified by:
metricDatabaseConnections
in interfaceIDatabaseCluster.Jsii$Default
- 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
- Specified by:
metricDeadlocks
in interfaceIDatabaseCluster.Jsii$Default
- 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
- Specified by:
metricEngineUptime
in interfaceIDatabaseCluster.Jsii$Default
- 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
- Specified by:
metricFreeableMemory
in interfaceIDatabaseCluster.Jsii$Default
- Parameters:
props
-
-
metricFreeableMemory
The amount of available random access memory, in bytes.Average over 5 minutes
- Specified by:
metricFreeableMemory
in interfaceIDatabaseCluster
-
metricFreeLocalStorage
@Stability(Stable) @NotNull public final Metric metricFreeLocalStorage(@Nullable MetricOptions props) The amount of local storage available, in bytes.Average over 5 minutes
- Specified by:
metricFreeLocalStorage
in interfaceIDatabaseCluster
- Specified by:
metricFreeLocalStorage
in interfaceIDatabaseCluster.Jsii$Default
- 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 final 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
- Specified by:
metricNetworkReceiveThroughput
in interfaceIDatabaseCluster.Jsii$Default
- 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
@Stability(Stable) @NotNull public final Metric metricNetworkThroughput(@Nullable MetricOptions props) 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
- Specified by:
metricNetworkThroughput
in interfaceIDatabaseCluster.Jsii$Default
- 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 final 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
- Specified by:
metricNetworkTransmitThroughput
in interfaceIDatabaseCluster.Jsii$Default
- 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
@Stability(Stable) @NotNull public final Metric metricSnapshotStorageUsed(@Nullable MetricOptions props) 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
- Specified by:
metricSnapshotStorageUsed
in interfaceIDatabaseCluster.Jsii$Default
- 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 final 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
- Specified by:
metricTotalBackupStorageBilled
in interfaceIDatabaseCluster.Jsii$Default
- 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
@Stability(Stable) @NotNull public final Metric metricVolumeBytesUsed(@Nullable MetricOptions props) The amount of storage used by your Aurora DB instance, in bytes.Average over 5 minutes
- Specified by:
metricVolumeBytesUsed
in interfaceIDatabaseCluster
- Specified by:
metricVolumeBytesUsed
in interfaceIDatabaseCluster.Jsii$Default
- 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
- Specified by:
metricVolumeReadIOPs
in interfaceIDatabaseCluster.Jsii$Default
- 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
@Stability(Stable) @NotNull public final Metric metricVolumeWriteIOPs(@Nullable MetricOptions props) 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
- Specified by:
metricVolumeWriteIOPs
in interfaceIDatabaseCluster.Jsii$Default
- 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
-