@pulumiverse/scaleway
Version:
A Pulumi package for creating and managing Scaleway cloud resources.
148 lines • 4.29 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Gets information about a VPC connector.
*
* A VPC connector enables network connectivity between two VPCs, allowing resources in separate VPCs to communicate with each other.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* // Retrieve a VPC connector by its ID
* const byId = scaleway.network.getConnector({
* connectorId: "fr-par/11111111-1111-1111-1111-111111111111",
* });
* ```
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* // Retrieve a VPC connector by name
* const byName = scaleway.network.getConnector({
* name: "my-vpc-connector",
* });
* ```
*/
export declare function getConnector(args?: GetConnectorArgs, opts?: pulumi.InvokeOptions): Promise<GetConnectorResult>;
/**
* A collection of arguments for invoking getConnector.
*/
export interface GetConnectorArgs {
/**
* The ID of the VPC connector. Conflicts with all filter arguments below.
*
* The following arguments can be used to look up a VPC connector via the list API. They all conflict with `connectorId`:
*/
connectorId?: string;
/**
* The name to filter for.
*/
name?: string;
/**
* The ID of the Project to filter for.
*/
projectId?: string;
/**
* `region`) The region in which the connector exists.
*/
region?: string;
/**
* List of tags to filter for.
*/
tags?: string[];
/**
* The target VPC ID to filter for.
*/
targetVpcId?: string;
/**
* The source VPC ID to filter for.
*/
vpcId?: string;
}
/**
* A collection of values returned by getConnector.
*/
export interface GetConnectorResult {
readonly connectorId?: string;
readonly createdAt: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
readonly name?: string;
readonly organizationId: string;
readonly projectId?: string;
readonly region?: string;
readonly status: string;
readonly tags?: string[];
readonly targetVpcId?: string;
readonly updatedAt: string;
readonly vpcId?: string;
}
/**
* Gets information about a VPC connector.
*
* A VPC connector enables network connectivity between two VPCs, allowing resources in separate VPCs to communicate with each other.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* // Retrieve a VPC connector by its ID
* const byId = scaleway.network.getConnector({
* connectorId: "fr-par/11111111-1111-1111-1111-111111111111",
* });
* ```
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* // Retrieve a VPC connector by name
* const byName = scaleway.network.getConnector({
* name: "my-vpc-connector",
* });
* ```
*/
export declare function getConnectorOutput(args?: GetConnectorOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetConnectorResult>;
/**
* A collection of arguments for invoking getConnector.
*/
export interface GetConnectorOutputArgs {
/**
* The ID of the VPC connector. Conflicts with all filter arguments below.
*
* The following arguments can be used to look up a VPC connector via the list API. They all conflict with `connectorId`:
*/
connectorId?: pulumi.Input<string | undefined>;
/**
* The name to filter for.
*/
name?: pulumi.Input<string | undefined>;
/**
* The ID of the Project to filter for.
*/
projectId?: pulumi.Input<string | undefined>;
/**
* `region`) The region in which the connector exists.
*/
region?: pulumi.Input<string | undefined>;
/**
* List of tags to filter for.
*/
tags?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* The target VPC ID to filter for.
*/
targetVpcId?: pulumi.Input<string | undefined>;
/**
* The source VPC ID to filter for.
*/
vpcId?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=getConnector.d.ts.map