@pulumi/f5bigip
Version:
A Pulumi package for creating and managing F5 BigIP resources.
218 lines • 8.18 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* ## # f5bigip.GtmMonitorTcp Resource
*
* Provides a BIG-IP GTM (Global Traffic Manager) TCP Monitor resource. This resource allows you to configure and manage GTM TCP health monitors on a BIG-IP system.
*
* ## Description
*
* A GTM TCP monitor verifies the health of TCP-based services by establishing a connection to the target. It can optionally send a text string and evaluate the response for more specific health checks.
*
* ## Example Usage
*
* ### Basic TCP Monitor
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as f5bigip from "@pulumi/f5bigip";
*
* const example = new f5bigip.GtmMonitorTcp("example", {name: "/Common/my_tcp_monitor"});
* ```
*
* ### TCP Monitor with Send/Receive Strings
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as f5bigip from "@pulumi/f5bigip";
*
* const advanced = new f5bigip.GtmMonitorTcp("advanced", {
* name: "/Common/my_tcp_monitor",
* defaultsFrom: "/Common/tcp",
* destination: "*:3306",
* interval: 10,
* timeout: 60,
* probeTimeout: 3,
* ignoreDownResponse: "disabled",
* transparent: "disabled",
* reverse: "disabled",
* send: "ping",
* receive: "pong",
* });
* ```
*
* ## Import
*
* GTM TCP Monitor resources can be imported using the full path name:
*
* ```sh
* $ pulumi import f5bigip:index/gtmMonitorTcp:GtmMonitorTcp example /Common/my_tcp_monitor
* ```
*/
export declare class GtmMonitorTcp extends pulumi.CustomResource {
/**
* Get an existing GtmMonitorTcp 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?: GtmMonitorTcpState, opts?: pulumi.CustomResourceOptions): GtmMonitorTcp;
/**
* Returns true if the given object is an instance of GtmMonitorTcp. 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 GtmMonitorTcp;
/**
* Inherit properties from this monitor
*/
readonly defaultsFrom: pulumi.Output<string | undefined>;
/**
* Specifies the IP address and service port of the resource that is the destination of this monitor. Format: ip:port. Default is "*:*"
*/
readonly destination: pulumi.Output<string | undefined>;
/**
* Specifies whether the monitor ignores a down response from the system it is monitoring
*/
readonly ignoreDownResponse: pulumi.Output<string | undefined>;
/**
* Specifies, in seconds, the frequency at which the system issues the monitor check
*/
readonly interval: pulumi.Output<number | undefined>;
/**
* Name of the GTM TCP monitor
*/
readonly name: pulumi.Output<string>;
/**
* Specifies the number of seconds after which the BIG-IP system times out the probe request to the BIG-IP system
*/
readonly probeTimeout: pulumi.Output<number | undefined>;
/**
* Specifies the text string that the monitor looks for in the returned resource
*/
readonly receive: pulumi.Output<string | undefined>;
/**
* Instructs the system to mark the target resource down when the test is successful
*/
readonly reverse: pulumi.Output<string | undefined>;
/**
* Specifies the text string that the monitor sends to the target object
*/
readonly send: pulumi.Output<string | undefined>;
/**
* Specifies the number of seconds the target has in which to respond to the monitor request
*/
readonly timeout: pulumi.Output<number | undefined>;
/**
* Specifies whether the monitor operates in transparent mode
*/
readonly transparent: pulumi.Output<string | undefined>;
/**
* Create a GtmMonitorTcp 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: GtmMonitorTcpArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering GtmMonitorTcp resources.
*/
export interface GtmMonitorTcpState {
/**
* Inherit properties from this monitor
*/
defaultsFrom?: pulumi.Input<string | undefined>;
/**
* Specifies the IP address and service port of the resource that is the destination of this monitor. Format: ip:port. Default is "*:*"
*/
destination?: pulumi.Input<string | undefined>;
/**
* Specifies whether the monitor ignores a down response from the system it is monitoring
*/
ignoreDownResponse?: pulumi.Input<string | undefined>;
/**
* Specifies, in seconds, the frequency at which the system issues the monitor check
*/
interval?: pulumi.Input<number | undefined>;
/**
* Name of the GTM TCP monitor
*/
name?: pulumi.Input<string | undefined>;
/**
* Specifies the number of seconds after which the BIG-IP system times out the probe request to the BIG-IP system
*/
probeTimeout?: pulumi.Input<number | undefined>;
/**
* Specifies the text string that the monitor looks for in the returned resource
*/
receive?: pulumi.Input<string | undefined>;
/**
* Instructs the system to mark the target resource down when the test is successful
*/
reverse?: pulumi.Input<string | undefined>;
/**
* Specifies the text string that the monitor sends to the target object
*/
send?: pulumi.Input<string | undefined>;
/**
* Specifies the number of seconds the target has in which to respond to the monitor request
*/
timeout?: pulumi.Input<number | undefined>;
/**
* Specifies whether the monitor operates in transparent mode
*/
transparent?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a GtmMonitorTcp resource.
*/
export interface GtmMonitorTcpArgs {
/**
* Inherit properties from this monitor
*/
defaultsFrom?: pulumi.Input<string | undefined>;
/**
* Specifies the IP address and service port of the resource that is the destination of this monitor. Format: ip:port. Default is "*:*"
*/
destination?: pulumi.Input<string | undefined>;
/**
* Specifies whether the monitor ignores a down response from the system it is monitoring
*/
ignoreDownResponse?: pulumi.Input<string | undefined>;
/**
* Specifies, in seconds, the frequency at which the system issues the monitor check
*/
interval?: pulumi.Input<number | undefined>;
/**
* Name of the GTM TCP monitor
*/
name: pulumi.Input<string>;
/**
* Specifies the number of seconds after which the BIG-IP system times out the probe request to the BIG-IP system
*/
probeTimeout?: pulumi.Input<number | undefined>;
/**
* Specifies the text string that the monitor looks for in the returned resource
*/
receive?: pulumi.Input<string | undefined>;
/**
* Instructs the system to mark the target resource down when the test is successful
*/
reverse?: pulumi.Input<string | undefined>;
/**
* Specifies the text string that the monitor sends to the target object
*/
send?: pulumi.Input<string | undefined>;
/**
* Specifies the number of seconds the target has in which to respond to the monitor request
*/
timeout?: pulumi.Input<number | undefined>;
/**
* Specifies whether the monitor operates in transparent mode
*/
transparent?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=gtmMonitorTcp.d.ts.map