Interface Instance

interface Instance {
    backupSameRegion: boolean;
    backupSchedule?: RDB.v1.BackupSchedule;
    createdAt?: Date;
    encryption?: EncryptionAtRest;
    endpoint?: RDB.v1.Endpoint;
    endpoints: RDB.v1.Endpoint[];
    engine: string;
    id: string;
    initSettings: RDB.v1.InstanceSetting[];
    isHaCluster: boolean;
    logsPolicy?: RDB.v1.LogsPolicy;
    maintenances: RDB.v1.Maintenance[];
    name: string;
    nodeType: string;
    organizationId: string;
    projectId: string;
    readReplicas: RDB.v1.ReadReplica[];
    region: Region;
    settings: RDB.v1.InstanceSetting[];
    status: RDB.v1.InstanceStatus;
    tags: string[];
    upgradableVersion: RDB.v1.UpgradableVersion[];
    volume?: RDB.v1.Volume;
}

Properties

backupSameRegion backupSchedule? createdAt? encryption? endpoint? endpoints engine id initSettings isHaCluster logsPolicy? maintenances name nodeType organizationId projectId readReplicas region settings status tags upgradableVersion volume?

Properties

backupSameRegion

backupSameRegion: boolean

Store logical backups in the same region as the Database Instance.

OptionalbackupSchedule

backupSchedule?: RDB.v1.BackupSchedule

Backup schedule of the Database Instance.

OptionalcreatedAt

createdAt?: Date

Creation date (must follow the ISO 8601 format).

Optionalencryption

encryption?: EncryptionAtRest

Encryption at rest settings for your Database Instance.

Optionalendpoint

endpoint?: RDB.v1.Endpoint

Deprecated

Endpoint of the Database Instance.

endpoints

endpoints: RDB.v1.Endpoint[]

List of Database Instance endpoints.

engine

engine: string

Database engine of the database (PostgreSQL, MySQL, ...).

id

id: string

UUID of the Database Instance.

initSettings

initSettings: RDB.v1.InstanceSetting[]

List of engine settings to be set at database initialization.

isHaCluster

isHaCluster: boolean

Defines whether or not High-Availability is enabled.

OptionallogsPolicy

logsPolicy?: RDB.v1.LogsPolicy

Logs policy of the Database Instance.

maintenances

maintenances: RDB.v1.Maintenance[]

List of Database Instance maintenance events.

name

name: string

Name of the Database Instance.

nodeType

nodeType: string

Node type of the Database Instance.

organizationId

organizationId: string

Organization ID the Database Instance belongs to.

projectId

projectId: string

Project ID the Database Instance belongs to.

readReplicas

readReplicas: RDB.v1.ReadReplica[]

Read Replicas of the Database Instance.

region

region: Region

Region the Database Instance is in.

settings

settings: RDB.v1.InstanceSetting[]

Advanced settings of the Database Instance.

status

status: RDB.v1.InstanceStatus

Status of the Database Instance.

tags

tags: string[]

List of tags applied to the Database Instance.

upgradableVersion

upgradableVersion: RDB.v1.UpgradableVersion[]

Available database engine versions for upgrade.

Optionalvolume

volume?: RDB.v1.Volume

Volumes of the Database Instance.

Settings

On This Page

Properties