@pulumi/f5bigip
Version:
A Pulumi package for creating and managing F5 BigIP resources.
215 lines (214 loc) • 7.9 kB
TypeScript
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 dstaddr = new f5bigip.ltm.PersistenceProfileDstAddr("dstaddr", {
* name: "/Common/terraform_ppdstaddr",
* defaultsFrom: "/Common/dest_addr",
* matchAcrossPools: "enabled",
* matchAcrossServices: "enabled",
* matchAcrossVirtuals: "enabled",
* mirror: "enabled",
* timeout: 3600,
* overrideConnLimit: "enabled",
* hashAlgorithm: "carp",
* mask: "255.255.255.255",
* });
* ```
*
* ## Reference
*
* `name` - (Required) Name of the virtual address
*
* `defaultsFrom` - (Optional) Specifies the existing profile from which the system imports settings for the new 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
*
* `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.
*
* ## Importing
*
* An dest-addr 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_dstaddr.dstaddr "/Common/terraform_ppdstaddr"
* ```
*/
export declare class PersistenceProfileDstAddr extends pulumi.CustomResource {
/**
* Get an existing PersistenceProfileDstAddr 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?: PersistenceProfileDstAddrState, opts?: pulumi.CustomResourceOptions): PersistenceProfileDstAddr;
/**
* Returns true if the given object is an instance of PersistenceProfileDstAddr. 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 PersistenceProfileDstAddr;
readonly appService: pulumi.Output<string>;
/**
* Inherit defaults from parent profile
*/
readonly defaultsFrom: pulumi.Output<string>;
/**
* Specify the hash algorithm
*/
readonly hashAlgorithm: pulumi.Output<string>;
/**
* Identify a range of source IP addresses to manage together as a single source address affinity persistent connection
* when connecting to the pool. Must be a valid IPv4 or IPv6 mask.
*/
readonly mask: 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 services with given persistence record
*/
readonly matchAcrossVirtuals: 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 PersistenceProfileDstAddr 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: PersistenceProfileDstAddrArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering PersistenceProfileDstAddr resources.
*/
export interface PersistenceProfileDstAddrState {
appService?: pulumi.Input<string>;
/**
* Inherit defaults from parent profile
*/
defaultsFrom?: pulumi.Input<string>;
/**
* Specify the hash algorithm
*/
hashAlgorithm?: pulumi.Input<string>;
/**
* Identify a range of source IP addresses to manage together as a single source address affinity persistent connection
* when connecting to the pool. Must be a valid IPv4 or IPv6 mask.
*/
mask?: 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 services with given persistence record
*/
matchAcrossVirtuals?: 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 PersistenceProfileDstAddr resource.
*/
export interface PersistenceProfileDstAddrArgs {
appService?: pulumi.Input<string>;
/**
* Inherit defaults from parent profile
*/
defaultsFrom: pulumi.Input<string>;
/**
* Specify the hash algorithm
*/
hashAlgorithm?: pulumi.Input<string>;
/**
* Identify a range of source IP addresses to manage together as a single source address affinity persistent connection
* when connecting to the pool. Must be a valid IPv4 or IPv6 mask.
*/
mask?: 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 services with given persistence record
*/
matchAcrossVirtuals?: 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>;
}