@lbrlabs/pulumi-scaleway
Version:
A Pulumi package for creating and managing scaleway cloud resources.
148 lines (147 loc) • 5.02 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* ## Import
*
* Database Instance Endpoint can be imported using the `{region}/{endpoint_id}`, e.g. bash
*
* ```sh
* $ pulumi import scaleway:index/documentdbPrivateNetworkEndpoint:DocumentdbPrivateNetworkEndpoint end fr-par/11111111-1111-1111-1111-111111111111
* ```
*/
export declare class DocumentdbPrivateNetworkEndpoint extends pulumi.CustomResource {
/**
* Get an existing DocumentdbPrivateNetworkEndpoint 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?: DocumentdbPrivateNetworkEndpointState, opts?: pulumi.CustomResourceOptions): DocumentdbPrivateNetworkEndpoint;
/**
* Returns true if the given object is an instance of DocumentdbPrivateNetworkEndpoint. 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 DocumentdbPrivateNetworkEndpoint;
/**
* Hostname of the endpoint.
*/
readonly hostname: pulumi.Output<string>;
/**
* UUID of the documentdb instance.
*/
readonly instanceId: pulumi.Output<string>;
/**
* IPv4 address on the network.
*/
readonly ip: pulumi.Output<string>;
/**
* The IP network address within the private subnet. This must be an IPv4 address with a
* CIDR notation. The IP network address within the private subnet is determined by the IP Address Management (IPAM)
* service if not set.
*/
readonly ipNet: pulumi.Output<string>;
/**
* Name of the endpoint.
*/
readonly name: pulumi.Output<string>;
/**
* Port in the Private Network.
*/
readonly port: pulumi.Output<number>;
/**
* The ID of the private network.
*/
readonly privateNetworkId: pulumi.Output<string>;
/**
* The region you want to attach the resource to
*/
readonly region: pulumi.Output<string>;
/**
* The zone you want to attach the resource to
*/
readonly zone: pulumi.Output<string>;
/**
* Create a DocumentdbPrivateNetworkEndpoint 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: DocumentdbPrivateNetworkEndpointArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering DocumentdbPrivateNetworkEndpoint resources.
*/
export interface DocumentdbPrivateNetworkEndpointState {
/**
* Hostname of the endpoint.
*/
hostname?: pulumi.Input<string>;
/**
* UUID of the documentdb instance.
*/
instanceId?: pulumi.Input<string>;
/**
* IPv4 address on the network.
*/
ip?: pulumi.Input<string>;
/**
* The IP network address within the private subnet. This must be an IPv4 address with a
* CIDR notation. The IP network address within the private subnet is determined by the IP Address Management (IPAM)
* service if not set.
*/
ipNet?: pulumi.Input<string>;
/**
* Name of the endpoint.
*/
name?: pulumi.Input<string>;
/**
* Port in the Private Network.
*/
port?: pulumi.Input<number>;
/**
* The ID of the private network.
*/
privateNetworkId?: pulumi.Input<string>;
/**
* The region you want to attach the resource to
*/
region?: pulumi.Input<string>;
/**
* The zone you want to attach the resource to
*/
zone?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a DocumentdbPrivateNetworkEndpoint resource.
*/
export interface DocumentdbPrivateNetworkEndpointArgs {
/**
* UUID of the documentdb instance.
*/
instanceId: pulumi.Input<string>;
/**
* The IP network address within the private subnet. This must be an IPv4 address with a
* CIDR notation. The IP network address within the private subnet is determined by the IP Address Management (IPAM)
* service if not set.
*/
ipNet?: pulumi.Input<string>;
/**
* Port in the Private Network.
*/
port?: pulumi.Input<number>;
/**
* The ID of the private network.
*/
privateNetworkId: pulumi.Input<string>;
/**
* The region you want to attach the resource to
*/
region?: pulumi.Input<string>;
/**
* The zone you want to attach the resource to
*/
zone?: pulumi.Input<string>;
}