@pulumiverse/scaleway
Version:
A Pulumi package for creating and managing Scaleway cloud resources.
246 lines (245 loc) • 7.48 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Creates and manages Scaleway VPC Routes.
* For more information, see [the main documentation](https://www.scaleway.com/en/docs/vpc/concepts/).
*
* ## Example Usage
*
* ### With Instance
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const vpc01 = new scaleway.network.Vpc("vpc01", {name: "tf-vpc-vpn"});
* const pn01 = new scaleway.network.PrivateNetwork("pn01", {
* name: "tf-pn-vpn",
* ipv4Subnet: {
* subnet: "172.16.64.0/22",
* },
* vpcId: vpc01.id,
* });
* const server01 = new scaleway.instance.Server("server01", {
* name: "tf-server-vpn",
* type: "PLAY2-MICRO",
* image: "openvpn",
* });
* const pnic01 = new scaleway.instance.PrivateNic("pnic01", {
* privateNetworkId: pn01.id,
* serverId: server01.id,
* });
* const rt01 = new scaleway.network.Route("rt01", {
* vpcId: vpc01.id,
* description: "tf-route-vpn",
* tags: [
* "tf",
* "route",
* ],
* destination: "10.0.0.0/24",
* nexthopResourceId: pnic01.id,
* });
* ```
*
* ### With Baremetal
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumi/scaleway";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const vpc01 = new scaleway.network.Vpc("vpc01", {name: "tf-vpc-vpn"});
* const pn01 = new scaleway.network.PrivateNetwork("pn01", {
* name: "tf-pn-vpn",
* ipv4Subnet: {
* subnet: "172.16.64.0/22",
* },
* vpcId: vpc01.id,
* });
* const myOs = scaleway.elasticmetal.getOs({
* zone: "fr-par-2",
* name: "Ubuntu",
* version: "22.04 LTS (Jammy Jellyfish)",
* });
* const myOffer = scaleway.elasticmetal.getOffer({
* zone: "fr-par-2",
* name: "EM-B112X-SSD",
* });
* const privateNetwork = scaleway.elasticmetal.getOption({
* zone: "fr-par-2",
* name: "Private Network",
* });
* const myKey = scaleway.iam.getSshKey({
* name: "main",
* });
* const myServer = new scaleway.elasticmetal.Server("my_server", {
* zone: "fr-par-2",
* offer: myOffer.then(myOffer => myOffer.offerId),
* os: myOs.then(myOs => myOs.osId),
* sshKeyIds: [myKey.then(myKey => myKey.id)],
* options: [{
* id: privateNetwork.then(privateNetwork => privateNetwork.optionId),
* }],
* privateNetworks: [{
* id: pn01.id,
* }],
* });
* const rt01 = new scaleway.network.Route("rt01", {
* vpcId: vpc01.id,
* description: "tf-route-vpn",
* tags: [
* "tf",
* "route",
* ],
* destination: "10.0.0.0/24",
* nexthopResourceId: myServer.privateNetworks.apply(privateNetworks => privateNetworks?.[0]?.mappingId),
* });
* ```
*
* ## Import
*
* Routes can be imported using `{region}/{id}`, e.g.
*
* bash
*
* ```sh
* $ pulumi import scaleway:index/vpcRoute:VpcRoute main fr-par/11111111-1111-1111-1111-111111111111
* ```
*
* @deprecated scaleway.index/vpcroute.VpcRoute has been deprecated in favor of scaleway.network/route.Route
*/
export declare class VpcRoute extends pulumi.CustomResource {
/**
* Get an existing VpcRoute 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?: VpcRouteState, opts?: pulumi.CustomResourceOptions): VpcRoute;
/**
* Returns true if the given object is an instance of VpcRoute. 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 VpcRoute;
/**
* The date and time of the creation of the route (RFC 3339 format).
*/
readonly createdAt: pulumi.Output<string>;
/**
* The route description.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The destination of the route.
*/
readonly destination: pulumi.Output<string | undefined>;
/**
* The ID of the nexthop private network.
*/
readonly nexthopPrivateNetworkId: pulumi.Output<string | undefined>;
/**
* The ID of the nexthop resource.
*/
readonly nexthopResourceId: pulumi.Output<string | undefined>;
/**
* `region`) The region of the route.
*/
readonly region: pulumi.Output<string>;
/**
* The tags to associate with the route.
*/
readonly tags: pulumi.Output<string[] | undefined>;
/**
* The date and time of the creation of the route (RFC 3339 format).
*/
readonly updatedAt: pulumi.Output<string>;
/**
* The VPC ID the route belongs to.
*/
readonly vpcId: pulumi.Output<string>;
/**
* Create a VpcRoute 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.
*/
/** @deprecated scaleway.index/vpcroute.VpcRoute has been deprecated in favor of scaleway.network/route.Route */
constructor(name: string, args: VpcRouteArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering VpcRoute resources.
*/
export interface VpcRouteState {
/**
* The date and time of the creation of the route (RFC 3339 format).
*/
createdAt?: pulumi.Input<string>;
/**
* The route description.
*/
description?: pulumi.Input<string>;
/**
* The destination of the route.
*/
destination?: pulumi.Input<string>;
/**
* The ID of the nexthop private network.
*/
nexthopPrivateNetworkId?: pulumi.Input<string>;
/**
* The ID of the nexthop resource.
*/
nexthopResourceId?: pulumi.Input<string>;
/**
* `region`) The region of the route.
*/
region?: pulumi.Input<string>;
/**
* The tags to associate with the route.
*/
tags?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The date and time of the creation of the route (RFC 3339 format).
*/
updatedAt?: pulumi.Input<string>;
/**
* The VPC ID the route belongs to.
*/
vpcId?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a VpcRoute resource.
*/
export interface VpcRouteArgs {
/**
* The route description.
*/
description?: pulumi.Input<string>;
/**
* The destination of the route.
*/
destination?: pulumi.Input<string>;
/**
* The ID of the nexthop private network.
*/
nexthopPrivateNetworkId?: pulumi.Input<string>;
/**
* The ID of the nexthop resource.
*/
nexthopResourceId?: pulumi.Input<string>;
/**
* `region`) The region of the route.
*/
region?: pulumi.Input<string>;
/**
* The tags to associate with the route.
*/
tags?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The VPC ID the route belongs to.
*/
vpcId: pulumi.Input<string>;
}