@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
154 lines • 7.14 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* QuotaAdjusterSettings resource represents your quota adjuster settings for a particular project. When enabled, the quota adjuster monitors your usage for the specified resources and issues quota adjustment requests when resource usage approaches its quota value.
*
* > **Warning:** This resource is in beta, and should be used with the terraform-provider-google-beta provider.
* See Provider Versions for more details on beta resources.
*
* To get more information about QuotaAdjusterSettings, see:
*
* * [API documentation](https://cloud.google.com/docs/quotas/reference/rest/v1beta/projects.locations.quotaAdjusterSettings)
* * How-to Guides
* * [Cloud Quotas Overview](https://cloud.google.com/docs/quotas/overview)
*
* ## Example Usage
*
* ### Cloudquotas Quota Adjuster Settings Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const adjusterSettings = new gcp.cloudquota.SQuotaAdjusterSettings("adjuster_settings", {
* parent: "projects/104740170505",
* enablement: "ENABLED",
* });
* ```
*
* ## Import
*
* QuotaAdjusterSettings can be imported using any of these accepted formats:
*
* * `{{parent}}/locations/global/quotaAdjusterSettings`
*
* When using the `pulumi import` command, QuotaAdjusterSettings can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:cloudquota/sQuotaAdjusterSettings:SQuotaAdjusterSettings default {{parent}}/locations/global/quotaAdjusterSettings
* ```
*/
export declare class SQuotaAdjusterSettings extends pulumi.CustomResource {
/**
* Get an existing SQuotaAdjusterSettings resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SQuotaAdjusterSettingsState, opts?: pulumi.CustomResourceOptions): SQuotaAdjusterSettings;
/**
* Returns true if the given object is an instance of SQuotaAdjusterSettings. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is SQuotaAdjusterSettings;
/**
* (Deprecated)
* The resource container that determines if the quota adjuster is set for this project.
* Expect this field to be empty currently.
*
* @deprecated `effectiveContainer` is deprecated and will be removed in a future major release. Use `inheritedFrom` instead.
*/
readonly effectiveContainer: pulumi.Output<string>;
/**
* (Deprecated)
* Based on the effective container`s setting above, determines Whether this resource container has the quota adjuster enabled.
* Expect this field to be empty currently.
*
* @deprecated `effectiveEnablement` is deprecated and will be removed in a future major release. Use `inherited` instead.
*/
readonly effectiveEnablement: pulumi.Output<string>;
/**
* Required. The configured value of the enablement at the given resource.
* Possible values are: `ENABLED`, `DISABLED`.
*/
readonly enablement: pulumi.Output<string>;
/**
* Indicates whether the setting is inherited or explicitly specified.
*/
readonly inherited: pulumi.Output<boolean>;
/**
* The resource container from which the setting is inherited. This refers to the nearest ancestor with enablement set (either ENABLED or DISABLED).
* The value can be `organizations/{organization_id}`, `folders/{folder_id}`, or can be `default` if no ancestor exists with enablement set.
* The value will be empty when `enablement` is specified on this resource container.
*/
readonly inheritedFrom: pulumi.Output<string>;
/**
* The parent of the quota preference. Allowed parent format is "projects/[project-id / number]".
*/
readonly parent: pulumi.Output<string>;
/**
* Create a SQuotaAdjusterSettings resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: SQuotaAdjusterSettingsArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering SQuotaAdjusterSettings resources.
*/
export interface SQuotaAdjusterSettingsState {
/**
* (Deprecated)
* The resource container that determines if the quota adjuster is set for this project.
* Expect this field to be empty currently.
*
* @deprecated `effectiveContainer` is deprecated and will be removed in a future major release. Use `inheritedFrom` instead.
*/
effectiveContainer?: pulumi.Input<string | undefined>;
/**
* (Deprecated)
* Based on the effective container`s setting above, determines Whether this resource container has the quota adjuster enabled.
* Expect this field to be empty currently.
*
* @deprecated `effectiveEnablement` is deprecated and will be removed in a future major release. Use `inherited` instead.
*/
effectiveEnablement?: pulumi.Input<string | undefined>;
/**
* Required. The configured value of the enablement at the given resource.
* Possible values are: `ENABLED`, `DISABLED`.
*/
enablement?: pulumi.Input<string | undefined>;
/**
* Indicates whether the setting is inherited or explicitly specified.
*/
inherited?: pulumi.Input<boolean | undefined>;
/**
* The resource container from which the setting is inherited. This refers to the nearest ancestor with enablement set (either ENABLED or DISABLED).
* The value can be `organizations/{organization_id}`, `folders/{folder_id}`, or can be `default` if no ancestor exists with enablement set.
* The value will be empty when `enablement` is specified on this resource container.
*/
inheritedFrom?: pulumi.Input<string | undefined>;
/**
* The parent of the quota preference. Allowed parent format is "projects/[project-id / number]".
*/
parent?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a SQuotaAdjusterSettings resource.
*/
export interface SQuotaAdjusterSettingsArgs {
/**
* Required. The configured value of the enablement at the given resource.
* Possible values are: `ENABLED`, `DISABLED`.
*/
enablement: pulumi.Input<string>;
/**
* The parent of the quota preference. Allowed parent format is "projects/[project-id / number]".
*/
parent?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=squotaAdjusterSettings.d.ts.map