Module serviceusage
This page documents the language specification for the gcp package. If you're looking for help working with the inputs, outputs, or functions of gcp resources in a Pulumi program, please see the resource documentation for examples and API reference.
Resources
Others
Resources
Resource ConsumerQuotaOverride
class ConsumerQuotaOverride extends CustomResourceA 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
Example Usage - Consumer Quota Override
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const myProject = new gcp.organizations.Project("myProject", {
projectId: "quota",
orgId: "123456789",
});
const override = new gcp.serviceusage.ConsumerQuotaOverride("override", {
project: myProject.projectId,
service: "servicemanagement.googleapis.com",
metric: `servicemanagement.googleapis.com%2Fdefault_requests`,
limit: `%2Fmin%2Fproject`,
overrideValue: "95",
force: true,
});constructor
new ConsumerQuotaOverride(name: string, args: ConsumerQuotaOverrideArgs, opts?: pulumi.CustomResourceOptions)Create a ConsumerQuotaOverride resource with the given unique name, arguments, and options.
nameThe unique name of the resource.argsThe arguments to use to populate this resource's properties.optsA bag of options that control this resource's behavior.
method get
public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ConsumerQuotaOverrideState, opts?: pulumi.CustomResourceOptions): ConsumerQuotaOverrideGet an existing ConsumerQuotaOverride resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
method getProvider
getProvider(moduleMember: string): ProviderResource | undefinedmethod isInstance
public static isInstance(obj: any): obj is ConsumerQuotaOverrideReturns true if the given object is an instance of ConsumerQuotaOverride. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.
property dimensions
public dimensions: pulumi.Output<{[key: string]: string} | undefined>;If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit.
property force
public force: pulumi.Output<boolean | undefined>;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.
property id
id: Output<ID>;id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.
property limit
public limit: pulumi.Output<string>;The limit on the metric, e.g. /project/region.
property metric
public metric: pulumi.Output<string>;The metric that should be limited, e.g. compute.googleapis.com/cpus.
property name
public name: pulumi.Output<string>;The server-generated name of the quota override.
property overrideValue
public overrideValue: pulumi.Output<string>;The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota).
property project
public project: pulumi.Output<string>;The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
property service
public service: pulumi.Output<string>;The service that the metrics belong to, e.g. compute.googleapis.com.
property urn
urn: Output<URN>;urn is the stable logical URN used to distinctly address a resource, both before and after deployments.
Others
interface ConsumerQuotaOverrideArgs
interface ConsumerQuotaOverrideArgsThe set of arguments for constructing a ConsumerQuotaOverride resource.
property dimensions
dimensions?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit.
property force
force?: pulumi.Input<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.
property limit
limit: pulumi.Input<string>;The limit on the metric, e.g. /project/region.
property metric
metric: pulumi.Input<string>;The metric that should be limited, e.g. compute.googleapis.com/cpus.
property overrideValue
overrideValue: pulumi.Input<string>;The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota).
property project
project?: pulumi.Input<string>;The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
property service
service: pulumi.Input<string>;The service that the metrics belong to, e.g. compute.googleapis.com.
interface ConsumerQuotaOverrideState
interface ConsumerQuotaOverrideStateInput properties used for looking up and filtering ConsumerQuotaOverride resources.
property dimensions
dimensions?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit.
property force
force?: pulumi.Input<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.
property limit
limit?: pulumi.Input<string>;The limit on the metric, e.g. /project/region.
property metric
metric?: pulumi.Input<string>;The metric that should be limited, e.g. compute.googleapis.com/cpus.
property name
name?: pulumi.Input<string>;The server-generated name of the quota override.
property overrideValue
overrideValue?: pulumi.Input<string>;The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota).
property project
project?: pulumi.Input<string>;The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
property service
service?: pulumi.Input<string>;The service that the metrics belong to, e.g. compute.googleapis.com.