@pulumiverse/scaleway
Version:
A Pulumi package for creating and managing Scaleway cloud resources.
234 lines • 8.24 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Creates and manages Scaleway Site-to-Site VPN Gateways.
* For more information, see [the main documentation](https://www.scaleway.com/en/docs/site-to-site-vpn/reference-content/understanding-s2svpn/).
*
* ## Example Usage
*
* ### Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const vpc = new scaleway.network.Vpc("vpc", {name: "my-vpc"});
* const pn = new scaleway.network.PrivateNetwork("pn", {
* name: "my-private-network",
* vpcId: vpc.id,
* ipv4Subnet: {
* subnet: "10.0.1.0/24",
* },
* });
* const gateway = new scaleway.s2svpn.Gateway("gateway", {
* name: "my-vpn-gateway",
* gatewayType: "VGW-S",
* privateNetworkId: pn.id,
* });
* ```
*
* ## Import
*
* VPN Gateways can be imported using `{region}/{id}`, e.g.
*
* ```sh
* $ pulumi import scaleway:s2svpn/gateway:Gateway main fr-par/11111111-1111-1111-1111-111111111111
* ```
*/
export declare class Gateway extends pulumi.CustomResource {
/**
* Get an existing Gateway 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?: GatewayState, opts?: pulumi.CustomResourceOptions): Gateway;
/**
* Returns true if the given object is an instance of Gateway. 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 Gateway;
/**
* The AS Number of the VPN gateway (typically 12876 for Scaleway).
*/
readonly asn: pulumi.Output<number>;
/**
* The date and time of the creation of the VPN gateway (RFC 3339 format).
*/
readonly createdAt: pulumi.Output<string>;
/**
* The VPN gateway type (commercial offer type).
*/
readonly gatewayType: pulumi.Output<string>;
/**
* The ID of the IPAM private IPv4 address to attach to the VPN gateway.
*/
readonly ipamPrivateIpv4Id: pulumi.Output<string>;
/**
* The ID of the IPAM private IPv6 address to attach to the VPN gateway.
*/
readonly ipamPrivateIpv6Id: pulumi.Output<string>;
/**
* The name of the VPN gateway. If not provided, it will be randomly generated.
*/
readonly name: pulumi.Output<string>;
/**
* The Organization ID the VPN gateway is associated with.
*/
readonly organizationId: pulumi.Output<string>;
/**
* The ID of the Private Network to attach to the VPN gateway.
*/
readonly privateNetworkId: pulumi.Output<string>;
/**
* `projectId`) The ID of the project the VPN gateway is associated with.
*/
readonly projectId: pulumi.Output<string>;
/**
* The public endpoint configuration of the VPN gateway. See Public Config below.
*/
readonly publicConfigs: pulumi.Output<outputs.s2svpn.GatewayPublicConfig[]>;
/**
* `region`) The region in which the VPN gateway should be created.
*/
readonly region: pulumi.Output<string | undefined>;
/**
* The status of the VPN gateway.
*/
readonly status: pulumi.Output<string>;
/**
* The list of tags to apply to the VPN gateway.
*/
readonly tags: pulumi.Output<string[]>;
/**
* The date and time of the last update of the VPN gateway (RFC 3339 format).
*/
readonly updatedAt: pulumi.Output<string>;
/**
* `zone`) The zone in which the VPN gateway should be created.
*/
readonly zone: pulumi.Output<string | undefined>;
/**
* Create a Gateway 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: GatewayArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Gateway resources.
*/
export interface GatewayState {
/**
* The AS Number of the VPN gateway (typically 12876 for Scaleway).
*/
asn?: pulumi.Input<number | undefined>;
/**
* The date and time of the creation of the VPN gateway (RFC 3339 format).
*/
createdAt?: pulumi.Input<string | undefined>;
/**
* The VPN gateway type (commercial offer type).
*/
gatewayType?: pulumi.Input<string | undefined>;
/**
* The ID of the IPAM private IPv4 address to attach to the VPN gateway.
*/
ipamPrivateIpv4Id?: pulumi.Input<string | undefined>;
/**
* The ID of the IPAM private IPv6 address to attach to the VPN gateway.
*/
ipamPrivateIpv6Id?: pulumi.Input<string | undefined>;
/**
* The name of the VPN gateway. If not provided, it will be randomly generated.
*/
name?: pulumi.Input<string | undefined>;
/**
* The Organization ID the VPN gateway is associated with.
*/
organizationId?: pulumi.Input<string | undefined>;
/**
* The ID of the Private Network to attach to the VPN gateway.
*/
privateNetworkId?: pulumi.Input<string | undefined>;
/**
* `projectId`) The ID of the project the VPN gateway is associated with.
*/
projectId?: pulumi.Input<string | undefined>;
/**
* The public endpoint configuration of the VPN gateway. See Public Config below.
*/
publicConfigs?: pulumi.Input<pulumi.Input<inputs.s2svpn.GatewayPublicConfig>[] | undefined>;
/**
* `region`) The region in which the VPN gateway should be created.
*/
region?: pulumi.Input<string | undefined>;
/**
* The status of the VPN gateway.
*/
status?: pulumi.Input<string | undefined>;
/**
* The list of tags to apply to the VPN gateway.
*/
tags?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* The date and time of the last update of the VPN gateway (RFC 3339 format).
*/
updatedAt?: pulumi.Input<string | undefined>;
/**
* `zone`) The zone in which the VPN gateway should be created.
*/
zone?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a Gateway resource.
*/
export interface GatewayArgs {
/**
* The VPN gateway type (commercial offer type).
*/
gatewayType: pulumi.Input<string>;
/**
* The ID of the IPAM private IPv4 address to attach to the VPN gateway.
*/
ipamPrivateIpv4Id?: pulumi.Input<string | undefined>;
/**
* The ID of the IPAM private IPv6 address to attach to the VPN gateway.
*/
ipamPrivateIpv6Id?: pulumi.Input<string | undefined>;
/**
* The name of the VPN gateway. If not provided, it will be randomly generated.
*/
name?: pulumi.Input<string | undefined>;
/**
* The ID of the Private Network to attach to the VPN gateway.
*/
privateNetworkId: pulumi.Input<string>;
/**
* `projectId`) The ID of the project the VPN gateway is associated with.
*/
projectId?: pulumi.Input<string | undefined>;
/**
* The public endpoint configuration of the VPN gateway. See Public Config below.
*/
publicConfigs?: pulumi.Input<pulumi.Input<inputs.s2svpn.GatewayPublicConfig>[] | undefined>;
/**
* `region`) The region in which the VPN gateway should be created.
*/
region?: pulumi.Input<string | undefined>;
/**
* The list of tags to apply to the VPN gateway.
*/
tags?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* `zone`) The zone in which the VPN gateway should be created.
*/
zone?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=gateway.d.ts.map