@natzka-oss/pulumi-netbox
Version:
A Pulumi package for creating and managing Netbox cloud resources.
90 lines (89 loc) • 2.35 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as netbox from "@pulumi/netbox";
*
* const vmwCluster01 = netbox.virt.getCluster({
* name: "vmw-cluster-01",
* });
* ```
*/
export declare function getCluster(args?: GetClusterArgs, opts?: pulumi.InvokeOptions): Promise<GetClusterResult>;
/**
* A collection of arguments for invoking getCluster.
*/
export interface GetClusterArgs {
clusterGroupId?: number;
/**
* At least one of `name`, `siteId` or `id` must be given.
*/
id?: string;
/**
* At least one of `name`, `siteId` or `id` must be given.
*/
name?: string;
/**
* At least one of `name`, `siteId` or `id` must be given.
*/
siteId?: number;
}
/**
* A collection of values returned by getCluster.
*/
export interface GetClusterResult {
readonly clusterGroupId: number;
readonly clusterId: number;
readonly clusterTypeId: number;
readonly comments: string;
readonly customFields: {
[key: string]: string;
};
readonly description: string;
/**
* At least one of `name`, `siteId` or `id` must be given.
*/
readonly id: string;
/**
* At least one of `name`, `siteId` or `id` must be given.
*/
readonly name?: string;
/**
* At least one of `name`, `siteId` or `id` must be given.
*/
readonly siteId: number;
readonly tags: string[];
}
/**
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as netbox from "@pulumi/netbox";
*
* const vmwCluster01 = netbox.virt.getCluster({
* name: "vmw-cluster-01",
* });
* ```
*/
export declare function getClusterOutput(args?: GetClusterOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetClusterResult>;
/**
* A collection of arguments for invoking getCluster.
*/
export interface GetClusterOutputArgs {
clusterGroupId?: pulumi.Input<number>;
/**
* At least one of `name`, `siteId` or `id` must be given.
*/
id?: pulumi.Input<string>;
/**
* At least one of `name`, `siteId` or `id` must be given.
*/
name?: pulumi.Input<string>;
/**
* At least one of `name`, `siteId` or `id` must be given.
*/
siteId?: pulumi.Input<number>;
}