HealthCheck class

Creates a HealthCheck resource in the specified project using the data included in the request.

Constructors

HealthCheck(String name, {HealthCheckArgs? args, CustomResourceOptions? options})

Creates a new HealthCheck. name The Pulumi resource name. args Arguments used to configure this HealthCheck. The set of arguments for HealthCheck. options Resource options controlling this resource's behavior.

Properties

checkIntervalSec ↔ Output<int>

How often (in seconds) to send a health check. The default value is 5 seconds.

late, final

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

creationTimestamp ↔ Output<String>

Creation timestamp in 3339 text format.

late, final

description ↔ Output<String>

An optional description of this resource. Provide this property when you create the resource.

late, final

grpcHealthCheck ↔ Output<GRPCHealthCheckResponse>

late, final

hashCode → int

The hash code for this object.

no setter, inherited

healthyThreshold ↔ Output<int>

A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.

late, final

http2HealthCheck ↔ Output<HTTP2HealthCheckResponse>

late, final

httpHealthCheck ↔ Output<HTTPHealthCheckResponse>

late, final

httpsHealthCheck ↔ Output<HTTPSHealthCheckResponse>

late, final

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

kind ↔ Output<String>

Type of the resource.

late, final

logConfig ↔ Output<HealthCheckLogConfigResponse>

Configure logging on this health check.

late, final

name ↔ Output<String>

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. For example, a name that is 1-63 characters long, matches the regular expression [a-z]([-a-z0-9]*[a-z0-9])?, and otherwise complies with RFC1035. This regular expression describes a name where the first character is a lowercase letter, and all following characters are a dash, lowercase letter, or digit, except the last character, which isn't a dash.

late, final

project ↔ Output<String>

late, final

region ↔ Output<String>

Region where the health check resides. Not applicable to global health checks.

late, final

requestId ↔ Output<String?>

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

selfLink ↔ Output<String>

Server-defined URL for the resource.

late, final

selfLinkWithId ↔ Output<String>

Server-defined URL for this resource with the resource id.

late, final

sourceRegions ↔ Output<List<String>>

The list of cloud regions from which health checks are performed. If any regions are specified, then exactly 3 regions should be specified. The region names must be valid names of GCP regions. This can only be set for global health check. If this list is non-empty, then there are restrictions on what other health check fields are supported and what other resources can use this health check: - SSL, HTTP2, and GRPC protocols are not supported. - The TCP request field is not supported. - The proxyHeader field for HTTP, HTTPS, and TCP is not supported. - The checkIntervalSec field must be at least 30. - The health check cannot be used with BackendService nor with managed instance group auto-healing.

late, final

sslHealthCheck ↔ Output<SSLHealthCheckResponse>

late, final

tcpHealthCheck ↔ Output<TCPHealthCheckResponse>

late, final

timeoutSec ↔ Output<int>

How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

type ↔ Output<String>

Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must match type field.

late, final

udpHealthCheck ↔ Output<UDPHealthCheckResponse>

late, final

unhealthyThreshold ↔ Output<int>

A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

late, final

urn ↔ Output<String>

late, final, inherited

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited