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

constellix.HttpCheck

Explore with Pulumi AI

Create HttpCheck Resource

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

Constructor syntax

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

@overload
def HttpCheck(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              ip_version: Optional[str] = None,
              protocol_type: Optional[str] = None,
              port: Optional[float] = None,
              host: Optional[str] = None,
              check_sites: Optional[Sequence[float]] = None,
              http_check_id: Optional[str] = None,
              interval_policy: Optional[str] = None,
              interval: Optional[str] = None,
              name: Optional[str] = None,
              notification_groups: Optional[Sequence[float]] = None,
              notification_report_timeout: Optional[float] = None,
              path: Optional[str] = None,
              fqdn: Optional[str] = None,
              expected_status_code: Optional[float] = None,
              search_string: Optional[str] = None,
              verification_policy: Optional[str] = None)
func NewHttpCheck(ctx *Context, name string, args HttpCheckArgs, opts ...ResourceOption) (*HttpCheck, error)
public HttpCheck(string name, HttpCheckArgs args, CustomResourceOptions? opts = null)
public HttpCheck(String name, HttpCheckArgs args)
public HttpCheck(String name, HttpCheckArgs args, CustomResourceOptions options)
type: constellix:HttpCheck
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. HttpCheckArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. HttpCheckArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. HttpCheckArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. HttpCheckArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. HttpCheckArgs
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 httpCheckResource = new Constellix.HttpCheck("httpCheckResource", new()
{
    IpVersion = "string",
    ProtocolType = "string",
    Port = 0,
    Host = "string",
    CheckSites = new[]
    {
        0,
    },
    HttpCheckId = "string",
    IntervalPolicy = "string",
    Interval = "string",
    Name = "string",
    NotificationGroups = new[]
    {
        0,
    },
    NotificationReportTimeout = 0,
    Path = "string",
    Fqdn = "string",
    ExpectedStatusCode = 0,
    SearchString = "string",
    VerificationPolicy = "string",
});
Copy
example, err := constellix.NewHttpCheck(ctx, "httpCheckResource", &constellix.HttpCheckArgs{
	IpVersion:    pulumi.String("string"),
	ProtocolType: pulumi.String("string"),
	Port:         pulumi.Float64(0),
	Host:         pulumi.String("string"),
	CheckSites: pulumi.Float64Array{
		pulumi.Float64(0),
	},
	HttpCheckId:    pulumi.String("string"),
	IntervalPolicy: pulumi.String("string"),
	Interval:       pulumi.String("string"),
	Name:           pulumi.String("string"),
	NotificationGroups: pulumi.Float64Array{
		pulumi.Float64(0),
	},
	NotificationReportTimeout: pulumi.Float64(0),
	Path:                      pulumi.String("string"),
	Fqdn:                      pulumi.String("string"),
	ExpectedStatusCode:        pulumi.Float64(0),
	SearchString:              pulumi.String("string"),
	VerificationPolicy:        pulumi.String("string"),
})
Copy
var httpCheckResource = new HttpCheck("httpCheckResource", HttpCheckArgs.builder()
    .ipVersion("string")
    .protocolType("string")
    .port(0)
    .host("string")
    .checkSites(0)
    .httpCheckId("string")
    .intervalPolicy("string")
    .interval("string")
    .name("string")
    .notificationGroups(0)
    .notificationReportTimeout(0)
    .path("string")
    .fqdn("string")
    .expectedStatusCode(0)
    .searchString("string")
    .verificationPolicy("string")
    .build());
Copy
http_check_resource = constellix.HttpCheck("httpCheckResource",
    ip_version="string",
    protocol_type="string",
    port=0,
    host="string",
    check_sites=[0],
    http_check_id="string",
    interval_policy="string",
    interval="string",
    name="string",
    notification_groups=[0],
    notification_report_timeout=0,
    path="string",
    fqdn="string",
    expected_status_code=0,
    search_string="string",
    verification_policy="string")
Copy
const httpCheckResource = new constellix.HttpCheck("httpCheckResource", {
    ipVersion: "string",
    protocolType: "string",
    port: 0,
    host: "string",
    checkSites: [0],
    httpCheckId: "string",
    intervalPolicy: "string",
    interval: "string",
    name: "string",
    notificationGroups: [0],
    notificationReportTimeout: 0,
    path: "string",
    fqdn: "string",
    expectedStatusCode: 0,
    searchString: "string",
    verificationPolicy: "string",
});
Copy
type: constellix:HttpCheck
properties:
    checkSites:
        - 0
    expectedStatusCode: 0
    fqdn: string
    host: string
    httpCheckId: string
    interval: string
    intervalPolicy: string
    ipVersion: string
    name: string
    notificationGroups:
        - 0
    notificationReportTimeout: 0
    path: string
    port: 0
    protocolType: string
    searchString: string
    verificationPolicy: string
Copy

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

CheckSites This property is required. List<double>
Host This property is required. string
IpVersion This property is required. string
Port This property is required. double
ProtocolType This property is required. string
ExpectedStatusCode double
Fqdn string
HttpCheckId string
Interval string
IntervalPolicy string
Name string
NotificationGroups List<double>
NotificationReportTimeout double
Path string
SearchString string
VerificationPolicy string
CheckSites This property is required. []float64
Host This property is required. string
IpVersion This property is required. string
Port This property is required. float64
ProtocolType This property is required. string
ExpectedStatusCode float64
Fqdn string
HttpCheckId string
Interval string
IntervalPolicy string
Name string
NotificationGroups []float64
NotificationReportTimeout float64
Path string
SearchString string
VerificationPolicy string
checkSites This property is required. List<Double>
host This property is required. String
ipVersion This property is required. String
port This property is required. Double
protocolType This property is required. String
expectedStatusCode Double
fqdn String
httpCheckId String
interval String
intervalPolicy String
name String
notificationGroups List<Double>
notificationReportTimeout Double
path String
searchString String
verificationPolicy String
checkSites This property is required. number[]
host This property is required. string
ipVersion This property is required. string
port This property is required. number
protocolType This property is required. string
expectedStatusCode number
fqdn string
httpCheckId string
interval string
intervalPolicy string
name string
notificationGroups number[]
notificationReportTimeout number
path string
searchString string
verificationPolicy string
check_sites This property is required. Sequence[float]
host This property is required. str
ip_version This property is required. str
port This property is required. float
protocol_type This property is required. str
expected_status_code float
fqdn str
http_check_id str
interval str
interval_policy str
name str
notification_groups Sequence[float]
notification_report_timeout float
path str
search_string str
verification_policy str
checkSites This property is required. List<Number>
host This property is required. String
ipVersion This property is required. String
port This property is required. Number
protocolType This property is required. String
expectedStatusCode Number
fqdn String
httpCheckId String
interval String
intervalPolicy String
name String
notificationGroups List<Number>
notificationReportTimeout Number
path String
searchString String
verificationPolicy String

Outputs

All input properties are implicitly available as output properties. Additionally, the HttpCheck 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 HttpCheck Resource

Get an existing HttpCheck 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?: HttpCheckState, opts?: CustomResourceOptions): HttpCheck
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        check_sites: Optional[Sequence[float]] = None,
        expected_status_code: Optional[float] = None,
        fqdn: Optional[str] = None,
        host: Optional[str] = None,
        http_check_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) -> HttpCheck
func GetHttpCheck(ctx *Context, name string, id IDInput, state *HttpCheckState, opts ...ResourceOption) (*HttpCheck, error)
public static HttpCheck Get(string name, Input<string> id, HttpCheckState? state, CustomResourceOptions? opts = null)
public static HttpCheck get(String name, Output<String> id, HttpCheckState state, CustomResourceOptions options)
resources:  _:    type: constellix:HttpCheck    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
CheckSites List<double>
ExpectedStatusCode double
Fqdn string
Host string
HttpCheckId 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
HttpCheckId 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
httpCheckId 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 List<Number>
expectedStatusCode Number
fqdn String
host String
httpCheckId 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.