Class DatabaseInstanceBase

A new or imported database instance.

Inheritance

object

Resource

DatabaseInstanceBase

DatabaseInstance

DatabaseInstanceFromSnapshot

DatabaseInstanceReadReplica

Implements

IDatabaseInstance

IResource

IConstruct

IDependable

IConnectable

ISecretAttachmentTarget

Inherited Members

Resource.IsOwnedResource(IConstruct)

Resource.IsResource(IConstruct)

Resource.ApplyRemovalPolicy(RemovalPolicy)

Resource.GeneratePhysicalName()

Resource.GetResourceArnAttribute(string, IArnComponents)

Resource.GetResourceNameAttribute(string)

Resource.Env

Resource.PhysicalName

Resource.Stack

Namespace: Amazon.CDK.AWS.RDS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public abstract class DatabaseInstanceBase : Resource, IDatabaseInstance, IResource, IConstruct, IDependable, IConnectable, ISecretAttachmentTarget

Syntax (vb)

Public MustInherit Class DatabaseInstanceBase Inherits Resource Implements IDatabaseInstance, IResource, IConstruct, IDependable, IConnectable, ISecretAttachmentTarget

Remarks

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK.AWS.EC2;
            using Amazon.CDK.AWS.RDS;

            IInstanceEngine instanceEngine;
            SecurityGroup securityGroup;

            var databaseInstanceBase = DatabaseInstanceBase.FromDatabaseInstanceAttributes(this, "MyDatabaseInstanceBase", new DatabaseInstanceAttributes {
                InstanceEndpointAddress = "instanceEndpointAddress",
                InstanceIdentifier = "instanceIdentifier",
                Port = 123,
                SecurityGroups = new [] { securityGroup },

                // the properties below are optional
                Engine = instanceEngine,
                InstanceResourceId = "instanceResourceId"
            });

Synopsis

Constructors

DatabaseInstanceBase(Construct, string, IResourceProps?)

A new or imported database instance.

Properties

Connections	Access to network connections.
DbInstanceEndpointAddress	The instance endpoint address.
DbInstanceEndpointPort	The instance endpoint port.
EnableIamAuthentication	A new or imported database instance.
Engine	The engine of this database Instance.
InstanceArn	The instance arn.
InstanceEndpoint	The instance endpoint.
InstanceIdentifier	The instance identifier.
InstanceResourceId	The AWS Region-unique, immutable identifier for the DB instance.

Methods

AddProxy(string, IDatabaseProxyOptions)	Add a new db proxy to this instance.
AsSecretAttachmentTarget()	Renders the secret attachment target specifications.
FromDatabaseInstanceAttributes(Construct, string, IDatabaseInstanceAttributes)	Import an existing database instance.
FromLookup(Construct, string, IDatabaseInstanceLookupOptions)	Lookup an existing DatabaseInstance using instanceIdentifier.
GrantConnect(IGrantable, string?)	Grant the given identity connection access to the database.
Metric(string, IMetricOptions?)	Return the given named metric for this DBInstance.
MetricCPUUtilization(IMetricOptions?)	The percentage of CPU utilization.
MetricDatabaseConnections(IMetricOptions?)	The number of database connections in use.
MetricFreeStorageSpace(IMetricOptions?)	The amount of available storage space.
MetricFreeableMemory(IMetricOptions?)	The amount of available random access memory.
MetricReadIOPS(IMetricOptions?)	The average number of disk write I/O operations per second.
MetricWriteIOPS(IMetricOptions?)	The average number of disk read I/O operations per second.
OnEvent(string, IOnEventOptions?)	Defines a CloudWatch event rule which triggers for instance events.

Constructors

DatabaseInstanceBase(Construct, string, IResourceProps?)

A new or imported database instance.

protected DatabaseInstanceBase(Construct scope, string id, IResourceProps? props = null)

Parameters

scope Construct

id string

props IResourceProps

Remarks

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK.AWS.EC2;
            using Amazon.CDK.AWS.RDS;

            IInstanceEngine instanceEngine;
            SecurityGroup securityGroup;

            var databaseInstanceBase = DatabaseInstanceBase.FromDatabaseInstanceAttributes(this, "MyDatabaseInstanceBase", new DatabaseInstanceAttributes {
                InstanceEndpointAddress = "instanceEndpointAddress",
                InstanceIdentifier = "instanceIdentifier",
                Port = 123,
                SecurityGroups = new [] { securityGroup },

                // the properties below are optional
                Engine = instanceEngine,
                InstanceResourceId = "instanceResourceId"
            });

Properties

Connections

Access to network connections.

public abstract Connections_ Connections { get; }

Property Value

Connections_

Remarks

ExampleMetadata: fixture=_generated

DbInstanceEndpointAddress

The instance endpoint address.

public abstract string DbInstanceEndpointAddress { get; }

Property Value

string

Remarks

ExampleMetadata: fixture=_generated

DbInstanceEndpointPort

The instance endpoint port.

public abstract string DbInstanceEndpointPort { get; }

Property Value

string

Remarks

ExampleMetadata: fixture=_generated

EnableIamAuthentication

A new or imported database instance.

protected abstract bool? EnableIamAuthentication { get; set; }

Property Value

bool?

Remarks

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK.AWS.EC2;
            using Amazon.CDK.AWS.RDS;

            IInstanceEngine instanceEngine;
            SecurityGroup securityGroup;

            var databaseInstanceBase = DatabaseInstanceBase.FromDatabaseInstanceAttributes(this, "MyDatabaseInstanceBase", new DatabaseInstanceAttributes {
                InstanceEndpointAddress = "instanceEndpointAddress",
                InstanceIdentifier = "instanceIdentifier",
                Port = 123,
                SecurityGroups = new [] { securityGroup },

                // the properties below are optional
                Engine = instanceEngine,
                InstanceResourceId = "instanceResourceId"
            });

Engine

The engine of this database Instance.

public abstract IInstanceEngine? Engine { get; }

Property Value

IInstanceEngine

Remarks

May be not known for imported Instances if it wasn't provided explicitly, or for read replicas.

InstanceArn

The instance arn.

public virtual string InstanceArn { get; }

Property Value

string

Remarks

ExampleMetadata: fixture=_generated

InstanceEndpoint

The instance endpoint.

public abstract Endpoint InstanceEndpoint { get; }

Property Value

Endpoint

Remarks

ExampleMetadata: fixture=_generated

InstanceIdentifier

The instance identifier.

public abstract string InstanceIdentifier { get; }

Property Value

string

Remarks

ExampleMetadata: fixture=_generated

InstanceResourceId

The AWS Region-unique, immutable identifier for the DB instance.

public abstract string? InstanceResourceId { get; }

Property Value

string

Remarks

This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed.

Methods

AddProxy(string, IDatabaseProxyOptions)

Add a new db proxy to this instance.

public virtual DatabaseProxy AddProxy(string id, IDatabaseProxyOptions options)

Parameters

id string

options IDatabaseProxyOptions

Returns

DatabaseProxy

Remarks

ExampleMetadata: fixture=_generated

AsSecretAttachmentTarget()

Renders the secret attachment target specifications.

public virtual ISecretAttachmentTargetProps AsSecretAttachmentTarget()

Returns

ISecretAttachmentTargetProps

Remarks

ExampleMetadata: fixture=_generated

FromDatabaseInstanceAttributes(Construct, string, IDatabaseInstanceAttributes)

Import an existing database instance.

public static IDatabaseInstance FromDatabaseInstanceAttributes(Construct scope, string id, IDatabaseInstanceAttributes attrs)

Parameters

scope Construct

id string

attrs IDatabaseInstanceAttributes

Returns

IDatabaseInstance

Remarks

ExampleMetadata: fixture=_generated

FromLookup(Construct, string, IDatabaseInstanceLookupOptions)

Lookup an existing DatabaseInstance using instanceIdentifier.

public static IDatabaseInstance FromLookup(Construct scope, string id, IDatabaseInstanceLookupOptions options)

Parameters

scope Construct

id string

options IDatabaseInstanceLookupOptions

Returns

IDatabaseInstance

Remarks

ExampleMetadata: fixture=_generated

GrantConnect(IGrantable, string?)

Grant the given identity connection access to the database.

public virtual Grant GrantConnect(IGrantable grantee, string? dbUser = null)

Parameters

grantee IGrantable

dbUser string

Returns

Grant

Remarks

ExampleMetadata: fixture=_generated

Metric(string, IMetricOptions?)

Return the given named metric for this DBInstance.

public virtual Metric Metric(string metricName, IMetricOptions? props = null)

Parameters

metricName string

props IMetricOptions

Returns

Metric

Remarks

ExampleMetadata: fixture=_generated

MetricCPUUtilization(IMetricOptions?)

The percentage of CPU utilization.

public virtual Metric MetricCPUUtilization(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Average over 5 minutes

MetricDatabaseConnections(IMetricOptions?)

The number of database connections in use.

public virtual Metric MetricDatabaseConnections(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Average over 5 minutes

MetricFreeStorageSpace(IMetricOptions?)

The amount of available storage space.

public virtual Metric MetricFreeStorageSpace(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Average over 5 minutes

MetricFreeableMemory(IMetricOptions?)

The amount of available random access memory.

public virtual Metric MetricFreeableMemory(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Average over 5 minutes

MetricReadIOPS(IMetricOptions?)

The average number of disk write I/O operations per second.

public virtual Metric MetricReadIOPS(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Average over 5 minutes

MetricWriteIOPS(IMetricOptions?)

The average number of disk read I/O operations per second.

public virtual Metric MetricWriteIOPS(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Average over 5 minutes

OnEvent(string, IOnEventOptions?)

Defines a CloudWatch event rule which triggers for instance events.

public virtual Rule OnEvent(string id, IOnEventOptions? options = null)

Parameters

id string

options IOnEventOptions

Returns

Rule

Remarks

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

Implements

IDatabaseInstance

IResource

Constructs.IConstruct

Constructs.IDependable

IConnectable

ISecretAttachmentTarget