Class DatabaseInstanceReadReplica

A read replica database instance.

Inheritance
object
Resource
DatabaseInstanceBase
DatabaseInstanceReadReplica
Inherited Members
Namespace: Amazon.CDK.AWS.RDS
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class DatabaseInstanceReadReplica : DatabaseInstanceBase, IDatabaseInstance, IResource, IConstruct, IDependable, IConnectable, ISecretAttachmentTarget
Syntax (vb)
Public Class DatabaseInstanceReadReplica Inherits DatabaseInstanceBase Implements IDatabaseInstance, IResource, IConstruct, IDependable, IConnectable, ISecretAttachmentTarget
Remarks

Resource: AWS::RDS::DBInstance

ExampleMetadata: infused

Examples
Vpc vpc;

             DatabaseInstance sourceInstance;

             new DatabaseInstanceFromSnapshot(this, "Instance", new DatabaseInstanceFromSnapshotProps {
                 SnapshotIdentifier = "my-snapshot",
                 Engine = DatabaseInstanceEngine.Postgres(new PostgresInstanceEngineProps { Version = PostgresEngineVersion.VER_16_3 }),
                 // optional, defaults to m5.large
                 InstanceType = InstanceType.Of(InstanceClass.BURSTABLE2, InstanceSize.LARGE),
                 Vpc = vpc
             });
             new DatabaseInstanceReadReplica(this, "ReadReplica", new DatabaseInstanceReadReplicaProps {
                 SourceDatabaseInstance = sourceInstance,
                 InstanceType = InstanceType.Of(InstanceClass.BURSTABLE2, InstanceSize.LARGE),
                 Vpc = vpc
             });

Synopsis

Constructors

DatabaseInstanceReadReplica(Construct, string, IDatabaseInstanceReadReplicaProps)

A read replica database instance.

Properties

CloudwatchLogGroups

The log group is created when cloudwatchLogsExports is set.
Connections

Access to network connections.
DbInstanceEndpointAddress

The instance endpoint address.
DbInstanceEndpointPort

The instance endpoint port.
EnableIamAuthentication

A read replica database instance.
Engine

The engine of this database Instance.
InstanceEndpoint

The instance endpoint.
InstanceIdentifier

The instance identifier.
InstanceResourceId

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

A read replica database instance.
NewCfnProps

A read replica database instance.
PROPERTY_INJECTION_ID

Uniquely identifies this class.
Vpc

The VPC where this database instance is deployed.
VpcPlacement

A read replica database instance.

Methods

SetLogRetention()

A read replica database instance.

Constructors

DatabaseInstanceReadReplica(Construct, string, IDatabaseInstanceReadReplicaProps)

A read replica database instance.

public DatabaseInstanceReadReplica(Construct scope, string id, IDatabaseInstanceReadReplicaProps props)
Parameters
scope Construct
id string
props IDatabaseInstanceReadReplicaProps
Remarks

Resource: AWS::RDS::DBInstance

ExampleMetadata: infused

Examples
Vpc vpc;

             DatabaseInstance sourceInstance;

             new DatabaseInstanceFromSnapshot(this, "Instance", new DatabaseInstanceFromSnapshotProps {
                 SnapshotIdentifier = "my-snapshot",
                 Engine = DatabaseInstanceEngine.Postgres(new PostgresInstanceEngineProps { Version = PostgresEngineVersion.VER_16_3 }),
                 // optional, defaults to m5.large
                 InstanceType = InstanceType.Of(InstanceClass.BURSTABLE2, InstanceSize.LARGE),
                 Vpc = vpc
             });
             new DatabaseInstanceReadReplica(this, "ReadReplica", new DatabaseInstanceReadReplicaProps {
                 SourceDatabaseInstance = sourceInstance,
                 InstanceType = InstanceType.Of(InstanceClass.BURSTABLE2, InstanceSize.LARGE),
                 Vpc = vpc
             });

Properties

CloudwatchLogGroups

The log group is created when cloudwatchLogsExports is set.

public virtual IDictionary<string, ILogGroup> CloudwatchLogGroups { get; }
Property Value

IDictionary<string, ILogGroup>

Remarks

Each export value will create a separate log group.

Connections

Access to network connections.

public override Connections_ Connections { get; }
Property Value

Connections_

Overrides
Remarks

Resource: AWS::RDS::DBInstance

ExampleMetadata: infused

DbInstanceEndpointAddress

The instance endpoint address.

public override string DbInstanceEndpointAddress { get; }
Property Value

string

Overrides
Remarks

Resource: AWS::RDS::DBInstance

ExampleMetadata: infused

DbInstanceEndpointPort

The instance endpoint port.

public override string DbInstanceEndpointPort { get; }
Property Value

string

Overrides
Remarks

Resource: AWS::RDS::DBInstance

ExampleMetadata: infused

EnableIamAuthentication

A read replica database instance.

protected override bool? EnableIamAuthentication { get; set; }
Property Value

bool?

Overrides
Remarks

Resource: AWS::RDS::DBInstance

ExampleMetadata: infused

Engine

The engine of this database Instance.

public override IInstanceEngine? Engine { get; }
Property Value

IInstanceEngine

Overrides
Remarks

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

InstanceEndpoint

The instance endpoint.

public override Endpoint InstanceEndpoint { get; }
Property Value

Endpoint

Overrides
Remarks

Resource: AWS::RDS::DBInstance

ExampleMetadata: infused

InstanceIdentifier

The instance identifier.

public override string InstanceIdentifier { get; }
Property Value

string

Overrides
Remarks

Resource: AWS::RDS::DBInstance

ExampleMetadata: infused

InstanceResourceId

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

public override string? InstanceResourceId { get; }
Property Value

string

Overrides
Remarks

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

See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#aws-resource-rds-dbinstance-return-values

InstanceType

A read replica database instance.

protected virtual InstanceType InstanceType { get; }
Property Value

InstanceType

Remarks

Resource: AWS::RDS::DBInstance

ExampleMetadata: infused

Examples
Vpc vpc;

             DatabaseInstance sourceInstance;

             new DatabaseInstanceFromSnapshot(this, "Instance", new DatabaseInstanceFromSnapshotProps {
                 SnapshotIdentifier = "my-snapshot",
                 Engine = DatabaseInstanceEngine.Postgres(new PostgresInstanceEngineProps { Version = PostgresEngineVersion.VER_16_3 }),
                 // optional, defaults to m5.large
                 InstanceType = InstanceType.Of(InstanceClass.BURSTABLE2, InstanceSize.LARGE),
                 Vpc = vpc
             });
             new DatabaseInstanceReadReplica(this, "ReadReplica", new DatabaseInstanceReadReplicaProps {
                 SourceDatabaseInstance = sourceInstance,
                 InstanceType = InstanceType.Of(InstanceClass.BURSTABLE2, InstanceSize.LARGE),
                 Vpc = vpc
             });

NewCfnProps

A read replica database instance.

protected virtual ICfnDBInstanceProps NewCfnProps { get; }
Property Value

ICfnDBInstanceProps

Remarks

Resource: AWS::RDS::DBInstance

ExampleMetadata: infused

Examples
Vpc vpc;

             DatabaseInstance sourceInstance;

             new DatabaseInstanceFromSnapshot(this, "Instance", new DatabaseInstanceFromSnapshotProps {
                 SnapshotIdentifier = "my-snapshot",
                 Engine = DatabaseInstanceEngine.Postgres(new PostgresInstanceEngineProps { Version = PostgresEngineVersion.VER_16_3 }),
                 // optional, defaults to m5.large
                 InstanceType = InstanceType.Of(InstanceClass.BURSTABLE2, InstanceSize.LARGE),
                 Vpc = vpc
             });
             new DatabaseInstanceReadReplica(this, "ReadReplica", new DatabaseInstanceReadReplicaProps {
                 SourceDatabaseInstance = sourceInstance,
                 InstanceType = InstanceType.Of(InstanceClass.BURSTABLE2, InstanceSize.LARGE),
                 Vpc = vpc
             });

PROPERTY_INJECTION_ID

Uniquely identifies this class.

public static string PROPERTY_INJECTION_ID { get; }
Property Value

string

Remarks

Resource: AWS::RDS::DBInstance

ExampleMetadata: infused

Vpc

The VPC where this database instance is deployed.

public virtual IVpc Vpc { get; }
Property Value

IVpc

Remarks

Resource: AWS::RDS::DBInstance

ExampleMetadata: infused

VpcPlacement

A read replica database instance.

protected virtual ISubnetSelection? VpcPlacement { get; }
Property Value

ISubnetSelection

Remarks

Resource: AWS::RDS::DBInstance

ExampleMetadata: infused

Examples
Vpc vpc;

             DatabaseInstance sourceInstance;

             new DatabaseInstanceFromSnapshot(this, "Instance", new DatabaseInstanceFromSnapshotProps {
                 SnapshotIdentifier = "my-snapshot",
                 Engine = DatabaseInstanceEngine.Postgres(new PostgresInstanceEngineProps { Version = PostgresEngineVersion.VER_16_3 }),
                 // optional, defaults to m5.large
                 InstanceType = InstanceType.Of(InstanceClass.BURSTABLE2, InstanceSize.LARGE),
                 Vpc = vpc
             });
             new DatabaseInstanceReadReplica(this, "ReadReplica", new DatabaseInstanceReadReplicaProps {
                 SourceDatabaseInstance = sourceInstance,
                 InstanceType = InstanceType.Of(InstanceClass.BURSTABLE2, InstanceSize.LARGE),
                 Vpc = vpc
             });

Methods

SetLogRetention()

A read replica database instance.

protected virtual void SetLogRetention()
Remarks

Resource: AWS::RDS::DBInstance

ExampleMetadata: infused

Examples
Vpc vpc;

             DatabaseInstance sourceInstance;

             new DatabaseInstanceFromSnapshot(this, "Instance", new DatabaseInstanceFromSnapshotProps {
                 SnapshotIdentifier = "my-snapshot",
                 Engine = DatabaseInstanceEngine.Postgres(new PostgresInstanceEngineProps { Version = PostgresEngineVersion.VER_16_3 }),
                 // optional, defaults to m5.large
                 InstanceType = InstanceType.Of(InstanceClass.BURSTABLE2, InstanceSize.LARGE),
                 Vpc = vpc
             });
             new DatabaseInstanceReadReplica(this, "ReadReplica", new DatabaseInstanceReadReplicaProps {
                 SourceDatabaseInstance = sourceInstance,
                 InstanceType = InstanceType.Of(InstanceClass.BURSTABLE2, InstanceSize.LARGE),
                 Vpc = vpc
             });

Implements

Constructs.IConstruct
Constructs.IDependable