@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
126 lines (125 loc) • 3.68 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Get a Serverless VPC Access connector.
*
* To get more information about Connector, see:
*
* * [API documentation](https://cloud.google.com/vpc/docs/reference/vpcaccess/rest/v1/projects.locations.connectors)
* * How-to Guides
* * [Configuring Serverless VPC Access](https://cloud.google.com/vpc/docs/configure-serverless-vpc-access)
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const sample = gcp.vpcaccess.getConnector({
* name: "vpc-con",
* });
* const connector = new gcp.vpcaccess.Connector("connector", {
* name: "vpc-con",
* ipCidrRange: "10.8.0.0/28",
* network: "default",
* region: "us-central1",
* minInstances: 2,
* maxInstances: 3,
* });
* ```
*/
export declare function getConnector(args: GetConnectorArgs, opts?: pulumi.InvokeOptions): Promise<GetConnectorResult>;
/**
* A collection of arguments for invoking getConnector.
*/
export interface GetConnectorArgs {
/**
* Name of the resource.
*
* - - -
*/
name: string;
/**
* The ID of the project in which the resource belongs. If it
* is not provided, the provider project is used.
*/
project?: string;
/**
* The region in which the resource belongs. If it
* is not provided, the provider region is used.
*/
region?: string;
}
/**
* A collection of values returned by getConnector.
*/
export interface GetConnectorResult {
readonly connectedProjects: string[];
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
readonly ipCidrRange: string;
readonly machineType: string;
readonly maxInstances: number;
readonly maxThroughput: number;
readonly minInstances: number;
readonly minThroughput: number;
readonly name: string;
readonly network: string;
readonly project?: string;
readonly region?: string;
readonly selfLink: string;
readonly state: string;
readonly subnets: outputs.vpcaccess.GetConnectorSubnet[];
}
/**
* Get a Serverless VPC Access connector.
*
* To get more information about Connector, see:
*
* * [API documentation](https://cloud.google.com/vpc/docs/reference/vpcaccess/rest/v1/projects.locations.connectors)
* * How-to Guides
* * [Configuring Serverless VPC Access](https://cloud.google.com/vpc/docs/configure-serverless-vpc-access)
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const sample = gcp.vpcaccess.getConnector({
* name: "vpc-con",
* });
* const connector = new gcp.vpcaccess.Connector("connector", {
* name: "vpc-con",
* ipCidrRange: "10.8.0.0/28",
* network: "default",
* region: "us-central1",
* minInstances: 2,
* maxInstances: 3,
* });
* ```
*/
export declare function getConnectorOutput(args: GetConnectorOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetConnectorResult>;
/**
* A collection of arguments for invoking getConnector.
*/
export interface GetConnectorOutputArgs {
/**
* Name of the resource.
*
* - - -
*/
name: pulumi.Input<string>;
/**
* The ID of the project in which the resource belongs. If it
* is not provided, the provider project is used.
*/
project?: pulumi.Input<string>;
/**
* The region in which the resource belongs. If it
* is not provided, the provider region is used.
*/
region?: pulumi.Input<string>;
}