@pulumiverse/scaleway
Version:
A Pulumi package for creating and managing Scaleway cloud resources.
164 lines • 7.03 kB
JavaScript
;
// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.GatewayNetwork = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* Creates and manages GatewayNetworks (connections between a Public Gateway and a Private Network).
*
* It allows the attachment of Private Networks to Public Gateways.
* For more information, see [the API documentation](https://www.scaleway.com/en/developers/api/public-gateway/#step-3-attach-private-networks-to-the-vpc-public-gateway).
*
* ## Example Usage
*
* ### Create a GatewayNetwork with IPAM configuration
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const vpc01 = new scaleway.network.Vpc("vpc01", {name: "my vpc"});
* const pn01 = new scaleway.network.PrivateNetwork("pn01", {
* name: "pn_test_network",
* ipv4Subnet: {
* subnet: "172.16.64.0/22",
* },
* vpcId: vpc01.id,
* });
* const pg01 = new scaleway.network.PublicGateway("pg01", {
* name: "foobar",
* type: "VPC-GW-S",
* });
* const main = new scaleway.network.GatewayNetwork("main", {
* gatewayId: pg01.id,
* privateNetworkId: pn01.id,
* enableMasquerade: true,
* ipamConfigs: [{
* pushDefaultRoute: true,
* }],
* });
* ```
*
* ### Create a GatewayNetwork with a booked IPAM IP
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const vpc01 = new scaleway.network.Vpc("vpc01", {name: "my vpc"});
* const pn01 = new scaleway.network.PrivateNetwork("pn01", {
* name: "pn_test_network",
* ipv4Subnet: {
* subnet: "172.16.64.0/22",
* },
* vpcId: vpc01.id,
* });
* const ip01 = new scaleway.ipam.Ip("ip01", {
* address: "172.16.64.7",
* sources: [{
* privateNetworkId: pn01.id,
* }],
* });
* const pg01 = new scaleway.network.PublicGateway("pg01", {
* name: "foobar",
* type: "VPC-GW-S",
* });
* const main = new scaleway.network.GatewayNetwork("main", {
* gatewayId: pg01.id,
* privateNetworkId: pn01.id,
* enableMasquerade: true,
* ipamConfigs: [{
* pushDefaultRoute: true,
* ipamIpId: ip01.id,
* }],
* });
* ```
*
* ## Import
*
* GatewayNetwork can be imported using `{zone}/{id}`, e.g.
*
* bash
*
* ```sh
* $ pulumi import scaleway:network/gatewayNetwork:GatewayNetwork main fr-par-1/11111111-1111-1111-1111-111111111111
* ```
*/
class GatewayNetwork extends pulumi.CustomResource {
/**
* Get an existing GatewayNetwork 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 GatewayNetwork(name, state, Object.assign(Object.assign({}, opts), { id: id }));
}
/**
* Returns true if the given object is an instance of GatewayNetwork. 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'] === GatewayNetwork.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["cleanupDhcp"] = state ? state.cleanupDhcp : undefined;
resourceInputs["createdAt"] = state ? state.createdAt : undefined;
resourceInputs["dhcpId"] = state ? state.dhcpId : undefined;
resourceInputs["enableDhcp"] = state ? state.enableDhcp : undefined;
resourceInputs["enableMasquerade"] = state ? state.enableMasquerade : undefined;
resourceInputs["gatewayId"] = state ? state.gatewayId : undefined;
resourceInputs["ipamConfigs"] = state ? state.ipamConfigs : undefined;
resourceInputs["macAddress"] = state ? state.macAddress : undefined;
resourceInputs["privateIps"] = state ? state.privateIps : undefined;
resourceInputs["privateNetworkId"] = state ? state.privateNetworkId : undefined;
resourceInputs["staticAddress"] = state ? state.staticAddress : undefined;
resourceInputs["status"] = state ? state.status : undefined;
resourceInputs["updatedAt"] = state ? state.updatedAt : undefined;
resourceInputs["zone"] = state ? state.zone : undefined;
}
else {
const args = argsOrState;
if ((!args || args.gatewayId === undefined) && !opts.urn) {
throw new Error("Missing required property 'gatewayId'");
}
if ((!args || args.privateNetworkId === undefined) && !opts.urn) {
throw new Error("Missing required property 'privateNetworkId'");
}
resourceInputs["cleanupDhcp"] = args ? args.cleanupDhcp : undefined;
resourceInputs["dhcpId"] = args ? args.dhcpId : undefined;
resourceInputs["enableDhcp"] = args ? args.enableDhcp : undefined;
resourceInputs["enableMasquerade"] = args ? args.enableMasquerade : undefined;
resourceInputs["gatewayId"] = args ? args.gatewayId : undefined;
resourceInputs["ipamConfigs"] = args ? args.ipamConfigs : undefined;
resourceInputs["privateIps"] = args ? args.privateIps : undefined;
resourceInputs["privateNetworkId"] = args ? args.privateNetworkId : undefined;
resourceInputs["staticAddress"] = args ? args.staticAddress : undefined;
resourceInputs["zone"] = args ? args.zone : undefined;
resourceInputs["createdAt"] = undefined /*out*/;
resourceInputs["macAddress"] = undefined /*out*/;
resourceInputs["status"] = undefined /*out*/;
resourceInputs["updatedAt"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
const aliasOpts = { aliases: [{ type: "scaleway:index/vpcGatewayNetwork:VpcGatewayNetwork" }] };
opts = pulumi.mergeOptions(opts, aliasOpts);
super(GatewayNetwork.__pulumiType, name, resourceInputs, opts);
}
}
exports.GatewayNetwork = GatewayNetwork;
/** @internal */
GatewayNetwork.__pulumiType = 'scaleway:network/gatewayNetwork:GatewayNetwork';
//# sourceMappingURL=gatewayNetwork.js.map