@natzka-oss/pulumi-netbox
Version:
A Pulumi package for creating and managing Netbox cloud resources.
117 lines (116 loc) • 4.95 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* From the [official documentation](https://docs.netbox.dev/en/stable/models/extras/customfieldchoiceset/):
*
* Single- and multi-selection custom fields must define a set of valid choices from which the user may choose when defining the field value. These choices are defined as sets that may be reused among multiple custom fields.
*
* A choice set must define a base choice set and/or a set of arbitrary extra choices.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as netbox from "@natzka-oss/pulumi-netbox";
*
* const test = new netbox.CustomFieldChoiceSet("test", {
* name: "my-custom-field-set",
* description: "Description",
* extraChoices: [
* [
* "choice1",
* "label1",
* ],
* [
* "choice2",
* "choice2",
* ],
* ],
* });
* ```
*/
export declare class CustomFieldChoiceSet extends pulumi.CustomResource {
/**
* Get an existing CustomFieldChoiceSet 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?: CustomFieldChoiceSetState, opts?: pulumi.CustomResourceOptions): CustomFieldChoiceSet;
/**
* Returns true if the given object is an instance of CustomFieldChoiceSet. 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 CustomFieldChoiceSet;
/**
* Valid values are `IATA`, `ISO_3166` and `UN_LOCODE`. At least one of `baseChoices` or `extraChoices` must be given.
*/
readonly baseChoices: pulumi.Output<string | undefined>;
readonly customFields: pulumi.Output<{
[key: string]: string;
} | undefined>;
readonly description: pulumi.Output<string | undefined>;
/**
* This length of the inner lists must be exactly two, where the first value is the value of a choice and the second value is the label of the choice. At least one of `baseChoices` or `extraChoices` must be given.
*/
readonly extraChoices: pulumi.Output<string[][] | undefined>;
readonly name: pulumi.Output<string>;
/**
* experimental. Defaults to `false`.
*/
readonly orderAlphabetically: pulumi.Output<boolean | undefined>;
/**
* Create a CustomFieldChoiceSet 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?: CustomFieldChoiceSetArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering CustomFieldChoiceSet resources.
*/
export interface CustomFieldChoiceSetState {
/**
* Valid values are `IATA`, `ISO_3166` and `UN_LOCODE`. At least one of `baseChoices` or `extraChoices` must be given.
*/
baseChoices?: pulumi.Input<string>;
customFields?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
description?: pulumi.Input<string>;
/**
* This length of the inner lists must be exactly two, where the first value is the value of a choice and the second value is the label of the choice. At least one of `baseChoices` or `extraChoices` must be given.
*/
extraChoices?: pulumi.Input<pulumi.Input<pulumi.Input<string>[]>[]>;
name?: pulumi.Input<string>;
/**
* experimental. Defaults to `false`.
*/
orderAlphabetically?: pulumi.Input<boolean>;
}
/**
* The set of arguments for constructing a CustomFieldChoiceSet resource.
*/
export interface CustomFieldChoiceSetArgs {
/**
* Valid values are `IATA`, `ISO_3166` and `UN_LOCODE`. At least one of `baseChoices` or `extraChoices` must be given.
*/
baseChoices?: pulumi.Input<string>;
customFields?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
description?: pulumi.Input<string>;
/**
* This length of the inner lists must be exactly two, where the first value is the value of a choice and the second value is the label of the choice. At least one of `baseChoices` or `extraChoices` must be given.
*/
extraChoices?: pulumi.Input<pulumi.Input<pulumi.Input<string>[]>[]>;
name?: pulumi.Input<string>;
/**
* experimental. Defaults to `false`.
*/
orderAlphabetically?: pulumi.Input<boolean>;
}