@pulumiverse/scaleway
Version:
A Pulumi package for creating and managing Scaleway cloud resources.
223 lines • 8.12 kB
JavaScript
;
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.Route = void 0;
const pulumi = __importStar(require("@pulumi/pulumi"));
const utilities = __importStar(require("../utilities"));
/**
* 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 "@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),
* });
* ```
*
* ### With VPC Connector
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const vpc01 = new scaleway.network.Vpc("vpc01", {name: "tf-vpc-source"});
* const vpc02 = new scaleway.network.Vpc("vpc02", {name: "tf-vpc-target"});
* const main = new scaleway.network.Connector("main", {
* name: "tf-conn-route",
* vpcId: vpc01.id,
* targetVpcId: vpc02.id,
* });
* const rt01 = new scaleway.network.Route("rt01", {
* vpcId: vpc01.id,
* description: "tf-route-connector",
* tags: [
* "tf",
* "route",
* ],
* destination: "10.0.0.0/24",
* nexthopVpcConnectorId: main.id,
* });
* ```
*
* ## Import
*
* Routes can be imported using `{region}/{id}`, e.g.
*
* ```sh
* $ pulumi import scaleway:network/route:Route main fr-par/11111111-1111-1111-1111-111111111111
* ```
*/
class Route extends pulumi.CustomResource {
/**
* Get an existing Route 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, id, state, opts) {
return new Route(name, state, { ...opts, id: id });
}
/** @internal */
static __pulumiType = 'scaleway:network/route:Route';
/**
* Returns true if the given object is an instance of Route. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj) {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === Route.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["createdAt"] = state?.createdAt;
resourceInputs["description"] = state?.description;
resourceInputs["destination"] = state?.destination;
resourceInputs["nexthopPrivateNetworkId"] = state?.nexthopPrivateNetworkId;
resourceInputs["nexthopResourceId"] = state?.nexthopResourceId;
resourceInputs["nexthopVpcConnectorId"] = state?.nexthopVpcConnectorId;
resourceInputs["region"] = state?.region;
resourceInputs["tags"] = state?.tags;
resourceInputs["updatedAt"] = state?.updatedAt;
resourceInputs["vpcId"] = state?.vpcId;
}
else {
const args = argsOrState;
if (args?.vpcId === undefined && !opts.urn) {
throw new Error("Missing required property 'vpcId'");
}
resourceInputs["description"] = args?.description;
resourceInputs["destination"] = args?.destination;
resourceInputs["nexthopPrivateNetworkId"] = args?.nexthopPrivateNetworkId;
resourceInputs["nexthopResourceId"] = args?.nexthopResourceId;
resourceInputs["nexthopVpcConnectorId"] = args?.nexthopVpcConnectorId;
resourceInputs["region"] = args?.region;
resourceInputs["tags"] = args?.tags;
resourceInputs["vpcId"] = args?.vpcId;
resourceInputs["createdAt"] = undefined /*out*/;
resourceInputs["updatedAt"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
const aliasOpts = { aliases: [{ type: "scaleway:index/vpcRoute:VpcRoute" }] };
opts = pulumi.mergeOptions(opts, aliasOpts);
super(Route.__pulumiType, name, resourceInputs, opts);
}
}
exports.Route = Route;
//# sourceMappingURL=route.js.map