Welcome to Pulumi Registry, your window into the cloud. Read the announcement.

Yandex

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

getYdbDatabaseDedicated

Get information about a Yandex Database (dedicated) 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.GetYdbDatabaseDedicated.InvokeAsync(new Yandex.GetYdbDatabaseDedicatedArgs
        {
            DatabaseId = "some_ydb_dedicated_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_dedicated_database_id"
		myDatabase, err := yandex.LookupYdbDatabaseDedicated(ctx, &GetYdbDatabaseDedicatedArgs{
			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_dedicated(database_id="some_ydb_dedicated_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.getYdbDatabaseDedicated({
    databaseId: "some_ydb_dedicated_database_id",
}));

export const ydbApiEndpoint = myDatabase.ydbApiEndpoint;

Using getYdbDatabaseDedicated

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 getYdbDatabaseDedicated(args: GetYdbDatabaseDedicatedArgs, opts?: InvokeOptions): Promise<GetYdbDatabaseDedicatedResult>
function getYdbDatabaseDedicatedOutput(args: GetYdbDatabaseDedicatedOutputArgs, opts?: InvokeOptions): Output<GetYdbDatabaseDedicatedResult>
def get_ydb_database_dedicated(database_id: Optional[str] = None,
                               folder_id: Optional[str] = None,
                               name: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetYdbDatabaseDedicatedResult
def get_ydb_database_dedicated_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[GetYdbDatabaseDedicatedResult]
func LookupYdbDatabaseDedicated(ctx *Context, args *LookupYdbDatabaseDedicatedArgs, opts ...InvokeOption) (*LookupYdbDatabaseDedicatedResult, error)
func LookupYdbDatabaseDedicatedOutput(ctx *Context, args *LookupYdbDatabaseDedicatedOutputArgs, opts ...InvokeOption) LookupYdbDatabaseDedicatedResultOutput

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

public static class GetYdbDatabaseDedicated 
{
    public static Task<GetYdbDatabaseDedicatedResult> InvokeAsync(GetYdbDatabaseDedicatedArgs args, InvokeOptions? opts = null)
    public static Output<GetYdbDatabaseDedicatedResult> Invoke(GetYdbDatabaseDedicatedInvokeArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

DatabaseId string
ID of the Yandex Database cluster.
FolderId string
ID of the folder that the Yandex Database cluster belongs to. It will be deduced from provider configuration if not set explicitly.
Name string
Name of the Yandex Database cluster.
DatabaseId string
ID of the Yandex Database cluster.
FolderId string
ID of the folder that the Yandex Database cluster belongs to. It will be deduced from provider configuration if not set explicitly.
Name string
Name of the Yandex Database cluster.
databaseId string
ID of the Yandex Database cluster.
folderId string
ID of the folder that the Yandex Database cluster belongs to. It will be deduced from provider configuration if not set explicitly.
name string
Name of the Yandex Database cluster.
database_id str
ID of the Yandex Database cluster.
folder_id str
ID of the folder that the Yandex Database cluster belongs to. It will be deduced from provider configuration if not set explicitly.
name str
Name of the Yandex Database cluster.

getYdbDatabaseDedicated Result

The following output properties are available:

AssignPublicIps bool
Whether public IP addresses are assigned to the Yandex Database cluster.
CreatedAt string
The Yandex Database cluster creation timestamp.
DatabasePath string
Full database path of the Yandex Database cluster. Useful for SDK configuration.
Description string
A description of the Yandex Database 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 cluster.
Location GetYdbDatabaseDedicatedLocation
Location of the Yandex Database cluster. The structure is documented below.
LocationId string
Location ID of the Yandex Database cluster.
NetworkId string
ID of the network the Yandex Database cluster is attached to.
ResourcePresetId string
The Yandex Database cluster preset.
ScalePolicy GetYdbDatabaseDedicatedScalePolicy
Scaling policy of the Yandex Database cluster. The structure is documented below.
Status string
Status of the Yandex Database cluster.
StorageConfigs List<GetYdbDatabaseDedicatedStorageConfig>
A list of storage configuration options of the Yandex Database cluster. The structure is documented below.
SubnetIds List<string>
List of subnet IDs the Yandex Database cluster is attached to.
TlsEnabled bool
Whether TLS is enabled for the Yandex Database cluster. Useful for SDK configuration.
YdbApiEndpoint string
API endpoint of the Yandex Database cluster. Useful for SDK configuration.
YdbFullEndpoint string
Full endpoint of the Yandex Database cluster.
DatabaseId string
FolderId string
Name string
AssignPublicIps bool
Whether public IP addresses are assigned to the Yandex Database cluster.
CreatedAt string
The Yandex Database cluster creation timestamp.
DatabasePath string
Full database path of the Yandex Database cluster. Useful for SDK configuration.
Description string
A description of the Yandex Database 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 cluster.
Location GetYdbDatabaseDedicatedLocation
Location of the Yandex Database cluster. The structure is documented below.
LocationId string
Location ID of the Yandex Database cluster.
NetworkId string
ID of the network the Yandex Database cluster is attached to.
ResourcePresetId string
The Yandex Database cluster preset.
ScalePolicy GetYdbDatabaseDedicatedScalePolicy
Scaling policy of the Yandex Database cluster. The structure is documented below.
Status string
Status of the Yandex Database cluster.
StorageConfigs []GetYdbDatabaseDedicatedStorageConfig
A list of storage configuration options of the Yandex Database cluster. The structure is documented below.
SubnetIds []string
List of subnet IDs the Yandex Database cluster is attached to.
TlsEnabled bool
Whether TLS is enabled for the Yandex Database cluster. Useful for SDK configuration.
YdbApiEndpoint string
API endpoint of the Yandex Database cluster. Useful for SDK configuration.
YdbFullEndpoint string
Full endpoint of the Yandex Database cluster.
DatabaseId string
FolderId string
Name string
assignPublicIps boolean
Whether public IP addresses are assigned to the Yandex Database cluster.
createdAt string
The Yandex Database cluster creation timestamp.
databasePath string
Full database path of the Yandex Database cluster. Useful for SDK configuration.
description string
A description of the Yandex Database 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 cluster.
location GetYdbDatabaseDedicatedLocation
Location of the Yandex Database cluster. The structure is documented below.
locationId string
Location ID of the Yandex Database cluster.
networkId string
ID of the network the Yandex Database cluster is attached to.
resourcePresetId string
The Yandex Database cluster preset.
scalePolicy GetYdbDatabaseDedicatedScalePolicy
Scaling policy of the Yandex Database cluster. The structure is documented below.
status string
Status of the Yandex Database cluster.
storageConfigs GetYdbDatabaseDedicatedStorageConfig[]
A list of storage configuration options of the Yandex Database cluster. The structure is documented below.
subnetIds string[]
List of subnet IDs the Yandex Database cluster is attached to.
tlsEnabled boolean
Whether TLS is enabled for the Yandex Database cluster. Useful for SDK configuration.
ydbApiEndpoint string
API endpoint of the Yandex Database cluster. Useful for SDK configuration.
ydbFullEndpoint string
Full endpoint of the Yandex Database cluster.
databaseId string
folderId string
name string
assign_public_ips bool
Whether public IP addresses are assigned to the Yandex Database cluster.
created_at str
The Yandex Database cluster creation timestamp.
database_path str
Full database path of the Yandex Database cluster. Useful for SDK configuration.
description str
A description of the Yandex Database 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 cluster.
location GetYdbDatabaseDedicatedLocation
Location of the Yandex Database cluster. The structure is documented below.
location_id str
Location ID of the Yandex Database cluster.
network_id str
ID of the network the Yandex Database cluster is attached to.
resource_preset_id str
The Yandex Database cluster preset.
scale_policy GetYdbDatabaseDedicatedScalePolicy
Scaling policy of the Yandex Database cluster. The structure is documented below.
status str
Status of the Yandex Database cluster.
storage_configs Sequence[GetYdbDatabaseDedicatedStorageConfig]
A list of storage configuration options of the Yandex Database cluster. The structure is documented below.
subnet_ids Sequence[str]
List of subnet IDs the Yandex Database cluster is attached to.
tls_enabled bool
Whether TLS is enabled for the Yandex Database cluster. Useful for SDK configuration.
ydb_api_endpoint str
API endpoint of the Yandex Database cluster. Useful for SDK configuration.
ydb_full_endpoint str
Full endpoint of the Yandex Database cluster.
database_id str
folder_id str
name str

Supporting Types

GetYdbDatabaseDedicatedLocation

Region GetYdbDatabaseDedicatedLocationRegion
Region of the Yandex Database cluster. The structure is documented below.
Zone GetYdbDatabaseDedicatedLocationZone
Region GetYdbDatabaseDedicatedLocationRegion
Region of the Yandex Database cluster. The structure is documented below.
Zone GetYdbDatabaseDedicatedLocationZone
region GetYdbDatabaseDedicatedLocationRegion
Region of the Yandex Database cluster. The structure is documented below.
zone GetYdbDatabaseDedicatedLocationZone
region GetYdbDatabaseDedicatedLocationRegion
Region of the Yandex Database cluster. The structure is documented below.
zone GetYdbDatabaseDedicatedLocationZone

GetYdbDatabaseDedicatedLocationRegion

Id string
Region ID of the Yandex Database cluster.
Id string
Region ID of the Yandex Database cluster.
id string
Region ID of the Yandex Database cluster.
id str
Region ID of the Yandex Database cluster.

GetYdbDatabaseDedicatedLocationZone

Id string
Region ID of the Yandex Database cluster.
Id string
Region ID of the Yandex Database cluster.
id string
Region ID of the Yandex Database cluster.
id str
Region ID of the Yandex Database cluster.

GetYdbDatabaseDedicatedScalePolicy

FixedScale GetYdbDatabaseDedicatedScalePolicyFixedScale
Fixed scaling policy of the Yandex Database cluster. The structure is documented below.
FixedScale GetYdbDatabaseDedicatedScalePolicyFixedScale
Fixed scaling policy of the Yandex Database cluster. The structure is documented below.
fixedScale GetYdbDatabaseDedicatedScalePolicyFixedScale
Fixed scaling policy of the Yandex Database cluster. The structure is documented below.
fixed_scale GetYdbDatabaseDedicatedScalePolicyFixedScale
Fixed scaling policy of the Yandex Database cluster. The structure is documented below.

GetYdbDatabaseDedicatedScalePolicyFixedScale

Size int
Number of instances in the Yandex Database cluster.
Size int
Number of instances in the Yandex Database cluster.
size number
Number of instances in the Yandex Database cluster.
size int
Number of instances in the Yandex Database cluster.

GetYdbDatabaseDedicatedStorageConfig

GroupCount int
Amount of storage groups of selected type in the Yandex Database cluster.
StorageTypeId string
Storage type ID of the Yandex Database cluster.
GroupCount int
Amount of storage groups of selected type in the Yandex Database cluster.
StorageTypeId string
Storage type ID of the Yandex Database cluster.
groupCount number
Amount of storage groups of selected type in the Yandex Database cluster.
storageTypeId string
Storage type ID of the Yandex Database cluster.
group_count int
Amount of storage groups of selected type in the Yandex Database cluster.
storage_type_id str
Storage type ID of the Yandex Database cluster.

Package Details

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