Class DatabaseInstanceReadReplica

A read replica database instance.

Inheritance
System.Object
Construct
Resource
DatabaseInstanceBase
DatabaseInstanceReadReplica
Inherited Members
Namespace: Amazon.CDK.AWS.RDS
Assembly: Amazon.CDK.AWS.RDS.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_12_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(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
DatabaseInstanceReadReplica(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps
DatabaseInstanceReadReplica(Construct, String, IDatabaseInstanceReadReplicaProps)

Properties

Connections

Access to network connections.
DbInstanceEndpointAddress

The instance endpoint address.
DbInstanceEndpointPort

The instance endpoint port.
EnableIamAuthentication
Engine

The engine of this database Instance.
InstanceEndpoint

The instance endpoint.
InstanceIdentifier

The instance identifier.
InstanceType
NewCfnProps
Vpc

The VPC where this database instance is deployed.
VpcPlacement

Methods

SetLogRetention()

Constructors

DatabaseInstanceReadReplica(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected DatabaseInstanceReadReplica(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

DatabaseInstanceReadReplica(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected DatabaseInstanceReadReplica(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

DatabaseInstanceReadReplica(Construct, String, IDatabaseInstanceReadReplicaProps)

public DatabaseInstanceReadReplica(Construct scope, string id, IDatabaseInstanceReadReplicaProps props)
Parameters
scope Constructs.Construct
id System.String
props IDatabaseInstanceReadReplicaProps

Properties

Connections

Access to network connections.

public override Connections_ Connections { get; }
Property Value

Connections_

Overrides

DbInstanceEndpointAddress

The instance endpoint address.

public override string DbInstanceEndpointAddress { get; }
Property Value

System.String

Overrides

DbInstanceEndpointPort

The instance endpoint port.

public override string DbInstanceEndpointPort { get; }
Property Value

System.String

Overrides

EnableIamAuthentication

protected override Nullable<bool> EnableIamAuthentication { get; set; }
Property Value

System.Nullable<System.Boolean>

Overrides

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

InstanceIdentifier

The instance identifier.

public override string InstanceIdentifier { get; }
Property Value

System.String

Overrides

InstanceType

protected virtual InstanceType InstanceType { get; }
Property Value

InstanceType

NewCfnProps

protected virtual ICfnDBInstanceProps NewCfnProps { get; }
Property Value

ICfnDBInstanceProps

Vpc

The VPC where this database instance is deployed.

public virtual IVpc Vpc { get; }
Property Value

IVpc

VpcPlacement

protected virtual ISubnetSelection VpcPlacement { get; }
Property Value

ISubnetSelection

Methods

SetLogRetention()

protected virtual void SetLogRetention()

Implements

Constructs.IConstruct