Creating and reconfiguring a serverless database

To create a serverless database, use the yandex_ydb_database_serverless resource.

Description of the resourceDescription of the yandex_ydb_database_serverlessresource

The configuration file of your project should already include a code section for initializing providers. Open this file and add this code:

resource "yandex_ydb_database_serverless" "database1" {
  name                = "test-ydb-serverless"
  deletion_protection = true

  serverless_database {
    enable_throttling_rcu_limit = false
    provisioned_rcu_limit       = 10
    storage_size_limit          = 50
    throttling_rcu_limit        = 0
  }
}

Note that the resource initialization string consists of three parts:

• resource keyword.
• Resource name enclosed in quotes: "yandex_ydb_database_serverless".
• Resource internal ID within the configuration file: "database1" (not the database name in the cloud).

The resource ID together with its name serve as an address for retrieving a field of the resource you are creating, as described further below. The yandex_ydb_database_serverless resource has the following field properties:

• name: Name of the database. It may include lowercase Latin letters, digits, and hyphens. The first character must be a letter, the last one cannot be a hyphen. It must be from 3 to 63 characters long. This is a required parameter.
• deletion_protection: Database deletion protection (does not protect the database contents). The default value is false.
• enable_throttling_rcu_limit: Enable a throughput limit. This is an optional parameter. The default value is false.
• throttling_rcu_limit: Limit on request units consumed per second. This is an optional parameter. The default value is 0.
• provisioned_rcu_limit: Request units per second charged on an hourly basis according to the pricing plan. If set to 0, hourly billing is off. This is an optional parameter. The default value is 0.
• storage_size_limit: Amount of data, in GB. This is an optional parameter. The default value is 50.

Save the file and run the terraform validate command. This command will check all files in the project directory for errors. If there are no errors, the terminal will display this message: Success! The configuration is valid. If there are errors, you will get a code section containing errors and specific erroneous lines of code.

If there are no errors, run the terraform plan command. This command will create a plan for infrastructure changes and output a report with the resources to create, without creating any real cloud resources at this stage. Use the terraform apply command to apply changes and create actual cloud resources. To confirm the action, enter yes in the terminal.

Terraform will create all the required resources. You can check the update using the management console or this CLI command: yc ydb database get <DB_name>. The terminal will display information about the database.

If you need to reconfigure an existing database, edit the configuration file and run this command sequence: terraform validate, terraform plan, and terraform apply. For example, you can change the database name, storage_size_limit, etc. Keep in mind that if you change the database ID ("database1" in this case) the database will be recreated, and its data will be lost.