@pulumi/yandex
Version:
A Pulumi package for creating and managing yandex cloud resources.
289 lines (288 loc) • 9.96 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import { input as inputs, output as outputs } from "./types";
/**
* Yandex Database (dedicated) resource.
* For more information, see [the official documentation](https://cloud.yandex.com/en/docs/ydb/concepts/serverless_and_dedicated).
*
* ## Example Usage
*
* ```typescript
* 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],
* });
* ```
*/
export declare class YdbDatabaseDedicated extends pulumi.CustomResource {
/**
* Get an existing YdbDatabaseDedicated resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: YdbDatabaseDedicatedState, opts?: pulumi.CustomResourceOptions): YdbDatabaseDedicated;
/**
* Returns true if the given object is an instance of YdbDatabaseDedicated. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is YdbDatabaseDedicated;
/**
* Whether public IP addresses should be assigned to the Yandex Database cluster.
*/
readonly assignPublicIps: pulumi.Output<boolean | undefined>;
/**
* The Yandex Database cluster creation timestamp.
*/
readonly createdAt: pulumi.Output<string>;
/**
* Full database path of the Yandex Database cluster.
* Useful for SDK configuration.
*/
readonly databasePath: pulumi.Output<string>;
/**
* A description for the Yandex Database cluster.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* ID of the folder that the Yandex Database cluster belongs to.
* It will be deduced from provider configuration if not set explicitly.
*/
readonly folderId: pulumi.Output<string>;
/**
* A set of key/value label pairs to assign to the Yandex Database cluster.
*/
readonly labels: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Location for the Yandex Database cluster.
* The structure is documented below.
*/
readonly location: pulumi.Output<outputs.YdbDatabaseDedicatedLocation | undefined>;
/**
* Location ID for the Yandex Database cluster.
*/
readonly locationId: pulumi.Output<string>;
/**
* Name of the Yandex Database cluster.
*/
readonly name: pulumi.Output<string>;
/**
* ID of the network to attach the Yandex Database cluster to.
*/
readonly networkId: pulumi.Output<string>;
/**
* The Yandex Database cluster preset.
* Available presets can be obtained via `yc ydb resource-preset list` command.
*/
readonly resourcePresetId: pulumi.Output<string>;
/**
* Scaling policy for the Yandex Database cluster.
* The structure is documented below.
*/
readonly scalePolicy: pulumi.Output<outputs.YdbDatabaseDedicatedScalePolicy>;
/**
* Status of the Yandex Database cluster.
*/
readonly status: pulumi.Output<string>;
/**
* A list of storage configuration options for the Yandex Database cluster.
* The structure is documented below.
*/
readonly storageConfig: pulumi.Output<outputs.YdbDatabaseDedicatedStorageConfig>;
/**
* List of subnet IDs to attach the Yandex Database cluster to.
*/
readonly subnetIds: pulumi.Output<string[]>;
/**
* Whether TLS is enabled for the Yandex Database cluster.
* Useful for SDK configuration.
*/
readonly tlsEnabled: pulumi.Output<boolean>;
/**
* API endpoint of the Yandex Database cluster.
* Useful for SDK configuration.
*/
readonly ydbApiEndpoint: pulumi.Output<string>;
/**
* Full endpoint of the Yandex Database cluster.
*/
readonly ydbFullEndpoint: pulumi.Output<string>;
/**
* Create a YdbDatabaseDedicated resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: YdbDatabaseDedicatedArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering YdbDatabaseDedicated resources.
*/
export interface YdbDatabaseDedicatedState {
/**
* Whether public IP addresses should be assigned to the Yandex Database cluster.
*/
assignPublicIps?: pulumi.Input<boolean>;
/**
* The Yandex Database cluster creation timestamp.
*/
createdAt?: pulumi.Input<string>;
/**
* Full database path of the Yandex Database cluster.
* Useful for SDK configuration.
*/
databasePath?: pulumi.Input<string>;
/**
* A description for the Yandex Database cluster.
*/
description?: pulumi.Input<string>;
/**
* ID of the folder that the Yandex Database cluster belongs to.
* It will be deduced from provider configuration if not set explicitly.
*/
folderId?: pulumi.Input<string>;
/**
* A set of key/value label pairs to assign to the Yandex Database cluster.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Location for the Yandex Database cluster.
* The structure is documented below.
*/
location?: pulumi.Input<inputs.YdbDatabaseDedicatedLocation>;
/**
* Location ID for the Yandex Database cluster.
*/
locationId?: pulumi.Input<string>;
/**
* Name of the Yandex Database cluster.
*/
name?: pulumi.Input<string>;
/**
* ID of the network to attach the Yandex Database cluster to.
*/
networkId?: pulumi.Input<string>;
/**
* The Yandex Database cluster preset.
* Available presets can be obtained via `yc ydb resource-preset list` command.
*/
resourcePresetId?: pulumi.Input<string>;
/**
* Scaling policy for the Yandex Database cluster.
* The structure is documented below.
*/
scalePolicy?: pulumi.Input<inputs.YdbDatabaseDedicatedScalePolicy>;
/**
* Status of the Yandex Database cluster.
*/
status?: pulumi.Input<string>;
/**
* A list of storage configuration options for the Yandex Database cluster.
* The structure is documented below.
*/
storageConfig?: pulumi.Input<inputs.YdbDatabaseDedicatedStorageConfig>;
/**
* List of subnet IDs to attach the Yandex Database cluster to.
*/
subnetIds?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Whether TLS is enabled for the Yandex Database cluster.
* Useful for SDK configuration.
*/
tlsEnabled?: pulumi.Input<boolean>;
/**
* API endpoint of the Yandex Database cluster.
* Useful for SDK configuration.
*/
ydbApiEndpoint?: pulumi.Input<string>;
/**
* Full endpoint of the Yandex Database cluster.
*/
ydbFullEndpoint?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a YdbDatabaseDedicated resource.
*/
export interface YdbDatabaseDedicatedArgs {
/**
* Whether public IP addresses should be assigned to the Yandex Database cluster.
*/
assignPublicIps?: pulumi.Input<boolean>;
/**
* A description for the Yandex Database cluster.
*/
description?: pulumi.Input<string>;
/**
* ID of the folder that the Yandex Database cluster belongs to.
* It will be deduced from provider configuration if not set explicitly.
*/
folderId?: pulumi.Input<string>;
/**
* A set of key/value label pairs to assign to the Yandex Database cluster.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Location for the Yandex Database cluster.
* The structure is documented below.
*/
location?: pulumi.Input<inputs.YdbDatabaseDedicatedLocation>;
/**
* Location ID for the Yandex Database cluster.
*/
locationId?: pulumi.Input<string>;
/**
* Name of the Yandex Database cluster.
*/
name?: pulumi.Input<string>;
/**
* ID of the network to attach the Yandex Database cluster to.
*/
networkId: pulumi.Input<string>;
/**
* The Yandex Database cluster preset.
* Available presets can be obtained via `yc ydb resource-preset list` command.
*/
resourcePresetId: pulumi.Input<string>;
/**
* Scaling policy for the Yandex Database cluster.
* The structure is documented below.
*/
scalePolicy: pulumi.Input<inputs.YdbDatabaseDedicatedScalePolicy>;
/**
* A list of storage configuration options for the Yandex Database cluster.
* The structure is documented below.
*/
storageConfig: pulumi.Input<inputs.YdbDatabaseDedicatedStorageConfig>;
/**
* List of subnet IDs to attach the Yandex Database cluster to.
*/
subnetIds: pulumi.Input<pulumi.Input<string>[]>;
}