Yandex

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

YdbDatabaseDedicated

Yandex Database (dedicated) 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.YdbDatabaseDedicated("database1", new Yandex.YdbDatabaseDedicatedArgs
        {
            FolderId = data.Yandex_resourcemanager_folder.Test_folder.Id,
            Location = new Yandex.Inputs.YdbDatabaseDedicatedLocationArgs
            {
                Region = new Yandex.Inputs.YdbDatabaseDedicatedLocationRegionArgs
                {
                    Id = "ru-central1",
                },
            },
            NetworkId = yandex_vpc_network.My_inst_group_network.Id,
            ResourcePresetId = "medium",
            ScalePolicy = new Yandex.Inputs.YdbDatabaseDedicatedScalePolicyArgs
            {
                FixedScale = new Yandex.Inputs.YdbDatabaseDedicatedScalePolicyFixedScaleArgs
                {
                    Size = 1,
                },
            },
            StorageConfig = new Yandex.Inputs.YdbDatabaseDedicatedStorageConfigArgs
            {
                GroupCount = 1,
                StorageTypeId = "ssd",
            },
            SubnetIds = 
            {
                yandex_vpc_subnet.My_inst_group_subnet.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.NewYdbDatabaseDedicated(ctx, "database1", &yandex.YdbDatabaseDedicatedArgs{
			FolderId: pulumi.Any(data.Yandex_resourcemanager_folder.Test_folder.Id),
			Location: &YdbDatabaseDedicatedLocationArgs{
				Region: &YdbDatabaseDedicatedLocationRegionArgs{
					Id: pulumi.String("ru-central1"),
				},
			},
			NetworkId:        pulumi.Any(yandex_vpc_network.My - inst - group - network.Id),
			ResourcePresetId: pulumi.String("medium"),
			ScalePolicy: &YdbDatabaseDedicatedScalePolicyArgs{
				FixedScale: &YdbDatabaseDedicatedScalePolicyFixedScaleArgs{
					Size: pulumi.Int(1),
				},
			},
			StorageConfig: &YdbDatabaseDedicatedStorageConfigArgs{
				GroupCount:    pulumi.Int(1),
				StorageTypeId: pulumi.String("ssd"),
			},
			SubnetIds: pulumi.StringArray{
				pulumi.Any(yandex_vpc_subnet.My - inst - group - subnet.Id),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
import pulumi
import pulumi_yandex as yandex

database1 = yandex.YdbDatabaseDedicated("database1",
    folder_id=data["yandex_resourcemanager_folder"]["test_folder"]["id"],
    location=yandex.YdbDatabaseDedicatedLocationArgs(
        region=yandex.YdbDatabaseDedicatedLocationRegionArgs(
            id="ru-central1",
        ),
    ),
    network_id=yandex_vpc_network["my-inst-group-network"]["id"],
    resource_preset_id="medium",
    scale_policy=yandex.YdbDatabaseDedicatedScalePolicyArgs(
        fixed_scale=yandex.YdbDatabaseDedicatedScalePolicyFixedScaleArgs(
            size=1,
        ),
    ),
    storage_config=yandex.YdbDatabaseDedicatedStorageConfigArgs(
        group_count=1,
        storage_type_id="ssd",
    ),
    subnet_ids=[yandex_vpc_subnet["my-inst-group-subnet"]["id"]])
import * as pulumi from "@pulumi/pulumi";
import * as yandex from "@pulumi/yandex";

const database1 = new yandex.YdbDatabaseDedicated("database1", {
    folderId: yandex_resourcemanager_folder_test_folder.id,
    location: {
        region: {
            id: "ru-central1",
        },
    },
    networkId: yandex_vpc_network_my_inst_group_network.id,
    resourcePresetId: "medium",
    scalePolicy: {
        fixedScale: {
            size: 1,
        },
    },
    storageConfig: {
        groupCount: 1,
        storageTypeId: "ssd",
    },
    subnetIds: [yandex_vpc_subnet_my_inst_group_subnet.id],
});

Create a YdbDatabaseDedicated Resource

new YdbDatabaseDedicated(name: string, args: YdbDatabaseDedicatedArgs, opts?: CustomResourceOptions);
@overload
def YdbDatabaseDedicated(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         assign_public_ips: Optional[bool] = None,
                         description: Optional[str] = None,
                         folder_id: Optional[str] = None,
                         labels: Optional[Mapping[str, str]] = None,
                         location: Optional[YdbDatabaseDedicatedLocationArgs] = None,
                         location_id: Optional[str] = None,
                         name: Optional[str] = None,
                         network_id: Optional[str] = None,
                         resource_preset_id: Optional[str] = None,
                         scale_policy: Optional[YdbDatabaseDedicatedScalePolicyArgs] = None,
                         storage_config: Optional[YdbDatabaseDedicatedStorageConfigArgs] = None,
                         subnet_ids: Optional[Sequence[str]] = None)
@overload
def YdbDatabaseDedicated(resource_name: str,
                         args: YdbDatabaseDedicatedArgs,
                         opts: Optional[ResourceOptions] = None)
func NewYdbDatabaseDedicated(ctx *Context, name string, args YdbDatabaseDedicatedArgs, opts ...ResourceOption) (*YdbDatabaseDedicated, error)
public YdbDatabaseDedicated(string name, YdbDatabaseDedicatedArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args YdbDatabaseDedicatedArgs
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 YdbDatabaseDedicatedArgs
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 YdbDatabaseDedicatedArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args YdbDatabaseDedicatedArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

YdbDatabaseDedicated Resource Properties

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

Inputs

The YdbDatabaseDedicated resource accepts the following input properties:

NetworkId string
ID of the network to attach the Yandex Database cluster to.
ResourcePresetId string
The Yandex Database cluster preset. Available presets can be obtained via yc ydb resource-preset list command.
ScalePolicy YdbDatabaseDedicatedScalePolicyArgs
Scaling policy for the Yandex Database cluster. The structure is documented below.
StorageConfig YdbDatabaseDedicatedStorageConfigArgs
A list of storage configuration options for the Yandex Database cluster. The structure is documented below.
SubnetIds List<string>
List of subnet IDs to attach the Yandex Database cluster to.
AssignPublicIps bool
Whether public IP addresses should be assigned to the Yandex Database cluster.
Description string
A description for 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.
Labels Dictionary<string, string>
A set of key/value label pairs to assign to the Yandex Database cluster.
Location YdbDatabaseDedicatedLocationArgs
Location for the Yandex Database cluster. The structure is documented below.
LocationId string
Location ID for the Yandex Database cluster.
Name string
Name of the Yandex Database cluster.
NetworkId string
ID of the network to attach the Yandex Database cluster to.
ResourcePresetId string
The Yandex Database cluster preset. Available presets can be obtained via yc ydb resource-preset list command.
ScalePolicy YdbDatabaseDedicatedScalePolicyArgs
Scaling policy for the Yandex Database cluster. The structure is documented below.
StorageConfig YdbDatabaseDedicatedStorageConfigArgs
A list of storage configuration options for the Yandex Database cluster. The structure is documented below.
SubnetIds []string
List of subnet IDs to attach the Yandex Database cluster to.
AssignPublicIps bool
Whether public IP addresses should be assigned to the Yandex Database cluster.
Description string
A description for 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.
Labels map[string]string
A set of key/value label pairs to assign to the Yandex Database cluster.
Location YdbDatabaseDedicatedLocationArgs
Location for the Yandex Database cluster. The structure is documented below.
LocationId string
Location ID for the Yandex Database cluster.
Name string
Name of the Yandex Database cluster.
networkId string
ID of the network to attach the Yandex Database cluster to.
resourcePresetId string
The Yandex Database cluster preset. Available presets can be obtained via yc ydb resource-preset list command.
scalePolicy YdbDatabaseDedicatedScalePolicyArgs
Scaling policy for the Yandex Database cluster. The structure is documented below.
storageConfig YdbDatabaseDedicatedStorageConfigArgs
A list of storage configuration options for the Yandex Database cluster. The structure is documented below.
subnetIds string[]
List of subnet IDs to attach the Yandex Database cluster to.
assignPublicIps boolean
Whether public IP addresses should be assigned to the Yandex Database cluster.
description string
A description for 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.
labels {[key: string]: string}
A set of key/value label pairs to assign to the Yandex Database cluster.
location YdbDatabaseDedicatedLocationArgs
Location for the Yandex Database cluster. The structure is documented below.
locationId string
Location ID for the Yandex Database cluster.
name string
Name of the Yandex Database cluster.
network_id str
ID of the network to attach the Yandex Database cluster to.
resource_preset_id str
The Yandex Database cluster preset. Available presets can be obtained via yc ydb resource-preset list command.
scale_policy YdbDatabaseDedicatedScalePolicyArgs
Scaling policy for the Yandex Database cluster. The structure is documented below.
storage_config YdbDatabaseDedicatedStorageConfigArgs
A list of storage configuration options for the Yandex Database cluster. The structure is documented below.
subnet_ids Sequence[str]
List of subnet IDs to attach the Yandex Database cluster to.
assign_public_ips bool
Whether public IP addresses should be assigned to the Yandex Database cluster.
description str
A description for 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.
labels Mapping[str, str]
A set of key/value label pairs to assign to the Yandex Database cluster.
location YdbDatabaseDedicatedLocationArgs
Location for the Yandex Database cluster. The structure is documented below.
location_id str
Location ID for the Yandex Database cluster.
name str
Name of the Yandex Database cluster.

Outputs

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

CreatedAt string
The Yandex Database cluster creation timestamp.
DatabasePath string
Full database path of the Yandex Database cluster. Useful for SDK configuration.
Id string
The provider-assigned unique ID for this managed resource.
Status string
Status of the Yandex Database cluster.
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.
CreatedAt string
The Yandex Database cluster creation timestamp.
DatabasePath string
Full database path of the Yandex Database cluster. Useful for SDK configuration.
Id string
The provider-assigned unique ID for this managed resource.
Status string
Status of the Yandex Database cluster.
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.
createdAt string
The Yandex Database cluster creation timestamp.
databasePath string
Full database path of the Yandex Database cluster. Useful for SDK configuration.
id string
The provider-assigned unique ID for this managed resource.
status string
Status of the Yandex Database cluster.
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.
created_at str
The Yandex Database cluster creation timestamp.
database_path str
Full database path of the Yandex Database cluster. Useful for SDK configuration.
id str
The provider-assigned unique ID for this managed resource.
status str
Status of the Yandex Database cluster.
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.

Look up an Existing YdbDatabaseDedicated Resource

Get an existing YdbDatabaseDedicated 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?: YdbDatabaseDedicatedState, opts?: CustomResourceOptions): YdbDatabaseDedicated
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        assign_public_ips: Optional[bool] = None,
        created_at: Optional[str] = None,
        database_path: Optional[str] = None,
        description: Optional[str] = None,
        folder_id: Optional[str] = None,
        labels: Optional[Mapping[str, str]] = None,
        location: Optional[YdbDatabaseDedicatedLocationArgs] = None,
        location_id: Optional[str] = None,
        name: Optional[str] = None,
        network_id: Optional[str] = None,
        resource_preset_id: Optional[str] = None,
        scale_policy: Optional[YdbDatabaseDedicatedScalePolicyArgs] = None,
        status: Optional[str] = None,
        storage_config: Optional[YdbDatabaseDedicatedStorageConfigArgs] = None,
        subnet_ids: Optional[Sequence[str]] = None,
        tls_enabled: Optional[bool] = None,
        ydb_api_endpoint: Optional[str] = None,
        ydb_full_endpoint: Optional[str] = None) -> YdbDatabaseDedicated
func GetYdbDatabaseDedicated(ctx *Context, name string, id IDInput, state *YdbDatabaseDedicatedState, opts ...ResourceOption) (*YdbDatabaseDedicated, error)
public static YdbDatabaseDedicated Get(string name, Input<string> id, YdbDatabaseDedicatedState? state, CustomResourceOptions? opts = null)
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.

The following state arguments are supported:

AssignPublicIps bool
Whether public IP addresses should be 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 for 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.
Labels Dictionary<string, string>
A set of key/value label pairs to assign to the Yandex Database cluster.
Location YdbDatabaseDedicatedLocationArgs
Location for the Yandex Database cluster. The structure is documented below.
LocationId string
Location ID for the Yandex Database cluster.
Name string
Name of the Yandex Database cluster.
NetworkId string
ID of the network to attach the Yandex Database cluster to.
ResourcePresetId string
The Yandex Database cluster preset. Available presets can be obtained via yc ydb resource-preset list command.
ScalePolicy YdbDatabaseDedicatedScalePolicyArgs
Scaling policy for the Yandex Database cluster. The structure is documented below.
Status string
Status of the Yandex Database cluster.
StorageConfig YdbDatabaseDedicatedStorageConfigArgs
A list of storage configuration options for the Yandex Database cluster. The structure is documented below.
SubnetIds List<string>
List of subnet IDs to attach the Yandex Database cluster 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.
AssignPublicIps bool
Whether public IP addresses should be 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 for 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.
Labels map[string]string
A set of key/value label pairs to assign to the Yandex Database cluster.
Location YdbDatabaseDedicatedLocationArgs
Location for the Yandex Database cluster. The structure is documented below.
LocationId string
Location ID for the Yandex Database cluster.
Name string
Name of the Yandex Database cluster.
NetworkId string
ID of the network to attach the Yandex Database cluster to.
ResourcePresetId string
The Yandex Database cluster preset. Available presets can be obtained via yc ydb resource-preset list command.
ScalePolicy YdbDatabaseDedicatedScalePolicyArgs
Scaling policy for the Yandex Database cluster. The structure is documented below.
Status string
Status of the Yandex Database cluster.
StorageConfig YdbDatabaseDedicatedStorageConfigArgs
A list of storage configuration options for the Yandex Database cluster. The structure is documented below.
SubnetIds []string
List of subnet IDs to attach the Yandex Database cluster 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.
assignPublicIps boolean
Whether public IP addresses should be 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 for 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.
labels {[key: string]: string}
A set of key/value label pairs to assign to the Yandex Database cluster.
location YdbDatabaseDedicatedLocationArgs
Location for the Yandex Database cluster. The structure is documented below.
locationId string
Location ID for the Yandex Database cluster.
name string
Name of the Yandex Database cluster.
networkId string
ID of the network to attach the Yandex Database cluster to.
resourcePresetId string
The Yandex Database cluster preset. Available presets can be obtained via yc ydb resource-preset list command.
scalePolicy YdbDatabaseDedicatedScalePolicyArgs
Scaling policy for the Yandex Database cluster. The structure is documented below.
status string
Status of the Yandex Database cluster.
storageConfig YdbDatabaseDedicatedStorageConfigArgs
A list of storage configuration options for the Yandex Database cluster. The structure is documented below.
subnetIds string[]
List of subnet IDs to attach the Yandex Database cluster 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.
assign_public_ips bool
Whether public IP addresses should be 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 for 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.
labels Mapping[str, str]
A set of key/value label pairs to assign to the Yandex Database cluster.
location YdbDatabaseDedicatedLocationArgs
Location for the Yandex Database cluster. The structure is documented below.
location_id str
Location ID for the Yandex Database cluster.
name str
Name of the Yandex Database cluster.
network_id str
ID of the network to attach the Yandex Database cluster to.
resource_preset_id str
The Yandex Database cluster preset. Available presets can be obtained via yc ydb resource-preset list command.
scale_policy YdbDatabaseDedicatedScalePolicyArgs
Scaling policy for the Yandex Database cluster. The structure is documented below.
status str
Status of the Yandex Database cluster.
storage_config YdbDatabaseDedicatedStorageConfigArgs
A list of storage configuration options for the Yandex Database cluster. The structure is documented below.
subnet_ids Sequence[str]
List of subnet IDs to attach the Yandex Database cluster 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.

Supporting Types

YdbDatabaseDedicatedLocation

Region YdbDatabaseDedicatedLocationRegion
Region for the Yandex Database cluster. The structure is documented below.
Region YdbDatabaseDedicatedLocationRegion
Region for the Yandex Database cluster. The structure is documented below.
region YdbDatabaseDedicatedLocationRegion
Region for the Yandex Database cluster. The structure is documented below.
region YdbDatabaseDedicatedLocationRegion
Region for the Yandex Database cluster. The structure is documented below.

YdbDatabaseDedicatedLocationRegion

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

YdbDatabaseDedicatedScalePolicy

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

YdbDatabaseDedicatedScalePolicyFixedScale

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

YdbDatabaseDedicatedStorageConfig

GroupCount int
Amount of storage groups of selected type for the Yandex Database cluster.
StorageTypeId string
Storage type ID for the Yandex Database cluster. Available presets can be obtained via yc ydb storage-type list command.
GroupCount int
Amount of storage groups of selected type for the Yandex Database cluster.
StorageTypeId string
Storage type ID for the Yandex Database cluster. Available presets can be obtained via yc ydb storage-type list command.
groupCount number
Amount of storage groups of selected type for the Yandex Database cluster.
storageTypeId string
Storage type ID for the Yandex Database cluster. Available presets can be obtained via yc ydb storage-type list command.
group_count int
Amount of storage groups of selected type for the Yandex Database cluster.
storage_type_id str
Storage type ID for the Yandex Database cluster. Available presets can be obtained via yc ydb storage-type list command.

Package Details

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