gcp.cloudquota.SQuotaPreference
Explore with Pulumi AI
QuotaPreference represents the preferred quota configuration specified for a project, folder or organization. There is only one QuotaPreference resource for a quota value targeting a unique set of dimensions.
To get more information about QuotaPreference, see:
- API documentation
- How-to Guides
Example Usage
Cloudquotas Quota Preference Basic
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const preference = new gcp.cloudquota.SQuotaPreference("preference", {
parent: "projects/my-project-name",
name: "compute_googleapis_com-CPUS-per-project_us-east1",
dimensions: {
region: "us-east1",
},
service: "compute.googleapis.com",
quotaId: "CPUS-per-project-region",
contactEmail: "testuser@gmail.com",
quotaConfig: {
preferredValue: "200",
},
});
import pulumi
import pulumi_gcp as gcp
preference = gcp.cloudquota.SQuotaPreference("preference",
parent="projects/my-project-name",
name="compute_googleapis_com-CPUS-per-project_us-east1",
dimensions={
"region": "us-east1",
},
service="compute.googleapis.com",
quota_id="CPUS-per-project-region",
contact_email="testuser@gmail.com",
quota_config={
"preferred_value": "200",
})
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/cloudquota"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := cloudquota.NewSQuotaPreference(ctx, "preference", &cloudquota.SQuotaPreferenceArgs{
Parent: pulumi.String("projects/my-project-name"),
Name: pulumi.String("compute_googleapis_com-CPUS-per-project_us-east1"),
Dimensions: pulumi.StringMap{
"region": pulumi.String("us-east1"),
},
Service: pulumi.String("compute.googleapis.com"),
QuotaId: pulumi.String("CPUS-per-project-region"),
ContactEmail: pulumi.String("testuser@gmail.com"),
QuotaConfig: &cloudquota.SQuotaPreferenceQuotaConfigArgs{
PreferredValue: pulumi.String("200"),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var preference = new Gcp.CloudQuota.SQuotaPreference("preference", new()
{
Parent = "projects/my-project-name",
Name = "compute_googleapis_com-CPUS-per-project_us-east1",
Dimensions =
{
{ "region", "us-east1" },
},
Service = "compute.googleapis.com",
QuotaId = "CPUS-per-project-region",
ContactEmail = "testuser@gmail.com",
QuotaConfig = new Gcp.CloudQuota.Inputs.SQuotaPreferenceQuotaConfigArgs
{
PreferredValue = "200",
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.cloudquota.SQuotaPreference;
import com.pulumi.gcp.cloudquota.SQuotaPreferenceArgs;
import com.pulumi.gcp.cloudquota.inputs.SQuotaPreferenceQuotaConfigArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var preference = new SQuotaPreference("preference", SQuotaPreferenceArgs.builder()
.parent("projects/my-project-name")
.name("compute_googleapis_com-CPUS-per-project_us-east1")
.dimensions(Map.of("region", "us-east1"))
.service("compute.googleapis.com")
.quotaId("CPUS-per-project-region")
.contactEmail("testuser@gmail.com")
.quotaConfig(SQuotaPreferenceQuotaConfigArgs.builder()
.preferredValue(200)
.build())
.build());
}
}
resources:
preference:
type: gcp:cloudquota:SQuotaPreference
properties:
parent: projects/my-project-name
name: compute_googleapis_com-CPUS-per-project_us-east1
dimensions:
region: us-east1
service: compute.googleapis.com
quotaId: CPUS-per-project-region
contactEmail: testuser@gmail.com
quotaConfig:
preferredValue: 200
Create SQuotaPreference Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new SQuotaPreference(name: string, args: SQuotaPreferenceArgs, opts?: CustomResourceOptions);
@overload
def SQuotaPreference(resource_name: str,
args: SQuotaPreferenceArgs,
opts: Optional[ResourceOptions] = None)
@overload
def SQuotaPreference(resource_name: str,
opts: Optional[ResourceOptions] = None,
quota_config: Optional[SQuotaPreferenceQuotaConfigArgs] = None,
contact_email: Optional[str] = None,
dimensions: Optional[Mapping[str, str]] = None,
ignore_safety_checks: Optional[str] = None,
justification: Optional[str] = None,
name: Optional[str] = None,
parent: Optional[str] = None,
quota_id: Optional[str] = None,
service: Optional[str] = None)
func NewSQuotaPreference(ctx *Context, name string, args SQuotaPreferenceArgs, opts ...ResourceOption) (*SQuotaPreference, error)
public SQuotaPreference(string name, SQuotaPreferenceArgs args, CustomResourceOptions? opts = null)
public SQuotaPreference(String name, SQuotaPreferenceArgs args)
public SQuotaPreference(String name, SQuotaPreferenceArgs args, CustomResourceOptions options)
type: gcp:cloudquota:SQuotaPreference
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args SQuotaPreferenceArgs
- 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 SQuotaPreferenceArgs
- 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 SQuotaPreferenceArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SQuotaPreferenceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args SQuotaPreferenceArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var squotaPreferenceResource = new Gcp.CloudQuota.SQuotaPreference("squotaPreferenceResource", new()
{
QuotaConfig = new Gcp.CloudQuota.Inputs.SQuotaPreferenceQuotaConfigArgs
{
PreferredValue = "string",
Annotations =
{
{ "string", "string" },
},
GrantedValue = "string",
RequestOrigin = "string",
StateDetail = "string",
TraceId = "string",
},
ContactEmail = "string",
Dimensions =
{
{ "string", "string" },
},
IgnoreSafetyChecks = "string",
Justification = "string",
Name = "string",
Parent = "string",
QuotaId = "string",
Service = "string",
});
example, err := cloudquota.NewSQuotaPreference(ctx, "squotaPreferenceResource", &cloudquota.SQuotaPreferenceArgs{
QuotaConfig: &cloudquota.SQuotaPreferenceQuotaConfigArgs{
PreferredValue: pulumi.String("string"),
Annotations: pulumi.StringMap{
"string": pulumi.String("string"),
},
GrantedValue: pulumi.String("string"),
RequestOrigin: pulumi.String("string"),
StateDetail: pulumi.String("string"),
TraceId: pulumi.String("string"),
},
ContactEmail: pulumi.String("string"),
Dimensions: pulumi.StringMap{
"string": pulumi.String("string"),
},
IgnoreSafetyChecks: pulumi.String("string"),
Justification: pulumi.String("string"),
Name: pulumi.String("string"),
Parent: pulumi.String("string"),
QuotaId: pulumi.String("string"),
Service: pulumi.String("string"),
})
var squotaPreferenceResource = new SQuotaPreference("squotaPreferenceResource", SQuotaPreferenceArgs.builder()
.quotaConfig(SQuotaPreferenceQuotaConfigArgs.builder()
.preferredValue("string")
.annotations(Map.of("string", "string"))
.grantedValue("string")
.requestOrigin("string")
.stateDetail("string")
.traceId("string")
.build())
.contactEmail("string")
.dimensions(Map.of("string", "string"))
.ignoreSafetyChecks("string")
.justification("string")
.name("string")
.parent("string")
.quotaId("string")
.service("string")
.build());
squota_preference_resource = gcp.cloudquota.SQuotaPreference("squotaPreferenceResource",
quota_config={
"preferred_value": "string",
"annotations": {
"string": "string",
},
"granted_value": "string",
"request_origin": "string",
"state_detail": "string",
"trace_id": "string",
},
contact_email="string",
dimensions={
"string": "string",
},
ignore_safety_checks="string",
justification="string",
name="string",
parent="string",
quota_id="string",
service="string")
const squotaPreferenceResource = new gcp.cloudquota.SQuotaPreference("squotaPreferenceResource", {
quotaConfig: {
preferredValue: "string",
annotations: {
string: "string",
},
grantedValue: "string",
requestOrigin: "string",
stateDetail: "string",
traceId: "string",
},
contactEmail: "string",
dimensions: {
string: "string",
},
ignoreSafetyChecks: "string",
justification: "string",
name: "string",
parent: "string",
quotaId: "string",
service: "string",
});
type: gcp:cloudquota:SQuotaPreference
properties:
contactEmail: string
dimensions:
string: string
ignoreSafetyChecks: string
justification: string
name: string
parent: string
quotaConfig:
annotations:
string: string
grantedValue: string
preferredValue: string
requestOrigin: string
stateDetail: string
traceId: string
quotaId: string
service: string
SQuotaPreference Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The SQuotaPreference resource accepts the following input properties:
- Quota
Config SQuotaPreference Quota Config - The preferred quota configuration. Structure is documented below.
- Contact
Email string - An email address that can be used for quota related communication between the Google Cloud and the user in case the Google Cloud needs further information to make a decision on whether the user preferred quota can be granted. The Google account for the email address must have quota update permission for the project, folder or organization this quota preference is for.
- Dimensions Dictionary<string, string>
- The dimensions that this quota preference applies to. The key of the map entry is the name of a dimension, such as "region", "zone", "network_id", and the value of the map entry is the dimension value. If a dimension is missing from the map of dimensions, the quota preference applies to all the dimension values except for those that have other quota preferences configured for the specific value. NOTE: QuotaPreferences can only be applied across all values of "user" and "resource" dimension. Do not set values for "user" or "resource" in the dimension map. Example: '{"provider": "Foo Inc"}' where "provider" is a service specific dimension.
- Ignore
Safety stringChecks - The list of quota safety checks to be ignored. Default value: "QUOTA_SAFETY_CHECK_UNSPECIFIED" Possible values: ["QUOTA_SAFETY_CHECK_UNSPECIFIED", "QUOTA_DECREASE_BELOW_USAGE", "QUOTA_DECREASE_PERCENTAGE_TOO_HIGH"]
- Justification string
- The reason / justification for this quota preference.
- Name string
- The resource name of the quota preference. Required except in the CREATE requests.
- Parent string
- The parent of the quota preference. Allowed parents are "projects/[project-id / number]" or "folders/[folder-id / number]" or "organizations/[org-id / number]".
- Quota
Id string - The id of the quota to which the quota preference is applied. A quota id is unique in the service.
Example:
CPUS-per-project-region
. - Service string
- The name of the service to which the quota preference is applied.
- Quota
Config SQuotaPreference Quota Config Args - The preferred quota configuration. Structure is documented below.
- Contact
Email string - An email address that can be used for quota related communication between the Google Cloud and the user in case the Google Cloud needs further information to make a decision on whether the user preferred quota can be granted. The Google account for the email address must have quota update permission for the project, folder or organization this quota preference is for.
- Dimensions map[string]string
- The dimensions that this quota preference applies to. The key of the map entry is the name of a dimension, such as "region", "zone", "network_id", and the value of the map entry is the dimension value. If a dimension is missing from the map of dimensions, the quota preference applies to all the dimension values except for those that have other quota preferences configured for the specific value. NOTE: QuotaPreferences can only be applied across all values of "user" and "resource" dimension. Do not set values for "user" or "resource" in the dimension map. Example: '{"provider": "Foo Inc"}' where "provider" is a service specific dimension.
- Ignore
Safety stringChecks - The list of quota safety checks to be ignored. Default value: "QUOTA_SAFETY_CHECK_UNSPECIFIED" Possible values: ["QUOTA_SAFETY_CHECK_UNSPECIFIED", "QUOTA_DECREASE_BELOW_USAGE", "QUOTA_DECREASE_PERCENTAGE_TOO_HIGH"]
- Justification string
- The reason / justification for this quota preference.
- Name string
- The resource name of the quota preference. Required except in the CREATE requests.
- Parent string
- The parent of the quota preference. Allowed parents are "projects/[project-id / number]" or "folders/[folder-id / number]" or "organizations/[org-id / number]".
- Quota
Id string - The id of the quota to which the quota preference is applied. A quota id is unique in the service.
Example:
CPUS-per-project-region
. - Service string
- The name of the service to which the quota preference is applied.
- quota
Config SQuotaPreference Quota Config - The preferred quota configuration. Structure is documented below.
- contact
Email String - An email address that can be used for quota related communication between the Google Cloud and the user in case the Google Cloud needs further information to make a decision on whether the user preferred quota can be granted. The Google account for the email address must have quota update permission for the project, folder or organization this quota preference is for.
- dimensions Map<String,String>
- The dimensions that this quota preference applies to. The key of the map entry is the name of a dimension, such as "region", "zone", "network_id", and the value of the map entry is the dimension value. If a dimension is missing from the map of dimensions, the quota preference applies to all the dimension values except for those that have other quota preferences configured for the specific value. NOTE: QuotaPreferences can only be applied across all values of "user" and "resource" dimension. Do not set values for "user" or "resource" in the dimension map. Example: '{"provider": "Foo Inc"}' where "provider" is a service specific dimension.
- ignore
Safety StringChecks - The list of quota safety checks to be ignored. Default value: "QUOTA_SAFETY_CHECK_UNSPECIFIED" Possible values: ["QUOTA_SAFETY_CHECK_UNSPECIFIED", "QUOTA_DECREASE_BELOW_USAGE", "QUOTA_DECREASE_PERCENTAGE_TOO_HIGH"]
- justification String
- The reason / justification for this quota preference.
- name String
- The resource name of the quota preference. Required except in the CREATE requests.
- parent String
- The parent of the quota preference. Allowed parents are "projects/[project-id / number]" or "folders/[folder-id / number]" or "organizations/[org-id / number]".
- quota
Id String - The id of the quota to which the quota preference is applied. A quota id is unique in the service.
Example:
CPUS-per-project-region
. - service String
- The name of the service to which the quota preference is applied.
- quota
Config SQuotaPreference Quota Config - The preferred quota configuration. Structure is documented below.
- contact
Email string - An email address that can be used for quota related communication between the Google Cloud and the user in case the Google Cloud needs further information to make a decision on whether the user preferred quota can be granted. The Google account for the email address must have quota update permission for the project, folder or organization this quota preference is for.
- dimensions {[key: string]: string}
- The dimensions that this quota preference applies to. The key of the map entry is the name of a dimension, such as "region", "zone", "network_id", and the value of the map entry is the dimension value. If a dimension is missing from the map of dimensions, the quota preference applies to all the dimension values except for those that have other quota preferences configured for the specific value. NOTE: QuotaPreferences can only be applied across all values of "user" and "resource" dimension. Do not set values for "user" or "resource" in the dimension map. Example: '{"provider": "Foo Inc"}' where "provider" is a service specific dimension.
- ignore
Safety stringChecks - The list of quota safety checks to be ignored. Default value: "QUOTA_SAFETY_CHECK_UNSPECIFIED" Possible values: ["QUOTA_SAFETY_CHECK_UNSPECIFIED", "QUOTA_DECREASE_BELOW_USAGE", "QUOTA_DECREASE_PERCENTAGE_TOO_HIGH"]
- justification string
- The reason / justification for this quota preference.
- name string
- The resource name of the quota preference. Required except in the CREATE requests.
- parent string
- The parent of the quota preference. Allowed parents are "projects/[project-id / number]" or "folders/[folder-id / number]" or "organizations/[org-id / number]".
- quota
Id string - The id of the quota to which the quota preference is applied. A quota id is unique in the service.
Example:
CPUS-per-project-region
. - service string
- The name of the service to which the quota preference is applied.
- quota_
config SQuotaPreference Quota Config Args - The preferred quota configuration. Structure is documented below.
- contact_
email str - An email address that can be used for quota related communication between the Google Cloud and the user in case the Google Cloud needs further information to make a decision on whether the user preferred quota can be granted. The Google account for the email address must have quota update permission for the project, folder or organization this quota preference is for.
- dimensions Mapping[str, str]
- The dimensions that this quota preference applies to. The key of the map entry is the name of a dimension, such as "region", "zone", "network_id", and the value of the map entry is the dimension value. If a dimension is missing from the map of dimensions, the quota preference applies to all the dimension values except for those that have other quota preferences configured for the specific value. NOTE: QuotaPreferences can only be applied across all values of "user" and "resource" dimension. Do not set values for "user" or "resource" in the dimension map. Example: '{"provider": "Foo Inc"}' where "provider" is a service specific dimension.
- ignore_
safety_ strchecks - The list of quota safety checks to be ignored. Default value: "QUOTA_SAFETY_CHECK_UNSPECIFIED" Possible values: ["QUOTA_SAFETY_CHECK_UNSPECIFIED", "QUOTA_DECREASE_BELOW_USAGE", "QUOTA_DECREASE_PERCENTAGE_TOO_HIGH"]
- justification str
- The reason / justification for this quota preference.
- name str
- The resource name of the quota preference. Required except in the CREATE requests.
- parent str
- The parent of the quota preference. Allowed parents are "projects/[project-id / number]" or "folders/[folder-id / number]" or "organizations/[org-id / number]".
- quota_
id str - The id of the quota to which the quota preference is applied. A quota id is unique in the service.
Example:
CPUS-per-project-region
. - service str
- The name of the service to which the quota preference is applied.
- quota
Config Property Map - The preferred quota configuration. Structure is documented below.
- contact
Email String - An email address that can be used for quota related communication between the Google Cloud and the user in case the Google Cloud needs further information to make a decision on whether the user preferred quota can be granted. The Google account for the email address must have quota update permission for the project, folder or organization this quota preference is for.
- dimensions Map<String>
- The dimensions that this quota preference applies to. The key of the map entry is the name of a dimension, such as "region", "zone", "network_id", and the value of the map entry is the dimension value. If a dimension is missing from the map of dimensions, the quota preference applies to all the dimension values except for those that have other quota preferences configured for the specific value. NOTE: QuotaPreferences can only be applied across all values of "user" and "resource" dimension. Do not set values for "user" or "resource" in the dimension map. Example: '{"provider": "Foo Inc"}' where "provider" is a service specific dimension.
- ignore
Safety StringChecks - The list of quota safety checks to be ignored. Default value: "QUOTA_SAFETY_CHECK_UNSPECIFIED" Possible values: ["QUOTA_SAFETY_CHECK_UNSPECIFIED", "QUOTA_DECREASE_BELOW_USAGE", "QUOTA_DECREASE_PERCENTAGE_TOO_HIGH"]
- justification String
- The reason / justification for this quota preference.
- name String
- The resource name of the quota preference. Required except in the CREATE requests.
- parent String
- The parent of the quota preference. Allowed parents are "projects/[project-id / number]" or "folders/[folder-id / number]" or "organizations/[org-id / number]".
- quota
Id String - The id of the quota to which the quota preference is applied. A quota id is unique in the service.
Example:
CPUS-per-project-region
. - service String
- The name of the service to which the quota preference is applied.
Outputs
All input properties are implicitly available as output properties. Additionally, the SQuotaPreference resource produces the following output properties:
- Create
Time string - Create time stamp.
A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples:
2014-10-02T15:01:23Z
and2014-10-02T15:01:23.045123456Z
. - Etag string
- The current etag of the quota preference. If an etag is provided on update and does not match the current server's etag of the quota preference, the request will be blocked and an ABORTED error will be returned. See https://google.aip.dev/134#etags for more details on etags.
- Id string
- The provider-assigned unique ID for this managed resource.
- Reconciling bool
- Is the quota preference pending Google Cloud approval and fulfillment.
- Update
Time string - Update time stamp.
A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples:
2014-10-02T15:01:23Z
and2014-10-02T15:01:23.045123456Z
.
- Create
Time string - Create time stamp.
A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples:
2014-10-02T15:01:23Z
and2014-10-02T15:01:23.045123456Z
. - Etag string
- The current etag of the quota preference. If an etag is provided on update and does not match the current server's etag of the quota preference, the request will be blocked and an ABORTED error will be returned. See https://google.aip.dev/134#etags for more details on etags.
- Id string
- The provider-assigned unique ID for this managed resource.
- Reconciling bool
- Is the quota preference pending Google Cloud approval and fulfillment.
- Update
Time string - Update time stamp.
A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples:
2014-10-02T15:01:23Z
and2014-10-02T15:01:23.045123456Z
.
- create
Time String - Create time stamp.
A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples:
2014-10-02T15:01:23Z
and2014-10-02T15:01:23.045123456Z
. - etag String
- The current etag of the quota preference. If an etag is provided on update and does not match the current server's etag of the quota preference, the request will be blocked and an ABORTED error will be returned. See https://google.aip.dev/134#etags for more details on etags.
- id String
- The provider-assigned unique ID for this managed resource.
- reconciling Boolean
- Is the quota preference pending Google Cloud approval and fulfillment.
- update
Time String - Update time stamp.
A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples:
2014-10-02T15:01:23Z
and2014-10-02T15:01:23.045123456Z
.
- create
Time string - Create time stamp.
A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples:
2014-10-02T15:01:23Z
and2014-10-02T15:01:23.045123456Z
. - etag string
- The current etag of the quota preference. If an etag is provided on update and does not match the current server's etag of the quota preference, the request will be blocked and an ABORTED error will be returned. See https://google.aip.dev/134#etags for more details on etags.
- id string
- The provider-assigned unique ID for this managed resource.
- reconciling boolean
- Is the quota preference pending Google Cloud approval and fulfillment.
- update
Time string - Update time stamp.
A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples:
2014-10-02T15:01:23Z
and2014-10-02T15:01:23.045123456Z
.
- create_
time str - Create time stamp.
A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples:
2014-10-02T15:01:23Z
and2014-10-02T15:01:23.045123456Z
. - etag str
- The current etag of the quota preference. If an etag is provided on update and does not match the current server's etag of the quota preference, the request will be blocked and an ABORTED error will be returned. See https://google.aip.dev/134#etags for more details on etags.
- id str
- The provider-assigned unique ID for this managed resource.
- reconciling bool
- Is the quota preference pending Google Cloud approval and fulfillment.
- update_
time str - Update time stamp.
A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples:
2014-10-02T15:01:23Z
and2014-10-02T15:01:23.045123456Z
.
- create
Time String - Create time stamp.
A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples:
2014-10-02T15:01:23Z
and2014-10-02T15:01:23.045123456Z
. - etag String
- The current etag of the quota preference. If an etag is provided on update and does not match the current server's etag of the quota preference, the request will be blocked and an ABORTED error will be returned. See https://google.aip.dev/134#etags for more details on etags.
- id String
- The provider-assigned unique ID for this managed resource.
- reconciling Boolean
- Is the quota preference pending Google Cloud approval and fulfillment.
- update
Time String - Update time stamp.
A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples:
2014-10-02T15:01:23Z
and2014-10-02T15:01:23.045123456Z
.
Look up Existing SQuotaPreference Resource
Get an existing SQuotaPreference 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?: SQuotaPreferenceState, opts?: CustomResourceOptions): SQuotaPreference
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
contact_email: Optional[str] = None,
create_time: Optional[str] = None,
dimensions: Optional[Mapping[str, str]] = None,
etag: Optional[str] = None,
ignore_safety_checks: Optional[str] = None,
justification: Optional[str] = None,
name: Optional[str] = None,
parent: Optional[str] = None,
quota_config: Optional[SQuotaPreferenceQuotaConfigArgs] = None,
quota_id: Optional[str] = None,
reconciling: Optional[bool] = None,
service: Optional[str] = None,
update_time: Optional[str] = None) -> SQuotaPreference
func GetSQuotaPreference(ctx *Context, name string, id IDInput, state *SQuotaPreferenceState, opts ...ResourceOption) (*SQuotaPreference, error)
public static SQuotaPreference Get(string name, Input<string> id, SQuotaPreferenceState? state, CustomResourceOptions? opts = null)
public static SQuotaPreference get(String name, Output<String> id, SQuotaPreferenceState 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.
- Contact
Email string - An email address that can be used for quota related communication between the Google Cloud and the user in case the Google Cloud needs further information to make a decision on whether the user preferred quota can be granted. The Google account for the email address must have quota update permission for the project, folder or organization this quota preference is for.
- Create
Time string - Create time stamp.
A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples:
2014-10-02T15:01:23Z
and2014-10-02T15:01:23.045123456Z
. - Dimensions Dictionary<string, string>
- The dimensions that this quota preference applies to. The key of the map entry is the name of a dimension, such as "region", "zone", "network_id", and the value of the map entry is the dimension value. If a dimension is missing from the map of dimensions, the quota preference applies to all the dimension values except for those that have other quota preferences configured for the specific value. NOTE: QuotaPreferences can only be applied across all values of "user" and "resource" dimension. Do not set values for "user" or "resource" in the dimension map. Example: '{"provider": "Foo Inc"}' where "provider" is a service specific dimension.
- Etag string
- The current etag of the quota preference. If an etag is provided on update and does not match the current server's etag of the quota preference, the request will be blocked and an ABORTED error will be returned. See https://google.aip.dev/134#etags for more details on etags.
- Ignore
Safety stringChecks - The list of quota safety checks to be ignored. Default value: "QUOTA_SAFETY_CHECK_UNSPECIFIED" Possible values: ["QUOTA_SAFETY_CHECK_UNSPECIFIED", "QUOTA_DECREASE_BELOW_USAGE", "QUOTA_DECREASE_PERCENTAGE_TOO_HIGH"]
- Justification string
- The reason / justification for this quota preference.
- Name string
- The resource name of the quota preference. Required except in the CREATE requests.
- Parent string
- The parent of the quota preference. Allowed parents are "projects/[project-id / number]" or "folders/[folder-id / number]" or "organizations/[org-id / number]".
- Quota
Config SQuotaPreference Quota Config - The preferred quota configuration. Structure is documented below.
- Quota
Id string - The id of the quota to which the quota preference is applied. A quota id is unique in the service.
Example:
CPUS-per-project-region
. - Reconciling bool
- Is the quota preference pending Google Cloud approval and fulfillment.
- Service string
- The name of the service to which the quota preference is applied.
- Update
Time string - Update time stamp.
A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples:
2014-10-02T15:01:23Z
and2014-10-02T15:01:23.045123456Z
.
- Contact
Email string - An email address that can be used for quota related communication between the Google Cloud and the user in case the Google Cloud needs further information to make a decision on whether the user preferred quota can be granted. The Google account for the email address must have quota update permission for the project, folder or organization this quota preference is for.
- Create
Time string - Create time stamp.
A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples:
2014-10-02T15:01:23Z
and2014-10-02T15:01:23.045123456Z
. - Dimensions map[string]string
- The dimensions that this quota preference applies to. The key of the map entry is the name of a dimension, such as "region", "zone", "network_id", and the value of the map entry is the dimension value. If a dimension is missing from the map of dimensions, the quota preference applies to all the dimension values except for those that have other quota preferences configured for the specific value. NOTE: QuotaPreferences can only be applied across all values of "user" and "resource" dimension. Do not set values for "user" or "resource" in the dimension map. Example: '{"provider": "Foo Inc"}' where "provider" is a service specific dimension.
- Etag string
- The current etag of the quota preference. If an etag is provided on update and does not match the current server's etag of the quota preference, the request will be blocked and an ABORTED error will be returned. See https://google.aip.dev/134#etags for more details on etags.
- Ignore
Safety stringChecks - The list of quota safety checks to be ignored. Default value: "QUOTA_SAFETY_CHECK_UNSPECIFIED" Possible values: ["QUOTA_SAFETY_CHECK_UNSPECIFIED", "QUOTA_DECREASE_BELOW_USAGE", "QUOTA_DECREASE_PERCENTAGE_TOO_HIGH"]
- Justification string
- The reason / justification for this quota preference.
- Name string
- The resource name of the quota preference. Required except in the CREATE requests.
- Parent string
- The parent of the quota preference. Allowed parents are "projects/[project-id / number]" or "folders/[folder-id / number]" or "organizations/[org-id / number]".
- Quota
Config SQuotaPreference Quota Config Args - The preferred quota configuration. Structure is documented below.
- Quota
Id string - The id of the quota to which the quota preference is applied. A quota id is unique in the service.
Example:
CPUS-per-project-region
. - Reconciling bool
- Is the quota preference pending Google Cloud approval and fulfillment.
- Service string
- The name of the service to which the quota preference is applied.
- Update
Time string - Update time stamp.
A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples:
2014-10-02T15:01:23Z
and2014-10-02T15:01:23.045123456Z
.
- contact
Email String - An email address that can be used for quota related communication between the Google Cloud and the user in case the Google Cloud needs further information to make a decision on whether the user preferred quota can be granted. The Google account for the email address must have quota update permission for the project, folder or organization this quota preference is for.
- create
Time String - Create time stamp.
A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples:
2014-10-02T15:01:23Z
and2014-10-02T15:01:23.045123456Z
. - dimensions Map<String,String>
- The dimensions that this quota preference applies to. The key of the map entry is the name of a dimension, such as "region", "zone", "network_id", and the value of the map entry is the dimension value. If a dimension is missing from the map of dimensions, the quota preference applies to all the dimension values except for those that have other quota preferences configured for the specific value. NOTE: QuotaPreferences can only be applied across all values of "user" and "resource" dimension. Do not set values for "user" or "resource" in the dimension map. Example: '{"provider": "Foo Inc"}' where "provider" is a service specific dimension.
- etag String
- The current etag of the quota preference. If an etag is provided on update and does not match the current server's etag of the quota preference, the request will be blocked and an ABORTED error will be returned. See https://google.aip.dev/134#etags for more details on etags.
- ignore
Safety StringChecks - The list of quota safety checks to be ignored. Default value: "QUOTA_SAFETY_CHECK_UNSPECIFIED" Possible values: ["QUOTA_SAFETY_CHECK_UNSPECIFIED", "QUOTA_DECREASE_BELOW_USAGE", "QUOTA_DECREASE_PERCENTAGE_TOO_HIGH"]
- justification String
- The reason / justification for this quota preference.
- name String
- The resource name of the quota preference. Required except in the CREATE requests.
- parent String
- The parent of the quota preference. Allowed parents are "projects/[project-id / number]" or "folders/[folder-id / number]" or "organizations/[org-id / number]".
- quota
Config SQuotaPreference Quota Config - The preferred quota configuration. Structure is documented below.
- quota
Id String - The id of the quota to which the quota preference is applied. A quota id is unique in the service.
Example:
CPUS-per-project-region
. - reconciling Boolean
- Is the quota preference pending Google Cloud approval and fulfillment.
- service String
- The name of the service to which the quota preference is applied.
- update
Time String - Update time stamp.
A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples:
2014-10-02T15:01:23Z
and2014-10-02T15:01:23.045123456Z
.
- contact
Email string - An email address that can be used for quota related communication between the Google Cloud and the user in case the Google Cloud needs further information to make a decision on whether the user preferred quota can be granted. The Google account for the email address must have quota update permission for the project, folder or organization this quota preference is for.
- create
Time string - Create time stamp.
A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples:
2014-10-02T15:01:23Z
and2014-10-02T15:01:23.045123456Z
. - dimensions {[key: string]: string}
- The dimensions that this quota preference applies to. The key of the map entry is the name of a dimension, such as "region", "zone", "network_id", and the value of the map entry is the dimension value. If a dimension is missing from the map of dimensions, the quota preference applies to all the dimension values except for those that have other quota preferences configured for the specific value. NOTE: QuotaPreferences can only be applied across all values of "user" and "resource" dimension. Do not set values for "user" or "resource" in the dimension map. Example: '{"provider": "Foo Inc"}' where "provider" is a service specific dimension.
- etag string
- The current etag of the quota preference. If an etag is provided on update and does not match the current server's etag of the quota preference, the request will be blocked and an ABORTED error will be returned. See https://google.aip.dev/134#etags for more details on etags.
- ignore
Safety stringChecks - The list of quota safety checks to be ignored. Default value: "QUOTA_SAFETY_CHECK_UNSPECIFIED" Possible values: ["QUOTA_SAFETY_CHECK_UNSPECIFIED", "QUOTA_DECREASE_BELOW_USAGE", "QUOTA_DECREASE_PERCENTAGE_TOO_HIGH"]
- justification string
- The reason / justification for this quota preference.
- name string
- The resource name of the quota preference. Required except in the CREATE requests.
- parent string
- The parent of the quota preference. Allowed parents are "projects/[project-id / number]" or "folders/[folder-id / number]" or "organizations/[org-id / number]".
- quota
Config SQuotaPreference Quota Config - The preferred quota configuration. Structure is documented below.
- quota
Id string - The id of the quota to which the quota preference is applied. A quota id is unique in the service.
Example:
CPUS-per-project-region
. - reconciling boolean
- Is the quota preference pending Google Cloud approval and fulfillment.
- service string
- The name of the service to which the quota preference is applied.
- update
Time string - Update time stamp.
A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples:
2014-10-02T15:01:23Z
and2014-10-02T15:01:23.045123456Z
.
- contact_
email str - An email address that can be used for quota related communication between the Google Cloud and the user in case the Google Cloud needs further information to make a decision on whether the user preferred quota can be granted. The Google account for the email address must have quota update permission for the project, folder or organization this quota preference is for.
- create_
time str - Create time stamp.
A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples:
2014-10-02T15:01:23Z
and2014-10-02T15:01:23.045123456Z
. - dimensions Mapping[str, str]
- The dimensions that this quota preference applies to. The key of the map entry is the name of a dimension, such as "region", "zone", "network_id", and the value of the map entry is the dimension value. If a dimension is missing from the map of dimensions, the quota preference applies to all the dimension values except for those that have other quota preferences configured for the specific value. NOTE: QuotaPreferences can only be applied across all values of "user" and "resource" dimension. Do not set values for "user" or "resource" in the dimension map. Example: '{"provider": "Foo Inc"}' where "provider" is a service specific dimension.
- etag str
- The current etag of the quota preference. If an etag is provided on update and does not match the current server's etag of the quota preference, the request will be blocked and an ABORTED error will be returned. See https://google.aip.dev/134#etags for more details on etags.
- ignore_
safety_ strchecks - The list of quota safety checks to be ignored. Default value: "QUOTA_SAFETY_CHECK_UNSPECIFIED" Possible values: ["QUOTA_SAFETY_CHECK_UNSPECIFIED", "QUOTA_DECREASE_BELOW_USAGE", "QUOTA_DECREASE_PERCENTAGE_TOO_HIGH"]
- justification str
- The reason / justification for this quota preference.
- name str
- The resource name of the quota preference. Required except in the CREATE requests.
- parent str
- The parent of the quota preference. Allowed parents are "projects/[project-id / number]" or "folders/[folder-id / number]" or "organizations/[org-id / number]".
- quota_
config SQuotaPreference Quota Config Args - The preferred quota configuration. Structure is documented below.
- quota_
id str - The id of the quota to which the quota preference is applied. A quota id is unique in the service.
Example:
CPUS-per-project-region
. - reconciling bool
- Is the quota preference pending Google Cloud approval and fulfillment.
- service str
- The name of the service to which the quota preference is applied.
- update_
time str - Update time stamp.
A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples:
2014-10-02T15:01:23Z
and2014-10-02T15:01:23.045123456Z
.
- contact
Email String - An email address that can be used for quota related communication between the Google Cloud and the user in case the Google Cloud needs further information to make a decision on whether the user preferred quota can be granted. The Google account for the email address must have quota update permission for the project, folder or organization this quota preference is for.
- create
Time String - Create time stamp.
A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples:
2014-10-02T15:01:23Z
and2014-10-02T15:01:23.045123456Z
. - dimensions Map<String>
- The dimensions that this quota preference applies to. The key of the map entry is the name of a dimension, such as "region", "zone", "network_id", and the value of the map entry is the dimension value. If a dimension is missing from the map of dimensions, the quota preference applies to all the dimension values except for those that have other quota preferences configured for the specific value. NOTE: QuotaPreferences can only be applied across all values of "user" and "resource" dimension. Do not set values for "user" or "resource" in the dimension map. Example: '{"provider": "Foo Inc"}' where "provider" is a service specific dimension.
- etag String
- The current etag of the quota preference. If an etag is provided on update and does not match the current server's etag of the quota preference, the request will be blocked and an ABORTED error will be returned. See https://google.aip.dev/134#etags for more details on etags.
- ignore
Safety StringChecks - The list of quota safety checks to be ignored. Default value: "QUOTA_SAFETY_CHECK_UNSPECIFIED" Possible values: ["QUOTA_SAFETY_CHECK_UNSPECIFIED", "QUOTA_DECREASE_BELOW_USAGE", "QUOTA_DECREASE_PERCENTAGE_TOO_HIGH"]
- justification String
- The reason / justification for this quota preference.
- name String
- The resource name of the quota preference. Required except in the CREATE requests.
- parent String
- The parent of the quota preference. Allowed parents are "projects/[project-id / number]" or "folders/[folder-id / number]" or "organizations/[org-id / number]".
- quota
Config Property Map - The preferred quota configuration. Structure is documented below.
- quota
Id String - The id of the quota to which the quota preference is applied. A quota id is unique in the service.
Example:
CPUS-per-project-region
. - reconciling Boolean
- Is the quota preference pending Google Cloud approval and fulfillment.
- service String
- The name of the service to which the quota preference is applied.
- update
Time String - Update time stamp.
A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples:
2014-10-02T15:01:23Z
and2014-10-02T15:01:23.045123456Z
.
Supporting Types
SQuotaPreferenceQuotaConfig, SQuotaPreferenceQuotaConfigArgs
- Preferred
Value string - The preferred value. Must be greater than or equal to -1. If set to -1, it means the value is "unlimited".
- Annotations Dictionary<string, string>
- The annotations map for clients to store small amounts of arbitrary data. Do not put PII or other sensitive information here. See https://google.aip.dev/128#annotations.
An object containing a list of "key: value" pairs. Example:
{ "name": "wrench", "mass": "1.3kg", "count": "3" }
. - Granted
Value string - (Output) Granted quota value.
- Request
Origin string - (Output)
The origin of the quota preference request.
- State
Detail string - (Output) Optional details about the state of this quota preference.
- Trace
Id string - (Output) The trace id that the Google Cloud uses to provision the requested quota. This trace id may be used by the client to contact Cloud support to track the state of a quota preference request. The trace id is only produced for increase requests and is unique for each request. The quota decrease requests do not have a trace id.
- Preferred
Value string - The preferred value. Must be greater than or equal to -1. If set to -1, it means the value is "unlimited".
- Annotations map[string]string
- The annotations map for clients to store small amounts of arbitrary data. Do not put PII or other sensitive information here. See https://google.aip.dev/128#annotations.
An object containing a list of "key: value" pairs. Example:
{ "name": "wrench", "mass": "1.3kg", "count": "3" }
. - Granted
Value string - (Output) Granted quota value.
- Request
Origin string - (Output)
The origin of the quota preference request.
- State
Detail string - (Output) Optional details about the state of this quota preference.
- Trace
Id string - (Output) The trace id that the Google Cloud uses to provision the requested quota. This trace id may be used by the client to contact Cloud support to track the state of a quota preference request. The trace id is only produced for increase requests and is unique for each request. The quota decrease requests do not have a trace id.
- preferred
Value String - The preferred value. Must be greater than or equal to -1. If set to -1, it means the value is "unlimited".
- annotations Map<String,String>
- The annotations map for clients to store small amounts of arbitrary data. Do not put PII or other sensitive information here. See https://google.aip.dev/128#annotations.
An object containing a list of "key: value" pairs. Example:
{ "name": "wrench", "mass": "1.3kg", "count": "3" }
. - granted
Value String - (Output) Granted quota value.
- request
Origin String - (Output)
The origin of the quota preference request.
- state
Detail String - (Output) Optional details about the state of this quota preference.
- trace
Id String - (Output) The trace id that the Google Cloud uses to provision the requested quota. This trace id may be used by the client to contact Cloud support to track the state of a quota preference request. The trace id is only produced for increase requests and is unique for each request. The quota decrease requests do not have a trace id.
- preferred
Value string - The preferred value. Must be greater than or equal to -1. If set to -1, it means the value is "unlimited".
- annotations {[key: string]: string}
- The annotations map for clients to store small amounts of arbitrary data. Do not put PII or other sensitive information here. See https://google.aip.dev/128#annotations.
An object containing a list of "key: value" pairs. Example:
{ "name": "wrench", "mass": "1.3kg", "count": "3" }
. - granted
Value string - (Output) Granted quota value.
- request
Origin string - (Output)
The origin of the quota preference request.
- state
Detail string - (Output) Optional details about the state of this quota preference.
- trace
Id string - (Output) The trace id that the Google Cloud uses to provision the requested quota. This trace id may be used by the client to contact Cloud support to track the state of a quota preference request. The trace id is only produced for increase requests and is unique for each request. The quota decrease requests do not have a trace id.
- preferred_
value str - The preferred value. Must be greater than or equal to -1. If set to -1, it means the value is "unlimited".
- annotations Mapping[str, str]
- The annotations map for clients to store small amounts of arbitrary data. Do not put PII or other sensitive information here. See https://google.aip.dev/128#annotations.
An object containing a list of "key: value" pairs. Example:
{ "name": "wrench", "mass": "1.3kg", "count": "3" }
. - granted_
value str - (Output) Granted quota value.
- request_
origin str - (Output)
The origin of the quota preference request.
- state_
detail str - (Output) Optional details about the state of this quota preference.
- trace_
id str - (Output) The trace id that the Google Cloud uses to provision the requested quota. This trace id may be used by the client to contact Cloud support to track the state of a quota preference request. The trace id is only produced for increase requests and is unique for each request. The quota decrease requests do not have a trace id.
- preferred
Value String - The preferred value. Must be greater than or equal to -1. If set to -1, it means the value is "unlimited".
- annotations Map<String>
- The annotations map for clients to store small amounts of arbitrary data. Do not put PII or other sensitive information here. See https://google.aip.dev/128#annotations.
An object containing a list of "key: value" pairs. Example:
{ "name": "wrench", "mass": "1.3kg", "count": "3" }
. - granted
Value String - (Output) Granted quota value.
- request
Origin String - (Output)
The origin of the quota preference request.
- state
Detail String - (Output) Optional details about the state of this quota preference.
- trace
Id String - (Output) The trace id that the Google Cloud uses to provision the requested quota. This trace id may be used by the client to contact Cloud support to track the state of a quota preference request. The trace id is only produced for increase requests and is unique for each request. The quota decrease requests do not have a trace id.
Import
QuotaPreference can be imported using any of these accepted formats:
{{parent}}/locations/global/quotaPreferences/{{name}}
When using the pulumi import
command, QuotaPreference can be imported using one of the formats above. For example:
$ pulumi import gcp:cloudquota/sQuotaPreference:SQuotaPreference default {{parent}}/locations/global/quotaPreferences/{{name}}
To learn more about importing existing cloud resources, see Importing resources.
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.