Class HealthcheckArgs

Inheritance

System.Object

InputArgs

ResourceArgs

HealthcheckArgs

Inherited Members

ResourceArgs.Empty

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Cloudflare

Assembly: Pulumi.Cloudflare.dll

Syntax

public sealed class HealthcheckArgs : ResourceArgs

Constructors

HealthcheckArgs()

Declaration

public HealthcheckArgs()

Properties

Address

The hostname or IP address of the origin server to run health checks on.

Declaration

public Input<string> Address { get; set; }

Property Value

Type	Description
Input<System.String>

AllowInsecure

Do not validate the certificate when the health check uses HTTPS. Valid values: true or false (Default: false).

Declaration

public Input<bool> AllowInsecure { get; set; }

Property Value

Type	Description
Input<System.Boolean>

CheckRegions

A list of regions from which to run health checks. If not set Cloudflare will pick a default region. Valid values: WNAM, ENAM, WEU, EEU, NSAM, SSAM, OC, ME, NAF, SAF, IN, SEAS, NEAS, ALL_REGIONS.

Declaration

public InputList<string> CheckRegions { get; set; }

Property Value

Type	Description
InputList<System.String>

ConsecutiveFails

The number of consecutive fails required from a health check before changing the health to unhealthy. (Default: 1)

Declaration

public Input<int> ConsecutiveFails { get; set; }

Property Value

Type	Description
Input<System.Int32>

ConsecutiveSuccesses

The number of consecutive successes required from a health check before changing the health to healthy. (Default: 1)

Declaration

public Input<int> ConsecutiveSuccesses { get; set; }

Property Value

Type	Description
Input<System.Int32>

Description

A human-readable description of the health check.

Declaration

public Input<string> Description { get; set; }

Property Value

Type	Description
Input<System.String>

ExpectedBody

A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy.

Declaration

public Input<string> ExpectedBody { get; set; }

Property Value

Type	Description
Input<System.String>

ExpectedCodes

The expected HTTP response codes (e.g. "200") or code ranges (e.g. "2xx" for all codes starting with 2) of the health check. (Default: ["200"])

Declaration

public InputList<string> ExpectedCodes { get; set; }

Property Value

Type	Description
InputList<System.String>

FollowRedirects

Follow redirects if the origin returns a 3xx status code. Valid values: true or false (Default: false).

Declaration

public Input<bool> FollowRedirects { get; set; }

Property Value

Type	Description
Input<System.Boolean>

Headers

The header name.

Declaration

public InputList<HealthcheckHeaderArgs> Headers { get; set; }

Property Value

Type	Description
InputList<HealthcheckHeaderArgs>

Interval

The interval between each health check. Shorter intervals may give quicker notifications if the origin status changes, but will increase load on the origin as we check from multiple locations. (Default: 60)

Declaration

public Input<int> Interval { get; set; }

Property Value

Type	Description
Input<System.Int32>

Method

The TCP connection method to use for the health check. Valid values: connection_established (Default: connection_established).

Declaration

public Input<string> Method { get; set; }

Property Value

Type	Description
Input<System.String>

Name

A short name to identify the health check. Only alphanumeric characters, hyphens and underscores are allowed.

Declaration

public Input<string> Name { get; set; }

Property Value

Type	Description
Input<System.String>

NotificationEmailAddresses

A list of email addresses we want to send the notifications to.

Declaration

public InputList<string> NotificationEmailAddresses { get; set; }

Property Value

Type	Description
InputList<System.String>

NotificationSuspended

Whether the notifications are suspended or not. Useful for maintenance periods. Valid values: true or false (Default: false).

Declaration

public Input<bool> NotificationSuspended { get; set; }

Property Value

Type	Description
Input<System.Boolean>

Path

The endpoint path to health check against. (Default: /)

Declaration

public Input<string> Path { get; set; }

Property Value

Type	Description
Input<System.String>

Port

Port number to connect to for the health check. Valid values are in the rage 0-65535 (Default: 80).

Declaration

public Input<int> Port { get; set; }

Property Value

Type	Description
Input<System.Int32>

Retries

The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately. (Default: 2)

Declaration

public Input<int> Retries { get; set; }

Property Value

Type	Description
Input<System.Int32>

Suspended

If suspended, no health checks are sent to the origin. Valid values: true or false (Default: false).

Declaration

public Input<bool> Suspended { get; set; }

Property Value

Type	Description
Input<System.Boolean>

Timeout

The timeout (in seconds) before marking the health check as failed. (Default: 5)

Declaration

public Input<int> Timeout { get; set; }

Property Value

Type	Description
Input<System.Int32>

Type

The protocol to use for the health check. Valid values: HTTP, HTTPS, TCP.

Declaration

public Input<string> Type { get; set; }

Property Value

Type	Description
Input<System.String>

ZoneId

The DNS zone ID to which apply settings.

Declaration

public Input<string> ZoneId { get; set; }

Property Value

Type	Description
Input<System.String>