UNPKG

@pulumi/f5bigip

Version:

A Pulumi package for creating and managing F5 BigIP resources.

318 lines (317 loc) • 11.1 kB
import * as pulumi from "@pulumi/pulumi"; /** * Configures a cookie persistence profile * * ## Example * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as f5bigip from "@pulumi/f5bigip"; * * const testPpcookie = new f5bigip.ltm.PersistenceProfileCookie("test_ppcookie", { * name: "/Common/terraform_cookie", * defaultsFrom: "/Common/cookie", * matchAcrossPools: "enabled", * matchAcrossServices: "enabled", * matchAcrossVirtuals: "enabled", * timeout: 3600, * overrideConnLimit: "enabled", * alwaysSend: "enabled", * cookieEncryption: "required", * cookieEncryptionPassphrase: "iam", * cookieName: "ham", * expiration: "1:0:0", * hashLength: 0, * }); * ``` * * ## Reference * * `name` - (Required) Name of the virtual address * * `defaultsFrom` - (Required) Parent cookie persistence profile * * `matchAcrossPools` (Optional) (enabled or disabled) match across pools with given persistence record * * `matchAcrossServices` (Optional) (enabled or disabled) match across services with given persistence record * * `matchAcrossVirtuals` (Optional) (enabled or disabled) match across virtual servers with given persistence record * * `method` (Optional) Specifies the type of cookie processing that the system uses. The default value is insert * * `mirror` (Optional) (enabled or disabled) mirror persistence record * * `timeout` (Optional) (enabled or disabled) Timeout for persistence of the session in seconds * * `overrideConnLimit` (Optional) (enabled or disabled) Enable or dissable pool member connection limits are overridden for persisted clients. Per-virtual connection limits remain hard limits and are not overridden. * * `alwaysSend` (Optional) (enabled or disabled) always send cookies * * `cookieEncryption` (Optional) (required, preferred, or disabled) To required, preferred, or disabled policy for cookie encryption * * `cookieEncryptionPassphrase` (Optional) (required, preferred, or disabled) Passphrase for encrypted cookies. The field is encrypted on the server and will always return differently then set. * If this is configured specify `ignoreChanges` under the `lifecycle` block to ignore returned encrypted value. * * `cookieName` (Optional) Name of the cookie to track persistence * * `expiration` (Optional) Expiration TTL for cookie specified in DAY:HOUR:MIN:SECONDS (Examples: 1:0:0:0 one day, 1:0:0 one hour, 30:0 thirty minutes) * * `hashLength` (Optional) (Integer) Length of hash to apply to cookie * * `hashOffset` (Optional) (Integer) Number of characters to skip in the cookie for the hash * * `httponly` (Optional) (enabled or disabled) Sending only over http * * ## Importing * * An cookie persistence profile can be imported into this resource by supplying the Name in `full path` as `id`. * An example is below: * ```sh * $ terraform import bigip_ltm_persistence_profile_cookie.test_ppcookie "/Common/terraform_cookie" * ``` */ export declare class PersistenceProfileCookie extends pulumi.CustomResource { /** * Get an existing PersistenceProfileCookie 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?: PersistenceProfileCookieState, opts?: pulumi.CustomResourceOptions): PersistenceProfileCookie; /** * Returns true if the given object is an instance of PersistenceProfileCookie. 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 PersistenceProfileCookie; /** * To enable _ disable always sending cookies */ readonly alwaysSend: pulumi.Output<string>; readonly appService: pulumi.Output<string>; /** * To required, preferred, or disabled policy for cookie encryption */ readonly cookieEncryption: pulumi.Output<string>; /** * Passphrase for encrypted cookies */ readonly cookieEncryptionPassphrase: pulumi.Output<string>; /** * Name of the cookie to track persistence */ readonly cookieName: pulumi.Output<string>; /** * Inherit defaults from parent profile */ readonly defaultsFrom: pulumi.Output<string>; /** * Expiration TTL for cookie specified in D:H:M:S or in seconds */ readonly expiration: pulumi.Output<string>; /** * Length of hash to apply to cookie */ readonly hashLength: pulumi.Output<number>; /** * Number of characters to skip in the cookie for the hash */ readonly hashOffset: pulumi.Output<number>; /** * To enable _ disable sending only over http */ readonly httponly: pulumi.Output<string>; /** * To enable _ disable match across pools with given persistence record */ readonly matchAcrossPools: pulumi.Output<string>; /** * To enable _ disable match across services with given persistence record */ readonly matchAcrossServices: pulumi.Output<string>; /** * To enable _ disable match across virtual servers with given persistence record */ readonly matchAcrossVirtuals: pulumi.Output<string>; /** * Specifies the type of cookie processing that the system uses */ readonly method: pulumi.Output<string>; /** * To enable _ disable */ readonly mirror: pulumi.Output<string>; /** * Name of the persistence profile */ readonly name: pulumi.Output<string>; /** * To enable _ disable that pool member connection limits are overridden for persisted clients. Per-virtual connection * limits remain hard limits and are not overridden. */ readonly overrideConnLimit: pulumi.Output<string>; /** * Timeout for persistence of the session */ readonly timeout: pulumi.Output<number>; /** * Create a PersistenceProfileCookie 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: PersistenceProfileCookieArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering PersistenceProfileCookie resources. */ export interface PersistenceProfileCookieState { /** * To enable _ disable always sending cookies */ alwaysSend?: pulumi.Input<string>; appService?: pulumi.Input<string>; /** * To required, preferred, or disabled policy for cookie encryption */ cookieEncryption?: pulumi.Input<string>; /** * Passphrase for encrypted cookies */ cookieEncryptionPassphrase?: pulumi.Input<string>; /** * Name of the cookie to track persistence */ cookieName?: pulumi.Input<string>; /** * Inherit defaults from parent profile */ defaultsFrom?: pulumi.Input<string>; /** * Expiration TTL for cookie specified in D:H:M:S or in seconds */ expiration?: pulumi.Input<string>; /** * Length of hash to apply to cookie */ hashLength?: pulumi.Input<number>; /** * Number of characters to skip in the cookie for the hash */ hashOffset?: pulumi.Input<number>; /** * To enable _ disable sending only over http */ httponly?: pulumi.Input<string>; /** * To enable _ disable match across pools with given persistence record */ matchAcrossPools?: pulumi.Input<string>; /** * To enable _ disable match across services with given persistence record */ matchAcrossServices?: pulumi.Input<string>; /** * To enable _ disable match across virtual servers with given persistence record */ matchAcrossVirtuals?: pulumi.Input<string>; /** * Specifies the type of cookie processing that the system uses */ method?: pulumi.Input<string>; /** * To enable _ disable */ mirror?: pulumi.Input<string>; /** * Name of the persistence profile */ name?: pulumi.Input<string>; /** * To enable _ disable that pool member connection limits are overridden for persisted clients. Per-virtual connection * limits remain hard limits and are not overridden. */ overrideConnLimit?: pulumi.Input<string>; /** * Timeout for persistence of the session */ timeout?: pulumi.Input<number>; } /** * The set of arguments for constructing a PersistenceProfileCookie resource. */ export interface PersistenceProfileCookieArgs { /** * To enable _ disable always sending cookies */ alwaysSend?: pulumi.Input<string>; appService?: pulumi.Input<string>; /** * To required, preferred, or disabled policy for cookie encryption */ cookieEncryption?: pulumi.Input<string>; /** * Passphrase for encrypted cookies */ cookieEncryptionPassphrase?: pulumi.Input<string>; /** * Name of the cookie to track persistence */ cookieName?: pulumi.Input<string>; /** * Inherit defaults from parent profile */ defaultsFrom: pulumi.Input<string>; /** * Expiration TTL for cookie specified in D:H:M:S or in seconds */ expiration?: pulumi.Input<string>; /** * Length of hash to apply to cookie */ hashLength?: pulumi.Input<number>; /** * Number of characters to skip in the cookie for the hash */ hashOffset?: pulumi.Input<number>; /** * To enable _ disable sending only over http */ httponly?: pulumi.Input<string>; /** * To enable _ disable match across pools with given persistence record */ matchAcrossPools?: pulumi.Input<string>; /** * To enable _ disable match across services with given persistence record */ matchAcrossServices?: pulumi.Input<string>; /** * To enable _ disable match across virtual servers with given persistence record */ matchAcrossVirtuals?: pulumi.Input<string>; /** * Specifies the type of cookie processing that the system uses */ method?: pulumi.Input<string>; /** * To enable _ disable */ mirror?: pulumi.Input<string>; /** * Name of the persistence profile */ name: pulumi.Input<string>; /** * To enable _ disable that pool member connection limits are overridden for persisted clients. Per-virtual connection * limits remain hard limits and are not overridden. */ overrideConnLimit?: pulumi.Input<string>; /** * Timeout for persistence of the session */ timeout?: pulumi.Input<number>; }