globalNetworkEndpointGroup.go

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

package compute

import (
	"context"
	"reflect"

	"errors"
	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/internal"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

// A global network endpoint group contains endpoints that reside outside of Google Cloud.
// Currently a global network endpoint group can only support a single endpoint.
//
// Recreating a global network endpoint group that's in use by another resource will give a
// `resourceInUseByAnotherResource` error. Use `lifecycle.create_before_destroy`
// to avoid this type of error.
//
// To get more information about GlobalNetworkEndpointGroup, see:
//
// * [API documentation](https://cloud.google.com/compute/docs/reference/rest/beta/networkEndpointGroups)
// * How-to Guides
//   - [Official Documentation](https://cloud.google.com/load-balancing/docs/negs/internet-neg-concepts)
//
// ## Example Usage
//
// ### Global Network Endpoint Group
//
// ```go
// package main
//
// import (
//
//	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/compute"
//	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
//
// )
//
//	func main() {
//		pulumi.Run(func(ctx *pulumi.Context) error {
//			_, err := compute.NewGlobalNetworkEndpointGroup(ctx, "neg", &compute.GlobalNetworkEndpointGroupArgs{
//				Name:                pulumi.String("my-lb-neg"),
//				DefaultPort:         pulumi.Int(90),
//				NetworkEndpointType: pulumi.String("INTERNET_FQDN_PORT"),
//			})
//			if err != nil {
//				return err
//			}
//			return nil
//		})
//	}
//
// ```
// ### Global Network Endpoint Group Ip Address
//
// ```go
// package main
//
// import (
//
//	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/compute"
//	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
//
// )
//
//	func main() {
//		pulumi.Run(func(ctx *pulumi.Context) error {
//			_, err := compute.NewGlobalNetworkEndpointGroup(ctx, "neg", &compute.GlobalNetworkEndpointGroupArgs{
//				Name:                pulumi.String("my-lb-neg"),
//				NetworkEndpointType: pulumi.String("INTERNET_IP_PORT"),
//				DefaultPort:         pulumi.Int(90),
//			})
//			if err != nil {
//				return err
//			}
//			return nil
//		})
//	}
//
// ```
//
// ## Import
//
// GlobalNetworkEndpointGroup can be imported using any of these accepted formats:
//
// * `projects/{{project}}/global/networkEndpointGroups/{{name}}`
//
// * `{{project}}/{{name}}`
//
// * `{{name}}`
//
// When using the `pulumi import` command, GlobalNetworkEndpointGroup can be imported using one of the formats above. For example:
//
// ```sh
// $ pulumi import gcp:compute/globalNetworkEndpointGroup:GlobalNetworkEndpointGroup default projects/{{project}}/global/networkEndpointGroups/{{name}}
// ```
//
// ```sh
// $ pulumi import gcp:compute/globalNetworkEndpointGroup:GlobalNetworkEndpointGroup default {{project}}/{{name}}
// ```
//
// ```sh
// $ pulumi import gcp:compute/globalNetworkEndpointGroup:GlobalNetworkEndpointGroup default {{name}}
// ```
type GlobalNetworkEndpointGroup struct {
	pulumi.CustomResourceState

	// The default port used if the port number is not specified in the
	// network endpoint.
	DefaultPort pulumi.IntPtrOutput `pulumi:"defaultPort"`
	// An optional description of this resource. Provide this property when
	// you create the resource.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// 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"`
	// Type of network endpoints in this network endpoint group.
	// Possible values are: `INTERNET_IP_PORT`, `INTERNET_FQDN_PORT`.
	//
	// ***
	NetworkEndpointType pulumi.StringOutput `pulumi:"networkEndpointType"`
	// 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 URI of the created resource.
	SelfLink pulumi.StringOutput `pulumi:"selfLink"`
}

// NewGlobalNetworkEndpointGroup registers a new resource with the given unique name, arguments, and options.
func NewGlobalNetworkEndpointGroup(ctx *pulumi.Context,
	name string, args *GlobalNetworkEndpointGroupArgs, opts ...pulumi.ResourceOption) (*GlobalNetworkEndpointGroup, error) {
	if args == nil {
		return nil, errors.New("missing one or more required arguments")
	}

	if args.NetworkEndpointType == nil {
		return nil, errors.New("invalid value for required argument 'NetworkEndpointType'")
	}
	opts = internal.PkgResourceDefaultOpts(opts)
	var resource GlobalNetworkEndpointGroup
	err := ctx.RegisterResource("gcp:compute/globalNetworkEndpointGroup:GlobalNetworkEndpointGroup", name, args, &resource, opts...)
	if err != nil {
		return nil, err
	}
	return &resource, nil
}

// GetGlobalNetworkEndpointGroup gets an existing GlobalNetworkEndpointGroup 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 GetGlobalNetworkEndpointGroup(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *GlobalNetworkEndpointGroupState, opts ...pulumi.ResourceOption) (*GlobalNetworkEndpointGroup, error) {
	var resource GlobalNetworkEndpointGroup
	err := ctx.ReadResource("gcp:compute/globalNetworkEndpointGroup:GlobalNetworkEndpointGroup", name, id, state, &resource, opts...)
	if err != nil {
		return nil, err
	}
	return &resource, nil
}

// Input properties used for looking up and filtering GlobalNetworkEndpointGroup resources.
type globalNetworkEndpointGroupState struct {
	// The default port used if the port number is not specified in the
	// network endpoint.
	DefaultPort *int `pulumi:"defaultPort"`
	// An optional description of this resource. Provide this property when
	// you create the resource.
	Description *string `pulumi:"description"`
	// 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"`
	// Type of network endpoints in this network endpoint group.
	// Possible values are: `INTERNET_IP_PORT`, `INTERNET_FQDN_PORT`.
	//
	// ***
	NetworkEndpointType *string `pulumi:"networkEndpointType"`
	// 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 URI of the created resource.
	SelfLink *string `pulumi:"selfLink"`
}

type GlobalNetworkEndpointGroupState struct {
	// The default port used if the port number is not specified in the
	// network endpoint.
	DefaultPort pulumi.IntPtrInput
	// An optional description of this resource. Provide this property when
	// you create the resource.
	Description 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
	// Type of network endpoints in this network endpoint group.
	// Possible values are: `INTERNET_IP_PORT`, `INTERNET_FQDN_PORT`.
	//
	// ***
	NetworkEndpointType pulumi.StringPtrInput
	// The ID of the project in which the resource belongs.
	// If it is not provided, the provider project is used.
	Project pulumi.StringPtrInput
	// The URI of the created resource.
	SelfLink pulumi.StringPtrInput
}

func (GlobalNetworkEndpointGroupState) ElementType() reflect.Type {
	return reflect.TypeOf((*globalNetworkEndpointGroupState)(nil)).Elem()
}

type globalNetworkEndpointGroupArgs struct {
	// The default port used if the port number is not specified in the
	// network endpoint.
	DefaultPort *int `pulumi:"defaultPort"`
	// An optional description of this resource. Provide this property when
	// you create the resource.
	Description *string `pulumi:"description"`
	// 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"`
	// Type of network endpoints in this network endpoint group.
	// Possible values are: `INTERNET_IP_PORT`, `INTERNET_FQDN_PORT`.
	//
	// ***
	NetworkEndpointType string `pulumi:"networkEndpointType"`
	// 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 set of arguments for constructing a GlobalNetworkEndpointGroup resource.
type GlobalNetworkEndpointGroupArgs struct {
	// The default port used if the port number is not specified in the
	// network endpoint.
	DefaultPort pulumi.IntPtrInput
	// An optional description of this resource. Provide this property when
	// you create the resource.
	Description 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
	// Type of network endpoints in this network endpoint group.
	// Possible values are: `INTERNET_IP_PORT`, `INTERNET_FQDN_PORT`.
	//
	// ***
	NetworkEndpointType pulumi.StringInput
	// The ID of the project in which the resource belongs.
	// If it is not provided, the provider project is used.
	Project pulumi.StringPtrInput
}

func (GlobalNetworkEndpointGroupArgs) ElementType() reflect.Type {
	return reflect.TypeOf((*globalNetworkEndpointGroupArgs)(nil)).Elem()
}

type GlobalNetworkEndpointGroupInput interface {
	pulumi.Input

	ToGlobalNetworkEndpointGroupOutput() GlobalNetworkEndpointGroupOutput
	ToGlobalNetworkEndpointGroupOutputWithContext(ctx context.Context) GlobalNetworkEndpointGroupOutput
}

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

func (i *GlobalNetworkEndpointGroup) ToGlobalNetworkEndpointGroupOutput() GlobalNetworkEndpointGroupOutput {
	return i.ToGlobalNetworkEndpointGroupOutputWithContext(context.Background())
}

func (i *GlobalNetworkEndpointGroup) ToGlobalNetworkEndpointGroupOutputWithContext(ctx context.Context) GlobalNetworkEndpointGroupOutput {
	return pulumi.ToOutputWithContext(ctx, i).(GlobalNetworkEndpointGroupOutput)
}

// GlobalNetworkEndpointGroupArrayInput is an input type that accepts GlobalNetworkEndpointGroupArray and GlobalNetworkEndpointGroupArrayOutput values.
// You can construct a concrete instance of `GlobalNetworkEndpointGroupArrayInput` via:
//
//	GlobalNetworkEndpointGroupArray{ GlobalNetworkEndpointGroupArgs{...} }
type GlobalNetworkEndpointGroupArrayInput interface {
	pulumi.Input

	ToGlobalNetworkEndpointGroupArrayOutput() GlobalNetworkEndpointGroupArrayOutput
	ToGlobalNetworkEndpointGroupArrayOutputWithContext(context.Context) GlobalNetworkEndpointGroupArrayOutput
}

type GlobalNetworkEndpointGroupArray []GlobalNetworkEndpointGroupInput

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

func (i GlobalNetworkEndpointGroupArray) ToGlobalNetworkEndpointGroupArrayOutput() GlobalNetworkEndpointGroupArrayOutput {
	return i.ToGlobalNetworkEndpointGroupArrayOutputWithContext(context.Background())
}

func (i GlobalNetworkEndpointGroupArray) ToGlobalNetworkEndpointGroupArrayOutputWithContext(ctx context.Context) GlobalNetworkEndpointGroupArrayOutput {
	return pulumi.ToOutputWithContext(ctx, i).(GlobalNetworkEndpointGroupArrayOutput)
}

// GlobalNetworkEndpointGroupMapInput is an input type that accepts GlobalNetworkEndpointGroupMap and GlobalNetworkEndpointGroupMapOutput values.
// You can construct a concrete instance of `GlobalNetworkEndpointGroupMapInput` via:
//
//	GlobalNetworkEndpointGroupMap{ "key": GlobalNetworkEndpointGroupArgs{...} }
type GlobalNetworkEndpointGroupMapInput interface {
	pulumi.Input

	ToGlobalNetworkEndpointGroupMapOutput() GlobalNetworkEndpointGroupMapOutput
	ToGlobalNetworkEndpointGroupMapOutputWithContext(context.Context) GlobalNetworkEndpointGroupMapOutput
}

type GlobalNetworkEndpointGroupMap map[string]GlobalNetworkEndpointGroupInput

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

func (i GlobalNetworkEndpointGroupMap) ToGlobalNetworkEndpointGroupMapOutput() GlobalNetworkEndpointGroupMapOutput {
	return i.ToGlobalNetworkEndpointGroupMapOutputWithContext(context.Background())
}

func (i GlobalNetworkEndpointGroupMap) ToGlobalNetworkEndpointGroupMapOutputWithContext(ctx context.Context) GlobalNetworkEndpointGroupMapOutput {
	return pulumi.ToOutputWithContext(ctx, i).(GlobalNetworkEndpointGroupMapOutput)
}

type GlobalNetworkEndpointGroupOutput struct{ *pulumi.OutputState }

func (GlobalNetworkEndpointGroupOutput) ElementType() reflect.Type {
	return reflect.TypeOf((**GlobalNetworkEndpointGroup)(nil)).Elem()
}

func (o GlobalNetworkEndpointGroupOutput) ToGlobalNetworkEndpointGroupOutput() GlobalNetworkEndpointGroupOutput {
	return o
}

func (o GlobalNetworkEndpointGroupOutput) ToGlobalNetworkEndpointGroupOutputWithContext(ctx context.Context) GlobalNetworkEndpointGroupOutput {
	return o
}

// The default port used if the port number is not specified in the
// network endpoint.
func (o GlobalNetworkEndpointGroupOutput) DefaultPort() pulumi.IntPtrOutput {
	return o.ApplyT(func(v *GlobalNetworkEndpointGroup) pulumi.IntPtrOutput { return v.DefaultPort }).(pulumi.IntPtrOutput)
}

// An optional description of this resource. Provide this property when
// you create the resource.
func (o GlobalNetworkEndpointGroupOutput) Description() pulumi.StringPtrOutput {
	return o.ApplyT(func(v *GlobalNetworkEndpointGroup) pulumi.StringPtrOutput { return v.Description }).(pulumi.StringPtrOutput)
}

// 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.
func (o GlobalNetworkEndpointGroupOutput) Name() pulumi.StringOutput {
	return o.ApplyT(func(v *GlobalNetworkEndpointGroup) pulumi.StringOutput { return v.Name }).(pulumi.StringOutput)
}

// Type of network endpoints in this network endpoint group.
// Possible values are: `INTERNET_IP_PORT`, `INTERNET_FQDN_PORT`.
//
// ***
func (o GlobalNetworkEndpointGroupOutput) NetworkEndpointType() pulumi.StringOutput {
	return o.ApplyT(func(v *GlobalNetworkEndpointGroup) pulumi.StringOutput { return v.NetworkEndpointType }).(pulumi.StringOutput)
}

// The ID of the project in which the resource belongs.
// If it is not provided, the provider project is used.
func (o GlobalNetworkEndpointGroupOutput) Project() pulumi.StringOutput {
	return o.ApplyT(func(v *GlobalNetworkEndpointGroup) pulumi.StringOutput { return v.Project }).(pulumi.StringOutput)
}

// The URI of the created resource.
func (o GlobalNetworkEndpointGroupOutput) SelfLink() pulumi.StringOutput {
	return o.ApplyT(func(v *GlobalNetworkEndpointGroup) pulumi.StringOutput { return v.SelfLink }).(pulumi.StringOutput)
}

type GlobalNetworkEndpointGroupArrayOutput struct{ *pulumi.OutputState }

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

func (o GlobalNetworkEndpointGroupArrayOutput) ToGlobalNetworkEndpointGroupArrayOutput() GlobalNetworkEndpointGroupArrayOutput {
	return o
}

func (o GlobalNetworkEndpointGroupArrayOutput) ToGlobalNetworkEndpointGroupArrayOutputWithContext(ctx context.Context) GlobalNetworkEndpointGroupArrayOutput {
	return o
}

func (o GlobalNetworkEndpointGroupArrayOutput) Index(i pulumi.IntInput) GlobalNetworkEndpointGroupOutput {
	return pulumi.All(o, i).ApplyT(func(vs []interface{}) *GlobalNetworkEndpointGroup {
		return vs[0].([]*GlobalNetworkEndpointGroup)[vs[1].(int)]
	}).(GlobalNetworkEndpointGroupOutput)
}

type GlobalNetworkEndpointGroupMapOutput struct{ *pulumi.OutputState }

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

func (o GlobalNetworkEndpointGroupMapOutput) ToGlobalNetworkEndpointGroupMapOutput() GlobalNetworkEndpointGroupMapOutput {
	return o
}

func (o GlobalNetworkEndpointGroupMapOutput) ToGlobalNetworkEndpointGroupMapOutputWithContext(ctx context.Context) GlobalNetworkEndpointGroupMapOutput {
	return o
}

func (o GlobalNetworkEndpointGroupMapOutput) MapIndex(k pulumi.StringInput) GlobalNetworkEndpointGroupOutput {
	return pulumi.All(o, k).ApplyT(func(vs []interface{}) *GlobalNetworkEndpointGroup {
		return vs[0].(map[string]*GlobalNetworkEndpointGroup)[vs[1].(string)]
	}).(GlobalNetworkEndpointGroupOutput)
}

func init() {
	pulumi.RegisterInputType(reflect.TypeOf((*GlobalNetworkEndpointGroupInput)(nil)).Elem(), &GlobalNetworkEndpointGroup{})
	pulumi.RegisterInputType(reflect.TypeOf((*GlobalNetworkEndpointGroupArrayInput)(nil)).Elem(), GlobalNetworkEndpointGroupArray{})
	pulumi.RegisterInputType(reflect.TypeOf((*GlobalNetworkEndpointGroupMapInput)(nil)).Elem(), GlobalNetworkEndpointGroupMap{})
	pulumi.RegisterOutputType(GlobalNetworkEndpointGroupOutput{})
	pulumi.RegisterOutputType(GlobalNetworkEndpointGroupArrayOutput{})
	pulumi.RegisterOutputType(GlobalNetworkEndpointGroupMapOutput{})
}