@equinix-labs/pulumi-equinix
Version:
A Pulumi package for creating and managing equinix cloud resources.
150 lines (149 loc) • 5.63 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Use this resource to create Metal Gateway resources in Equinix Metal.
*
* See the [Virtual Routing and Forwarding documentation](https://deploy.equinix.com/developers/docs/metal/layer2-networking/vrf/) for product details and API reference material.
*
* ## Example Usage
* ### example 1
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as equinix from "@equinix-labs/pulumi-equinix";
*
* const test = new equinix.metal.Vlan("test", {
* description: "test VLAN in SV",
* metro: "sv",
* projectId: projectId,
* });
* const testGateway = new equinix.metal.Gateway("testGateway", {
* projectId: projectId,
* vlanId: test.id,
* privateIpv4SubnetSize: 8,
* });
* ```
* ### example 2
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as equinix from "@equinix-labs/pulumi-equinix";
*
* const test = new equinix.metal.Vlan("test", {
* description: "test VLAN in SV",
* metro: "sv",
* projectId: projectId,
* });
* const test1 = new equinix.metal.ReservedIpBlock("test1", {
* projectId: projectId,
* metro: "sv",
* quantity: 8,
* });
* const testGateway = new equinix.metal.Gateway("testGateway", {
* projectId: projectId,
* vlanId: test.id,
* ipReservationId: testEquinixMetalReservedIpBlock.id,
* });
* ```
*/
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;
/**
* UUID of Public or VRF IP Reservation to associate with the gateway, the reservation must be in the same metro as the VLAN, conflicts with `privateIpv4SubnetSize`.
*/
readonly ipReservationId: pulumi.Output<string>;
/**
* Size of the private IPv4 subnet to create for this metal gateway, must be one of `8`, `16`, `32`, `64`, `128`. Conflicts with `ipReservationId`.
*/
readonly privateIpv4SubnetSize: pulumi.Output<number>;
/**
* UUID of the project where the gateway is scoped to.
*/
readonly projectId: pulumi.Output<string>;
/**
* Status of the gateway resource.
*/
readonly state: pulumi.Output<string>;
readonly timeouts: pulumi.Output<outputs.metal.GatewayTimeouts | undefined>;
/**
* UUID of the VLAN where the gateway is scoped to.
*/
readonly vlanId: pulumi.Output<string>;
/**
* UUID of the VRF associated with the IP Reservation
*/
readonly vrfId: pulumi.Output<string>;
/**
* 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 {
/**
* UUID of Public or VRF IP Reservation to associate with the gateway, the reservation must be in the same metro as the VLAN, conflicts with `privateIpv4SubnetSize`.
*/
ipReservationId?: pulumi.Input<string>;
/**
* Size of the private IPv4 subnet to create for this metal gateway, must be one of `8`, `16`, `32`, `64`, `128`. Conflicts with `ipReservationId`.
*/
privateIpv4SubnetSize?: pulumi.Input<number>;
/**
* UUID of the project where the gateway is scoped to.
*/
projectId?: pulumi.Input<string>;
/**
* Status of the gateway resource.
*/
state?: pulumi.Input<string>;
timeouts?: pulumi.Input<inputs.metal.GatewayTimeouts>;
/**
* UUID of the VLAN where the gateway is scoped to.
*/
vlanId?: pulumi.Input<string>;
/**
* UUID of the VRF associated with the IP Reservation
*/
vrfId?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Gateway resource.
*/
export interface GatewayArgs {
/**
* UUID of Public or VRF IP Reservation to associate with the gateway, the reservation must be in the same metro as the VLAN, conflicts with `privateIpv4SubnetSize`.
*/
ipReservationId?: pulumi.Input<string>;
/**
* Size of the private IPv4 subnet to create for this metal gateway, must be one of `8`, `16`, `32`, `64`, `128`. Conflicts with `ipReservationId`.
*/
privateIpv4SubnetSize?: pulumi.Input<number>;
/**
* UUID of the project where the gateway is scoped to.
*/
projectId: pulumi.Input<string>;
timeouts?: pulumi.Input<inputs.metal.GatewayTimeouts>;
/**
* UUID of the VLAN where the gateway is scoped to.
*/
vlanId: pulumi.Input<string>;
}