Google Cloud Classic v6.57.0, May 30 23

gcp.serviceusage.ConsumerQuotaOverride

Explore with Pulumi AI

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

Create ConsumerQuotaOverride Resource

new ConsumerQuotaOverride(name: string, args: ConsumerQuotaOverrideArgs, opts?: CustomResourceOptions);

@overload
def ConsumerQuotaOverride(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          dimensions: Optional[Mapping[str, str]] = None,
                          force: Optional[bool] = None,
                          limit: Optional[str] = None,
                          metric: Optional[str] = None,
                          override_value: Optional[str] = None,
                          project: Optional[str] = None,
                          service: Optional[str] = None)
@overload
def ConsumerQuotaOverride(resource_name: str,
                          args: ConsumerQuotaOverrideArgs,
                          opts: Optional[ResourceOptions] = None)

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

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

public ConsumerQuotaOverride(String name, ConsumerQuotaOverrideArgs args)
public ConsumerQuotaOverride(String name, ConsumerQuotaOverrideArgs args, CustomResourceOptions options)

type: gcp:serviceusage:ConsumerQuotaOverride
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ConsumerQuotaOverrideArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args ConsumerQuotaOverrideArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ConsumerQuotaOverrideArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ConsumerQuotaOverrideArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ConsumerQuotaOverrideArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

ConsumerQuotaOverride Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The ConsumerQuotaOverride resource accepts the following input properties:

Limit string: 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}.
Metric string: The metric that should be limited, e.g. compute.googleapis.com/cpus.
OverrideValue string: The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota).
Service string: The service that the metrics belong to, e.g. compute.googleapis.com.
Dimensions Dictionary<string, string>: If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit.
Force bool: 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.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Limit string: 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}.
Metric string: The metric that should be limited, e.g. compute.googleapis.com/cpus.
OverrideValue string: The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota).
Service string: The service that the metrics belong to, e.g. compute.googleapis.com.
Dimensions map[string]string: If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit.
Force bool: 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.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

limit String: 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}.
metric String: The metric that should be limited, e.g. compute.googleapis.com/cpus.
overrideValue String: The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota).
service String: The service that the metrics belong to, e.g. compute.googleapis.com.
dimensions Map<String,String>: If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit.
force Boolean: 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.
project String: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

limit string: 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}.
metric string: The metric that should be limited, e.g. compute.googleapis.com/cpus.
overrideValue string: The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota).
service string: The service that the metrics belong to, e.g. compute.googleapis.com.
dimensions {[key: string]: string}: If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit.
force boolean: 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.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

limit str: 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}.
metric str: The metric that should be limited, e.g. compute.googleapis.com/cpus.
override_value str: The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota).
service str: The service that the metrics belong to, e.g. compute.googleapis.com.
dimensions Mapping[str, str]: If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit.
force bool: 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.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

limit String: 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}.
metric String: The metric that should be limited, e.g. compute.googleapis.com/cpus.
overrideValue String: The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota).
service String: The service that the metrics belong to, e.g. compute.googleapis.com.
dimensions Map<String>: If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit.
force Boolean: 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.
project String: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Outputs

All input properties are implicitly available as output properties. Additionally, the ConsumerQuotaOverride resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.
Name string: The server-generated name of the quota override.

Id string: The provider-assigned unique ID for this managed resource.
Name string: The server-generated name of the quota override.

id String: The provider-assigned unique ID for this managed resource.
name String: The server-generated name of the quota override.

id string: The provider-assigned unique ID for this managed resource.
name string: The server-generated name of the quota override.

id str: The provider-assigned unique ID for this managed resource.
name str: The server-generated name of the quota override.

id String: The provider-assigned unique ID for this managed resource.
name String: The server-generated name of the quota override.

Look up Existing ConsumerQuotaOverride Resource

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

public static get(name: string, id: Input<ID>, state?: ConsumerQuotaOverrideState, opts?: CustomResourceOptions): ConsumerQuotaOverride

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        dimensions: Optional[Mapping[str, str]] = None,
        force: Optional[bool] = None,
        limit: Optional[str] = None,
        metric: Optional[str] = None,
        name: Optional[str] = None,
        override_value: Optional[str] = None,
        project: Optional[str] = None,
        service: Optional[str] = None) -> ConsumerQuotaOverride

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

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

public static ConsumerQuotaOverride get(String name, Output<String> id, ConsumerQuotaOverrideState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Dimensions Dictionary<string, string>: If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit.
Force bool: 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.
Limit string: 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}.
Metric string: The metric that should be limited, e.g. compute.googleapis.com/cpus.
Name string: The server-generated name of the quota override.
OverrideValue string: The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota).
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Service string: The service that the metrics belong to, e.g. compute.googleapis.com.

Dimensions map[string]string: If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit.
Force bool: 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.
Limit string: 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}.
Metric string: The metric that should be limited, e.g. compute.googleapis.com/cpus.
Name string: The server-generated name of the quota override.
OverrideValue string: The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota).
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Service string: The service that the metrics belong to, e.g. compute.googleapis.com.

dimensions Map<String,String>: If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit.
force Boolean: 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.
limit String: 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}.
metric String: The metric that should be limited, e.g. compute.googleapis.com/cpus.
name String: The server-generated name of the quota override.
overrideValue String: The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota).
project String: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
service String: The service that the metrics belong to, e.g. compute.googleapis.com.

dimensions {[key: string]: string}: If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit.
force boolean: 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.
limit string: 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}.
metric string: The metric that should be limited, e.g. compute.googleapis.com/cpus.
name string: The server-generated name of the quota override.
overrideValue string: The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota).
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
service string: The service that the metrics belong to, e.g. compute.googleapis.com.

dimensions Mapping[str, str]: If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit.
force bool: 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.
limit str: 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}.
metric str: The metric that should be limited, e.g. compute.googleapis.com/cpus.
name str: The server-generated name of the quota override.
override_value str: The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota).
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
service str: The service that the metrics belong to, e.g. compute.googleapis.com.

dimensions Map<String>: If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit.
force Boolean: 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.
limit String: 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}.
metric String: The metric that should be limited, e.g. compute.googleapis.com/cpus.
name String: The server-generated name of the quota override.
overrideValue String: The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota).
project String: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
service String: The service that the metrics belong to, e.g. compute.googleapis.com.

Import

ConsumerQuotaOverride can be imported using any of these accepted formats

 $ pulumi import gcp:serviceusage/consumerQuotaOverride:ConsumerQuotaOverride default projects/{{project}}/services/{{service}}/consumerQuotaMetrics/{{metric}}/limits/{{limit}}/consumerOverrides/{{name}}

 $ pulumi import gcp:serviceusage/consumerQuotaOverride:ConsumerQuotaOverride default services/{{service}}/consumerQuotaMetrics/{{metric}}/limits/{{limit}}/consumerOverrides/{{name}}

 $ pulumi import gcp:serviceusage/consumerQuotaOverride:ConsumerQuotaOverride default {{service}}/{{metric}}/{{limit}}/{{name}}

Package Details

Repository: Google Cloud (GCP) Classic pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.