Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Replica

A DB System read replica.

Properties

Optional availabilityDomain

availabilityDomain: undefined | string

The name of the Availability Domain the read replica is located in.

compartmentId

compartmentId: string

The OCID of the compartment that contains the read replica.

Optional configurationId

configurationId: undefined | string

The OCID of the Configuration currently in use by the read replica.

dbSystemId

dbSystemId: string

The OCID of the DB System the read replica is associated with.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {@code {"foo-namespace": {"bar-key": "value"}}}

Optional description

description: undefined | string

User provided description of the read replica.

displayName

displayName: string

The user-friendly name for the read replica. It does not have to be unique.

Optional faultDomain

faultDomain: undefined | string

The name of the Fault Domain the read replica is located in.

Optional freeformTags

freeformTags: undefined | object

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {@code {"bar-key": "value"}}

id

id: string

The OCID of the read replica.

ipAddress

ipAddress: string

The IP address the read replica is configured to listen on.

Optional isDeleteProtected

isDeleteProtected: undefined | false | true

Specifies whether the read replica can be deleted. Set to true to prevent deletion, false (default) to allow. Note that if a read replica is delete protected it also prevents the entire DB System from being deleted. If the DB System is delete protected, read replicas can still be deleted individually if they are not delete protected themselves.

Optional lifecycleDetails

lifecycleDetails: undefined | string

A message describing the state of the read replica.

lifecycleState

lifecycleState: LifecycleState

The state of the read replica.

mysqlVersion

mysqlVersion: string

The MySQL version currently in use by the read replica.

port

port: number

The port the read replica is configured to listen on. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

portX

portX: number

The TCP network port on which X Plugin listens for connections. This is the X Plugin equivalent of port. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional replicaOverrides

replicaOverrides: model.ReplicaOverrides

Optional secureConnections

secureConnections: model.SecureConnectionDetails

Optional shapeName

shapeName: undefined | string

The shape currently in use by the read replica. The shape determines the resources allocated: CPU cores and memory for VM shapes, CPU cores, memory and storage for non-VM (bare metal) shapes. To get a list of shapes, use the {@link #listShapes(ListShapesRequest) listShapes} operation.

timeCreated

timeCreated: Date

The date and time the read replica was created, as described by RFC 3339.

Optional timeUpdated

timeUpdated: Date

The time the read replica was last updated, as described by RFC 3339.

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: Replica): object

getJsonObj