Interface Instance

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

Properties

backupSameRegion backupSchedule? createdAt? 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?: DocumentDB.v1beta1.BackupSchedule

Backup schedule of the Database Instance.

OptionalcreatedAt

createdAt?: Date

Creation date (must follow the ISO 8601 format).

Optionalendpoint

endpoint?: DocumentDB.v1beta1.Endpoint

Deprecated

Endpoint of the Database Instance.

endpoints

endpoints: DocumentDB.v1beta1.Endpoint[]

List of Database Instance endpoints.

engine

engine: string

Database engine of the database.

id

id: string

UUID of the Database Instance.

initSettings

initSettings: DocumentDB.v1beta1.InstanceSetting[]

List of engine settings to be set at Database Instance initialization.

isHaCluster

isHaCluster: boolean

Defines whether or not High-Availability is enabled.

OptionallogsPolicy

logsPolicy?: DocumentDB.v1beta1.LogsPolicy

Logs policy of the Database Instance.

maintenances

maintenances: DocumentDB.v1beta1.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: DocumentDB.v1beta1.ReadReplica[]

Read Replicas of the Database Instance.

region

region: Region

Region the Database Instance is in.

settings

settings: DocumentDB.v1beta1.InstanceSetting[]

Advanced settings of the Database Instance.

status

status: DocumentDB.v1beta1.InstanceStatus

Status of the Database Instance.

tags

tags: string[]

List of tags applied to the Database Instance.

upgradableVersion

upgradableVersion: DocumentDB.v1beta1.UpgradableVersion[]

Available database engine versions for upgrade.

Optionalvolume

volume?: DocumentDB.v1beta1.Volume

Volumes of the Database Instance.

Settings

On This Page

Properties