Package software.amazon.awscdk.services.rds

Interface IDatabaseInstance.Jsii$Default

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

  • 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

    • getDbInstanceEndpointAddress

      @Stability(Stable) @NotNull default String getDbInstanceEndpointAddress()
      The instance endpoint address.
      Specified by:
      getDbInstanceEndpointAddress in interface IDatabaseInstance

    • getDbInstanceEndpointPort

      @Stability(Stable) @NotNull default String getDbInstanceEndpointPort()
      The instance endpoint port.
      Specified by:
      getDbInstanceEndpointPort in interface IDatabaseInstance

    • getInstanceArn

      @Stability(Stable) @NotNull default String getInstanceArn()
      The instance arn.
      Specified by:
      getInstanceArn in interface IDatabaseInstance

    • getInstanceEndpoint

      @Stability(Stable) @NotNull default Endpoint getInstanceEndpoint()
      The instance endpoint.
      Specified by:
      getInstanceEndpoint in interface IDatabaseInstance

    • getInstanceIdentifier

      @Stability(Stable) @NotNull default String getInstanceIdentifier()
      The instance identifier.
      Specified by:
      getInstanceIdentifier in interface IDatabaseInstance

    • getEngine

      @Stability(Stable) @Nullable default IInstanceEngine 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 interface IDatabaseInstance

    • getInstanceResourceId

      @Stability(Stable) @Nullable default String 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 interface IDatabaseInstance
      See Also:

    • 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 instance.

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

    • grantConnect

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

      Specified by:
      grantConnect in interface IDatabaseInstance
      Parameters:
      grantee - the Principal to grant the permissions to. This parameter is required.
      dbUser - the name of the database user to allow connecting as to the db instance.

    • metric

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

      Specified by:
      metric in interface IDatabaseInstance
      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 IDatabaseInstance
      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 IDatabaseInstance
      Parameters:
      props -

    • metricFreeableMemory

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

      Average over 5 minutes

      Specified by:
      metricFreeableMemory in interface IDatabaseInstance
      Parameters:
      props -

    • metricFreeStorageSpace

      @Stability(Stable) @NotNull default Metric metricFreeStorageSpace(@Nullable MetricOptions props)
      The amount of available storage space.

      Average over 5 minutes

      Specified by:
      metricFreeStorageSpace in interface IDatabaseInstance
      Parameters:
      props -

    • metricReadIOPS

      @Stability(Stable) @NotNull default Metric metricReadIOPS(@Nullable MetricOptions props)
      The average number of disk write I/O operations per second.

      Average over 5 minutes

      Specified by:
      metricReadIOPS in interface IDatabaseInstance
      Parameters:
      props -

    • metricWriteIOPS

      @Stability(Stable) @NotNull default Metric metricWriteIOPS(@Nullable MetricOptions props)
      The average number of disk read I/O operations per second.

      Average over 5 minutes

      Specified by:
      metricWriteIOPS in interface IDatabaseInstance
      Parameters:
      props -

    • onEvent

      @Stability(Stable) @NotNull default Rule onEvent(@NotNull String id, @Nullable OnEventOptions options)
      Defines a CloudWatch event rule which triggers for instance events.

      Use rule.addEventPattern(pattern) to specify a filter.

      Specified by:
      onEvent in interface IDatabaseInstance
      Parameters:
      id - This parameter is required.
      options -