1. Packages
  2. Yandex
  3. API Docs
  4. getYdbDatabaseDedicated
Viewing docs for Yandex v0.13.0
published on Tuesday, Feb 22, 2022 by Pulumi
Schema (JSON)
pulumi/pulumi-yandex

yandex.getYdbDatabaseDedicated

logo
Viewing docs for Yandex v0.13.0
published on Tuesday, Feb 22, 2022 by Pulumi
Schema (JSON)
pulumi/pulumi-yandex

    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
	})
}

    Example coming soon!

    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;

    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)

    Example coming soon!

    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)
}
    public static CompletableFuture<GetYdbDatabaseDedicatedResult> getYdbDatabaseDedicated(GetYdbDatabaseDedicatedArgs args, InvokeOptions options)
public static Output<GetYdbDatabaseDedicatedResult> getYdbDatabaseDedicated(GetYdbDatabaseDedicatedArgs args, InvokeOptions options)

    fn::invoke:
  function: yandex:index/getYdbDatabaseDedicated:getYdbDatabaseDedicated
  arguments:
    # arguments dictionary

    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.
    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.
    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.

    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.
    LocationId string
    Location ID of the Yandex Database cluster.
    Locations List<GetYdbDatabaseDedicatedLocation>
    Location of the Yandex Database cluster. The structure is documented below.
    NetworkId string
    ID of the network the Yandex Database cluster is attached to.
    ResourcePresetId string
    The Yandex Database cluster preset.
    ScalePolicies List<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.
    LocationId string
    Location ID of the Yandex Database cluster.
    Locations []GetYdbDatabaseDedicatedLocation
    Location of the Yandex Database cluster. The structure is documented below.
    NetworkId string
    ID of the network the Yandex Database cluster is attached to.
    ResourcePresetId string
    The Yandex Database cluster preset.
    ScalePolicies []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 Map<String,String>
    A set of key/value label pairs assigned to the Yandex Database cluster.
    locationId String
    Location ID of the Yandex Database cluster.
    locations List<GetYdbDatabaseDedicatedLocation>
    Location of the Yandex Database cluster. The structure is documented below.
    networkId String
    ID of the network the Yandex Database cluster is attached to.
    resourcePresetId String
    The Yandex Database cluster preset.
    scalePolicies List<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 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
    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.
    locationId string
    Location ID of the Yandex Database cluster.
    locations GetYdbDatabaseDedicatedLocation[]
    Location of the Yandex Database cluster. The structure is documented below.
    networkId string
    ID of the network the Yandex Database cluster is attached to.
    resourcePresetId string
    The Yandex Database cluster preset.
    scalePolicies 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_id str
    Location ID of the Yandex Database cluster.
    locations Sequence[GetYdbDatabaseDedicatedLocation]
    Location of the Yandex Database cluster. The structure is documented below.
    network_id str
    ID of the network the Yandex Database cluster is attached to.
    resource_preset_id str
    The Yandex Database cluster preset.
    scale_policies Sequence[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
    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 Map<String>
    A set of key/value label pairs assigned to the Yandex Database cluster.
    locationId String
    Location ID of the Yandex Database cluster.
    locations List<Property Map>
    Location of the Yandex Database cluster. The structure is documented below.
    networkId String
    ID of the network the Yandex Database cluster is attached to.
    resourcePresetId String
    The Yandex Database cluster preset.
    scalePolicies List<Property Map>
    Scaling policy of the Yandex Database cluster. The structure is documented below.
    status String
    Status of the Yandex Database cluster.
    storageConfigs List<Property Map>
    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 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

    Supporting Types

    GetYdbDatabaseDedicatedLocation

    Regions List<GetYdbDatabaseDedicatedLocationRegion>
    Region of the Yandex Database cluster. The structure is documented below.
    Zones List<GetYdbDatabaseDedicatedLocationZone>
    Regions []GetYdbDatabaseDedicatedLocationRegion
    Region of the Yandex Database cluster. The structure is documented below.
    Zones []GetYdbDatabaseDedicatedLocationZone
    regions List<GetYdbDatabaseDedicatedLocationRegion>
    Region of the Yandex Database cluster. The structure is documented below.
    zones List<GetYdbDatabaseDedicatedLocationZone>
    regions GetYdbDatabaseDedicatedLocationRegion[]
    Region of the Yandex Database cluster. The structure is documented below.
    zones GetYdbDatabaseDedicatedLocationZone[]
    regions Sequence[GetYdbDatabaseDedicatedLocationRegion]
    Region of the Yandex Database cluster. The structure is documented below.
    zones Sequence[GetYdbDatabaseDedicatedLocationZone]
    regions List<Property Map>
    Region of the Yandex Database cluster. The structure is documented below.
    zones List<Property Map>

    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 string
    Region ID of the Yandex Database cluster.
    id str
    Region ID of the Yandex Database cluster.
    id String
    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 string
    Region ID of the Yandex Database cluster.
    id str
    Region ID of the Yandex Database cluster.
    id String
    Region ID of the Yandex Database cluster.

    GetYdbDatabaseDedicatedScalePolicy

    FixedScales List<GetYdbDatabaseDedicatedScalePolicyFixedScale>
    Fixed scaling policy of the Yandex Database cluster. The structure is documented below.
    FixedScales []GetYdbDatabaseDedicatedScalePolicyFixedScale
    Fixed scaling policy of the Yandex Database cluster. The structure is documented below.
    fixedScales List<GetYdbDatabaseDedicatedScalePolicyFixedScale>
    Fixed scaling policy of the Yandex Database cluster. The structure is documented below.
    fixedScales GetYdbDatabaseDedicatedScalePolicyFixedScale[]
    Fixed scaling policy of the Yandex Database cluster. The structure is documented below.
    fixed_scales Sequence[GetYdbDatabaseDedicatedScalePolicyFixedScale]
    Fixed scaling policy of the Yandex Database cluster. The structure is documented below.
    fixedScales List<Property Map>
    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 Integer
    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.
    size Number
    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 Integer
    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.
    groupCount Number
    Amount of storage groups of selected type in the Yandex Database cluster.
    storageTypeId String
    Storage type ID of the Yandex Database cluster.

    Package Details

    Repository
    Yandex pulumi/pulumi-yandex
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the yandex Terraform Provider.
    logo
    Viewing docs for Yandex v0.13.0
    published on Tuesday, Feb 22, 2022 by Pulumi
    Schema (JSON)
    pulumi/pulumi-yandex
      Try Pulumi Cloud free. Your team will thank you.