Class API

constructor

• new API(client): DocumentDB.v1beta1.API

• Parameters

  • client: Client

  Returns DocumentDB.v1beta1.API

Static ReadonlyLOCALITIES

addInstanceACLRules

• addInstanceACLRules(request): Promise<DocumentDB.v1beta1.AddInstanceACLRulesResponse>

• Add an ACL rule to a Database Instance. Add an additional ACL rule to a Database Instance.

  Parameters

  • request: Readonly<DocumentDB.v1beta1.AddInstanceACLRulesRequest>

    The request AddInstanceACLRulesRequest

  Returns Promise<DocumentDB.v1beta1.AddInstanceACLRulesResponse>

  A Promise of AddInstanceACLRulesResponse

addInstanceSettings

• addInstanceSettings(request): Promise<DocumentDB.v1beta1.AddInstanceSettingsResponse>

• Add Database Instance advanced settings. Add an advanced setting to a Database Instance. You must set the name and the value of each setting.

  Parameters

  • request: Readonly<DocumentDB.v1beta1.AddInstanceSettingsRequest>

    The request AddInstanceSettingsRequest

  Returns Promise<DocumentDB.v1beta1.AddInstanceSettingsResponse>

  A Promise of AddInstanceSettingsResponse

applyInstanceMaintenance

• applyInstanceMaintenance(request): Promise<DocumentDB.v1beta1.Maintenance>

• Apply an instance maintenance. Apply a pending instance maintenance on your instance. This action can generate some service interruption.

  Parameters

  • request: Readonly<DocumentDB.v1beta1.ApplyInstanceMaintenanceRequest>

    The request ApplyInstanceMaintenanceRequest

  Returns Promise<DocumentDB.v1beta1.Maintenance>

  A Promise of Maintenance

cloneInstance

• cloneInstance(request): Promise<DocumentDB.v1beta1.Instance>

• Clone a Database Instance. Clone a given Database Instance, specified by the region and instance_id parameters. The clone feature allows you to create a new Database Instance from an existing one. The clone includes all existing databases, users and permissions. You can create a clone on a Database Instance bigger than your current one.

  Parameters

  • request: Readonly<DocumentDB.v1beta1.CloneInstanceRequest>

    The request CloneInstanceRequest

  Returns Promise<DocumentDB.v1beta1.Instance>

  A Promise of Instance

createDatabase

• createDatabase(request): Promise<DocumentDB.v1beta1.Database>

• Create a database in a Database Instance. Create a new database. You must define the name parameter in the request.

  Parameters

  • request: Readonly<DocumentDB.v1beta1.CreateDatabaseRequest>

    The request CreateDatabaseRequest

  Returns Promise<DocumentDB.v1beta1.Database>

  A Promise of Database

createEndpoint

• createEndpoint(request): Promise<DocumentDB.v1beta1.Endpoint>

• Create a new Database Instance endpoint. Create a new endpoint for a Database Instance. You can add load_balancer and private_network specifications to the body of the request.

  Parameters

  • request: Readonly<DocumentDB.v1beta1.CreateEndpointRequest>

    The request CreateEndpointRequest

  Returns Promise<DocumentDB.v1beta1.Endpoint>

  A Promise of Endpoint

createInstance

• createInstance(request): Promise<DocumentDB.v1beta1.Instance>

• Create a Database Instance. Create a new Database Instance. You must set the engine, user_name, password and node_type parameters. Optionally, you can specify the volume type and size.

  Parameters

  • request: Readonly<DocumentDB.v1beta1.CreateInstanceRequest>

    The request CreateInstanceRequest

  Returns Promise<DocumentDB.v1beta1.Instance>

  A Promise of Instance

createInstanceFromSnapshot

• createInstanceFromSnapshot(request): Promise<DocumentDB.v1beta1.Instance>

• Create a new Database Instance from a snapshot. Restore a snapshot. When you restore a snapshot, a new Instance is created and billed to your account. Note that is possible to select a larger node type for your new Database Instance. However, the Block volume size will be the same as the size of the restored snapshot. All Instance settings will be restored if you chose a node type with the same or more memory size than the initial Instance. Settings will be reset to the default if your node type has less memory.

  Parameters

  • request: Readonly<DocumentDB.v1beta1.CreateInstanceFromSnapshotRequest>

    The request CreateInstanceFromSnapshotRequest

  Returns Promise<DocumentDB.v1beta1.Instance>

  A Promise of Instance

createReadReplica

• createReadReplica(request): Promise<DocumentDB.v1beta1.ReadReplica>

• Create a Read Replica. Create a new Read Replica of a Database Instance. You must specify the region and the instance_id. You can only create a maximum of 3 Read Replicas per Database Instance.

  Parameters

  • request: Readonly<DocumentDB.v1beta1.CreateReadReplicaRequest>

    The request CreateReadReplicaRequest

  Returns Promise<DocumentDB.v1beta1.ReadReplica>

  A Promise of ReadReplica

createReadReplicaEndpoint

• createReadReplicaEndpoint(request): Promise<DocumentDB.v1beta1.ReadReplica>

• Create an endpoint for a Read Replica. Create a new endpoint for a Read Replica. Read Replicas can have at most one direct access and one Private Network endpoint.

  Parameters

  • request: Readonly<DocumentDB.v1beta1.CreateReadReplicaEndpointRequest>

    The request CreateReadReplicaEndpointRequest

  Returns Promise<DocumentDB.v1beta1.ReadReplica>

  A Promise of ReadReplica

createSnapshot

• createSnapshot(request): Promise<DocumentDB.v1beta1.Snapshot>

• Create a Database Instance snapshot. Create a new snapshot of a Database Instance. You must define the name parameter in the request.

  Parameters

  • request: Readonly<DocumentDB.v1beta1.CreateSnapshotRequest>

    The request CreateSnapshotRequest

  Returns Promise<DocumentDB.v1beta1.Snapshot>

  A Promise of Snapshot

createUser

• createUser(request): Promise<DocumentDB.v1beta1.User>

• Create a user for a Database Instance. Create a new user for a Database Instance. You must define the name, password and is_admin parameters.

  Parameters

  • request: Readonly<DocumentDB.v1beta1.CreateUserRequest>

    The request CreateUserRequest

  Returns Promise<DocumentDB.v1beta1.User>

  A Promise of User

deleteDatabase

• deleteDatabase(request): Promise<void>

• Delete a database in a Database Instance. Delete a given database on a Database Instance. You must specify, in the endpoint, the region, instance_id and name parameters of the database you want to delete.

  Parameters

  • request: Readonly<DocumentDB.v1beta1.DeleteDatabaseRequest>

    The request DeleteDatabaseRequest

  Returns Promise<void>

deleteEndpoint

• deleteEndpoint(request): Promise<void>

• Delete a Database Instance endpoint. Delete the endpoint of a Database Instance. You must specify the region and endpoint_id parameters of the endpoint you want to delete. Note that might need to update any environment configurations that point to the deleted endpoint.

  Parameters

  • request: Readonly<DocumentDB.v1beta1.DeleteEndpointRequest>

    The request DeleteEndpointRequest

  Returns Promise<void>

deleteInstance

• deleteInstance(request): Promise<DocumentDB.v1beta1.Instance>

• Delete a Database Instance. Delete a given Database Instance, specified by the region and instance_id parameters. Deleting a Database Instance is permanent, and cannot be undone. Note that upon deletion all your data will be lost.

  Parameters

  • request: Readonly<DocumentDB.v1beta1.DeleteInstanceRequest>

    The request DeleteInstanceRequest

  Returns Promise<DocumentDB.v1beta1.Instance>

  A Promise of Instance

deleteInstanceACLRules

• deleteInstanceACLRules(request): Promise<DocumentDB.v1beta1.DeleteInstanceACLRulesResponse>

• Delete ACL rules of a Database Instance. Delete one or more ACL rules of a Database Instance.

  Parameters

  • request: Readonly<DocumentDB.v1beta1.DeleteInstanceACLRulesRequest>

    The request DeleteInstanceACLRulesRequest

  Returns Promise<DocumentDB.v1beta1.DeleteInstanceACLRulesResponse>

  A Promise of DeleteInstanceACLRulesResponse

deleteInstanceSettings

• deleteInstanceSettings(request): Promise<DocumentDB.v1beta1.DeleteInstanceSettingsResponse>

• Delete Database Instance advanced settings. Delete an advanced setting in a Database Instance. You must specify the names of the settings you want to delete in the request.

  Parameters

  • request: Readonly<DocumentDB.v1beta1.DeleteInstanceSettingsRequest>

    The request DeleteInstanceSettingsRequest

  Returns Promise<DocumentDB.v1beta1.DeleteInstanceSettingsResponse>

  A Promise of DeleteInstanceSettingsResponse

deleteReadReplica

• deleteReadReplica(request): Promise<DocumentDB.v1beta1.ReadReplica>

• Delete a Read Replica. Delete a Read Replica of a Database Instance. You must specify the region and read_replica_id parameters of the Read Replica you want to delete.

  Parameters

  • request: Readonly<DocumentDB.v1beta1.DeleteReadReplicaRequest>

    The request DeleteReadReplicaRequest

  Returns Promise<DocumentDB.v1beta1.ReadReplica>

  A Promise of ReadReplica

deleteSnapshot

• deleteSnapshot(request): Promise<DocumentDB.v1beta1.Snapshot>

• Delete a Database Instance snapshot. Delete a given snapshot of a Database Instance. You must specify, in the endpoint, the region and snapshot_id parameters of the snapshot you want to delete.

  Parameters

  • request: Readonly<DocumentDB.v1beta1.DeleteSnapshotRequest>

    The request DeleteSnapshotRequest

  Returns Promise<DocumentDB.v1beta1.Snapshot>

  A Promise of Snapshot

deleteUser

• deleteUser(request): Promise<void>

• Delete a user on a Database Instance. Delete a given user on a Database Instance. You must specify, in the endpoint, the region, instance_id and name parameters of the user you want to delete.

  Parameters

  • request: Readonly<DocumentDB.v1beta1.DeleteUserRequest>

    The request DeleteUserRequest

  Returns Promise<void>

getEndpoint

• getEndpoint(request): Promise<DocumentDB.v1beta1.Endpoint>

• Get a Database Instance endpoint. Retrieve information about a Database Instance endpoint. Full details about the endpoint, like ip, port, private_network and load_balancer specifications are returned in the response.

  Parameters

  • request: Readonly<DocumentDB.v1beta1.GetEndpointRequest>

    The request GetEndpointRequest

  Returns Promise<DocumentDB.v1beta1.Endpoint>

  A Promise of Endpoint

getInstance

• getInstance(request): Promise<DocumentDB.v1beta1.Instance>

• Get a Database Instance. Retrieve information about a given Database Instance, specified by the region and instance_id parameters. Its full details, including name, status, IP address and port, are returned in the response object.

  Parameters

  • request: Readonly<DocumentDB.v1beta1.GetInstanceRequest>

    The request GetInstanceRequest

  Returns Promise<DocumentDB.v1beta1.Instance>

  A Promise of Instance

getInstanceCertificate

• getInstanceCertificate(request): Promise<Blob>

• Get the TLS certificate of a Database Instance. Retrieve information about the TLS certificate of a given Database Instance. Details like name and content are returned in the response.

  Parameters

  • request: Readonly<DocumentDB.v1beta1.GetInstanceCertificateRequest>

    The request GetInstanceCertificateRequest

  Returns Promise<Blob>

  A Promise of Blob

getInstanceLog

• getInstanceLog(request): Promise<DocumentDB.v1beta1.InstanceLog>

• Get given logs of a Database Instance. Retrieve information about the logs of a Database Instance. Specify the instance_log_id and region in your request to get information such as download_url, status, expires_at and created_at about your logs in the response.

  Parameters

  • request: Readonly<DocumentDB.v1beta1.GetInstanceLogRequest>

    The request GetInstanceLogRequest

  Returns Promise<DocumentDB.v1beta1.InstanceLog>

  A Promise of InstanceLog

getInstanceMetrics

• getInstanceMetrics(request): Promise<DocumentDB.v1beta1.InstanceMetrics>

• Get Database Instance metrics. Retrieve the time series metrics of a given Database Instance. You can define the period from which to retrieve metrics by specifying the start_date and end_date.

  Parameters

  • request: Readonly<DocumentDB.v1beta1.GetInstanceMetricsRequest>

    The request GetInstanceMetricsRequest

  Returns Promise<DocumentDB.v1beta1.InstanceMetrics>

  A Promise of InstanceMetrics

getReadReplica

• getReadReplica(request): Promise<DocumentDB.v1beta1.ReadReplica>

• Get a Read Replica. Retrieve information about a Database Instance Read Replica. Full details about the Read Replica, like endpoints, status and region are returned in the response.

  Parameters

  • request: Readonly<DocumentDB.v1beta1.GetReadReplicaRequest>

    The request GetReadReplicaRequest

  Returns Promise<DocumentDB.v1beta1.ReadReplica>

  A Promise of ReadReplica

getSnapshot

• getSnapshot(request): Promise<DocumentDB.v1beta1.Snapshot>

• Get a Database Instance snapshot. Retrieve information about a given snapshot, specified by its snapshot_id and region. Full details about the snapshot, like size and expiration date, are returned in the response.

  Parameters

  • request: Readonly<DocumentDB.v1beta1.GetSnapshotRequest>

    The request GetSnapshotRequest

  Returns Promise<DocumentDB.v1beta1.Snapshot>

  A Promise of Snapshot

listDatabaseEngines

• listDatabaseEngines(request?): Promise<DocumentDB.v1beta1.ListDatabaseEnginesResponse> & {
      [asyncIterator]: (() => AsyncGenerator<DocumentDB.v1beta1.DatabaseEngine[], void, void>);
      all: (() => Promise<DocumentDB.v1beta1.DatabaseEngine[]>);
  }

• List available database engines. List the FerretDB database engines available at Scaleway.

  Parameters

  • request: Readonly<DocumentDB.v1beta1.ListDatabaseEnginesRequest> = {}

    The request ListDatabaseEnginesRequest

  Returns Promise<DocumentDB.v1beta1.ListDatabaseEnginesResponse> & {
      [asyncIterator]: (() => AsyncGenerator<DocumentDB.v1beta1.DatabaseEngine[], void, void>);
      all: (() => Promise<DocumentDB.v1beta1.DatabaseEngine[]>);
  }

  A Promise of ListDatabaseEnginesResponse

listDatabases

• listDatabases(request): Promise<DocumentDB.v1beta1.ListDatabasesResponse> & {
      [asyncIterator]: (() => AsyncGenerator<DocumentDB.v1beta1.Database[], void, void>);
      all: (() => Promise<DocumentDB.v1beta1.Database[]>);
  }

• List databases in a Database Instance. List all databases of a given Database Instance. By default, the databases returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. You can define additional parameters for your query, such as name, managed and owner.

  Parameters

  • request: Readonly<DocumentDB.v1beta1.ListDatabasesRequest>

    The request ListDatabasesRequest

  Returns Promise<DocumentDB.v1beta1.ListDatabasesResponse> & {
      [asyncIterator]: (() => AsyncGenerator<DocumentDB.v1beta1.Database[], void, void>);
      all: (() => Promise<DocumentDB.v1beta1.Database[]>);
  }

  A Promise of ListDatabasesResponse

listInstanceACLRules

• listInstanceACLRules(request): Promise<DocumentDB.v1beta1.ListInstanceACLRulesResponse> & {
      [asyncIterator]: (() => AsyncGenerator<DocumentDB.v1beta1.ACLRule[], void, void>);
      all: (() => Promise<DocumentDB.v1beta1.ACLRule[]>);
  }

• List ACL rules of a Database Instance. List the ACL rules for a given Database Instance. The response is an array of ACL objects, each one representing an ACL that denies, allows or redirects traffic based on certain conditions.

  Parameters

  • request: Readonly<DocumentDB.v1beta1.ListInstanceACLRulesRequest>

    The request ListInstanceACLRulesRequest

  Returns Promise<DocumentDB.v1beta1.ListInstanceACLRulesResponse> & {
      [asyncIterator]: (() => AsyncGenerator<DocumentDB.v1beta1.ACLRule[], void, void>);
      all: (() => Promise<DocumentDB.v1beta1.ACLRule[]>);
  }

  A Promise of ListInstanceACLRulesResponse

listInstanceLogs

• listInstanceLogs(request): Promise<DocumentDB.v1beta1.ListInstanceLogsResponse>

• List available logs of a Database Instance. List the available logs of a Database Instance. By default, the logs returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.

  Parameters

  • request: Readonly<DocumentDB.v1beta1.ListInstanceLogsRequest>

    The request ListInstanceLogsRequest

  Returns Promise<DocumentDB.v1beta1.ListInstanceLogsResponse>

  A Promise of ListInstanceLogsResponse

listInstanceLogsDetails

• listInstanceLogsDetails(request): Promise<DocumentDB.v1beta1.ListInstanceLogsDetailsResponse>

• List remote Database Instance logs details. List remote log details. By default, the details returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.

  Parameters

  • request: Readonly<DocumentDB.v1beta1.ListInstanceLogsDetailsRequest>

    The request ListInstanceLogsDetailsRequest

  Returns Promise<DocumentDB.v1beta1.ListInstanceLogsDetailsResponse>

  A Promise of ListInstanceLogsDetailsResponse

listInstances

• listInstances(request?): Promise<DocumentDB.v1beta1.ListInstancesResponse> & {
      [asyncIterator]: (() => AsyncGenerator<DocumentDB.v1beta1.Instance[], void, void>);
      all: (() => Promise<DocumentDB.v1beta1.Instance[]>);
  }

• List Database Instances. List all Database Instances in the specified region, for a given Scaleway Organization or Scaleway Project. By default, the Database Instances returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. You can define additional parameters for your query, such as tags and name. For the name parameter, the value you include will be checked against the whole name string to see if it includes the string you put in the parameter.

  Parameters

  • request: Readonly<DocumentDB.v1beta1.ListInstancesRequest> = {}

    The request ListInstancesRequest

  Returns Promise<DocumentDB.v1beta1.ListInstancesResponse> & {
      [asyncIterator]: (() => AsyncGenerator<DocumentDB.v1beta1.Instance[], void, void>);
      all: (() => Promise<DocumentDB.v1beta1.Instance[]>);
  }

  A Promise of ListInstancesResponse

listNodeTypes

• listNodeTypes(request): Promise<DocumentDB.v1beta1.ListNodeTypesResponse> & {
      [asyncIterator]: (() => AsyncGenerator<DocumentDB.v1beta1.NodeType[], void, void>);
      all: (() => Promise<DocumentDB.v1beta1.NodeType[]>);
  }

• List available node types. List all available node types. By default, the node types returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.

  Parameters

  • request: Readonly<DocumentDB.v1beta1.ListNodeTypesRequest>

    The request ListNodeTypesRequest

  Returns Promise<DocumentDB.v1beta1.ListNodeTypesResponse> & {
      [asyncIterator]: (() => AsyncGenerator<DocumentDB.v1beta1.NodeType[], void, void>);
      all: (() => Promise<DocumentDB.v1beta1.NodeType[]>);
  }

  A Promise of ListNodeTypesResponse

listPrivileges

• listPrivileges(request): Promise<DocumentDB.v1beta1.ListPrivilegesResponse> & {
      [asyncIterator]: (() => AsyncGenerator<DocumentDB.v1beta1.Privilege[], void, void>);
      all: (() => Promise<DocumentDB.v1beta1.Privilege[]>);
  }

• List user privileges for a database. List privileges of a user on a database. By default, the details returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. You can define additional parameters for your query, such as database_name and user_name.

  Parameters

  • request: Readonly<DocumentDB.v1beta1.ListPrivilegesRequest>

    The request ListPrivilegesRequest

  Returns Promise<DocumentDB.v1beta1.ListPrivilegesResponse> & {
      [asyncIterator]: (() => AsyncGenerator<DocumentDB.v1beta1.Privilege[], void, void>);
      all: (() => Promise<DocumentDB.v1beta1.Privilege[]>);
  }

  A Promise of ListPrivilegesResponse

listSnapshots

• listSnapshots(request?): Promise<DocumentDB.v1beta1.ListSnapshotsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<DocumentDB.v1beta1.Snapshot[], void, void>);
      all: (() => Promise<DocumentDB.v1beta1.Snapshot[]>);
  }

• List snapshots. List snapshots. You can include the instance_id or project_id in your query to get the list of snapshots for specific Database Instances and/or Projects. By default, the details returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.

  Parameters

  • request: Readonly<DocumentDB.v1beta1.ListSnapshotsRequest> = {}

    The request ListSnapshotsRequest

  Returns Promise<DocumentDB.v1beta1.ListSnapshotsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<DocumentDB.v1beta1.Snapshot[], void, void>);
      all: (() => Promise<DocumentDB.v1beta1.Snapshot[]>);
  }

  A Promise of ListSnapshotsResponse

listUsers

• listUsers(request): Promise<DocumentDB.v1beta1.ListUsersResponse> & {
      [asyncIterator]: (() => AsyncGenerator<DocumentDB.v1beta1.User[], void, void>);
      all: (() => Promise<DocumentDB.v1beta1.User[]>);
  }

• List users of a Database Instance. List all users of a given Database Instance. By default, the users returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.

  Parameters

  • request: Readonly<DocumentDB.v1beta1.ListUsersRequest>

    The request ListUsersRequest

  Returns Promise<DocumentDB.v1beta1.ListUsersResponse> & {
      [asyncIterator]: (() => AsyncGenerator<DocumentDB.v1beta1.User[], void, void>);
      all: (() => Promise<DocumentDB.v1beta1.User[]>);
  }

  A Promise of ListUsersResponse

migrateEndpoint

• migrateEndpoint(request): Promise<DocumentDB.v1beta1.Endpoint>

• Migrate Database Instance endpoint. Migrate an existing Database Instance endpoint to another Database Instance.

  Parameters

  • request: Readonly<DocumentDB.v1beta1.MigrateEndpointRequest>

    The request MigrateEndpointRequest

  Returns Promise<DocumentDB.v1beta1.Endpoint>

  A Promise of Endpoint

promoteReadReplica

• promoteReadReplica(request): Promise<DocumentDB.v1beta1.Instance>

• Promote a Read Replica. Promote a Read Replica to Database Instance automatically.

  Parameters

  • request: Readonly<DocumentDB.v1beta1.PromoteReadReplicaRequest>

    The request PromoteReadReplicaRequest

  Returns Promise<DocumentDB.v1beta1.Instance>

  A Promise of Instance

purgeInstanceLogs

• purgeInstanceLogs(request): Promise<void>

• Purge remote Database Instance logs. Purge a given remote log from a Database Instance. You can specify the log_name of the log you wish to clean from your Database Instance.

  Parameters

  • request: Readonly<DocumentDB.v1beta1.PurgeInstanceLogsRequest>

    The request PurgeInstanceLogsRequest

  Returns Promise<void>

renewInstanceCertificate

• renewInstanceCertificate(request): Promise<void>

• Renew the TLS certificate of a Database Instance. Renew a TLS for a Database Instance. Renewing a certificate means that you will not be able to connect to your Database Instance using the previous certificate. You will also need to download and update the new certificate for all database clients.

  Parameters

  • request: Readonly<DocumentDB.v1beta1.RenewInstanceCertificateRequest>

    The request RenewInstanceCertificateRequest

  Returns Promise<void>

resetReadReplica

• resetReadReplica(request): Promise<DocumentDB.v1beta1.ReadReplica>

• Resync a Read Replica. When you resync a Read Replica, first it is reset, then its data is resynchronized from the primary node. Your Read Replica remains unavailable during the resync process. The duration of this process is proportional to the size of your Database Instance. The configured endpoints do not change.

  Parameters

  • request: Readonly<DocumentDB.v1beta1.ResetReadReplicaRequest>

    The request ResetReadReplicaRequest

  Returns Promise<DocumentDB.v1beta1.ReadReplica>

  A Promise of ReadReplica

restartInstance

• restartInstance(request): Promise<DocumentDB.v1beta1.Instance>

• Restart Database Instance. Restart a given Database Instance, specified by the region and instance_id parameters. The status of the Database Instance returned in the response.

  Parameters

  • request: Readonly<DocumentDB.v1beta1.RestartInstanceRequest>

    The request RestartInstanceRequest

  Returns Promise<DocumentDB.v1beta1.Instance>

  A Promise of Instance

setInstanceACLRules

• setInstanceACLRules(request): Promise<DocumentDB.v1beta1.SetInstanceACLRulesResponse>

• Set ACL rules for a Database Instance. Replace all the ACL rules of a Database Instance.

  Parameters

  • request: Readonly<DocumentDB.v1beta1.SetInstanceACLRulesRequest>

    The request SetInstanceACLRulesRequest

  Returns Promise<DocumentDB.v1beta1.SetInstanceACLRulesResponse>

  A Promise of SetInstanceACLRulesResponse

setInstanceSettings

• setInstanceSettings(request): Promise<DocumentDB.v1beta1.SetInstanceSettingsResponse>

• Set Database Instance advanced settings. Update an advanced setting for a Database Instance. Settings added upon database engine initalization can only be defined once, and cannot, therefore, be updated.

  Parameters

  • request: Readonly<DocumentDB.v1beta1.SetInstanceSettingsRequest>

    The request SetInstanceSettingsRequest

  Returns Promise<DocumentDB.v1beta1.SetInstanceSettingsResponse>

  A Promise of SetInstanceSettingsResponse

setPrivilege

• setPrivilege(request): Promise<DocumentDB.v1beta1.Privilege>

• Set user privileges for a database. Set the privileges of a user on a database. You must define database_name, user_name and permission in the request body.

  Parameters

  • request: Readonly<DocumentDB.v1beta1.SetPrivilegeRequest>

    The request SetPrivilegeRequest

  Returns Promise<DocumentDB.v1beta1.Privilege>

  A Promise of Privilege

updateInstance

• updateInstance(request): Promise<DocumentDB.v1beta1.Instance>

• Update a Database Instance. Update the parameters of a Database Instance, including name, tags and backup schedule details.

  Parameters

  • request: Readonly<DocumentDB.v1beta1.UpdateInstanceRequest>

    The request UpdateInstanceRequest

  Returns Promise<DocumentDB.v1beta1.Instance>

  A Promise of Instance

updateSnapshot

• updateSnapshot(request): Promise<DocumentDB.v1beta1.Snapshot>

• Update a Database Instance snapshot. Update the parameters of a snapshot of a Database Instance. You can update the name and expires_at parameters.

  Parameters

  • request: Readonly<DocumentDB.v1beta1.UpdateSnapshotRequest>

    The request UpdateSnapshotRequest

  Returns Promise<DocumentDB.v1beta1.Snapshot>

  A Promise of Snapshot

updateUser

• updateUser(request): Promise<DocumentDB.v1beta1.User>

• Update a user on a Database Instance. Update the parameters of a user on a Database Instance. You can update the password and is_admin parameters, but you cannot change the name of the user.

  Parameters

  • request: Readonly<DocumentDB.v1beta1.UpdateUserRequest>

    The request UpdateUserRequest

  Returns Promise<DocumentDB.v1beta1.User>

  A Promise of User

upgradeInstance

• upgradeInstance(request): Promise<DocumentDB.v1beta1.Instance>

• Upgrade a Database Instance. Upgrade your current Database Instance specifications like node type, high availability, volume, or the database engine version. Note that upon upgrade the enable_ha parameter can only be set to true.

  Parameters

  • request: Readonly<DocumentDB.v1beta1.UpgradeInstanceRequest>

    The request UpgradeInstanceRequest

  Returns Promise<DocumentDB.v1beta1.Instance>

  A Promise of Instance

waitForInstance

• waitForInstance(request, options?): Promise<DocumentDB.v1beta1.Instance>

• Waits for Instance to be in a final state.

  Parameters

  • request: Readonly<DocumentDB.v1beta1.GetInstanceRequest>

    The request GetInstanceRequest
  • Optionaloptions: Readonly<WaitForOptions<DocumentDB.v1beta1.Instance>>

    The waiting options

  Returns Promise<DocumentDB.v1beta1.Instance>

  A Promise of Instance

waitForInstanceLog

• waitForInstanceLog(request, options?): Promise<DocumentDB.v1beta1.InstanceLog>

• Waits for InstanceLog to be in a final state.

  Parameters

  • request: Readonly<DocumentDB.v1beta1.GetInstanceLogRequest>

    The request GetInstanceLogRequest
  • Optionaloptions: Readonly<WaitForOptions<DocumentDB.v1beta1.InstanceLog>>

    The waiting options

  Returns Promise<DocumentDB.v1beta1.InstanceLog>

  A Promise of InstanceLog

waitForReadReplica

• waitForReadReplica(request, options?): Promise<DocumentDB.v1beta1.ReadReplica>

• Waits for ReadReplica to be in a final state.

  Parameters

  • request: Readonly<DocumentDB.v1beta1.GetReadReplicaRequest>

    The request GetReadReplicaRequest
  • Optionaloptions: Readonly<WaitForOptions<DocumentDB.v1beta1.ReadReplica>>

    The waiting options

  Returns Promise<DocumentDB.v1beta1.ReadReplica>

  A Promise of ReadReplica

waitForSnapshot

• waitForSnapshot(request, options?): Promise<DocumentDB.v1beta1.Snapshot>

• Waits for Snapshot to be in a final state.

  Parameters

  • request: Readonly<DocumentDB.v1beta1.GetSnapshotRequest>

    The request GetSnapshotRequest
  • Optionaloptions: Readonly<WaitForOptions<DocumentDB.v1beta1.Snapshot>>

    The waiting options

  Returns Promise<DocumentDB.v1beta1.Snapshot>

  A Promise of Snapshot