@pulumi/linode/vpc.d.ts

A Pulumi package for creating and managing linode cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
 * Manages a Linode VPC.
 * For more information, see the [Linode APIv4 docs](https://techdocs.akamai.com/linode-api/reference/post-vpc).
 *
 * Please refer to linode.VpcSubnet to manage the subnets under a Linode VPC.
 *
 * ## Example Usage
 *
 * Create a VPC:
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as linode from "@pulumi/linode";
 *
 * const test = new linode.Vpc("test", {
 *     label: "test-vpc",
 *     region: "us-iad",
 *     description: "My first VPC.",
 * });
 * ```
 *
 * Create a VPC with a `/52` IPv6 range prefix:
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as linode from "@pulumi/linode";
 *
 * // NOTE: IPv6 VPCs may not currently be available to all users.
 * const test = new linode.Vpc("test", {
 *     label: "test-vpc",
 *     region: "us-iad",
 *     ipv6s: [{
 *         range: "/52",
 *     }],
 * });
 * ```
 *
 * ## IPv6
 *
 * > **Limited Availability** IPv6 VPCs may not currently be available to all users.
 *
 * Configures a single IPv6 range under this VPC.
 *
 * * `range` - (Optional) An existing IPv6 prefix owned by the current account or a forward slash (/) followed by a valid prefix length. If unspecified, a range with the default prefix will be allocated for this VPC.
 *
 * * `allocationClass` - (Optional) Indicates the labeled IPv6 Inventory that the VPC Prefix should be allocated from.
 *
 * * `allocatedRange` - (Read-Only) The value of range computed by the API. This is necessary when needing to access the range for an implicit allocation.
 */
export declare class Vpc extends pulumi.CustomResource {
    /**
     * Get an existing Vpc 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?: VpcState, opts?: pulumi.CustomResourceOptions): Vpc;
    /**
     * Returns true if the given object is an instance of Vpc.  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 Vpc;
    /**
     * The date and time when the VPC was created.
     */
    readonly created: pulumi.Output<string>;
    /**
     * The user-defined description of this VPC.
     *
     * * `ipv6` - (Optional) A list of IPv6 allocations under this VPC.
     */
    readonly description: pulumi.Output<string>;
    /**
     * The IPv6 configuration of this VPC.
     */
    readonly ipv6s: pulumi.Output<outputs.VpcIpv6[] | undefined>;
    /**
     * The label of the VPC. This field can only contain ASCII letters, digits and dashes.
     */
    readonly label: pulumi.Output<string>;
    /**
     * The region of the VPC.
     */
    readonly region: pulumi.Output<string>;
    /**
     * The date and time when the VPC was last updated.
     */
    readonly updated: pulumi.Output<string>;
    /**
     * Create a Vpc 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: VpcArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Vpc resources.
 */
export interface VpcState {
    /**
     * The date and time when the VPC was created.
     */
    created?: pulumi.Input<string>;
    /**
     * The user-defined description of this VPC.
     *
     * * `ipv6` - (Optional) A list of IPv6 allocations under this VPC.
     */
    description?: pulumi.Input<string>;
    /**
     * The IPv6 configuration of this VPC.
     */
    ipv6s?: pulumi.Input<pulumi.Input<inputs.VpcIpv6>[]>;
    /**
     * The label of the VPC. This field can only contain ASCII letters, digits and dashes.
     */
    label?: pulumi.Input<string>;
    /**
     * The region of the VPC.
     */
    region?: pulumi.Input<string>;
    /**
     * The date and time when the VPC was last updated.
     */
    updated?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a Vpc resource.
 */
export interface VpcArgs {
    /**
     * The user-defined description of this VPC.
     *
     * * `ipv6` - (Optional) A list of IPv6 allocations under this VPC.
     */
    description?: pulumi.Input<string>;
    /**
     * The IPv6 configuration of this VPC.
     */
    ipv6s?: pulumi.Input<pulumi.Input<inputs.VpcIpv6>[]>;
    /**
     * The label of the VPC. This field can only contain ASCII letters, digits and dashes.
     */
    label: pulumi.Input<string>;
    /**
     * The region of the VPC.
     */
    region: pulumi.Input<string>;
}