Package software.amazon.awscdk.services.rds

Interface IDatabaseCluster.Jsii$Default

All Superinterfaces:
IConnectable, IConnectable.Jsii$Default, software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, IDatabaseCluster, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IResource, IResource.Jsii$Default, ISecretAttachmentTarget, ISecretAttachmentTarget.Jsii$Default, software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
IDatabaseCluster.Jsii$Proxy
Enclosing interface:
IDatabaseCluster
@Internal public static interface IDatabaseCluster.Jsii$Default extends IDatabaseCluster, IResource.Jsii$Default, IConnectable.Jsii$Default, ISecretAttachmentTarget.Jsii$Default
Internal default implementation for IDatabaseCluster.

  • Method Details

    • getNode

      @Stability(Stable) @NotNull default software.constructs.Node getNode()
      The tree node.
      Specified by:
      getNode in interface software.constructs.IConstruct
      Specified by:
      getNode in interface software.constructs.IConstruct.Jsii$Default
      Specified by:
      getNode in interface IResource.Jsii$Default

    • getEnv

      @Stability(Stable) @NotNull default ResourceEnvironment 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 interface IResource
      Specified by:
      getEnv in interface IResource.Jsii$Default

    • getStack

      @Stability(Stable) @NotNull default Stack getStack()
      The stack in which this resource is defined.
      Specified by:
      getStack in interface IResource
      Specified by:
      getStack in interface IResource.Jsii$Default

    • getConnections

      @Stability(Stable) @NotNull default Connections getConnections()
      The network connections associated with this resource.
      Specified by:
      getConnections in interface IConnectable
      Specified by:
      getConnections in interface IConnectable.Jsii$Default

    • getClusterArn

      @Stability(Stable) @NotNull default String getClusterArn()
      The ARN of the database cluster.
      Specified by:
      getClusterArn in interface IDatabaseCluster

    • getClusterEndpoint

      @Stability(Stable) @NotNull default Endpoint getClusterEndpoint()
      The endpoint to use for read/write operations.
      Specified by:
      getClusterEndpoint in interface IDatabaseCluster

    • getClusterIdentifier

      @Stability(Stable) @NotNull default String getClusterIdentifier()
      Identifier of the cluster.
      Specified by:
      getClusterIdentifier in interface IDatabaseCluster

    • getClusterReadEndpoint

      @Stability(Stable) @NotNull default Endpoint getClusterReadEndpoint()
      Endpoint to use for load-balanced read-only operations.
      Specified by:
      getClusterReadEndpoint in interface IDatabaseCluster

    • getClusterResourceIdentifier

      @Stability(Stable) @NotNull default String 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 interface IDatabaseCluster

    • getInstanceEndpoints

      @Stability(Stable) @NotNull default List<Endpoint> getInstanceEndpoints()
      Endpoints which address each individual replica.
      Specified by:
      getInstanceEndpoints in interface IDatabaseCluster

    • getInstanceIdentifiers

      @Stability(Stable) @NotNull default List<String> getInstanceIdentifiers()
      Identifiers of the replicas.
      Specified by:
      getInstanceIdentifiers in interface IDatabaseCluster

    • getEngine

      @Stability(Stable) @Nullable default IClusterEngine getEngine()
      The engine of this Cluster.

      May be not known for imported Clusters if it wasn't provided explicitly.

      Specified by:
      getEngine in interface IDatabaseCluster

    • applyRemovalPolicy

      @Stability(Stable) default void applyRemovalPolicy(@NotNull RemovalPolicy policy)
      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 interface IResource
      Specified by:
      applyRemovalPolicy in interface IResource.Jsii$Default
      Parameters:
      policy - This parameter is required.

    • asSecretAttachmentTarget

      @Stability(Stable) @NotNull default SecretAttachmentTargetProps asSecretAttachmentTarget()
      Renders the target specifications.
      Specified by:
      asSecretAttachmentTarget in interface ISecretAttachmentTarget
      Specified by:
      asSecretAttachmentTarget in interface ISecretAttachmentTarget.Jsii$Default

    • addProxy

      @Stability(Stable) @NotNull default DatabaseProxy addProxy(@NotNull String id, @NotNull DatabaseProxyOptions options)
      Add a new db proxy to this cluster.

      Specified by:
      addProxy in interface IDatabaseCluster
      Parameters:
      id - This parameter is required.
      options - This parameter is required.

    • grantConnect

      @Stability(Stable) @NotNull default Grant grantConnect(@NotNull IGrantable grantee, @NotNull String dbUser)
      Grant the given identity connection access to the Cluster.

      Specified by:
      grantConnect in interface IDatabaseCluster
      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

      @Stability(Stable) @NotNull default Grant grantDataApiAccess(@NotNull IGrantable grantee)
      Grant the given identity to access to the Data API.

      Specified by:
      grantDataApiAccess in interface IDatabaseCluster
      Parameters:
      grantee - The principal to grant access to. This parameter is required.

    • metric

      @Stability(Stable) @NotNull default Metric metric(@NotNull String metricName, @Nullable MetricOptions props)
      Return the given named metric for this DBCluster.

      Specified by:
      metric in interface IDatabaseCluster
      Parameters:
      metricName - This parameter is required.
      props -

    • metricCPUUtilization

      @Stability(Stable) @NotNull default Metric metricCPUUtilization(@Nullable MetricOptions props)
      The percentage of CPU utilization.

      Average over 5 minutes

      Specified by:
      metricCPUUtilization in interface IDatabaseCluster
      Parameters:
      props -

    • metricDatabaseConnections

      @Stability(Stable) @NotNull default Metric metricDatabaseConnections(@Nullable MetricOptions props)
      The number of database connections in use.

      Average over 5 minutes

      Specified by:
      metricDatabaseConnections in interface IDatabaseCluster
      Parameters:
      props -

    • metricDeadlocks

      @Stability(Stable) @NotNull default Metric metricDeadlocks(@Nullable MetricOptions props)
      The average number of deadlocks in the database per second.

      Average over 5 minutes

      Specified by:
      metricDeadlocks in interface IDatabaseCluster
      Parameters:
      props -

    • metricEngineUptime

      @Stability(Stable) @NotNull default Metric metricEngineUptime(@Nullable MetricOptions props)
      The amount of time that the instance has been running, in seconds.

      Average over 5 minutes

      Specified by:
      metricEngineUptime in interface IDatabaseCluster
      Parameters:
      props -

    • metricFreeableMemory

      @Stability(Stable) @NotNull default Metric metricFreeableMemory(@Nullable MetricOptions props)
      The amount of available random access memory, in bytes.

      Average over 5 minutes

      Specified by:
      metricFreeableMemory in interface IDatabaseCluster
      Parameters:
      props -

    • metricFreeLocalStorage

      @Stability(Stable) @NotNull default Metric metricFreeLocalStorage(@Nullable MetricOptions props)
      The amount of local storage available, in bytes.

      Average over 5 minutes

      Specified by:
      metricFreeLocalStorage in interface IDatabaseCluster
      Parameters:
      props -

    • metricNetworkReceiveThroughput

      @Stability(Stable) @NotNull default 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 interface IDatabaseCluster
      Parameters:
      props -

    • metricNetworkThroughput

      @Stability(Stable) @NotNull default 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 interface IDatabaseCluster
      Parameters:
      props -

    • metricNetworkTransmitThroughput

      @Stability(Stable) @NotNull default 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 interface IDatabaseCluster
      Parameters:
      props -

    • metricSnapshotStorageUsed

      @Stability(Stable) @NotNull default 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 interface IDatabaseCluster
      Parameters:
      props -

    • metricTotalBackupStorageBilled

      @Stability(Stable) @NotNull default 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 interface IDatabaseCluster
      Parameters:
      props -

    • metricVolumeBytesUsed

      @Stability(Stable) @NotNull default 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 interface IDatabaseCluster
      Parameters:
      props -

    • metricVolumeReadIOPs

      @Stability(Stable) @NotNull default Metric metricVolumeReadIOPs(@Nullable MetricOptions props)
      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 interface IDatabaseCluster
      Parameters:
      props -

    • metricVolumeWriteIOPs

      @Stability(Stable) @NotNull default 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 interface IDatabaseCluster
      Parameters:
      props -