Class ConsumerQuotaOverride

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
• REST API documentation

Example Usage - Consumer Quota Override

using Pulumi;
using Gcp = Pulumi.Gcp;

class MyStack : Stack
{
public MyStack()
{
    var myProject = new Gcp.Organizations.Project("myProject", new Gcp.Organizations.ProjectArgs
    {
        ProjectId = "quota",
        OrgId = "123456789",
    });
    var @override = new Gcp.ServiceUsage.ConsumerQuotaOverride("override", new Gcp.ServiceUsage.ConsumerQuotaOverrideArgs
    {
        Project = myProject.ProjectId,
        Service = "servicemanagement.googleapis.com",
        Metric = "servicemanagement.googleapis.com%2Fdefault_requests",
        Limit = "%2Fmin%2Fproject",
        OverrideValue = "95",
        Force = true,
    });
}

}

Inheritance

System.Object

Resource

CustomResource

ConsumerQuotaOverride

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Gcp.ServiceUsage

Assembly: Pulumi.Gcp.dll

Syntax

public class ConsumerQuotaOverride : CustomResource

Constructors

ConsumerQuotaOverride(String, ConsumerQuotaOverrideArgs, CustomResourceOptions)

Create a ConsumerQuotaOverride resource with the given unique name, arguments, and options.

Declaration

public ConsumerQuotaOverride(string name, ConsumerQuotaOverrideArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
ConsumerQuotaOverrideArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

Dimensions

If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit.

Declaration

public Output<ImmutableDictionary<string, string>> Dimensions { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.String>>

Force

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.

Declaration

public Output<bool?> Force { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

Limit

The limit on the metric, e.g. /project/region.

Declaration

public Output<string> Limit { get; }

Property Value

Type	Description
Output<System.String>

Metric

The metric that should be limited, e.g. compute.googleapis.com/cpus.

Declaration

public Output<string> Metric { get; }

Property Value

Type	Description
Output<System.String>

Name

The server-generated name of the quota override.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

OverrideValue

The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota).

Declaration

public Output<string> OverrideValue { get; }

Property Value

Type	Description
Output<System.String>

Project

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Declaration

public Output<string> Project { get; }

Property Value

Type	Description
Output<System.String>

Service

The service that the metrics belong to, e.g. compute.googleapis.com.

Declaration

public Output<string> Service { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, ConsumerQuotaOverrideState, CustomResourceOptions)

Get an existing ConsumerQuotaOverride resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static ConsumerQuotaOverride Get(string name, Input<string> id, ConsumerQuotaOverrideState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
ConsumerQuotaOverrideState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
ConsumerQuotaOverride