@pulumi/linode
Version:
A Pulumi package for creating and managing linode cloud resources.
155 lines (154 loc) • 4.79 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* > **Limited Availability** VPC-attached NodeBalancers may not currently be available to all users and may require the `apiVersion` provider argument must be set to `v4beta`.
*
* Provides information about Linode NodeBalancers VPC configurations that match a set of filters.
* For more information, see the [Linode APIv4 docs](https://techdocs.akamai.com/linode-api/reference/get-node-balancers).
*
* ## Example Usage
*
* Retrieve all VPC configurations under a NodeBalancer:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as linode from "@pulumi/linode";
*
* const vpc_configs = linode.getNodebalancerVpcs({
* nodebalancerId: 12345,
* });
* ```
*
* Retrieve all VPC configurations under a NodeBalancer with an IPv4 range of "10.0.0.4/30":
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as linode from "@pulumi/linode";
*
* const vpc_configs = linode.getNodebalancerVpcs({
* nodebalancerId: 12345,
* filters: [{
* name: "ipv4_range",
* values: ["10.0.0.4/30"],
* }],
* });
* ```
*
* ## Filterable Fields
*
* * `id`
*
* * `ipv4Range`
*
* * `nodebalancerId`
*
* * `subnetId`
*
* * `vpcId`
*/
export declare function getNodebalancerVpcs(args: GetNodebalancerVpcsArgs, opts?: pulumi.InvokeOptions): Promise<GetNodebalancerVpcsResult>;
/**
* A collection of arguments for invoking getNodebalancerVpcs.
*/
export interface GetNodebalancerVpcsArgs {
filters?: inputs.GetNodebalancerVpcsFilter[];
/**
* The ID of the NodeBalancer to list VPC configurations for.
*
* * `filter` - (Optional) A set of filters used to select VPC configurations that meet certain requirements.
*/
nodebalancerId: number;
/**
* The order in which results should be returned. (`asc`, `desc`; default `asc`)
*/
order?: string;
/**
* The attribute to order the results by. See the Filterable Fields section for a list of valid fields.
*/
orderBy?: string;
}
/**
* A collection of values returned by getNodebalancerVpcs.
*/
export interface GetNodebalancerVpcsResult {
readonly filters?: outputs.GetNodebalancerVpcsFilter[];
/**
* The ID of the VPC configuration.
*/
readonly id: string;
/**
* The ID of the parent NodeBalancer for this VPC configuration.
*/
readonly nodebalancerId: number;
readonly order?: string;
readonly orderBy?: string;
readonly vpcConfigs: outputs.GetNodebalancerVpcsVpcConfig[];
}
/**
* > **Limited Availability** VPC-attached NodeBalancers may not currently be available to all users and may require the `apiVersion` provider argument must be set to `v4beta`.
*
* Provides information about Linode NodeBalancers VPC configurations that match a set of filters.
* For more information, see the [Linode APIv4 docs](https://techdocs.akamai.com/linode-api/reference/get-node-balancers).
*
* ## Example Usage
*
* Retrieve all VPC configurations under a NodeBalancer:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as linode from "@pulumi/linode";
*
* const vpc_configs = linode.getNodebalancerVpcs({
* nodebalancerId: 12345,
* });
* ```
*
* Retrieve all VPC configurations under a NodeBalancer with an IPv4 range of "10.0.0.4/30":
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as linode from "@pulumi/linode";
*
* const vpc_configs = linode.getNodebalancerVpcs({
* nodebalancerId: 12345,
* filters: [{
* name: "ipv4_range",
* values: ["10.0.0.4/30"],
* }],
* });
* ```
*
* ## Filterable Fields
*
* * `id`
*
* * `ipv4Range`
*
* * `nodebalancerId`
*
* * `subnetId`
*
* * `vpcId`
*/
export declare function getNodebalancerVpcsOutput(args: GetNodebalancerVpcsOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetNodebalancerVpcsResult>;
/**
* A collection of arguments for invoking getNodebalancerVpcs.
*/
export interface GetNodebalancerVpcsOutputArgs {
filters?: pulumi.Input<pulumi.Input<inputs.GetNodebalancerVpcsFilterArgs>[]>;
/**
* The ID of the NodeBalancer to list VPC configurations for.
*
* * `filter` - (Optional) A set of filters used to select VPC configurations that meet certain requirements.
*/
nodebalancerId: pulumi.Input<number>;
/**
* The order in which results should be returned. (`asc`, `desc`; default `asc`)
*/
order?: pulumi.Input<string>;
/**
* The attribute to order the results by. See the Filterable Fields section for a list of valid fields.
*/
orderBy?: pulumi.Input<string>;
}