@pulumi/f5bigip
Version:
A Pulumi package for creating and managing F5 BigIP resources.
227 lines (226 loc) • 8.99 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* `f5bigip.FastTcpApp` This resource will create and manage FAST TCP applications on BIG-IP from provided JSON declaration.
*/
export declare class FastTcpApp extends pulumi.CustomResource {
/**
* Get an existing FastTcpApp 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?: FastTcpAppState, opts?: pulumi.CustomResourceOptions): FastTcpApp;
/**
* Returns true if the given object is an instance of FastTcpApp. 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 FastTcpApp;
/**
* Name of the FAST TCP application.
*/
readonly application: pulumi.Output<string>;
/**
* Name of an existing BIG-IP HTTPS pool monitor. Monitors are used to determine the health of the application on each server.
*/
readonly existingMonitor: pulumi.Output<string | undefined>;
/**
* Name of an existing BIG-IP pool.
*/
readonly existingPool: pulumi.Output<string | undefined>;
/**
* Name of an existing BIG-IP SNAT pool.
*/
readonly existingSnatPool: pulumi.Output<string | undefined>;
/**
* Type of fallback persistence record to be created for each new client connection.
*/
readonly fallbackPersistence: pulumi.Output<string | undefined>;
/**
* Json payload for FAST TCP application.
*/
readonly fastTcpJson: pulumi.Output<string>;
/**
* A `load balancing method` is an algorithm that the BIG-IP system uses to select a pool member for processing a request. F5 recommends the Least Connections load balancing method
*/
readonly loadBalancingMode: pulumi.Output<string | undefined>;
/**
* `monitor` block takes input for FAST-Generated Pool Monitor.
* See Pool Monitor below for more details.
*/
readonly monitor: pulumi.Output<outputs.FastTcpAppMonitor | undefined>;
/**
* Name of an existing BIG-IP persistence profile to be used.
*/
readonly persistenceProfile: pulumi.Output<string | undefined>;
/**
* Type of persistence profile to be created. Using this option will enable use of FAST generated persistence profiles.
*/
readonly persistenceType: pulumi.Output<string | undefined>;
/**
* `poolMembers` block takes input for FAST-Generated Pool.
* See Pool Members below for more details.
*/
readonly poolMembers: pulumi.Output<outputs.FastTcpAppPoolMember[] | undefined>;
/**
* Slow ramp temporarily throttles the number of connections to a new pool member. The recommended value is 300 seconds
*/
readonly slowRampTime: pulumi.Output<number | undefined>;
/**
* List of address to be used for FAST-Generated SNAT Pool.
*/
readonly snatPoolAddresses: pulumi.Output<string[] | undefined>;
/**
* Name of the FAST TCP application tenant.
*/
readonly tenant: pulumi.Output<string>;
/**
* `virtualServer` block will provide `ip` and `port` options to be used for virtual server.
* See virtual server below for more details.
*/
readonly virtualServer: pulumi.Output<outputs.FastTcpAppVirtualServer | undefined>;
/**
* Create a FastTcpApp 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: FastTcpAppArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering FastTcpApp resources.
*/
export interface FastTcpAppState {
/**
* Name of the FAST TCP application.
*/
application?: pulumi.Input<string>;
/**
* Name of an existing BIG-IP HTTPS pool monitor. Monitors are used to determine the health of the application on each server.
*/
existingMonitor?: pulumi.Input<string>;
/**
* Name of an existing BIG-IP pool.
*/
existingPool?: pulumi.Input<string>;
/**
* Name of an existing BIG-IP SNAT pool.
*/
existingSnatPool?: pulumi.Input<string>;
/**
* Type of fallback persistence record to be created for each new client connection.
*/
fallbackPersistence?: pulumi.Input<string>;
/**
* Json payload for FAST TCP application.
*/
fastTcpJson?: pulumi.Input<string>;
/**
* A `load balancing method` is an algorithm that the BIG-IP system uses to select a pool member for processing a request. F5 recommends the Least Connections load balancing method
*/
loadBalancingMode?: pulumi.Input<string>;
/**
* `monitor` block takes input for FAST-Generated Pool Monitor.
* See Pool Monitor below for more details.
*/
monitor?: pulumi.Input<inputs.FastTcpAppMonitor>;
/**
* Name of an existing BIG-IP persistence profile to be used.
*/
persistenceProfile?: pulumi.Input<string>;
/**
* Type of persistence profile to be created. Using this option will enable use of FAST generated persistence profiles.
*/
persistenceType?: pulumi.Input<string>;
/**
* `poolMembers` block takes input for FAST-Generated Pool.
* See Pool Members below for more details.
*/
poolMembers?: pulumi.Input<pulumi.Input<inputs.FastTcpAppPoolMember>[]>;
/**
* Slow ramp temporarily throttles the number of connections to a new pool member. The recommended value is 300 seconds
*/
slowRampTime?: pulumi.Input<number>;
/**
* List of address to be used for FAST-Generated SNAT Pool.
*/
snatPoolAddresses?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Name of the FAST TCP application tenant.
*/
tenant?: pulumi.Input<string>;
/**
* `virtualServer` block will provide `ip` and `port` options to be used for virtual server.
* See virtual server below for more details.
*/
virtualServer?: pulumi.Input<inputs.FastTcpAppVirtualServer>;
}
/**
* The set of arguments for constructing a FastTcpApp resource.
*/
export interface FastTcpAppArgs {
/**
* Name of the FAST TCP application.
*/
application: pulumi.Input<string>;
/**
* Name of an existing BIG-IP HTTPS pool monitor. Monitors are used to determine the health of the application on each server.
*/
existingMonitor?: pulumi.Input<string>;
/**
* Name of an existing BIG-IP pool.
*/
existingPool?: pulumi.Input<string>;
/**
* Name of an existing BIG-IP SNAT pool.
*/
existingSnatPool?: pulumi.Input<string>;
/**
* Type of fallback persistence record to be created for each new client connection.
*/
fallbackPersistence?: pulumi.Input<string>;
/**
* A `load balancing method` is an algorithm that the BIG-IP system uses to select a pool member for processing a request. F5 recommends the Least Connections load balancing method
*/
loadBalancingMode?: pulumi.Input<string>;
/**
* `monitor` block takes input for FAST-Generated Pool Monitor.
* See Pool Monitor below for more details.
*/
monitor?: pulumi.Input<inputs.FastTcpAppMonitor>;
/**
* Name of an existing BIG-IP persistence profile to be used.
*/
persistenceProfile?: pulumi.Input<string>;
/**
* Type of persistence profile to be created. Using this option will enable use of FAST generated persistence profiles.
*/
persistenceType?: pulumi.Input<string>;
/**
* `poolMembers` block takes input for FAST-Generated Pool.
* See Pool Members below for more details.
*/
poolMembers?: pulumi.Input<pulumi.Input<inputs.FastTcpAppPoolMember>[]>;
/**
* Slow ramp temporarily throttles the number of connections to a new pool member. The recommended value is 300 seconds
*/
slowRampTime?: pulumi.Input<number>;
/**
* List of address to be used for FAST-Generated SNAT Pool.
*/
snatPoolAddresses?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Name of the FAST TCP application tenant.
*/
tenant: pulumi.Input<string>;
/**
* `virtualServer` block will provide `ip` and `port` options to be used for virtual server.
* See virtual server below for more details.
*/
virtualServer?: pulumi.Input<inputs.FastTcpAppVirtualServer>;
}