pulumi-fusionauth/fusionAuthFormField.d.ts

A Pulumi package for managing FusionAuth instances.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
 * ## # Form Field Resource
 *
 * A FusionAuth Form Field is an object that can be customized to receive input within a FusionAuth Form.
 *
 * [Form Field API](https://fusionauth.io/docs/v1/tech/apis/form-fields/)
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as fusionauth from "pulumi-fusionauth";
 *
 * const field = new fusionauth.FusionAuthFormField("field", {
 *     confirm: true,
 *     data: {
 *         leftAddOn: "send",
 *     },
 *     description: "Information about this custom field",
 *     key: "user.firstName",
 *     required: true,
 * });
 * ```
 */
export declare class FusionAuthFormField extends pulumi.CustomResource {
    /**
     * Get an existing FusionAuthFormField 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?: FusionAuthFormFieldState, opts?: pulumi.CustomResourceOptions): FusionAuthFormField;
    /**
     * Returns true if the given object is an instance of FusionAuthFormField.  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 FusionAuthFormField;
    /**
     * Determines if the user input should be confirmed by requiring the value to be entered twice. If true, a confirmation field is included.
     */
    readonly confirm: pulumi.Output<boolean | undefined>;
    /**
     * The Id of an existing Consent. This field will be required when the type is set to consent.
     */
    readonly consentId: pulumi.Output<string | undefined>;
    /**
     * The Form Field control
     */
    readonly control: pulumi.Output<string>;
    /**
     * An object that can hold any information about the Form Field that should be persisted.
     */
    readonly data: pulumi.Output<{
        [key: string]: string;
    } | undefined>;
    /**
     * A description of the Form Field.
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * The Id to use for the new Form Field. If not specified a secure random UUID will be generated.
     */
    readonly formFieldId: pulumi.Output<string | undefined>;
    /**
     * The key is the path to the value in the user or registration object.
     */
    readonly key: pulumi.Output<string>;
    /**
     * The unique name of the Form Field.
     */
    readonly name: pulumi.Output<string>;
    /**
     * A list of options that are applied to checkbox, radio, or select controls.
     */
    readonly options: pulumi.Output<string[] | undefined>;
    /**
     * Determines if a value is required to complete the form.
     */
    readonly required: pulumi.Output<boolean | undefined>;
    /**
     * The data type used to store the value in FusionAuth.
     */
    readonly type: pulumi.Output<string | undefined>;
    readonly validator: pulumi.Output<outputs.FusionAuthFormFieldValidator>;
    /**
     * Create a FusionAuthFormField 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: FusionAuthFormFieldArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering FusionAuthFormField resources.
 */
export interface FusionAuthFormFieldState {
    /**
     * Determines if the user input should be confirmed by requiring the value to be entered twice. If true, a confirmation field is included.
     */
    confirm?: pulumi.Input<boolean>;
    /**
     * The Id of an existing Consent. This field will be required when the type is set to consent.
     */
    consentId?: pulumi.Input<string>;
    /**
     * The Form Field control
     */
    control?: pulumi.Input<string>;
    /**
     * An object that can hold any information about the Form Field that should be persisted.
     */
    data?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    /**
     * A description of the Form Field.
     */
    description?: pulumi.Input<string>;
    /**
     * The Id to use for the new Form Field. If not specified a secure random UUID will be generated.
     */
    formFieldId?: pulumi.Input<string>;
    /**
     * The key is the path to the value in the user or registration object.
     */
    key?: pulumi.Input<string>;
    /**
     * The unique name of the Form Field.
     */
    name?: pulumi.Input<string>;
    /**
     * A list of options that are applied to checkbox, radio, or select controls.
     */
    options?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * Determines if a value is required to complete the form.
     */
    required?: pulumi.Input<boolean>;
    /**
     * The data type used to store the value in FusionAuth.
     */
    type?: pulumi.Input<string>;
    validator?: pulumi.Input<inputs.FusionAuthFormFieldValidator>;
}
/**
 * The set of arguments for constructing a FusionAuthFormField resource.
 */
export interface FusionAuthFormFieldArgs {
    /**
     * Determines if the user input should be confirmed by requiring the value to be entered twice. If true, a confirmation field is included.
     */
    confirm?: pulumi.Input<boolean>;
    /**
     * The Id of an existing Consent. This field will be required when the type is set to consent.
     */
    consentId?: pulumi.Input<string>;
    /**
     * The Form Field control
     */
    control?: pulumi.Input<string>;
    /**
     * An object that can hold any information about the Form Field that should be persisted.
     */
    data?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    /**
     * A description of the Form Field.
     */
    description?: pulumi.Input<string>;
    /**
     * The Id to use for the new Form Field. If not specified a secure random UUID will be generated.
     */
    formFieldId?: pulumi.Input<string>;
    /**
     * The key is the path to the value in the user or registration object.
     */
    key: pulumi.Input<string>;
    /**
     * The unique name of the Form Field.
     */
    name?: pulumi.Input<string>;
    /**
     * A list of options that are applied to checkbox, radio, or select controls.
     */
    options?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * Determines if a value is required to complete the form.
     */
    required?: pulumi.Input<boolean>;
    /**
     * The data type used to store the value in FusionAuth.
     */
    type?: pulumi.Input<string>;
    validator?: pulumi.Input<inputs.FusionAuthFormFieldValidator>;
}