@pulumiverse/scaleway
Version:
A Pulumi package for creating and managing Scaleway cloud resources.
204 lines • 6.68 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Creates and manages Scaleway VPC Connectors.
*
* A VPC connector enables network connectivity between two VPCs, allowing resources in separate VPCs to communicate with each other.
*
* For more information, see [the main documentation](https://www.scaleway.com/en/docs/vpc/concepts/).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const vpc01 = new scaleway.network.Vpc("vpc01", {name: "my-vpc-source"});
* const vpc02 = new scaleway.network.Vpc("vpc02", {name: "my-vpc-target"});
* const main = new scaleway.network.Connector("main", {
* name: "my-vpc-connector",
* vpcId: vpc01.id,
* targetVpcId: vpc02.id,
* });
* ```
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const vpc01 = new scaleway.network.Vpc("vpc01", {
* name: "my-vpc-source",
* region: "nl-ams",
* });
* const vpc02 = new scaleway.network.Vpc("vpc02", {
* name: "my-vpc-target",
* region: "nl-ams",
* });
* const main = new scaleway.network.Connector("main", {
* name: "my-vpc-connector",
* vpcId: vpc01.id,
* targetVpcId: vpc02.id,
* region: "nl-ams",
* });
* ```
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const vpc01 = new scaleway.network.Vpc("vpc01", {name: "my-vpc-source"});
* const vpc02 = new scaleway.network.Vpc("vpc02", {name: "my-vpc-target"});
* const main = new scaleway.network.Connector("main", {
* name: "my-vpc-connector",
* vpcId: vpc01.id,
* targetVpcId: vpc02.id,
* tags: [
* "production",
* "connector",
* ],
* });
* ```
*
* ## Import
*
* VPC connectors can be imported using `{region}/{id}`, e.g.
*
* ```sh
* $ pulumi import scaleway:network/connector:Connector main fr-par/11111111-1111-1111-1111-111111111111
* ```
*/
export declare class Connector extends pulumi.CustomResource {
/**
* Get an existing Connector 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?: ConnectorState, opts?: pulumi.CustomResourceOptions): Connector;
/**
* Returns true if the given object is an instance of Connector. 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 Connector;
/**
* The date and time of the creation of the VPC connector (RFC 3339 format).
*/
readonly createdAt: pulumi.Output<string>;
/**
* The name of the VPC connector. If not provided it will be randomly generated.
*/
readonly name: pulumi.Output<string>;
/**
* The Organization ID the VPC connector is associated with.
*/
readonly organizationId: pulumi.Output<string>;
/**
* The Scaleway Project the VPC connector belongs to.
*/
readonly projectId: pulumi.Output<string>;
/**
* `region`) The region of the VPC connector.
*/
readonly region: pulumi.Output<string | undefined>;
/**
* The status of the VPC connector.
*/
readonly status: pulumi.Output<string>;
/**
* The tags to associate with the VPC connector.
*/
readonly tags: pulumi.Output<string[] | undefined>;
/**
* The ID of the target VPC to connect to.
*/
readonly targetVpcId: pulumi.Output<string>;
/**
* The date and time of the last update of the VPC connector (RFC 3339 format).
*/
readonly updatedAt: pulumi.Output<string>;
/**
* The ID of the source VPC.
*/
readonly vpcId: pulumi.Output<string>;
/**
* Create a Connector 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: ConnectorArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Connector resources.
*/
export interface ConnectorState {
/**
* The date and time of the creation of the VPC connector (RFC 3339 format).
*/
createdAt?: pulumi.Input<string | undefined>;
/**
* The name of the VPC connector. If not provided it will be randomly generated.
*/
name?: pulumi.Input<string | undefined>;
/**
* The Organization ID the VPC connector is associated with.
*/
organizationId?: pulumi.Input<string | undefined>;
/**
* The Scaleway Project the VPC connector belongs to.
*/
projectId?: pulumi.Input<string | undefined>;
/**
* `region`) The region of the VPC connector.
*/
region?: pulumi.Input<string | undefined>;
/**
* The status of the VPC connector.
*/
status?: pulumi.Input<string | undefined>;
/**
* The tags to associate with the VPC connector.
*/
tags?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* The ID of the target VPC to connect to.
*/
targetVpcId?: pulumi.Input<string | undefined>;
/**
* The date and time of the last update of the VPC connector (RFC 3339 format).
*/
updatedAt?: pulumi.Input<string | undefined>;
/**
* The ID of the source VPC.
*/
vpcId?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a Connector resource.
*/
export interface ConnectorArgs {
/**
* The name of the VPC connector. If not provided it will be randomly generated.
*/
name?: pulumi.Input<string | undefined>;
/**
* `region`) The region of the VPC connector.
*/
region?: pulumi.Input<string | undefined>;
/**
* The tags to associate with the VPC connector.
*/
tags?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* The ID of the target VPC to connect to.
*/
targetVpcId: pulumi.Input<string>;
/**
* The ID of the source VPC.
*/
vpcId: pulumi.Input<string>;
}
//# sourceMappingURL=connector.d.ts.map