@pulumi/f5bigip/ltm/ifile.d.ts

A Pulumi package for creating and managing F5 BigIP resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * `f5bigip.ltm.Ifile` This resource creates an LTM iFile on F5 BIG-IP that references an existing system iFile.
 * LTM iFiles are used in iRules and LTM policies to access file content for traffic processing and decision making.
 *
 * ## Example Usage
 *
 * ### Using LTM iFile in iRule
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as f5bigip from "@pulumi/f5bigip";
 *
 * const serverList = new f5bigip.sys.Ifile("server_list", {
 *     name: "server-mapping",
 *     partition: "Production",
 *     content: `web1:10.1.1.10
 * web2:10.1.1.11
 * web3:10.1.1.12
 * `,
 * });
 * const ltmServers = new f5bigip.ltm.Ifile("ltm_servers", {
 *     name: "ltm-server-mapping",
 *     partition: "Production",
 *     fileName: "/Production/server-mapping",
 * });
 * const serverSelector = new f5bigip.ltm.IRule("server_selector", {
 *     name: "select-server-rule",
 *     irule: `when HTTP_REQUEST {
 *   set server_map [ifile get ltm-server-mapping]
 *   # Process server mapping logic
 *   foreach line [split server_map \\"\\
 * \\"] {
 *     set parts [split line \\":\\"]
 *     # Implement server selection logic
 *   }
 * }
 * `,
 * });
 * ```
 *
 * ## Notes
 *
 * * The referenced system iFile (specified in `fileName`) must exist before creating the LTM iFile.
 * * LTM iFiles are primarily used in iRules and LTM policies for traffic processing.
 * * Changes to `name`, `partition`, or `subPath` will force recreation of the resource.
 * * The LTM iFile acts as a reference to the system iFile and doesn't store content directly.
 * * Use `f5bigip.sys.Ifile` to upload file content, then reference it with `f5bigip.ltm.Ifile` for LTM usage.
 *
 * ## Related Resources
 *
 * * `f5bigip.sys.Ifile` - Creates system iFiles with content
 * * `f5bigip.ltm.IRule` - Creates iRules that can reference LTM iFiles
 * * `f5bigip.ltm.Policy` - Creates LTM policies that can use LTM iFiles
 *
 * ## Import
 *
 * LTM iFiles can be imported using their full path:
 *
 * ```sh
 * $ pulumi import f5bigip:ltm/ifile:Ifile example /Common/my-ltm-ifile
 * ```
 *
 * For iFiles with sub-paths:
 *
 * ```sh
 * $ pulumi import f5bigip:ltm/ifile:Ifile example /Common/templates/my-ltm-ifile
 * ```
 */
export declare class Ifile extends pulumi.CustomResource {
    /**
     * Get an existing Ifile 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?: IfileState, opts?: pulumi.CustomResourceOptions): Ifile;
    /**
     * Returns true if the given object is an instance of Ifile.  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 Ifile;
    /**
     * The system iFile name to reference (e.g., `/Common/my-sys-ifile`). This should reference an existing system iFile created with `f5bigip.sys.Ifile`.
     */
    readonly fileName: pulumi.Output<string>;
    /**
     * The complete path of the LTM iFile on the BIG-IP system.
     */
    readonly fullPath: pulumi.Output<string>;
    /**
     * Name of the LTM iFile to be created on BIG-IP.
     */
    readonly name: pulumi.Output<string>;
    /**
     * Partition where the LTM iFile will be created. Defaults to `Common`.
     */
    readonly partition: pulumi.Output<string | undefined>;
    /**
     * Subdirectory within the partition for organizing iFiles.
     */
    readonly subPath: pulumi.Output<string | undefined>;
    /**
     * Create a Ifile 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: IfileArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Ifile resources.
 */
export interface IfileState {
    /**
     * The system iFile name to reference (e.g., `/Common/my-sys-ifile`). This should reference an existing system iFile created with `f5bigip.sys.Ifile`.
     */
    fileName?: pulumi.Input<string | undefined>;
    /**
     * The complete path of the LTM iFile on the BIG-IP system.
     */
    fullPath?: pulumi.Input<string | undefined>;
    /**
     * Name of the LTM iFile to be created on BIG-IP.
     */
    name?: pulumi.Input<string | undefined>;
    /**
     * Partition where the LTM iFile will be created. Defaults to `Common`.
     */
    partition?: pulumi.Input<string | undefined>;
    /**
     * Subdirectory within the partition for organizing iFiles.
     */
    subPath?: pulumi.Input<string | undefined>;
}
/**
 * The set of arguments for constructing a Ifile resource.
 */
export interface IfileArgs {
    /**
     * The system iFile name to reference (e.g., `/Common/my-sys-ifile`). This should reference an existing system iFile created with `f5bigip.sys.Ifile`.
     */
    fileName: pulumi.Input<string>;
    /**
     * Name of the LTM iFile to be created on BIG-IP.
     */
    name: pulumi.Input<string>;
    /**
     * Partition where the LTM iFile will be created. Defaults to `Common`.
     */
    partition?: pulumi.Input<string | undefined>;
    /**
     * Subdirectory within the partition for organizing iFiles.
     */
    subPath?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=ifile.d.ts.map