healthcheck

package
v12.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 7, 2025 License: MPL-2.0 Imports: 7 Imported by: 0

README

cloudflare_healthcheck

Refer to the Terraform Registry for docs: cloudflare_healthcheck.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Healthcheck_GenerateConfigForImport 

func Healthcheck_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, provider cdktf.TerraformProvider) cdktf.ImportableResource

Generates CDKTF code for importing a Healthcheck resource upon running "cdktf plan <stack-name>".

func Healthcheck_IsConstruct 

func Healthcheck_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.

Returns: true if `x` is an object created from a class which extends `Construct`.

func Healthcheck_IsTerraformElement 

func Healthcheck_IsTerraformElement(x interface{}) *bool

Experimental.

func Healthcheck_IsTerraformResource 

func Healthcheck_IsTerraformResource(x interface{}) *bool

Experimental.

func Healthcheck_TfResourceType 

func Healthcheck_TfResourceType() *string

func NewHealthcheckHttpConfigOutputReference_Override 

func NewHealthcheckHttpConfigOutputReference_Override(h HealthcheckHttpConfigOutputReference, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string)

func NewHealthcheckTcpConfigOutputReference_Override 

func NewHealthcheckTcpConfigOutputReference_Override(h HealthcheckTcpConfigOutputReference, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string)

func NewHealthcheck_Override 

func NewHealthcheck_Override(h Healthcheck, scope constructs.Construct, id *string, config *HealthcheckConfig)

Create a new {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.0.0/docs/resources/healthcheck cloudflare_healthcheck} Resource.

Types

type Healthcheck 

type Healthcheck interface {
	cdktf.TerraformResource
	Address() *string
	SetAddress(val *string)
	AddressInput() *string
	// Experimental.
	CdktfStack() cdktf.TerraformStack
	CheckRegions() *[]*string
	SetCheckRegions(val *[]*string)
	CheckRegionsInput() *[]*string
	// Experimental.
	Connection() interface{}
	// Experimental.
	SetConnection(val interface{})
	ConsecutiveFails() *float64
	SetConsecutiveFails(val *float64)
	ConsecutiveFailsInput() *float64
	ConsecutiveSuccesses() *float64
	SetConsecutiveSuccesses(val *float64)
	ConsecutiveSuccessesInput() *float64
	// Experimental.
	ConstructNodeMetadata() *map[string]interface{}
	// Experimental.
	Count() interface{}
	// Experimental.
	SetCount(val interface{})
	CreatedOn() *string
	// Experimental.
	DependsOn() *[]*string
	// Experimental.
	SetDependsOn(val *[]*string)
	Description() *string
	SetDescription(val *string)
	DescriptionInput() *string
	FailureReason() *string
	// Experimental.
	ForEach() cdktf.ITerraformIterator
	// Experimental.
	SetForEach(val cdktf.ITerraformIterator)
	// Experimental.
	Fqn() *string
	// Experimental.
	FriendlyUniqueId() *string
	HttpConfig() HealthcheckHttpConfigOutputReference
	HttpConfigInput() interface{}
	Id() *string
	Interval() *float64
	SetInterval(val *float64)
	IntervalInput() *float64
	// Experimental.
	Lifecycle() *cdktf.TerraformResourceLifecycle
	// Experimental.
	SetLifecycle(val *cdktf.TerraformResourceLifecycle)
	ModifiedOn() *string
	Name() *string
	SetName(val *string)
	NameInput() *string
	// The tree node.
	Node() constructs.Node
	// Experimental.
	Provider() cdktf.TerraformProvider
	// Experimental.
	SetProvider(val cdktf.TerraformProvider)
	// Experimental.
	Provisioners() *[]interface{}
	// Experimental.
	SetProvisioners(val *[]interface{})
	// Experimental.
	RawOverrides() interface{}
	Retries() *float64
	SetRetries(val *float64)
	RetriesInput() *float64
	Status() *string
	Suspended() interface{}
	SetSuspended(val interface{})
	SuspendedInput() interface{}
	TcpConfig() HealthcheckTcpConfigOutputReference
	TcpConfigInput() interface{}
	// Experimental.
	TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
	// Experimental.
	TerraformMetaArguments() *map[string]interface{}
	// Experimental.
	TerraformResourceType() *string
	Timeout() *float64
	SetTimeout(val *float64)
	TimeoutInput() *float64
	Type() *string
	SetType(val *string)
	TypeInput() *string
	ZoneId() *string
	SetZoneId(val *string)
	ZoneIdInput() *string
	// Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
	// Experimental.
	AddMoveTarget(moveTarget *string)
	// Experimental.
	AddOverride(path *string, value interface{})
	// Experimental.
	GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
	// Experimental.
	GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable
	// Experimental.
	GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
	// Experimental.
	GetListAttribute(terraformAttribute *string) *[]*string
	// Experimental.
	GetNumberAttribute(terraformAttribute *string) *float64
	// Experimental.
	GetNumberListAttribute(terraformAttribute *string) *[]*float64
	// Experimental.
	GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64
	// Experimental.
	GetStringAttribute(terraformAttribute *string) *string
	// Experimental.
	GetStringMapAttribute(terraformAttribute *string) *map[string]*string
	// Experimental.
	HasResourceMove() interface{}
	// Experimental.
	ImportFrom(id *string, provider cdktf.TerraformProvider)
	// Experimental.
	InterpolationForAttribute(terraformAttribute *string) cdktf.IResolvable
	// Move the resource corresponding to "id" to this resource.
	//
	// Note that the resource being moved from must be marked as moved using it's instance function.
	// Experimental.
	MoveFromId(id *string)
	// Moves this resource to the target resource given by moveTarget.
	// Experimental.
	MoveTo(moveTarget *string, index interface{})
	// Moves this resource to the resource corresponding to "id".
	// Experimental.
	MoveToId(id *string)
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	PutHttpConfig(value *HealthcheckHttpConfig)
	PutTcpConfig(value *HealthcheckTcpConfig)
	ResetCheckRegions()
	ResetConsecutiveFails()
	ResetConsecutiveSuccesses()
	ResetDescription()
	ResetHttpConfig()
	ResetInterval()
	// Resets a previously passed logical Id to use the auto-generated logical id again.
	// Experimental.
	ResetOverrideLogicalId()
	ResetRetries()
	ResetSuspended()
	ResetTcpConfig()
	ResetTimeout()
	ResetType()
	SynthesizeAttributes() *map[string]interface{}
	SynthesizeHclAttributes() *map[string]interface{}
	// Experimental.
	ToHclTerraform() interface{}
	// Experimental.
	ToMetadata() interface{}
	// Returns a string representation of this construct.
	ToString() *string
	// Adds this resource to the terraform JSON output.
	// Experimental.
	ToTerraform() interface{}
}

Represents a {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.0.0/docs/resources/healthcheck cloudflare_healthcheck}.

func NewHealthcheck 

func NewHealthcheck(scope constructs.Construct, id *string, config *HealthcheckConfig) Healthcheck

Create a new {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.0.0/docs/resources/healthcheck cloudflare_healthcheck} Resource.

type HealthcheckConfig 

type HealthcheckConfig struct {
	// Experimental.
	Connection interface{} `field:"optional" json:"connection" yaml:"connection"`
	// Experimental.
	Count interface{} `field:"optional" json:"count" yaml:"count"`
	// Experimental.
	DependsOn *[]cdktf.ITerraformDependable `field:"optional" json:"dependsOn" yaml:"dependsOn"`
	// Experimental.
	ForEach cdktf.ITerraformIterator `field:"optional" json:"forEach" yaml:"forEach"`
	// Experimental.
	Lifecycle *cdktf.TerraformResourceLifecycle `field:"optional" json:"lifecycle" yaml:"lifecycle"`
	// Experimental.
	Provider cdktf.TerraformProvider `field:"optional" json:"provider" yaml:"provider"`
	// Experimental.
	Provisioners *[]interface{} `field:"optional" json:"provisioners" yaml:"provisioners"`
	// The hostname or IP address of the origin server to run health checks on.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.0.0/docs/resources/healthcheck#address Healthcheck#address}
	Address *string `field:"required" json:"address" yaml:"address"`
	// A short name to identify the health check. Only alphanumeric characters, hyphens and underscores are allowed.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.0.0/docs/resources/healthcheck#name Healthcheck#name}
	Name *string `field:"required" json:"name" yaml:"name"`
	// Identifier.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.0.0/docs/resources/healthcheck#zone_id Healthcheck#zone_id}
	ZoneId *string `field:"required" json:"zoneId" yaml:"zoneId"`
	// A list of regions from which to run health checks. Null means Cloudflare will pick a default region.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.0.0/docs/resources/healthcheck#check_regions Healthcheck#check_regions}
	CheckRegions *[]*string `field:"optional" json:"checkRegions" yaml:"checkRegions"`
	// The number of consecutive fails required from a health check before changing the health to unhealthy.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.0.0/docs/resources/healthcheck#consecutive_fails Healthcheck#consecutive_fails}
	ConsecutiveFails *float64 `field:"optional" json:"consecutiveFails" yaml:"consecutiveFails"`
	// The number of consecutive successes required from a health check before changing the health to healthy.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.0.0/docs/resources/healthcheck#consecutive_successes Healthcheck#consecutive_successes}
	ConsecutiveSuccesses *float64 `field:"optional" json:"consecutiveSuccesses" yaml:"consecutiveSuccesses"`
	// A human-readable description of the health check.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.0.0/docs/resources/healthcheck#description Healthcheck#description}
	Description *string `field:"optional" json:"description" yaml:"description"`
	// Parameters specific to an HTTP or HTTPS health check.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.0.0/docs/resources/healthcheck#http_config Healthcheck#http_config}
	HttpConfig *HealthcheckHttpConfig `field:"optional" json:"httpConfig" yaml:"httpConfig"`
	// 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.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.0.0/docs/resources/healthcheck#interval Healthcheck#interval}
	Interval *float64 `field:"optional" json:"interval" yaml:"interval"`
	// The number of retries to attempt in case of a timeout before marking the origin as unhealthy.
	//
	// Retries are attempted immediately.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.0.0/docs/resources/healthcheck#retries Healthcheck#retries}
	Retries *float64 `field:"optional" json:"retries" yaml:"retries"`
	// If suspended, no health checks are sent to the origin.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.0.0/docs/resources/healthcheck#suspended Healthcheck#suspended}
	Suspended interface{} `field:"optional" json:"suspended" yaml:"suspended"`
	// Parameters specific to TCP health check.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.0.0/docs/resources/healthcheck#tcp_config Healthcheck#tcp_config}
	TcpConfig *HealthcheckTcpConfig `field:"optional" json:"tcpConfig" yaml:"tcpConfig"`
	// The timeout (in seconds) before marking the health check as failed.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.0.0/docs/resources/healthcheck#timeout Healthcheck#timeout}
	Timeout *float64 `field:"optional" json:"timeout" yaml:"timeout"`
	// The protocol to use for the health check. Currently supported protocols are 'HTTP', 'HTTPS' and 'TCP'.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.0.0/docs/resources/healthcheck#type Healthcheck#type}
	Type *string `field:"optional" json:"type" yaml:"type"`
}

type HealthcheckHttpConfig 

type HealthcheckHttpConfig struct {
	// Do not validate the certificate when the health check uses HTTPS.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.0.0/docs/resources/healthcheck#allow_insecure Healthcheck#allow_insecure}
	AllowInsecure interface{} `field:"optional" json:"allowInsecure" yaml:"allowInsecure"`
	// 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.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.0.0/docs/resources/healthcheck#expected_body Healthcheck#expected_body}
	ExpectedBody *string `field:"optional" json:"expectedBody" yaml:"expectedBody"`
	// The expected HTTP response codes (e.g. "200") or code ranges (e.g. "2xx" for all codes starting with 2) of the health check.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.0.0/docs/resources/healthcheck#expected_codes Healthcheck#expected_codes}
	ExpectedCodes *[]*string `field:"optional" json:"expectedCodes" yaml:"expectedCodes"`
	// Follow redirects if the origin returns a 3xx status code.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.0.0/docs/resources/healthcheck#follow_redirects Healthcheck#follow_redirects}
	FollowRedirects interface{} `field:"optional" json:"followRedirects" yaml:"followRedirects"`
	// The HTTP request headers to send in the health check.
	//
	// It is recommended you set a Host header by default. The User-Agent header cannot be overridden.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.0.0/docs/resources/healthcheck#header Healthcheck#header}
	Header interface{} `field:"optional" json:"header" yaml:"header"`
	// The HTTP method to use for the health check.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.0.0/docs/resources/healthcheck#method Healthcheck#method}
	Method *string `field:"optional" json:"method" yaml:"method"`
	// The endpoint path to health check against.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.0.0/docs/resources/healthcheck#path Healthcheck#path}
	Path *string `field:"optional" json:"path" yaml:"path"`
	// Port number to connect to for the health check.
	//
	// Defaults to 80 if type is HTTP or 443 if type is HTTPS.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.0.0/docs/resources/healthcheck#port Healthcheck#port}
	Port *float64 `field:"optional" json:"port" yaml:"port"`
}

type HealthcheckHttpConfigOutputReference 

type HealthcheckHttpConfigOutputReference interface {
	cdktf.ComplexObject
	AllowInsecure() interface{}
	SetAllowInsecure(val interface{})
	AllowInsecureInput() interface{}
	// the index of the complex object in a list.
	// Experimental.
	ComplexObjectIndex() interface{}
	// Experimental.
	SetComplexObjectIndex(val interface{})
	// set to true if this item is from inside a set and needs tolist() for accessing it set to "0" for single list items.
	// Experimental.
	ComplexObjectIsFromSet() *bool
	// Experimental.
	SetComplexObjectIsFromSet(val *bool)
	// The creation stack of this resolvable which will be appended to errors thrown during resolution.
	//
	// If this returns an empty array the stack will not be attached.
	// Experimental.
	CreationStack() *[]*string
	ExpectedBody() *string
	SetExpectedBody(val *string)
	ExpectedBodyInput() *string
	ExpectedCodes() *[]*string
	SetExpectedCodes(val *[]*string)
	ExpectedCodesInput() *[]*string
	FollowRedirects() interface{}
	SetFollowRedirects(val interface{})
	FollowRedirectsInput() interface{}
	// Experimental.
	Fqn() *string
	Header() interface{}
	SetHeader(val interface{})
	HeaderInput() interface{}
	InternalValue() interface{}
	SetInternalValue(val interface{})
	Method() *string
	SetMethod(val *string)
	MethodInput() *string
	Path() *string
	SetPath(val *string)
	PathInput() *string
	Port() *float64
	SetPort(val *float64)
	PortInput() *float64
	// Experimental.
	TerraformAttribute() *string
	// Experimental.
	SetTerraformAttribute(val *string)
	// Experimental.
	TerraformResource() cdktf.IInterpolatingParent
	// Experimental.
	SetTerraformResource(val cdktf.IInterpolatingParent)
	// Experimental.
	ComputeFqn() *string
	// Experimental.
	GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
	// Experimental.
	GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable
	// Experimental.
	GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
	// Experimental.
	GetListAttribute(terraformAttribute *string) *[]*string
	// Experimental.
	GetNumberAttribute(terraformAttribute *string) *float64
	// Experimental.
	GetNumberListAttribute(terraformAttribute *string) *[]*float64
	// Experimental.
	GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64
	// Experimental.
	GetStringAttribute(terraformAttribute *string) *string
	// Experimental.
	GetStringMapAttribute(terraformAttribute *string) *map[string]*string
	// Experimental.
	InterpolationAsList() cdktf.IResolvable
	// Experimental.
	InterpolationForAttribute(property *string) cdktf.IResolvable
	ResetAllowInsecure()
	ResetExpectedBody()
	ResetExpectedCodes()
	ResetFollowRedirects()
	ResetHeader()
	ResetMethod()
	ResetPath()
	ResetPort()
	// Produce the Token's value at resolution time.
	// Experimental.
	Resolve(_context cdktf.IResolveContext) interface{}
	// Return a string representation of this resolvable object.
	//
	// Returns a reversible string representation.
	// Experimental.
	ToString() *string
}

func NewHealthcheckHttpConfigOutputReference 

func NewHealthcheckHttpConfigOutputReference(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string) HealthcheckHttpConfigOutputReference

type HealthcheckTcpConfig 

type HealthcheckTcpConfig struct {
	// The TCP connection method to use for the health check.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.0.0/docs/resources/healthcheck#method Healthcheck#method}
	Method *string `field:"optional" json:"method" yaml:"method"`
	// Port number to connect to for the health check. Defaults to 80.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.0.0/docs/resources/healthcheck#port Healthcheck#port}
	Port *float64 `field:"optional" json:"port" yaml:"port"`
}

type HealthcheckTcpConfigOutputReference 

type HealthcheckTcpConfigOutputReference interface {
	cdktf.ComplexObject
	// the index of the complex object in a list.
	// Experimental.
	ComplexObjectIndex() interface{}
	// Experimental.
	SetComplexObjectIndex(val interface{})
	// set to true if this item is from inside a set and needs tolist() for accessing it set to "0" for single list items.
	// Experimental.
	ComplexObjectIsFromSet() *bool
	// Experimental.
	SetComplexObjectIsFromSet(val *bool)
	// The creation stack of this resolvable which will be appended to errors thrown during resolution.
	//
	// If this returns an empty array the stack will not be attached.
	// Experimental.
	CreationStack() *[]*string
	// Experimental.
	Fqn() *string
	InternalValue() interface{}
	SetInternalValue(val interface{})
	Method() *string
	SetMethod(val *string)
	MethodInput() *string
	Port() *float64
	SetPort(val *float64)
	PortInput() *float64
	// Experimental.
	TerraformAttribute() *string
	// Experimental.
	SetTerraformAttribute(val *string)
	// Experimental.
	TerraformResource() cdktf.IInterpolatingParent
	// Experimental.
	SetTerraformResource(val cdktf.IInterpolatingParent)
	// Experimental.
	ComputeFqn() *string
	// Experimental.
	GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
	// Experimental.
	GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable
	// Experimental.
	GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
	// Experimental.
	GetListAttribute(terraformAttribute *string) *[]*string
	// Experimental.
	GetNumberAttribute(terraformAttribute *string) *float64
	// Experimental.
	GetNumberListAttribute(terraformAttribute *string) *[]*float64
	// Experimental.
	GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64
	// Experimental.
	GetStringAttribute(terraformAttribute *string) *string
	// Experimental.
	GetStringMapAttribute(terraformAttribute *string) *map[string]*string
	// Experimental.
	InterpolationAsList() cdktf.IResolvable
	// Experimental.
	InterpolationForAttribute(property *string) cdktf.IResolvable
	ResetMethod()
	ResetPort()
	// Produce the Token's value at resolution time.
	// Experimental.
	Resolve(_context cdktf.IResolveContext) interface{}
	// Return a string representation of this resolvable object.
	//
	// Returns a reversible string representation.
	// Experimental.
	ToString() *string
}

func NewHealthcheckTcpConfigOutputReference 

func NewHealthcheckTcpConfigOutputReference(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string) HealthcheckTcpConfigOutputReference

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.