@lbrlabs/pulumi-scaleway
Version:
A Pulumi package for creating and managing scaleway cloud resources.
176 lines (175 loc) • 7.1 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Creates and manages the [Scaleway DHCP Reservations](https://www.scaleway.com/en/docs/network/vpc/concepts/#dhcp).
*
* The static associations are used to assign IP addresses based on the MAC addresses of the Instance.
*
* Statically assigned IP addresses should fall within the configured subnet, but be outside of the dynamic range.
*
* For more information, see [the documentation](https://developers.scaleway.com/en/products/vpc-gw/api/v1/#dhcp-c05544) and [configuration guide](https://www.scaleway.com/en/docs/network/vpc/how-to/configure-a-public-gateway/#how-to-review-and-configure-dhcp).
*
* [DHCP reservations](https://developers.scaleway.com/en/products/vpc-gw/api/v1/#dhcp-entries-e40fb6) hold both dynamic DHCP leases (IP addresses dynamically assigned by the gateway to instances) and static user-created DHCP reservations.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@lbrlabs/pulumi-scaleway";
*
* const mainVpcPrivateNetwork = new scaleway.VpcPrivateNetwork("mainVpcPrivateNetwork", {});
* const mainInstanceServer = new scaleway.InstanceServer("mainInstanceServer", {
* image: "ubuntu_jammy",
* type: "DEV1-S",
* zone: "fr-par-1",
* privateNetworks: [{
* pnId: mainVpcPrivateNetwork.id,
* }],
* });
* const mainVpcPublicGatewayIp = new scaleway.VpcPublicGatewayIp("mainVpcPublicGatewayIp", {});
* const mainVpcPublicGatewayDhcp = new scaleway.VpcPublicGatewayDhcp("mainVpcPublicGatewayDhcp", {subnet: "192.168.1.0/24"});
* const mainVpcPublicGateway = new scaleway.VpcPublicGateway("mainVpcPublicGateway", {
* type: "VPC-GW-S",
* ipId: mainVpcPublicGatewayIp.id,
* });
* const mainVpcGatewayNetwork = new scaleway.VpcGatewayNetwork("mainVpcGatewayNetwork", {
* gatewayId: mainVpcPublicGateway.id,
* privateNetworkId: mainVpcPrivateNetwork.id,
* dhcpId: mainVpcPublicGatewayDhcp.id,
* cleanupDhcp: true,
* enableMasquerade: true,
* }, {
* dependsOn: [
* mainVpcPublicGatewayIp,
* mainVpcPrivateNetwork,
* ],
* });
* const mainVpcPublicGatewayDhcpReservation = new scaleway.VpcPublicGatewayDhcpReservation("mainVpcPublicGatewayDhcpReservation", {
* gatewayNetworkId: mainVpcGatewayNetwork.id,
* macAddress: mainInstanceServer.privateNetworks.apply(privateNetworks => privateNetworks?.[0]?.macAddress),
* ipAddress: "192.168.1.1",
* });
* ```
*
* ## Import
*
* Public gateway DHCP Reservation config can be imported using the `{zone}/{id}`, e.g. bash
*
* ```sh
* $ pulumi import scaleway:index/vpcPublicGatewayDhcpReservation:VpcPublicGatewayDhcpReservation main fr-par-1/11111111-1111-1111-1111-111111111111
* ```
*/
export declare class VpcPublicGatewayDhcpReservation extends pulumi.CustomResource {
/**
* Get an existing VpcPublicGatewayDhcpReservation 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?: VpcPublicGatewayDhcpReservationState, opts?: pulumi.CustomResourceOptions): VpcPublicGatewayDhcpReservation;
/**
* Returns true if the given object is an instance of VpcPublicGatewayDhcpReservation. 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 VpcPublicGatewayDhcpReservation;
/**
* The date and time of the creation of the public gateway DHCP config.
*/
readonly createdAt: pulumi.Output<string>;
/**
* The ID of the owning GatewayNetwork.
*/
readonly gatewayNetworkId: pulumi.Output<string>;
/**
* The Hostname of the client machine.
*/
readonly hostname: pulumi.Output<string>;
/**
* The IP address to give to the machine (IP address).
*/
readonly ipAddress: pulumi.Output<string>;
/**
* The MAC address to give a static entry to.
*/
readonly macAddress: pulumi.Output<string>;
/**
* The reservation type, either static (DHCP reservation) or dynamic (DHCP lease). Possible values are reservation and lease.
*/
readonly type: pulumi.Output<string>;
/**
* The date and time of the last update of the public gateway DHCP config.
*/
readonly updatedAt: pulumi.Output<string>;
/**
* `zone`) The zone in which the public gateway DHCP config should be created.
*/
readonly zone: pulumi.Output<string>;
/**
* Create a VpcPublicGatewayDhcpReservation 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: VpcPublicGatewayDhcpReservationArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering VpcPublicGatewayDhcpReservation resources.
*/
export interface VpcPublicGatewayDhcpReservationState {
/**
* The date and time of the creation of the public gateway DHCP config.
*/
createdAt?: pulumi.Input<string>;
/**
* The ID of the owning GatewayNetwork.
*/
gatewayNetworkId?: pulumi.Input<string>;
/**
* The Hostname of the client machine.
*/
hostname?: pulumi.Input<string>;
/**
* The IP address to give to the machine (IP address).
*/
ipAddress?: pulumi.Input<string>;
/**
* The MAC address to give a static entry to.
*/
macAddress?: pulumi.Input<string>;
/**
* The reservation type, either static (DHCP reservation) or dynamic (DHCP lease). Possible values are reservation and lease.
*/
type?: pulumi.Input<string>;
/**
* The date and time of the last update of the public gateway DHCP config.
*/
updatedAt?: pulumi.Input<string>;
/**
* `zone`) The zone in which the public gateway DHCP config should be created.
*/
zone?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a VpcPublicGatewayDhcpReservation resource.
*/
export interface VpcPublicGatewayDhcpReservationArgs {
/**
* The ID of the owning GatewayNetwork.
*/
gatewayNetworkId: pulumi.Input<string>;
/**
* The IP address to give to the machine (IP address).
*/
ipAddress: pulumi.Input<string>;
/**
* The MAC address to give a static entry to.
*/
macAddress: pulumi.Input<string>;
/**
* `zone`) The zone in which the public gateway DHCP config should be created.
*/
zone?: pulumi.Input<string>;
}