/** * (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /// import { IncomingHttpHeaders, OutgoingHttpHeaders } from 'http'; import { BaseService, UserOptions } from 'ibm-cloud-sdk-core'; /** * The IBM Cloud Databases API enables interaction between applications and Cloud Databases database deployments. * * Access to the API requires an IAM Bearer Token or an IAM API Key to be presented through bearer authentication. * * Deployment IDs are CRNs on the IBM Cloud Databases v5 API platform. No lookup or translation the Compose style UUIDs * is needed. The Deployment ID is a traditional UUID on the Compose v5 API platform. * * When you use CRNs, remember to URL escape the CRN value as they can include the forward-slash (/) character. */ declare class CloudDatabasesV5 extends BaseService { static DEFAULT_SERVICE_NAME: string; /************************* * Factory method ************************/ /** * Constructs an instance of CloudDatabasesV5 with passed in options and external configuration. * * @param {UserOptions} [options] - The parameters to send to the service. * @param {string} [options.serviceName] - The name of the service to configure * @param {Authenticator} [options.authenticator] - The Authenticator object used to authenticate requests to the service * @param {string} [options.serviceUrl] - The URL for the service * @returns {CloudDatabasesV5} */ static newInstance(options: UserOptions): CloudDatabasesV5; /** * Construct a CloudDatabasesV5 object. * * @param {Object} options - Options for the service. * @param {string} [options.serviceUrl] - The base url to use when contacting the service. The base url may differ between IBM Cloud regions. * @param {OutgoingHttpHeaders} [options.headers] - Default headers that shall be included with every request to the service. * @param {Authenticator} options.authenticator - The Authenticator object used to authenticate requests to the service * @constructor * @returns {CloudDatabasesV5} */ constructor(options: UserOptions); /************************* * deployments ************************/ /** * List all deployable databases. * * Returns a list of all the types and associated major versions of database deployments that can be provisioned. * * @param {Object} [params] - The parameters to send to the service. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} */ listDeployables(params?: CloudDatabasesV5.ListDeployablesParams): Promise>; /** * List all deployable regions. * * Returns a list of all the regions that deployments can be provisioned into from the current region. Used to * determine region availability for read-only replicas. * * @param {Object} [params] - The parameters to send to the service. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} */ listRegions(params?: CloudDatabasesV5.ListRegionsParams): Promise>; /** * Get deployment information. * * Gets the full data that is associated with a deployment. This data includes the ID, name, database type, and * version. * * @param {Object} params - The parameters to send to the service. * @param {string} params.id - Deployment ID. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} */ getDeploymentInfo(params: CloudDatabasesV5.GetDeploymentInfoParams): Promise>; /************************* * databaseUsers ************************/ /** * Creates a user based on user type. * * Creates a user in the database that can access the database through a connection. * * @param {Object} params - The parameters to send to the service. * @param {string} params.id - Deployment ID. * @param {string} params.userType - User type. * @param {CreateDatabaseUserRequestUser} [params.user] - * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} */ createDatabaseUser(params: CloudDatabasesV5.CreateDatabaseUserParams): Promise>; /** * Set specified user's password. * * Sets the password of a specified user. * * @param {Object} params - The parameters to send to the service. * @param {string} params.id - Deployment ID. * @param {string} params.userType - User type. * @param {string} params.username - User ID. * @param {APasswordSettingUser} [params.user] - * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} */ changeUserPassword(params: CloudDatabasesV5.ChangeUserPasswordParams): Promise>; /** * Deletes a user based on user type. * * Removes a user from the deployment. * * @param {Object} params - The parameters to send to the service. * @param {string} params.id - Deployment ID. * @param {string} params.userType - User type. * @param {string} params.username - Username. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} */ deleteDatabaseUser(params: CloudDatabasesV5.DeleteDatabaseUserParams): Promise>; /************************* * databaseConfiguration ************************/ /** * Change your database configuration. * * Change your database configuration. Available for PostgreSQL, EnterpriseDB, and Redis ONLY. * * @param {Object} params - The parameters to send to the service. * @param {string} params.id - Deployment ID. * @param {SetConfigurationConfiguration} params.configuration - * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} */ updateDatabaseConfiguration(params: CloudDatabasesV5.UpdateDatabaseConfigurationParams): Promise>; /************************* * remotes ************************/ /** * List read-only replica information. * * Get the read-only replicas associated with a deployment. Available for PostgreSQL and EnterpriseDB ONLY. * * @param {Object} params - The parameters to send to the service. * @param {string} params.id - Deployment ID. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} */ listRemotes(params: CloudDatabasesV5.ListRemotesParams): Promise>; /** * Resync read-only replica. * * Reinitialize a read-only replica. Available for PostgreSQL and EnterpriseDB ONLY. * * @param {Object} params - The parameters to send to the service. * @param {string} params.id - Deployment ID of the read-only replica. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} */ resyncReplica(params: CloudDatabasesV5.ResyncReplicaParams): Promise>; /** * Promote read-only replica to a full deployment. * * Promote a read-only replica or upgrade and promote a read-only replica. Available for PostgreSQL and EnterpriseDB * ONLY. * * @param {Object} params - The parameters to send to the service. * @param {string} params.id - Deployment ID of the read-only replica to promote. * @param {SetPromotionPromotion} params.promotion - * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} */ setPromotion(params: CloudDatabasesV5.SetPromotionParams): Promise>; /************************* * tasks ************************/ /** * List currently running tasks on a deployment. * * Obtain a list of tasks currently running or recently run on a deployment. Tasks are ephemeral. Records of * successful tasks are shown for 24-48 hours, and unsuccessful tasks are shown for 7-8 days. * * @param {Object} params - The parameters to send to the service. * @param {string} params.id - Deployment ID. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} */ listDeploymentTasks(params: CloudDatabasesV5.ListDeploymentTasksParams): Promise>; /** * Get information about a task. * * Get information about a task and its status. Tasks themselves are persistent so old tasks can be consulted as well * as running tasks. * * @param {Object} params - The parameters to send to the service. * @param {string} params.id - Task ID. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} */ getTask(params: CloudDatabasesV5.GetTaskParams): Promise>; /************************* * backups ************************/ /** * Get information about a backup. * * Get information about a backup, such as creation date. * * @param {Object} params - The parameters to send to the service. * @param {string} params.backupId - Backup ID. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} */ getBackupInfo(params: CloudDatabasesV5.GetBackupInfoParams): Promise>; /** * List currently available backups from a deployment. * * Get details of all currently available backups from a deployment. * * @param {Object} params - The parameters to send to the service. * @param {string} params.id - Deployment ID. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} */ listDeploymentBackups(params: CloudDatabasesV5.ListDeploymentBackupsParams): Promise>; /** * Initiate an on-demand backup. * * Signal the platform to create an on-demand backup for the specified deployment. The returned task can be polled to * track progress of the backup as it takes place. * * @param {Object} params - The parameters to send to the service. * @param {string} params.id - Deployment ID. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} */ startOndemandBackup(params: CloudDatabasesV5.StartOndemandBackupParams): Promise>; /** * Get earliest point-in-time-recovery timestamp. * * Returns the earliest available time for point-in-time-recovery in ISO8601 UTC format. PostgreSQL and EnterpriseDB * only. * * @param {Object} params - The parameters to send to the service. * @param {string} params.id - Deployment ID. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} */ getPitRdata(params: CloudDatabasesV5.GetPitRdataParams): Promise>; /************************* * connections ************************/ /** * Discover connection information for a deployment for a user with an endpoint type. * * Discover connection information for a deployment for a user with an endpoint type. * * @param {Object} params - The parameters to send to the service. * @param {string} params.id - Deployment ID. * @param {string} params.userType - User type. * @param {string} params.userId - User ID. * @param {string} params.endpointType - Endpoint Type. The endpoint must be enabled on the deployment before its * connection information can be fetched. * @param {string} [params.certificateRoot] - Optional certificate root path to prepend certificate names. * Certificates would be stored in this directory for use by other commands. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} */ getConnection(params: CloudDatabasesV5.GetConnectionParams): Promise>; /** * Discover connection information for a deployment for a user with substitutions and an endpoint type. * * Discover connection information for a deployment for a user. Behaves the same as the GET method but substitutes the * provided password parameter into the returned connection information. * * @param {Object} params - The parameters to send to the service. * @param {string} params.id - Deployment ID. * @param {string} params.userType - User type of `database` is the only currently supported value. * @param {string} params.userId - User ID. * @param {string} params.endpointType - Endpoint Type. The select endpoint must be enabled on the deployment before * its connection information can be fetched. * @param {string} [params.password] - Password to be substituted into the response. * @param {string} [params.certificateRoot] - Optional certificate root path to prepend certificate names. * Certificates would be stored in this directory for use by other commands. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} */ completeConnection(params: CloudDatabasesV5.CompleteConnectionParams): Promise>; /************************* * scaling ************************/ /** * List currently available scaling groups from a deployment. * * Scaling groups represent the various resources that are allocated to a deployment. This command allows for the * retrieval of all of the groups for a particular deployment. * * @param {Object} params - The parameters to send to the service. * @param {string} params.id - Deployment ID. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} */ listDeploymentScalingGroups(params: CloudDatabasesV5.ListDeploymentScalingGroupsParams): Promise>; /** * Get default scaling groups for a new deployment. * * Scaling groups represent the various resources allocated to a deployment. When a new deployment is created, there * are a set of defaults for each database type. This endpoint returns them for a particular database. * * @param {Object} params - The parameters to send to the service. * @param {string} params.type - Database type name. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} */ getDefaultScalingGroups(params: CloudDatabasesV5.GetDefaultScalingGroupsParams): Promise>; /** * Set scaling values on a specified group. * * Set scaling value on a specified group. Can only be performed on is_adjustable=true groups. Values set are for the * group as a whole and resources are distributed amongst the group. Values must be greater than or equal to the * minimum size and must be a multiple of the step size. * * @param {Object} params - The parameters to send to the service. * @param {string} params.id - Deployment ID. * @param {string} params.groupId - Group Id. * @param {SetDeploymentScalingGroupRequest} params.setDeploymentScalingGroupRequest - Scaling group settings. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} */ setDeploymentScalingGroup(params: CloudDatabasesV5.SetDeploymentScalingGroupParams): Promise>; /************************* * autoscaling ************************/ /** * Get the autoscaling configuration from a deployment. * * The Autoscaling configuration represents the various conditions that control autoscaling for a deployment. This * command allows for the retrieval of all autoscaling conditions for a particular deployment. * * @param {Object} params - The parameters to send to the service. * @param {string} params.id - Deployment ID. * @param {string} params.groupId - Group ID. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} */ getAutoscalingConditions(params: CloudDatabasesV5.GetAutoscalingConditionsParams): Promise>; /** * Set the autoscaling configuration from a deployment. * * Enable, disable, or set the conditions for autoscaling on your deployment. Memory, disk, and CPU (if available) can * be set separately and are not all required. * * @param {Object} params - The parameters to send to the service. * @param {string} params.id - Deployment ID. * @param {string} params.groupId - Group ID. * @param {AutoscalingSetGroupAutoscaling} params.autoscaling - * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} */ setAutoscalingConditions(params: CloudDatabasesV5.SetAutoscalingConditionsParams): Promise>; /************************* * management ************************/ /** * Kill connections to a PostgreSQL or EnterpriseDB deployment. * * Closes all the connections on a deployment. Available for PostgreSQL and EnterpriseDB ONLY. * * @param {Object} params - The parameters to send to the service. * @param {string} params.id - Deployment ID. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} */ killConnections(params: CloudDatabasesV5.KillConnectionsParams): Promise>; /************************* * security ************************/ /** * Retrieve the allowlisted addresses and ranges for a deployment. * * Retrieve the allowlisted addresses and ranges for a deployment. * * @param {Object} params - The parameters to send to the service. * @param {string} params.id - Deployment ID. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} */ getAllowlist(params: CloudDatabasesV5.GetAllowlistParams): Promise>; /** * Set the allowlist for a deployment. * * Set the allowlist for a deployment. This action overwrites all existing entries, so when you modify the allowlist * via a GET/update/PUT, provide the GET response's ETag header value in this endpoint's If-Match header to ensure * that changes that are made by other clients are not accidentally overwritten. * * @param {Object} params - The parameters to send to the service. * @param {string} params.id - Deployment ID. * @param {AllowlistEntry[]} [params.ipAddresses] - An array of allowlist entries. * @param {string} [params.ifMatch] - Verify that the current allowlist matches a provided ETag value. Use in * conjunction with the GET operation's ETag header to ensure synchronicity between clients. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} */ setAllowlist(params: CloudDatabasesV5.SetAllowlistParams): Promise>; /** * Add an address or range to the allowlist for a deployment. * * Add an address or range to the allowlist for a deployment. * * @param {Object} params - The parameters to send to the service. * @param {string} params.id - Deployment ID. * @param {AllowlistEntry} [params.ipAddress] - * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} */ addAllowlistEntry(params: CloudDatabasesV5.AddAllowlistEntryParams): Promise>; /** * Delete an address or range from the allowlist of a deployment. * * Delete an address or range from the allowlist of a deployment. * * @param {Object} params - The parameters to send to the service. * @param {string} params.id - Deployment ID. * @param {string} params.ipaddress - An IPv4 address or a CIDR range (netmasked IPv4 address). * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} */ deleteAllowlistEntry(params: CloudDatabasesV5.DeleteAllowlistEntryParams): Promise>; } /************************* * interfaces ************************/ declare namespace CloudDatabasesV5 { /** An operation response. */ interface Response { result: T; status: number; statusText: string; headers: IncomingHttpHeaders; } /** The callback for a service request. */ type Callback = (error: any, response?: Response) => void; /** The body of a service request that returns no response data. */ interface Empty { } /** A standard JS object, defined to avoid the limitations of `Object` and `object` */ interface JsonObject { [key: string]: any; } /************************* * request interfaces ************************/ /** Parameters for the `listDeployables` operation. */ interface ListDeployablesParams { headers?: OutgoingHttpHeaders; } /** Parameters for the `listRegions` operation. */ interface ListRegionsParams { headers?: OutgoingHttpHeaders; } /** Parameters for the `getDeploymentInfo` operation. */ interface GetDeploymentInfoParams { /** Deployment ID. */ id: string; headers?: OutgoingHttpHeaders; } /** Parameters for the `createDatabaseUser` operation. */ interface CreateDatabaseUserParams { /** Deployment ID. */ id: string; /** User type. */ userType: string; user?: CreateDatabaseUserRequestUser; headers?: OutgoingHttpHeaders; } /** Parameters for the `changeUserPassword` operation. */ interface ChangeUserPasswordParams { /** Deployment ID. */ id: string; /** User type. */ userType: string; /** User ID. */ username: string; user?: APasswordSettingUser; headers?: OutgoingHttpHeaders; } /** Parameters for the `deleteDatabaseUser` operation. */ interface DeleteDatabaseUserParams { /** Deployment ID. */ id: string; /** User type. */ userType: string; /** Username. */ username: string; headers?: OutgoingHttpHeaders; } /** Parameters for the `updateDatabaseConfiguration` operation. */ interface UpdateDatabaseConfigurationParams { /** Deployment ID. */ id: string; configuration: SetConfigurationConfiguration; headers?: OutgoingHttpHeaders; } /** Parameters for the `listRemotes` operation. */ interface ListRemotesParams { /** Deployment ID. */ id: string; headers?: OutgoingHttpHeaders; } /** Parameters for the `resyncReplica` operation. */ interface ResyncReplicaParams { /** Deployment ID of the read-only replica. */ id: string; headers?: OutgoingHttpHeaders; } /** Parameters for the `setPromotion` operation. */ interface SetPromotionParams { /** Deployment ID of the read-only replica to promote. */ id: string; promotion: SetPromotionPromotion; headers?: OutgoingHttpHeaders; } /** Parameters for the `listDeploymentTasks` operation. */ interface ListDeploymentTasksParams { /** Deployment ID. */ id: string; headers?: OutgoingHttpHeaders; } /** Parameters for the `getTask` operation. */ interface GetTaskParams { /** Task ID. */ id: string; headers?: OutgoingHttpHeaders; } /** Parameters for the `getBackupInfo` operation. */ interface GetBackupInfoParams { /** Backup ID. */ backupId: string; headers?: OutgoingHttpHeaders; } /** Parameters for the `listDeploymentBackups` operation. */ interface ListDeploymentBackupsParams { /** Deployment ID. */ id: string; headers?: OutgoingHttpHeaders; } /** Parameters for the `startOndemandBackup` operation. */ interface StartOndemandBackupParams { /** Deployment ID. */ id: string; headers?: OutgoingHttpHeaders; } /** Parameters for the `getPitRdata` operation. */ interface GetPitRdataParams { /** Deployment ID. */ id: string; headers?: OutgoingHttpHeaders; } /** Parameters for the `getConnection` operation. */ interface GetConnectionParams { /** Deployment ID. */ id: string; /** User type. */ userType: string; /** User ID. */ userId: string; /** Endpoint Type. The endpoint must be enabled on the deployment before its connection information can be * fetched. */ endpointType: GetConnectionConstants.EndpointType | string; /** Optional certificate root path to prepend certificate names. Certificates would be stored in this directory * for use by other commands. */ certificateRoot?: string; headers?: OutgoingHttpHeaders; } /** Constants for the `getConnection` operation. */ namespace GetConnectionConstants { /** Endpoint Type. The endpoint must be enabled on the deployment before its connection information can be fetched. */ enum EndpointType { PUBLIC = "public", PRIVATE = "private" } } /** Parameters for the `completeConnection` operation. */ interface CompleteConnectionParams { /** Deployment ID. */ id: string; /** User type of `database` is the only currently supported value. */ userType: string; /** User ID. */ userId: string; /** Endpoint Type. The select endpoint must be enabled on the deployment before its connection information can * be fetched. */ endpointType: CompleteConnectionConstants.EndpointType | string; /** Password to be substituted into the response. */ password?: string; /** Optional certificate root path to prepend certificate names. Certificates would be stored in this directory * for use by other commands. */ certificateRoot?: string; headers?: OutgoingHttpHeaders; } /** Constants for the `completeConnection` operation. */ namespace CompleteConnectionConstants { /** Endpoint Type. The select endpoint must be enabled on the deployment before its connection information can be fetched. */ enum EndpointType { PUBLIC = "public", PRIVATE = "private" } } /** Parameters for the `listDeploymentScalingGroups` operation. */ interface ListDeploymentScalingGroupsParams { /** Deployment ID. */ id: string; headers?: OutgoingHttpHeaders; } /** Parameters for the `getDefaultScalingGroups` operation. */ interface GetDefaultScalingGroupsParams { /** Database type name. */ type: GetDefaultScalingGroupsConstants.Type | string; headers?: OutgoingHttpHeaders; } /** Constants for the `getDefaultScalingGroups` operation. */ namespace GetDefaultScalingGroupsConstants { /** Database type name. */ enum Type { POSTGRESQL = "postgresql", ETCD = "etcd" } } /** Parameters for the `setDeploymentScalingGroup` operation. */ interface SetDeploymentScalingGroupParams { /** Deployment ID. */ id: string; /** Group Id. */ groupId: string; /** Scaling group settings. */ setDeploymentScalingGroupRequest: SetDeploymentScalingGroupRequest; headers?: OutgoingHttpHeaders; } /** Parameters for the `getAutoscalingConditions` operation. */ interface GetAutoscalingConditionsParams { /** Deployment ID. */ id: string; /** Group ID. */ groupId: string; headers?: OutgoingHttpHeaders; } /** Parameters for the `setAutoscalingConditions` operation. */ interface SetAutoscalingConditionsParams { /** Deployment ID. */ id: string; /** Group ID. */ groupId: string; autoscaling: AutoscalingSetGroupAutoscaling; headers?: OutgoingHttpHeaders; } /** Parameters for the `killConnections` operation. */ interface KillConnectionsParams { /** Deployment ID. */ id: string; headers?: OutgoingHttpHeaders; } /** Parameters for the `getAllowlist` operation. */ interface GetAllowlistParams { /** Deployment ID. */ id: string; headers?: OutgoingHttpHeaders; } /** Parameters for the `setAllowlist` operation. */ interface SetAllowlistParams { /** Deployment ID. */ id: string; /** An array of allowlist entries. */ ipAddresses?: AllowlistEntry[]; /** Verify that the current allowlist matches a provided ETag value. Use in conjunction with the GET operation's * ETag header to ensure synchronicity between clients. */ ifMatch?: string; headers?: OutgoingHttpHeaders; } /** Parameters for the `addAllowlistEntry` operation. */ interface AddAllowlistEntryParams { /** Deployment ID. */ id: string; ipAddress?: AllowlistEntry; headers?: OutgoingHttpHeaders; } /** Parameters for the `deleteAllowlistEntry` operation. */ interface DeleteAllowlistEntryParams { /** Deployment ID. */ id: string; /** An IPv4 address or a CIDR range (netmasked IPv4 address). */ ipaddress: string; headers?: OutgoingHttpHeaders; } /************************* * model interfaces ************************/ /** APasswordSettingUser. */ interface APasswordSettingUser { password?: string; } /** AddAllowlistEntryResponse. */ interface AddAllowlistEntryResponse { task?: Task; } /** Allowlist. */ interface Allowlist { /** An array of allowlist entries. */ ip_addresses?: AllowlistEntry[]; } /** AllowlistEntry. */ interface AllowlistEntry { /** An IPv4 address or a CIDR range (netmasked IPv4 address). */ address?: string; /** A human readable description of the address or range for identification purposes. */ description?: string; } /** AutoscalingCPUGroupCPU. */ interface AutoscalingCPUGroupCPU { scalers?: JsonObject; rate?: AutoscalingCPUGroupCPURate; } /** AutoscalingCPUGroupCPURate. */ interface AutoscalingCPUGroupCPURate { increase_percent?: number; period_seconds?: number; limit_count_per_member?: number; units?: string; } /** AutoscalingDiskGroupDisk. */ interface AutoscalingDiskGroupDisk { scalers?: AutoscalingDiskGroupDiskScalers; rate?: AutoscalingDiskGroupDiskRate; } /** AutoscalingDiskGroupDiskRate. */ interface AutoscalingDiskGroupDiskRate { increase_percent?: number; period_seconds?: number; limit_mb_per_member?: number; units?: string; } /** AutoscalingDiskGroupDiskScalers. */ interface AutoscalingDiskGroupDiskScalers { capacity?: AutoscalingDiskGroupDiskScalersCapacity; io_utilization?: AutoscalingDiskGroupDiskScalersIoUtilization; } /** AutoscalingDiskGroupDiskScalersCapacity. */ interface AutoscalingDiskGroupDiskScalersCapacity { enabled?: boolean; free_space_less_than_percent?: number; } /** AutoscalingDiskGroupDiskScalersIoUtilization. */ interface AutoscalingDiskGroupDiskScalersIoUtilization { enabled?: boolean; over_period?: string; above_percent?: number; } /** AutoscalingGroup. */ interface AutoscalingGroup { autoscaling: AutoscalingGroupAutoscaling; } /** AutoscalingGroupAutoscaling. */ interface AutoscalingGroupAutoscaling { disk?: AutoscalingDiskGroupDisk; memory?: AutoscalingMemoryGroupMemory; cpu?: AutoscalingCPUGroupCPU; } /** AutoscalingMemoryGroupMemory. */ interface AutoscalingMemoryGroupMemory { scalers?: AutoscalingMemoryGroupMemoryScalers; rate?: AutoscalingMemoryGroupMemoryRate; } /** AutoscalingMemoryGroupMemoryRate. */ interface AutoscalingMemoryGroupMemoryRate { increase_percent?: number; period_seconds?: number; limit_mb_per_member?: number; units?: string; } /** AutoscalingMemoryGroupMemoryScalers. */ interface AutoscalingMemoryGroupMemoryScalers { io_utilization?: AutoscalingMemoryGroupMemoryScalersIoUtilization; } /** AutoscalingMemoryGroupMemoryScalersIoUtilization. */ interface AutoscalingMemoryGroupMemoryScalersIoUtilization { enabled?: boolean; over_period?: string; above_percent?: number; } /** AutoscalingSetGroupAutoscaling. */ interface AutoscalingSetGroupAutoscaling { } /** Backup. */ interface Backup { /** ID of this backup. */ id?: string; /** ID of the deployment this backup relates to. */ deployment_id?: string; /** The type of backup. */ type?: string; /** The status of this backup. */ status?: string; /** Is this backup available to download?. */ is_downloadable?: boolean; /** Can this backup be used to restore an instance?. */ is_restorable?: boolean; /** Date and time when this backup was created. */ created_at?: string; } /** Backups. */ interface Backups { backups?: Backup[]; } /** ChangeUserPasswordResponse. */ interface ChangeUserPasswordResponse { task?: Task; } /** Connection. */ interface Connection { connection: ConnectionConnection; } /** CLI Connection. */ interface ConnectionCLI { /** Type of connection being described. */ type?: string; composed?: string[]; /** A map of environment variables for a CLI connection. */ environment?: JsonObject; /** The name of the executable the CLI should run. */ bin?: string; /** Sets of arguments to call the executable with. The outer array corresponds to a possible way to call the * CLI; the inner array is the set of arguments to use with that call. */ arguments?: string[][]; certificate?: ConnectionCLICertificate; } /** ConnectionCLICertificate. */ interface ConnectionCLICertificate { /** Name associated with the certificate. */ name?: string; /** Base64 encoded version of the certificate. */ certificate_base64?: string; } /** ConnectionConnection. */ interface ConnectionConnection { } /** CreateDatabaseUserRequestUser. */ interface CreateDatabaseUserRequestUser { /** User type for new user. */ user_type?: string; /** Username for new user. */ username?: string; /** Password for new user. */ password?: string; } /** CreateDatabaseUserResponse. */ interface CreateDatabaseUserResponse { task?: Task; } /** DeleteAllowlistEntryResponse. */ interface DeleteAllowlistEntryResponse { task?: Task; } /** DeleteDatabaseUserResponse. */ interface DeleteDatabaseUserResponse { task?: Task; } /** Deployable databases with their version information. */ interface Deployables { /** Deployment type - typically the name of the database. */ type?: string; /** An array of versions of the database, their status, preferedness, and transitions. */ versions?: DeployablesVersionsItem[]; } /** DeployablesVersionsItem. */ interface DeployablesVersionsItem { /** The version number. */ version?: string; /** The status of this version: To be finalized. */ status?: string; /** Should this version be preferred over others?. */ is_preferred?: boolean; /** versions that this version can be upgraded to. */ transitions?: DeployablesVersionsItemTransitionsItem[]; } /** DeployablesVersionsItemTransitionsItem. */ interface DeployablesVersionsItemTransitionsItem { /** The database type. */ application?: string; /** method of going from from_version to to_version. */ method?: string; /** The version the transition in from. */ from_version?: string; /** The version the transition is to. */ to_version?: string; } /** Deployment. */ interface Deployment { /** ID of this deployment. */ id?: string; /** Readable name of this deployment. */ name?: string; /** Database type within this deployment. */ type?: string; /** Platform-specific options for this deployment. */ platform_options?: JsonObject; /** Version number of the database. */ version?: string; /** Login name of administration level user. */ admin_usernames?: JsonObject; /** Whether access to this deployment is enabled from the public internet. This property can be modified by * updating this service instance through the Resource Controller API. */ enable_public_endpoints?: boolean; /** Whether access to this deployment is enabled from IBM Cloud via the IBM Cloud backbone network. This * property can be modified by updating this service instance through the Resource Controller API. */ enable_private_endpoints?: boolean; } /** ElasticsearchConnectionHTTPS. */ interface ElasticsearchConnectionHTTPS { /** Type of connection being described. */ type?: string; composed?: string[]; /** Scheme/protocol for URI connection. */ scheme?: string; hosts?: ElasticsearchConnectionHTTPSHostsItem[]; /** Path for URI connection. */ path?: string; /** Query options to add to the URI connection. */ query_options?: JsonObject; authentication?: ElasticsearchConnectionHTTPSAuthentication; certificate?: ElasticsearchConnectionHTTPSCertificate; } /** ElasticsearchConnectionHTTPSAuthentication. */ interface ElasticsearchConnectionHTTPSAuthentication { /** Authentication method for this credential. */ method?: string; /** Username part of credential. */ username?: string; /** Password part of credential. */ password?: string; } /** ElasticsearchConnectionHTTPSCertificate. */ interface ElasticsearchConnectionHTTPSCertificate { /** Name associated with the certificate. */ name?: string; /** Base64 encoded version of the certificate. */ certificate_base64?: string; } /** ElasticsearchConnectionHTTPSHostsItem. */ interface ElasticsearchConnectionHTTPSHostsItem { /** Hostname for connection. */ hostname?: string; /** Port number for connection. */ port?: number; } /** GRPCConnectionURI. */ interface GRPCConnectionURI { /** Type of connection being described. */ type?: string; composed?: string[]; /** Scheme/protocol for URI connection. */ scheme?: string; hosts?: GRPCConnectionURIHostsItem[]; /** Path for URI connection. */ path?: string; /** Query options to add to the URI connection. */ query_options?: JsonObject; authentication?: GRPCConnectionURIAuthentication; certificate?: GRPCConnectionURICertificate; } /** GRPCConnectionURIAuthentication. */ interface GRPCConnectionURIAuthentication { /** Authentication method for this credential. */ method?: string; /** Username part of credential. */ username?: string; /** Password part of credential. */ password?: string; } /** GRPCConnectionURICertificate. */ interface GRPCConnectionURICertificate { /** Name associated with the certificate. */ name?: string; /** Base64 encoded version of the certificate. */ certificate_base64?: string; } /** GRPCConnectionURIHostsItem. */ interface GRPCConnectionURIHostsItem { /** Hostname for connection. */ hostname?: string; /** Port number for connection. */ port?: number; } /** GetBackupInfoResponse. */ interface GetBackupInfoResponse { backup?: Backup; } /** GetDeploymentInfoResponse. */ interface GetDeploymentInfoResponse { deployment?: Deployment; } /** GetTaskResponse. */ interface GetTaskResponse { task?: Task; } /** Group. */ interface Group { /** Id/name for group. */ id?: string; /** Number of entities in the group. */ count?: number; members?: GroupMembers; memory?: GroupMemory; cpu?: GroupCpu; disk?: GroupDisk; } /** GroupCpu. */ interface GroupCpu { /** Units used for scaling cpu - count means the value is the number of the unit(s) available. */ units?: string; /** Number of allocated CPUs. */ allocation_count?: number; /** Minimum number of CPUs. */ minimum_count?: number; /** Maximum number of CPUs. */ maximum_count?: number; /** Step size CPUs can be adjusted. */ step_size_count?: number; /** Is this group's CPU count adjustable. */ is_adjustable?: boolean; /** Is this group's CPU optional?. */ is_optional?: boolean; /** Can this group's CPU scale down?. */ can_scale_down?: boolean; } /** GroupDisk. */ interface GroupDisk { /** Units used for scaling storage. */ units?: string; /** Allocated storage in MB. */ allocation_mb?: number; /** Minimum allocated storage. */ minimum_mb?: number; /** Maximum allocated storage. */ maximum_mb?: number; /** Step size storage can be adjusted. */ step_size_mb?: number; /** Is this group's storage adjustable?. */ is_adjustable?: boolean; /** Is this group's storage optional?. */ is_optional?: boolean; /** Can this group's storage scale down?. */ can_scale_down?: boolean; } /** GroupMembers. */ interface GroupMembers { /** Units used for scaling number of members. */ units?: string; /** Allocated number of members. */ allocation_count?: number; /** Minimum number of members. */ minimum_count?: number; /** Maximum number of members. */ maximum_count?: number; /** Step size for number of members. */ step_size_count?: number; /** Is this deployment's number of members adjustable?. */ is_adjustable?: boolean; /** Is this deployments's number of members optional?. */ is_optional?: boolean; /** Can this deployment's number of members scale down?. */ can_scale_down?: boolean; } /** GroupMemory. */ interface GroupMemory { /** Units used for scaling memory. */ units?: string; /** Allocated memory in MB. */ allocation_mb?: number; /** Minimum memory in MB. */ minimum_mb?: number; /** Maximum memory in MB. */ maximum_mb?: number; /** Step size memory can be adjusted by in MB. */ step_size_mb?: number; /** Is this group's memory adjustable?. */ is_adjustable?: boolean; /** Is this group's memory optional?. */ is_optional?: boolean; /** Can this group's memory scale down?. */ can_scale_down?: boolean; } /** Groups. */ interface Groups { groups?: Group[]; } /** KillConnectionsResponse. */ interface KillConnectionsResponse { task?: Task; } /** ListDeployablesResponse. */ interface ListDeployablesResponse { deployables?: Deployables[]; } /** ListRegionsResponse. */ interface ListRegionsResponse { /** An array of region ids. */ regions?: string[]; } /** ListRemotesResponse. */ interface ListRemotesResponse { /** Remotes. */ remotes?: Remotes; } /** MongoDBConnectionURI. */ interface MongoDBConnectionURI { /** Type of connection being described. */ type?: string; composed?: string[]; /** Scheme/protocol for URI connection. */ scheme?: string; hosts?: MongoDBConnectionURIHostsItem[]; /** Path for URI connection. */ path?: string; /** Query options to add to the URI connection. */ query_options?: JsonObject; authentication?: MongoDBConnectionURIAuthentication; certificate?: MongoDBConnectionURICertificate; /** Name of the database to use in the URI connection. */ database?: string; /** Name of the replica set to use in the URI connection. */ replica_set?: string; } /** MongoDBConnectionURIAuthentication. */ interface MongoDBConnectionURIAuthentication { /** Authentication method for this credential. */ method?: string; /** Username part of credential. */ username?: string; /** Password part of credential. */ password?: string; } /** MongoDBConnectionURICertificate. */ interface MongoDBConnectionURICertificate { /** Name associated with the certificate. */ name?: string; /** Base64 encoded version of the certificate. */ certificate_base64?: string; } /** MongoDBConnectionURIHostsItem. */ interface MongoDBConnectionURIHostsItem { /** Hostname for connection. */ hostname?: string; /** Port number for connection. */ port?: number; } /** PointInTimeRecoveryData. */ interface PointInTimeRecoveryData { earliest_point_in_time_recovery_time?: string; } /** PostgreSQLConnectionURI. */ interface PostgreSQLConnectionURI { /** Type of connection being described. */ type?: string; composed?: string[]; /** Scheme/protocol for URI connection. */ scheme?: string; hosts?: PostgreSQLConnectionURIHostsItem[]; /** Path for URI connection. */ path?: string; /** Query options to add to the URI connection. */ query_options?: JsonObject; authentication?: PostgreSQLConnectionURIAuthentication; certificate?: PostgreSQLConnectionURICertificate; /** Name of the database to use in the URI connection. */ database?: string; } /** PostgreSQLConnectionURIAuthentication. */ interface PostgreSQLConnectionURIAuthentication { /** Authentication method for this credential. */ method?: string; /** Username part of credential. */ username?: string; /** Password part of credential. */ password?: string; } /** PostgreSQLConnectionURICertificate. */ interface PostgreSQLConnectionURICertificate { /** Name associated with the certificate. */ name?: string; /** Base64 encoded version of the certificate. */ certificate_base64?: string; } /** PostgreSQLConnectionURIHostsItem. */ interface PostgreSQLConnectionURIHostsItem { /** Hostname for connection. */ hostname?: string; /** Port number for connection. */ port?: number; } /** RabbitMQConnectionAMQPS. */ interface RabbitMQConnectionAMQPS { /** Type of connection being described. */ type?: string; composed?: string[]; /** Scheme/protocol for URI connection. */ scheme?: string; hosts?: RabbitMQConnectionAMQPSHostsItem[]; /** Path for URI connection. */ path?: string; /** Query options to add to the URI connection. */ query_options?: JsonObject; authentication?: RabbitMQConnectionAMQPSAuthentication; certificate?: RabbitMQConnectionAMQPSCertificate; } /** RabbitMQConnectionAMQPSAuthentication. */ interface RabbitMQConnectionAMQPSAuthentication { /** Authentication method for this credential. */ method?: string; /** Username part of credential. */ username?: string; /** Password part of credential. */ password?: string; } /** RabbitMQConnectionAMQPSCertificate. */ interface RabbitMQConnectionAMQPSCertificate { /** Name associated with the certificate. */ name?: string; /** Base64 encoded version of the certificate. */ certificate_base64?: string; } /** RabbitMQConnectionAMQPSHostsItem. */ interface RabbitMQConnectionAMQPSHostsItem { /** Hostname for connection. */ hostname?: string; /** Port number for connection. */ port?: number; } /** RabbitMQConnectionHTTPS. */ interface RabbitMQConnectionHTTPS { /** Type of connection being described. */ type?: string; composed?: string[]; /** Scheme/protocol for URI connection. */ scheme?: string; hosts?: RabbitMQConnectionHTTPSHostsItem[]; /** Path for URI connection. */ path?: string; /** Query options to add to the URI connection. */ query_options?: JsonObject; authentication?: RabbitMQConnectionHTTPSAuthentication; certificate?: RabbitMQConnectionHTTPSCertificate; /** Indicates the address is accessible by browser, for the RabbitMQ Management UI. */ browser_accessible?: boolean; } /** RabbitMQConnectionHTTPSAuthentication. */ interface RabbitMQConnectionHTTPSAuthentication { /** Authentication method for this credential. */ method?: string; /** Username part of credential. */ username?: string; /** Password part of credential. */ password?: string; } /** RabbitMQConnectionHTTPSCertificate. */ interface RabbitMQConnectionHTTPSCertificate { /** Name associated with the certificate. */ name?: string; /** Base64 encoded version of the certificate. */ certificate_base64?: string; } /** RabbitMQConnectionHTTPSHostsItem. */ interface RabbitMQConnectionHTTPSHostsItem { /** Hostname for connection. */ hostname?: string; /** Port number for connection. */ port?: number; } /** RabbitMQConnectionMQTTS. */ interface RabbitMQConnectionMQTTS { /** Type of connection being described. */ type?: string; composed?: string[]; /** Scheme/protocol for URI connection. */ scheme?: string; hosts?: RabbitMQConnectionMQTTSHostsItem[]; /** Path for URI connection. */ path?: string; /** Query options to add to the URI connection. */ query_options?: JsonObject; authentication?: RabbitMQConnectionMQTTSAuthentication; certificate?: RabbitMQConnectionMQTTSCertificate; } /** RabbitMQConnectionMQTTSAuthentication. */ interface RabbitMQConnectionMQTTSAuthentication { /** Authentication method for this credential. */ method?: string; /** Username part of credential. */ username?: string; /** Password part of credential. */ password?: string; } /** RabbitMQConnectionMQTTSCertificate. */ interface RabbitMQConnectionMQTTSCertificate { /** Name associated with the certificate. */ name?: string; /** Base64 encoded version of the certificate. */ certificate_base64?: string; } /** RabbitMQConnectionMQTTSHostsItem. */ interface RabbitMQConnectionMQTTSHostsItem { /** Hostname for connection. */ hostname?: string; /** Port number for connection. */ port?: number; } /** RabbitMQConnectionStompSSL. */ interface RabbitMQConnectionStompSSL { /** Type of connection being described. */ type?: string; composed?: string[]; hosts?: RabbitMQConnectionStompSSLHostsItem[]; authentication?: RabbitMQConnectionStompSSLAuthentication; certificate?: RabbitMQConnectionStompSSLCertificate; /** Indicates ssl is required for the connection. */ ssl?: boolean; } /** RabbitMQConnectionStompSSLAuthentication. */ interface RabbitMQConnectionStompSSLAuthentication { /** Authentication method for this credential. */ method?: string; /** Username part of credential. */ username?: string; /** Password part of credential. */ password?: string; } /** RabbitMQConnectionStompSSLCertificate. */ interface RabbitMQConnectionStompSSLCertificate { /** Name associated with the certificate. */ name?: string; /** Base64 encoded version of the certificate. */ certificate_base64?: string; } /** RabbitMQConnectionStompSSLHostsItem. */ interface RabbitMQConnectionStompSSLHostsItem { /** Hostname for connection. */ hostname?: string; /** Port number for connection. */ port?: number; } /** RedisConnectionURI. */ interface RedisConnectionURI { /** Type of connection being described. */ type?: string; composed?: string[]; /** Scheme/protocol for URI connection. */ scheme?: string; hosts?: RedisConnectionURIHostsItem[]; /** Path for URI connection. */ path?: string; /** Query options to add to the URI connection. */ query_options?: JsonObject; authentication?: RedisConnectionURIAuthentication; certificate?: RedisConnectionURICertificate; /** Number of the database to use in the URI connection. */ database?: number; } /** RedisConnectionURIAuthentication. */ interface RedisConnectionURIAuthentication { /** Authentication method for this credential. */ method?: string; /** Username part of credential. */ username?: string; /** Password part of credential. */ password?: string; } /** RedisConnectionURICertificate. */ interface RedisConnectionURICertificate { /** Name associated with the certificate. */ name?: string; /** Base64 encoded version of the certificate. */ certificate_base64?: string; } /** RedisConnectionURIHostsItem. */ interface RedisConnectionURIHostsItem { /** Hostname for connection. */ hostname?: string; /** Port number for connection. */ port?: number; } /** Remotes. */ interface Remotes { /** Leader ID, if applicable. */ leader?: string; /** Replica IDs, if applicable. */ replicas?: string[]; } /** ResyncReplicaResponse. */ interface ResyncReplicaResponse { task?: Task; } /** SetAllowlistResponse. */ interface SetAllowlistResponse { task?: Task; } /** SetAutoscalingConditionsResponse. */ interface SetAutoscalingConditionsResponse { task?: Task; } /** SetCPUGroupCPU. */ interface SetCPUGroupCPU { /** Number of allocated CPUs. */ allocation_count?: number; } /** SetConfigurationConfiguration. */ interface SetConfigurationConfiguration { } /** SetDeploymentScalingGroupRequest. */ interface SetDeploymentScalingGroupRequest { } /** SetDeploymentScalingGroupResponse. */ interface SetDeploymentScalingGroupResponse { task?: Task; } /** SetDiskGroupDisk. */ interface SetDiskGroupDisk { /** Allocated storage in MB. */ allocation_mb?: number; } /** SetMembersGroupMembers. */ interface SetMembersGroupMembers { /** Allocated number of members. */ allocation_count?: number; } /** SetMemoryGroupMemory. */ interface SetMemoryGroupMemory { /** Allocated memory in MB. */ allocation_mb?: number; } /** SetPromotionPromotion. */ interface SetPromotionPromotion { } /** SetPromotionResponse. */ interface SetPromotionResponse { task?: Task; } /** StartOndemandBackupResponse. */ interface StartOndemandBackupResponse { task?: Task; } /** Task. */ interface Task { /** ID of the task. */ id?: string; /** Human-readable description of the task. */ description?: string; /** The status of the task. */ status?: string; /** ID of the deployment the task is being performed on. */ deployment_id?: string; /** Indicator as percentage of progress of the task. */ progress_percent?: number; /** Date and time when the task was created. */ created_at?: string; } /** Tasks. */ interface Tasks { tasks?: Task[]; } /** UpdateDatabaseConfigurationResponse. */ interface UpdateDatabaseConfigurationResponse { task?: Task; } /** AutoscalingSetGroupAutoscalingAutoscalingCPUGroup. */ interface AutoscalingSetGroupAutoscalingAutoscalingCPUGroup extends AutoscalingSetGroupAutoscaling { cpu?: AutoscalingCPUGroupCPU; } /** AutoscalingSetGroupAutoscalingAutoscalingDiskGroup. */ interface AutoscalingSetGroupAutoscalingAutoscalingDiskGroup extends AutoscalingSetGroupAutoscaling { disk?: AutoscalingDiskGroupDisk; } /** AutoscalingSetGroupAutoscalingAutoscalingMemoryGroup. */ interface AutoscalingSetGroupAutoscalingAutoscalingMemoryGroup extends AutoscalingSetGroupAutoscaling { memory?: AutoscalingMemoryGroupMemory; } /** Elasticsearch Connection Strings. */ interface ConnectionConnectionElasticsearchConnection extends ConnectionConnection { /** Elasticsearch Connection information for drivers and libraries. */ https: ElasticsearchConnectionHTTPS; /** Connection information for cURL. */ cli: ConnectionCLI; } /** etcd3 Connection Strings. */ interface ConnectionConnectionEtcdConnection extends ConnectionConnection { /** GRPC(etcd3) Connection information for drivers and libraries. */ grpc: GRPCConnectionURI; /** Connection information for etcdctl. */ cli: ConnectionCLI; } /** MongoDB Connection Strings. */ interface ConnectionConnectionMongoDBConnection extends ConnectionConnection { /** MongoDB Connection information for drivers and libraries. */ mongodb: MongoDBConnectionURI; /** Connection information for mongo shell. */ cli: ConnectionCLI; } /** PostgreSQL and EnterpriseDB Connection Strings. */ interface ConnectionConnectionPostgreSQLConnection extends ConnectionConnection { /** Connection information for drivers and libraries. */ postgres: PostgreSQLConnectionURI; /** Connection information for psql. */ cli: ConnectionCLI; } /** RabbitMQ Connection Strings. */ interface ConnectionConnectionRabbitMQConnection extends ConnectionConnection { /** RabbitMQ Connection information for AMQPS drivers and libraries. */ amqps: RabbitMQConnectionAMQPS; /** RabbitMQ Connection information for MQTTS drivers and libraries. */ mqtts: RabbitMQConnectionMQTTS; /** RabbitMQ Connection information for STOMP drivers and libraries. */ stomp_ssl: RabbitMQConnectionStompSSL; /** RabbitMQ Connection information for HTTPS. */ https: RabbitMQConnectionHTTPS; /** Connection information for rabbitmqadmin. */ cli: ConnectionCLI; } /** Redis Connection Strings. */ interface ConnectionConnectionRedisConnection extends ConnectionConnection { /** Connection information for drivers and libraries. */ rediss: RedisConnectionURI; /** Connection information for a Redis CLI client. */ cli: ConnectionCLI; } /** PostgreSQL and EnterpriseDB Configuration. */ interface SetConfigurationConfigurationPGConfiguration extends SetConfigurationConfiguration { /** Maximum connections allowed. */ max_connections?: number; /** Max number of transactions that can be in the "prepared" state simultaneously. */ max_prepared_transactions?: number; /** Deadlock timeout in ms. The time to wait on a lock before checking for deadlock. Also the duration where * lock waits will be logged. */ deadlock_timeout?: number; /** Number of simultaneous requests that can be handled efficiently by the disk subsystem. */ effective_io_concurrency?: number; /** Maximum number of simultaneously defined replication slots. */ max_replication_slots?: number; /** Maximum number of simultaneously running WAL sender processes. */ max_wal_senders?: number; /** The number of 8kB shared memory buffers used by the server. Set to 1/4 of memory. Setting too high will * cause crashes or prevent the database from starting. */ shared_buffers?: number; /** Sets the current transaction's synchronization level. Off can result in data loss. remote_write with * enable synchronous replication which will impact performance and availabilty. */ synchronous_commit?: string; /** WAL level. Set to logical to use logical decoding or logical replication. */ wal_level?: string; /** The number of seconds to wait before forces a switch to the next WAL file if a new file has not been * started. */ archive_timeout?: number; /** The minimum number of milliseconds for execution time above which statements will be logged. */ log_min_duration_statement?: number; } /** Redis Configuration. */ interface SetConfigurationConfigurationRedisConfiguration extends SetConfigurationConfiguration { /** The maximum memory Redis should use, as bytes. */ 'maxmemory-redis'?: number; /** The policy with which Redis evicts keys when maximum memory is reached. */ 'maxmemory-policy'?: string; /** If set to yes this will enable AOF persistence. */ appendonly?: string; /** The maximum memory Redis should use, as bytes. */ 'maxmemory-samples'?: number; /** Whether or not to stop accepting writes when background persistence actions fail. */ 'stop-writes-on-bgsave-error'?: string; } /** SetDeploymentScalingGroupRequestSetCPUGroup. */ interface SetDeploymentScalingGroupRequestSetCPUGroup extends SetDeploymentScalingGroupRequest { cpu?: SetCPUGroupCPU; } /** SetDeploymentScalingGroupRequestSetDiskGroup. */ interface SetDeploymentScalingGroupRequestSetDiskGroup extends SetDeploymentScalingGroupRequest { disk?: SetDiskGroupDisk; } /** SetDeploymentScalingGroupRequestSetMembersGroup. */ interface SetDeploymentScalingGroupRequestSetMembersGroup extends SetDeploymentScalingGroupRequest { members?: SetMembersGroupMembers; } /** SetDeploymentScalingGroupRequestSetMemoryGroup. */ interface SetDeploymentScalingGroupRequestSetMemoryGroup extends SetDeploymentScalingGroupRequest { memory?: SetMemoryGroupMemory; } /** Promotes a read-only replica to a full deployment. */ interface SetPromotionPromotionPromote extends SetPromotionPromotion { /** Promotion options. */ promotion?: JsonObject; } /** Promotes a read-only replica to a full deployment running a new database version. */ interface SetPromotionPromotionUpgradePromote extends SetPromotionPromotion { /** Promotion and Upgrade options. */ promotion?: JsonObject; } } export = CloudDatabasesV5;