consumerQuotaOverride.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 serviceusage

import (
	"context"
	"reflect"

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

// A consumer override is applied to the consumer on its own authority to limit its own quota usage.
// Consumer overrides cannot be used to grant more quota than would be allowed by admin overrides,
// producer overrides, or the default limit of the service.
//
// To get more information about ConsumerQuotaOverride, see:
//
// * How-to Guides
//   - [Managing Service Quota](https://cloud.google.com/service-usage/docs/manage-quota)
//   - [REST API documentation](https://cloud.google.com/service-usage/docs/reference/rest/v1beta1/services.consumerQuotaMetrics.limits.consumerOverrides)
//
// ## Example Usage
//
// ## Import
//
// # ConsumerQuotaOverride can be imported using any of these accepted formats
//
// ```sh
//
//	$ pulumi import gcp:serviceusage/consumerQuotaOverride:ConsumerQuotaOverride default projects/{{project}}/services/{{service}}/consumerQuotaMetrics/{{metric}}/limits/{{limit}}/consumerOverrides/{{name}}
//
// ```
//
// ```sh
//
//	$ pulumi import gcp:serviceusage/consumerQuotaOverride:ConsumerQuotaOverride default services/{{service}}/consumerQuotaMetrics/{{metric}}/limits/{{limit}}/consumerOverrides/{{name}}
//
// ```
//
// ```sh
//
//	$ pulumi import gcp:serviceusage/consumerQuotaOverride:ConsumerQuotaOverride default {{service}}/{{metric}}/{{limit}}/{{name}}
//
// ```
type ConsumerQuotaOverride struct {
	pulumi.CustomResourceState

	// If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit.
	Dimensions pulumi.StringMapOutput `pulumi:"dimensions"`
	// If the new quota would decrease the existing quota by more than 10%, the request is rejected.
	// If `force` is `true`, that safety check is ignored.
	Force pulumi.BoolPtrOutput `pulumi:"force"`
	// The limit on the metric, e.g. `/project/region`.
	// > Make sure that `limit` is in a format that doesn't start with `1/` or contain curly braces.
	// E.g. use `/project/user` instead of `1/{project}/{user}`.
	//
	// ***
	Limit pulumi.StringOutput `pulumi:"limit"`
	// The metric that should be limited, e.g. `compute.googleapis.com/cpus`.
	Metric pulumi.StringOutput `pulumi:"metric"`
	// The server-generated name of the quota override.
	Name pulumi.StringOutput `pulumi:"name"`
	// The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota).
	OverrideValue pulumi.StringOutput `pulumi:"overrideValue"`
	// 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 service that the metrics belong to, e.g. `compute.googleapis.com`.
	Service pulumi.StringOutput `pulumi:"service"`
}

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

	if args.Limit == nil {
		return nil, errors.New("invalid value for required argument 'Limit'")
	}
	if args.Metric == nil {
		return nil, errors.New("invalid value for required argument 'Metric'")
	}
	if args.OverrideValue == nil {
		return nil, errors.New("invalid value for required argument 'OverrideValue'")
	}
	if args.Service == nil {
		return nil, errors.New("invalid value for required argument 'Service'")
	}
	opts = internal.PkgResourceDefaultOpts(opts)
	var resource ConsumerQuotaOverride
	err := ctx.RegisterResource("gcp:serviceusage/consumerQuotaOverride:ConsumerQuotaOverride", name, args, &resource, opts...)
	if err != nil {
		return nil, err
	}
	return &resource, nil
}

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

// Input properties used for looking up and filtering ConsumerQuotaOverride resources.
type consumerQuotaOverrideState struct {
	// If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit.
	Dimensions map[string]string `pulumi:"dimensions"`
	// If the new quota would decrease the existing quota by more than 10%, the request is rejected.
	// If `force` is `true`, that safety check is ignored.
	Force *bool `pulumi:"force"`
	// The limit on the metric, e.g. `/project/region`.
	// > Make sure that `limit` is in a format that doesn't start with `1/` or contain curly braces.
	// E.g. use `/project/user` instead of `1/{project}/{user}`.
	//
	// ***
	Limit *string `pulumi:"limit"`
	// The metric that should be limited, e.g. `compute.googleapis.com/cpus`.
	Metric *string `pulumi:"metric"`
	// The server-generated name of the quota override.
	Name *string `pulumi:"name"`
	// The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota).
	OverrideValue *string `pulumi:"overrideValue"`
	// 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 service that the metrics belong to, e.g. `compute.googleapis.com`.
	Service *string `pulumi:"service"`
}

type ConsumerQuotaOverrideState struct {
	// If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit.
	Dimensions pulumi.StringMapInput
	// If the new quota would decrease the existing quota by more than 10%, the request is rejected.
	// If `force` is `true`, that safety check is ignored.
	Force pulumi.BoolPtrInput
	// The limit on the metric, e.g. `/project/region`.
	// > Make sure that `limit` is in a format that doesn't start with `1/` or contain curly braces.
	// E.g. use `/project/user` instead of `1/{project}/{user}`.
	//
	// ***
	Limit pulumi.StringPtrInput
	// The metric that should be limited, e.g. `compute.googleapis.com/cpus`.
	Metric pulumi.StringPtrInput
	// The server-generated name of the quota override.
	Name pulumi.StringPtrInput
	// The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota).
	OverrideValue 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 service that the metrics belong to, e.g. `compute.googleapis.com`.
	Service pulumi.StringPtrInput
}

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

type consumerQuotaOverrideArgs struct {
	// If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit.
	Dimensions map[string]string `pulumi:"dimensions"`
	// If the new quota would decrease the existing quota by more than 10%, the request is rejected.
	// If `force` is `true`, that safety check is ignored.
	Force *bool `pulumi:"force"`
	// The limit on the metric, e.g. `/project/region`.
	// > Make sure that `limit` is in a format that doesn't start with `1/` or contain curly braces.
	// E.g. use `/project/user` instead of `1/{project}/{user}`.
	//
	// ***
	Limit string `pulumi:"limit"`
	// The metric that should be limited, e.g. `compute.googleapis.com/cpus`.
	Metric string `pulumi:"metric"`
	// The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota).
	OverrideValue string `pulumi:"overrideValue"`
	// 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 service that the metrics belong to, e.g. `compute.googleapis.com`.
	Service string `pulumi:"service"`
}

// The set of arguments for constructing a ConsumerQuotaOverride resource.
type ConsumerQuotaOverrideArgs struct {
	// If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit.
	Dimensions pulumi.StringMapInput
	// If the new quota would decrease the existing quota by more than 10%, the request is rejected.
	// If `force` is `true`, that safety check is ignored.
	Force pulumi.BoolPtrInput
	// The limit on the metric, e.g. `/project/region`.
	// > Make sure that `limit` is in a format that doesn't start with `1/` or contain curly braces.
	// E.g. use `/project/user` instead of `1/{project}/{user}`.
	//
	// ***
	Limit pulumi.StringInput
	// The metric that should be limited, e.g. `compute.googleapis.com/cpus`.
	Metric pulumi.StringInput
	// The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota).
	OverrideValue 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
	// The service that the metrics belong to, e.g. `compute.googleapis.com`.
	Service pulumi.StringInput
}

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

type ConsumerQuotaOverrideInput interface {
	pulumi.Input

	ToConsumerQuotaOverrideOutput() ConsumerQuotaOverrideOutput
	ToConsumerQuotaOverrideOutputWithContext(ctx context.Context) ConsumerQuotaOverrideOutput
}

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

func (i *ConsumerQuotaOverride) ToConsumerQuotaOverrideOutput() ConsumerQuotaOverrideOutput {
	return i.ToConsumerQuotaOverrideOutputWithContext(context.Background())
}

func (i *ConsumerQuotaOverride) ToConsumerQuotaOverrideOutputWithContext(ctx context.Context) ConsumerQuotaOverrideOutput {
	return pulumi.ToOutputWithContext(ctx, i).(ConsumerQuotaOverrideOutput)
}

func (i *ConsumerQuotaOverride) ToOutput(ctx context.Context) pulumix.Output[*ConsumerQuotaOverride] {
	return pulumix.Output[*ConsumerQuotaOverride]{
		OutputState: i.ToConsumerQuotaOverrideOutputWithContext(ctx).OutputState,
	}
}

// ConsumerQuotaOverrideArrayInput is an input type that accepts ConsumerQuotaOverrideArray and ConsumerQuotaOverrideArrayOutput values.
// You can construct a concrete instance of `ConsumerQuotaOverrideArrayInput` via:
//
//	ConsumerQuotaOverrideArray{ ConsumerQuotaOverrideArgs{...} }
type ConsumerQuotaOverrideArrayInput interface {
	pulumi.Input

	ToConsumerQuotaOverrideArrayOutput() ConsumerQuotaOverrideArrayOutput
	ToConsumerQuotaOverrideArrayOutputWithContext(context.Context) ConsumerQuotaOverrideArrayOutput
}

type ConsumerQuotaOverrideArray []ConsumerQuotaOverrideInput

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

func (i ConsumerQuotaOverrideArray) ToConsumerQuotaOverrideArrayOutput() ConsumerQuotaOverrideArrayOutput {
	return i.ToConsumerQuotaOverrideArrayOutputWithContext(context.Background())
}

func (i ConsumerQuotaOverrideArray) ToConsumerQuotaOverrideArrayOutputWithContext(ctx context.Context) ConsumerQuotaOverrideArrayOutput {
	return pulumi.ToOutputWithContext(ctx, i).(ConsumerQuotaOverrideArrayOutput)
}

func (i ConsumerQuotaOverrideArray) ToOutput(ctx context.Context) pulumix.Output[[]*ConsumerQuotaOverride] {
	return pulumix.Output[[]*ConsumerQuotaOverride]{
		OutputState: i.ToConsumerQuotaOverrideArrayOutputWithContext(ctx).OutputState,
	}
}

// ConsumerQuotaOverrideMapInput is an input type that accepts ConsumerQuotaOverrideMap and ConsumerQuotaOverrideMapOutput values.
// You can construct a concrete instance of `ConsumerQuotaOverrideMapInput` via:
//
//	ConsumerQuotaOverrideMap{ "key": ConsumerQuotaOverrideArgs{...} }
type ConsumerQuotaOverrideMapInput interface {
	pulumi.Input

	ToConsumerQuotaOverrideMapOutput() ConsumerQuotaOverrideMapOutput
	ToConsumerQuotaOverrideMapOutputWithContext(context.Context) ConsumerQuotaOverrideMapOutput
}

type ConsumerQuotaOverrideMap map[string]ConsumerQuotaOverrideInput

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

func (i ConsumerQuotaOverrideMap) ToConsumerQuotaOverrideMapOutput() ConsumerQuotaOverrideMapOutput {
	return i.ToConsumerQuotaOverrideMapOutputWithContext(context.Background())
}

func (i ConsumerQuotaOverrideMap) ToConsumerQuotaOverrideMapOutputWithContext(ctx context.Context) ConsumerQuotaOverrideMapOutput {
	return pulumi.ToOutputWithContext(ctx, i).(ConsumerQuotaOverrideMapOutput)
}

func (i ConsumerQuotaOverrideMap) ToOutput(ctx context.Context) pulumix.Output[map[string]*ConsumerQuotaOverride] {
	return pulumix.Output[map[string]*ConsumerQuotaOverride]{
		OutputState: i.ToConsumerQuotaOverrideMapOutputWithContext(ctx).OutputState,
	}
}

type ConsumerQuotaOverrideOutput struct{ *pulumi.OutputState }

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

func (o ConsumerQuotaOverrideOutput) ToConsumerQuotaOverrideOutput() ConsumerQuotaOverrideOutput {
	return o
}

func (o ConsumerQuotaOverrideOutput) ToConsumerQuotaOverrideOutputWithContext(ctx context.Context) ConsumerQuotaOverrideOutput {
	return o
}

func (o ConsumerQuotaOverrideOutput) ToOutput(ctx context.Context) pulumix.Output[*ConsumerQuotaOverride] {
	return pulumix.Output[*ConsumerQuotaOverride]{
		OutputState: o.OutputState,
	}
}

// If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit.
func (o ConsumerQuotaOverrideOutput) Dimensions() pulumi.StringMapOutput {
	return o.ApplyT(func(v *ConsumerQuotaOverride) pulumi.StringMapOutput { return v.Dimensions }).(pulumi.StringMapOutput)
}

// If the new quota would decrease the existing quota by more than 10%, the request is rejected.
// If `force` is `true`, that safety check is ignored.
func (o ConsumerQuotaOverrideOutput) Force() pulumi.BoolPtrOutput {
	return o.ApplyT(func(v *ConsumerQuotaOverride) pulumi.BoolPtrOutput { return v.Force }).(pulumi.BoolPtrOutput)
}

// The limit on the metric, e.g. `/project/region`.
// > Make sure that `limit` is in a format that doesn't start with `1/` or contain curly braces.
// E.g. use `/project/user` instead of `1/{project}/{user}`.
//
// ***
func (o ConsumerQuotaOverrideOutput) Limit() pulumi.StringOutput {
	return o.ApplyT(func(v *ConsumerQuotaOverride) pulumi.StringOutput { return v.Limit }).(pulumi.StringOutput)
}

// The metric that should be limited, e.g. `compute.googleapis.com/cpus`.
func (o ConsumerQuotaOverrideOutput) Metric() pulumi.StringOutput {
	return o.ApplyT(func(v *ConsumerQuotaOverride) pulumi.StringOutput { return v.Metric }).(pulumi.StringOutput)
}

// The server-generated name of the quota override.
func (o ConsumerQuotaOverrideOutput) Name() pulumi.StringOutput {
	return o.ApplyT(func(v *ConsumerQuotaOverride) pulumi.StringOutput { return v.Name }).(pulumi.StringOutput)
}

// The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota).
func (o ConsumerQuotaOverrideOutput) OverrideValue() pulumi.StringOutput {
	return o.ApplyT(func(v *ConsumerQuotaOverride) pulumi.StringOutput { return v.OverrideValue }).(pulumi.StringOutput)
}

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

// The service that the metrics belong to, e.g. `compute.googleapis.com`.
func (o ConsumerQuotaOverrideOutput) Service() pulumi.StringOutput {
	return o.ApplyT(func(v *ConsumerQuotaOverride) pulumi.StringOutput { return v.Service }).(pulumi.StringOutput)
}

type ConsumerQuotaOverrideArrayOutput struct{ *pulumi.OutputState }

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

func (o ConsumerQuotaOverrideArrayOutput) ToConsumerQuotaOverrideArrayOutput() ConsumerQuotaOverrideArrayOutput {
	return o
}

func (o ConsumerQuotaOverrideArrayOutput) ToConsumerQuotaOverrideArrayOutputWithContext(ctx context.Context) ConsumerQuotaOverrideArrayOutput {
	return o
}

func (o ConsumerQuotaOverrideArrayOutput) ToOutput(ctx context.Context) pulumix.Output[[]*ConsumerQuotaOverride] {
	return pulumix.Output[[]*ConsumerQuotaOverride]{
		OutputState: o.OutputState,
	}
}

func (o ConsumerQuotaOverrideArrayOutput) Index(i pulumi.IntInput) ConsumerQuotaOverrideOutput {
	return pulumi.All(o, i).ApplyT(func(vs []interface{}) *ConsumerQuotaOverride {
		return vs[0].([]*ConsumerQuotaOverride)[vs[1].(int)]
	}).(ConsumerQuotaOverrideOutput)
}

type ConsumerQuotaOverrideMapOutput struct{ *pulumi.OutputState }

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

func (o ConsumerQuotaOverrideMapOutput) ToConsumerQuotaOverrideMapOutput() ConsumerQuotaOverrideMapOutput {
	return o
}

func (o ConsumerQuotaOverrideMapOutput) ToConsumerQuotaOverrideMapOutputWithContext(ctx context.Context) ConsumerQuotaOverrideMapOutput {
	return o
}

func (o ConsumerQuotaOverrideMapOutput) ToOutput(ctx context.Context) pulumix.Output[map[string]*ConsumerQuotaOverride] {
	return pulumix.Output[map[string]*ConsumerQuotaOverride]{
		OutputState: o.OutputState,
	}
}

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

func init() {
	pulumi.RegisterInputType(reflect.TypeOf((*ConsumerQuotaOverrideInput)(nil)).Elem(), &ConsumerQuotaOverride{})
	pulumi.RegisterInputType(reflect.TypeOf((*ConsumerQuotaOverrideArrayInput)(nil)).Elem(), ConsumerQuotaOverrideArray{})
	pulumi.RegisterInputType(reflect.TypeOf((*ConsumerQuotaOverrideMapInput)(nil)).Elem(), ConsumerQuotaOverrideMap{})
	pulumi.RegisterOutputType(ConsumerQuotaOverrideOutput{})
	pulumi.RegisterOutputType(ConsumerQuotaOverrideArrayOutput{})
	pulumi.RegisterOutputType(ConsumerQuotaOverrideMapOutput{})
}