@pulumi/f5bigip/gtmMonitorHttps.d.ts

A Pulumi package for creating and managing F5 BigIP resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * ## # f5bigip.GtmMonitorHttps Resource
 *
 * Provides a BIG-IP GTM (Global Traffic Manager) HTTPS Monitor resource. This resource allows you to configure and manage GTM HTTPS health monitors on a BIG-IP system.
 *
 * ## Description
 *
 * A GTM HTTPS monitor verifies the HTTPS service by attempting to receive specific content from a web page protected by Secure Socket Layer (SSL) security. HTTPS monitors support client certificate authentication and configurable cipher lists.
 *
 * ## Example Usage
 *
 * ### Basic HTTPS Monitor
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as f5bigip from "@pulumi/f5bigip";
 *
 * const example = new f5bigip.GtmMonitorHttps("example", {name: "/Common/my_https_monitor"});
 * ```
 *
 * ### HTTPS Monitor with Client Certificate
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as f5bigip from "@pulumi/f5bigip";
 *
 * const withCert = new f5bigip.GtmMonitorHttps("with_cert", {
 *     name: "/Common/my_https_monitor",
 *     defaultsFrom: "/Common/https",
 *     destination: "*:443",
 *     interval: 10,
 *     timeout: 60,
 *     probeTimeout: 3,
 *     send: "GET /health\\r\\n",
 *     receive: "200 OK",
 *     cert: "/Common/my_client_cert",
 *     key: "/Common/my_client_key",
 *     compatibility: "enabled",
 * });
 * ```
 *
 * ## Import
 *
 * GTM HTTPS Monitor resources can be imported using the full path name:
 *
 * ```sh
 * $ pulumi import f5bigip:index/gtmMonitorHttps:GtmMonitorHttps example /Common/my_https_monitor
 * ```
 */
export declare class GtmMonitorHttps extends pulumi.CustomResource {
    /**
     * Get an existing GtmMonitorHttps 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?: GtmMonitorHttpsState, opts?: pulumi.CustomResourceOptions): GtmMonitorHttps;
    /**
     * Returns true if the given object is an instance of GtmMonitorHttps.  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 GtmMonitorHttps;
    /**
     * Specifies a fully-qualified path for a client certificate that the monitor sends to the target SSL server
     */
    readonly cert: pulumi.Output<string | undefined>;
    /**
     * Specifies the list of ciphers for this monitor
     */
    readonly cipherlist: pulumi.Output<string | undefined>;
    /**
     * Specifies the SSL version compatibility
     */
    readonly compatibility: pulumi.Output<string | undefined>;
    /**
     * 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>;
    /**
     * Specifies the key for the client certificate that the monitor sends to the target SSL server
     */
    readonly key: pulumi.Output<string | undefined>;
    /**
     * Name of the GTM HTTPS 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 GtmMonitorHttps 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: GtmMonitorHttpsArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering GtmMonitorHttps resources.
 */
export interface GtmMonitorHttpsState {
    /**
     * Specifies a fully-qualified path for a client certificate that the monitor sends to the target SSL server
     */
    cert?: pulumi.Input<string | undefined>;
    /**
     * Specifies the list of ciphers for this monitor
     */
    cipherlist?: pulumi.Input<string | undefined>;
    /**
     * Specifies the SSL version compatibility
     */
    compatibility?: pulumi.Input<string | undefined>;
    /**
     * 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>;
    /**
     * Specifies the key for the client certificate that the monitor sends to the target SSL server
     */
    key?: pulumi.Input<string | undefined>;
    /**
     * Name of the GTM HTTPS 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 GtmMonitorHttps resource.
 */
export interface GtmMonitorHttpsArgs {
    /**
     * Specifies a fully-qualified path for a client certificate that the monitor sends to the target SSL server
     */
    cert?: pulumi.Input<string | undefined>;
    /**
     * Specifies the list of ciphers for this monitor
     */
    cipherlist?: pulumi.Input<string | undefined>;
    /**
     * Specifies the SSL version compatibility
     */
    compatibility?: pulumi.Input<string | undefined>;
    /**
     * 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>;
    /**
     * Specifies the key for the client certificate that the monitor sends to the target SSL server
     */
    key?: pulumi.Input<string | undefined>;
    /**
     * Name of the GTM HTTPS 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=gtmMonitorHttps.d.ts.map