@pulumi/f5bigip
Version:
A Pulumi package for creating and managing F5 BigIP resources.
160 lines • 8.42 kB
JavaScript
;
// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.PersistenceProfileCookie = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* 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"
* ```
*/
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, id, state, opts) {
return new PersistenceProfileCookie(name, state, Object.assign(Object.assign({}, opts), { id: id }));
}
/**
* 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) {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === PersistenceProfileCookie.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["alwaysSend"] = state ? state.alwaysSend : undefined;
resourceInputs["appService"] = state ? state.appService : undefined;
resourceInputs["cookieEncryption"] = state ? state.cookieEncryption : undefined;
resourceInputs["cookieEncryptionPassphrase"] = state ? state.cookieEncryptionPassphrase : undefined;
resourceInputs["cookieName"] = state ? state.cookieName : undefined;
resourceInputs["defaultsFrom"] = state ? state.defaultsFrom : undefined;
resourceInputs["expiration"] = state ? state.expiration : undefined;
resourceInputs["hashLength"] = state ? state.hashLength : undefined;
resourceInputs["hashOffset"] = state ? state.hashOffset : undefined;
resourceInputs["httponly"] = state ? state.httponly : undefined;
resourceInputs["matchAcrossPools"] = state ? state.matchAcrossPools : undefined;
resourceInputs["matchAcrossServices"] = state ? state.matchAcrossServices : undefined;
resourceInputs["matchAcrossVirtuals"] = state ? state.matchAcrossVirtuals : undefined;
resourceInputs["method"] = state ? state.method : undefined;
resourceInputs["mirror"] = state ? state.mirror : undefined;
resourceInputs["name"] = state ? state.name : undefined;
resourceInputs["overrideConnLimit"] = state ? state.overrideConnLimit : undefined;
resourceInputs["timeout"] = state ? state.timeout : undefined;
}
else {
const args = argsOrState;
if ((!args || args.defaultsFrom === undefined) && !opts.urn) {
throw new Error("Missing required property 'defaultsFrom'");
}
if ((!args || args.name === undefined) && !opts.urn) {
throw new Error("Missing required property 'name'");
}
resourceInputs["alwaysSend"] = args ? args.alwaysSend : undefined;
resourceInputs["appService"] = args ? args.appService : undefined;
resourceInputs["cookieEncryption"] = args ? args.cookieEncryption : undefined;
resourceInputs["cookieEncryptionPassphrase"] = args ? args.cookieEncryptionPassphrase : undefined;
resourceInputs["cookieName"] = args ? args.cookieName : undefined;
resourceInputs["defaultsFrom"] = args ? args.defaultsFrom : undefined;
resourceInputs["expiration"] = args ? args.expiration : undefined;
resourceInputs["hashLength"] = args ? args.hashLength : undefined;
resourceInputs["hashOffset"] = args ? args.hashOffset : undefined;
resourceInputs["httponly"] = args ? args.httponly : undefined;
resourceInputs["matchAcrossPools"] = args ? args.matchAcrossPools : undefined;
resourceInputs["matchAcrossServices"] = args ? args.matchAcrossServices : undefined;
resourceInputs["matchAcrossVirtuals"] = args ? args.matchAcrossVirtuals : undefined;
resourceInputs["method"] = args ? args.method : undefined;
resourceInputs["mirror"] = args ? args.mirror : undefined;
resourceInputs["name"] = args ? args.name : undefined;
resourceInputs["overrideConnLimit"] = args ? args.overrideConnLimit : undefined;
resourceInputs["timeout"] = args ? args.timeout : undefined;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(PersistenceProfileCookie.__pulumiType, name, resourceInputs, opts);
}
}
exports.PersistenceProfileCookie = PersistenceProfileCookie;
/** @internal */
PersistenceProfileCookie.__pulumiType = 'f5bigip:ltm/persistenceProfileCookie:PersistenceProfileCookie';
//# sourceMappingURL=persistenceProfileCookie.js.map