scaleway.document_db.v1beta1 package

Submodules

scaleway.document_db.v1beta1.api module

class scaleway.document_db.v1beta1.api.DocumentDbV1Beta1API(client: Client, *, bypass_validation: bool = False)

Bases: API

This API allows you to manage your Document Databases.

add_instance_acl_rules(*, instance_id: str, rules: List[ACLRuleRequest], region: Optional[str] = None) → AddInstanceACLRulesResponse

Add an ACL rule to a Database Instance. Add an additional ACL rule to a Database Instance. :param instance_id: UUID of the Database Instance you want to add ACL rules to. :param rules: ACL rules to add to the Database Instance. :param region: Region to target. If none is passed will use default region from the config. :return: AddInstanceACLRulesResponse

Usage:

result = api.add_instance_acl_rules(
    instance_id="example",
    rules=[],
)

add_instance_settings(*, instance_id: str, settings: List[InstanceSetting], region: Optional[str] = None) → 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. :param instance_id: UUID of the Database Instance you want to add settings to. :param settings: Settings to add to the Database Instance. :param region: Region to target. If none is passed will use default region from the config. :return: AddInstanceSettingsResponse

Usage:

result = api.add_instance_settings(
    instance_id="example",
    settings=[],
)

apply_instance_maintenance(*, instance_id: str, region: Optional[str] = None) → Maintenance

Apply an instance maintenance. Apply a pending instance maintenance on your instance. This action can generate some service interruption. :param instance_id: UUID of the Database Instance to which you want to apply maintenance. :param region: Region to target. If none is passed will use default region from the config. :return: Maintenance

Usage:

result = api.apply_instance_maintenance(
    instance_id="example",
)

clone_instance(*, instance_id: str, name: str, region: Optional[str] = None, node_type: Optional[str] = None) → 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. :param instance_id: UUID of the Database Instance you want to clone. :param name: Name of the Database Instance clone. :param region: Region to target. If none is passed will use default region from the config. :param node_type: Node type of the clone. :return: Instance

Usage:

result = api.clone_instance(
    instance_id="example",
    name="example",
)

create_database(*, instance_id: str, name: str, region: Optional[str] = None) → Database

Create a database in a Database Instance. Create a new database. You must define the name parameter in the request. :param instance_id: UUID of the Database Instance where to create the database. :param name: Name of the database. :param region: Region to target. If none is passed will use default region from the config. :return: Database

Usage:

result = api.create_database(
    instance_id="example",
    name="example",
)

create_endpoint(*, instance_id: str, region: Optional[str] = None, endpoint_spec: Optional[EndpointSpec] = None) → 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. :param instance_id: UUID of the Database Instance you to which you want to add an endpoint. :param region: Region to target. If none is passed will use default region from the config. :param endpoint_spec: Specification of the endpoint you want to create. :return: Endpoint

Usage:

result = api.create_endpoint(
    instance_id="example",
)

create_instance(*, engine: str, user_name: str, password: str, node_type: str, region: Optional[str] = None, organization_id: Optional[str] = None, project_id: Optional[str] = None, name: Optional[str] = None, is_ha_cluster: bool, disable_backup: bool, volume_size: int, backup_same_region: bool, tags: Optional[List[str]] = None, init_settings: Optional[List[InstanceSetting]] = None, volume_type: Optional[VolumeType] = None, init_endpoints: Optional[List[EndpointSpec]] = None) → 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. :param engine: Database engine of the Database Instance. :param user_name: Username created when the Database Instance is created. :param password: Password of the user. :param node_type: Type of node to use for the Database Instance. :param region: Region to target. If none is passed will use default region from the config. :param organization_id: Please use project_id instead. One-Of (‘project_identifier’): at most one of ‘organization_id’, ‘project_id’ could be set. :param project_id: The Project ID on which the Database Instance will be created. One-Of (‘project_identifier’): at most one of ‘organization_id’, ‘project_id’ could be set. :param name: Name of the Database Instance. :param is_ha_cluster: Defines whether or not High-Availability is enabled. :param disable_backup: Defines whether or not backups are disabled. :param volume_size: Volume size when volume_type is not lssd. :param backup_same_region: Defines whether to or not to store logical backups in the same region as the Database Instance. :param tags: Tags to apply to the Database Instance. :param init_settings: List of engine settings to be set upon Database Instance initialization. :param volume_type: Type of volume where data is stored (lssd, bssd, …). :param init_endpoints: One or multiple EndpointSpec used to expose your Database Instance. A load_balancer public endpoint is systematically created. :return: Instance

Usage:

result = api.create_instance(
    engine="example",
    user_name="example",
    password="example",
    node_type="example",
    is_ha_cluster=False,
    disable_backup=False,
    volume_size=1,
    backup_same_region=False,
)

create_instance_from_snapshot(*, snapshot_id: str, instance_name: str, region: Optional[str] = None, is_ha_cluster: Optional[bool] = None, node_type: Optional[str] = None) → 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. :param snapshot_id: Block snapshot of the Database Instance. :param instance_name: Name of the Database Instance created with the snapshot. :param region: Region to target. If none is passed will use default region from the config. :param is_ha_cluster: Defines whether or not High Availability is enabled on the new Database Instance. :param node_type: The node type used to restore the snapshot. :return: Instance

Usage:

result = api.create_instance_from_snapshot(
    snapshot_id="example",
    instance_name="example",
)

create_read_replica(*, instance_id: str, region: Optional[str] = None, endpoint_spec: Optional[List[ReadReplicaEndpointSpec]] = None, same_zone: Optional[bool] = None) → 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. :param instance_id: UUID of the Database Instance you want to create a Read Replica from. :param region: Region to target. If none is passed will use default region from the config. :param endpoint_spec: Specification of the endpoint you want to create. :param same_zone: Defines whether or not to create the replica in the same Availability Zone as the main Database Instance nodes. :return: ReadReplica

Usage:

result = api.create_read_replica(
    instance_id="example",
)

create_read_replica_endpoint(*, read_replica_id: str, endpoint_spec: List[ReadReplicaEndpointSpec], region: Optional[str] = None) → 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. :param read_replica_id: UUID of the Read Replica. :param endpoint_spec: Specification of the endpoint you want to create. :param region: Region to target. If none is passed will use default region from the config. :return: ReadReplica

Usage:

result = api.create_read_replica_endpoint(
    read_replica_id="example",
    endpoint_spec=[],
)

create_snapshot(*, instance_id: str, region: Optional[str] = None, name: Optional[str] = None, expires_at: Optional[datetime] = None) → Snapshot

Create a Database Instance snapshot. Create a new snapshot of a Database Instance. You must define the name parameter in the request. :param instance_id: UUID of the Database Instance. :param region: Region to target. If none is passed will use default region from the config. :param name: Name of the snapshot. :param expires_at: Expiration date (must follow the ISO 8601 format). :return: Snapshot

Usage:

result = api.create_snapshot(
    instance_id="example",
)

create_user(*, instance_id: str, name: str, password: str, is_admin: bool, region: Optional[str] = None) → 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. :param instance_id: UUID of the Database Instance in which you want to create a user. :param name: Name of the user you want to create. :param password: Password of the user you want to create. :param is_admin: Defines whether the user will have administrative privileges. :param region: Region to target. If none is passed will use default region from the config. :return: User

Usage:

result = api.create_user(
    instance_id="example",
    name="example",
    password="example",
    is_admin=False,
)

delete_database(*, instance_id: str, name: str, region: Optional[str] = None) → None

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. :param instance_id: UUID of the Database Instance where to delete the database. :param name: Name of the database to delete. :param region: Region to target. If none is passed will use default region from the config.

Usage:

result = api.delete_database(
    instance_id="example",
    name="example",
)

delete_endpoint(*, endpoint_id: str, region: Optional[str] = None) → None

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. :param endpoint_id: This endpoint can also be used to delete a Read Replica endpoint. :param region: Region to target. If none is passed will use default region from the config.

Usage:

result = api.delete_endpoint(
    endpoint_id="example",
)

delete_instance(*, instance_id: str, region: Optional[str] = None) → 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. :param instance_id: UUID of the Database Instance to delete. :param region: Region to target. If none is passed will use default region from the config. :return: Instance

Usage:

result = api.delete_instance(
    instance_id="example",
)

delete_instance_acl_rules(*, instance_id: str, acl_rule_ips: List[str], region: Optional[str] = None) → DeleteInstanceACLRulesResponse

Delete ACL rules of a Database Instance. Delete one or more ACL rules of a Database Instance. :param instance_id: UUID of the Database Instance you want to delete an ACL rule from. :param acl_rule_ips: IP addresses defined in the ACL rules of the Database Instance. :param region: Region to target. If none is passed will use default region from the config. :return: DeleteInstanceACLRulesResponse

Usage:

result = api.delete_instance_acl_rules(
    instance_id="example",
    acl_rule_ips=[],
)

delete_instance_settings(*, instance_id: str, setting_names: List[str], region: Optional[str] = None) → 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. :param instance_id: UUID of the Database Instance to delete settings from. :param setting_names: Settings names to delete. :param region: Region to target. If none is passed will use default region from the config. :return: DeleteInstanceSettingsResponse

Usage:

result = api.delete_instance_settings(
    instance_id="example",
    setting_names=[],
)

delete_read_replica(*, read_replica_id: str, region: Optional[str] = None) → 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. :param read_replica_id: UUID of the Read Replica. :param region: Region to target. If none is passed will use default region from the config. :return: ReadReplica

Usage:

result = api.delete_read_replica(
    read_replica_id="example",
)

delete_snapshot(*, snapshot_id: str, region: Optional[str] = None) → 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. :param snapshot_id: UUID of the snapshot to delete. :param region: Region to target. If none is passed will use default region from the config. :return: Snapshot

Usage:

result = api.delete_snapshot(
    snapshot_id="example",
)

delete_user(*, instance_id: str, name: str, region: Optional[str] = None) → None

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. :param instance_id: UUID of the Database Instance to delete the user from. :param name: Name of the user. :param region: Region to target. If none is passed will use default region from the config.

Usage:

result = api.delete_user(
    instance_id="example",
    name="example",
)

get_endpoint(*, endpoint_id: str, region: Optional[str] = None) → 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. :param endpoint_id: UUID of the endpoint you want to get. :param region: Region to target. If none is passed will use default region from the config. :return: Endpoint

Usage:

result = api.get_endpoint(
    endpoint_id="example",
)

get_instance(*, instance_id: str, region: Optional[str] = None) → 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. :param instance_id: UUID of the Database Instance. :param region: Region to target. If none is passed will use default region from the config. :return: Instance

Usage:

result = api.get_instance(
    instance_id="example",
)

get_instance_certificate(*, instance_id: str, region: Optional[str] = None) → ScwFile

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. :param instance_id: UUID of the Database Instance. :param region: Region to target. If none is passed will use default region from the config. :return: ScwFile

Usage:

result = api.get_instance_certificate(
    instance_id="example",
)

get_instance_log(*, instance_log_id: str, region: Optional[str] = None) → 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. :param instance_log_id: UUID of the instance_log you want. :param region: Region to target. If none is passed will use default region from the config. :return: InstanceLog

Usage:

result = api.get_instance_log(
    instance_log_id="example",
)

get_instance_metrics(*, instance_id: str, region: Optional[str] = None, start_date: Optional[datetime] = None, end_date: Optional[datetime] = None, metric_name: Optional[str] = None) → 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. :param instance_id: UUID of the Database Instance. :param region: Region to target. If none is passed will use default region from the config. :param start_date: Start date to gather metrics from. :param end_date: End date to gather metrics from. :param metric_name: Name of the metric to gather. :return: InstanceMetrics

Usage:

result = api.get_instance_metrics(
    instance_id="example",
)

get_read_replica(*, read_replica_id: str, region: Optional[str] = None) → 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. :param read_replica_id: UUID of the Read Replica. :param region: Region to target. If none is passed will use default region from the config. :return: ReadReplica

Usage:

result = api.get_read_replica(
    read_replica_id="example",
)

get_snapshot(*, snapshot_id: str, region: Optional[str] = None) → 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. :param snapshot_id: UUID of the snapshot. :param region: Region to target. If none is passed will use default region from the config. :return: Snapshot

Usage:

result = api.get_snapshot(
    snapshot_id="example",
)

list_database_engines(*, region: Optional[str] = None, name: Optional[str] = None, version: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None) → ListDatabaseEnginesResponse

List available database engines. List the FerretDB database engines available at Scaleway. :param region: Region to target. If none is passed will use default region from the config. :param name: Name of the database engine. :param version: Version of the database engine. :param page: :param page_size: :return: ListDatabaseEnginesResponse

Usage:

result = api.list_database_engines()

list_database_engines_all(*, region: Optional[str] = None, name: Optional[str] = None, version: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None) → List[DatabaseEngine]

List available database engines. List the FerretDB database engines available at Scaleway. :param region: Region to target. If none is passed will use default region from the config. :param name: Name of the database engine. :param version: Version of the database engine. :param page: :param page_size: :return: List[DatabaseEngine]

Usage:

result = api.list_database_engines_all()

list_databases(*, instance_id: str, region: Optional[str] = None, name: Optional[str] = None, managed: Optional[bool] = None, owner: Optional[str] = None, order_by: Optional[ListDatabasesRequestOrderBy] = None, page: Optional[int] = None, page_size: Optional[int] = None) → ListDatabasesResponse

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. :param instance_id: UUID of the Database Instance to list the databases of. :param region: Region to target. If none is passed will use default region from the config. :param name: Name of the database. :param managed: Defines whether or not the database is managed. :param owner: User that owns this database. :param order_by: Criteria to use when ordering database listing. :param page: :param page_size: :return: ListDatabasesResponse

Usage:

result = api.list_databases(
    instance_id="example",
)

list_databases_all(*, instance_id: str, region: Optional[str] = None, name: Optional[str] = None, managed: Optional[bool] = None, owner: Optional[str] = None, order_by: Optional[ListDatabasesRequestOrderBy] = None, page: Optional[int] = None, page_size: Optional[int] = None) → List[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. :param instance_id: UUID of the Database Instance to list the databases of. :param region: Region to target. If none is passed will use default region from the config. :param name: Name of the database. :param managed: Defines whether or not the database is managed. :param owner: User that owns this database. :param order_by: Criteria to use when ordering database listing. :param page: :param page_size: :return: List[Database]

Usage:

result = api.list_databases_all(
    instance_id="example",
)

list_instance_acl_rules(*, instance_id: str, region: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None) → ListInstanceACLRulesResponse

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. :param instance_id: UUID of the Database Instance. :param region: Region to target. If none is passed will use default region from the config. :param page: :param page_size: :return: ListInstanceACLRulesResponse

Usage:

result = api.list_instance_acl_rules(
    instance_id="example",
)

list_instance_acl_rules_all(*, instance_id: str, region: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None) → List[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. :param instance_id: UUID of the Database Instance. :param region: Region to target. If none is passed will use default region from the config. :param page: :param page_size: :return: List[ACLRule]

Usage:

result = api.list_instance_acl_rules_all(
    instance_id="example",
)

list_instance_logs(*, instance_id: str, region: Optional[str] = None, order_by: Optional[ListInstanceLogsRequestOrderBy] = None) → 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. :param instance_id: UUID of the Database Instance you want logs of. :param region: Region to target. If none is passed will use default region from the config. :param order_by: Criteria to use when ordering Database Instance logs listing. :return: ListInstanceLogsResponse

Usage:

result = api.list_instance_logs(
    instance_id="example",
)

list_instance_logs_details(*, instance_id: str, region: Optional[str] = None) → 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. :param instance_id: UUID of the Database Instance you want logs of. :param region: Region to target. If none is passed will use default region from the config. :return: ListInstanceLogsDetailsResponse

Usage:

result = api.list_instance_logs_details(
    instance_id="example",
)

list_instances(*, region: Optional[str] = None, tags: Optional[List[str]] = None, name: Optional[str] = None, order_by: Optional[ListInstancesRequestOrderBy] = None, organization_id: Optional[str] = None, project_id: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None) → ListInstancesResponse

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. :param region: Region to target. If none is passed will use default region from the config. :param tags: List Database Instances that have a given tag. :param name: Lists Database Instances that match a name pattern. :param order_by: Criteria to use when ordering Database Instance listings. :param organization_id: Please use project_id instead. :param project_id: Project ID to list the Database Instance of. :param page: :param page_size: :return: ListInstancesResponse

Usage:

result = api.list_instances()

list_instances_all(*, region: Optional[str] = None, tags: Optional[List[str]] = None, name: Optional[str] = None, order_by: Optional[ListInstancesRequestOrderBy] = None, organization_id: Optional[str] = None, project_id: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None) → List[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. :param region: Region to target. If none is passed will use default region from the config. :param tags: List Database Instances that have a given tag. :param name: Lists Database Instances that match a name pattern. :param order_by: Criteria to use when ordering Database Instance listings. :param organization_id: Please use project_id instead. :param project_id: Project ID to list the Database Instance of. :param page: :param page_size: :return: List[Instance]

Usage:

result = api.list_instances_all()

list_node_types(*, include_disabled_types: bool, region: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None) → ListNodeTypesResponse

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. :param include_disabled_types: Defines whether or not to include disabled types. :param region: Region to target. If none is passed will use default region from the config. :param page: :param page_size: :return: ListNodeTypesResponse

Usage:

result = api.list_node_types(
    include_disabled_types=False,
)

list_node_types_all(*, include_disabled_types: bool, region: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None) → List[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. :param include_disabled_types: Defines whether or not to include disabled types. :param region: Region to target. If none is passed will use default region from the config. :param page: :param page_size: :return: List[NodeType]

Usage:

result = api.list_node_types_all(
    include_disabled_types=False,
)

list_privileges(*, instance_id: str, region: Optional[str] = None, order_by: Optional[ListPrivilegesRequestOrderBy] = None, page: Optional[int] = None, page_size: Optional[int] = None, database_name: Optional[str] = None, user_name: Optional[str] = None) → ListPrivilegesResponse

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. :param instance_id: UUID of the Database Instance. :param region: Region to target. If none is passed will use default region from the config. :param order_by: Criteria to use when ordering privileges listing. :param page: :param page_size: :param database_name: Name of the database. :param user_name: Name of the user. :return: ListPrivilegesResponse

Usage:

result = api.list_privileges(
    instance_id="example",
)

list_privileges_all(*, instance_id: str, region: Optional[str] = None, order_by: Optional[ListPrivilegesRequestOrderBy] = None, page: Optional[int] = None, page_size: Optional[int] = None, database_name: Optional[str] = None, user_name: Optional[str] = None) → List[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. :param instance_id: UUID of the Database Instance. :param region: Region to target. If none is passed will use default region from the config. :param order_by: Criteria to use when ordering privileges listing. :param page: :param page_size: :param database_name: Name of the database. :param user_name: Name of the user. :return: List[Privilege]

Usage:

result = api.list_privileges_all(
    instance_id="example",
)

list_snapshots(*, region: Optional[str] = None, name: Optional[str] = None, order_by: Optional[ListSnapshotsRequestOrderBy] = None, instance_id: Optional[str] = None, organization_id: Optional[str] = None, project_id: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None) → ListSnapshotsResponse

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. :param region: Region to target. If none is passed will use default region from the config. :param name: Name of the snapshot. :param order_by: Criteria to use when ordering snapshot listing. :param instance_id: UUID of the Database Instance. :param organization_id: Organization ID the snapshots belongs to. :param project_id: Project ID the snapshots belongs to. :param page: :param page_size: :return: ListSnapshotsResponse

Usage:

result = api.list_snapshots()

list_snapshots_all(*, region: Optional[str] = None, name: Optional[str] = None, order_by: Optional[ListSnapshotsRequestOrderBy] = None, instance_id: Optional[str] = None, organization_id: Optional[str] = None, project_id: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None) → List[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. :param region: Region to target. If none is passed will use default region from the config. :param name: Name of the snapshot. :param order_by: Criteria to use when ordering snapshot listing. :param instance_id: UUID of the Database Instance. :param organization_id: Organization ID the snapshots belongs to. :param project_id: Project ID the snapshots belongs to. :param page: :param page_size: :return: List[Snapshot]

Usage:

result = api.list_snapshots_all()

list_users(*, instance_id: str, region: Optional[str] = None, name: Optional[str] = None, order_by: Optional[ListUsersRequestOrderBy] = None, page: Optional[int] = None, page_size: Optional[int] = None) → ListUsersResponse

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. :param instance_id: UUID of the Database Instance. :param region: Region to target. If none is passed will use default region from the config. :param name: Name of the user. :param order_by: Criteria to use when requesting user listing. :param page: :param page_size: :return: ListUsersResponse

Usage:

result = api.list_users(
    instance_id="example",
)

list_users_all(*, instance_id: str, region: Optional[str] = None, name: Optional[str] = None, order_by: Optional[ListUsersRequestOrderBy] = None, page: Optional[int] = None, page_size: Optional[int] = None) → List[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. :param instance_id: UUID of the Database Instance. :param region: Region to target. If none is passed will use default region from the config. :param name: Name of the user. :param order_by: Criteria to use when requesting user listing. :param page: :param page_size: :return: List[User]

Usage:

result = api.list_users_all(
    instance_id="example",
)

migrate_endpoint(*, endpoint_id: str, instance_id: str, region: Optional[str] = None) → Endpoint

Migrate Database Instance endpoint. Migrate an existing Database Instance endpoint to another Database Instance. :param endpoint_id: UUID of the endpoint you want to migrate. :param instance_id: UUID of the instance you want to attach the endpoint to. :param region: Region to target. If none is passed will use default region from the config. :return: Endpoint

Usage:

result = api.migrate_endpoint(
    endpoint_id="example",
    instance_id="example",
)

promote_read_replica(*, read_replica_id: str, region: Optional[str] = None) → Instance

Promote a Read Replica. Promote a Read Replica to Database Instance automatically. :param read_replica_id: UUID of the Read Replica. :param region: Region to target. If none is passed will use default region from the config. :return: Instance

Usage:

result = api.promote_read_replica(
    read_replica_id="example",
)

purge_instance_logs(*, instance_id: str, region: Optional[str] = None, log_name: Optional[str] = None) → None

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. :param instance_id: UUID of the Database Instance you want logs of. :param region: Region to target. If none is passed will use default region from the config. :param log_name: Given log name to purge.

Usage:

result = api.purge_instance_logs(
    instance_id="example",
)

renew_instance_certificate(*, instance_id: str, region: Optional[str] = None) → None

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. :param instance_id: UUID of the Database Instance you want logs of. :param region: Region to target. If none is passed will use default region from the config.

Usage:

result = api.renew_instance_certificate(
    instance_id="example",
)

reset_read_replica(*, read_replica_id: str, region: Optional[str] = None) → 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. :param read_replica_id: UUID of the Read Replica. :param region: Region to target. If none is passed will use default region from the config. :return: ReadReplica

Usage:

result = api.reset_read_replica(
    read_replica_id="example",
)

restart_instance(*, instance_id: str, region: Optional[str] = None) → 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. :param instance_id: UUID of the Database Instance you want to restart. :param region: Region to target. If none is passed will use default region from the config. :return: Instance

Usage:

result = api.restart_instance(
    instance_id="example",
)

set_instance_acl_rules(*, instance_id: str, rules: List[ACLRuleRequest], region: Optional[str] = None) → SetInstanceACLRulesResponse

Set ACL rules for a Database Instance. Replace all the ACL rules of a Database Instance. :param instance_id: UUID of the Database Instance where the ACL rules must be set. :param rules: ACL rules to define for the Database Instance. :param region: Region to target. If none is passed will use default region from the config. :return: SetInstanceACLRulesResponse

Usage:

result = api.set_instance_acl_rules(
    instance_id="example",
    rules=[],
)

set_instance_settings(*, instance_id: str, settings: List[InstanceSetting], region: Optional[str] = None) → 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. :param instance_id: UUID of the Database Instance where the settings must be set. :param settings: Settings to define for the Database Instance. :param region: Region to target. If none is passed will use default region from the config. :return: SetInstanceSettingsResponse

Usage:

result = api.set_instance_settings(
    instance_id="example",
    settings=[],
)

set_privilege(*, instance_id: str, database_name: str, user_name: str, region: Optional[str] = None, permission: Optional[Permission] = None) → 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. :param instance_id: UUID of the Database Instance. :param database_name: Name of the database. :param user_name: Name of the user. :param region: Region to target. If none is passed will use default region from the config. :param permission: Permission to set (Read, Read/Write, All, Custom). :return: Privilege

Usage:

result = api.set_privilege(
    instance_id="example",
    database_name="example",
    user_name="example",
)

update_instance(*, instance_id: str, region: Optional[str] = None, backup_schedule_frequency: Optional[int] = None, backup_schedule_retention: Optional[int] = None, is_backup_schedule_disabled: Optional[bool] = None, name: Optional[str] = None, tags: Optional[List[str]] = None, logs_policy: Optional[LogsPolicy] = None, backup_same_region: Optional[bool] = None, backup_schedule_start_hour: Optional[int] = None) → Instance

Update a Database Instance. Update the parameters of a Database Instance, including name, tags and backup schedule details. :param instance_id: UUID of the Database Instance to update. :param region: Region to target. If none is passed will use default region from the config. :param backup_schedule_frequency: In hours. :param backup_schedule_retention: In days. :param is_backup_schedule_disabled: Defines whether or not the backup schedule is disabled. :param name: Name of the Database Instance. :param tags: Tags of a Database Instance. :param logs_policy: Logs policy of the Database Instance. :param backup_same_region: Store logical backups in the same region as the Database Instance. :param backup_schedule_start_hour: Defines the start time of the autobackup. :return: Instance

Usage:

result = api.update_instance(
    instance_id="example",
)

update_snapshot(*, snapshot_id: str, region: Optional[str] = None, name: Optional[str] = None, expires_at: Optional[datetime] = None) → 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. :param snapshot_id: UUID of the snapshot to update. :param region: Region to target. If none is passed will use default region from the config. :param name: Name of the snapshot. :param expires_at: Expiration date (must follow the ISO 8601 format). :return: Snapshot

Usage:

result = api.update_snapshot(
    snapshot_id="example",
)

update_user(*, instance_id: str, name: str, region: Optional[str] = None, password: Optional[str] = None, is_admin: Optional[bool] = None) → 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. :param instance_id: UUID of the Database Instance the user belongs to. :param name: Name of the database user. :param region: Region to target. If none is passed will use default region from the config. :param password: Password of the database user. :param is_admin: Defines whether or not this user got administrative privileges. :return: User

Usage:

result = api.update_user(
    instance_id="example",
    name="example",
)

upgrade_instance(*, instance_id: str, region: Optional[str] = None, node_type: Optional[str] = None, enable_ha: Optional[bool] = None, volume_size: Optional[int] = None, volume_type: Optional[VolumeType] = None, upgradable_version_id: Optional[str] = None, major_upgrade_workflow: Optional[UpgradeInstanceRequestMajorUpgradeWorkflow] = None) → 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. :param instance_id: UUID of the Database Instance you want to upgrade. :param region: Region to target. If none is passed will use default region from the config. :param node_type: Node type of the Database Instance you want to upgrade to. One-Of (‘upgrade_target’): at most one of ‘node_type’, ‘enable_ha’, ‘volume_size’, ‘volume_type’, ‘upgradable_version_id’, ‘major_upgrade_workflow’ could be set. :param enable_ha: Defines whether or not High Availability should be enabled on the Database Instance. One-Of (‘upgrade_target’): at most one of ‘node_type’, ‘enable_ha’, ‘volume_size’, ‘volume_type’, ‘upgradable_version_id’, ‘major_upgrade_workflow’ could be set. :param volume_size: Increase your Block volume size. One-Of (‘upgrade_target’): at most one of ‘node_type’, ‘enable_ha’, ‘volume_size’, ‘volume_type’, ‘upgradable_version_id’, ‘major_upgrade_workflow’ could be set. :param volume_type: Change your Database Instance storage type. One-Of (‘upgrade_target’): at most one of ‘node_type’, ‘enable_ha’, ‘volume_size’, ‘volume_type’, ‘upgradable_version_id’, ‘major_upgrade_workflow’ could be set. :param upgradable_version_id: This will create a new Database Instance with same specifications as the current one and perform a Database Engine upgrade. One-Of (‘upgrade_target’): at most one of ‘node_type’, ‘enable_ha’, ‘volume_size’, ‘volume_type’, ‘upgradable_version_id’, ‘major_upgrade_workflow’ could be set. :param major_upgrade_workflow: Upgrade your database engine to a new major version including instance endpoints. One-Of (‘upgrade_target’): at most one of ‘node_type’, ‘enable_ha’, ‘volume_size’, ‘volume_type’, ‘upgradable_version_id’, ‘major_upgrade_workflow’ could be set. :return: Instance

Usage:

result = api.upgrade_instance(
    instance_id="example",
)

wait_for_instance(*, instance_id: str, region: Optional[str] = None, options: Optional[WaitForOptions[Instance, bool]] = None) → 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. :param instance_id: UUID of the Database Instance. :param region: Region to target. If none is passed will use default region from the config. :return: Instance

Usage:

result = api.get_instance(
    instance_id="example",
)

wait_for_instance_log(*, instance_log_id: str, region: Optional[str] = None, options: Optional[WaitForOptions[InstanceLog, bool]] = None) → 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. :param instance_log_id: UUID of the instance_log you want. :param region: Region to target. If none is passed will use default region from the config. :return: InstanceLog

Usage:

result = api.get_instance_log(
    instance_log_id="example",
)

wait_for_read_replica(*, read_replica_id: str, region: Optional[str] = None, options: Optional[WaitForOptions[ReadReplica, bool]] = None) → 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. :param read_replica_id: UUID of the Read Replica. :param region: Region to target. If none is passed will use default region from the config. :return: ReadReplica

Usage:

result = api.get_read_replica(
    read_replica_id="example",
)

wait_for_snapshot(*, snapshot_id: str, region: Optional[str] = None, options: Optional[WaitForOptions[Snapshot, bool]] = None) → 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. :param snapshot_id: UUID of the snapshot. :param region: Region to target. If none is passed will use default region from the config. :return: Snapshot

Usage:

result = api.get_snapshot(
    snapshot_id="example",
)

scaleway.document_db.v1beta1.content module

scaleway.document_db.v1beta1.content.INSTANCE_LOG_TRANSIENT_STATUSES: List[InstanceLogStatus] = [<InstanceLogStatus.CREATING: 'creating'>]

Lists transient statutes of the enum InstanceLogStatus.

scaleway.document_db.v1beta1.content.INSTANCE_TRANSIENT_STATUSES: List[InstanceStatus] = [<InstanceStatus.PROVISIONING: 'provisioning'>, <InstanceStatus.CONFIGURING: 'configuring'>, <InstanceStatus.DELETING: 'deleting'>, <InstanceStatus.AUTOHEALING: 'autohealing'>, <InstanceStatus.INITIALIZING: 'initializing'>, <InstanceStatus.BACKUPING: 'backuping'>, <InstanceStatus.SNAPSHOTTING: 'snapshotting'>, <InstanceStatus.RESTARTING: 'restarting'>]

Lists transient statutes of the enum InstanceStatus.

scaleway.document_db.v1beta1.content.MAINTENANCE_TRANSIENT_STATUSES: List[MaintenanceStatus] = [<MaintenanceStatus.ONGOING: 'ongoing'>]

Lists transient statutes of the enum MaintenanceStatus.

scaleway.document_db.v1beta1.content.READ_REPLICA_TRANSIENT_STATUSES: List[ReadReplicaStatus] = [<ReadReplicaStatus.PROVISIONING: 'provisioning'>, <ReadReplicaStatus.INITIALIZING: 'initializing'>, <ReadReplicaStatus.DELETING: 'deleting'>, <ReadReplicaStatus.CONFIGURING: 'configuring'>, <ReadReplicaStatus.PROMOTING: 'promoting'>]

Lists transient statutes of the enum ReadReplicaStatus.

scaleway.document_db.v1beta1.content.SNAPSHOT_TRANSIENT_STATUSES: List[SnapshotStatus] = [<SnapshotStatus.CREATING: 'creating'>, <SnapshotStatus.RESTORING: 'restoring'>, <SnapshotStatus.DELETING: 'deleting'>]

Lists transient statutes of the enum SnapshotStatus.

scaleway.document_db.v1beta1.marshalling module

scaleway.document_db.v1beta1.marshalling.marshal_ACLRuleRequest(request: ACLRuleRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.document_db.v1beta1.marshalling.marshal_AddInstanceACLRulesRequest(request: AddInstanceACLRulesRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.document_db.v1beta1.marshalling.marshal_AddInstanceSettingsRequest(request: AddInstanceSettingsRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.document_db.v1beta1.marshalling.marshal_CloneInstanceRequest(request: CloneInstanceRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.document_db.v1beta1.marshalling.marshal_CreateDatabaseRequest(request: CreateDatabaseRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.document_db.v1beta1.marshalling.marshal_CreateEndpointRequest(request: CreateEndpointRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.document_db.v1beta1.marshalling.marshal_CreateInstanceFromSnapshotRequest(request: CreateInstanceFromSnapshotRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.document_db.v1beta1.marshalling.marshal_CreateInstanceRequest(request: CreateInstanceRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.document_db.v1beta1.marshalling.marshal_CreateReadReplicaEndpointRequest(request: CreateReadReplicaEndpointRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.document_db.v1beta1.marshalling.marshal_CreateReadReplicaRequest(request: CreateReadReplicaRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.document_db.v1beta1.marshalling.marshal_CreateSnapshotRequest(request: CreateSnapshotRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.document_db.v1beta1.marshalling.marshal_CreateUserRequest(request: CreateUserRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.document_db.v1beta1.marshalling.marshal_DeleteInstanceACLRulesRequest(request: DeleteInstanceACLRulesRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.document_db.v1beta1.marshalling.marshal_DeleteInstanceSettingsRequest(request: DeleteInstanceSettingsRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.document_db.v1beta1.marshalling.marshal_EndpointSpec(request: EndpointSpec, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.document_db.v1beta1.marshalling.marshal_EndpointSpecLoadBalancer(request: EndpointSpecLoadBalancer, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.document_db.v1beta1.marshalling.marshal_EndpointSpecPrivateNetwork(request: EndpointSpecPrivateNetwork, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.document_db.v1beta1.marshalling.marshal_EndpointSpecPrivateNetworkIpamConfig(request: EndpointSpecPrivateNetworkIpamConfig, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.document_db.v1beta1.marshalling.marshal_InstanceSetting(request: InstanceSetting, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.document_db.v1beta1.marshalling.marshal_LogsPolicy(request: LogsPolicy, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.document_db.v1beta1.marshalling.marshal_MigrateEndpointRequest(request: MigrateEndpointRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.document_db.v1beta1.marshalling.marshal_PurgeInstanceLogsRequest(request: PurgeInstanceLogsRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.document_db.v1beta1.marshalling.marshal_ReadReplicaEndpointSpec(request: ReadReplicaEndpointSpec, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.document_db.v1beta1.marshalling.marshal_ReadReplicaEndpointSpecDirectAccess(request: ReadReplicaEndpointSpecDirectAccess, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.document_db.v1beta1.marshalling.marshal_ReadReplicaEndpointSpecPrivateNetwork(request: ReadReplicaEndpointSpecPrivateNetwork, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.document_db.v1beta1.marshalling.marshal_ReadReplicaEndpointSpecPrivateNetworkIpamConfig(request: ReadReplicaEndpointSpecPrivateNetworkIpamConfig, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.document_db.v1beta1.marshalling.marshal_SetInstanceACLRulesRequest(request: SetInstanceACLRulesRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.document_db.v1beta1.marshalling.marshal_SetInstanceSettingsRequest(request: SetInstanceSettingsRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.document_db.v1beta1.marshalling.marshal_SetPrivilegeRequest(request: SetPrivilegeRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.document_db.v1beta1.marshalling.marshal_UpdateInstanceRequest(request: UpdateInstanceRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.document_db.v1beta1.marshalling.marshal_UpdateSnapshotRequest(request: UpdateSnapshotRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.document_db.v1beta1.marshalling.marshal_UpdateUserRequest(request: UpdateUserRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.document_db.v1beta1.marshalling.marshal_UpgradeInstanceRequest(request: UpgradeInstanceRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.document_db.v1beta1.marshalling.marshal_UpgradeInstanceRequestMajorUpgradeWorkflow(request: UpgradeInstanceRequestMajorUpgradeWorkflow, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.document_db.v1beta1.marshalling.unmarshal_ACLRule(data: Any) → ACLRule

scaleway.document_db.v1beta1.marshalling.unmarshal_AddInstanceACLRulesResponse(data: Any) → AddInstanceACLRulesResponse

scaleway.document_db.v1beta1.marshalling.unmarshal_AddInstanceSettingsResponse(data: Any) → AddInstanceSettingsResponse

scaleway.document_db.v1beta1.marshalling.unmarshal_BackupSchedule(data: Any) → BackupSchedule

scaleway.document_db.v1beta1.marshalling.unmarshal_Database(data: Any) → Database

scaleway.document_db.v1beta1.marshalling.unmarshal_DatabaseEngine(data: Any) → DatabaseEngine

scaleway.document_db.v1beta1.marshalling.unmarshal_DeleteInstanceACLRulesResponse(data: Any) → DeleteInstanceACLRulesResponse

scaleway.document_db.v1beta1.marshalling.unmarshal_DeleteInstanceSettingsResponse(data: Any) → DeleteInstanceSettingsResponse

scaleway.document_db.v1beta1.marshalling.unmarshal_Endpoint(data: Any) → Endpoint

scaleway.document_db.v1beta1.marshalling.unmarshal_EndpointDirectAccessDetails(data: Any) → EndpointDirectAccessDetails

scaleway.document_db.v1beta1.marshalling.unmarshal_EndpointLoadBalancerDetails(data: Any) → EndpointLoadBalancerDetails

scaleway.document_db.v1beta1.marshalling.unmarshal_EndpointPrivateNetworkDetails(data: Any) → EndpointPrivateNetworkDetails

scaleway.document_db.v1beta1.marshalling.unmarshal_EngineSetting(data: Any) → EngineSetting

scaleway.document_db.v1beta1.marshalling.unmarshal_EngineVersion(data: Any) → EngineVersion

scaleway.document_db.v1beta1.marshalling.unmarshal_Instance(data: Any) → Instance

scaleway.document_db.v1beta1.marshalling.unmarshal_InstanceLog(data: Any) → InstanceLog

scaleway.document_db.v1beta1.marshalling.unmarshal_InstanceMetrics(data: Any) → InstanceMetrics

scaleway.document_db.v1beta1.marshalling.unmarshal_InstanceSetting(data: Any) → InstanceSetting

scaleway.document_db.v1beta1.marshalling.unmarshal_ListDatabaseEnginesResponse(data: Any) → ListDatabaseEnginesResponse

scaleway.document_db.v1beta1.marshalling.unmarshal_ListDatabasesResponse(data: Any) → ListDatabasesResponse

scaleway.document_db.v1beta1.marshalling.unmarshal_ListInstanceACLRulesResponse(data: Any) → ListInstanceACLRulesResponse

scaleway.document_db.v1beta1.marshalling.unmarshal_ListInstanceLogsDetailsResponse(data: Any) → ListInstanceLogsDetailsResponse

scaleway.document_db.v1beta1.marshalling.unmarshal_ListInstanceLogsDetailsResponseInstanceLogDetail(data: Any) → ListInstanceLogsDetailsResponseInstanceLogDetail

scaleway.document_db.v1beta1.marshalling.unmarshal_ListInstanceLogsResponse(data: Any) → ListInstanceLogsResponse

scaleway.document_db.v1beta1.marshalling.unmarshal_ListInstancesResponse(data: Any) → ListInstancesResponse

scaleway.document_db.v1beta1.marshalling.unmarshal_ListNodeTypesResponse(data: Any) → ListNodeTypesResponse

scaleway.document_db.v1beta1.marshalling.unmarshal_ListPrivilegesResponse(data: Any) → ListPrivilegesResponse

scaleway.document_db.v1beta1.marshalling.unmarshal_ListSnapshotsResponse(data: Any) → ListSnapshotsResponse

scaleway.document_db.v1beta1.marshalling.unmarshal_ListUsersResponse(data: Any) → ListUsersResponse

scaleway.document_db.v1beta1.marshalling.unmarshal_LogsPolicy(data: Any) → LogsPolicy

scaleway.document_db.v1beta1.marshalling.unmarshal_Maintenance(data: Any) → Maintenance

scaleway.document_db.v1beta1.marshalling.unmarshal_NodeType(data: Any) → NodeType

scaleway.document_db.v1beta1.marshalling.unmarshal_NodeTypeVolumeConstraintSizes(data: Any) → NodeTypeVolumeConstraintSizes

scaleway.document_db.v1beta1.marshalling.unmarshal_NodeTypeVolumeType(data: Any) → NodeTypeVolumeType

scaleway.document_db.v1beta1.marshalling.unmarshal_Privilege(data: Any) → Privilege

scaleway.document_db.v1beta1.marshalling.unmarshal_ReadReplica(data: Any) → ReadReplica

scaleway.document_db.v1beta1.marshalling.unmarshal_SetInstanceACLRulesResponse(data: Any) → SetInstanceACLRulesResponse

scaleway.document_db.v1beta1.marshalling.unmarshal_SetInstanceSettingsResponse(data: Any) → SetInstanceSettingsResponse

scaleway.document_db.v1beta1.marshalling.unmarshal_Snapshot(data: Any) → Snapshot

scaleway.document_db.v1beta1.marshalling.unmarshal_SnapshotVolumeType(data: Any) → SnapshotVolumeType

scaleway.document_db.v1beta1.marshalling.unmarshal_UpgradableVersion(data: Any) → UpgradableVersion

scaleway.document_db.v1beta1.marshalling.unmarshal_User(data: Any) → User

scaleway.document_db.v1beta1.marshalling.unmarshal_Volume(data: Any) → Volume

scaleway.document_db.v1beta1.types module

class scaleway.document_db.v1beta1.types.ACLRule(ip: 'str', protocol: 'ACLRuleProtocol', direction: 'ACLRuleDirection', action: 'ACLRuleAction', description: 'str', port: 'Optional[int]')

Bases: object

action: ACLRuleAction

description: str

direction: ACLRuleDirection

ip: str

port: Optional[int]

protocol: ACLRuleProtocol

class scaleway.document_db.v1beta1.types.ACLRuleAction(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

ALLOW = 'allow'

DENY = 'deny'

class scaleway.document_db.v1beta1.types.ACLRuleDirection(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

INBOUND = 'inbound'

OUTBOUND = 'outbound'

class scaleway.document_db.v1beta1.types.ACLRuleProtocol(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

ICMP = 'icmp'

TCP = 'tcp'

UDP = 'udp'

class scaleway.document_db.v1beta1.types.ACLRuleRequest(ip: 'str', description: 'str')

Bases: object

description: str

ip: str

class scaleway.document_db.v1beta1.types.AddInstanceACLRulesRequest(instance_id: 'str', rules: 'List[ACLRuleRequest]', region: 'Optional[Region]')

Bases: object

instance_id: str

UUID of the Database Instance you want to add ACL rules to.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

rules: List[ACLRuleRequest]

ACL rules to add to the Database Instance.

class scaleway.document_db.v1beta1.types.AddInstanceACLRulesResponse(rules: 'List[ACLRule]')

Bases: object

rules: List[ACLRule]

ACL Rules enabled for the Database Instance.

class scaleway.document_db.v1beta1.types.AddInstanceSettingsRequest(instance_id: 'str', settings: 'List[InstanceSetting]', region: 'Optional[Region]')

Bases: object

instance_id: str

UUID of the Database Instance you want to add settings to.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

settings: List[InstanceSetting]

Settings to add to the Database Instance.

class scaleway.document_db.v1beta1.types.AddInstanceSettingsResponse(settings: 'List[InstanceSetting]')

Bases: object

settings: List[InstanceSetting]

Settings available on the Database Instance.

class scaleway.document_db.v1beta1.types.ApplyInstanceMaintenanceRequest(instance_id: 'str', region: 'Optional[Region]')

Bases: object

instance_id: str

UUID of the Database Instance to which you want to apply maintenance.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.types.BackupSchedule(frequency: 'int', retention: 'int', disabled: 'bool', next_run_at: 'Optional[datetime]')

Bases: object

disabled: bool

Defines whether the backup schedule feature is disabled.

frequency: int

Frequency of the backup schedule (in hours).

next_run_at: Optional[datetime]

Next run of the backup schedule (accurate to 10 minutes).

retention: int

Default retention period of backups (in days).

class scaleway.document_db.v1beta1.types.CloneInstanceRequest(instance_id: 'str', name: 'str', region: 'Optional[Region]', node_type: 'Optional[str]')

Bases: object

instance_id: str

UUID of the Database Instance you want to clone.

name: str

Name of the Database Instance clone.

node_type: Optional[str]

Node type of the clone.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.types.CreateDatabaseRequest(instance_id: 'str', name: 'str', region: 'Optional[Region]')

Bases: object

instance_id: str

UUID of the Database Instance where to create the database.

name: str

Name of the database.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.types.CreateEndpointRequest(instance_id: 'str', region: 'Optional[Region]', endpoint_spec: 'Optional[EndpointSpec]')

Bases: object

endpoint_spec: Optional[EndpointSpec]

Specification of the endpoint you want to create.

instance_id: str

UUID of the Database Instance you to which you want to add an endpoint.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.types.CreateInstanceFromSnapshotRequest(snapshot_id: 'str', instance_name: 'str', region: 'Optional[Region]', is_ha_cluster: 'Optional[bool]', node_type: 'Optional[str]')

Bases: object

instance_name: str

Name of the Database Instance created with the snapshot.

is_ha_cluster: Optional[bool]

Defines whether or not High Availability is enabled on the new Database Instance.

node_type: Optional[str]

The node type used to restore the snapshot.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

snapshot_id: str

Block snapshot of the Database Instance.

class scaleway.document_db.v1beta1.types.CreateInstanceRequest(engine: 'str', user_name: 'str', password: 'str', node_type: 'str', region: 'Optional[Region]', name: 'Optional[str]', is_ha_cluster: 'bool', disable_backup: 'bool', volume_size: 'int', backup_same_region: 'bool', tags: 'Optional[List[str]]', init_settings: 'Optional[List[InstanceSetting]]', volume_type: 'Optional[VolumeType]', init_endpoints: 'Optional[List[EndpointSpec]]', organization_id: 'Optional[str]', project_id: 'Optional[str]')

Bases: object

backup_same_region: bool

Defines whether to or not to store logical backups in the same region as the Database Instance.

disable_backup: bool

Defines whether or not backups are disabled.

engine: str

Database engine of the Database Instance.

init_endpoints: Optional[List[EndpointSpec]]

One or multiple EndpointSpec used to expose your Database Instance. A load_balancer public endpoint is systematically created.

init_settings: Optional[List[InstanceSetting]]

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

is_ha_cluster: bool

Defines whether or not High-Availability is enabled.

name: Optional[str]

Name of the Database Instance.

node_type: str

Type of node to use for the Database Instance.

organization_id: Optional[str]

password: str

Password of the user.

project_id: Optional[str]

region: Optional[str]

Region to target. If none is passed will use default region from the config.

tags: Optional[List[str]]

Tags to apply to the Database Instance.

user_name: str

Username created when the Database Instance is created.

volume_size: int

Volume size when volume_type is not lssd.

volume_type: Optional[VolumeType]

Type of volume where data is stored (lssd, bssd, …).

class scaleway.document_db.v1beta1.types.CreateReadReplicaEndpointRequest(read_replica_id: 'str', endpoint_spec: 'List[ReadReplicaEndpointSpec]', region: 'Optional[Region]')

Bases: object

endpoint_spec: List[ReadReplicaEndpointSpec]

Specification of the endpoint you want to create.

read_replica_id: str

UUID of the Read Replica.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.types.CreateReadReplicaRequest(instance_id: 'str', region: 'Optional[Region]', endpoint_spec: 'Optional[List[ReadReplicaEndpointSpec]]', same_zone: 'Optional[bool]')

Bases: object

endpoint_spec: Optional[List[ReadReplicaEndpointSpec]]

Specification of the endpoint you want to create.

instance_id: str

UUID of the Database Instance you want to create a Read Replica from.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

same_zone: Optional[bool]

Defines whether or not to create the replica in the same Availability Zone as the main Database Instance nodes.

class scaleway.document_db.v1beta1.types.CreateSnapshotRequest(instance_id: 'str', region: 'Optional[Region]', name: 'Optional[str]', expires_at: 'Optional[datetime]')

Bases: object

expires_at: Optional[datetime]

Expiration date (must follow the ISO 8601 format).

instance_id: str

UUID of the Database Instance.

name: Optional[str]

Name of the snapshot.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.types.CreateUserRequest(instance_id: 'str', name: 'str', password: 'str', is_admin: 'bool', region: 'Optional[Region]')

Bases: object

instance_id: str

UUID of the Database Instance in which you want to create a user.

is_admin: bool

Defines whether the user will have administrative privileges.

name: str

Name of the user you want to create.

password: str

Password of the user you want to create.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.types.Database(name: 'str', owner: 'str', managed: 'bool', size: 'int')

Bases: object

managed: bool

Defines whether the database is managed or not.

name: str

Name of the database.

owner: str

Name of the database owner.

size: int

Size of the database.

class scaleway.document_db.v1beta1.types.DatabaseEngine(name: 'str', logo_url: 'str', versions: 'List[EngineVersion]', region: 'Region')

Bases: object

logo_url: str

Engine logo URL.

name: str

Engine name.

region: str

Region of this Database Instance.

versions: List[EngineVersion]

Available versions.

class scaleway.document_db.v1beta1.types.DeleteDatabaseRequest(instance_id: 'str', name: 'str', region: 'Optional[Region]')

Bases: object

instance_id: str

UUID of the Database Instance where to delete the database.

name: str

Name of the database to delete.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.types.DeleteEndpointRequest(endpoint_id: 'str', region: 'Optional[Region]')

Bases: object

endpoint_id: str

This endpoint can also be used to delete a Read Replica endpoint.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.types.DeleteInstanceACLRulesRequest(instance_id: 'str', acl_rule_ips: 'List[str]', region: 'Optional[Region]')

Bases: object

acl_rule_ips: List[str]

IP addresses defined in the ACL rules of the Database Instance.

instance_id: str

UUID of the Database Instance you want to delete an ACL rule from.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.types.DeleteInstanceACLRulesResponse(rules: 'List[ACLRule]')

Bases: object

rules: List[ACLRule]

IP addresses defined in the ACL rules of the Database Instance.

class scaleway.document_db.v1beta1.types.DeleteInstanceRequest(instance_id: 'str', region: 'Optional[Region]')

Bases: object

instance_id: str

UUID of the Database Instance to delete.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.types.DeleteInstanceSettingsRequest(instance_id: 'str', setting_names: 'List[str]', region: 'Optional[Region]')

Bases: object

instance_id: str

UUID of the Database Instance to delete settings from.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

setting_names: List[str]

Settings names to delete.

class scaleway.document_db.v1beta1.types.DeleteInstanceSettingsResponse(settings: 'List[InstanceSetting]')

Bases: object

settings: List[InstanceSetting]

Settings names to delete from the Database Instance.

class scaleway.document_db.v1beta1.types.DeleteReadReplicaRequest(read_replica_id: 'str', region: 'Optional[Region]')

Bases: object

read_replica_id: str

UUID of the Read Replica.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.types.DeleteSnapshotRequest(snapshot_id: 'str', region: 'Optional[Region]')

Bases: object

region: Optional[str]

Region to target. If none is passed will use default region from the config.

snapshot_id: str

UUID of the snapshot to delete.

class scaleway.document_db.v1beta1.types.DeleteUserRequest(instance_id: 'str', name: 'str', region: 'Optional[Region]')

Bases: object

instance_id: str

UUID of the Database Instance to delete the user from.

name: str

Name of the user.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.types.Endpoint(id: 'str', port: 'int', name: 'Optional[str]', ip: 'Optional[str]', hostname: 'Optional[str]', private_network: 'Optional[EndpointPrivateNetworkDetails]', load_balancer: 'Optional[EndpointLoadBalancerDetails]', direct_access: 'Optional[EndpointDirectAccessDetails]')

Bases: object

direct_access: Optional[EndpointDirectAccessDetails]

hostname: Optional[str]

id: str

UUID of the endpoint.

ip: Optional[str]

load_balancer: Optional[EndpointLoadBalancerDetails]

name: Optional[str]

Name of the endpoint.

port: int

TCP port of the endpoint.

private_network: Optional[EndpointPrivateNetworkDetails]

class scaleway.document_db.v1beta1.types.EndpointDirectAccessDetails

Bases: object

class scaleway.document_db.v1beta1.types.EndpointLoadBalancerDetails

Bases: object

class scaleway.document_db.v1beta1.types.EndpointPrivateNetworkDetails(private_network_id: 'str', service_ip: 'str', zone: 'Zone')

Bases: object

private_network_id: str

UUID of the Private Network.

service_ip: str

CIDR notation of the endpoint IPv4 address.

zone: str

Private network zone.

class scaleway.document_db.v1beta1.types.EndpointSpec(load_balancer: 'Optional[EndpointSpecLoadBalancer]', private_network: 'Optional[EndpointSpecPrivateNetwork]')

Bases: object

load_balancer: Optional[EndpointSpecLoadBalancer]

private_network: Optional[EndpointSpecPrivateNetwork]

class scaleway.document_db.v1beta1.types.EndpointSpecLoadBalancer

Bases: object

class scaleway.document_db.v1beta1.types.EndpointSpecPrivateNetwork(private_network_id: 'str', service_ip: 'Optional[str]', ipam_config: 'Optional[EndpointSpecPrivateNetworkIpamConfig]')

Bases: object

ipam_config: Optional[EndpointSpecPrivateNetworkIpamConfig]

private_network_id: str

UUID of the Private Network to be connected to the Database Instance.

service_ip: Optional[str]

class scaleway.document_db.v1beta1.types.EndpointSpecPrivateNetworkIpamConfig

Bases: object

class scaleway.document_db.v1beta1.types.EngineSetting(name: 'str', default_value: 'str', hot_configurable: 'bool', description: 'str', property_type: 'EngineSettingPropertyType', unit: 'Optional[str]', string_constraint: 'Optional[str]', int_min: 'Optional[int]', int_max: 'Optional[int]', float_min: 'Optional[float]', float_max: 'Optional[float]')

Bases: object

default_value: str

Value set when not specified.

description: str

Setting description.

float_max: Optional[float]

Maximum value for float types.

float_min: Optional[float]

Minimum value for float types.

hot_configurable: bool

Setting can be applied without restarting.

int_max: Optional[int]

Maximum value for int types.

int_min: Optional[int]

Minimum value for int types.

name: str

Setting name from the database engine.

property_type: EngineSettingPropertyType

Setting type.

string_constraint: Optional[str]

Validation regex for string type settings.

unit: Optional[str]

Setting base unit.

class scaleway.document_db.v1beta1.types.EngineSettingPropertyType(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

BOOLEAN = 'boolean'

FLOAT = 'float'

INT = 'int'

STRING = 'string'

class scaleway.document_db.v1beta1.types.EngineVersion(version: 'str', name: 'str', available_settings: 'List[EngineSetting]', disabled: 'bool', beta: 'bool', available_init_settings: 'List[EngineSetting]', end_of_life: 'Optional[datetime]')

Bases: object

available_init_settings: List[EngineSetting]

Engine settings available to be set at database initialization.

available_settings: List[EngineSetting]

Engine settings available to be set.

beta: bool

Beta status of engine version.

disabled: bool

Disabled versions cannot be created.

end_of_life: Optional[datetime]

End of life date.

name: str

Database engine name.

version: str

Database engine version.

class scaleway.document_db.v1beta1.types.GetEndpointRequest(endpoint_id: 'str', region: 'Optional[Region]')

Bases: object

endpoint_id: str

UUID of the endpoint you want to get.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.types.GetInstanceCertificateRequest(instance_id: 'str', region: 'Optional[Region]')

Bases: object

instance_id: str

UUID of the Database Instance.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.types.GetInstanceLogRequest(instance_log_id: 'str', region: 'Optional[Region]')

Bases: object

instance_log_id: str

UUID of the instance_log you want.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.types.GetInstanceMetricsRequest(instance_id: 'str', region: 'Optional[Region]', start_date: 'Optional[datetime]', end_date: 'Optional[datetime]', metric_name: 'Optional[str]')

Bases: object

end_date: Optional[datetime]

End date to gather metrics from.

instance_id: str

UUID of the Database Instance.

metric_name: Optional[str]

Name of the metric to gather.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

start_date: Optional[datetime]

Start date to gather metrics from.

class scaleway.document_db.v1beta1.types.GetInstanceRequest(instance_id: 'str', region: 'Optional[Region]')

Bases: object

instance_id: str

UUID of the Database Instance.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.types.GetReadReplicaRequest(read_replica_id: 'str', region: 'Optional[Region]')

Bases: object

read_replica_id: str

UUID of the Read Replica.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.types.GetSnapshotRequest(snapshot_id: 'str', region: 'Optional[Region]')

Bases: object

region: Optional[str]

Region to target. If none is passed will use default region from the config.

snapshot_id: str

UUID of the snapshot.

class scaleway.document_db.v1beta1.types.Instance(region: 'Region', id: 'str', name: 'str', organization_id: 'str', created_at: 'Optional[datetime]', volume: 'Optional[Volume]', project_id: 'str', status: 'InstanceStatus', engine: 'str', upgradable_version: 'List[UpgradableVersion]', tags: 'List[str]', settings: 'List[InstanceSetting]', is_ha_cluster: 'bool', endpoint: 'Optional[Endpoint]', backup_schedule: 'Optional[BackupSchedule]', read_replicas: 'List[ReadReplica]', node_type: 'str', init_settings: 'List[InstanceSetting]', endpoints: 'List[Endpoint]', backup_same_region: 'bool', maintenances: 'List[Maintenance]', logs_policy: 'Optional[LogsPolicy]')

Bases: object

backup_same_region: bool

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

backup_schedule: Optional[BackupSchedule]

Backup schedule of the Database Instance.

created_at: Optional[datetime]

Creation date (must follow the ISO 8601 format).

endpoint: Optional[Endpoint]

Endpoint of the Database Instance.

endpoints: List[Endpoint]

List of Database Instance endpoints.

engine: str

Database engine of the database.

id: str

UUID of the Database Instance.

init_settings: List[InstanceSetting]

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

is_ha_cluster: bool

Defines whether or not High-Availability is enabled.

logs_policy: Optional[LogsPolicy]

Logs policy of the Database Instance.

maintenances: List[Maintenance]

List of Database Instance maintenance events.

name: str

Name of the Database Instance.

node_type: str

Node type of the Database Instance.

organization_id: str

Organization ID the Database Instance belongs to.

project_id: str

Project ID the Database Instance belongs to.

read_replicas: List[ReadReplica]

Read Replicas of the Database Instance.

region: str

Region the Database Instance is in.

settings: List[InstanceSetting]

Advanced settings of the Database Instance.

status: InstanceStatus

Status of the Database Instance.

tags: List[str]

List of tags applied to the Database Instance.

upgradable_version: List[UpgradableVersion]

Available database engine versions for upgrade.

volume: Optional[Volume]

Volumes of the Database Instance.

class scaleway.document_db.v1beta1.types.InstanceLog(id: 'str', status: 'InstanceLogStatus', node_name: 'str', region: 'Region', download_url: 'Optional[str]', expires_at: 'Optional[datetime]', created_at: 'Optional[datetime]')

Bases: object

created_at: Optional[datetime]

Creation date (must follow the ISO 8601 format).

download_url: Optional[str]

Presigned S3 URL to download your log file.

expires_at: Optional[datetime]

Expiration date (must follow the ISO 8601 format).

id: str

UUID of the Database Instance log.

node_name: str

Name of the underlying node.

region: str

Region the Database Instance is in.

status: InstanceLogStatus

Status of the logs in a Database Instance.

class scaleway.document_db.v1beta1.types.InstanceLogStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

CREATING = 'creating'

ERROR = 'error'

READY = 'ready'

UNKNOWN = 'unknown'

class scaleway.document_db.v1beta1.types.InstanceMetrics(timeseries: 'List[TimeSeries]')

Bases: object

timeseries: List[TimeSeries]

Time series of metrics of a Database Instance.

class scaleway.document_db.v1beta1.types.InstanceSetting(name: 'str', value: 'str')

Bases: object

name: str

value: str

class scaleway.document_db.v1beta1.types.InstanceStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

AUTOHEALING = 'autohealing'

BACKUPING = 'backuping'

CONFIGURING = 'configuring'

DELETING = 'deleting'

DISK_FULL = 'disk_full'

ERROR = 'error'

INITIALIZING = 'initializing'

LOCKED = 'locked'

PROVISIONING = 'provisioning'

READY = 'ready'

RESTARTING = 'restarting'

SNAPSHOTTING = 'snapshotting'

UNKNOWN = 'unknown'

class scaleway.document_db.v1beta1.types.ListDatabaseEnginesRequest(region: 'Optional[Region]', name: 'Optional[str]', version: 'Optional[str]', page: 'Optional[int]', page_size: 'Optional[int]')

Bases: object

name: Optional[str]

Name of the database engine.

page: Optional[int]

page_size: Optional[int]

region: Optional[str]

Region to target. If none is passed will use default region from the config.

version: Optional[str]

Version of the database engine.

class scaleway.document_db.v1beta1.types.ListDatabaseEnginesResponse(engines: 'List[DatabaseEngine]', total_count: 'int')

Bases: object

engines: List[DatabaseEngine]

List of the available database engines.

total_count: int

Total count of database engines available.

class scaleway.document_db.v1beta1.types.ListDatabasesRequest(instance_id: 'str', region: 'Optional[Region]', name: 'Optional[str]', managed: 'Optional[bool]', owner: 'Optional[str]', order_by: 'Optional[ListDatabasesRequestOrderBy]', page: 'Optional[int]', page_size: 'Optional[int]')

Bases: object

instance_id: str

UUID of the Database Instance to list the databases of.

managed: Optional[bool]

Defines whether or not the database is managed.

name: Optional[str]

Name of the database.

order_by: Optional[ListDatabasesRequestOrderBy]

Criteria to use when ordering database listing.

owner: Optional[str]

User that owns this database.

page: Optional[int]

page_size: Optional[int]

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.types.ListDatabasesRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

NAME_ASC = 'name_asc'

NAME_DESC = 'name_desc'

SIZE_ASC = 'size_asc'

SIZE_DESC = 'size_desc'

class scaleway.document_db.v1beta1.types.ListDatabasesResponse(databases: 'List[Database]', total_count: 'int')

Bases: object

databases: List[Database]

List of the databases.

total_count: int

Total count of databases present on a Database Instance.

class scaleway.document_db.v1beta1.types.ListInstanceACLRulesRequest(instance_id: 'str', region: 'Optional[Region]', page: 'Optional[int]', page_size: 'Optional[int]')

Bases: object

instance_id: str

UUID of the Database Instance.

page: Optional[int]

page_size: Optional[int]

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.types.ListInstanceACLRulesResponse(rules: 'List[ACLRule]', total_count: 'int')

Bases: object

rules: List[ACLRule]

List of ACL rules present on a Database Instance.

total_count: int

Total count of ACL rules present on a Database Instance.

class scaleway.document_db.v1beta1.types.ListInstanceLogsDetailsRequest(instance_id: 'str', region: 'Optional[Region]')

Bases: object

instance_id: str

UUID of the Database Instance you want logs of.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.types.ListInstanceLogsDetailsResponse(details: 'List[ListInstanceLogsDetailsResponseInstanceLogDetail]')

Bases: object

details: List[ListInstanceLogsDetailsResponseInstanceLogDetail]

Remote Database Instance logs details.

class scaleway.document_db.v1beta1.types.ListInstanceLogsDetailsResponseInstanceLogDetail(log_name: 'str', size: 'int')

Bases: object

log_name: str

size: int

class scaleway.document_db.v1beta1.types.ListInstanceLogsRequest(instance_id: 'str', region: 'Optional[Region]', order_by: 'Optional[ListInstanceLogsRequestOrderBy]')

Bases: object

instance_id: str

UUID of the Database Instance you want logs of.

order_by: Optional[ListInstanceLogsRequestOrderBy]

Criteria to use when ordering Database Instance logs listing.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.types.ListInstanceLogsRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

CREATED_AT_ASC = 'created_at_asc'

CREATED_AT_DESC = 'created_at_desc'

class scaleway.document_db.v1beta1.types.ListInstanceLogsResponse(instance_logs: 'List[InstanceLog]')

Bases: object

instance_logs: List[InstanceLog]

Available logs in a Database Instance.

class scaleway.document_db.v1beta1.types.ListInstancesRequest(region: 'Optional[Region]', tags: 'Optional[List[str]]', name: 'Optional[str]', order_by: 'Optional[ListInstancesRequestOrderBy]', organization_id: 'Optional[str]', project_id: 'Optional[str]', page: 'Optional[int]', page_size: 'Optional[int]')

Bases: object

name: Optional[str]

Lists Database Instances that match a name pattern.

order_by: Optional[ListInstancesRequestOrderBy]

Criteria to use when ordering Database Instance listings.

organization_id: Optional[str]

Please use project_id instead.

page: Optional[int]

page_size: Optional[int]

project_id: Optional[str]

Project ID to list the Database Instance of.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

tags: Optional[List[str]]

List Database Instances that have a given tag.

class scaleway.document_db.v1beta1.types.ListInstancesRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

CREATED_AT_ASC = 'created_at_asc'

CREATED_AT_DESC = 'created_at_desc'

NAME_ASC = 'name_asc'

NAME_DESC = 'name_desc'

REGION = 'region'

STATUS_ASC = 'status_asc'

STATUS_DESC = 'status_desc'

class scaleway.document_db.v1beta1.types.ListInstancesResponse(instances: 'List[Instance]', total_count: 'int')

Bases: object

instances: List[Instance]

List of all Database Instances available in an Organization or Project.

total_count: int

Total count of Database Instances available in a Organization or Project.

class scaleway.document_db.v1beta1.types.ListNodeTypesRequest(include_disabled_types: 'bool', region: 'Optional[Region]', page: 'Optional[int]', page_size: 'Optional[int]')

Bases: object

include_disabled_types: bool

Defines whether or not to include disabled types.

page: Optional[int]

page_size: Optional[int]

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.types.ListNodeTypesResponse(node_types: 'List[NodeType]', total_count: 'int')

Bases: object

node_types: List[NodeType]

Types of the node.

total_count: int

Total count of node-types available.

class scaleway.document_db.v1beta1.types.ListPrivilegesRequest(instance_id: 'str', region: 'Optional[Region]', order_by: 'Optional[ListPrivilegesRequestOrderBy]', page: 'Optional[int]', page_size: 'Optional[int]', database_name: 'Optional[str]', user_name: 'Optional[str]')

Bases: object

database_name: Optional[str]

Name of the database.

instance_id: str

UUID of the Database Instance.

order_by: Optional[ListPrivilegesRequestOrderBy]

Criteria to use when ordering privileges listing.

page: Optional[int]

page_size: Optional[int]

region: Optional[str]

Region to target. If none is passed will use default region from the config.

user_name: Optional[str]

Name of the user.

class scaleway.document_db.v1beta1.types.ListPrivilegesRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

DATABASE_NAME_ASC = 'database_name_asc'

DATABASE_NAME_DESC = 'database_name_desc'

USER_NAME_ASC = 'user_name_asc'

USER_NAME_DESC = 'user_name_desc'

class scaleway.document_db.v1beta1.types.ListPrivilegesResponse(privileges: 'List[Privilege]', total_count: 'int')

Bases: object

privileges: List[Privilege]

Privileges of a user in a database in a Database Instance.

total_count: int

Total count of privileges present on a database.

class scaleway.document_db.v1beta1.types.ListSnapshotsRequest(region: 'Optional[Region]', name: 'Optional[str]', order_by: 'Optional[ListSnapshotsRequestOrderBy]', instance_id: 'Optional[str]', organization_id: 'Optional[str]', project_id: 'Optional[str]', page: 'Optional[int]', page_size: 'Optional[int]')

Bases: object

instance_id: Optional[str]

UUID of the Database Instance.

name: Optional[str]

Name of the snapshot.

order_by: Optional[ListSnapshotsRequestOrderBy]

Criteria to use when ordering snapshot listing.

organization_id: Optional[str]

Organization ID the snapshots belongs to.

page: Optional[int]

page_size: Optional[int]

project_id: Optional[str]

Project ID the snapshots belongs to.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.types.ListSnapshotsRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

CREATED_AT_ASC = 'created_at_asc'

CREATED_AT_DESC = 'created_at_desc'

EXPIRES_AT_ASC = 'expires_at_asc'

EXPIRES_AT_DESC = 'expires_at_desc'

NAME_ASC = 'name_asc'

NAME_DESC = 'name_desc'

class scaleway.document_db.v1beta1.types.ListSnapshotsResponse(snapshots: 'List[Snapshot]', total_count: 'int')

Bases: object

snapshots: List[Snapshot]

List of snapshots.

total_count: int

Total count of snapshots available.

class scaleway.document_db.v1beta1.types.ListUsersRequest(instance_id: 'str', region: 'Optional[Region]', name: 'Optional[str]', order_by: 'Optional[ListUsersRequestOrderBy]', page: 'Optional[int]', page_size: 'Optional[int]')

Bases: object

instance_id: str

UUID of the Database Instance.

name: Optional[str]

Name of the user.

order_by: Optional[ListUsersRequestOrderBy]

Criteria to use when requesting user listing.

page: Optional[int]

page_size: Optional[int]

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.types.ListUsersRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

IS_ADMIN_ASC = 'is_admin_asc'

IS_ADMIN_DESC = 'is_admin_desc'

NAME_ASC = 'name_asc'

NAME_DESC = 'name_desc'

class scaleway.document_db.v1beta1.types.ListUsersResponse(users: 'List[User]', total_count: 'int')

Bases: object

total_count: int

Total count of users present on a Database Instance.

users: List[User]

List of users in a Database Instance.

class scaleway.document_db.v1beta1.types.LogsPolicy(max_age_retention: 'Optional[int]', total_disk_retention: 'Optional[int]')

Bases: object

max_age_retention: Optional[int]

Max age (in days) of remote logs to keep on the Database Instance.

total_disk_retention: Optional[int]

Max disk size of remote logs to keep on the Database Instance.

class scaleway.document_db.v1beta1.types.Maintenance(reason: 'str', status: 'MaintenanceStatus', starts_at: 'Optional[datetime]', stops_at: 'Optional[datetime]', closed_at: 'Optional[datetime]', forced_at: 'Optional[datetime]')

Bases: object

closed_at: Optional[datetime]

Closed maintenance date.

forced_at: Optional[datetime]

Time when Scaleway-side maintenance will be applied.

reason: str

Maintenance information message.

starts_at: Optional[datetime]

Start date of the maintenance window.

status: MaintenanceStatus

Status of the maintenance.

stops_at: Optional[datetime]

End date of the maintenance window.

class scaleway.document_db.v1beta1.types.MaintenanceStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

CANCELED = 'canceled'

DONE = 'done'

ONGOING = 'ongoing'

PENDING = 'pending'

UNKNOWN = 'unknown'

class scaleway.document_db.v1beta1.types.MigrateEndpointRequest(endpoint_id: 'str', instance_id: 'str', region: 'Optional[Region]')

Bases: object

endpoint_id: str

UUID of the endpoint you want to migrate.

instance_id: str

UUID of the instance you want to attach the endpoint to.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.types.NodeType(name: 'str', stock_status: 'NodeTypeStock', description: 'str', vcpus: 'int', memory: 'int', disabled: 'bool', beta: 'bool', volume_constraint: 'Optional[NodeTypeVolumeConstraintSizes]', is_bssd_compatible: 'Optional[bool]', available_volume_types: 'List[NodeTypeVolumeType]', is_ha_required: 'bool', generation: 'NodeTypeGeneration', instance_range: 'str', region: 'Region')

Bases: object

available_volume_types: List[NodeTypeVolumeType]

Available storage options for the Node Type.

beta: bool

The Node Type is currently in beta.

description: str

Current specs of the offer.

disabled: bool

The Node Type is currently disabled.

generation: NodeTypeGeneration

Generation associated the NodeType offer.

instance_range: str

Instance range associated with the NodeType offer.

is_bssd_compatible: Optional[bool]

The Node Type is compliant with Block Storage.

is_ha_required: bool

The Node Type can be used only with the High Availability option.

memory: int

Quantity of RAM.

name: str

Node Type name identifier.

region: str

Region the Node Type is in.

stock_status: NodeTypeStock

Current stock status for the Node Type.

vcpus: int

Number of virtual CPUs.

volume_constraint: Optional[NodeTypeVolumeConstraintSizes]

[deprecated] Node Type volume constraints.

class scaleway.document_db.v1beta1.types.NodeTypeGeneration(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

GENERATION_V1 = 'generation_v1'

GENERATION_V2 = 'generation_v2'

UNKNOWN_GENERATION = 'unknown_generation'

class scaleway.document_db.v1beta1.types.NodeTypeStock(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

AVAILABLE = 'available'

LOW_STOCK = 'low_stock'

OUT_OF_STOCK = 'out_of_stock'

UNKNOWN = 'unknown'

class scaleway.document_db.v1beta1.types.NodeTypeVolumeConstraintSizes(min_size: 'int', max_size: 'int')

Bases: object

max_size: int

[deprecated] Maximum size required for the Volume.

min_size: int

[deprecated] Mimimum size required for the Volume.

class scaleway.document_db.v1beta1.types.NodeTypeVolumeType(type_: 'VolumeType', description: 'str', min_size: 'int', max_size: 'int', chunk_size: 'int', class_: 'StorageClass')

Bases: object

chunk_size: int

Minimum increment level for a Block Storage volume size.

class_: StorageClass

The storage class of the volume.

description: str

The description of the Volume.

max_size: int

Maximum size required for the Volume.

min_size: int

Mimimum size required for the Volume.

type_: VolumeType

Volume Type.

class scaleway.document_db.v1beta1.types.Permission(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

ALL = 'all'

CUSTOM = 'custom'

NONE = 'none'

READONLY = 'readonly'

READWRITE = 'readwrite'

class scaleway.document_db.v1beta1.types.Privilege(permission: 'Permission', database_name: 'str', user_name: 'str')

Bases: object

database_name: str

Name of the database.

permission: Permission

Permission (Read, Read/Write, All, Custom).

user_name: str

Name of the user.

class scaleway.document_db.v1beta1.types.PromoteReadReplicaRequest(read_replica_id: 'str', region: 'Optional[Region]')

Bases: object

read_replica_id: str

UUID of the Read Replica.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.types.PurgeInstanceLogsRequest(instance_id: 'str', region: 'Optional[Region]', log_name: 'Optional[str]')

Bases: object

instance_id: str

UUID of the Database Instance you want logs of.

log_name: Optional[str]

Given log name to purge.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.types.ReadReplica(id: 'str', endpoints: 'List[Endpoint]', status: 'ReadReplicaStatus', region: 'Region', same_zone: 'bool')

Bases: object

endpoints: List[Endpoint]

Display Read Replica connection information.

id: str

UUID of the Read Replica.

region: str

Region the Read Replica is in.

same_zone: bool

Whether the replica is in the same Availability Zone as the main Database Instance nodes or not.

status: ReadReplicaStatus

Read replica status.

class scaleway.document_db.v1beta1.types.ReadReplicaEndpointSpec(direct_access: 'Optional[ReadReplicaEndpointSpecDirectAccess]', private_network: 'Optional[ReadReplicaEndpointSpecPrivateNetwork]')

Bases: object

direct_access: Optional[ReadReplicaEndpointSpecDirectAccess]

private_network: Optional[ReadReplicaEndpointSpecPrivateNetwork]

class scaleway.document_db.v1beta1.types.ReadReplicaEndpointSpecDirectAccess

Bases: object

class scaleway.document_db.v1beta1.types.ReadReplicaEndpointSpecPrivateNetwork(private_network_id: 'str', service_ip: 'Optional[str]', ipam_config: 'Optional[ReadReplicaEndpointSpecPrivateNetworkIpamConfig]')

Bases: object

ipam_config: Optional[ReadReplicaEndpointSpecPrivateNetworkIpamConfig]

private_network_id: str

UUID of the Private Network to be connected to the Read Replica.

service_ip: Optional[str]

class scaleway.document_db.v1beta1.types.ReadReplicaEndpointSpecPrivateNetworkIpamConfig

Bases: object

class scaleway.document_db.v1beta1.types.ReadReplicaStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

CONFIGURING = 'configuring'

DELETING = 'deleting'

ERROR = 'error'

INITIALIZING = 'initializing'

LOCKED = 'locked'

PROMOTING = 'promoting'

PROVISIONING = 'provisioning'

READY = 'ready'

UNKNOWN = 'unknown'

class scaleway.document_db.v1beta1.types.RenewInstanceCertificateRequest(instance_id: 'str', region: 'Optional[Region]')

Bases: object

instance_id: str

UUID of the Database Instance you want logs of.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.types.ResetReadReplicaRequest(read_replica_id: 'str', region: 'Optional[Region]')

Bases: object

read_replica_id: str

UUID of the Read Replica.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.types.RestartInstanceRequest(instance_id: 'str', region: 'Optional[Region]')

Bases: object

instance_id: str

UUID of the Database Instance you want to restart.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.types.SetInstanceACLRulesRequest(instance_id: 'str', rules: 'List[ACLRuleRequest]', region: 'Optional[Region]')

Bases: object

instance_id: str

UUID of the Database Instance where the ACL rules must be set.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

rules: List[ACLRuleRequest]

ACL rules to define for the Database Instance.

class scaleway.document_db.v1beta1.types.SetInstanceACLRulesResponse(rules: 'List[ACLRule]')

Bases: object

rules: List[ACLRule]

ACLs rules configured for a Database Instance.

class scaleway.document_db.v1beta1.types.SetInstanceSettingsRequest(instance_id: 'str', settings: 'List[InstanceSetting]', region: 'Optional[Region]')

Bases: object

instance_id: str

UUID of the Database Instance where the settings must be set.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

settings: List[InstanceSetting]

Settings to define for the Database Instance.

class scaleway.document_db.v1beta1.types.SetInstanceSettingsResponse(settings: 'List[InstanceSetting]')

Bases: object

settings: List[InstanceSetting]

Settings configured for a Database Instance.

class scaleway.document_db.v1beta1.types.SetPrivilegeRequest(instance_id: 'str', database_name: 'str', user_name: 'str', region: 'Optional[Region]', permission: 'Optional[Permission]')

Bases: object

database_name: str

Name of the database.

instance_id: str

UUID of the Database Instance.

permission: Optional[Permission]

Permission to set (Read, Read/Write, All, Custom).

region: Optional[str]

Region to target. If none is passed will use default region from the config.

user_name: str

Name of the user.

class scaleway.document_db.v1beta1.types.Snapshot(id: 'str', instance_id: 'str', name: 'str', status: 'SnapshotStatus', instance_name: 'str', node_type: 'str', region: 'Region', size: 'Optional[int]', expires_at: 'Optional[datetime]', created_at: 'Optional[datetime]', updated_at: 'Optional[datetime]', volume_type: 'Optional[SnapshotVolumeType]')

Bases: object

created_at: Optional[datetime]

Creation date (must follow the ISO 8601 format).

expires_at: Optional[datetime]

Expiration date (must follow the ISO 8601 format).

id: str

UUID of the snapshot.

instance_id: str

UUID of the Database Instance.

instance_name: str

Name of the Database Instance of the snapshot.

name: str

Name of the snapshot.

node_type: str

Source node type.

region: str

Region of this snapshot.

size: Optional[int]

Size of the snapshot.

status: SnapshotStatus

Status of the snapshot.

updated_at: Optional[datetime]

Updated date (must follow the ISO 8601 format).

volume_type: Optional[SnapshotVolumeType]

Type of volume where data is stored (lssd, bssd or sbs).

class scaleway.document_db.v1beta1.types.SnapshotStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

CREATING = 'creating'

DELETING = 'deleting'

ERROR = 'error'

LOCKED = 'locked'

READY = 'ready'

RESTORING = 'restoring'

UNKNOWN = 'unknown'

class scaleway.document_db.v1beta1.types.SnapshotVolumeType(type_: 'VolumeType', class_: 'StorageClass')

Bases: object

class_: StorageClass

type_: VolumeType

class scaleway.document_db.v1beta1.types.StorageClass(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

BSSD = 'bssd'

LSSD = 'lssd'

SBS = 'sbs'

UNKNOWN_STORAGE_CLASS = 'unknown_storage_class'

class scaleway.document_db.v1beta1.types.UpdateInstanceRequest(instance_id: 'str', region: 'Optional[Region]', backup_schedule_frequency: 'Optional[int]', backup_schedule_retention: 'Optional[int]', is_backup_schedule_disabled: 'Optional[bool]', name: 'Optional[str]', tags: 'Optional[List[str]]', logs_policy: 'Optional[LogsPolicy]', backup_same_region: 'Optional[bool]', backup_schedule_start_hour: 'Optional[int]')

Bases: object

backup_same_region: Optional[bool]

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

backup_schedule_frequency: Optional[int]

In hours.

backup_schedule_retention: Optional[int]

In days.

backup_schedule_start_hour: Optional[int]

Defines the start time of the autobackup.

instance_id: str

UUID of the Database Instance to update.

is_backup_schedule_disabled: Optional[bool]

Defines whether or not the backup schedule is disabled.

logs_policy: Optional[LogsPolicy]

Logs policy of the Database Instance.

name: Optional[str]

Name of the Database Instance.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

tags: Optional[List[str]]

Tags of a Database Instance.

class scaleway.document_db.v1beta1.types.UpdateSnapshotRequest(snapshot_id: 'str', region: 'Optional[Region]', name: 'Optional[str]', expires_at: 'Optional[datetime]')

Bases: object

expires_at: Optional[datetime]

Expiration date (must follow the ISO 8601 format).

name: Optional[str]

Name of the snapshot.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

snapshot_id: str

UUID of the snapshot to update.

class scaleway.document_db.v1beta1.types.UpdateUserRequest(instance_id: 'str', name: 'str', region: 'Optional[Region]', password: 'Optional[str]', is_admin: 'Optional[bool]')

Bases: object

instance_id: str

UUID of the Database Instance the user belongs to.

is_admin: Optional[bool]

Defines whether or not this user got administrative privileges.

name: str

Name of the database user.

password: Optional[str]

Password of the database user.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.types.UpgradableVersion(id: 'str', name: 'str', version: 'str', minor_version: 'str')

Bases: object

id: str

minor_version: str

name: str

version: str

class scaleway.document_db.v1beta1.types.UpgradeInstanceRequest(instance_id: 'str', region: 'Optional[Region]', node_type: 'Optional[str]', enable_ha: 'Optional[bool]', volume_size: 'Optional[int]', volume_type: 'Optional[VolumeType]', upgradable_version_id: 'Optional[str]', major_upgrade_workflow: 'Optional[UpgradeInstanceRequestMajorUpgradeWorkflow]')

Bases: object

enable_ha: Optional[bool]

instance_id: str

UUID of the Database Instance you want to upgrade.

major_upgrade_workflow: Optional[UpgradeInstanceRequestMajorUpgradeWorkflow]

node_type: Optional[str]

region: Optional[str]

Region to target. If none is passed will use default region from the config.

upgradable_version_id: Optional[str]

volume_size: Optional[int]

volume_type: Optional[VolumeType]

class scaleway.document_db.v1beta1.types.UpgradeInstanceRequestMajorUpgradeWorkflow(upgradable_version_id: 'str', with_endpoints: 'bool')

Bases: object

upgradable_version_id: str

This will create a new Database Instance with same specifications as the current one and perform a Database Engine upgrade.

with_endpoints: bool

At the end of the migration procedure this option let you migrate all your database endpoint to the upgraded instance.

class scaleway.document_db.v1beta1.types.User(name: 'str', is_admin: 'bool')

Bases: object

is_admin: bool

Defines whether or not a user got administrative privileges on the Database Instance.

name: str

Name of the user (Length must be between 1 and 63 characters. First character must be an alphabet character (a-zA-Z). Your username cannot start with ‘_rdb’ or ‘pg_’. Only a-zA-Z0-9_$- characters are accepted).

class scaleway.document_db.v1beta1.types.Volume(type_: 'VolumeType', size: 'int', class_: 'StorageClass')

Bases: object

class_: StorageClass

size: int

type_: VolumeType

class scaleway.document_db.v1beta1.types.VolumeType(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

BSSD = 'bssd'

LSSD = 'lssd'

SBS_15K = 'sbs_15k'

SBS_5K = 'sbs_5k'

Module contents

class scaleway.document_db.v1beta1.ACLRule(ip: 'str', protocol: 'ACLRuleProtocol', direction: 'ACLRuleDirection', action: 'ACLRuleAction', description: 'str', port: 'Optional[int]')

Bases: object

action: ACLRuleAction

description: str

direction: ACLRuleDirection

ip: str

port: Optional[int]

protocol: ACLRuleProtocol

class scaleway.document_db.v1beta1.ACLRuleAction(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

ALLOW = 'allow'

DENY = 'deny'

class scaleway.document_db.v1beta1.ACLRuleDirection(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

INBOUND = 'inbound'

OUTBOUND = 'outbound'

class scaleway.document_db.v1beta1.ACLRuleProtocol(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

ICMP = 'icmp'

TCP = 'tcp'

UDP = 'udp'

class scaleway.document_db.v1beta1.ACLRuleRequest(ip: 'str', description: 'str')

Bases: object

description: str

ip: str

class scaleway.document_db.v1beta1.AddInstanceACLRulesRequest(instance_id: 'str', rules: 'List[ACLRuleRequest]', region: 'Optional[Region]')

Bases: object

instance_id: str

UUID of the Database Instance you want to add ACL rules to.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

rules: List[ACLRuleRequest]

ACL rules to add to the Database Instance.

class scaleway.document_db.v1beta1.AddInstanceACLRulesResponse(rules: 'List[ACLRule]')

Bases: object

rules: List[ACLRule]

ACL Rules enabled for the Database Instance.

class scaleway.document_db.v1beta1.AddInstanceSettingsRequest(instance_id: 'str', settings: 'List[InstanceSetting]', region: 'Optional[Region]')

Bases: object

instance_id: str

UUID of the Database Instance you want to add settings to.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

settings: List[InstanceSetting]

Settings to add to the Database Instance.

class scaleway.document_db.v1beta1.AddInstanceSettingsResponse(settings: 'List[InstanceSetting]')

Bases: object

settings: List[InstanceSetting]

Settings available on the Database Instance.

class scaleway.document_db.v1beta1.ApplyInstanceMaintenanceRequest(instance_id: 'str', region: 'Optional[Region]')

Bases: object

instance_id: str

UUID of the Database Instance to which you want to apply maintenance.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.BackupSchedule(frequency: 'int', retention: 'int', disabled: 'bool', next_run_at: 'Optional[datetime]')

Bases: object

disabled: bool

Defines whether the backup schedule feature is disabled.

frequency: int

Frequency of the backup schedule (in hours).

next_run_at: Optional[datetime]

Next run of the backup schedule (accurate to 10 minutes).

retention: int

Default retention period of backups (in days).

class scaleway.document_db.v1beta1.CloneInstanceRequest(instance_id: 'str', name: 'str', region: 'Optional[Region]', node_type: 'Optional[str]')

Bases: object

instance_id: str

UUID of the Database Instance you want to clone.

name: str

Name of the Database Instance clone.

node_type: Optional[str]

Node type of the clone.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.CreateDatabaseRequest(instance_id: 'str', name: 'str', region: 'Optional[Region]')

Bases: object

instance_id: str

UUID of the Database Instance where to create the database.

name: str

Name of the database.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.CreateEndpointRequest(instance_id: 'str', region: 'Optional[Region]', endpoint_spec: 'Optional[EndpointSpec]')

Bases: object

endpoint_spec: Optional[EndpointSpec]

Specification of the endpoint you want to create.

instance_id: str

UUID of the Database Instance you to which you want to add an endpoint.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.CreateInstanceFromSnapshotRequest(snapshot_id: 'str', instance_name: 'str', region: 'Optional[Region]', is_ha_cluster: 'Optional[bool]', node_type: 'Optional[str]')

Bases: object

instance_name: str

Name of the Database Instance created with the snapshot.

is_ha_cluster: Optional[bool]

Defines whether or not High Availability is enabled on the new Database Instance.

node_type: Optional[str]

The node type used to restore the snapshot.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

snapshot_id: str

Block snapshot of the Database Instance.

class scaleway.document_db.v1beta1.CreateInstanceRequest(engine: 'str', user_name: 'str', password: 'str', node_type: 'str', region: 'Optional[Region]', name: 'Optional[str]', is_ha_cluster: 'bool', disable_backup: 'bool', volume_size: 'int', backup_same_region: 'bool', tags: 'Optional[List[str]]', init_settings: 'Optional[List[InstanceSetting]]', volume_type: 'Optional[VolumeType]', init_endpoints: 'Optional[List[EndpointSpec]]', organization_id: 'Optional[str]', project_id: 'Optional[str]')

Bases: object

backup_same_region: bool

Defines whether to or not to store logical backups in the same region as the Database Instance.

disable_backup: bool

Defines whether or not backups are disabled.

engine: str

Database engine of the Database Instance.

init_endpoints: Optional[List[EndpointSpec]]

One or multiple EndpointSpec used to expose your Database Instance. A load_balancer public endpoint is systematically created.

init_settings: Optional[List[InstanceSetting]]

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

is_ha_cluster: bool

Defines whether or not High-Availability is enabled.

name: Optional[str]

Name of the Database Instance.

node_type: str

Type of node to use for the Database Instance.

organization_id: Optional[str]

password: str

Password of the user.

project_id: Optional[str]

region: Optional[str]

Region to target. If none is passed will use default region from the config.

tags: Optional[List[str]]

Tags to apply to the Database Instance.

user_name: str

Username created when the Database Instance is created.

volume_size: int

Volume size when volume_type is not lssd.

volume_type: Optional[VolumeType]

Type of volume where data is stored (lssd, bssd, …).

class scaleway.document_db.v1beta1.CreateReadReplicaEndpointRequest(read_replica_id: 'str', endpoint_spec: 'List[ReadReplicaEndpointSpec]', region: 'Optional[Region]')

Bases: object

endpoint_spec: List[ReadReplicaEndpointSpec]

Specification of the endpoint you want to create.

read_replica_id: str

UUID of the Read Replica.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.CreateReadReplicaRequest(instance_id: 'str', region: 'Optional[Region]', endpoint_spec: 'Optional[List[ReadReplicaEndpointSpec]]', same_zone: 'Optional[bool]')

Bases: object

endpoint_spec: Optional[List[ReadReplicaEndpointSpec]]

Specification of the endpoint you want to create.

instance_id: str

UUID of the Database Instance you want to create a Read Replica from.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

same_zone: Optional[bool]

Defines whether or not to create the replica in the same Availability Zone as the main Database Instance nodes.

class scaleway.document_db.v1beta1.CreateSnapshotRequest(instance_id: 'str', region: 'Optional[Region]', name: 'Optional[str]', expires_at: 'Optional[datetime]')

Bases: object

expires_at: Optional[datetime]

Expiration date (must follow the ISO 8601 format).

instance_id: str

UUID of the Database Instance.

name: Optional[str]

Name of the snapshot.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.CreateUserRequest(instance_id: 'str', name: 'str', password: 'str', is_admin: 'bool', region: 'Optional[Region]')

Bases: object

instance_id: str

UUID of the Database Instance in which you want to create a user.

is_admin: bool

Defines whether the user will have administrative privileges.

name: str

Name of the user you want to create.

password: str

Password of the user you want to create.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.Database(name: 'str', owner: 'str', managed: 'bool', size: 'int')

Bases: object

managed: bool

Defines whether the database is managed or not.

name: str

Name of the database.

owner: str

Name of the database owner.

size: int

Size of the database.

class scaleway.document_db.v1beta1.DatabaseEngine(name: 'str', logo_url: 'str', versions: 'List[EngineVersion]', region: 'Region')

Bases: object

logo_url: str

Engine logo URL.

name: str

Engine name.

region: str

Region of this Database Instance.

versions: List[EngineVersion]

Available versions.

class scaleway.document_db.v1beta1.DeleteDatabaseRequest(instance_id: 'str', name: 'str', region: 'Optional[Region]')

Bases: object

instance_id: str

UUID of the Database Instance where to delete the database.

name: str

Name of the database to delete.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.DeleteEndpointRequest(endpoint_id: 'str', region: 'Optional[Region]')

Bases: object

endpoint_id: str

This endpoint can also be used to delete a Read Replica endpoint.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.DeleteInstanceACLRulesRequest(instance_id: 'str', acl_rule_ips: 'List[str]', region: 'Optional[Region]')

Bases: object

acl_rule_ips: List[str]

IP addresses defined in the ACL rules of the Database Instance.

instance_id: str

UUID of the Database Instance you want to delete an ACL rule from.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.DeleteInstanceACLRulesResponse(rules: 'List[ACLRule]')

Bases: object

rules: List[ACLRule]

IP addresses defined in the ACL rules of the Database Instance.

class scaleway.document_db.v1beta1.DeleteInstanceRequest(instance_id: 'str', region: 'Optional[Region]')

Bases: object

instance_id: str

UUID of the Database Instance to delete.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.DeleteInstanceSettingsRequest(instance_id: 'str', setting_names: 'List[str]', region: 'Optional[Region]')

Bases: object

instance_id: str

UUID of the Database Instance to delete settings from.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

setting_names: List[str]

Settings names to delete.

class scaleway.document_db.v1beta1.DeleteInstanceSettingsResponse(settings: 'List[InstanceSetting]')

Bases: object

settings: List[InstanceSetting]

Settings names to delete from the Database Instance.

class scaleway.document_db.v1beta1.DeleteReadReplicaRequest(read_replica_id: 'str', region: 'Optional[Region]')

Bases: object

read_replica_id: str

UUID of the Read Replica.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.DeleteSnapshotRequest(snapshot_id: 'str', region: 'Optional[Region]')

Bases: object

region: Optional[str]

Region to target. If none is passed will use default region from the config.

snapshot_id: str

UUID of the snapshot to delete.

class scaleway.document_db.v1beta1.DeleteUserRequest(instance_id: 'str', name: 'str', region: 'Optional[Region]')

Bases: object

instance_id: str

UUID of the Database Instance to delete the user from.

name: str

Name of the user.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.DocumentDbV1Beta1API(client: Client, *, bypass_validation: bool = False)

Bases: API

This API allows you to manage your Document Databases.

add_instance_acl_rules(*, instance_id: str, rules: List[ACLRuleRequest], region: Optional[str] = None) → AddInstanceACLRulesResponse

Add an ACL rule to a Database Instance. Add an additional ACL rule to a Database Instance. :param instance_id: UUID of the Database Instance you want to add ACL rules to. :param rules: ACL rules to add to the Database Instance. :param region: Region to target. If none is passed will use default region from the config. :return: AddInstanceACLRulesResponse

Usage:

result = api.add_instance_acl_rules(
    instance_id="example",
    rules=[],
)

add_instance_settings(*, instance_id: str, settings: List[InstanceSetting], region: Optional[str] = None) → 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. :param instance_id: UUID of the Database Instance you want to add settings to. :param settings: Settings to add to the Database Instance. :param region: Region to target. If none is passed will use default region from the config. :return: AddInstanceSettingsResponse

Usage:

result = api.add_instance_settings(
    instance_id="example",
    settings=[],
)

apply_instance_maintenance(*, instance_id: str, region: Optional[str] = None) → Maintenance

Apply an instance maintenance. Apply a pending instance maintenance on your instance. This action can generate some service interruption. :param instance_id: UUID of the Database Instance to which you want to apply maintenance. :param region: Region to target. If none is passed will use default region from the config. :return: Maintenance

Usage:

result = api.apply_instance_maintenance(
    instance_id="example",
)

clone_instance(*, instance_id: str, name: str, region: Optional[str] = None, node_type: Optional[str] = None) → 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. :param instance_id: UUID of the Database Instance you want to clone. :param name: Name of the Database Instance clone. :param region: Region to target. If none is passed will use default region from the config. :param node_type: Node type of the clone. :return: Instance

Usage:

result = api.clone_instance(
    instance_id="example",
    name="example",
)

create_database(*, instance_id: str, name: str, region: Optional[str] = None) → Database

Create a database in a Database Instance. Create a new database. You must define the name parameter in the request. :param instance_id: UUID of the Database Instance where to create the database. :param name: Name of the database. :param region: Region to target. If none is passed will use default region from the config. :return: Database

Usage:

result = api.create_database(
    instance_id="example",
    name="example",
)

create_endpoint(*, instance_id: str, region: Optional[str] = None, endpoint_spec: Optional[EndpointSpec] = None) → 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. :param instance_id: UUID of the Database Instance you to which you want to add an endpoint. :param region: Region to target. If none is passed will use default region from the config. :param endpoint_spec: Specification of the endpoint you want to create. :return: Endpoint

Usage:

result = api.create_endpoint(
    instance_id="example",
)

create_instance(*, engine: str, user_name: str, password: str, node_type: str, region: Optional[str] = None, organization_id: Optional[str] = None, project_id: Optional[str] = None, name: Optional[str] = None, is_ha_cluster: bool, disable_backup: bool, volume_size: int, backup_same_region: bool, tags: Optional[List[str]] = None, init_settings: Optional[List[InstanceSetting]] = None, volume_type: Optional[VolumeType] = None, init_endpoints: Optional[List[EndpointSpec]] = None) → 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. :param engine: Database engine of the Database Instance. :param user_name: Username created when the Database Instance is created. :param password: Password of the user. :param node_type: Type of node to use for the Database Instance. :param region: Region to target. If none is passed will use default region from the config. :param organization_id: Please use project_id instead. One-Of (‘project_identifier’): at most one of ‘organization_id’, ‘project_id’ could be set. :param project_id: The Project ID on which the Database Instance will be created. One-Of (‘project_identifier’): at most one of ‘organization_id’, ‘project_id’ could be set. :param name: Name of the Database Instance. :param is_ha_cluster: Defines whether or not High-Availability is enabled. :param disable_backup: Defines whether or not backups are disabled. :param volume_size: Volume size when volume_type is not lssd. :param backup_same_region: Defines whether to or not to store logical backups in the same region as the Database Instance. :param tags: Tags to apply to the Database Instance. :param init_settings: List of engine settings to be set upon Database Instance initialization. :param volume_type: Type of volume where data is stored (lssd, bssd, …). :param init_endpoints: One or multiple EndpointSpec used to expose your Database Instance. A load_balancer public endpoint is systematically created. :return: Instance

Usage:

result = api.create_instance(
    engine="example",
    user_name="example",
    password="example",
    node_type="example",
    is_ha_cluster=False,
    disable_backup=False,
    volume_size=1,
    backup_same_region=False,
)

create_instance_from_snapshot(*, snapshot_id: str, instance_name: str, region: Optional[str] = None, is_ha_cluster: Optional[bool] = None, node_type: Optional[str] = None) → 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. :param snapshot_id: Block snapshot of the Database Instance. :param instance_name: Name of the Database Instance created with the snapshot. :param region: Region to target. If none is passed will use default region from the config. :param is_ha_cluster: Defines whether or not High Availability is enabled on the new Database Instance. :param node_type: The node type used to restore the snapshot. :return: Instance

Usage:

result = api.create_instance_from_snapshot(
    snapshot_id="example",
    instance_name="example",
)

create_read_replica(*, instance_id: str, region: Optional[str] = None, endpoint_spec: Optional[List[ReadReplicaEndpointSpec]] = None, same_zone: Optional[bool] = None) → 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. :param instance_id: UUID of the Database Instance you want to create a Read Replica from. :param region: Region to target. If none is passed will use default region from the config. :param endpoint_spec: Specification of the endpoint you want to create. :param same_zone: Defines whether or not to create the replica in the same Availability Zone as the main Database Instance nodes. :return: ReadReplica

Usage:

result = api.create_read_replica(
    instance_id="example",
)

create_read_replica_endpoint(*, read_replica_id: str, endpoint_spec: List[ReadReplicaEndpointSpec], region: Optional[str] = None) → 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. :param read_replica_id: UUID of the Read Replica. :param endpoint_spec: Specification of the endpoint you want to create. :param region: Region to target. If none is passed will use default region from the config. :return: ReadReplica

Usage:

result = api.create_read_replica_endpoint(
    read_replica_id="example",
    endpoint_spec=[],
)

create_snapshot(*, instance_id: str, region: Optional[str] = None, name: Optional[str] = None, expires_at: Optional[datetime] = None) → Snapshot

Create a Database Instance snapshot. Create a new snapshot of a Database Instance. You must define the name parameter in the request. :param instance_id: UUID of the Database Instance. :param region: Region to target. If none is passed will use default region from the config. :param name: Name of the snapshot. :param expires_at: Expiration date (must follow the ISO 8601 format). :return: Snapshot

Usage:

result = api.create_snapshot(
    instance_id="example",
)

create_user(*, instance_id: str, name: str, password: str, is_admin: bool, region: Optional[str] = None) → 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. :param instance_id: UUID of the Database Instance in which you want to create a user. :param name: Name of the user you want to create. :param password: Password of the user you want to create. :param is_admin: Defines whether the user will have administrative privileges. :param region: Region to target. If none is passed will use default region from the config. :return: User

Usage:

result = api.create_user(
    instance_id="example",
    name="example",
    password="example",
    is_admin=False,
)

delete_database(*, instance_id: str, name: str, region: Optional[str] = None) → None

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. :param instance_id: UUID of the Database Instance where to delete the database. :param name: Name of the database to delete. :param region: Region to target. If none is passed will use default region from the config.

Usage:

result = api.delete_database(
    instance_id="example",
    name="example",
)

delete_endpoint(*, endpoint_id: str, region: Optional[str] = None) → None

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. :param endpoint_id: This endpoint can also be used to delete a Read Replica endpoint. :param region: Region to target. If none is passed will use default region from the config.

Usage:

result = api.delete_endpoint(
    endpoint_id="example",
)

delete_instance(*, instance_id: str, region: Optional[str] = None) → 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. :param instance_id: UUID of the Database Instance to delete. :param region: Region to target. If none is passed will use default region from the config. :return: Instance

Usage:

result = api.delete_instance(
    instance_id="example",
)

delete_instance_acl_rules(*, instance_id: str, acl_rule_ips: List[str], region: Optional[str] = None) → DeleteInstanceACLRulesResponse

Delete ACL rules of a Database Instance. Delete one or more ACL rules of a Database Instance. :param instance_id: UUID of the Database Instance you want to delete an ACL rule from. :param acl_rule_ips: IP addresses defined in the ACL rules of the Database Instance. :param region: Region to target. If none is passed will use default region from the config. :return: DeleteInstanceACLRulesResponse

Usage:

result = api.delete_instance_acl_rules(
    instance_id="example",
    acl_rule_ips=[],
)

delete_instance_settings(*, instance_id: str, setting_names: List[str], region: Optional[str] = None) → 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. :param instance_id: UUID of the Database Instance to delete settings from. :param setting_names: Settings names to delete. :param region: Region to target. If none is passed will use default region from the config. :return: DeleteInstanceSettingsResponse

Usage:

result = api.delete_instance_settings(
    instance_id="example",
    setting_names=[],
)

delete_read_replica(*, read_replica_id: str, region: Optional[str] = None) → 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. :param read_replica_id: UUID of the Read Replica. :param region: Region to target. If none is passed will use default region from the config. :return: ReadReplica

Usage:

result = api.delete_read_replica(
    read_replica_id="example",
)

delete_snapshot(*, snapshot_id: str, region: Optional[str] = None) → 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. :param snapshot_id: UUID of the snapshot to delete. :param region: Region to target. If none is passed will use default region from the config. :return: Snapshot

Usage:

result = api.delete_snapshot(
    snapshot_id="example",
)

delete_user(*, instance_id: str, name: str, region: Optional[str] = None) → None

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. :param instance_id: UUID of the Database Instance to delete the user from. :param name: Name of the user. :param region: Region to target. If none is passed will use default region from the config.

Usage:

result = api.delete_user(
    instance_id="example",
    name="example",
)

get_endpoint(*, endpoint_id: str, region: Optional[str] = None) → 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. :param endpoint_id: UUID of the endpoint you want to get. :param region: Region to target. If none is passed will use default region from the config. :return: Endpoint

Usage:

result = api.get_endpoint(
    endpoint_id="example",
)

get_instance(*, instance_id: str, region: Optional[str] = None) → 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. :param instance_id: UUID of the Database Instance. :param region: Region to target. If none is passed will use default region from the config. :return: Instance

Usage:

result = api.get_instance(
    instance_id="example",
)

get_instance_certificate(*, instance_id: str, region: Optional[str] = None) → ScwFile

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. :param instance_id: UUID of the Database Instance. :param region: Region to target. If none is passed will use default region from the config. :return: ScwFile

Usage:

result = api.get_instance_certificate(
    instance_id="example",
)

get_instance_log(*, instance_log_id: str, region: Optional[str] = None) → 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. :param instance_log_id: UUID of the instance_log you want. :param region: Region to target. If none is passed will use default region from the config. :return: InstanceLog

Usage:

result = api.get_instance_log(
    instance_log_id="example",
)

get_instance_metrics(*, instance_id: str, region: Optional[str] = None, start_date: Optional[datetime] = None, end_date: Optional[datetime] = None, metric_name: Optional[str] = None) → 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. :param instance_id: UUID of the Database Instance. :param region: Region to target. If none is passed will use default region from the config. :param start_date: Start date to gather metrics from. :param end_date: End date to gather metrics from. :param metric_name: Name of the metric to gather. :return: InstanceMetrics

Usage:

result = api.get_instance_metrics(
    instance_id="example",
)

get_read_replica(*, read_replica_id: str, region: Optional[str] = None) → 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. :param read_replica_id: UUID of the Read Replica. :param region: Region to target. If none is passed will use default region from the config. :return: ReadReplica

Usage:

result = api.get_read_replica(
    read_replica_id="example",
)

get_snapshot(*, snapshot_id: str, region: Optional[str] = None) → 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. :param snapshot_id: UUID of the snapshot. :param region: Region to target. If none is passed will use default region from the config. :return: Snapshot

Usage:

result = api.get_snapshot(
    snapshot_id="example",
)

list_database_engines(*, region: Optional[str] = None, name: Optional[str] = None, version: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None) → ListDatabaseEnginesResponse

List available database engines. List the FerretDB database engines available at Scaleway. :param region: Region to target. If none is passed will use default region from the config. :param name: Name of the database engine. :param version: Version of the database engine. :param page: :param page_size: :return: ListDatabaseEnginesResponse

Usage:

result = api.list_database_engines()

list_database_engines_all(*, region: Optional[str] = None, name: Optional[str] = None, version: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None) → List[DatabaseEngine]

List available database engines. List the FerretDB database engines available at Scaleway. :param region: Region to target. If none is passed will use default region from the config. :param name: Name of the database engine. :param version: Version of the database engine. :param page: :param page_size: :return: List[DatabaseEngine]

Usage:

result = api.list_database_engines_all()

list_databases(*, instance_id: str, region: Optional[str] = None, name: Optional[str] = None, managed: Optional[bool] = None, owner: Optional[str] = None, order_by: Optional[ListDatabasesRequestOrderBy] = None, page: Optional[int] = None, page_size: Optional[int] = None) → ListDatabasesResponse

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. :param instance_id: UUID of the Database Instance to list the databases of. :param region: Region to target. If none is passed will use default region from the config. :param name: Name of the database. :param managed: Defines whether or not the database is managed. :param owner: User that owns this database. :param order_by: Criteria to use when ordering database listing. :param page: :param page_size: :return: ListDatabasesResponse

Usage:

result = api.list_databases(
    instance_id="example",
)

list_databases_all(*, instance_id: str, region: Optional[str] = None, name: Optional[str] = None, managed: Optional[bool] = None, owner: Optional[str] = None, order_by: Optional[ListDatabasesRequestOrderBy] = None, page: Optional[int] = None, page_size: Optional[int] = None) → List[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. :param instance_id: UUID of the Database Instance to list the databases of. :param region: Region to target. If none is passed will use default region from the config. :param name: Name of the database. :param managed: Defines whether or not the database is managed. :param owner: User that owns this database. :param order_by: Criteria to use when ordering database listing. :param page: :param page_size: :return: List[Database]

Usage:

result = api.list_databases_all(
    instance_id="example",
)

list_instance_acl_rules(*, instance_id: str, region: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None) → ListInstanceACLRulesResponse

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. :param instance_id: UUID of the Database Instance. :param region: Region to target. If none is passed will use default region from the config. :param page: :param page_size: :return: ListInstanceACLRulesResponse

Usage:

result = api.list_instance_acl_rules(
    instance_id="example",
)

list_instance_acl_rules_all(*, instance_id: str, region: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None) → List[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. :param instance_id: UUID of the Database Instance. :param region: Region to target. If none is passed will use default region from the config. :param page: :param page_size: :return: List[ACLRule]

Usage:

result = api.list_instance_acl_rules_all(
    instance_id="example",
)

list_instance_logs(*, instance_id: str, region: Optional[str] = None, order_by: Optional[ListInstanceLogsRequestOrderBy] = None) → 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. :param instance_id: UUID of the Database Instance you want logs of. :param region: Region to target. If none is passed will use default region from the config. :param order_by: Criteria to use when ordering Database Instance logs listing. :return: ListInstanceLogsResponse

Usage:

result = api.list_instance_logs(
    instance_id="example",
)

list_instance_logs_details(*, instance_id: str, region: Optional[str] = None) → 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. :param instance_id: UUID of the Database Instance you want logs of. :param region: Region to target. If none is passed will use default region from the config. :return: ListInstanceLogsDetailsResponse

Usage:

result = api.list_instance_logs_details(
    instance_id="example",
)

list_instances(*, region: Optional[str] = None, tags: Optional[List[str]] = None, name: Optional[str] = None, order_by: Optional[ListInstancesRequestOrderBy] = None, organization_id: Optional[str] = None, project_id: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None) → ListInstancesResponse

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. :param region: Region to target. If none is passed will use default region from the config. :param tags: List Database Instances that have a given tag. :param name: Lists Database Instances that match a name pattern. :param order_by: Criteria to use when ordering Database Instance listings. :param organization_id: Please use project_id instead. :param project_id: Project ID to list the Database Instance of. :param page: :param page_size: :return: ListInstancesResponse

Usage:

result = api.list_instances()

list_instances_all(*, region: Optional[str] = None, tags: Optional[List[str]] = None, name: Optional[str] = None, order_by: Optional[ListInstancesRequestOrderBy] = None, organization_id: Optional[str] = None, project_id: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None) → List[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. :param region: Region to target. If none is passed will use default region from the config. :param tags: List Database Instances that have a given tag. :param name: Lists Database Instances that match a name pattern. :param order_by: Criteria to use when ordering Database Instance listings. :param organization_id: Please use project_id instead. :param project_id: Project ID to list the Database Instance of. :param page: :param page_size: :return: List[Instance]

Usage:

result = api.list_instances_all()

list_node_types(*, include_disabled_types: bool, region: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None) → ListNodeTypesResponse

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. :param include_disabled_types: Defines whether or not to include disabled types. :param region: Region to target. If none is passed will use default region from the config. :param page: :param page_size: :return: ListNodeTypesResponse

Usage:

result = api.list_node_types(
    include_disabled_types=False,
)

list_node_types_all(*, include_disabled_types: bool, region: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None) → List[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. :param include_disabled_types: Defines whether or not to include disabled types. :param region: Region to target. If none is passed will use default region from the config. :param page: :param page_size: :return: List[NodeType]

Usage:

result = api.list_node_types_all(
    include_disabled_types=False,
)

list_privileges(*, instance_id: str, region: Optional[str] = None, order_by: Optional[ListPrivilegesRequestOrderBy] = None, page: Optional[int] = None, page_size: Optional[int] = None, database_name: Optional[str] = None, user_name: Optional[str] = None) → ListPrivilegesResponse

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. :param instance_id: UUID of the Database Instance. :param region: Region to target. If none is passed will use default region from the config. :param order_by: Criteria to use when ordering privileges listing. :param page: :param page_size: :param database_name: Name of the database. :param user_name: Name of the user. :return: ListPrivilegesResponse

Usage:

result = api.list_privileges(
    instance_id="example",
)

list_privileges_all(*, instance_id: str, region: Optional[str] = None, order_by: Optional[ListPrivilegesRequestOrderBy] = None, page: Optional[int] = None, page_size: Optional[int] = None, database_name: Optional[str] = None, user_name: Optional[str] = None) → List[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. :param instance_id: UUID of the Database Instance. :param region: Region to target. If none is passed will use default region from the config. :param order_by: Criteria to use when ordering privileges listing. :param page: :param page_size: :param database_name: Name of the database. :param user_name: Name of the user. :return: List[Privilege]

Usage:

result = api.list_privileges_all(
    instance_id="example",
)

list_snapshots(*, region: Optional[str] = None, name: Optional[str] = None, order_by: Optional[ListSnapshotsRequestOrderBy] = None, instance_id: Optional[str] = None, organization_id: Optional[str] = None, project_id: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None) → ListSnapshotsResponse

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. :param region: Region to target. If none is passed will use default region from the config. :param name: Name of the snapshot. :param order_by: Criteria to use when ordering snapshot listing. :param instance_id: UUID of the Database Instance. :param organization_id: Organization ID the snapshots belongs to. :param project_id: Project ID the snapshots belongs to. :param page: :param page_size: :return: ListSnapshotsResponse

Usage:

result = api.list_snapshots()

list_snapshots_all(*, region: Optional[str] = None, name: Optional[str] = None, order_by: Optional[ListSnapshotsRequestOrderBy] = None, instance_id: Optional[str] = None, organization_id: Optional[str] = None, project_id: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None) → List[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. :param region: Region to target. If none is passed will use default region from the config. :param name: Name of the snapshot. :param order_by: Criteria to use when ordering snapshot listing. :param instance_id: UUID of the Database Instance. :param organization_id: Organization ID the snapshots belongs to. :param project_id: Project ID the snapshots belongs to. :param page: :param page_size: :return: List[Snapshot]

Usage:

result = api.list_snapshots_all()

list_users(*, instance_id: str, region: Optional[str] = None, name: Optional[str] = None, order_by: Optional[ListUsersRequestOrderBy] = None, page: Optional[int] = None, page_size: Optional[int] = None) → ListUsersResponse

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. :param instance_id: UUID of the Database Instance. :param region: Region to target. If none is passed will use default region from the config. :param name: Name of the user. :param order_by: Criteria to use when requesting user listing. :param page: :param page_size: :return: ListUsersResponse

Usage:

result = api.list_users(
    instance_id="example",
)

list_users_all(*, instance_id: str, region: Optional[str] = None, name: Optional[str] = None, order_by: Optional[ListUsersRequestOrderBy] = None, page: Optional[int] = None, page_size: Optional[int] = None) → List[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. :param instance_id: UUID of the Database Instance. :param region: Region to target. If none is passed will use default region from the config. :param name: Name of the user. :param order_by: Criteria to use when requesting user listing. :param page: :param page_size: :return: List[User]

Usage:

result = api.list_users_all(
    instance_id="example",
)

migrate_endpoint(*, endpoint_id: str, instance_id: str, region: Optional[str] = None) → Endpoint

Migrate Database Instance endpoint. Migrate an existing Database Instance endpoint to another Database Instance. :param endpoint_id: UUID of the endpoint you want to migrate. :param instance_id: UUID of the instance you want to attach the endpoint to. :param region: Region to target. If none is passed will use default region from the config. :return: Endpoint

Usage:

result = api.migrate_endpoint(
    endpoint_id="example",
    instance_id="example",
)

promote_read_replica(*, read_replica_id: str, region: Optional[str] = None) → Instance

Promote a Read Replica. Promote a Read Replica to Database Instance automatically. :param read_replica_id: UUID of the Read Replica. :param region: Region to target. If none is passed will use default region from the config. :return: Instance

Usage:

result = api.promote_read_replica(
    read_replica_id="example",
)

purge_instance_logs(*, instance_id: str, region: Optional[str] = None, log_name: Optional[str] = None) → None

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. :param instance_id: UUID of the Database Instance you want logs of. :param region: Region to target. If none is passed will use default region from the config. :param log_name: Given log name to purge.

Usage:

result = api.purge_instance_logs(
    instance_id="example",
)

renew_instance_certificate(*, instance_id: str, region: Optional[str] = None) → None

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. :param instance_id: UUID of the Database Instance you want logs of. :param region: Region to target. If none is passed will use default region from the config.

Usage:

result = api.renew_instance_certificate(
    instance_id="example",
)

reset_read_replica(*, read_replica_id: str, region: Optional[str] = None) → 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. :param read_replica_id: UUID of the Read Replica. :param region: Region to target. If none is passed will use default region from the config. :return: ReadReplica

Usage:

result = api.reset_read_replica(
    read_replica_id="example",
)

restart_instance(*, instance_id: str, region: Optional[str] = None) → 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. :param instance_id: UUID of the Database Instance you want to restart. :param region: Region to target. If none is passed will use default region from the config. :return: Instance

Usage:

result = api.restart_instance(
    instance_id="example",
)

set_instance_acl_rules(*, instance_id: str, rules: List[ACLRuleRequest], region: Optional[str] = None) → SetInstanceACLRulesResponse

Set ACL rules for a Database Instance. Replace all the ACL rules of a Database Instance. :param instance_id: UUID of the Database Instance where the ACL rules must be set. :param rules: ACL rules to define for the Database Instance. :param region: Region to target. If none is passed will use default region from the config. :return: SetInstanceACLRulesResponse

Usage:

result = api.set_instance_acl_rules(
    instance_id="example",
    rules=[],
)

set_instance_settings(*, instance_id: str, settings: List[InstanceSetting], region: Optional[str] = None) → 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. :param instance_id: UUID of the Database Instance where the settings must be set. :param settings: Settings to define for the Database Instance. :param region: Region to target. If none is passed will use default region from the config. :return: SetInstanceSettingsResponse

Usage:

result = api.set_instance_settings(
    instance_id="example",
    settings=[],
)

set_privilege(*, instance_id: str, database_name: str, user_name: str, region: Optional[str] = None, permission: Optional[Permission] = None) → 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. :param instance_id: UUID of the Database Instance. :param database_name: Name of the database. :param user_name: Name of the user. :param region: Region to target. If none is passed will use default region from the config. :param permission: Permission to set (Read, Read/Write, All, Custom). :return: Privilege

Usage:

result = api.set_privilege(
    instance_id="example",
    database_name="example",
    user_name="example",
)

update_instance(*, instance_id: str, region: Optional[str] = None, backup_schedule_frequency: Optional[int] = None, backup_schedule_retention: Optional[int] = None, is_backup_schedule_disabled: Optional[bool] = None, name: Optional[str] = None, tags: Optional[List[str]] = None, logs_policy: Optional[LogsPolicy] = None, backup_same_region: Optional[bool] = None, backup_schedule_start_hour: Optional[int] = None) → Instance

Update a Database Instance. Update the parameters of a Database Instance, including name, tags and backup schedule details. :param instance_id: UUID of the Database Instance to update. :param region: Region to target. If none is passed will use default region from the config. :param backup_schedule_frequency: In hours. :param backup_schedule_retention: In days. :param is_backup_schedule_disabled: Defines whether or not the backup schedule is disabled. :param name: Name of the Database Instance. :param tags: Tags of a Database Instance. :param logs_policy: Logs policy of the Database Instance. :param backup_same_region: Store logical backups in the same region as the Database Instance. :param backup_schedule_start_hour: Defines the start time of the autobackup. :return: Instance

Usage:

result = api.update_instance(
    instance_id="example",
)

update_snapshot(*, snapshot_id: str, region: Optional[str] = None, name: Optional[str] = None, expires_at: Optional[datetime] = None) → 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. :param snapshot_id: UUID of the snapshot to update. :param region: Region to target. If none is passed will use default region from the config. :param name: Name of the snapshot. :param expires_at: Expiration date (must follow the ISO 8601 format). :return: Snapshot

Usage:

result = api.update_snapshot(
    snapshot_id="example",
)

update_user(*, instance_id: str, name: str, region: Optional[str] = None, password: Optional[str] = None, is_admin: Optional[bool] = None) → 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. :param instance_id: UUID of the Database Instance the user belongs to. :param name: Name of the database user. :param region: Region to target. If none is passed will use default region from the config. :param password: Password of the database user. :param is_admin: Defines whether or not this user got administrative privileges. :return: User

Usage:

result = api.update_user(
    instance_id="example",
    name="example",
)

upgrade_instance(*, instance_id: str, region: Optional[str] = None, node_type: Optional[str] = None, enable_ha: Optional[bool] = None, volume_size: Optional[int] = None, volume_type: Optional[VolumeType] = None, upgradable_version_id: Optional[str] = None, major_upgrade_workflow: Optional[UpgradeInstanceRequestMajorUpgradeWorkflow] = None) → 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. :param instance_id: UUID of the Database Instance you want to upgrade. :param region: Region to target. If none is passed will use default region from the config. :param node_type: Node type of the Database Instance you want to upgrade to. One-Of (‘upgrade_target’): at most one of ‘node_type’, ‘enable_ha’, ‘volume_size’, ‘volume_type’, ‘upgradable_version_id’, ‘major_upgrade_workflow’ could be set. :param enable_ha: Defines whether or not High Availability should be enabled on the Database Instance. One-Of (‘upgrade_target’): at most one of ‘node_type’, ‘enable_ha’, ‘volume_size’, ‘volume_type’, ‘upgradable_version_id’, ‘major_upgrade_workflow’ could be set. :param volume_size: Increase your Block volume size. One-Of (‘upgrade_target’): at most one of ‘node_type’, ‘enable_ha’, ‘volume_size’, ‘volume_type’, ‘upgradable_version_id’, ‘major_upgrade_workflow’ could be set. :param volume_type: Change your Database Instance storage type. One-Of (‘upgrade_target’): at most one of ‘node_type’, ‘enable_ha’, ‘volume_size’, ‘volume_type’, ‘upgradable_version_id’, ‘major_upgrade_workflow’ could be set. :param upgradable_version_id: This will create a new Database Instance with same specifications as the current one and perform a Database Engine upgrade. One-Of (‘upgrade_target’): at most one of ‘node_type’, ‘enable_ha’, ‘volume_size’, ‘volume_type’, ‘upgradable_version_id’, ‘major_upgrade_workflow’ could be set. :param major_upgrade_workflow: Upgrade your database engine to a new major version including instance endpoints. One-Of (‘upgrade_target’): at most one of ‘node_type’, ‘enable_ha’, ‘volume_size’, ‘volume_type’, ‘upgradable_version_id’, ‘major_upgrade_workflow’ could be set. :return: Instance

Usage:

result = api.upgrade_instance(
    instance_id="example",
)

wait_for_instance(*, instance_id: str, region: Optional[str] = None, options: Optional[WaitForOptions[Instance, bool]] = None) → 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. :param instance_id: UUID of the Database Instance. :param region: Region to target. If none is passed will use default region from the config. :return: Instance

Usage:

result = api.get_instance(
    instance_id="example",
)

wait_for_instance_log(*, instance_log_id: str, region: Optional[str] = None, options: Optional[WaitForOptions[InstanceLog, bool]] = None) → 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. :param instance_log_id: UUID of the instance_log you want. :param region: Region to target. If none is passed will use default region from the config. :return: InstanceLog

Usage:

result = api.get_instance_log(
    instance_log_id="example",
)

wait_for_read_replica(*, read_replica_id: str, region: Optional[str] = None, options: Optional[WaitForOptions[ReadReplica, bool]] = None) → 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. :param read_replica_id: UUID of the Read Replica. :param region: Region to target. If none is passed will use default region from the config. :return: ReadReplica

Usage:

result = api.get_read_replica(
    read_replica_id="example",
)

wait_for_snapshot(*, snapshot_id: str, region: Optional[str] = None, options: Optional[WaitForOptions[Snapshot, bool]] = None) → 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. :param snapshot_id: UUID of the snapshot. :param region: Region to target. If none is passed will use default region from the config. :return: Snapshot

Usage:

result = api.get_snapshot(
    snapshot_id="example",
)

class scaleway.document_db.v1beta1.Endpoint(id: 'str', port: 'int', name: 'Optional[str]', ip: 'Optional[str]', hostname: 'Optional[str]', private_network: 'Optional[EndpointPrivateNetworkDetails]', load_balancer: 'Optional[EndpointLoadBalancerDetails]', direct_access: 'Optional[EndpointDirectAccessDetails]')

Bases: object

direct_access: Optional[EndpointDirectAccessDetails]

hostname: Optional[str]

id: str

UUID of the endpoint.

ip: Optional[str]

load_balancer: Optional[EndpointLoadBalancerDetails]

name: Optional[str]

Name of the endpoint.

port: int

TCP port of the endpoint.

private_network: Optional[EndpointPrivateNetworkDetails]

class scaleway.document_db.v1beta1.EndpointDirectAccessDetails

Bases: object

class scaleway.document_db.v1beta1.EndpointLoadBalancerDetails

Bases: object

class scaleway.document_db.v1beta1.EndpointPrivateNetworkDetails(private_network_id: 'str', service_ip: 'str', zone: 'Zone')

Bases: object

private_network_id: str

UUID of the Private Network.

service_ip: str

CIDR notation of the endpoint IPv4 address.

zone: str

Private network zone.

class scaleway.document_db.v1beta1.EndpointSpec(load_balancer: 'Optional[EndpointSpecLoadBalancer]', private_network: 'Optional[EndpointSpecPrivateNetwork]')

Bases: object

load_balancer: Optional[EndpointSpecLoadBalancer]

private_network: Optional[EndpointSpecPrivateNetwork]

class scaleway.document_db.v1beta1.EndpointSpecLoadBalancer

Bases: object

class scaleway.document_db.v1beta1.EndpointSpecPrivateNetwork(private_network_id: 'str', service_ip: 'Optional[str]', ipam_config: 'Optional[EndpointSpecPrivateNetworkIpamConfig]')

Bases: object

ipam_config: Optional[EndpointSpecPrivateNetworkIpamConfig]

private_network_id: str

UUID of the Private Network to be connected to the Database Instance.

service_ip: Optional[str]

class scaleway.document_db.v1beta1.EndpointSpecPrivateNetworkIpamConfig

Bases: object

class scaleway.document_db.v1beta1.EngineSetting(name: 'str', default_value: 'str', hot_configurable: 'bool', description: 'str', property_type: 'EngineSettingPropertyType', unit: 'Optional[str]', string_constraint: 'Optional[str]', int_min: 'Optional[int]', int_max: 'Optional[int]', float_min: 'Optional[float]', float_max: 'Optional[float]')

Bases: object

default_value: str

Value set when not specified.

description: str

Setting description.

float_max: Optional[float]

Maximum value for float types.

float_min: Optional[float]

Minimum value for float types.

hot_configurable: bool

Setting can be applied without restarting.

int_max: Optional[int]

Maximum value for int types.

int_min: Optional[int]

Minimum value for int types.

name: str

Setting name from the database engine.

property_type: EngineSettingPropertyType

Setting type.

string_constraint: Optional[str]

Validation regex for string type settings.

unit: Optional[str]

Setting base unit.

class scaleway.document_db.v1beta1.EngineSettingPropertyType(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

BOOLEAN = 'boolean'

FLOAT = 'float'

INT = 'int'

STRING = 'string'

class scaleway.document_db.v1beta1.EngineVersion(version: 'str', name: 'str', available_settings: 'List[EngineSetting]', disabled: 'bool', beta: 'bool', available_init_settings: 'List[EngineSetting]', end_of_life: 'Optional[datetime]')

Bases: object

available_init_settings: List[EngineSetting]

Engine settings available to be set at database initialization.

available_settings: List[EngineSetting]

Engine settings available to be set.

beta: bool

Beta status of engine version.

disabled: bool

Disabled versions cannot be created.

end_of_life: Optional[datetime]

End of life date.

name: str

Database engine name.

version: str

Database engine version.

class scaleway.document_db.v1beta1.GetEndpointRequest(endpoint_id: 'str', region: 'Optional[Region]')

Bases: object

endpoint_id: str

UUID of the endpoint you want to get.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.GetInstanceCertificateRequest(instance_id: 'str', region: 'Optional[Region]')

Bases: object

instance_id: str

UUID of the Database Instance.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.GetInstanceLogRequest(instance_log_id: 'str', region: 'Optional[Region]')

Bases: object

instance_log_id: str

UUID of the instance_log you want.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.GetInstanceMetricsRequest(instance_id: 'str', region: 'Optional[Region]', start_date: 'Optional[datetime]', end_date: 'Optional[datetime]', metric_name: 'Optional[str]')

Bases: object

end_date: Optional[datetime]

End date to gather metrics from.

instance_id: str

UUID of the Database Instance.

metric_name: Optional[str]

Name of the metric to gather.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

start_date: Optional[datetime]

Start date to gather metrics from.

class scaleway.document_db.v1beta1.GetInstanceRequest(instance_id: 'str', region: 'Optional[Region]')

Bases: object

instance_id: str

UUID of the Database Instance.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.GetReadReplicaRequest(read_replica_id: 'str', region: 'Optional[Region]')

Bases: object

read_replica_id: str

UUID of the Read Replica.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.GetSnapshotRequest(snapshot_id: 'str', region: 'Optional[Region]')

Bases: object

region: Optional[str]

Region to target. If none is passed will use default region from the config.

snapshot_id: str

UUID of the snapshot.

class scaleway.document_db.v1beta1.Instance(region: 'Region', id: 'str', name: 'str', organization_id: 'str', created_at: 'Optional[datetime]', volume: 'Optional[Volume]', project_id: 'str', status: 'InstanceStatus', engine: 'str', upgradable_version: 'List[UpgradableVersion]', tags: 'List[str]', settings: 'List[InstanceSetting]', is_ha_cluster: 'bool', endpoint: 'Optional[Endpoint]', backup_schedule: 'Optional[BackupSchedule]', read_replicas: 'List[ReadReplica]', node_type: 'str', init_settings: 'List[InstanceSetting]', endpoints: 'List[Endpoint]', backup_same_region: 'bool', maintenances: 'List[Maintenance]', logs_policy: 'Optional[LogsPolicy]')

Bases: object

backup_same_region: bool

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

backup_schedule: Optional[BackupSchedule]

Backup schedule of the Database Instance.

created_at: Optional[datetime]

Creation date (must follow the ISO 8601 format).

endpoint: Optional[Endpoint]

Endpoint of the Database Instance.

endpoints: List[Endpoint]

List of Database Instance endpoints.

engine: str

Database engine of the database.

id: str

UUID of the Database Instance.

init_settings: List[InstanceSetting]

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

is_ha_cluster: bool

Defines whether or not High-Availability is enabled.

logs_policy: Optional[LogsPolicy]

Logs policy of the Database Instance.

maintenances: List[Maintenance]

List of Database Instance maintenance events.

name: str

Name of the Database Instance.

node_type: str

Node type of the Database Instance.

organization_id: str

Organization ID the Database Instance belongs to.

project_id: str

Project ID the Database Instance belongs to.

read_replicas: List[ReadReplica]

Read Replicas of the Database Instance.

region: str

Region the Database Instance is in.

settings: List[InstanceSetting]

Advanced settings of the Database Instance.

status: InstanceStatus

Status of the Database Instance.

tags: List[str]

List of tags applied to the Database Instance.

upgradable_version: List[UpgradableVersion]

Available database engine versions for upgrade.

volume: Optional[Volume]

Volumes of the Database Instance.

class scaleway.document_db.v1beta1.InstanceLog(id: 'str', status: 'InstanceLogStatus', node_name: 'str', region: 'Region', download_url: 'Optional[str]', expires_at: 'Optional[datetime]', created_at: 'Optional[datetime]')

Bases: object

created_at: Optional[datetime]

Creation date (must follow the ISO 8601 format).

download_url: Optional[str]

Presigned S3 URL to download your log file.

expires_at: Optional[datetime]

Expiration date (must follow the ISO 8601 format).

id: str

UUID of the Database Instance log.

node_name: str

Name of the underlying node.

region: str

Region the Database Instance is in.

status: InstanceLogStatus

Status of the logs in a Database Instance.

class scaleway.document_db.v1beta1.InstanceLogStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

CREATING = 'creating'

ERROR = 'error'

READY = 'ready'

UNKNOWN = 'unknown'

class scaleway.document_db.v1beta1.InstanceMetrics(timeseries: 'List[TimeSeries]')

Bases: object

timeseries: List[TimeSeries]

Time series of metrics of a Database Instance.

class scaleway.document_db.v1beta1.InstanceSetting(name: 'str', value: 'str')

Bases: object

name: str

value: str

class scaleway.document_db.v1beta1.InstanceStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

AUTOHEALING = 'autohealing'

BACKUPING = 'backuping'

CONFIGURING = 'configuring'

DELETING = 'deleting'

DISK_FULL = 'disk_full'

ERROR = 'error'

INITIALIZING = 'initializing'

LOCKED = 'locked'

PROVISIONING = 'provisioning'

READY = 'ready'

RESTARTING = 'restarting'

SNAPSHOTTING = 'snapshotting'

UNKNOWN = 'unknown'

class scaleway.document_db.v1beta1.ListDatabaseEnginesRequest(region: 'Optional[Region]', name: 'Optional[str]', version: 'Optional[str]', page: 'Optional[int]', page_size: 'Optional[int]')

Bases: object

name: Optional[str]

Name of the database engine.

page: Optional[int]

page_size: Optional[int]

region: Optional[str]

Region to target. If none is passed will use default region from the config.

version: Optional[str]

Version of the database engine.

class scaleway.document_db.v1beta1.ListDatabaseEnginesResponse(engines: 'List[DatabaseEngine]', total_count: 'int')

Bases: object

engines: List[DatabaseEngine]

List of the available database engines.

total_count: int

Total count of database engines available.

class scaleway.document_db.v1beta1.ListDatabasesRequest(instance_id: 'str', region: 'Optional[Region]', name: 'Optional[str]', managed: 'Optional[bool]', owner: 'Optional[str]', order_by: 'Optional[ListDatabasesRequestOrderBy]', page: 'Optional[int]', page_size: 'Optional[int]')

Bases: object

instance_id: str

UUID of the Database Instance to list the databases of.

managed: Optional[bool]

Defines whether or not the database is managed.

name: Optional[str]

Name of the database.

order_by: Optional[ListDatabasesRequestOrderBy]

Criteria to use when ordering database listing.

owner: Optional[str]

User that owns this database.

page: Optional[int]

page_size: Optional[int]

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.ListDatabasesRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

NAME_ASC = 'name_asc'

NAME_DESC = 'name_desc'

SIZE_ASC = 'size_asc'

SIZE_DESC = 'size_desc'

class scaleway.document_db.v1beta1.ListDatabasesResponse(databases: 'List[Database]', total_count: 'int')

Bases: object

databases: List[Database]

List of the databases.

total_count: int

Total count of databases present on a Database Instance.

class scaleway.document_db.v1beta1.ListInstanceACLRulesRequest(instance_id: 'str', region: 'Optional[Region]', page: 'Optional[int]', page_size: 'Optional[int]')

Bases: object

instance_id: str

UUID of the Database Instance.

page: Optional[int]

page_size: Optional[int]

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.ListInstanceACLRulesResponse(rules: 'List[ACLRule]', total_count: 'int')

Bases: object

rules: List[ACLRule]

List of ACL rules present on a Database Instance.

total_count: int

Total count of ACL rules present on a Database Instance.

class scaleway.document_db.v1beta1.ListInstanceLogsDetailsRequest(instance_id: 'str', region: 'Optional[Region]')

Bases: object

instance_id: str

UUID of the Database Instance you want logs of.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.ListInstanceLogsDetailsResponse(details: 'List[ListInstanceLogsDetailsResponseInstanceLogDetail]')

Bases: object

details: List[ListInstanceLogsDetailsResponseInstanceLogDetail]

Remote Database Instance logs details.

class scaleway.document_db.v1beta1.ListInstanceLogsDetailsResponseInstanceLogDetail(log_name: 'str', size: 'int')

Bases: object

log_name: str

size: int

class scaleway.document_db.v1beta1.ListInstanceLogsRequest(instance_id: 'str', region: 'Optional[Region]', order_by: 'Optional[ListInstanceLogsRequestOrderBy]')

Bases: object

instance_id: str

UUID of the Database Instance you want logs of.

order_by: Optional[ListInstanceLogsRequestOrderBy]

Criteria to use when ordering Database Instance logs listing.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.ListInstanceLogsRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

CREATED_AT_ASC = 'created_at_asc'

CREATED_AT_DESC = 'created_at_desc'

class scaleway.document_db.v1beta1.ListInstanceLogsResponse(instance_logs: 'List[InstanceLog]')

Bases: object

instance_logs: List[InstanceLog]

Available logs in a Database Instance.

class scaleway.document_db.v1beta1.ListInstancesRequest(region: 'Optional[Region]', tags: 'Optional[List[str]]', name: 'Optional[str]', order_by: 'Optional[ListInstancesRequestOrderBy]', organization_id: 'Optional[str]', project_id: 'Optional[str]', page: 'Optional[int]', page_size: 'Optional[int]')

Bases: object

name: Optional[str]

Lists Database Instances that match a name pattern.

order_by: Optional[ListInstancesRequestOrderBy]

Criteria to use when ordering Database Instance listings.

organization_id: Optional[str]

Please use project_id instead.

page: Optional[int]

page_size: Optional[int]

project_id: Optional[str]

Project ID to list the Database Instance of.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

tags: Optional[List[str]]

List Database Instances that have a given tag.

class scaleway.document_db.v1beta1.ListInstancesRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

CREATED_AT_ASC = 'created_at_asc'

CREATED_AT_DESC = 'created_at_desc'

NAME_ASC = 'name_asc'

NAME_DESC = 'name_desc'

REGION = 'region'

STATUS_ASC = 'status_asc'

STATUS_DESC = 'status_desc'

class scaleway.document_db.v1beta1.ListInstancesResponse(instances: 'List[Instance]', total_count: 'int')

Bases: object

instances: List[Instance]

List of all Database Instances available in an Organization or Project.

total_count: int

Total count of Database Instances available in a Organization or Project.

class scaleway.document_db.v1beta1.ListNodeTypesRequest(include_disabled_types: 'bool', region: 'Optional[Region]', page: 'Optional[int]', page_size: 'Optional[int]')

Bases: object

include_disabled_types: bool

Defines whether or not to include disabled types.

page: Optional[int]

page_size: Optional[int]

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.ListNodeTypesResponse(node_types: 'List[NodeType]', total_count: 'int')

Bases: object

node_types: List[NodeType]

Types of the node.

total_count: int

Total count of node-types available.

class scaleway.document_db.v1beta1.ListPrivilegesRequest(instance_id: 'str', region: 'Optional[Region]', order_by: 'Optional[ListPrivilegesRequestOrderBy]', page: 'Optional[int]', page_size: 'Optional[int]', database_name: 'Optional[str]', user_name: 'Optional[str]')

Bases: object

database_name: Optional[str]

Name of the database.

instance_id: str

UUID of the Database Instance.

order_by: Optional[ListPrivilegesRequestOrderBy]

Criteria to use when ordering privileges listing.

page: Optional[int]

page_size: Optional[int]

region: Optional[str]

Region to target. If none is passed will use default region from the config.

user_name: Optional[str]

Name of the user.

class scaleway.document_db.v1beta1.ListPrivilegesRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

DATABASE_NAME_ASC = 'database_name_asc'

DATABASE_NAME_DESC = 'database_name_desc'

USER_NAME_ASC = 'user_name_asc'

USER_NAME_DESC = 'user_name_desc'

class scaleway.document_db.v1beta1.ListPrivilegesResponse(privileges: 'List[Privilege]', total_count: 'int')

Bases: object

privileges: List[Privilege]

Privileges of a user in a database in a Database Instance.

total_count: int

Total count of privileges present on a database.

class scaleway.document_db.v1beta1.ListSnapshotsRequest(region: 'Optional[Region]', name: 'Optional[str]', order_by: 'Optional[ListSnapshotsRequestOrderBy]', instance_id: 'Optional[str]', organization_id: 'Optional[str]', project_id: 'Optional[str]', page: 'Optional[int]', page_size: 'Optional[int]')

Bases: object

instance_id: Optional[str]

UUID of the Database Instance.

name: Optional[str]

Name of the snapshot.

order_by: Optional[ListSnapshotsRequestOrderBy]

Criteria to use when ordering snapshot listing.

organization_id: Optional[str]

Organization ID the snapshots belongs to.

page: Optional[int]

page_size: Optional[int]

project_id: Optional[str]

Project ID the snapshots belongs to.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.ListSnapshotsRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

CREATED_AT_ASC = 'created_at_asc'

CREATED_AT_DESC = 'created_at_desc'

EXPIRES_AT_ASC = 'expires_at_asc'

EXPIRES_AT_DESC = 'expires_at_desc'

NAME_ASC = 'name_asc'

NAME_DESC = 'name_desc'

class scaleway.document_db.v1beta1.ListSnapshotsResponse(snapshots: 'List[Snapshot]', total_count: 'int')

Bases: object

snapshots: List[Snapshot]

List of snapshots.

total_count: int

Total count of snapshots available.

class scaleway.document_db.v1beta1.ListUsersRequest(instance_id: 'str', region: 'Optional[Region]', name: 'Optional[str]', order_by: 'Optional[ListUsersRequestOrderBy]', page: 'Optional[int]', page_size: 'Optional[int]')

Bases: object

instance_id: str

UUID of the Database Instance.

name: Optional[str]

Name of the user.

order_by: Optional[ListUsersRequestOrderBy]

Criteria to use when requesting user listing.

page: Optional[int]

page_size: Optional[int]

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.ListUsersRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

IS_ADMIN_ASC = 'is_admin_asc'

IS_ADMIN_DESC = 'is_admin_desc'

NAME_ASC = 'name_asc'

NAME_DESC = 'name_desc'

class scaleway.document_db.v1beta1.ListUsersResponse(users: 'List[User]', total_count: 'int')

Bases: object

total_count: int

Total count of users present on a Database Instance.

users: List[User]

List of users in a Database Instance.

class scaleway.document_db.v1beta1.LogsPolicy(max_age_retention: 'Optional[int]', total_disk_retention: 'Optional[int]')

Bases: object

max_age_retention: Optional[int]

Max age (in days) of remote logs to keep on the Database Instance.

total_disk_retention: Optional[int]

Max disk size of remote logs to keep on the Database Instance.

class scaleway.document_db.v1beta1.Maintenance(reason: 'str', status: 'MaintenanceStatus', starts_at: 'Optional[datetime]', stops_at: 'Optional[datetime]', closed_at: 'Optional[datetime]', forced_at: 'Optional[datetime]')

Bases: object

closed_at: Optional[datetime]

Closed maintenance date.

forced_at: Optional[datetime]

Time when Scaleway-side maintenance will be applied.

reason: str

Maintenance information message.

starts_at: Optional[datetime]

Start date of the maintenance window.

status: MaintenanceStatus

Status of the maintenance.

stops_at: Optional[datetime]

End date of the maintenance window.

class scaleway.document_db.v1beta1.MaintenanceStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

CANCELED = 'canceled'

DONE = 'done'

ONGOING = 'ongoing'

PENDING = 'pending'

UNKNOWN = 'unknown'

class scaleway.document_db.v1beta1.MigrateEndpointRequest(endpoint_id: 'str', instance_id: 'str', region: 'Optional[Region]')

Bases: object

endpoint_id: str

UUID of the endpoint you want to migrate.

instance_id: str

UUID of the instance you want to attach the endpoint to.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.NodeType(name: 'str', stock_status: 'NodeTypeStock', description: 'str', vcpus: 'int', memory: 'int', disabled: 'bool', beta: 'bool', volume_constraint: 'Optional[NodeTypeVolumeConstraintSizes]', is_bssd_compatible: 'Optional[bool]', available_volume_types: 'List[NodeTypeVolumeType]', is_ha_required: 'bool', generation: 'NodeTypeGeneration', instance_range: 'str', region: 'Region')

Bases: object

available_volume_types: List[NodeTypeVolumeType]

Available storage options for the Node Type.

beta: bool

The Node Type is currently in beta.

description: str

Current specs of the offer.

disabled: bool

The Node Type is currently disabled.

generation: NodeTypeGeneration

Generation associated the NodeType offer.

instance_range: str

Instance range associated with the NodeType offer.

is_bssd_compatible: Optional[bool]

The Node Type is compliant with Block Storage.

is_ha_required: bool

The Node Type can be used only with the High Availability option.

memory: int

Quantity of RAM.

name: str

Node Type name identifier.

region: str

Region the Node Type is in.

stock_status: NodeTypeStock

Current stock status for the Node Type.

vcpus: int

Number of virtual CPUs.

volume_constraint: Optional[NodeTypeVolumeConstraintSizes]

[deprecated] Node Type volume constraints.

class scaleway.document_db.v1beta1.NodeTypeGeneration(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

GENERATION_V1 = 'generation_v1'

GENERATION_V2 = 'generation_v2'

UNKNOWN_GENERATION = 'unknown_generation'

class scaleway.document_db.v1beta1.NodeTypeStock(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

AVAILABLE = 'available'

LOW_STOCK = 'low_stock'

OUT_OF_STOCK = 'out_of_stock'

UNKNOWN = 'unknown'

class scaleway.document_db.v1beta1.NodeTypeVolumeConstraintSizes(min_size: 'int', max_size: 'int')

Bases: object

max_size: int

[deprecated] Maximum size required for the Volume.

min_size: int

[deprecated] Mimimum size required for the Volume.

class scaleway.document_db.v1beta1.NodeTypeVolumeType(type_: 'VolumeType', description: 'str', min_size: 'int', max_size: 'int', chunk_size: 'int', class_: 'StorageClass')

Bases: object

chunk_size: int

Minimum increment level for a Block Storage volume size.

class_: StorageClass

The storage class of the volume.

description: str

The description of the Volume.

max_size: int

Maximum size required for the Volume.

min_size: int

Mimimum size required for the Volume.

type_: VolumeType

Volume Type.

class scaleway.document_db.v1beta1.Permission(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

ALL = 'all'

CUSTOM = 'custom'

NONE = 'none'

READONLY = 'readonly'

READWRITE = 'readwrite'

class scaleway.document_db.v1beta1.Privilege(permission: 'Permission', database_name: 'str', user_name: 'str')

Bases: object

database_name: str

Name of the database.

permission: Permission

Permission (Read, Read/Write, All, Custom).

user_name: str

Name of the user.

class scaleway.document_db.v1beta1.PromoteReadReplicaRequest(read_replica_id: 'str', region: 'Optional[Region]')

Bases: object

read_replica_id: str

UUID of the Read Replica.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.PurgeInstanceLogsRequest(instance_id: 'str', region: 'Optional[Region]', log_name: 'Optional[str]')

Bases: object

instance_id: str

UUID of the Database Instance you want logs of.

log_name: Optional[str]

Given log name to purge.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.ReadReplica(id: 'str', endpoints: 'List[Endpoint]', status: 'ReadReplicaStatus', region: 'Region', same_zone: 'bool')

Bases: object

endpoints: List[Endpoint]

Display Read Replica connection information.

id: str

UUID of the Read Replica.

region: str

Region the Read Replica is in.

same_zone: bool

Whether the replica is in the same Availability Zone as the main Database Instance nodes or not.

status: ReadReplicaStatus

Read replica status.

class scaleway.document_db.v1beta1.ReadReplicaEndpointSpec(direct_access: 'Optional[ReadReplicaEndpointSpecDirectAccess]', private_network: 'Optional[ReadReplicaEndpointSpecPrivateNetwork]')

Bases: object

direct_access: Optional[ReadReplicaEndpointSpecDirectAccess]

private_network: Optional[ReadReplicaEndpointSpecPrivateNetwork]

class scaleway.document_db.v1beta1.ReadReplicaEndpointSpecDirectAccess

Bases: object

class scaleway.document_db.v1beta1.ReadReplicaEndpointSpecPrivateNetwork(private_network_id: 'str', service_ip: 'Optional[str]', ipam_config: 'Optional[ReadReplicaEndpointSpecPrivateNetworkIpamConfig]')

Bases: object

ipam_config: Optional[ReadReplicaEndpointSpecPrivateNetworkIpamConfig]

private_network_id: str

UUID of the Private Network to be connected to the Read Replica.

service_ip: Optional[str]

class scaleway.document_db.v1beta1.ReadReplicaEndpointSpecPrivateNetworkIpamConfig

Bases: object

class scaleway.document_db.v1beta1.ReadReplicaStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

CONFIGURING = 'configuring'

DELETING = 'deleting'

ERROR = 'error'

INITIALIZING = 'initializing'

LOCKED = 'locked'

PROMOTING = 'promoting'

PROVISIONING = 'provisioning'

READY = 'ready'

UNKNOWN = 'unknown'

class scaleway.document_db.v1beta1.RenewInstanceCertificateRequest(instance_id: 'str', region: 'Optional[Region]')

Bases: object

instance_id: str

UUID of the Database Instance you want logs of.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.ResetReadReplicaRequest(read_replica_id: 'str', region: 'Optional[Region]')

Bases: object

read_replica_id: str

UUID of the Read Replica.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.RestartInstanceRequest(instance_id: 'str', region: 'Optional[Region]')

Bases: object

instance_id: str

UUID of the Database Instance you want to restart.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.SetInstanceACLRulesRequest(instance_id: 'str', rules: 'List[ACLRuleRequest]', region: 'Optional[Region]')

Bases: object

instance_id: str

UUID of the Database Instance where the ACL rules must be set.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

rules: List[ACLRuleRequest]

ACL rules to define for the Database Instance.

class scaleway.document_db.v1beta1.SetInstanceACLRulesResponse(rules: 'List[ACLRule]')

Bases: object

rules: List[ACLRule]

ACLs rules configured for a Database Instance.

class scaleway.document_db.v1beta1.SetInstanceSettingsRequest(instance_id: 'str', settings: 'List[InstanceSetting]', region: 'Optional[Region]')

Bases: object

instance_id: str

UUID of the Database Instance where the settings must be set.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

settings: List[InstanceSetting]

Settings to define for the Database Instance.

class scaleway.document_db.v1beta1.SetInstanceSettingsResponse(settings: 'List[InstanceSetting]')

Bases: object

settings: List[InstanceSetting]

Settings configured for a Database Instance.

class scaleway.document_db.v1beta1.SetPrivilegeRequest(instance_id: 'str', database_name: 'str', user_name: 'str', region: 'Optional[Region]', permission: 'Optional[Permission]')

Bases: object

database_name: str

Name of the database.

instance_id: str

UUID of the Database Instance.

permission: Optional[Permission]

Permission to set (Read, Read/Write, All, Custom).

region: Optional[str]

Region to target. If none is passed will use default region from the config.

user_name: str

Name of the user.

class scaleway.document_db.v1beta1.Snapshot(id: 'str', instance_id: 'str', name: 'str', status: 'SnapshotStatus', instance_name: 'str', node_type: 'str', region: 'Region', size: 'Optional[int]', expires_at: 'Optional[datetime]', created_at: 'Optional[datetime]', updated_at: 'Optional[datetime]', volume_type: 'Optional[SnapshotVolumeType]')

Bases: object

created_at: Optional[datetime]

Creation date (must follow the ISO 8601 format).

expires_at: Optional[datetime]

Expiration date (must follow the ISO 8601 format).

id: str

UUID of the snapshot.

instance_id: str

UUID of the Database Instance.

instance_name: str

Name of the Database Instance of the snapshot.

name: str

Name of the snapshot.

node_type: str

Source node type.

region: str

Region of this snapshot.

size: Optional[int]

Size of the snapshot.

status: SnapshotStatus

Status of the snapshot.

updated_at: Optional[datetime]

Updated date (must follow the ISO 8601 format).

volume_type: Optional[SnapshotVolumeType]

Type of volume where data is stored (lssd, bssd or sbs).

class scaleway.document_db.v1beta1.SnapshotStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

CREATING = 'creating'

DELETING = 'deleting'

ERROR = 'error'

LOCKED = 'locked'

READY = 'ready'

RESTORING = 'restoring'

UNKNOWN = 'unknown'

class scaleway.document_db.v1beta1.SnapshotVolumeType(type_: 'VolumeType', class_: 'StorageClass')

Bases: object

class_: StorageClass

type_: VolumeType

class scaleway.document_db.v1beta1.StorageClass(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

BSSD = 'bssd'

LSSD = 'lssd'

SBS = 'sbs'

UNKNOWN_STORAGE_CLASS = 'unknown_storage_class'

class scaleway.document_db.v1beta1.UpdateInstanceRequest(instance_id: 'str', region: 'Optional[Region]', backup_schedule_frequency: 'Optional[int]', backup_schedule_retention: 'Optional[int]', is_backup_schedule_disabled: 'Optional[bool]', name: 'Optional[str]', tags: 'Optional[List[str]]', logs_policy: 'Optional[LogsPolicy]', backup_same_region: 'Optional[bool]', backup_schedule_start_hour: 'Optional[int]')

Bases: object

backup_same_region: Optional[bool]

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

backup_schedule_frequency: Optional[int]

In hours.

backup_schedule_retention: Optional[int]

In days.

backup_schedule_start_hour: Optional[int]

Defines the start time of the autobackup.

instance_id: str

UUID of the Database Instance to update.

is_backup_schedule_disabled: Optional[bool]

Defines whether or not the backup schedule is disabled.

logs_policy: Optional[LogsPolicy]

Logs policy of the Database Instance.

name: Optional[str]

Name of the Database Instance.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

tags: Optional[List[str]]

Tags of a Database Instance.

class scaleway.document_db.v1beta1.UpdateSnapshotRequest(snapshot_id: 'str', region: 'Optional[Region]', name: 'Optional[str]', expires_at: 'Optional[datetime]')

Bases: object

expires_at: Optional[datetime]

Expiration date (must follow the ISO 8601 format).

name: Optional[str]

Name of the snapshot.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

snapshot_id: str

UUID of the snapshot to update.

class scaleway.document_db.v1beta1.UpdateUserRequest(instance_id: 'str', name: 'str', region: 'Optional[Region]', password: 'Optional[str]', is_admin: 'Optional[bool]')

Bases: object

instance_id: str

UUID of the Database Instance the user belongs to.

is_admin: Optional[bool]

Defines whether or not this user got administrative privileges.

name: str

Name of the database user.

password: Optional[str]

Password of the database user.

region: Optional[str]

Region to target. If none is passed will use default region from the config.

class scaleway.document_db.v1beta1.UpgradableVersion(id: 'str', name: 'str', version: 'str', minor_version: 'str')

Bases: object

id: str

minor_version: str

name: str

version: str

class scaleway.document_db.v1beta1.UpgradeInstanceRequest(instance_id: 'str', region: 'Optional[Region]', node_type: 'Optional[str]', enable_ha: 'Optional[bool]', volume_size: 'Optional[int]', volume_type: 'Optional[VolumeType]', upgradable_version_id: 'Optional[str]', major_upgrade_workflow: 'Optional[UpgradeInstanceRequestMajorUpgradeWorkflow]')

Bases: object

enable_ha: Optional[bool]

instance_id: str

UUID of the Database Instance you want to upgrade.

major_upgrade_workflow: Optional[UpgradeInstanceRequestMajorUpgradeWorkflow]

node_type: Optional[str]

region: Optional[str]

Region to target. If none is passed will use default region from the config.

upgradable_version_id: Optional[str]

volume_size: Optional[int]

volume_type: Optional[VolumeType]

class scaleway.document_db.v1beta1.UpgradeInstanceRequestMajorUpgradeWorkflow(upgradable_version_id: 'str', with_endpoints: 'bool')

Bases: object

upgradable_version_id: str

This will create a new Database Instance with same specifications as the current one and perform a Database Engine upgrade.

with_endpoints: bool

At the end of the migration procedure this option let you migrate all your database endpoint to the upgraded instance.

class scaleway.document_db.v1beta1.User(name: 'str', is_admin: 'bool')

Bases: object

is_admin: bool

Defines whether or not a user got administrative privileges on the Database Instance.

name: str

Name of the user (Length must be between 1 and 63 characters. First character must be an alphabet character (a-zA-Z). Your username cannot start with ‘_rdb’ or ‘pg_’. Only a-zA-Z0-9_$- characters are accepted).

class scaleway.document_db.v1beta1.Volume(type_: 'VolumeType', size: 'int', class_: 'StorageClass')

Bases: object

class_: StorageClass

size: int

type_: VolumeType

class scaleway.document_db.v1beta1.VolumeType(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

BSSD = 'bssd'

LSSD = 'lssd'

SBS_15K = 'sbs_15k'

SBS_5K = 'sbs_5k'