@pulumi/yandex
Version:
A Pulumi package for creating and managing yandex cloud resources.
164 lines (163 loc) • 5.57 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import { input as inputs, output as outputs } from "./types";
/**
* Manages a Data Transfer endpoint. For more information, see [the official documentation](https://cloud.yandex.com/docs/data-transfer/).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as yandex from "@pulumi/yandex";
*
* const pgSource = new yandex.DatatransferEndpoint("pg_source", {
* settings: {
* postgresSource: {
* connection: {
* onPremise: {
* hosts: ["example.org"],
* port: 5432,
* },
* },
* database: "db1",
* password: {
* raw: "123",
* },
* slotGigabyteLagLimit: 100,
* user: "user1",
* },
* },
* });
* const pgTarget = new yandex.DatatransferEndpoint("pg_target", {
* folderId: "some_folder_id",
* settings: {
* postgresTarget: {
* connection: {
* mdbClusterId: "some_cluster_id",
* },
* database: "db2",
* password: {
* raw: "321",
* },
* user: "user2",
* },
* },
* });
* ```
*
* ## Import
*
* An endpoint can be imported using the `id` of the resource, e.g.
*
* ```sh
* $ pulumi import yandex:index/datatransferEndpoint:DatatransferEndpoint foo endpoint_id
* ```
*/
export declare class DatatransferEndpoint extends pulumi.CustomResource {
/**
* Get an existing DatatransferEndpoint 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?: DatatransferEndpointState, opts?: pulumi.CustomResourceOptions): DatatransferEndpoint;
/**
* Returns true if the given object is an instance of DatatransferEndpoint. 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 DatatransferEndpoint;
/**
* (Computed) Identifier of the IAM user account of the user who created the endpoint.
*/
readonly author: pulumi.Output<string>;
/**
* Arbitrary description text for the endpoint.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* ID of the folder to create the endpoint in. If it is not provided, the default provider folder is used.
*/
readonly folderId: pulumi.Output<string>;
/**
* A set of key/value label pairs to assign to the Data Transfer endpoint.
*/
readonly labels: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Name of the endpoint.
*/
readonly name: pulumi.Output<string>;
/**
* Settings for the endpoint. The structure is documented below.
*/
readonly settings: pulumi.Output<outputs.DatatransferEndpointSettings | undefined>;
/**
* Create a DatatransferEndpoint 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?: DatatransferEndpointArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering DatatransferEndpoint resources.
*/
export interface DatatransferEndpointState {
/**
* (Computed) Identifier of the IAM user account of the user who created the endpoint.
*/
author?: pulumi.Input<string>;
/**
* Arbitrary description text for the endpoint.
*/
description?: pulumi.Input<string>;
/**
* ID of the folder to create the endpoint in. If it is not provided, the default provider folder is used.
*/
folderId?: pulumi.Input<string>;
/**
* A set of key/value label pairs to assign to the Data Transfer endpoint.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Name of the endpoint.
*/
name?: pulumi.Input<string>;
/**
* Settings for the endpoint. The structure is documented below.
*/
settings?: pulumi.Input<inputs.DatatransferEndpointSettings>;
}
/**
* The set of arguments for constructing a DatatransferEndpoint resource.
*/
export interface DatatransferEndpointArgs {
/**
* Arbitrary description text for the endpoint.
*/
description?: pulumi.Input<string>;
/**
* ID of the folder to create the endpoint in. If it is not provided, the default provider folder is used.
*/
folderId?: pulumi.Input<string>;
/**
* A set of key/value label pairs to assign to the Data Transfer endpoint.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Name of the endpoint.
*/
name?: pulumi.Input<string>;
/**
* Settings for the endpoint. The structure is documented below.
*/
settings?: pulumi.Input<inputs.DatatransferEndpointSettings>;
}