@pulumi/yandex
Version:
A Pulumi package for creating and managing yandex cloud resources.
183 lines (182 loc) • 6.48 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Yandex Database (serverless) 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.YdbDatabaseServerless("database1", {
* folderId: yandex_resourcemanager_folder_test_folder.id,
* });
* ```
*/
export declare class YdbDatabaseServerless extends pulumi.CustomResource {
/**
* Get an existing YdbDatabaseServerless 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?: YdbDatabaseServerlessState, opts?: pulumi.CustomResourceOptions): YdbDatabaseServerless;
/**
* Returns true if the given object is an instance of YdbDatabaseServerless. 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 YdbDatabaseServerless;
/**
* The Yandex Database serverless cluster creation timestamp.
*/
readonly createdAt: pulumi.Output<string>;
/**
* Full database path of the Yandex Database serverless cluster.
* Useful for SDK configuration.
*/
readonly databasePath: pulumi.Output<string>;
/**
* A description for the Yandex Database serverless cluster.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Document API endpoint of the Yandex Database serverless cluster.
*/
readonly documentApiEndpoint: pulumi.Output<string>;
/**
* ID of the folder that the Yandex Database serverless 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 serverless cluster.
*/
readonly labels: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Location ID for the Yandex Database serverless cluster.
*/
readonly locationId: pulumi.Output<string>;
/**
* Name for the Yandex Database serverless cluster.
*/
readonly name: pulumi.Output<string>;
/**
* Status of the Yandex Database serverless cluster.
*/
readonly status: pulumi.Output<string>;
/**
* Whether TLS is enabled for the Yandex Database serverless cluster.
* Useful for SDK configuration.
*/
readonly tlsEnabled: pulumi.Output<boolean>;
/**
* API endpoint of the Yandex Database serverless cluster.
* Useful for SDK configuration.
*/
readonly ydbApiEndpoint: pulumi.Output<string>;
/**
* Full endpoint of the Yandex Database serverless cluster.
*/
readonly ydbFullEndpoint: pulumi.Output<string>;
/**
* Create a YdbDatabaseServerless 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?: YdbDatabaseServerlessArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering YdbDatabaseServerless resources.
*/
export interface YdbDatabaseServerlessState {
/**
* The Yandex Database serverless cluster creation timestamp.
*/
createdAt?: pulumi.Input<string>;
/**
* Full database path of the Yandex Database serverless cluster.
* Useful for SDK configuration.
*/
databasePath?: pulumi.Input<string>;
/**
* A description for the Yandex Database serverless cluster.
*/
description?: pulumi.Input<string>;
/**
* Document API endpoint of the Yandex Database serverless cluster.
*/
documentApiEndpoint?: pulumi.Input<string>;
/**
* ID of the folder that the Yandex Database serverless 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 serverless cluster.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Location ID for the Yandex Database serverless cluster.
*/
locationId?: pulumi.Input<string>;
/**
* Name for the Yandex Database serverless cluster.
*/
name?: pulumi.Input<string>;
/**
* Status of the Yandex Database serverless cluster.
*/
status?: pulumi.Input<string>;
/**
* Whether TLS is enabled for the Yandex Database serverless cluster.
* Useful for SDK configuration.
*/
tlsEnabled?: pulumi.Input<boolean>;
/**
* API endpoint of the Yandex Database serverless cluster.
* Useful for SDK configuration.
*/
ydbApiEndpoint?: pulumi.Input<string>;
/**
* Full endpoint of the Yandex Database serverless cluster.
*/
ydbFullEndpoint?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a YdbDatabaseServerless resource.
*/
export interface YdbDatabaseServerlessArgs {
/**
* A description for the Yandex Database serverless cluster.
*/
description?: pulumi.Input<string>;
/**
* ID of the folder that the Yandex Database serverless 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 serverless cluster.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Location ID for the Yandex Database serverless cluster.
*/
locationId?: pulumi.Input<string>;
/**
* Name for the Yandex Database serverless cluster.
*/
name?: pulumi.Input<string>;
}