@natzka-oss/pulumi-netbox/configContext.d.ts

A Pulumi package for creating and managing Netbox cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * From the [official documentation](https://docs.netbox.dev/en/stable/models/extras/configcontext/):
 *
 * > Context data is made available to devices and/or virtual machines based on their relationships to other objects in NetBox. For example, context data can be associated only with devices assigned to a particular site, or only to virtual machines in a certain cluster.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as netbox from "@natzka-oss/pulumi-netbox";
 *
 * const test = new netbox.ConfigContext("test", {
 *     name: "%s",
 *     data: JSON.stringify({
 *         testkey: "testval",
 *     }),
 * });
 * ```
 */
export declare class ConfigContext extends pulumi.CustomResource {
    /**
     * Get an existing ConfigContext 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?: ConfigContextState, opts?: pulumi.CustomResourceOptions): ConfigContext;
    /**
     * Returns true if the given object is an instance of ConfigContext.  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 ConfigContext;
    readonly clusterGroups: pulumi.Output<number[] | undefined>;
    readonly clusterTypes: pulumi.Output<number[] | undefined>;
    readonly clusters: pulumi.Output<number[] | undefined>;
    readonly data: pulumi.Output<string>;
    readonly description: pulumi.Output<string | undefined>;
    readonly deviceTypes: pulumi.Output<number[] | undefined>;
    readonly locations: pulumi.Output<number[] | undefined>;
    readonly name: pulumi.Output<string>;
    readonly platforms: pulumi.Output<number[] | undefined>;
    readonly regions: pulumi.Output<number[] | undefined>;
    readonly roles: pulumi.Output<number[] | undefined>;
    readonly siteGroups: pulumi.Output<number[] | undefined>;
    readonly sites: pulumi.Output<number[] | undefined>;
    readonly tags: pulumi.Output<string[] | undefined>;
    readonly tenantGroups: pulumi.Output<number[] | undefined>;
    readonly tenants: pulumi.Output<number[] | undefined>;
    /**
     * Defaults to `1000`.
     */
    readonly weight: pulumi.Output<number | undefined>;
    /**
     * Create a ConfigContext 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: ConfigContextArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering ConfigContext resources.
 */
export interface ConfigContextState {
    clusterGroups?: pulumi.Input<pulumi.Input<number>[]>;
    clusterTypes?: pulumi.Input<pulumi.Input<number>[]>;
    clusters?: pulumi.Input<pulumi.Input<number>[]>;
    data?: pulumi.Input<string>;
    description?: pulumi.Input<string>;
    deviceTypes?: pulumi.Input<pulumi.Input<number>[]>;
    locations?: pulumi.Input<pulumi.Input<number>[]>;
    name?: pulumi.Input<string>;
    platforms?: pulumi.Input<pulumi.Input<number>[]>;
    regions?: pulumi.Input<pulumi.Input<number>[]>;
    roles?: pulumi.Input<pulumi.Input<number>[]>;
    siteGroups?: pulumi.Input<pulumi.Input<number>[]>;
    sites?: pulumi.Input<pulumi.Input<number>[]>;
    tags?: pulumi.Input<pulumi.Input<string>[]>;
    tenantGroups?: pulumi.Input<pulumi.Input<number>[]>;
    tenants?: pulumi.Input<pulumi.Input<number>[]>;
    /**
     * Defaults to `1000`.
     */
    weight?: pulumi.Input<number>;
}
/**
 * The set of arguments for constructing a ConfigContext resource.
 */
export interface ConfigContextArgs {
    clusterGroups?: pulumi.Input<pulumi.Input<number>[]>;
    clusterTypes?: pulumi.Input<pulumi.Input<number>[]>;
    clusters?: pulumi.Input<pulumi.Input<number>[]>;
    data: pulumi.Input<string>;
    description?: pulumi.Input<string>;
    deviceTypes?: pulumi.Input<pulumi.Input<number>[]>;
    locations?: pulumi.Input<pulumi.Input<number>[]>;
    name?: pulumi.Input<string>;
    platforms?: pulumi.Input<pulumi.Input<number>[]>;
    regions?: pulumi.Input<pulumi.Input<number>[]>;
    roles?: pulumi.Input<pulumi.Input<number>[]>;
    siteGroups?: pulumi.Input<pulumi.Input<number>[]>;
    sites?: pulumi.Input<pulumi.Input<number>[]>;
    tags?: pulumi.Input<pulumi.Input<string>[]>;
    tenantGroups?: pulumi.Input<pulumi.Input<number>[]>;
    tenants?: pulumi.Input<pulumi.Input<number>[]>;
    /**
     * Defaults to `1000`.
     */
    weight?: pulumi.Input<number>;
}