@pulumi/linode
Version:
A Pulumi package for creating and managing linode cloud resources.
113 lines (112 loc) • 3.03 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "./types/output";
/**
* Provides information about a Linode VPC.
* For more information, see the [Linode APIv4 docs](https://techdocs.akamai.com/linode-api/reference/get-vpc).
*
* ## Example Usage
*
* The following example shows how one might use this data source to access information about a Linode VPC.
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as linode from "@pulumi/linode";
*
* const foo = linode.getVpc({
* id: "123",
* });
* export const vpc = foo;
* ```
*
* ## IPv6
*
* > **Limited Availability** IPv6 VPCs may not currently be available to all users.
*
* Contains information about a single IPv6 allocation under this VPC.
*
* * `range` - The allocated range in CIDR format.
*
* ### Subnets Reference
*
* To list all subnets under a VPC, please refer to the linode.getVpcSubnets data source.
*/
export declare function getVpc(args: GetVpcArgs, opts?: pulumi.InvokeOptions): Promise<GetVpcResult>;
/**
* A collection of arguments for invoking getVpc.
*/
export interface GetVpcArgs {
/**
* The unique id of this VPC.
*/
id: string;
}
/**
* A collection of values returned by getVpc.
*/
export interface GetVpcResult {
/**
* The date and time when the VPC was created.
*/
readonly created: string;
/**
* The user-defined description of this VPC.
*/
readonly description: string;
readonly id: string;
/**
* A list of IPv6 allocations under this VPC.
*/
readonly ipv6s: outputs.GetVpcIpv6[];
/**
* The label of the VPC.
*/
readonly label: string;
/**
* The region where the VPC is deployed.
*/
readonly region: string;
/**
* The date and time when the VPC was last updated.
*/
readonly updated: string;
}
/**
* Provides information about a Linode VPC.
* For more information, see the [Linode APIv4 docs](https://techdocs.akamai.com/linode-api/reference/get-vpc).
*
* ## Example Usage
*
* The following example shows how one might use this data source to access information about a Linode VPC.
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as linode from "@pulumi/linode";
*
* const foo = linode.getVpc({
* id: "123",
* });
* export const vpc = foo;
* ```
*
* ## IPv6
*
* > **Limited Availability** IPv6 VPCs may not currently be available to all users.
*
* Contains information about a single IPv6 allocation under this VPC.
*
* * `range` - The allocated range in CIDR format.
*
* ### Subnets Reference
*
* To list all subnets under a VPC, please refer to the linode.getVpcSubnets data source.
*/
export declare function getVpcOutput(args: GetVpcOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetVpcResult>;
/**
* A collection of arguments for invoking getVpc.
*/
export interface GetVpcOutputArgs {
/**
* The unique id of this VPC.
*/
id: pulumi.Input<string>;
}