1. Packages
  2. Constellix Provider
  3. API Docs
  4. getHttpCheck
constellix 0.4.6 published on Friday, Mar 7, 2025 by constellix

constellix.getHttpCheck

Explore with Pulumi AI

constellix logo
constellix 0.4.6 published on Friday, Mar 7, 2025 by constellix

    Data source for HTTP check resource

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as constellix from "@pulumi/constellix";
    
    const check = constellix.getHttpCheck({
        name: "http check",
    });
    
    import pulumi
    import pulumi_constellix as constellix
    
    check = constellix.get_http_check(name="http check")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/constellix/constellix"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := constellix.LookupHttpCheck(ctx, &constellix.LookupHttpCheckArgs{
    			Name: "http check",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Constellix = Pulumi.Constellix;
    
    return await Deployment.RunAsync(() => 
    {
        var check = Constellix.GetHttpCheck.Invoke(new()
        {
            Name = "http check",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.constellix.ConstellixFunctions;
    import com.pulumi.constellix.inputs.GetHttpCheckArgs;
    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) {
            final var check = ConstellixFunctions.getHttpCheck(GetHttpCheckArgs.builder()
                .name("http check")
                .build());
    
        }
    }
    
    variables:
      check:
        fn::invoke:
          function: constellix:getHttpCheck
          arguments:
            name: http check
    

    Argument Reference

    • name - (Required) Name of resource. Name should be unique.

    Attribute Reference

    • name - (Required) name of the resource. Name should be unique.
    • host - (Optional) Host for the resource, for example “constellix.com”. It can be set only once.
    • ip_version - (Optional) Specifies the version of IP. It can be set only once.
    • port - (Optional) Specifies the port number.
    • protocol_type - (Optional) Specifies upper layer protocol like HTTP, HTTPs, etc.
    • check_sites - (Optional) Site ids to check.
    • notification_groups - (Optional) List of group IDs for the notification group of HTTP Check.
    • interval - (Optional) Check Interval. Allowed values are THIRTYSECONDS, ONEMINUTE, TWOMINUTES, THREEMINUTES, FOURMINUTES, FIVEMINUTES, TENMINUTES, THIRTYMINUTES, HALFDAY and DAY.
    • interval_policy - (Optional) Agent Interval Run Policy. It specifies whether you want to run checks from one location or all. Allowed values are PARALLEL, ONCEPERSITE and ONCEPERREGION.
    • verification_policy - (Optional) Specifies how the check should be validated. Allowed values are SIMPLE and MAJORITY. This parameter will only work with the interval_policy set to PARALLEL.
    • fqdn - (Optional) Fully qualified domain name of the URL should be checked.
    • path - (Optional) In case of multi-page site, which path should be checked.
    • search_string - (Optional) String to search in the first 2KB of resonse received.
    • expected_status_code - (Optional) Expected HTTP status code for this check.

    Using getHttpCheck

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getHttpCheck(args: GetHttpCheckArgs, opts?: InvokeOptions): Promise<GetHttpCheckResult>
    function getHttpCheckOutput(args: GetHttpCheckOutputArgs, opts?: InvokeOptions): Output<GetHttpCheckResult>
    def get_http_check(check_sites: Optional[Sequence[float]] = None,
                       expected_status_code: Optional[float] = None,
                       fqdn: Optional[str] = None,
                       host: Optional[str] = None,
                       id: Optional[str] = None,
                       interval: Optional[str] = None,
                       interval_policy: Optional[str] = None,
                       ip_version: Optional[str] = None,
                       name: Optional[str] = None,
                       notification_groups: Optional[Sequence[float]] = None,
                       notification_report_timeout: Optional[float] = None,
                       path: Optional[str] = None,
                       port: Optional[float] = None,
                       protocol_type: Optional[str] = None,
                       search_string: Optional[str] = None,
                       verification_policy: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetHttpCheckResult
    def get_http_check_output(check_sites: Optional[pulumi.Input[Sequence[pulumi.Input[float]]]] = None,
                       expected_status_code: Optional[pulumi.Input[float]] = None,
                       fqdn: Optional[pulumi.Input[str]] = None,
                       host: Optional[pulumi.Input[str]] = None,
                       id: Optional[pulumi.Input[str]] = None,
                       interval: Optional[pulumi.Input[str]] = None,
                       interval_policy: Optional[pulumi.Input[str]] = None,
                       ip_version: Optional[pulumi.Input[str]] = None,
                       name: Optional[pulumi.Input[str]] = None,
                       notification_groups: Optional[pulumi.Input[Sequence[pulumi.Input[float]]]] = None,
                       notification_report_timeout: Optional[pulumi.Input[float]] = None,
                       path: Optional[pulumi.Input[str]] = None,
                       port: Optional[pulumi.Input[float]] = None,
                       protocol_type: Optional[pulumi.Input[str]] = None,
                       search_string: Optional[pulumi.Input[str]] = None,
                       verification_policy: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetHttpCheckResult]
    func LookupHttpCheck(ctx *Context, args *LookupHttpCheckArgs, opts ...InvokeOption) (*LookupHttpCheckResult, error)
    func LookupHttpCheckOutput(ctx *Context, args *LookupHttpCheckOutputArgs, opts ...InvokeOption) LookupHttpCheckResultOutput

    > Note: This function is named LookupHttpCheck in the Go SDK.

    public static class GetHttpCheck 
    {
        public static Task<GetHttpCheckResult> InvokeAsync(GetHttpCheckArgs args, InvokeOptions? opts = null)
        public static Output<GetHttpCheckResult> Invoke(GetHttpCheckInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetHttpCheckResult> getHttpCheck(GetHttpCheckArgs args, InvokeOptions options)
    public static Output<GetHttpCheckResult> getHttpCheck(GetHttpCheckArgs args, InvokeOptions options)
    
    fn::invoke:
      function: constellix:index/getHttpCheck:getHttpCheck
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    CheckSites List<double>
    ExpectedStatusCode double
    Fqdn string
    Host string
    Id string
    Interval string
    IntervalPolicy string
    IpVersion string
    NotificationGroups List<double>
    NotificationReportTimeout double
    Path string
    Port double
    ProtocolType string
    SearchString string
    VerificationPolicy string
    Name string
    CheckSites []float64
    ExpectedStatusCode float64
    Fqdn string
    Host string
    Id string
    Interval string
    IntervalPolicy string
    IpVersion string
    NotificationGroups []float64
    NotificationReportTimeout float64
    Path string
    Port float64
    ProtocolType string
    SearchString string
    VerificationPolicy string
    name String
    checkSites List<Double>
    expectedStatusCode Double
    fqdn String
    host String
    id String
    interval String
    intervalPolicy String
    ipVersion String
    notificationGroups List<Double>
    notificationReportTimeout Double
    path String
    port Double
    protocolType String
    searchString String
    verificationPolicy String
    name string
    checkSites number[]
    expectedStatusCode number
    fqdn string
    host string
    id string
    interval string
    intervalPolicy string
    ipVersion string
    notificationGroups number[]
    notificationReportTimeout number
    path string
    port number
    protocolType string
    searchString string
    verificationPolicy string
    name String
    checkSites List<Number>
    expectedStatusCode Number
    fqdn String
    host String
    id String
    interval String
    intervalPolicy String
    ipVersion String
    notificationGroups List<Number>
    notificationReportTimeout Number
    path String
    port Number
    protocolType String
    searchString String
    verificationPolicy String

    getHttpCheck Result

    The following output properties are available:

    CheckSites List<double>
    ExpectedStatusCode double
    Fqdn string
    Host string
    Id string
    Interval string
    IntervalPolicy string
    IpVersion string
    Name string
    NotificationGroups List<double>
    NotificationReportTimeout double
    Path string
    Port double
    ProtocolType string
    SearchString string
    VerificationPolicy string
    CheckSites []float64
    ExpectedStatusCode float64
    Fqdn string
    Host string
    Id string
    Interval string
    IntervalPolicy string
    IpVersion string
    Name string
    NotificationGroups []float64
    NotificationReportTimeout float64
    Path string
    Port float64
    ProtocolType string
    SearchString string
    VerificationPolicy string
    checkSites List<Double>
    expectedStatusCode Double
    fqdn String
    host String
    id String
    interval String
    intervalPolicy String
    ipVersion String
    name String
    notificationGroups List<Double>
    notificationReportTimeout Double
    path String
    port Double
    protocolType String
    searchString String
    verificationPolicy String
    checkSites number[]
    expectedStatusCode number
    fqdn string
    host string
    id string
    interval string
    intervalPolicy string
    ipVersion string
    name string
    notificationGroups number[]
    notificationReportTimeout number
    path string
    port number
    protocolType string
    searchString string
    verificationPolicy string
    checkSites List<Number>
    expectedStatusCode Number
    fqdn String
    host String
    id String
    interval String
    intervalPolicy String
    ipVersion String
    name String
    notificationGroups List<Number>
    notificationReportTimeout Number
    path String
    port Number
    protocolType String
    searchString String
    verificationPolicy String

    Package Details

    Repository
    constellix constellix/terraform-provider-constellix
    License
    Notes
    This Pulumi package is based on the constellix Terraform Provider.
    constellix logo
    constellix 0.4.6 published on Friday, Mar 7, 2025 by constellix