Yandex Cloud
Search
Contact UsGet started
  • Pricing
  • Customer Stories
  • Documentation
  • Blog
  • All Services
  • System Status
    • Featured
    • Infrastructure & Network
    • Data Platform
    • Containers
    • Developer tools
    • Serverless
    • Security
    • Monitoring & Resources
    • AI for business
    • Business tools
  • All Solutions
    • By industry
    • By use case
    • Economics and Pricing
    • Security
    • Technical Support
    • Start testing with double trial credits
    • Cloud credits to scale your IT product
    • Gateway to Russia
    • Cloud for Startups
    • Center for Technologies and Society
    • Yandex Cloud Partner program
  • Pricing
  • Customer Stories
  • Documentation
  • Blog
© 2025 Direct Cursus Technology L.L.C.
Terraform in Yandex Cloud
  • Getting started
  • Solution library
    • Overview
    • Release notes
          • ydb_database_dedicated
          • ydb_database_iam_binding
          • ydb_database_serverless
          • ydb_table
          • ydb_table_changefeed
          • ydb_table_index
          • ydb_topic

In this article:

  • Example usage
  • Schema
  • Required
  • Optional
  • Read-Only
  • Nested Schema for serverless_database
  • Nested Schema for timeouts
  • Import
  1. Terraform reference
  2. Resources
  3. Managed Service for YDB
  4. Resources
  5. ydb_database_serverless

yandex_ydb_database_serverless (Resource)

Written by
Yandex Cloud
Updated at August 7, 2025
  • Example usage
  • Schema
    • Required
    • Optional
    • Read-Only
    • Nested Schema for serverless_database
    • Nested Schema for timeouts
  • Import

Yandex Database (serverless) resource. For more information, see the official documentation.

Example usageExample usage

//
// Create a new YDB Serverless Database.
//
resource "yandex_ydb_database_serverless" "my_ydb" {
  name      = "test-ydb-serverless"
  folder_id = data.yandex_resourcemanager_folder.test_folder.id

  deletion_protection = true
}

SchemaSchema

RequiredRequired

  • name (String) The resource name.

OptionalOptional

  • deletion_protection (Boolean) The true value means that resource is protected from accidental deletion.
  • description (String) The resource description.
  • folder_id (String) The folder identifier that resource belongs to. If it is not provided, the default provider folder-id is used.
  • labels (Map of String) A set of key/value label pairs which assigned to resource.
  • location_id (String) Location ID for the Yandex Database serverless cluster.
  • serverless_database (Block Set) (see below for nested schema)
  • sleep_after (Number)
  • timeouts (Block, Optional) (see below for nested schema)

Read-OnlyRead-Only

  • created_at (String) The creation timestamp of the resource.
  • database_path (String) Full database path of the Yandex Database serverless cluster. Useful for SDK configuration.
  • document_api_endpoint (String) Document API endpoint of the Yandex Database serverless cluster.
  • id (String) The ID of this resource.
  • status (String) Status of the Yandex Database serverless cluster.
  • tls_enabled (Boolean) Whether TLS is enabled for the Yandex Database serverless cluster. Useful for SDK configuration.
  • ydb_api_endpoint (String) API endpoint of the Yandex Database serverless cluster. Useful for SDK configuration.
  • ydb_full_endpoint (String) Full endpoint of the Yandex Database serverless cluster.

Nested Schema for Nested Schema for serverless_database

Optional:

  • enable_throttling_rcu_limit (Boolean)
  • provisioned_rcu_limit (Number)
  • storage_size_limit (Number)
  • throttling_rcu_limit (Number)

Nested Schema for Nested Schema for timeouts

Optional:

  • default (String) A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

ImportImport

The resource can be imported by using their resource ID. For getting the resource ID you can use Yandex Cloud Web Console or YC CLI.

# terraform import yandex_ydb_database_serverless.<resource Name> <resource Id>
terraform import yandex_ydb_database_serverless.my_ydb ...

Was the article helpful?

Previous
ydb_database_iam_binding
Next
ydb_table
© 2025 Direct Cursus Technology L.L.C.