Yandex

v0.10.0 published on Thursday, Nov 18, 2021 by Pulumi

getYdbDatabaseServerless

Get information about a Yandex Database serverless cluster. For more information, see the official documentation.

Example Usage

using Pulumi;
using Yandex = Pulumi.Yandex;

class MyStack : Stack
{
    public MyStack()
    {
        var myDatabase = Output.Create(Yandex.GetYdbDatabaseServerless.InvokeAsync(new Yandex.GetYdbDatabaseServerlessArgs
        {
            DatabaseId = "some_ydb_serverless_database_id",
        }));
        this.YdbApiEndpoint = myDatabase.Apply(myDatabase => myDatabase.YdbApiEndpoint);
    }

    [Output("ydbApiEndpoint")]
    public Output<string> YdbApiEndpoint { get; set; }
}
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 {
		opt0 := "some_ydb_serverless_database_id"
		myDatabase, err := yandex.LookupYdbDatabaseServerless(ctx, &GetYdbDatabaseServerlessArgs{
			DatabaseId: &opt0,
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("ydbApiEndpoint", myDatabase.YdbApiEndpoint)
		return nil
	})
}
import pulumi
import pulumi_yandex as yandex

my_database = yandex.get_ydb_database_serverless(database_id="some_ydb_serverless_database_id")
pulumi.export("ydbApiEndpoint", my_database.ydb_api_endpoint)
import * as pulumi from "@pulumi/pulumi";
import * as yandex from "@pulumi/yandex";

const myDatabase = pulumi.output(yandex.getYdbDatabaseServerless({
    databaseId: "some_ydb_serverless_database_id",
}));

export const ydbApiEndpoint = myDatabase.ydbApiEndpoint;

Using getYdbDatabaseServerless

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getYdbDatabaseServerless(args: GetYdbDatabaseServerlessArgs, opts?: InvokeOptions): Promise<GetYdbDatabaseServerlessResult>
function getYdbDatabaseServerlessOutput(args: GetYdbDatabaseServerlessOutputArgs, opts?: InvokeOptions): Output<GetYdbDatabaseServerlessResult>
def get_ydb_database_serverless(database_id: Optional[str] = None,
                                folder_id: Optional[str] = None,
                                name: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetYdbDatabaseServerlessResult
def get_ydb_database_serverless_output(database_id: Optional[pulumi.Input[str]] = None,
                                folder_id: Optional[pulumi.Input[str]] = None,
                                name: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetYdbDatabaseServerlessResult]
func LookupYdbDatabaseServerless(ctx *Context, args *LookupYdbDatabaseServerlessArgs, opts ...InvokeOption) (*LookupYdbDatabaseServerlessResult, error)
func LookupYdbDatabaseServerlessOutput(ctx *Context, args *LookupYdbDatabaseServerlessOutputArgs, opts ...InvokeOption) LookupYdbDatabaseServerlessResultOutput

> Note: This function is named LookupYdbDatabaseServerless in the Go SDK.

public static class GetYdbDatabaseServerless 
{
    public static Task<GetYdbDatabaseServerlessResult> InvokeAsync(GetYdbDatabaseServerlessArgs args, InvokeOptions? opts = null)
    public static Output<GetYdbDatabaseServerlessResult> Invoke(GetYdbDatabaseServerlessInvokeArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

DatabaseId string
ID 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.
Name string
Name of the Yandex Database serverless cluster.
DatabaseId string
ID 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.
Name string
Name of the Yandex Database serverless cluster.
databaseId string
ID 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.
name string
Name of the Yandex Database serverless cluster.
database_id str
ID 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.
name str
Name of the Yandex Database serverless cluster.

getYdbDatabaseServerless Result

The following output properties are available:

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 of the Yandex Database serverless cluster.
DocumentApiEndpoint string
Document API endpoint of the Yandex Database serverless cluster.
Id string
The provider-assigned unique ID for this managed resource.
Labels Dictionary<string, string>
A set of key/value label pairs assigned to the Yandex Database serverless cluster.
LocationId string
Location ID of 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.
DatabaseId string
FolderId string
Name string
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 of the Yandex Database serverless cluster.
DocumentApiEndpoint string
Document API endpoint of the Yandex Database serverless cluster.
Id string
The provider-assigned unique ID for this managed resource.
Labels map[string]string
A set of key/value label pairs assigned to the Yandex Database serverless cluster.
LocationId string
Location ID of 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.
DatabaseId string
FolderId string
Name string
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 of the Yandex Database serverless cluster.
documentApiEndpoint string
Document API endpoint of the Yandex Database serverless cluster.
id string
The provider-assigned unique ID for this managed resource.
labels {[key: string]: string}
A set of key/value label pairs assigned to the Yandex Database serverless cluster.
locationId string
Location ID of 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.
databaseId string
folderId string
name string
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 of the Yandex Database serverless cluster.
document_api_endpoint str
Document API endpoint of the Yandex Database serverless cluster.
id str
The provider-assigned unique ID for this managed resource.
labels Mapping[str, str]
A set of key/value label pairs assigned to the Yandex Database serverless cluster.
location_id str
Location ID of 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.
database_id str
folder_id str
name str

Package Details

Repository
https://github.com/pulumi/pulumi-yandex
License
Apache-2.0
Notes
This Pulumi package is based on the yandex Terraform Provider.