Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Statuscake
  3. API Docs
  4. UptimeCheck
Statuscake v1.0.2 published on Sunday, Oct 8, 2023 by Pulumiverse
pulumiverse/pulumi-statuscake

statuscake.UptimeCheck

Explore with Pulumi AI

statuscake logo
Statuscake v1.0.2 published on Sunday, Oct 8, 2023 by Pulumiverse
pulumiverse/pulumi-statuscake

    Create UptimeCheck Resource

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

    Constructor syntax

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

@overload
def UptimeCheck(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                check_interval: Optional[int] = None,
                monitored_resource: Optional[UptimeCheckMonitoredResourceArgs] = None,
                dns_check: Optional[UptimeCheckDnsCheckArgs] = None,
                contact_groups: Optional[Sequence[str]] = None,
                http_check: Optional[UptimeCheckHttpCheckArgs] = None,
                icmp_check: Optional[UptimeCheckIcmpCheckArgs] = None,
                confirmation: Optional[int] = None,
                name: Optional[str] = None,
                paused: Optional[bool] = None,
                regions: Optional[Sequence[str]] = None,
                tags: Optional[Sequence[str]] = None,
                tcp_check: Optional[UptimeCheckTcpCheckArgs] = None,
                trigger_rate: Optional[int] = None)
    func NewUptimeCheck(ctx *Context, name string, args UptimeCheckArgs, opts ...ResourceOption) (*UptimeCheck, error)
    public UptimeCheck(string name, UptimeCheckArgs args, CustomResourceOptions? opts = null)
    public UptimeCheck(String name, UptimeCheckArgs args)
public UptimeCheck(String name, UptimeCheckArgs args, CustomResourceOptions options)

    type: statuscake:UptimeCheck
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 UptimeCheckArgs
    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 UptimeCheckArgs
    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 UptimeCheckArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UptimeCheckArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UptimeCheckArgs
    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 uptimeCheckResource = new Statuscake.UptimeCheck("uptimeCheckResource", new()
{
    CheckInterval = 0,
    MonitoredResource = new Statuscake.Inputs.UptimeCheckMonitoredResourceArgs
    {
        Address = "string",
        Host = "string",
    },
    DnsCheck = new Statuscake.Inputs.UptimeCheckDnsCheckArgs
    {
        DnsIps = new[]
        {
            "string",
        },
        DnsServer = "string",
    },
    ContactGroups = new[]
    {
        "string",
    },
    HttpCheck = new Statuscake.Inputs.UptimeCheckHttpCheckArgs
    {
        StatusCodes = new[]
        {
            "string",
        },
        FinalEndpoint = "string",
        EnableCookies = false,
        BasicAuthentication = new Statuscake.Inputs.UptimeCheckHttpCheckBasicAuthenticationArgs
        {
            Password = "string",
            Username = "string",
        },
        FollowRedirects = false,
        RequestHeaders = 
        {
            { "string", "string" },
        },
        RequestMethod = "string",
        RequestPayload = 
        {
            { "string", "string" },
        },
        RequestPayloadRaw = "string",
        ContentMatchers = new Statuscake.Inputs.UptimeCheckHttpCheckContentMatchersArgs
        {
            Content = "string",
            IncludeHeaders = false,
            Matcher = "string",
        },
        Timeout = 0,
        UserAgent = "string",
        ValidateSsl = false,
    },
    IcmpCheck = new Statuscake.Inputs.UptimeCheckIcmpCheckArgs
    {
        Enabled = false,
    },
    Confirmation = 0,
    Name = "string",
    Paused = false,
    Regions = new[]
    {
        "string",
    },
    Tags = new[]
    {
        "string",
    },
    TcpCheck = new Statuscake.Inputs.UptimeCheckTcpCheckArgs
    {
        Port = 0,
        Authentication = new Statuscake.Inputs.UptimeCheckTcpCheckAuthenticationArgs
        {
            Password = "string",
            Username = "string",
        },
        Protocol = "string",
        Timeout = 0,
    },
    TriggerRate = 0,
});

    example, err := statuscake.NewUptimeCheck(ctx, "uptimeCheckResource", &statuscake.UptimeCheckArgs{
	CheckInterval: pulumi.Int(0),
	MonitoredResource: &statuscake.UptimeCheckMonitoredResourceArgs{
		Address: pulumi.String("string"),
		Host:    pulumi.String("string"),
	},
	DnsCheck: &statuscake.UptimeCheckDnsCheckArgs{
		DnsIps: pulumi.StringArray{
			pulumi.String("string"),
		},
		DnsServer: pulumi.String("string"),
	},
	ContactGroups: pulumi.StringArray{
		pulumi.String("string"),
	},
	HttpCheck: &statuscake.UptimeCheckHttpCheckArgs{
		StatusCodes: pulumi.StringArray{
			pulumi.String("string"),
		},
		FinalEndpoint: pulumi.String("string"),
		EnableCookies: pulumi.Bool(false),
		BasicAuthentication: &statuscake.UptimeCheckHttpCheckBasicAuthenticationArgs{
			Password: pulumi.String("string"),
			Username: pulumi.String("string"),
		},
		FollowRedirects: pulumi.Bool(false),
		RequestHeaders: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		RequestMethod: pulumi.String("string"),
		RequestPayload: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		RequestPayloadRaw: pulumi.String("string"),
		ContentMatchers: &statuscake.UptimeCheckHttpCheckContentMatchersArgs{
			Content:        pulumi.String("string"),
			IncludeHeaders: pulumi.Bool(false),
			Matcher:        pulumi.String("string"),
		},
		Timeout:     pulumi.Int(0),
		UserAgent:   pulumi.String("string"),
		ValidateSsl: pulumi.Bool(false),
	},
	IcmpCheck: &statuscake.UptimeCheckIcmpCheckArgs{
		Enabled: pulumi.Bool(false),
	},
	Confirmation: pulumi.Int(0),
	Name:         pulumi.String("string"),
	Paused:       pulumi.Bool(false),
	Regions: pulumi.StringArray{
		pulumi.String("string"),
	},
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	TcpCheck: &statuscake.UptimeCheckTcpCheckArgs{
		Port: pulumi.Int(0),
		Authentication: &statuscake.UptimeCheckTcpCheckAuthenticationArgs{
			Password: pulumi.String("string"),
			Username: pulumi.String("string"),
		},
		Protocol: pulumi.String("string"),
		Timeout:  pulumi.Int(0),
	},
	TriggerRate: pulumi.Int(0),
})

    var uptimeCheckResource = new UptimeCheck("uptimeCheckResource", UptimeCheckArgs.builder()
    .checkInterval(0)
    .monitoredResource(UptimeCheckMonitoredResourceArgs.builder()
        .address("string")
        .host("string")
        .build())
    .dnsCheck(UptimeCheckDnsCheckArgs.builder()
        .dnsIps("string")
        .dnsServer("string")
        .build())
    .contactGroups("string")
    .httpCheck(UptimeCheckHttpCheckArgs.builder()
        .statusCodes("string")
        .finalEndpoint("string")
        .enableCookies(false)
        .basicAuthentication(UptimeCheckHttpCheckBasicAuthenticationArgs.builder()
            .password("string")
            .username("string")
            .build())
        .followRedirects(false)
        .requestHeaders(Map.of("string", "string"))
        .requestMethod("string")
        .requestPayload(Map.of("string", "string"))
        .requestPayloadRaw("string")
        .contentMatchers(UptimeCheckHttpCheckContentMatchersArgs.builder()
            .content("string")
            .includeHeaders(false)
            .matcher("string")
            .build())
        .timeout(0)
        .userAgent("string")
        .validateSsl(false)
        .build())
    .icmpCheck(UptimeCheckIcmpCheckArgs.builder()
        .enabled(false)
        .build())
    .confirmation(0)
    .name("string")
    .paused(false)
    .regions("string")
    .tags("string")
    .tcpCheck(UptimeCheckTcpCheckArgs.builder()
        .port(0)
        .authentication(UptimeCheckTcpCheckAuthenticationArgs.builder()
            .password("string")
            .username("string")
            .build())
        .protocol("string")
        .timeout(0)
        .build())
    .triggerRate(0)
    .build());

    uptime_check_resource = statuscake.UptimeCheck("uptimeCheckResource",
    check_interval=0,
    monitored_resource={
        "address": "string",
        "host": "string",
    },
    dns_check={
        "dns_ips": ["string"],
        "dns_server": "string",
    },
    contact_groups=["string"],
    http_check={
        "status_codes": ["string"],
        "final_endpoint": "string",
        "enable_cookies": False,
        "basic_authentication": {
            "password": "string",
            "username": "string",
        },
        "follow_redirects": False,
        "request_headers": {
            "string": "string",
        },
        "request_method": "string",
        "request_payload": {
            "string": "string",
        },
        "request_payload_raw": "string",
        "content_matchers": {
            "content": "string",
            "include_headers": False,
            "matcher": "string",
        },
        "timeout": 0,
        "user_agent": "string",
        "validate_ssl": False,
    },
    icmp_check={
        "enabled": False,
    },
    confirmation=0,
    name="string",
    paused=False,
    regions=["string"],
    tags=["string"],
    tcp_check={
        "port": 0,
        "authentication": {
            "password": "string",
            "username": "string",
        },
        "protocol": "string",
        "timeout": 0,
    },
    trigger_rate=0)

    const uptimeCheckResource = new statuscake.UptimeCheck("uptimeCheckResource", {
    checkInterval: 0,
    monitoredResource: {
        address: "string",
        host: "string",
    },
    dnsCheck: {
        dnsIps: ["string"],
        dnsServer: "string",
    },
    contactGroups: ["string"],
    httpCheck: {
        statusCodes: ["string"],
        finalEndpoint: "string",
        enableCookies: false,
        basicAuthentication: {
            password: "string",
            username: "string",
        },
        followRedirects: false,
        requestHeaders: {
            string: "string",
        },
        requestMethod: "string",
        requestPayload: {
            string: "string",
        },
        requestPayloadRaw: "string",
        contentMatchers: {
            content: "string",
            includeHeaders: false,
            matcher: "string",
        },
        timeout: 0,
        userAgent: "string",
        validateSsl: false,
    },
    icmpCheck: {
        enabled: false,
    },
    confirmation: 0,
    name: "string",
    paused: false,
    regions: ["string"],
    tags: ["string"],
    tcpCheck: {
        port: 0,
        authentication: {
            password: "string",
            username: "string",
        },
        protocol: "string",
        timeout: 0,
    },
    triggerRate: 0,
});

    type: statuscake:UptimeCheck
properties:
    checkInterval: 0
    confirmation: 0
    contactGroups:
        - string
    dnsCheck:
        dnsIps:
            - string
        dnsServer: string
    httpCheck:
        basicAuthentication:
            password: string
            username: string
        contentMatchers:
            content: string
            includeHeaders: false
            matcher: string
        enableCookies: false
        finalEndpoint: string
        followRedirects: false
        requestHeaders:
            string: string
        requestMethod: string
        requestPayload:
            string: string
        requestPayloadRaw: string
        statusCodes:
            - string
        timeout: 0
        userAgent: string
        validateSsl: false
    icmpCheck:
        enabled: false
    monitoredResource:
        address: string
        host: string
    name: string
    paused: false
    regions:
        - string
    tags:
        - string
    tcpCheck:
        authentication:
            password: string
            username: string
        port: 0
        protocol: string
        timeout: 0
    triggerRate: 0

    UptimeCheck 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 UptimeCheck resource accepts the following input properties:

    CheckInterval int
    Number of seconds between checks
    MonitoredResource Pulumiverse.Statuscake.Inputs.UptimeCheckMonitoredResource
    Monitored resource configuration block. The describes server under test
    Confirmation int
    Number of confirmation servers to confirm downtime before an alert is triggered
    ContactGroups List<string>
    List of contact group IDs
    DnsCheck Pulumiverse.Statuscake.Inputs.UptimeCheckDnsCheck
    DNS check configuration block. Only one of dns_check, http_check, icmp_check, and tcp_check may be specified
    HttpCheck Pulumiverse.Statuscake.Inputs.UptimeCheckHttpCheck
    HTTP check configuration block. Only one of dns_check, http_check, icmp_check, and tcp_check may be specified
    IcmpCheck Pulumiverse.Statuscake.Inputs.UptimeCheckIcmpCheck
    ICMP check configuration block. Only one of dns_check, http_check, icmp_check, and tcp_check may be specified
    Name string
    Name of the check
    Paused bool
    Whether the check should be run
    Regions List<string>
    List of regions on which to run checks. The values required for this parameter can be retrieved from the GET /v1/uptime-locations endpoint
    Tags List<string>
    List of tags
    TcpCheck Pulumiverse.Statuscake.Inputs.UptimeCheckTcpCheck
    TCP check configuration block. Only one of dns_check, http_check, icmp_check, and tcp_check may be specified
    TriggerRate int
    The number of minutes to wait before sending an alert
    CheckInterval int
    Number of seconds between checks
    MonitoredResource UptimeCheckMonitoredResourceArgs
    Monitored resource configuration block. The describes server under test
    Confirmation int
    Number of confirmation servers to confirm downtime before an alert is triggered
    ContactGroups []string
    List of contact group IDs
    DnsCheck UptimeCheckDnsCheckArgs
    DNS check configuration block. Only one of dns_check, http_check, icmp_check, and tcp_check may be specified
    HttpCheck UptimeCheckHttpCheckArgs
    HTTP check configuration block. Only one of dns_check, http_check, icmp_check, and tcp_check may be specified
    IcmpCheck UptimeCheckIcmpCheckArgs
    ICMP check configuration block. Only one of dns_check, http_check, icmp_check, and tcp_check may be specified
    Name string
    Name of the check
    Paused bool
    Whether the check should be run
    Regions []string
    List of regions on which to run checks. The values required for this parameter can be retrieved from the GET /v1/uptime-locations endpoint
    Tags []string
    List of tags
    TcpCheck UptimeCheckTcpCheckArgs
    TCP check configuration block. Only one of dns_check, http_check, icmp_check, and tcp_check may be specified
    TriggerRate int
    The number of minutes to wait before sending an alert
    checkInterval Integer
    Number of seconds between checks
    monitoredResource UptimeCheckMonitoredResource
    Monitored resource configuration block. The describes server under test
    confirmation Integer
    Number of confirmation servers to confirm downtime before an alert is triggered
    contactGroups List<String>
    List of contact group IDs
    dnsCheck UptimeCheckDnsCheck
    DNS check configuration block. Only one of dns_check, http_check, icmp_check, and tcp_check may be specified
    httpCheck UptimeCheckHttpCheck
    HTTP check configuration block. Only one of dns_check, http_check, icmp_check, and tcp_check may be specified
    icmpCheck UptimeCheckIcmpCheck
    ICMP check configuration block. Only one of dns_check, http_check, icmp_check, and tcp_check may be specified
    name String
    Name of the check
    paused Boolean
    Whether the check should be run
    regions List<String>
    List of regions on which to run checks. The values required for this parameter can be retrieved from the GET /v1/uptime-locations endpoint
    tags List<String>
    List of tags
    tcpCheck UptimeCheckTcpCheck
    TCP check configuration block. Only one of dns_check, http_check, icmp_check, and tcp_check may be specified
    triggerRate Integer
    The number of minutes to wait before sending an alert
    checkInterval number
    Number of seconds between checks
    monitoredResource UptimeCheckMonitoredResource
    Monitored resource configuration block. The describes server under test
    confirmation number
    Number of confirmation servers to confirm downtime before an alert is triggered
    contactGroups string[]
    List of contact group IDs
    dnsCheck UptimeCheckDnsCheck
    DNS check configuration block. Only one of dns_check, http_check, icmp_check, and tcp_check may be specified
    httpCheck UptimeCheckHttpCheck
    HTTP check configuration block. Only one of dns_check, http_check, icmp_check, and tcp_check may be specified
    icmpCheck UptimeCheckIcmpCheck
    ICMP check configuration block. Only one of dns_check, http_check, icmp_check, and tcp_check may be specified
    name string
    Name of the check
    paused boolean
    Whether the check should be run
    regions string[]
    List of regions on which to run checks. The values required for this parameter can be retrieved from the GET /v1/uptime-locations endpoint
    tags string[]
    List of tags
    tcpCheck UptimeCheckTcpCheck
    TCP check configuration block. Only one of dns_check, http_check, icmp_check, and tcp_check may be specified
    triggerRate number
    The number of minutes to wait before sending an alert
    check_interval int
    Number of seconds between checks
    monitored_resource UptimeCheckMonitoredResourceArgs
    Monitored resource configuration block. The describes server under test
    confirmation int
    Number of confirmation servers to confirm downtime before an alert is triggered
    contact_groups Sequence[str]
    List of contact group IDs
    dns_check UptimeCheckDnsCheckArgs
    DNS check configuration block. Only one of dns_check, http_check, icmp_check, and tcp_check may be specified
    http_check UptimeCheckHttpCheckArgs
    HTTP check configuration block. Only one of dns_check, http_check, icmp_check, and tcp_check may be specified
    icmp_check UptimeCheckIcmpCheckArgs
    ICMP check configuration block. Only one of dns_check, http_check, icmp_check, and tcp_check may be specified
    name str
    Name of the check
    paused bool
    Whether the check should be run
    regions Sequence[str]
    List of regions on which to run checks. The values required for this parameter can be retrieved from the GET /v1/uptime-locations endpoint
    tags Sequence[str]
    List of tags
    tcp_check UptimeCheckTcpCheckArgs
    TCP check configuration block. Only one of dns_check, http_check, icmp_check, and tcp_check may be specified
    trigger_rate int
    The number of minutes to wait before sending an alert
    checkInterval Number
    Number of seconds between checks
    monitoredResource Property Map
    Monitored resource configuration block. The describes server under test
    confirmation Number
    Number of confirmation servers to confirm downtime before an alert is triggered
    contactGroups List<String>
    List of contact group IDs
    dnsCheck Property Map
    DNS check configuration block. Only one of dns_check, http_check, icmp_check, and tcp_check may be specified
    httpCheck Property Map
    HTTP check configuration block. Only one of dns_check, http_check, icmp_check, and tcp_check may be specified
    icmpCheck Property Map
    ICMP check configuration block. Only one of dns_check, http_check, icmp_check, and tcp_check may be specified
    name String
    Name of the check
    paused Boolean
    Whether the check should be run
    regions List<String>
    List of regions on which to run checks. The values required for this parameter can be retrieved from the GET /v1/uptime-locations endpoint
    tags List<String>
    List of tags
    tcpCheck Property Map
    TCP check configuration block. Only one of dns_check, http_check, icmp_check, and tcp_check may be specified
    triggerRate Number
    The number of minutes to wait before sending an alert

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Locations List<Pulumiverse.Statuscake.Outputs.UptimeCheckLocation>
    List of assigned monitoring locations on which to run checks
    Id string
    The provider-assigned unique ID for this managed resource.
    Locations []UptimeCheckLocation
    List of assigned monitoring locations on which to run checks
    id String
    The provider-assigned unique ID for this managed resource.
    locations List<UptimeCheckLocation>
    List of assigned monitoring locations on which to run checks
    id string
    The provider-assigned unique ID for this managed resource.
    locations UptimeCheckLocation[]
    List of assigned monitoring locations on which to run checks
    id str
    The provider-assigned unique ID for this managed resource.
    locations Sequence[UptimeCheckLocation]
    List of assigned monitoring locations on which to run checks
    id String
    The provider-assigned unique ID for this managed resource.
    locations List<Property Map>
    List of assigned monitoring locations on which to run checks

    Look up Existing UptimeCheck Resource

    Get an existing UptimeCheck 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?: UptimeCheckState, opts?: CustomResourceOptions): UptimeCheck
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        check_interval: Optional[int] = None,
        confirmation: Optional[int] = None,
        contact_groups: Optional[Sequence[str]] = None,
        dns_check: Optional[UptimeCheckDnsCheckArgs] = None,
        http_check: Optional[UptimeCheckHttpCheckArgs] = None,
        icmp_check: Optional[UptimeCheckIcmpCheckArgs] = None,
        locations: Optional[Sequence[UptimeCheckLocationArgs]] = None,
        monitored_resource: Optional[UptimeCheckMonitoredResourceArgs] = None,
        name: Optional[str] = None,
        paused: Optional[bool] = None,
        regions: Optional[Sequence[str]] = None,
        tags: Optional[Sequence[str]] = None,
        tcp_check: Optional[UptimeCheckTcpCheckArgs] = None,
        trigger_rate: Optional[int] = None) -> UptimeCheck
    func GetUptimeCheck(ctx *Context, name string, id IDInput, state *UptimeCheckState, opts ...ResourceOption) (*UptimeCheck, error)
    public static UptimeCheck Get(string name, Input<string> id, UptimeCheckState? state, CustomResourceOptions? opts = null)
    public static UptimeCheck get(String name, Output<String> id, UptimeCheckState state, CustomResourceOptions options)
    resources:  _:    type: statuscake:UptimeCheck    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:
    CheckInterval int
    Number of seconds between checks
    Confirmation int
    Number of confirmation servers to confirm downtime before an alert is triggered
    ContactGroups List<string>
    List of contact group IDs
    DnsCheck Pulumiverse.Statuscake.Inputs.UptimeCheckDnsCheck
    DNS check configuration block. Only one of dns_check, http_check, icmp_check, and tcp_check may be specified
    HttpCheck Pulumiverse.Statuscake.Inputs.UptimeCheckHttpCheck
    HTTP check configuration block. Only one of dns_check, http_check, icmp_check, and tcp_check may be specified
    IcmpCheck Pulumiverse.Statuscake.Inputs.UptimeCheckIcmpCheck
    ICMP check configuration block. Only one of dns_check, http_check, icmp_check, and tcp_check may be specified
    Locations List<Pulumiverse.Statuscake.Inputs.UptimeCheckLocation>
    List of assigned monitoring locations on which to run checks
    MonitoredResource Pulumiverse.Statuscake.Inputs.UptimeCheckMonitoredResource
    Monitored resource configuration block. The describes server under test
    Name string
    Name of the check
    Paused bool
    Whether the check should be run
    Regions List<string>
    List of regions on which to run checks. The values required for this parameter can be retrieved from the GET /v1/uptime-locations endpoint
    Tags List<string>
    List of tags
    TcpCheck Pulumiverse.Statuscake.Inputs.UptimeCheckTcpCheck
    TCP check configuration block. Only one of dns_check, http_check, icmp_check, and tcp_check may be specified
    TriggerRate int
    The number of minutes to wait before sending an alert
    CheckInterval int
    Number of seconds between checks
    Confirmation int
    Number of confirmation servers to confirm downtime before an alert is triggered
    ContactGroups []string
    List of contact group IDs
    DnsCheck UptimeCheckDnsCheckArgs
    DNS check configuration block. Only one of dns_check, http_check, icmp_check, and tcp_check may be specified
    HttpCheck UptimeCheckHttpCheckArgs
    HTTP check configuration block. Only one of dns_check, http_check, icmp_check, and tcp_check may be specified
    IcmpCheck UptimeCheckIcmpCheckArgs
    ICMP check configuration block. Only one of dns_check, http_check, icmp_check, and tcp_check may be specified
    Locations []UptimeCheckLocationArgs
    List of assigned monitoring locations on which to run checks
    MonitoredResource UptimeCheckMonitoredResourceArgs
    Monitored resource configuration block. The describes server under test
    Name string
    Name of the check
    Paused bool
    Whether the check should be run
    Regions []string
    List of regions on which to run checks. The values required for this parameter can be retrieved from the GET /v1/uptime-locations endpoint
    Tags []string
    List of tags
    TcpCheck UptimeCheckTcpCheckArgs
    TCP check configuration block. Only one of dns_check, http_check, icmp_check, and tcp_check may be specified
    TriggerRate int
    The number of minutes to wait before sending an alert
    checkInterval Integer
    Number of seconds between checks
    confirmation Integer
    Number of confirmation servers to confirm downtime before an alert is triggered
    contactGroups List<String>
    List of contact group IDs
    dnsCheck UptimeCheckDnsCheck
    DNS check configuration block. Only one of dns_check, http_check, icmp_check, and tcp_check may be specified
    httpCheck UptimeCheckHttpCheck
    HTTP check configuration block. Only one of dns_check, http_check, icmp_check, and tcp_check may be specified
    icmpCheck UptimeCheckIcmpCheck
    ICMP check configuration block. Only one of dns_check, http_check, icmp_check, and tcp_check may be specified
    locations List<UptimeCheckLocation>
    List of assigned monitoring locations on which to run checks
    monitoredResource UptimeCheckMonitoredResource
    Monitored resource configuration block. The describes server under test
    name String
    Name of the check
    paused Boolean
    Whether the check should be run
    regions List<String>
    List of regions on which to run checks. The values required for this parameter can be retrieved from the GET /v1/uptime-locations endpoint
    tags List<String>
    List of tags
    tcpCheck UptimeCheckTcpCheck
    TCP check configuration block. Only one of dns_check, http_check, icmp_check, and tcp_check may be specified
    triggerRate Integer
    The number of minutes to wait before sending an alert
    checkInterval number
    Number of seconds between checks
    confirmation number
    Number of confirmation servers to confirm downtime before an alert is triggered
    contactGroups string[]
    List of contact group IDs
    dnsCheck UptimeCheckDnsCheck
    DNS check configuration block. Only one of dns_check, http_check, icmp_check, and tcp_check may be specified
    httpCheck UptimeCheckHttpCheck
    HTTP check configuration block. Only one of dns_check, http_check, icmp_check, and tcp_check may be specified
    icmpCheck UptimeCheckIcmpCheck
    ICMP check configuration block. Only one of dns_check, http_check, icmp_check, and tcp_check may be specified
    locations UptimeCheckLocation[]
    List of assigned monitoring locations on which to run checks
    monitoredResource UptimeCheckMonitoredResource
    Monitored resource configuration block. The describes server under test
    name string
    Name of the check
    paused boolean
    Whether the check should be run
    regions string[]
    List of regions on which to run checks. The values required for this parameter can be retrieved from the GET /v1/uptime-locations endpoint
    tags string[]
    List of tags
    tcpCheck UptimeCheckTcpCheck
    TCP check configuration block. Only one of dns_check, http_check, icmp_check, and tcp_check may be specified
    triggerRate number
    The number of minutes to wait before sending an alert
    check_interval int
    Number of seconds between checks
    confirmation int
    Number of confirmation servers to confirm downtime before an alert is triggered
    contact_groups Sequence[str]
    List of contact group IDs
    dns_check UptimeCheckDnsCheckArgs
    DNS check configuration block. Only one of dns_check, http_check, icmp_check, and tcp_check may be specified
    http_check UptimeCheckHttpCheckArgs
    HTTP check configuration block. Only one of dns_check, http_check, icmp_check, and tcp_check may be specified
    icmp_check UptimeCheckIcmpCheckArgs
    ICMP check configuration block. Only one of dns_check, http_check, icmp_check, and tcp_check may be specified
    locations Sequence[UptimeCheckLocationArgs]
    List of assigned monitoring locations on which to run checks
    monitored_resource UptimeCheckMonitoredResourceArgs
    Monitored resource configuration block. The describes server under test
    name str
    Name of the check
    paused bool
    Whether the check should be run
    regions Sequence[str]
    List of regions on which to run checks. The values required for this parameter can be retrieved from the GET /v1/uptime-locations endpoint
    tags Sequence[str]
    List of tags
    tcp_check UptimeCheckTcpCheckArgs
    TCP check configuration block. Only one of dns_check, http_check, icmp_check, and tcp_check may be specified
    trigger_rate int
    The number of minutes to wait before sending an alert
    checkInterval Number
    Number of seconds between checks
    confirmation Number
    Number of confirmation servers to confirm downtime before an alert is triggered
    contactGroups List<String>
    List of contact group IDs
    dnsCheck Property Map
    DNS check configuration block. Only one of dns_check, http_check, icmp_check, and tcp_check may be specified
    httpCheck Property Map
    HTTP check configuration block. Only one of dns_check, http_check, icmp_check, and tcp_check may be specified
    icmpCheck Property Map
    ICMP check configuration block. Only one of dns_check, http_check, icmp_check, and tcp_check may be specified
    locations List<Property Map>
    List of assigned monitoring locations on which to run checks
    monitoredResource Property Map
    Monitored resource configuration block. The describes server under test
    name String
    Name of the check
    paused Boolean
    Whether the check should be run
    regions List<String>
    List of regions on which to run checks. The values required for this parameter can be retrieved from the GET /v1/uptime-locations endpoint
    tags List<String>
    List of tags
    tcpCheck Property Map
    TCP check configuration block. Only one of dns_check, http_check, icmp_check, and tcp_check may be specified
    triggerRate Number
    The number of minutes to wait before sending an alert

    Supporting Types

    UptimeCheckDnsCheck, UptimeCheckDnsCheckArgs

    DnsIps List<string>
    DnsServer string
    DnsIps []string
    DnsServer string
    dnsIps List<String>
    dnsServer String
    dnsIps string[]
    dnsServer string
    dns_ips Sequence[str]
    dns_server str
    dnsIps List<String>
    dnsServer String

    UptimeCheckHttpCheck, UptimeCheckHttpCheckArgs

    UptimeCheckHttpCheckBasicAuthentication, UptimeCheckHttpCheckBasicAuthenticationArgs

    Password string
    Username string
    Password string
    Username string
    password String
    username String
    password string
    username string
    password String
    username String

    UptimeCheckHttpCheckContentMatchers, UptimeCheckHttpCheckContentMatchersArgs

    Content string
    IncludeHeaders bool
    Matcher string
    Content string
    IncludeHeaders bool
    Matcher string
    content String
    includeHeaders Boolean
    matcher String
    content string
    includeHeaders boolean
    matcher string
    content String
    includeHeaders Boolean
    matcher String

    UptimeCheckIcmpCheck, UptimeCheckIcmpCheckArgs

    Enabled bool
    Enabled bool
    enabled Boolean
    enabled boolean
    enabled bool
    enabled Boolean

    UptimeCheckLocation, UptimeCheckLocationArgs

    Description string
    Ipv4 string
    Ipv6 string
    Region string
    RegionCode string
    Status string
    Description string
    Ipv4 string
    Ipv6 string
    Region string
    RegionCode string
    Status string
    description String
    ipv4 String
    ipv6 String
    region String
    regionCode String
    status String
    description string
    ipv4 string
    ipv6 string
    region string
    regionCode string
    status string
    description String
    ipv4 String
    ipv6 String
    region String
    regionCode String
    status String

    UptimeCheckMonitoredResource, UptimeCheckMonitoredResourceArgs

    Address string
    Host string
    Address string
    Host string
    address String
    host String
    address string
    host string
    address str
    host str
    address String
    host String

    UptimeCheckTcpCheck, UptimeCheckTcpCheckArgs

    UptimeCheckTcpCheckAuthentication, UptimeCheckTcpCheckAuthenticationArgs

    Password string
    Username string
    Password string
    Username string
    password String
    username String
    password string
    username string
    password String
    username String

    Package Details

    Repository
    statuscake pulumiverse/pulumi-statuscake
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the statuscake Terraform Provider.
    statuscake logo
    Statuscake v1.0.2 published on Sunday, Oct 8, 2023 by Pulumiverse
    pulumiverse/pulumi-statuscake