import * as pulumi from "@pulumi/pulumi"; import * as inputs from "./types/input"; import * as outputs from "./types/output"; /** * 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:index/vpcGatewayNetwork:VpcGatewayNetwork main fr-par-1/11111111-1111-1111-1111-111111111111 * ``` * * @deprecated scaleway.index/vpcgatewaynetwork.VpcGatewayNetwork has been deprecated in favor of scaleway.network/gatewaynetwork.GatewayNetwork */ export declare class VpcGatewayNetwork extends pulumi.CustomResource { /** * Get an existing VpcGatewayNetwork 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, state?: VpcGatewayNetworkState, opts?: pulumi.CustomResourceOptions): VpcGatewayNetwork; /** * Returns true if the given object is an instance of VpcGatewayNetwork. 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 VpcGatewayNetwork; /** * Please use `ipamConfig`. Whether to remove DHCP configuration on this GatewayNetwork upon destroy. Requires DHCP ID. * * @deprecated Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md */ readonly cleanupDhcp: pulumi.Output; /** * The date and time of the creation of the GatewayNetwork. */ readonly createdAt: pulumi.Output; /** * Please use `ipamConfig`. The ID of the Public Gateway DHCP configuration. Only one of `dhcpId`, `staticAddress` and `ipamConfig` should be specified. * * @deprecated Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md */ readonly dhcpId: pulumi.Output; /** * Please use `ipamConfig`. Whether a DHCP configuration should be enabled on this GatewayNetwork. Requires a DHCP ID. * * @deprecated Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md */ readonly enableDhcp: pulumi.Output; /** * Whether masquerade (dynamic NAT) should be enabled on this GatewayNetwork. */ readonly enableMasquerade: pulumi.Output; /** * The ID of the Public Gateway. */ readonly gatewayId: pulumi.Output; /** * Auto-configure the GatewayNetwork using Scaleway's IPAM (IP address management service). Only one of `dhcpId`, `staticAddress` and `ipamConfig` should be specified. */ readonly ipamConfigs: pulumi.Output; /** * The MAC address of the GatewayNetwork. */ readonly macAddress: pulumi.Output; /** * The private IPv4 address associated with the resource. */ readonly privateIps: pulumi.Output; /** * The ID of the Private Network. */ readonly privateNetworkId: pulumi.Output; /** * Please use `ipamConfig`. Enable DHCP configration on this GatewayNetwork. Only one of `dhcpId`, `staticAddress` and `ipamConfig` should be specified. * * @deprecated Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md */ readonly staticAddress: pulumi.Output; /** * The status of the Public Gateway's connection to the Private Network. */ readonly status: pulumi.Output; /** * The date and time of the last update of the GatewayNetwork. */ readonly updatedAt: pulumi.Output; /** * `zone`) The zone in which the gateway network should be created. * * > **Important:** * In 2023, DHCP functionality was moved from Public Gateways to Private Networks, DHCP fields are now deprecated. * For more information, please refer to the dedicated guide. */ readonly zone: pulumi.Output; /** * Create a VpcGatewayNetwork 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/vpcgatewaynetwork.VpcGatewayNetwork has been deprecated in favor of scaleway.network/gatewaynetwork.GatewayNetwork */ constructor(name: string, args: VpcGatewayNetworkArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering VpcGatewayNetwork resources. */ export interface VpcGatewayNetworkState { /** * Please use `ipamConfig`. Whether to remove DHCP configuration on this GatewayNetwork upon destroy. Requires DHCP ID. * * @deprecated Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md */ cleanupDhcp?: pulumi.Input; /** * The date and time of the creation of the GatewayNetwork. */ createdAt?: pulumi.Input; /** * Please use `ipamConfig`. The ID of the Public Gateway DHCP configuration. Only one of `dhcpId`, `staticAddress` and `ipamConfig` should be specified. * * @deprecated Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md */ dhcpId?: pulumi.Input; /** * Please use `ipamConfig`. Whether a DHCP configuration should be enabled on this GatewayNetwork. Requires a DHCP ID. * * @deprecated Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md */ enableDhcp?: pulumi.Input; /** * Whether masquerade (dynamic NAT) should be enabled on this GatewayNetwork. */ enableMasquerade?: pulumi.Input; /** * The ID of the Public Gateway. */ gatewayId?: pulumi.Input; /** * Auto-configure the GatewayNetwork using Scaleway's IPAM (IP address management service). Only one of `dhcpId`, `staticAddress` and `ipamConfig` should be specified. */ ipamConfigs?: pulumi.Input[]>; /** * The MAC address of the GatewayNetwork. */ macAddress?: pulumi.Input; /** * The private IPv4 address associated with the resource. */ privateIps?: pulumi.Input[]>; /** * The ID of the Private Network. */ privateNetworkId?: pulumi.Input; /** * Please use `ipamConfig`. Enable DHCP configration on this GatewayNetwork. Only one of `dhcpId`, `staticAddress` and `ipamConfig` should be specified. * * @deprecated Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md */ staticAddress?: pulumi.Input; /** * The status of the Public Gateway's connection to the Private Network. */ status?: pulumi.Input; /** * The date and time of the last update of the GatewayNetwork. */ updatedAt?: pulumi.Input; /** * `zone`) The zone in which the gateway network should be created. * * > **Important:** * In 2023, DHCP functionality was moved from Public Gateways to Private Networks, DHCP fields are now deprecated. * For more information, please refer to the dedicated guide. */ zone?: pulumi.Input; } /** * The set of arguments for constructing a VpcGatewayNetwork resource. */ export interface VpcGatewayNetworkArgs { /** * Please use `ipamConfig`. Whether to remove DHCP configuration on this GatewayNetwork upon destroy. Requires DHCP ID. * * @deprecated Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md */ cleanupDhcp?: pulumi.Input; /** * Please use `ipamConfig`. The ID of the Public Gateway DHCP configuration. Only one of `dhcpId`, `staticAddress` and `ipamConfig` should be specified. * * @deprecated Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md */ dhcpId?: pulumi.Input; /** * Please use `ipamConfig`. Whether a DHCP configuration should be enabled on this GatewayNetwork. Requires a DHCP ID. * * @deprecated Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md */ enableDhcp?: pulumi.Input; /** * Whether masquerade (dynamic NAT) should be enabled on this GatewayNetwork. */ enableMasquerade?: pulumi.Input; /** * The ID of the Public Gateway. */ gatewayId: pulumi.Input; /** * Auto-configure the GatewayNetwork using Scaleway's IPAM (IP address management service). Only one of `dhcpId`, `staticAddress` and `ipamConfig` should be specified. */ ipamConfigs?: pulumi.Input[]>; /** * The private IPv4 address associated with the resource. */ privateIps?: pulumi.Input[]>; /** * The ID of the Private Network. */ privateNetworkId: pulumi.Input; /** * Please use `ipamConfig`. Enable DHCP configration on this GatewayNetwork. Only one of `dhcpId`, `staticAddress` and `ipamConfig` should be specified. * * @deprecated Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md */ staticAddress?: pulumi.Input; /** * `zone`) The zone in which the gateway network should be created. * * > **Important:** * In 2023, DHCP functionality was moved from Public Gateways to Private Networks, DHCP fields are now deprecated. * For more information, please refer to the dedicated guide. */ zone?: pulumi.Input; }