Class IDatabaseCluster.Jsii$Proxy
- All Implemented Interfaces:
IEnvironmentAware,IEnvironmentAware.Jsii$Default,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.InitializationModeNested classes/interfaces inherited from interface software.amazon.awscdk.services.ec2.IConnectable
IConnectable.Jsii$Default, IConnectable.Jsii$ProxyNested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.services.rds.IDatabaseCluster
IDatabaseCluster.Jsii$Default, IDatabaseCluster.Jsii$ProxyNested classes/interfaces inherited from interface software.constructs.IDependable
software.constructs.IDependable.Jsii$Default, software.constructs.IDependable.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.IEnvironmentAware
IEnvironmentAware.Jsii$Default, IEnvironmentAware.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.IResource
IResource.Jsii$Default, IResource.Jsii$ProxyNested 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 DatabaseProxyaddProxy(String id, DatabaseProxyOptions options) Add a new db proxy to this cluster.final voidapplyRemovalPolicy(RemovalPolicy policy) Apply the given removal policy to this resource.Renders the target specifications.final StringThe ARN of the database cluster.final EndpointThe endpoint to use for read/write operations.final StringIdentifier of the cluster.final EndpointEndpoint to use for load-balanced read-only operations.final StringThe immutable identifier for the cluster; for example: cluster-ABCD1234EFGH5678IJKL90MNOP.final ConnectionsThe network connections associated with this resource.final IClusterEngineThe engine of this Cluster.final ResourceEnvironmentgetEnv()The environment this resource belongs to.Endpoints which address each individual replica.Identifiers of the replicas.final software.constructs.NodegetNode()The tree node.final StackgetStack()The stack in which this resource is defined.final GrantgrantConnect(IGrantable grantee, String dbUser) Grant the given identity connection access to the Cluster.final GrantgrantDataApiAccess(IGrantable grantee) Grant the given identity to access to the Data API.final MetricReturn the given named metric for this DBCluster.final Metricmetric(String metricName, MetricOptions props) Return the given named metric for this DBCluster.final MetricThe percentage of CPU utilization.final MetricThe percentage of CPU utilization.final MetricThe number of database connections in use.final MetricThe number of database connections in use.final MetricThe average number of deadlocks in the database per second.final MetricmetricDeadlocks(MetricOptions props) The average number of deadlocks in the database per second.final MetricThe amount of time that the instance has been running, in seconds.final MetricmetricEngineUptime(MetricOptions props) The amount of time that the instance has been running, in seconds.final MetricThe amount of available random access memory, in bytes.final MetricThe amount of available random access memory, in bytes.final MetricThe amount of local storage available, in bytes.final MetricThe amount of local storage available, in bytes.final MetricThe amount of network throughput received from clients by each instance, in bytes per second.final MetricThe amount of network throughput received from clients by each instance, in bytes per second.final MetricThe amount of network throughput both received from and transmitted to clients by each instance, in bytes per second.final MetricThe amount of network throughput both received from and transmitted to clients by each instance, in bytes per second.final MetricThe amount of network throughput sent to clients by each instance, in bytes per second.final MetricThe amount of network throughput sent to clients by each instance, in bytes per second.final MetricThe total amount of backup storage in bytes consumed by all Aurora snapshots outside its backup retention window.final MetricThe total amount of backup storage in bytes consumed by all Aurora snapshots outside its backup retention window.final MetricThe total amount of backup storage in bytes for which you are billed.final MetricThe total amount of backup storage in bytes for which you are billed.final MetricThe amount of storage used by your Aurora DB instance, in bytes.final MetricThe amount of storage used by your Aurora DB instance, in bytes.final MetricThe number of billed read I/O operations from a cluster volume, reported at 5-minute intervals.final MetricThe number of billed read I/O operations from a cluster volume, reported at 5-minute intervals.final MetricThe number of write disk I/O operations to the cluster volume, reported at 5-minute intervals.final MetricThe 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, jsiiStaticSetMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods 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:
getNodein interfacesoftware.constructs.IConstruct- Specified by:
getNodein interfacesoftware.constructs.IConstruct.Jsii$Default- Specified by:
getNodein interfaceIDatabaseCluster.Jsii$Default- Specified by:
getNodein interfaceIResource.Jsii$Default
-
getEnv
The environment this resource belongs to.For resources that are created and managed in a Stack (those created by creating new class instances like
new Role(),new Bucket(), etc.), this is always the same as the environment of the stack they belong to.For referenced resources (those obtained from referencing methods like
Role.fromRoleArn(),Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.- Specified by:
getEnvin interfaceIDatabaseCluster.Jsii$Default- Specified by:
getEnvin interfaceIEnvironmentAware- Specified by:
getEnvin interfaceIEnvironmentAware.Jsii$Default- Specified by:
getEnvin interfaceIResource.Jsii$Default
-
getStack
The stack in which this resource is defined.- Specified by:
getStackin interfaceIDatabaseCluster.Jsii$Default- Specified by:
getStackin interfaceIResource- Specified by:
getStackin interfaceIResource.Jsii$Default
-
getConnections
The network connections associated with this resource.- Specified by:
getConnectionsin interfaceIConnectable- Specified by:
getConnectionsin interfaceIConnectable.Jsii$Default- Specified by:
getConnectionsin interfaceIDatabaseCluster.Jsii$Default
-
getClusterArn
The ARN of the database cluster.- Specified by:
getClusterArnin interfaceIDatabaseCluster- Specified by:
getClusterArnin interfaceIDatabaseCluster.Jsii$Default
-
getClusterEndpoint
The endpoint to use for read/write operations.- Specified by:
getClusterEndpointin interfaceIDatabaseCluster- Specified by:
getClusterEndpointin interfaceIDatabaseCluster.Jsii$Default
-
getClusterIdentifier
Identifier of the cluster.- Specified by:
getClusterIdentifierin interfaceIDatabaseCluster- Specified by:
getClusterIdentifierin interfaceIDatabaseCluster.Jsii$Default
-
getClusterReadEndpoint
Endpoint to use for load-balanced read-only operations.- Specified by:
getClusterReadEndpointin interfaceIDatabaseCluster- Specified by:
getClusterReadEndpointin 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:
getClusterResourceIdentifierin interfaceIDatabaseCluster- Specified by:
getClusterResourceIdentifierin interfaceIDatabaseCluster.Jsii$Default
-
getInstanceEndpoints
Endpoints which address each individual replica.- Specified by:
getInstanceEndpointsin interfaceIDatabaseCluster- Specified by:
getInstanceEndpointsin interfaceIDatabaseCluster.Jsii$Default
-
getInstanceIdentifiers
Identifiers of the replicas.- Specified by:
getInstanceIdentifiersin interfaceIDatabaseCluster- Specified by:
getInstanceIdentifiersin interfaceIDatabaseCluster.Jsii$Default
-
getEngine
The engine of this Cluster.May be not known for imported Clusters if it wasn't provided explicitly.
- Specified by:
getEnginein interfaceIDatabaseCluster- Specified by:
getEnginein 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:
applyRemovalPolicyin interfaceIDatabaseCluster.Jsii$Default- Specified by:
applyRemovalPolicyin interfaceIResource- Specified by:
applyRemovalPolicyin interfaceIResource.Jsii$Default- Parameters:
policy- This parameter is required.
-
asSecretAttachmentTarget
Renders the target specifications.- Specified by:
asSecretAttachmentTargetin interfaceIDatabaseCluster.Jsii$Default- Specified by:
asSecretAttachmentTargetin interfaceISecretAttachmentTarget- Specified by:
asSecretAttachmentTargetin 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:
addProxyin interfaceIDatabaseCluster- Specified by:
addProxyin 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:
grantConnectin interfaceIDatabaseCluster- Specified by:
grantConnectin 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:
grantDataApiAccessin interfaceIDatabaseCluster- Specified by:
grantDataApiAccessin 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:
metricin interfaceIDatabaseCluster- Specified by:
metricin interfaceIDatabaseCluster.Jsii$Default- Parameters:
metricName- This parameter is required.props-
-
metric
Return the given named metric for this DBCluster.- Specified by:
metricin interfaceIDatabaseCluster- Parameters:
metricName- This parameter is required.
-
metricCPUUtilization
The percentage of CPU utilization.Average over 5 minutes
- Specified by:
metricCPUUtilizationin interfaceIDatabaseCluster- Specified by:
metricCPUUtilizationin interfaceIDatabaseCluster.Jsii$Default- Parameters:
props-
-
metricCPUUtilization
The percentage of CPU utilization.Average over 5 minutes
- Specified by:
metricCPUUtilizationin 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:
metricDatabaseConnectionsin interfaceIDatabaseCluster- Specified by:
metricDatabaseConnectionsin interfaceIDatabaseCluster.Jsii$Default- Parameters:
props-
-
metricDatabaseConnections
The number of database connections in use.Average over 5 minutes
- Specified by:
metricDatabaseConnectionsin interfaceIDatabaseCluster
-
metricDeadlocks
The average number of deadlocks in the database per second.Average over 5 minutes
- Specified by:
metricDeadlocksin interfaceIDatabaseCluster- Specified by:
metricDeadlocksin interfaceIDatabaseCluster.Jsii$Default- Parameters:
props-
-
metricDeadlocks
The average number of deadlocks in the database per second.Average over 5 minutes
- Specified by:
metricDeadlocksin interfaceIDatabaseCluster
-
metricEngineUptime
The amount of time that the instance has been running, in seconds.Average over 5 minutes
- Specified by:
metricEngineUptimein interfaceIDatabaseCluster- Specified by:
metricEngineUptimein interfaceIDatabaseCluster.Jsii$Default- Parameters:
props-
-
metricEngineUptime
The amount of time that the instance has been running, in seconds.Average over 5 minutes
- Specified by:
metricEngineUptimein interfaceIDatabaseCluster
-
metricFreeableMemory
The amount of available random access memory, in bytes.Average over 5 minutes
- Specified by:
metricFreeableMemoryin interfaceIDatabaseCluster- Specified by:
metricFreeableMemoryin interfaceIDatabaseCluster.Jsii$Default- Parameters:
props-
-
metricFreeableMemory
The amount of available random access memory, in bytes.Average over 5 minutes
- Specified by:
metricFreeableMemoryin 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:
metricFreeLocalStoragein interfaceIDatabaseCluster- Specified by:
metricFreeLocalStoragein interfaceIDatabaseCluster.Jsii$Default- Parameters:
props-
-
metricFreeLocalStorage
The amount of local storage available, in bytes.Average over 5 minutes
- Specified by:
metricFreeLocalStoragein 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:
metricNetworkReceiveThroughputin interfaceIDatabaseCluster- Specified by:
metricNetworkReceiveThroughputin 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:
metricNetworkReceiveThroughputin 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:
metricNetworkThroughputin interfaceIDatabaseCluster- Specified by:
metricNetworkThroughputin 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:
metricNetworkThroughputin 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:
metricNetworkTransmitThroughputin interfaceIDatabaseCluster- Specified by:
metricNetworkTransmitThroughputin 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:
metricNetworkTransmitThroughputin 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:
metricSnapshotStorageUsedin interfaceIDatabaseCluster- Specified by:
metricSnapshotStorageUsedin 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:
metricSnapshotStorageUsedin 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:
metricTotalBackupStorageBilledin interfaceIDatabaseCluster- Specified by:
metricTotalBackupStorageBilledin 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:
metricTotalBackupStorageBilledin 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:
metricVolumeBytesUsedin interfaceIDatabaseCluster- Specified by:
metricVolumeBytesUsedin interfaceIDatabaseCluster.Jsii$Default- Parameters:
props-
-
metricVolumeBytesUsed
The amount of storage used by your Aurora DB instance, in bytes.Average over 5 minutes
- Specified by:
metricVolumeBytesUsedin 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:
metricVolumeReadIOPsin interfaceIDatabaseCluster- Specified by:
metricVolumeReadIOPsin 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:
metricVolumeReadIOPsin 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:
metricVolumeWriteIOPsin interfaceIDatabaseCluster- Specified by:
metricVolumeWriteIOPsin 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:
metricVolumeWriteIOPsin interfaceIDatabaseCluster
-