serviceusage

Documentation

Overview

nolint: lll

Index

• type ConsumerQuotaOverride
  • func GetConsumerQuotaOverride(ctx *pulumi.Context, name string, id pulumi.IDInput, ...) (*ConsumerQuotaOverride, error)
  • func NewConsumerQuotaOverride(ctx *pulumi.Context, name string, args *ConsumerQuotaOverrideArgs, ...) (*ConsumerQuotaOverride, error)
• type ConsumerQuotaOverrideArgs
  • func (ConsumerQuotaOverrideArgs) ElementType() reflect.Type
• type ConsumerQuotaOverrideState
  • func (ConsumerQuotaOverrideState) ElementType() reflect.Type

Types

type ConsumerQuotaOverride

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'.
	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"`
}

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

• [Getting Started](https://cloud.google.com/service-usage/docs/getting-started)
• [REST API documentation](https://cloud.google.com/service-usage/docs/reference/rest/v1beta1/services.consumerQuotaMetrics.limits.consumerOverrides)

> This content is derived from https://github.com/terraform-providers/terraform-provider-google/blob/master/website/docs/r/service_usage_consumer_quota_override.html.markdown.

func GetConsumerQuotaOverride

func GetConsumerQuotaOverride(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ConsumerQuotaOverrideState, opts ...pulumi.ResourceOption) (*ConsumerQuotaOverride, error)

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 NewConsumerQuotaOverride

func NewConsumerQuotaOverride(ctx *pulumi.Context,
	name string, args *ConsumerQuotaOverrideArgs, opts ...pulumi.ResourceOption) (*ConsumerQuotaOverride, error)

NewConsumerQuotaOverride registers a new resource with the given unique name, arguments, and options.

type ConsumerQuotaOverrideArgs

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'.
	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
}

The set of arguments for constructing a ConsumerQuotaOverride resource.

func (ConsumerQuotaOverrideArgs) ElementType

func (ConsumerQuotaOverrideArgs) ElementType() reflect.Type

type ConsumerQuotaOverrideState

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'.
	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

func (ConsumerQuotaOverrideState) ElementType() reflect.Type