@pulumiverse/cockroach
Version:
A Pulumi package to create and managed Cockroach DB resources in Pulumi programs.
87 lines (86 loc) • 3.42 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Private endpoint connections allow customer applications to connect to a CockroachDB Cloud cluster without traversing the public internet. All application-database traffic remains within the cloud-provider network.
*
* ## Import
*
* format: <cluster id>:<connection id>
*
* ```sh
* $ pulumi import cockroach:index/privateEndpointConnection:PrivateEndpointConnection resource_name 1f69fdd2-600a-4cfc-a9ba-16995df0d77d:vpce-0c1308d7312217abc
* ```
*/
export declare class PrivateEndpointConnection extends pulumi.CustomResource {
/**
* Get an existing PrivateEndpointConnection 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?: PrivateEndpointConnectionState, opts?: pulumi.CustomResourceOptions): PrivateEndpointConnection;
/**
* Returns true if the given object is an instance of PrivateEndpointConnection. 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 PrivateEndpointConnection;
/**
* Cloud provider associated with this connection.
*/
readonly cloudProvider: pulumi.Output<string>;
readonly clusterId: pulumi.Output<string>;
/**
* Client side ID of the Private Endpoint Connection.
*/
readonly endpointId: pulumi.Output<string>;
/**
* Cloud provider region code associated with this connection.
*/
readonly regionName: pulumi.Output<string>;
/**
* Server side ID of the Private Endpoint Connection.
*/
readonly serviceId: pulumi.Output<string>;
/**
* Create a PrivateEndpointConnection 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: PrivateEndpointConnectionArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering PrivateEndpointConnection resources.
*/
export interface PrivateEndpointConnectionState {
/**
* Cloud provider associated with this connection.
*/
cloudProvider?: pulumi.Input<string>;
clusterId?: pulumi.Input<string>;
/**
* Client side ID of the Private Endpoint Connection.
*/
endpointId?: pulumi.Input<string>;
/**
* Cloud provider region code associated with this connection.
*/
regionName?: pulumi.Input<string>;
/**
* Server side ID of the Private Endpoint Connection.
*/
serviceId?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a PrivateEndpointConnection resource.
*/
export interface PrivateEndpointConnectionArgs {
clusterId: pulumi.Input<string>;
/**
* Client side ID of the Private Endpoint Connection.
*/
endpointId: pulumi.Input<string>;
}