@pulumi/f5bigip
Version:
A Pulumi package for creating and managing F5 BigIP resources.
185 lines • 8.79 kB
JavaScript
;
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.PersistenceProfileCookie = void 0;
const pulumi = __importStar(require("@pulumi/pulumi"));
const utilities = __importStar(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,
* }, {
* ignoreChanges: ["cookieEncryptionPassphrase"],
* });
* ```
*
* ## 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, { ...opts, id: id });
}
/** @internal */
static __pulumiType = 'f5bigip:ltm/persistenceProfileCookie: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) {
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?.alwaysSend;
resourceInputs["appService"] = state?.appService;
resourceInputs["cookieEncryption"] = state?.cookieEncryption;
resourceInputs["cookieEncryptionPassphrase"] = state?.cookieEncryptionPassphrase;
resourceInputs["cookieName"] = state?.cookieName;
resourceInputs["defaultsFrom"] = state?.defaultsFrom;
resourceInputs["expiration"] = state?.expiration;
resourceInputs["hashLength"] = state?.hashLength;
resourceInputs["hashOffset"] = state?.hashOffset;
resourceInputs["httponly"] = state?.httponly;
resourceInputs["matchAcrossPools"] = state?.matchAcrossPools;
resourceInputs["matchAcrossServices"] = state?.matchAcrossServices;
resourceInputs["matchAcrossVirtuals"] = state?.matchAcrossVirtuals;
resourceInputs["method"] = state?.method;
resourceInputs["mirror"] = state?.mirror;
resourceInputs["name"] = state?.name;
resourceInputs["overrideConnLimit"] = state?.overrideConnLimit;
resourceInputs["timeout"] = state?.timeout;
}
else {
const args = argsOrState;
if (args?.defaultsFrom === undefined && !opts.urn) {
throw new Error("Missing required property 'defaultsFrom'");
}
if (args?.name === undefined && !opts.urn) {
throw new Error("Missing required property 'name'");
}
resourceInputs["alwaysSend"] = args?.alwaysSend;
resourceInputs["appService"] = args?.appService;
resourceInputs["cookieEncryption"] = args?.cookieEncryption;
resourceInputs["cookieEncryptionPassphrase"] = args?.cookieEncryptionPassphrase;
resourceInputs["cookieName"] = args?.cookieName;
resourceInputs["defaultsFrom"] = args?.defaultsFrom;
resourceInputs["expiration"] = args?.expiration;
resourceInputs["hashLength"] = args?.hashLength;
resourceInputs["hashOffset"] = args?.hashOffset;
resourceInputs["httponly"] = args?.httponly;
resourceInputs["matchAcrossPools"] = args?.matchAcrossPools;
resourceInputs["matchAcrossServices"] = args?.matchAcrossServices;
resourceInputs["matchAcrossVirtuals"] = args?.matchAcrossVirtuals;
resourceInputs["method"] = args?.method;
resourceInputs["mirror"] = args?.mirror;
resourceInputs["name"] = args?.name;
resourceInputs["overrideConnLimit"] = args?.overrideConnLimit;
resourceInputs["timeout"] = args?.timeout;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(PersistenceProfileCookie.__pulumiType, name, resourceInputs, opts);
}
}
exports.PersistenceProfileCookie = PersistenceProfileCookie;
//# sourceMappingURL=persistenceProfileCookie.js.map