Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Incapsula Provider
  3. API Docs
  4. SiteMonitoring
incapsula 3.32.1 published on Monday, Apr 14, 2025 by imperva
imperva/terraform-provider-incapsula

incapsula.SiteMonitoring

Explore with Pulumi AI

incapsula logo
incapsula 3.32.1 published on Monday, Apr 14, 2025 by imperva
imperva/terraform-provider-incapsula

    Configure settings to determine when origin servers should be considered “up” or “down” (active or inactive) by the Imperva Load Balancer. Select which failure scenarios you want to produce alarm messages, and how to send them.

    Note that destroy action doesn’t do any change in Imperva system. To return to default values, delete all resource fields but site_id and execute pulumi up

    Example Usage

    Basic Usage - Site Monitoring

    import * as pulumi from "@pulumi/pulumi";
import * as incapsula from "@pulumi/incapsula";

const exampleSiteMonitoring = new incapsula.SiteMonitoring("exampleSiteMonitoring", {
    alarmOnDcFailover: true,
    alarmOnServerFailover: true,
    alarmOnStandsByFailover: true,
    expectedReceivedString: "some string",
    failedRequestsDuration: 1,
    failedRequestsDurationUnits: "MINUTES",
    failedRequestsMinNumber: 2,
    failedRequestsPercentage: 30,
    httpRequestTimeout: 50,
    httpRequestTimeoutUnits: "SECONDS",
    httpResponseError: "501-599",
    monitoringUrl: "/users",
    requiredMonitors: "ALL",
    siteId: 1234,
    upCheckRetries: 10,
    upChecksInterval: 15,
    upChecksIntervalUnits: "SECONDS",
    useVerificationForDown: false,
});

    import pulumi
import pulumi_incapsula as incapsula

example_site_monitoring = incapsula.SiteMonitoring("exampleSiteMonitoring",
    alarm_on_dc_failover=True,
    alarm_on_server_failover=True,
    alarm_on_stands_by_failover=True,
    expected_received_string="some string",
    failed_requests_duration=1,
    failed_requests_duration_units="MINUTES",
    failed_requests_min_number=2,
    failed_requests_percentage=30,
    http_request_timeout=50,
    http_request_timeout_units="SECONDS",
    http_response_error="501-599",
    monitoring_url="/users",
    required_monitors="ALL",
    site_id=1234,
    up_check_retries=10,
    up_checks_interval=15,
    up_checks_interval_units="SECONDS",
    use_verification_for_down=False)

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/incapsula/v3/incapsula"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := incapsula.NewSiteMonitoring(ctx, "exampleSiteMonitoring", &incapsula.SiteMonitoringArgs{
			AlarmOnDcFailover:           pulumi.Bool(true),
			AlarmOnServerFailover:       pulumi.Bool(true),
			AlarmOnStandsByFailover:     pulumi.Bool(true),
			ExpectedReceivedString:      pulumi.String("some string"),
			FailedRequestsDuration:      pulumi.Float64(1),
			FailedRequestsDurationUnits: pulumi.String("MINUTES"),
			FailedRequestsMinNumber:     pulumi.Float64(2),
			FailedRequestsPercentage:    pulumi.Float64(30),
			HttpRequestTimeout:          pulumi.Float64(50),
			HttpRequestTimeoutUnits:     pulumi.String("SECONDS"),
			HttpResponseError:           pulumi.String("501-599"),
			MonitoringUrl:               pulumi.String("/users"),
			RequiredMonitors:            pulumi.String("ALL"),
			SiteId:                      pulumi.Float64(1234),
			UpCheckRetries:              pulumi.Float64(10),
			UpChecksInterval:            pulumi.Float64(15),
			UpChecksIntervalUnits:       pulumi.String("SECONDS"),
			UseVerificationForDown:      pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Incapsula = Pulumi.Incapsula;

return await Deployment.RunAsync(() => 
{
    var exampleSiteMonitoring = new Incapsula.SiteMonitoring("exampleSiteMonitoring", new()
    {
        AlarmOnDcFailover = true,
        AlarmOnServerFailover = true,
        AlarmOnStandsByFailover = true,
        ExpectedReceivedString = "some string",
        FailedRequestsDuration = 1,
        FailedRequestsDurationUnits = "MINUTES",
        FailedRequestsMinNumber = 2,
        FailedRequestsPercentage = 30,
        HttpRequestTimeout = 50,
        HttpRequestTimeoutUnits = "SECONDS",
        HttpResponseError = "501-599",
        MonitoringUrl = "/users",
        RequiredMonitors = "ALL",
        SiteId = 1234,
        UpCheckRetries = 10,
        UpChecksInterval = 15,
        UpChecksIntervalUnits = "SECONDS",
        UseVerificationForDown = false,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.incapsula.SiteMonitoring;
import com.pulumi.incapsula.SiteMonitoringArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var exampleSiteMonitoring = new SiteMonitoring("exampleSiteMonitoring", SiteMonitoringArgs.builder()
            .alarmOnDcFailover(true)
            .alarmOnServerFailover(true)
            .alarmOnStandsByFailover(true)
            .expectedReceivedString("some string")
            .failedRequestsDuration(1)
            .failedRequestsDurationUnits("MINUTES")
            .failedRequestsMinNumber(2)
            .failedRequestsPercentage(30)
            .httpRequestTimeout(50)
            .httpRequestTimeoutUnits("SECONDS")
            .httpResponseError("501-599")
            .monitoringUrl("/users")
            .requiredMonitors("ALL")
            .siteId(1234)
            .upCheckRetries(10)
            .upChecksInterval(15)
            .upChecksIntervalUnits("SECONDS")
            .useVerificationForDown(false)
            .build());

    }
}

    resources:
  exampleSiteMonitoring:
    type: incapsula:SiteMonitoring
    properties:
      alarmOnDcFailover: true
      alarmOnServerFailover: true
      alarmOnStandsByFailover: true
      expectedReceivedString: some string
      failedRequestsDuration: 1
      failedRequestsDurationUnits: MINUTES
      failedRequestsMinNumber: 2
      failedRequestsPercentage: 30
      httpRequestTimeout: 50
      httpRequestTimeoutUnits: SECONDS
      httpResponseError: 501-599
      monitoringUrl: /users
      requiredMonitors: ALL
      siteId: 1234
      upCheckRetries: 10
      upChecksInterval: 15
      upChecksIntervalUnits: SECONDS
      useVerificationForDown: false

    Create SiteMonitoring Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new SiteMonitoring(name: string, args: SiteMonitoringArgs, opts?: CustomResourceOptions);
    @overload
def SiteMonitoring(resource_name: str,
                   args: SiteMonitoringArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def SiteMonitoring(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   site_id: Optional[float] = None,
                   http_request_timeout: Optional[float] = None,
                   monitoring_url: Optional[str] = None,
                   expected_received_string: Optional[str] = None,
                   failed_requests_duration: Optional[float] = None,
                   failed_requests_duration_units: Optional[str] = None,
                   failed_requests_min_number: Optional[float] = None,
                   failed_requests_percentage: Optional[float] = None,
                   alarm_on_dc_failover: Optional[bool] = None,
                   alarm_on_stands_by_failover: Optional[bool] = None,
                   http_request_timeout_units: Optional[str] = None,
                   http_response_error: Optional[str] = None,
                   required_monitors: Optional[str] = None,
                   alarm_on_server_failover: Optional[bool] = None,
                   site_monitoring_id: Optional[str] = None,
                   up_check_retries: Optional[float] = None,
                   up_checks_interval: Optional[float] = None,
                   up_checks_interval_units: Optional[str] = None,
                   use_verification_for_down: Optional[bool] = None)
    func NewSiteMonitoring(ctx *Context, name string, args SiteMonitoringArgs, opts ...ResourceOption) (*SiteMonitoring, error)
    public SiteMonitoring(string name, SiteMonitoringArgs args, CustomResourceOptions? opts = null)
    public SiteMonitoring(String name, SiteMonitoringArgs args)
public SiteMonitoring(String name, SiteMonitoringArgs args, CustomResourceOptions options)

    type: incapsula:SiteMonitoring
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args SiteMonitoringArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args SiteMonitoringArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args SiteMonitoringArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SiteMonitoringArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SiteMonitoringArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var siteMonitoringResource = new Incapsula.SiteMonitoring("siteMonitoringResource", new()
{
    SiteId = 0,
    HttpRequestTimeout = 0,
    MonitoringUrl = "string",
    ExpectedReceivedString = "string",
    FailedRequestsDuration = 0,
    FailedRequestsDurationUnits = "string",
    FailedRequestsMinNumber = 0,
    FailedRequestsPercentage = 0,
    AlarmOnDcFailover = false,
    AlarmOnStandsByFailover = false,
    HttpRequestTimeoutUnits = "string",
    HttpResponseError = "string",
    RequiredMonitors = "string",
    AlarmOnServerFailover = false,
    SiteMonitoringId = "string",
    UpCheckRetries = 0,
    UpChecksInterval = 0,
    UpChecksIntervalUnits = "string",
    UseVerificationForDown = false,
});

    example, err := incapsula.NewSiteMonitoring(ctx, "siteMonitoringResource", &incapsula.SiteMonitoringArgs{
	SiteId:                      pulumi.Float64(0),
	HttpRequestTimeout:          pulumi.Float64(0),
	MonitoringUrl:               pulumi.String("string"),
	ExpectedReceivedString:      pulumi.String("string"),
	FailedRequestsDuration:      pulumi.Float64(0),
	FailedRequestsDurationUnits: pulumi.String("string"),
	FailedRequestsMinNumber:     pulumi.Float64(0),
	FailedRequestsPercentage:    pulumi.Float64(0),
	AlarmOnDcFailover:           pulumi.Bool(false),
	AlarmOnStandsByFailover:     pulumi.Bool(false),
	HttpRequestTimeoutUnits:     pulumi.String("string"),
	HttpResponseError:           pulumi.String("string"),
	RequiredMonitors:            pulumi.String("string"),
	AlarmOnServerFailover:       pulumi.Bool(false),
	SiteMonitoringId:            pulumi.String("string"),
	UpCheckRetries:              pulumi.Float64(0),
	UpChecksInterval:            pulumi.Float64(0),
	UpChecksIntervalUnits:       pulumi.String("string"),
	UseVerificationForDown:      pulumi.Bool(false),
})

    var siteMonitoringResource = new SiteMonitoring("siteMonitoringResource", SiteMonitoringArgs.builder()
    .siteId(0)
    .httpRequestTimeout(0)
    .monitoringUrl("string")
    .expectedReceivedString("string")
    .failedRequestsDuration(0)
    .failedRequestsDurationUnits("string")
    .failedRequestsMinNumber(0)
    .failedRequestsPercentage(0)
    .alarmOnDcFailover(false)
    .alarmOnStandsByFailover(false)
    .httpRequestTimeoutUnits("string")
    .httpResponseError("string")
    .requiredMonitors("string")
    .alarmOnServerFailover(false)
    .siteMonitoringId("string")
    .upCheckRetries(0)
    .upChecksInterval(0)
    .upChecksIntervalUnits("string")
    .useVerificationForDown(false)
    .build());

    site_monitoring_resource = incapsula.SiteMonitoring("siteMonitoringResource",
    site_id=0,
    http_request_timeout=0,
    monitoring_url="string",
    expected_received_string="string",
    failed_requests_duration=0,
    failed_requests_duration_units="string",
    failed_requests_min_number=0,
    failed_requests_percentage=0,
    alarm_on_dc_failover=False,
    alarm_on_stands_by_failover=False,
    http_request_timeout_units="string",
    http_response_error="string",
    required_monitors="string",
    alarm_on_server_failover=False,
    site_monitoring_id="string",
    up_check_retries=0,
    up_checks_interval=0,
    up_checks_interval_units="string",
    use_verification_for_down=False)

    const siteMonitoringResource = new incapsula.SiteMonitoring("siteMonitoringResource", {
    siteId: 0,
    httpRequestTimeout: 0,
    monitoringUrl: "string",
    expectedReceivedString: "string",
    failedRequestsDuration: 0,
    failedRequestsDurationUnits: "string",
    failedRequestsMinNumber: 0,
    failedRequestsPercentage: 0,
    alarmOnDcFailover: false,
    alarmOnStandsByFailover: false,
    httpRequestTimeoutUnits: "string",
    httpResponseError: "string",
    requiredMonitors: "string",
    alarmOnServerFailover: false,
    siteMonitoringId: "string",
    upCheckRetries: 0,
    upChecksInterval: 0,
    upChecksIntervalUnits: "string",
    useVerificationForDown: false,
});

    type: incapsula:SiteMonitoring
properties:
    alarmOnDcFailover: false
    alarmOnServerFailover: false
    alarmOnStandsByFailover: false
    expectedReceivedString: string
    failedRequestsDuration: 0
    failedRequestsDurationUnits: string
    failedRequestsMinNumber: 0
    failedRequestsPercentage: 0
    httpRequestTimeout: 0
    httpRequestTimeoutUnits: string
    httpResponseError: string
    monitoringUrl: string
    requiredMonitors: string
    siteId: 0
    siteMonitoringId: string
    upCheckRetries: 0
    upChecksInterval: 0
    upChecksIntervalUnits: string
    useVerificationForDown: false

    SiteMonitoring Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The SiteMonitoring resource accepts the following input properties:

    SiteId double
    Numeric identifier of the site to operate on.
    AlarmOnDcFailover bool
    Indicates whether or not an email will be sent upon data center failover. Default: true
    AlarmOnServerFailover bool
    Indicates whether or not an email will be sent upon server failover. Default: false
    AlarmOnStandsByFailover bool
    Indicates whether or not an email will be sent upon failover to a standby data center. Default: true
    ExpectedReceivedString string
    The expected string. If left empty, any response, except for the codes defined in the HTTP response error codes to be treated as Down parameter, will be considered successful. If the value is non-empty, then the defined value must appear within the response string for the response to be considered successful.
    FailedRequestsDuration double
    The minimum duration of failures above the threshold to consider server as down. 20-180 SECONDS or 1-2 MINUTES. Default: 40.
    FailedRequestsDurationUnits string
    Time unit. Possible values: SECONDS, MINUTES. Default: SECONDS.
    FailedRequestsMinNumber double
    The minimum number of failed requests to be considered as failure. Default: 3
    FailedRequestsPercentage double
    The percentage of failed requests to the origin server. Default: 40
    HttpRequestTimeout double
    The maximum time to wait for an HTTP response. 1-200 SECONDS or 1-2 MINUTES. Default: 35
    HttpRequestTimeoutUnits string
    Time unit. Default: SECONDS.
    HttpResponseError string
    The HTTP response error codes or patterns that will be counted as request failures. Default: "501-599".
    MonitoringUrl string
    The URL to use for monitoring your website. Default: "/"
    RequiredMonitors string
    Monitors required to report server / data center as down. Default: "MOST"
    SiteMonitoringId string
    Unique identifier in the API for the Site Monitoring. The id is identical to Site id.
    UpCheckRetries double
    Every time an origin server is tested to see whether it’s back up, the test will be retried this number of times. Default: 3
    UpChecksInterval double
    After an origin server was identified as down, Imperva will periodically test it to see whether it has recovered, according to the frequency defined in this parameter. 10-120 SECONDS or 1-2 MINUTES. Default: 20
    UpChecksIntervalUnits string
    Time unit. Default: SECONDS.
    UseVerificationForDown bool
    If Imperva determines that an origin server is down according to failed request criteria, it will initiate another request to verify that the origin server is down. Default: true
    SiteId float64
    Numeric identifier of the site to operate on.
    AlarmOnDcFailover bool
    Indicates whether or not an email will be sent upon data center failover. Default: true
    AlarmOnServerFailover bool
    Indicates whether or not an email will be sent upon server failover. Default: false
    AlarmOnStandsByFailover bool
    Indicates whether or not an email will be sent upon failover to a standby data center. Default: true
    ExpectedReceivedString string
    The expected string. If left empty, any response, except for the codes defined in the HTTP response error codes to be treated as Down parameter, will be considered successful. If the value is non-empty, then the defined value must appear within the response string for the response to be considered successful.
    FailedRequestsDuration float64
    The minimum duration of failures above the threshold to consider server as down. 20-180 SECONDS or 1-2 MINUTES. Default: 40.
    FailedRequestsDurationUnits string
    Time unit. Possible values: SECONDS, MINUTES. Default: SECONDS.
    FailedRequestsMinNumber float64
    The minimum number of failed requests to be considered as failure. Default: 3
    FailedRequestsPercentage float64
    The percentage of failed requests to the origin server. Default: 40
    HttpRequestTimeout float64
    The maximum time to wait for an HTTP response. 1-200 SECONDS or 1-2 MINUTES. Default: 35
    HttpRequestTimeoutUnits string
    Time unit. Default: SECONDS.
    HttpResponseError string
    The HTTP response error codes or patterns that will be counted as request failures. Default: "501-599".
    MonitoringUrl string
    The URL to use for monitoring your website. Default: "/"
    RequiredMonitors string
    Monitors required to report server / data center as down. Default: "MOST"
    SiteMonitoringId string
    Unique identifier in the API for the Site Monitoring. The id is identical to Site id.
    UpCheckRetries float64
    Every time an origin server is tested to see whether it’s back up, the test will be retried this number of times. Default: 3
    UpChecksInterval float64
    After an origin server was identified as down, Imperva will periodically test it to see whether it has recovered, according to the frequency defined in this parameter. 10-120 SECONDS or 1-2 MINUTES. Default: 20
    UpChecksIntervalUnits string
    Time unit. Default: SECONDS.
    UseVerificationForDown bool
    If Imperva determines that an origin server is down according to failed request criteria, it will initiate another request to verify that the origin server is down. Default: true
    siteId Double
    Numeric identifier of the site to operate on.
    alarmOnDcFailover Boolean
    Indicates whether or not an email will be sent upon data center failover. Default: true
    alarmOnServerFailover Boolean
    Indicates whether or not an email will be sent upon server failover. Default: false
    alarmOnStandsByFailover Boolean
    Indicates whether or not an email will be sent upon failover to a standby data center. Default: true
    expectedReceivedString String
    The expected string. If left empty, any response, except for the codes defined in the HTTP response error codes to be treated as Down parameter, will be considered successful. If the value is non-empty, then the defined value must appear within the response string for the response to be considered successful.
    failedRequestsDuration Double
    The minimum duration of failures above the threshold to consider server as down. 20-180 SECONDS or 1-2 MINUTES. Default: 40.
    failedRequestsDurationUnits String
    Time unit. Possible values: SECONDS, MINUTES. Default: SECONDS.
    failedRequestsMinNumber Double
    The minimum number of failed requests to be considered as failure. Default: 3
    failedRequestsPercentage Double
    The percentage of failed requests to the origin server. Default: 40
    httpRequestTimeout Double
    The maximum time to wait for an HTTP response. 1-200 SECONDS or 1-2 MINUTES. Default: 35
    httpRequestTimeoutUnits String
    Time unit. Default: SECONDS.
    httpResponseError String
    The HTTP response error codes or patterns that will be counted as request failures. Default: "501-599".
    monitoringUrl String
    The URL to use for monitoring your website. Default: "/"
    requiredMonitors String
    Monitors required to report server / data center as down. Default: "MOST"
    siteMonitoringId String
    Unique identifier in the API for the Site Monitoring. The id is identical to Site id.
    upCheckRetries Double
    Every time an origin server is tested to see whether it’s back up, the test will be retried this number of times. Default: 3
    upChecksInterval Double
    After an origin server was identified as down, Imperva will periodically test it to see whether it has recovered, according to the frequency defined in this parameter. 10-120 SECONDS or 1-2 MINUTES. Default: 20
    upChecksIntervalUnits String
    Time unit. Default: SECONDS.
    useVerificationForDown Boolean
    If Imperva determines that an origin server is down according to failed request criteria, it will initiate another request to verify that the origin server is down. Default: true
    siteId number
    Numeric identifier of the site to operate on.
    alarmOnDcFailover boolean
    Indicates whether or not an email will be sent upon data center failover. Default: true
    alarmOnServerFailover boolean
    Indicates whether or not an email will be sent upon server failover. Default: false
    alarmOnStandsByFailover boolean
    Indicates whether or not an email will be sent upon failover to a standby data center. Default: true
    expectedReceivedString string
    The expected string. If left empty, any response, except for the codes defined in the HTTP response error codes to be treated as Down parameter, will be considered successful. If the value is non-empty, then the defined value must appear within the response string for the response to be considered successful.
    failedRequestsDuration number
    The minimum duration of failures above the threshold to consider server as down. 20-180 SECONDS or 1-2 MINUTES. Default: 40.
    failedRequestsDurationUnits string
    Time unit. Possible values: SECONDS, MINUTES. Default: SECONDS.
    failedRequestsMinNumber number
    The minimum number of failed requests to be considered as failure. Default: 3
    failedRequestsPercentage number
    The percentage of failed requests to the origin server. Default: 40
    httpRequestTimeout number
    The maximum time to wait for an HTTP response. 1-200 SECONDS or 1-2 MINUTES. Default: 35
    httpRequestTimeoutUnits string
    Time unit. Default: SECONDS.
    httpResponseError string
    The HTTP response error codes or patterns that will be counted as request failures. Default: "501-599".
    monitoringUrl string
    The URL to use for monitoring your website. Default: "/"
    requiredMonitors string
    Monitors required to report server / data center as down. Default: "MOST"
    siteMonitoringId string
    Unique identifier in the API for the Site Monitoring. The id is identical to Site id.
    upCheckRetries number
    Every time an origin server is tested to see whether it’s back up, the test will be retried this number of times. Default: 3
    upChecksInterval number
    After an origin server was identified as down, Imperva will periodically test it to see whether it has recovered, according to the frequency defined in this parameter. 10-120 SECONDS or 1-2 MINUTES. Default: 20
    upChecksIntervalUnits string
    Time unit. Default: SECONDS.
    useVerificationForDown boolean
    If Imperva determines that an origin server is down according to failed request criteria, it will initiate another request to verify that the origin server is down. Default: true
    site_id float
    Numeric identifier of the site to operate on.
    alarm_on_dc_failover bool
    Indicates whether or not an email will be sent upon data center failover. Default: true
    alarm_on_server_failover bool
    Indicates whether or not an email will be sent upon server failover. Default: false
    alarm_on_stands_by_failover bool
    Indicates whether or not an email will be sent upon failover to a standby data center. Default: true
    expected_received_string str
    The expected string. If left empty, any response, except for the codes defined in the HTTP response error codes to be treated as Down parameter, will be considered successful. If the value is non-empty, then the defined value must appear within the response string for the response to be considered successful.
    failed_requests_duration float
    The minimum duration of failures above the threshold to consider server as down. 20-180 SECONDS or 1-2 MINUTES. Default: 40.
    failed_requests_duration_units str
    Time unit. Possible values: SECONDS, MINUTES. Default: SECONDS.
    failed_requests_min_number float
    The minimum number of failed requests to be considered as failure. Default: 3
    failed_requests_percentage float
    The percentage of failed requests to the origin server. Default: 40
    http_request_timeout float
    The maximum time to wait for an HTTP response. 1-200 SECONDS or 1-2 MINUTES. Default: 35
    http_request_timeout_units str
    Time unit. Default: SECONDS.
    http_response_error str
    The HTTP response error codes or patterns that will be counted as request failures. Default: "501-599".
    monitoring_url str
    The URL to use for monitoring your website. Default: "/"
    required_monitors str
    Monitors required to report server / data center as down. Default: "MOST"
    site_monitoring_id str
    Unique identifier in the API for the Site Monitoring. The id is identical to Site id.
    up_check_retries float
    Every time an origin server is tested to see whether it’s back up, the test will be retried this number of times. Default: 3
    up_checks_interval float
    After an origin server was identified as down, Imperva will periodically test it to see whether it has recovered, according to the frequency defined in this parameter. 10-120 SECONDS or 1-2 MINUTES. Default: 20
    up_checks_interval_units str
    Time unit. Default: SECONDS.
    use_verification_for_down bool
    If Imperva determines that an origin server is down according to failed request criteria, it will initiate another request to verify that the origin server is down. Default: true
    siteId Number
    Numeric identifier of the site to operate on.
    alarmOnDcFailover Boolean
    Indicates whether or not an email will be sent upon data center failover. Default: true
    alarmOnServerFailover Boolean
    Indicates whether or not an email will be sent upon server failover. Default: false
    alarmOnStandsByFailover Boolean
    Indicates whether or not an email will be sent upon failover to a standby data center. Default: true
    expectedReceivedString String
    The expected string. If left empty, any response, except for the codes defined in the HTTP response error codes to be treated as Down parameter, will be considered successful. If the value is non-empty, then the defined value must appear within the response string for the response to be considered successful.
    failedRequestsDuration Number
    The minimum duration of failures above the threshold to consider server as down. 20-180 SECONDS or 1-2 MINUTES. Default: 40.
    failedRequestsDurationUnits String
    Time unit. Possible values: SECONDS, MINUTES. Default: SECONDS.
    failedRequestsMinNumber Number
    The minimum number of failed requests to be considered as failure. Default: 3
    failedRequestsPercentage Number
    The percentage of failed requests to the origin server. Default: 40
    httpRequestTimeout Number
    The maximum time to wait for an HTTP response. 1-200 SECONDS or 1-2 MINUTES. Default: 35
    httpRequestTimeoutUnits String
    Time unit. Default: SECONDS.
    httpResponseError String
    The HTTP response error codes or patterns that will be counted as request failures. Default: "501-599".
    monitoringUrl String
    The URL to use for monitoring your website. Default: "/"
    requiredMonitors String
    Monitors required to report server / data center as down. Default: "MOST"
    siteMonitoringId String
    Unique identifier in the API for the Site Monitoring. The id is identical to Site id.
    upCheckRetries Number
    Every time an origin server is tested to see whether it’s back up, the test will be retried this number of times. Default: 3
    upChecksInterval Number
    After an origin server was identified as down, Imperva will periodically test it to see whether it has recovered, according to the frequency defined in this parameter. 10-120 SECONDS or 1-2 MINUTES. Default: 20
    upChecksIntervalUnits String
    Time unit. Default: SECONDS.
    useVerificationForDown Boolean
    If Imperva determines that an origin server is down according to failed request criteria, it will initiate another request to verify that the origin server is down. Default: true

    Outputs

    All input properties are implicitly available as output properties. Additionally, the SiteMonitoring resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing SiteMonitoring Resource

    Get an existing SiteMonitoring resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: SiteMonitoringState, opts?: CustomResourceOptions): SiteMonitoring
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        alarm_on_dc_failover: Optional[bool] = None,
        alarm_on_server_failover: Optional[bool] = None,
        alarm_on_stands_by_failover: Optional[bool] = None,
        expected_received_string: Optional[str] = None,
        failed_requests_duration: Optional[float] = None,
        failed_requests_duration_units: Optional[str] = None,
        failed_requests_min_number: Optional[float] = None,
        failed_requests_percentage: Optional[float] = None,
        http_request_timeout: Optional[float] = None,
        http_request_timeout_units: Optional[str] = None,
        http_response_error: Optional[str] = None,
        monitoring_url: Optional[str] = None,
        required_monitors: Optional[str] = None,
        site_id: Optional[float] = None,
        site_monitoring_id: Optional[str] = None,
        up_check_retries: Optional[float] = None,
        up_checks_interval: Optional[float] = None,
        up_checks_interval_units: Optional[str] = None,
        use_verification_for_down: Optional[bool] = None) -> SiteMonitoring
    func GetSiteMonitoring(ctx *Context, name string, id IDInput, state *SiteMonitoringState, opts ...ResourceOption) (*SiteMonitoring, error)
    public static SiteMonitoring Get(string name, Input<string> id, SiteMonitoringState? state, CustomResourceOptions? opts = null)
    public static SiteMonitoring get(String name, Output<String> id, SiteMonitoringState state, CustomResourceOptions options)
    resources:  _:    type: incapsula:SiteMonitoring    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AlarmOnDcFailover bool
    Indicates whether or not an email will be sent upon data center failover. Default: true
    AlarmOnServerFailover bool
    Indicates whether or not an email will be sent upon server failover. Default: false
    AlarmOnStandsByFailover bool
    Indicates whether or not an email will be sent upon failover to a standby data center. Default: true
    ExpectedReceivedString string
    The expected string. If left empty, any response, except for the codes defined in the HTTP response error codes to be treated as Down parameter, will be considered successful. If the value is non-empty, then the defined value must appear within the response string for the response to be considered successful.
    FailedRequestsDuration double
    The minimum duration of failures above the threshold to consider server as down. 20-180 SECONDS or 1-2 MINUTES. Default: 40.
    FailedRequestsDurationUnits string
    Time unit. Possible values: SECONDS, MINUTES. Default: SECONDS.
    FailedRequestsMinNumber double
    The minimum number of failed requests to be considered as failure. Default: 3
    FailedRequestsPercentage double
    The percentage of failed requests to the origin server. Default: 40
    HttpRequestTimeout double
    The maximum time to wait for an HTTP response. 1-200 SECONDS or 1-2 MINUTES. Default: 35
    HttpRequestTimeoutUnits string
    Time unit. Default: SECONDS.
    HttpResponseError string
    The HTTP response error codes or patterns that will be counted as request failures. Default: "501-599".
    MonitoringUrl string
    The URL to use for monitoring your website. Default: "/"
    RequiredMonitors string
    Monitors required to report server / data center as down. Default: "MOST"
    SiteId double
    Numeric identifier of the site to operate on.
    SiteMonitoringId string
    Unique identifier in the API for the Site Monitoring. The id is identical to Site id.
    UpCheckRetries double
    Every time an origin server is tested to see whether it’s back up, the test will be retried this number of times. Default: 3
    UpChecksInterval double
    After an origin server was identified as down, Imperva will periodically test it to see whether it has recovered, according to the frequency defined in this parameter. 10-120 SECONDS or 1-2 MINUTES. Default: 20
    UpChecksIntervalUnits string
    Time unit. Default: SECONDS.
    UseVerificationForDown bool
    If Imperva determines that an origin server is down according to failed request criteria, it will initiate another request to verify that the origin server is down. Default: true
    AlarmOnDcFailover bool
    Indicates whether or not an email will be sent upon data center failover. Default: true
    AlarmOnServerFailover bool
    Indicates whether or not an email will be sent upon server failover. Default: false
    AlarmOnStandsByFailover bool
    Indicates whether or not an email will be sent upon failover to a standby data center. Default: true
    ExpectedReceivedString string
    The expected string. If left empty, any response, except for the codes defined in the HTTP response error codes to be treated as Down parameter, will be considered successful. If the value is non-empty, then the defined value must appear within the response string for the response to be considered successful.
    FailedRequestsDuration float64
    The minimum duration of failures above the threshold to consider server as down. 20-180 SECONDS or 1-2 MINUTES. Default: 40.
    FailedRequestsDurationUnits string
    Time unit. Possible values: SECONDS, MINUTES. Default: SECONDS.
    FailedRequestsMinNumber float64
    The minimum number of failed requests to be considered as failure. Default: 3
    FailedRequestsPercentage float64
    The percentage of failed requests to the origin server. Default: 40
    HttpRequestTimeout float64
    The maximum time to wait for an HTTP response. 1-200 SECONDS or 1-2 MINUTES. Default: 35
    HttpRequestTimeoutUnits string
    Time unit. Default: SECONDS.
    HttpResponseError string
    The HTTP response error codes or patterns that will be counted as request failures. Default: "501-599".
    MonitoringUrl string
    The URL to use for monitoring your website. Default: "/"
    RequiredMonitors string
    Monitors required to report server / data center as down. Default: "MOST"
    SiteId float64
    Numeric identifier of the site to operate on.
    SiteMonitoringId string
    Unique identifier in the API for the Site Monitoring. The id is identical to Site id.
    UpCheckRetries float64
    Every time an origin server is tested to see whether it’s back up, the test will be retried this number of times. Default: 3
    UpChecksInterval float64
    After an origin server was identified as down, Imperva will periodically test it to see whether it has recovered, according to the frequency defined in this parameter. 10-120 SECONDS or 1-2 MINUTES. Default: 20
    UpChecksIntervalUnits string
    Time unit. Default: SECONDS.
    UseVerificationForDown bool
    If Imperva determines that an origin server is down according to failed request criteria, it will initiate another request to verify that the origin server is down. Default: true
    alarmOnDcFailover Boolean
    Indicates whether or not an email will be sent upon data center failover. Default: true
    alarmOnServerFailover Boolean
    Indicates whether or not an email will be sent upon server failover. Default: false
    alarmOnStandsByFailover Boolean
    Indicates whether or not an email will be sent upon failover to a standby data center. Default: true
    expectedReceivedString String
    The expected string. If left empty, any response, except for the codes defined in the HTTP response error codes to be treated as Down parameter, will be considered successful. If the value is non-empty, then the defined value must appear within the response string for the response to be considered successful.
    failedRequestsDuration Double
    The minimum duration of failures above the threshold to consider server as down. 20-180 SECONDS or 1-2 MINUTES. Default: 40.
    failedRequestsDurationUnits String
    Time unit. Possible values: SECONDS, MINUTES. Default: SECONDS.
    failedRequestsMinNumber Double
    The minimum number of failed requests to be considered as failure. Default: 3
    failedRequestsPercentage Double
    The percentage of failed requests to the origin server. Default: 40
    httpRequestTimeout Double
    The maximum time to wait for an HTTP response. 1-200 SECONDS or 1-2 MINUTES. Default: 35
    httpRequestTimeoutUnits String
    Time unit. Default: SECONDS.
    httpResponseError String
    The HTTP response error codes or patterns that will be counted as request failures. Default: "501-599".
    monitoringUrl String
    The URL to use for monitoring your website. Default: "/"
    requiredMonitors String
    Monitors required to report server / data center as down. Default: "MOST"
    siteId Double
    Numeric identifier of the site to operate on.
    siteMonitoringId String
    Unique identifier in the API for the Site Monitoring. The id is identical to Site id.
    upCheckRetries Double
    Every time an origin server is tested to see whether it’s back up, the test will be retried this number of times. Default: 3
    upChecksInterval Double
    After an origin server was identified as down, Imperva will periodically test it to see whether it has recovered, according to the frequency defined in this parameter. 10-120 SECONDS or 1-2 MINUTES. Default: 20
    upChecksIntervalUnits String
    Time unit. Default: SECONDS.
    useVerificationForDown Boolean
    If Imperva determines that an origin server is down according to failed request criteria, it will initiate another request to verify that the origin server is down. Default: true
    alarmOnDcFailover boolean
    Indicates whether or not an email will be sent upon data center failover. Default: true
    alarmOnServerFailover boolean
    Indicates whether or not an email will be sent upon server failover. Default: false
    alarmOnStandsByFailover boolean
    Indicates whether or not an email will be sent upon failover to a standby data center. Default: true
    expectedReceivedString string
    The expected string. If left empty, any response, except for the codes defined in the HTTP response error codes to be treated as Down parameter, will be considered successful. If the value is non-empty, then the defined value must appear within the response string for the response to be considered successful.
    failedRequestsDuration number
    The minimum duration of failures above the threshold to consider server as down. 20-180 SECONDS or 1-2 MINUTES. Default: 40.
    failedRequestsDurationUnits string
    Time unit. Possible values: SECONDS, MINUTES. Default: SECONDS.
    failedRequestsMinNumber number
    The minimum number of failed requests to be considered as failure. Default: 3
    failedRequestsPercentage number
    The percentage of failed requests to the origin server. Default: 40
    httpRequestTimeout number
    The maximum time to wait for an HTTP response. 1-200 SECONDS or 1-2 MINUTES. Default: 35
    httpRequestTimeoutUnits string
    Time unit. Default: SECONDS.
    httpResponseError string
    The HTTP response error codes or patterns that will be counted as request failures. Default: "501-599".
    monitoringUrl string
    The URL to use for monitoring your website. Default: "/"
    requiredMonitors string
    Monitors required to report server / data center as down. Default: "MOST"
    siteId number
    Numeric identifier of the site to operate on.
    siteMonitoringId string
    Unique identifier in the API for the Site Monitoring. The id is identical to Site id.
    upCheckRetries number
    Every time an origin server is tested to see whether it’s back up, the test will be retried this number of times. Default: 3
    upChecksInterval number
    After an origin server was identified as down, Imperva will periodically test it to see whether it has recovered, according to the frequency defined in this parameter. 10-120 SECONDS or 1-2 MINUTES. Default: 20
    upChecksIntervalUnits string
    Time unit. Default: SECONDS.
    useVerificationForDown boolean
    If Imperva determines that an origin server is down according to failed request criteria, it will initiate another request to verify that the origin server is down. Default: true
    alarm_on_dc_failover bool
    Indicates whether or not an email will be sent upon data center failover. Default: true
    alarm_on_server_failover bool
    Indicates whether or not an email will be sent upon server failover. Default: false
    alarm_on_stands_by_failover bool
    Indicates whether or not an email will be sent upon failover to a standby data center. Default: true
    expected_received_string str
    The expected string. If left empty, any response, except for the codes defined in the HTTP response error codes to be treated as Down parameter, will be considered successful. If the value is non-empty, then the defined value must appear within the response string for the response to be considered successful.
    failed_requests_duration float
    The minimum duration of failures above the threshold to consider server as down. 20-180 SECONDS or 1-2 MINUTES. Default: 40.
    failed_requests_duration_units str
    Time unit. Possible values: SECONDS, MINUTES. Default: SECONDS.
    failed_requests_min_number float
    The minimum number of failed requests to be considered as failure. Default: 3
    failed_requests_percentage float
    The percentage of failed requests to the origin server. Default: 40
    http_request_timeout float
    The maximum time to wait for an HTTP response. 1-200 SECONDS or 1-2 MINUTES. Default: 35
    http_request_timeout_units str
    Time unit. Default: SECONDS.
    http_response_error str
    The HTTP response error codes or patterns that will be counted as request failures. Default: "501-599".
    monitoring_url str
    The URL to use for monitoring your website. Default: "/"
    required_monitors str
    Monitors required to report server / data center as down. Default: "MOST"
    site_id float
    Numeric identifier of the site to operate on.
    site_monitoring_id str
    Unique identifier in the API for the Site Monitoring. The id is identical to Site id.
    up_check_retries float
    Every time an origin server is tested to see whether it’s back up, the test will be retried this number of times. Default: 3
    up_checks_interval float
    After an origin server was identified as down, Imperva will periodically test it to see whether it has recovered, according to the frequency defined in this parameter. 10-120 SECONDS or 1-2 MINUTES. Default: 20
    up_checks_interval_units str
    Time unit. Default: SECONDS.
    use_verification_for_down bool
    If Imperva determines that an origin server is down according to failed request criteria, it will initiate another request to verify that the origin server is down. Default: true
    alarmOnDcFailover Boolean
    Indicates whether or not an email will be sent upon data center failover. Default: true
    alarmOnServerFailover Boolean
    Indicates whether or not an email will be sent upon server failover. Default: false
    alarmOnStandsByFailover Boolean
    Indicates whether or not an email will be sent upon failover to a standby data center. Default: true
    expectedReceivedString String
    The expected string. If left empty, any response, except for the codes defined in the HTTP response error codes to be treated as Down parameter, will be considered successful. If the value is non-empty, then the defined value must appear within the response string for the response to be considered successful.
    failedRequestsDuration Number
    The minimum duration of failures above the threshold to consider server as down. 20-180 SECONDS or 1-2 MINUTES. Default: 40.
    failedRequestsDurationUnits String
    Time unit. Possible values: SECONDS, MINUTES. Default: SECONDS.
    failedRequestsMinNumber Number
    The minimum number of failed requests to be considered as failure. Default: 3
    failedRequestsPercentage Number
    The percentage of failed requests to the origin server. Default: 40
    httpRequestTimeout Number
    The maximum time to wait for an HTTP response. 1-200 SECONDS or 1-2 MINUTES. Default: 35
    httpRequestTimeoutUnits String
    Time unit. Default: SECONDS.
    httpResponseError String
    The HTTP response error codes or patterns that will be counted as request failures. Default: "501-599".
    monitoringUrl String
    The URL to use for monitoring your website. Default: "/"
    requiredMonitors String
    Monitors required to report server / data center as down. Default: "MOST"
    siteId Number
    Numeric identifier of the site to operate on.
    siteMonitoringId String
    Unique identifier in the API for the Site Monitoring. The id is identical to Site id.
    upCheckRetries Number
    Every time an origin server is tested to see whether it’s back up, the test will be retried this number of times. Default: 3
    upChecksInterval Number
    After an origin server was identified as down, Imperva will periodically test it to see whether it has recovered, according to the frequency defined in this parameter. 10-120 SECONDS or 1-2 MINUTES. Default: 20
    upChecksIntervalUnits String
    Time unit. Default: SECONDS.
    useVerificationForDown Boolean
    If Imperva determines that an origin server is down according to failed request criteria, it will initiate another request to verify that the origin server is down. Default: true

    Import

    Site Monitoring configuration can be imported using the id, e.g.:

    $ pulumi import incapsula:index/siteMonitoring:SiteMonitoring example_site_monitoring 1234

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    incapsula imperva/terraform-provider-incapsula
    License
    Notes
    This Pulumi package is based on the incapsula Terraform Provider.
    incapsula logo
    incapsula 3.32.1 published on Monday, Apr 14, 2025 by imperva
    imperva/terraform-provider-incapsula