@pulumiverse/fortios/system/apiuser.d.ts

A Pulumi package for creating and managing Fortios resources. Based on terraform-provider-fortios: version v1.16.0

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
 * ## Import
 *
 * System ApiUser can be imported using any of these accepted formats:
 *
 * ```sh
 * $ pulumi import fortios:system/apiuser:Apiuser labelname {{name}}
 * ```
 *
 * If you do not want to import arguments of block:
 *
 * $ export "FORTIOS_IMPORT_TABLE"="false"
 *
 * ```sh
 * $ pulumi import fortios:system/apiuser:Apiuser labelname {{name}}
 * ```
 *
 * $ unset "FORTIOS_IMPORT_TABLE"
 */
export declare class Apiuser extends pulumi.CustomResource {
    /**
     * Get an existing Apiuser 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?: ApiuserState, opts?: pulumi.CustomResourceOptions): Apiuser;
    /**
     * Returns true if the given object is an instance of Apiuser.  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 Apiuser;
    /**
     * Admin user access profile.
     */
    readonly accprofile: pulumi.Output<string>;
    /**
     * Admin user password.
     */
    readonly apiKey: pulumi.Output<string | undefined>;
    /**
     * Comment.
     */
    readonly comments: pulumi.Output<string | undefined>;
    /**
     * Value for Access-Control-Allow-Origin on API responses. Avoid using '*' if possible.
     */
    readonly corsAllowOrigin: pulumi.Output<string>;
    /**
     * Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
     */
    readonly dynamicSortSubtable: pulumi.Output<string | undefined>;
    /**
     * Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
     */
    readonly getAllTables: pulumi.Output<string | undefined>;
    /**
     * User name.
     */
    readonly name: pulumi.Output<string>;
    /**
     * Enable/disable peer authentication. Valid values: `enable`, `disable`.
     */
    readonly peerAuth: pulumi.Output<string>;
    /**
     * Peer group name.
     */
    readonly peerGroup: pulumi.Output<string>;
    /**
     * Schedule name.
     */
    readonly schedule: pulumi.Output<string>;
    /**
     * Trusthost. The structure of `trusthost` block is documented below.
     */
    readonly trusthosts: pulumi.Output<outputs.system.ApiuserTrusthost[] | undefined>;
    /**
     * Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
     */
    readonly vdomparam: pulumi.Output<string>;
    /**
     * Virtual domains. The structure of `vdom` block is documented below.
     */
    readonly vdoms: pulumi.Output<outputs.system.ApiuserVdom[] | undefined>;
    /**
     * Create a Apiuser 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: ApiuserArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Apiuser resources.
 */
export interface ApiuserState {
    /**
     * Admin user access profile.
     */
    accprofile?: pulumi.Input<string>;
    /**
     * Admin user password.
     */
    apiKey?: pulumi.Input<string>;
    /**
     * Comment.
     */
    comments?: pulumi.Input<string>;
    /**
     * Value for Access-Control-Allow-Origin on API responses. Avoid using '*' if possible.
     */
    corsAllowOrigin?: pulumi.Input<string>;
    /**
     * Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
     */
    dynamicSortSubtable?: pulumi.Input<string>;
    /**
     * Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
     */
    getAllTables?: pulumi.Input<string>;
    /**
     * User name.
     */
    name?: pulumi.Input<string>;
    /**
     * Enable/disable peer authentication. Valid values: `enable`, `disable`.
     */
    peerAuth?: pulumi.Input<string>;
    /**
     * Peer group name.
     */
    peerGroup?: pulumi.Input<string>;
    /**
     * Schedule name.
     */
    schedule?: pulumi.Input<string>;
    /**
     * Trusthost. The structure of `trusthost` block is documented below.
     */
    trusthosts?: pulumi.Input<pulumi.Input<inputs.system.ApiuserTrusthost>[]>;
    /**
     * Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
     */
    vdomparam?: pulumi.Input<string>;
    /**
     * Virtual domains. The structure of `vdom` block is documented below.
     */
    vdoms?: pulumi.Input<pulumi.Input<inputs.system.ApiuserVdom>[]>;
}
/**
 * The set of arguments for constructing a Apiuser resource.
 */
export interface ApiuserArgs {
    /**
     * Admin user access profile.
     */
    accprofile: pulumi.Input<string>;
    /**
     * Admin user password.
     */
    apiKey?: pulumi.Input<string>;
    /**
     * Comment.
     */
    comments?: pulumi.Input<string>;
    /**
     * Value for Access-Control-Allow-Origin on API responses. Avoid using '*' if possible.
     */
    corsAllowOrigin?: pulumi.Input<string>;
    /**
     * Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
     */
    dynamicSortSubtable?: pulumi.Input<string>;
    /**
     * Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
     */
    getAllTables?: pulumi.Input<string>;
    /**
     * User name.
     */
    name?: pulumi.Input<string>;
    /**
     * Enable/disable peer authentication. Valid values: `enable`, `disable`.
     */
    peerAuth?: pulumi.Input<string>;
    /**
     * Peer group name.
     */
    peerGroup?: pulumi.Input<string>;
    /**
     * Schedule name.
     */
    schedule?: pulumi.Input<string>;
    /**
     * Trusthost. The structure of `trusthost` block is documented below.
     */
    trusthosts?: pulumi.Input<pulumi.Input<inputs.system.ApiuserTrusthost>[]>;
    /**
     * Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
     */
    vdomparam?: pulumi.Input<string>;
    /**
     * Virtual domains. The structure of `vdom` block is documented below.
     */
    vdoms?: pulumi.Input<pulumi.Input<inputs.system.ApiuserVdom>[]>;
}