Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Yandex
  3. API Docs
  4. YdbDatabaseServerless
Yandex v0.13.0 published on Tuesday, Feb 22, 2022 by Pulumi
pulumi/pulumi-yandex

yandex.YdbDatabaseServerless

Explore with Pulumi AI

yandex logo
Yandex v0.13.0 published on Tuesday, Feb 22, 2022 by Pulumi
pulumi/pulumi-yandex

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

    Example Usage

    using Pulumi;
using Yandex = Pulumi.Yandex;

class MyStack : Stack
{
    public MyStack()
    {
        var database1 = new Yandex.YdbDatabaseServerless("database1", new Yandex.YdbDatabaseServerlessArgs
        {
            FolderId = data.Yandex_resourcemanager_folder.Test_folder.Id,
        });
    }

}

    package main

import (
	"github.com/pulumi/pulumi-yandex/sdk/go/yandex"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := yandex.NewYdbDatabaseServerless(ctx, "database1", &yandex.YdbDatabaseServerlessArgs{
			FolderId: pulumi.Any(data.Yandex_resourcemanager_folder.Test_folder.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Coming soon!

    import pulumi
import pulumi_yandex as yandex

database1 = yandex.YdbDatabaseServerless("database1", folder_id=data["yandex_resourcemanager_folder"]["test_folder"]["id"])

    import * as pulumi from "@pulumi/pulumi";
import * as yandex from "@pulumi/yandex";

const database1 = new yandex.YdbDatabaseServerless("database1", {
    folderId: yandex_resourcemanager_folder_test_folder.id,
});

    Coming soon!

    Create YdbDatabaseServerless Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new YdbDatabaseServerless(name: string, args?: YdbDatabaseServerlessArgs, opts?: CustomResourceOptions);
    @overload
def YdbDatabaseServerless(resource_name: str,
                          args: Optional[YdbDatabaseServerlessArgs] = None,
                          opts: Optional[ResourceOptions] = None)

@overload
def YdbDatabaseServerless(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          description: Optional[str] = None,
                          folder_id: Optional[str] = None,
                          labels: Optional[Mapping[str, str]] = None,
                          location_id: Optional[str] = None,
                          name: Optional[str] = None)
    func NewYdbDatabaseServerless(ctx *Context, name string, args *YdbDatabaseServerlessArgs, opts ...ResourceOption) (*YdbDatabaseServerless, error)
    public YdbDatabaseServerless(string name, YdbDatabaseServerlessArgs? args = null, CustomResourceOptions? opts = null)
    public YdbDatabaseServerless(String name, YdbDatabaseServerlessArgs args)
public YdbDatabaseServerless(String name, YdbDatabaseServerlessArgs args, CustomResourceOptions options)

    type: yandex:YdbDatabaseServerless
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args YdbDatabaseServerlessArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args YdbDatabaseServerlessArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args YdbDatabaseServerlessArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args YdbDatabaseServerlessArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args YdbDatabaseServerlessArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var ydbDatabaseServerlessResource = new Yandex.YdbDatabaseServerless("ydbDatabaseServerlessResource", new()
{
    Description = "string",
    FolderId = "string",
    Labels = 
    {
        { "string", "string" },
    },
    LocationId = "string",
    Name = "string",
});

    example, err := yandex.NewYdbDatabaseServerless(ctx, "ydbDatabaseServerlessResource", &yandex.YdbDatabaseServerlessArgs{
	Description: pulumi.String("string"),
	FolderId:    pulumi.String("string"),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	LocationId: pulumi.String("string"),
	Name:       pulumi.String("string"),
})

    var ydbDatabaseServerlessResource = new YdbDatabaseServerless("ydbDatabaseServerlessResource", YdbDatabaseServerlessArgs.builder()
    .description("string")
    .folderId("string")
    .labels(Map.of("string", "string"))
    .locationId("string")
    .name("string")
    .build());

    ydb_database_serverless_resource = yandex.YdbDatabaseServerless("ydbDatabaseServerlessResource",
    description="string",
    folder_id="string",
    labels={
        "string": "string",
    },
    location_id="string",
    name="string")

    const ydbDatabaseServerlessResource = new yandex.YdbDatabaseServerless("ydbDatabaseServerlessResource", {
    description: "string",
    folderId: "string",
    labels: {
        string: "string",
    },
    locationId: "string",
    name: "string",
});

    type: yandex:YdbDatabaseServerless
properties:
    description: string
    folderId: string
    labels:
        string: string
    locationId: string
    name: string

    YdbDatabaseServerless Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The YdbDatabaseServerless resource accepts the following input properties:

    Description string
    A description for the Yandex Database serverless cluster.
    FolderId string
    ID of the folder that the Yandex Database serverless cluster belongs to. It will be deduced from provider configuration if not set explicitly.
    Labels Dictionary<string, string>
    A set of key/value label pairs to assign to the Yandex Database serverless cluster.
    LocationId string
    Location ID for the Yandex Database serverless cluster.
    Name string
    Name for the Yandex Database serverless cluster.
    Description string
    A description for the Yandex Database serverless cluster.
    FolderId string
    ID of the folder that the Yandex Database serverless cluster belongs to. It will be deduced from provider configuration if not set explicitly.
    Labels map[string]string
    A set of key/value label pairs to assign to the Yandex Database serverless cluster.
    LocationId string
    Location ID for the Yandex Database serverless cluster.
    Name string
    Name for the Yandex Database serverless cluster.
    description String
    A description for the Yandex Database serverless cluster.
    folderId String
    ID of the folder that the Yandex Database serverless cluster belongs to. It will be deduced from provider configuration if not set explicitly.
    labels Map<String,String>
    A set of key/value label pairs to assign to the Yandex Database serverless cluster.
    locationId String
    Location ID for the Yandex Database serverless cluster.
    name String
    Name for the Yandex Database serverless cluster.
    description string
    A description for the Yandex Database serverless cluster.
    folderId string
    ID of the folder that the Yandex Database serverless cluster belongs to. It will be deduced from provider configuration if not set explicitly.
    labels {[key: string]: string}
    A set of key/value label pairs to assign to the Yandex Database serverless cluster.
    locationId string
    Location ID for the Yandex Database serverless cluster.
    name string
    Name for the Yandex Database serverless cluster.
    description str
    A description for the Yandex Database serverless cluster.
    folder_id str
    ID of the folder that the Yandex Database serverless cluster belongs to. It will be deduced from provider configuration if not set explicitly.
    labels Mapping[str, str]
    A set of key/value label pairs to assign to the Yandex Database serverless cluster.
    location_id str
    Location ID for the Yandex Database serverless cluster.
    name str
    Name for the Yandex Database serverless cluster.
    description String
    A description for the Yandex Database serverless cluster.
    folderId String
    ID of the folder that the Yandex Database serverless cluster belongs to. It will be deduced from provider configuration if not set explicitly.
    labels Map<String>
    A set of key/value label pairs to assign to the Yandex Database serverless cluster.
    locationId String
    Location ID for the Yandex Database serverless cluster.
    name String
    Name for the Yandex Database serverless cluster.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the YdbDatabaseServerless resource produces the following output properties:

    CreatedAt string
    The Yandex Database serverless cluster creation timestamp.
    DatabasePath string
    Full database path of the Yandex Database serverless cluster. Useful for SDK configuration.
    DocumentApiEndpoint string
    Document API endpoint of the Yandex Database serverless cluster.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    Status of the Yandex Database serverless cluster.
    TlsEnabled bool
    Whether TLS is enabled for the Yandex Database serverless cluster. Useful for SDK configuration.
    YdbApiEndpoint string
    API endpoint of the Yandex Database serverless cluster. Useful for SDK configuration.
    YdbFullEndpoint string
    Full endpoint of the Yandex Database serverless cluster.
    CreatedAt string
    The Yandex Database serverless cluster creation timestamp.
    DatabasePath string
    Full database path of the Yandex Database serverless cluster. Useful for SDK configuration.
    DocumentApiEndpoint string
    Document API endpoint of the Yandex Database serverless cluster.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    Status of the Yandex Database serverless cluster.
    TlsEnabled bool
    Whether TLS is enabled for the Yandex Database serverless cluster. Useful for SDK configuration.
    YdbApiEndpoint string
    API endpoint of the Yandex Database serverless cluster. Useful for SDK configuration.
    YdbFullEndpoint string
    Full endpoint of the Yandex Database serverless cluster.
    createdAt String
    The Yandex Database serverless cluster creation timestamp.
    databasePath String
    Full database path of the Yandex Database serverless cluster. Useful for SDK configuration.
    documentApiEndpoint String
    Document API endpoint of the Yandex Database serverless cluster.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    Status of the Yandex Database serverless cluster.
    tlsEnabled Boolean
    Whether TLS is enabled for the Yandex Database serverless cluster. Useful for SDK configuration.
    ydbApiEndpoint String
    API endpoint of the Yandex Database serverless cluster. Useful for SDK configuration.
    ydbFullEndpoint String
    Full endpoint of the Yandex Database serverless cluster.
    createdAt string
    The Yandex Database serverless cluster creation timestamp.
    databasePath string
    Full database path of the Yandex Database serverless cluster. Useful for SDK configuration.
    documentApiEndpoint string
    Document API endpoint of the Yandex Database serverless cluster.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    Status of the Yandex Database serverless cluster.
    tlsEnabled boolean
    Whether TLS is enabled for the Yandex Database serverless cluster. Useful for SDK configuration.
    ydbApiEndpoint string
    API endpoint of the Yandex Database serverless cluster. Useful for SDK configuration.
    ydbFullEndpoint string
    Full endpoint of the Yandex Database serverless cluster.
    created_at str
    The Yandex Database serverless cluster creation timestamp.
    database_path str
    Full database path of the Yandex Database serverless cluster. Useful for SDK configuration.
    document_api_endpoint str
    Document API endpoint of the Yandex Database serverless cluster.
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    Status of the Yandex Database serverless cluster.
    tls_enabled bool
    Whether TLS is enabled for the Yandex Database serverless cluster. Useful for SDK configuration.
    ydb_api_endpoint str
    API endpoint of the Yandex Database serverless cluster. Useful for SDK configuration.
    ydb_full_endpoint str
    Full endpoint of the Yandex Database serverless cluster.
    createdAt String
    The Yandex Database serverless cluster creation timestamp.
    databasePath String
    Full database path of the Yandex Database serverless cluster. Useful for SDK configuration.
    documentApiEndpoint String
    Document API endpoint of the Yandex Database serverless cluster.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    Status of the Yandex Database serverless cluster.
    tlsEnabled Boolean
    Whether TLS is enabled for the Yandex Database serverless cluster. Useful for SDK configuration.
    ydbApiEndpoint String
    API endpoint of the Yandex Database serverless cluster. Useful for SDK configuration.
    ydbFullEndpoint String
    Full endpoint of the Yandex Database serverless cluster.

    Look up Existing YdbDatabaseServerless Resource

    Get an existing YdbDatabaseServerless resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: YdbDatabaseServerlessState, opts?: CustomResourceOptions): YdbDatabaseServerless
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_at: Optional[str] = None,
        database_path: Optional[str] = None,
        description: Optional[str] = None,
        document_api_endpoint: Optional[str] = None,
        folder_id: Optional[str] = None,
        labels: Optional[Mapping[str, str]] = None,
        location_id: Optional[str] = None,
        name: Optional[str] = None,
        status: Optional[str] = None,
        tls_enabled: Optional[bool] = None,
        ydb_api_endpoint: Optional[str] = None,
        ydb_full_endpoint: Optional[str] = None) -> YdbDatabaseServerless
    func GetYdbDatabaseServerless(ctx *Context, name string, id IDInput, state *YdbDatabaseServerlessState, opts ...ResourceOption) (*YdbDatabaseServerless, error)
    public static YdbDatabaseServerless Get(string name, Input<string> id, YdbDatabaseServerlessState? state, CustomResourceOptions? opts = null)
    public static YdbDatabaseServerless get(String name, Output<String> id, YdbDatabaseServerlessState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CreatedAt string
    The Yandex Database serverless cluster creation timestamp.
    DatabasePath string
    Full database path of the Yandex Database serverless cluster. Useful for SDK configuration.
    Description string
    A description for the Yandex Database serverless cluster.
    DocumentApiEndpoint string
    Document API endpoint of the Yandex Database serverless cluster.
    FolderId string
    ID of the folder that the Yandex Database serverless cluster belongs to. It will be deduced from provider configuration if not set explicitly.
    Labels Dictionary<string, string>
    A set of key/value label pairs to assign to the Yandex Database serverless cluster.
    LocationId string
    Location ID for the Yandex Database serverless cluster.
    Name string
    Name for the Yandex Database serverless cluster.
    Status string
    Status of the Yandex Database serverless cluster.
    TlsEnabled bool
    Whether TLS is enabled for the Yandex Database serverless cluster. Useful for SDK configuration.
    YdbApiEndpoint string
    API endpoint of the Yandex Database serverless cluster. Useful for SDK configuration.
    YdbFullEndpoint string
    Full endpoint of the Yandex Database serverless cluster.
    CreatedAt string
    The Yandex Database serverless cluster creation timestamp.
    DatabasePath string
    Full database path of the Yandex Database serverless cluster. Useful for SDK configuration.
    Description string
    A description for the Yandex Database serverless cluster.
    DocumentApiEndpoint string
    Document API endpoint of the Yandex Database serverless cluster.
    FolderId string
    ID of the folder that the Yandex Database serverless cluster belongs to. It will be deduced from provider configuration if not set explicitly.
    Labels map[string]string
    A set of key/value label pairs to assign to the Yandex Database serverless cluster.
    LocationId string
    Location ID for the Yandex Database serverless cluster.
    Name string
    Name for the Yandex Database serverless cluster.
    Status string
    Status of the Yandex Database serverless cluster.
    TlsEnabled bool
    Whether TLS is enabled for the Yandex Database serverless cluster. Useful for SDK configuration.
    YdbApiEndpoint string
    API endpoint of the Yandex Database serverless cluster. Useful for SDK configuration.
    YdbFullEndpoint string
    Full endpoint of the Yandex Database serverless cluster.
    createdAt String
    The Yandex Database serverless cluster creation timestamp.
    databasePath String
    Full database path of the Yandex Database serverless cluster. Useful for SDK configuration.
    description String
    A description for the Yandex Database serverless cluster.
    documentApiEndpoint String
    Document API endpoint of the Yandex Database serverless cluster.
    folderId String
    ID of the folder that the Yandex Database serverless cluster belongs to. It will be deduced from provider configuration if not set explicitly.
    labels Map<String,String>
    A set of key/value label pairs to assign to the Yandex Database serverless cluster.
    locationId String
    Location ID for the Yandex Database serverless cluster.
    name String
    Name for the Yandex Database serverless cluster.
    status String
    Status of the Yandex Database serverless cluster.
    tlsEnabled Boolean
    Whether TLS is enabled for the Yandex Database serverless cluster. Useful for SDK configuration.
    ydbApiEndpoint String
    API endpoint of the Yandex Database serverless cluster. Useful for SDK configuration.
    ydbFullEndpoint String
    Full endpoint of the Yandex Database serverless cluster.
    createdAt string
    The Yandex Database serverless cluster creation timestamp.
    databasePath string
    Full database path of the Yandex Database serverless cluster. Useful for SDK configuration.
    description string
    A description for the Yandex Database serverless cluster.
    documentApiEndpoint string
    Document API endpoint of the Yandex Database serverless cluster.
    folderId string
    ID of the folder that the Yandex Database serverless cluster belongs to. It will be deduced from provider configuration if not set explicitly.
    labels {[key: string]: string}
    A set of key/value label pairs to assign to the Yandex Database serverless cluster.
    locationId string
    Location ID for the Yandex Database serverless cluster.
    name string
    Name for the Yandex Database serverless cluster.
    status string
    Status of the Yandex Database serverless cluster.
    tlsEnabled boolean
    Whether TLS is enabled for the Yandex Database serverless cluster. Useful for SDK configuration.
    ydbApiEndpoint string
    API endpoint of the Yandex Database serverless cluster. Useful for SDK configuration.
    ydbFullEndpoint string
    Full endpoint of the Yandex Database serverless cluster.
    created_at str
    The Yandex Database serverless cluster creation timestamp.
    database_path str
    Full database path of the Yandex Database serverless cluster. Useful for SDK configuration.
    description str
    A description for the Yandex Database serverless cluster.
    document_api_endpoint str
    Document API endpoint of the Yandex Database serverless cluster.
    folder_id str
    ID of the folder that the Yandex Database serverless cluster belongs to. It will be deduced from provider configuration if not set explicitly.
    labels Mapping[str, str]
    A set of key/value label pairs to assign to the Yandex Database serverless cluster.
    location_id str
    Location ID for the Yandex Database serverless cluster.
    name str
    Name for the Yandex Database serverless cluster.
    status str
    Status of the Yandex Database serverless cluster.
    tls_enabled bool
    Whether TLS is enabled for the Yandex Database serverless cluster. Useful for SDK configuration.
    ydb_api_endpoint str
    API endpoint of the Yandex Database serverless cluster. Useful for SDK configuration.
    ydb_full_endpoint str
    Full endpoint of the Yandex Database serverless cluster.
    createdAt String
    The Yandex Database serverless cluster creation timestamp.
    databasePath String
    Full database path of the Yandex Database serverless cluster. Useful for SDK configuration.
    description String
    A description for the Yandex Database serverless cluster.
    documentApiEndpoint String
    Document API endpoint of the Yandex Database serverless cluster.
    folderId String
    ID of the folder that the Yandex Database serverless cluster belongs to. It will be deduced from provider configuration if not set explicitly.
    labels Map<String>
    A set of key/value label pairs to assign to the Yandex Database serverless cluster.
    locationId String
    Location ID for the Yandex Database serverless cluster.
    name String
    Name for the Yandex Database serverless cluster.
    status String
    Status of the Yandex Database serverless cluster.
    tlsEnabled Boolean
    Whether TLS is enabled for the Yandex Database serverless cluster. Useful for SDK configuration.
    ydbApiEndpoint String
    API endpoint of the Yandex Database serverless cluster. Useful for SDK configuration.
    ydbFullEndpoint String
    Full endpoint of the Yandex Database serverless cluster.

    Package Details

    Repository
    Yandex pulumi/pulumi-yandex
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the yandex Terraform Provider.
    yandex logo
    Yandex v0.13.0 published on Tuesday, Feb 22, 2022 by Pulumi
    pulumi/pulumi-yandex