httpsHealthCheck.go

// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***

package compute

import (
	"context"
	"reflect"

	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

// An HttpsHealthCheck resource. This resource defines a template for how
// individual VMs should be checked for health, via HTTPS.
//
// > **Note:** compute.HttpsHealthCheck is a legacy health check.
// The newer [compute.HealthCheck](https://www.terraform.io/docs/providers/google/r/compute_health_check.html)
// should be preferred for all uses except
// [Network Load Balancers](https://cloud.google.com/compute/docs/load-balancing/network/)
// which still require the legacy version.
//
// To get more information about HttpsHealthCheck, see:
//
// * [API documentation](https://cloud.google.com/compute/docs/reference/v1/httpsHealthChecks)
// * How-to Guides
//     * [Adding Health Checks](https://cloud.google.com/compute/docs/load-balancing/health-checks#legacy_health_checks)
//
// ## Example Usage
// ### Https Health Check Basic
//
// ```go
// package main
//
// import (
// 	"github.com/pulumi/pulumi-gcp/sdk/v5/go/gcp/compute"
// 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
// )
//
// func main() {
// 	pulumi.Run(func(ctx *pulumi.Context) error {
// 		_, err := compute.NewHttpsHealthCheck(ctx, "_default", &compute.HttpsHealthCheckArgs{
// 			CheckIntervalSec: pulumi.Int(1),
// 			RequestPath:      pulumi.String("/health_check"),
// 			TimeoutSec:       pulumi.Int(1),
// 		})
// 		if err != nil {
// 			return err
// 		}
// 		return nil
// 	})
// }
// ```
//
// ## Import
//
// HttpsHealthCheck can be imported using any of these accepted formats
//
// ```sh
//  $ pulumi import gcp:compute/httpsHealthCheck:HttpsHealthCheck default projects/{{project}}/global/httpsHealthChecks/{{name}}
// ```
//
// ```sh
//  $ pulumi import gcp:compute/httpsHealthCheck:HttpsHealthCheck default {{project}}/{{name}}
// ```
//
// ```sh
//  $ pulumi import gcp:compute/httpsHealthCheck:HttpsHealthCheck default {{name}}
// ```
type HttpsHealthCheck struct {
	pulumi.CustomResourceState

	// How often (in seconds) to send a health check. The default value is 5
	// seconds.
	CheckIntervalSec pulumi.IntPtrOutput `pulumi:"checkIntervalSec"`
	// Creation timestamp in RFC3339 text format.
	CreationTimestamp pulumi.StringOutput `pulumi:"creationTimestamp"`
	// An optional description of this resource. Provide this property when
	// you create the resource.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// A so-far unhealthy instance will be marked healthy after this many
	// consecutive successes. The default value is 2.
	HealthyThreshold pulumi.IntPtrOutput `pulumi:"healthyThreshold"`
	// The value of the host header in the HTTPS health check request. If
	// left empty (default value), the public IP on behalf of which this
	// health check is performed will be used.
	Host pulumi.StringPtrOutput `pulumi:"host"`
	// 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.  Specifically, the name must be 1-63 characters long and
	// match the regular expression `a-z?` which means
	// the first character must be a lowercase letter, and all following
	// characters must be a dash, lowercase letter, or digit, except the
	// last character, which cannot be a dash.
	Name pulumi.StringOutput `pulumi:"name"`
	// The TCP port number for the HTTPS health check request.
	// The default value is 443.
	Port pulumi.IntPtrOutput `pulumi:"port"`
	// The ID of the project in which the resource belongs.
	// If it is not provided, the provider project is used.
	Project pulumi.StringOutput `pulumi:"project"`
	// The request path of the HTTPS health check request.
	// The default value is /.
	RequestPath pulumi.StringPtrOutput `pulumi:"requestPath"`
	// The URI of the created resource.
	SelfLink pulumi.StringOutput `pulumi:"selfLink"`
	// 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.
	TimeoutSec pulumi.IntPtrOutput `pulumi:"timeoutSec"`
	// A so-far healthy instance will be marked unhealthy after this many
	// consecutive failures. The default value is 2.
	UnhealthyThreshold pulumi.IntPtrOutput `pulumi:"unhealthyThreshold"`
}

// NewHttpsHealthCheck registers a new resource with the given unique name, arguments, and options.
func NewHttpsHealthCheck(ctx *pulumi.Context,
	name string, args *HttpsHealthCheckArgs, opts ...pulumi.ResourceOption) (*HttpsHealthCheck, error) {
	if args == nil {
		args = &HttpsHealthCheckArgs{}
	}

	var resource HttpsHealthCheck
	err := ctx.RegisterResource("gcp:compute/httpsHealthCheck:HttpsHealthCheck", name, args, &resource, opts...)
	if err != nil {
		return nil, err
	}
	return &resource, nil
}

// GetHttpsHealthCheck gets an existing HttpsHealthCheck resource's state with the given name, ID, and optional
// state properties that are used to uniquely qualify the lookup (nil if not required).
func GetHttpsHealthCheck(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *HttpsHealthCheckState, opts ...pulumi.ResourceOption) (*HttpsHealthCheck, error) {
	var resource HttpsHealthCheck
	err := ctx.ReadResource("gcp:compute/httpsHealthCheck:HttpsHealthCheck", name, id, state, &resource, opts...)
	if err != nil {
		return nil, err
	}
	return &resource, nil
}

// Input properties used for looking up and filtering HttpsHealthCheck resources.
type httpsHealthCheckState struct {
	// How often (in seconds) to send a health check. The default value is 5
	// seconds.
	CheckIntervalSec *int `pulumi:"checkIntervalSec"`
	// Creation timestamp in RFC3339 text format.
	CreationTimestamp *string `pulumi:"creationTimestamp"`
	// An optional description of this resource. Provide this property when
	// you create the resource.
	Description *string `pulumi:"description"`
	// A so-far unhealthy instance will be marked healthy after this many
	// consecutive successes. The default value is 2.
	HealthyThreshold *int `pulumi:"healthyThreshold"`
	// The value of the host header in the HTTPS health check request. If
	// left empty (default value), the public IP on behalf of which this
	// health check is performed will be used.
	Host *string `pulumi:"host"`
	// 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.  Specifically, the name must be 1-63 characters long and
	// match the regular expression `a-z?` which means
	// the first character must be a lowercase letter, and all following
	// characters must be a dash, lowercase letter, or digit, except the
	// last character, which cannot be a dash.
	Name *string `pulumi:"name"`
	// The TCP port number for the HTTPS health check request.
	// The default value is 443.
	Port *int `pulumi:"port"`
	// The ID of the project in which the resource belongs.
	// If it is not provided, the provider project is used.
	Project *string `pulumi:"project"`
	// The request path of the HTTPS health check request.
	// The default value is /.
	RequestPath *string `pulumi:"requestPath"`
	// The URI of the created resource.
	SelfLink *string `pulumi:"selfLink"`
	// 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.
	TimeoutSec *int `pulumi:"timeoutSec"`
	// A so-far healthy instance will be marked unhealthy after this many
	// consecutive failures. The default value is 2.
	UnhealthyThreshold *int `pulumi:"unhealthyThreshold"`
}

type HttpsHealthCheckState struct {
	// How often (in seconds) to send a health check. The default value is 5
	// seconds.
	CheckIntervalSec pulumi.IntPtrInput
	// Creation timestamp in RFC3339 text format.
	CreationTimestamp pulumi.StringPtrInput
	// An optional description of this resource. Provide this property when
	// you create the resource.
	Description pulumi.StringPtrInput
	// A so-far unhealthy instance will be marked healthy after this many
	// consecutive successes. The default value is 2.
	HealthyThreshold pulumi.IntPtrInput
	// The value of the host header in the HTTPS health check request. If
	// left empty (default value), the public IP on behalf of which this
	// health check is performed will be used.
	Host pulumi.StringPtrInput
	// 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.  Specifically, the name must be 1-63 characters long and
	// match the regular expression `a-z?` which means
	// the first character must be a lowercase letter, and all following
	// characters must be a dash, lowercase letter, or digit, except the
	// last character, which cannot be a dash.
	Name pulumi.StringPtrInput
	// The TCP port number for the HTTPS health check request.
	// The default value is 443.
	Port pulumi.IntPtrInput
	// The ID of the project in which the resource belongs.
	// If it is not provided, the provider project is used.
	Project pulumi.StringPtrInput
	// The request path of the HTTPS health check request.
	// The default value is /.
	RequestPath pulumi.StringPtrInput
	// The URI of the created resource.
	SelfLink pulumi.StringPtrInput
	// 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.
	TimeoutSec pulumi.IntPtrInput
	// A so-far healthy instance will be marked unhealthy after this many
	// consecutive failures. The default value is 2.
	UnhealthyThreshold pulumi.IntPtrInput
}

func (HttpsHealthCheckState) ElementType() reflect.Type {
	return reflect.TypeOf((*httpsHealthCheckState)(nil)).Elem()
}

type httpsHealthCheckArgs struct {
	// How often (in seconds) to send a health check. The default value is 5
	// seconds.
	CheckIntervalSec *int `pulumi:"checkIntervalSec"`
	// An optional description of this resource. Provide this property when
	// you create the resource.
	Description *string `pulumi:"description"`
	// A so-far unhealthy instance will be marked healthy after this many
	// consecutive successes. The default value is 2.
	HealthyThreshold *int `pulumi:"healthyThreshold"`
	// The value of the host header in the HTTPS health check request. If
	// left empty (default value), the public IP on behalf of which this
	// health check is performed will be used.
	Host *string `pulumi:"host"`
	// 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.  Specifically, the name must be 1-63 characters long and
	// match the regular expression `a-z?` which means
	// the first character must be a lowercase letter, and all following
	// characters must be a dash, lowercase letter, or digit, except the
	// last character, which cannot be a dash.
	Name *string `pulumi:"name"`
	// The TCP port number for the HTTPS health check request.
	// The default value is 443.
	Port *int `pulumi:"port"`
	// The ID of the project in which the resource belongs.
	// If it is not provided, the provider project is used.
	Project *string `pulumi:"project"`
	// The request path of the HTTPS health check request.
	// The default value is /.
	RequestPath *string `pulumi:"requestPath"`
	// 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.
	TimeoutSec *int `pulumi:"timeoutSec"`
	// A so-far healthy instance will be marked unhealthy after this many
	// consecutive failures. The default value is 2.
	UnhealthyThreshold *int `pulumi:"unhealthyThreshold"`
}

// The set of arguments for constructing a HttpsHealthCheck resource.
type HttpsHealthCheckArgs struct {
	// How often (in seconds) to send a health check. The default value is 5
	// seconds.
	CheckIntervalSec pulumi.IntPtrInput
	// An optional description of this resource. Provide this property when
	// you create the resource.
	Description pulumi.StringPtrInput
	// A so-far unhealthy instance will be marked healthy after this many
	// consecutive successes. The default value is 2.
	HealthyThreshold pulumi.IntPtrInput
	// The value of the host header in the HTTPS health check request. If
	// left empty (default value), the public IP on behalf of which this
	// health check is performed will be used.
	Host pulumi.StringPtrInput
	// 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.  Specifically, the name must be 1-63 characters long and
	// match the regular expression `a-z?` which means
	// the first character must be a lowercase letter, and all following
	// characters must be a dash, lowercase letter, or digit, except the
	// last character, which cannot be a dash.
	Name pulumi.StringPtrInput
	// The TCP port number for the HTTPS health check request.
	// The default value is 443.
	Port pulumi.IntPtrInput
	// The ID of the project in which the resource belongs.
	// If it is not provided, the provider project is used.
	Project pulumi.StringPtrInput
	// The request path of the HTTPS health check request.
	// The default value is /.
	RequestPath pulumi.StringPtrInput
	// 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.
	TimeoutSec pulumi.IntPtrInput
	// A so-far healthy instance will be marked unhealthy after this many
	// consecutive failures. The default value is 2.
	UnhealthyThreshold pulumi.IntPtrInput
}

func (HttpsHealthCheckArgs) ElementType() reflect.Type {
	return reflect.TypeOf((*httpsHealthCheckArgs)(nil)).Elem()
}

type HttpsHealthCheckInput interface {
	pulumi.Input

	ToHttpsHealthCheckOutput() HttpsHealthCheckOutput
	ToHttpsHealthCheckOutputWithContext(ctx context.Context) HttpsHealthCheckOutput
}

func (*HttpsHealthCheck) ElementType() reflect.Type {
	return reflect.TypeOf((*HttpsHealthCheck)(nil))
}

func (i *HttpsHealthCheck) ToHttpsHealthCheckOutput() HttpsHealthCheckOutput {
	return i.ToHttpsHealthCheckOutputWithContext(context.Background())
}

func (i *HttpsHealthCheck) ToHttpsHealthCheckOutputWithContext(ctx context.Context) HttpsHealthCheckOutput {
	return pulumi.ToOutputWithContext(ctx, i).(HttpsHealthCheckOutput)
}

func (i *HttpsHealthCheck) ToHttpsHealthCheckPtrOutput() HttpsHealthCheckPtrOutput {
	return i.ToHttpsHealthCheckPtrOutputWithContext(context.Background())
}

func (i *HttpsHealthCheck) ToHttpsHealthCheckPtrOutputWithContext(ctx context.Context) HttpsHealthCheckPtrOutput {
	return pulumi.ToOutputWithContext(ctx, i).(HttpsHealthCheckPtrOutput)
}

type HttpsHealthCheckPtrInput interface {
	pulumi.Input

	ToHttpsHealthCheckPtrOutput() HttpsHealthCheckPtrOutput
	ToHttpsHealthCheckPtrOutputWithContext(ctx context.Context) HttpsHealthCheckPtrOutput
}

type httpsHealthCheckPtrType HttpsHealthCheckArgs

func (*httpsHealthCheckPtrType) ElementType() reflect.Type {
	return reflect.TypeOf((**HttpsHealthCheck)(nil))
}

func (i *httpsHealthCheckPtrType) ToHttpsHealthCheckPtrOutput() HttpsHealthCheckPtrOutput {
	return i.ToHttpsHealthCheckPtrOutputWithContext(context.Background())
}

func (i *httpsHealthCheckPtrType) ToHttpsHealthCheckPtrOutputWithContext(ctx context.Context) HttpsHealthCheckPtrOutput {
	return pulumi.ToOutputWithContext(ctx, i).(HttpsHealthCheckPtrOutput)
}

// HttpsHealthCheckArrayInput is an input type that accepts HttpsHealthCheckArray and HttpsHealthCheckArrayOutput values.
// You can construct a concrete instance of `HttpsHealthCheckArrayInput` via:
//
//          HttpsHealthCheckArray{ HttpsHealthCheckArgs{...} }
type HttpsHealthCheckArrayInput interface {
	pulumi.Input

	ToHttpsHealthCheckArrayOutput() HttpsHealthCheckArrayOutput
	ToHttpsHealthCheckArrayOutputWithContext(context.Context) HttpsHealthCheckArrayOutput
}

type HttpsHealthCheckArray []HttpsHealthCheckInput

func (HttpsHealthCheckArray) ElementType() reflect.Type {
	return reflect.TypeOf((*[]*HttpsHealthCheck)(nil)).Elem()
}

func (i HttpsHealthCheckArray) ToHttpsHealthCheckArrayOutput() HttpsHealthCheckArrayOutput {
	return i.ToHttpsHealthCheckArrayOutputWithContext(context.Background())
}

func (i HttpsHealthCheckArray) ToHttpsHealthCheckArrayOutputWithContext(ctx context.Context) HttpsHealthCheckArrayOutput {
	return pulumi.ToOutputWithContext(ctx, i).(HttpsHealthCheckArrayOutput)
}

// HttpsHealthCheckMapInput is an input type that accepts HttpsHealthCheckMap and HttpsHealthCheckMapOutput values.
// You can construct a concrete instance of `HttpsHealthCheckMapInput` via:
//
//          HttpsHealthCheckMap{ "key": HttpsHealthCheckArgs{...} }
type HttpsHealthCheckMapInput interface {
	pulumi.Input

	ToHttpsHealthCheckMapOutput() HttpsHealthCheckMapOutput
	ToHttpsHealthCheckMapOutputWithContext(context.Context) HttpsHealthCheckMapOutput
}

type HttpsHealthCheckMap map[string]HttpsHealthCheckInput

func (HttpsHealthCheckMap) ElementType() reflect.Type {
	return reflect.TypeOf((*map[string]*HttpsHealthCheck)(nil)).Elem()
}

func (i HttpsHealthCheckMap) ToHttpsHealthCheckMapOutput() HttpsHealthCheckMapOutput {
	return i.ToHttpsHealthCheckMapOutputWithContext(context.Background())
}

func (i HttpsHealthCheckMap) ToHttpsHealthCheckMapOutputWithContext(ctx context.Context) HttpsHealthCheckMapOutput {
	return pulumi.ToOutputWithContext(ctx, i).(HttpsHealthCheckMapOutput)
}

type HttpsHealthCheckOutput struct{ *pulumi.OutputState }

func (HttpsHealthCheckOutput) ElementType() reflect.Type {
	return reflect.TypeOf((*HttpsHealthCheck)(nil))
}

func (o HttpsHealthCheckOutput) ToHttpsHealthCheckOutput() HttpsHealthCheckOutput {
	return o
}

func (o HttpsHealthCheckOutput) ToHttpsHealthCheckOutputWithContext(ctx context.Context) HttpsHealthCheckOutput {
	return o
}

func (o HttpsHealthCheckOutput) ToHttpsHealthCheckPtrOutput() HttpsHealthCheckPtrOutput {
	return o.ToHttpsHealthCheckPtrOutputWithContext(context.Background())
}

func (o HttpsHealthCheckOutput) ToHttpsHealthCheckPtrOutputWithContext(ctx context.Context) HttpsHealthCheckPtrOutput {
	return o.ApplyTWithContext(ctx, func(_ context.Context, v HttpsHealthCheck) *HttpsHealthCheck {
		return &v
	}).(HttpsHealthCheckPtrOutput)
}

type HttpsHealthCheckPtrOutput struct{ *pulumi.OutputState }

func (HttpsHealthCheckPtrOutput) ElementType() reflect.Type {
	return reflect.TypeOf((**HttpsHealthCheck)(nil))
}

func (o HttpsHealthCheckPtrOutput) ToHttpsHealthCheckPtrOutput() HttpsHealthCheckPtrOutput {
	return o
}

func (o HttpsHealthCheckPtrOutput) ToHttpsHealthCheckPtrOutputWithContext(ctx context.Context) HttpsHealthCheckPtrOutput {
	return o
}

func (o HttpsHealthCheckPtrOutput) Elem() HttpsHealthCheckOutput {
	return o.ApplyT(func(v *HttpsHealthCheck) HttpsHealthCheck {
		if v != nil {
			return *v
		}
		var ret HttpsHealthCheck
		return ret
	}).(HttpsHealthCheckOutput)
}

type HttpsHealthCheckArrayOutput struct{ *pulumi.OutputState }

func (HttpsHealthCheckArrayOutput) ElementType() reflect.Type {
	return reflect.TypeOf((*[]HttpsHealthCheck)(nil))
}

func (o HttpsHealthCheckArrayOutput) ToHttpsHealthCheckArrayOutput() HttpsHealthCheckArrayOutput {
	return o
}

func (o HttpsHealthCheckArrayOutput) ToHttpsHealthCheckArrayOutputWithContext(ctx context.Context) HttpsHealthCheckArrayOutput {
	return o
}

func (o HttpsHealthCheckArrayOutput) Index(i pulumi.IntInput) HttpsHealthCheckOutput {
	return pulumi.All(o, i).ApplyT(func(vs []interface{}) HttpsHealthCheck {
		return vs[0].([]HttpsHealthCheck)[vs[1].(int)]
	}).(HttpsHealthCheckOutput)
}

type HttpsHealthCheckMapOutput struct{ *pulumi.OutputState }

func (HttpsHealthCheckMapOutput) ElementType() reflect.Type {
	return reflect.TypeOf((*map[string]HttpsHealthCheck)(nil))
}

func (o HttpsHealthCheckMapOutput) ToHttpsHealthCheckMapOutput() HttpsHealthCheckMapOutput {
	return o
}

func (o HttpsHealthCheckMapOutput) ToHttpsHealthCheckMapOutputWithContext(ctx context.Context) HttpsHealthCheckMapOutput {
	return o
}

func (o HttpsHealthCheckMapOutput) MapIndex(k pulumi.StringInput) HttpsHealthCheckOutput {
	return pulumi.All(o, k).ApplyT(func(vs []interface{}) HttpsHealthCheck {
		return vs[0].(map[string]HttpsHealthCheck)[vs[1].(string)]
	}).(HttpsHealthCheckOutput)
}

func init() {
	pulumi.RegisterOutputType(HttpsHealthCheckOutput{})
	pulumi.RegisterOutputType(HttpsHealthCheckPtrOutput{})
	pulumi.RegisterOutputType(HttpsHealthCheckArrayOutput{})
	pulumi.RegisterOutputType(HttpsHealthCheckMapOutput{})
}