import * as pulumi from "@pulumi/pulumi"; /** * QuotaRule specifies the maximum capacity a user or group can use within a volume. They can be used for creating default and individual quota rules. * * To get more information about VolumeQuotaRule, see: * * * [API documentation](https://cloud.google.com/netapp/volumes/docs/reference/rest/v1/projects.locations.volumes.quotaRules) * * How-to Guides * * [Documentation](https://cloud.google.com/netapp/volumes/docs/configure-and-use/volumes/overview#volume_user_and_group_quotas) * * ## Example Usage * * ### Netapp Volume Quota Rule Basic * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const _default = gcp.compute.getNetwork({ * name: "test-network", * }); * const defaultStoragePool = new gcp.netapp.StoragePool("default", { * name: "test-pool", * location: "us-west2", * serviceLevel: "PREMIUM", * capacityGib: "2048", * network: _default.then(_default => _default.id), * }); * const defaultVolume = new gcp.netapp.Volume("default", { * location: defaultStoragePool.location, * name: "test-volume", * capacityGib: "100", * shareName: "test-volume", * storagePool: defaultStoragePool.name, * protocols: ["NFSV3"], * }); * const testQuotaRule = new gcp.netapp.VolumeQuotaRule("test_quota_rule", { * location: defaultVolume.location, * volumeName: defaultVolume.name, * type: "DEFAULT_USER_QUOTA", * diskLimitMib: 50, * name: "test-volume-quota-rule", * }, { * dependsOn: [defaultVolume], * }); * ``` * * ## Import * * VolumeQuotaRule can be imported using any of these accepted formats: * * * `projects/{{project}}/locations/{{location}}/volumes/{{volume_name}}/quotaRules/{{name}}` * * `{{project}}/{{location}}/{{volume_name}}/{{name}}` * * `{{location}}/{{volume_name}}/{{name}}` * * When using the `pulumi import` command, VolumeQuotaRule can be imported using one of the formats above. For example: * * ```sh * $ pulumi import gcp:netapp/volumeQuotaRule:VolumeQuotaRule default projects/{{project}}/locations/{{location}}/volumes/{{volume_name}}/quotaRules/{{name}} * $ pulumi import gcp:netapp/volumeQuotaRule:VolumeQuotaRule default {{project}}/{{location}}/{{volume_name}}/{{name}} * $ pulumi import gcp:netapp/volumeQuotaRule:VolumeQuotaRule default {{location}}/{{volume_name}}/{{name}} * ``` */ export declare class VolumeQuotaRule extends pulumi.CustomResource { /** * Get an existing VolumeQuotaRule 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, state?: VolumeQuotaRuleState, opts?: pulumi.CustomResourceOptions): VolumeQuotaRule; /** * Returns true if the given object is an instance of VolumeQuotaRule. 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 VolumeQuotaRule; /** * Create time of the quota rule. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z". */ readonly createTime: pulumi.Output; /** * Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. * When a 'terraform destroy' or 'pulumi up' would delete the resource, * the command will fail if this field is set to "PREVENT" in Terraform state. * When set to "ABANDON", the command will remove the resource from Terraform * management without updating or deleting the resource in the API. * When set to "DELETE", deleting the resource is allowed. */ readonly deletionPolicy: pulumi.Output; /** * Description for the quota rule. */ readonly description: pulumi.Output; /** * The maximum allowed capacity in MiB. */ readonly diskLimitMib: pulumi.Output; /** * All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services. */ readonly effectiveLabels: pulumi.Output<{ [key: string]: string; }>; /** * Labels as key value pairs of the quota rule. Example: `{ "owner": "Bob", "department": "finance", "purpose": "testing" }`. * * **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. * Please refer to the field `effectiveLabels` for all of the labels present on the resource. */ readonly labels: pulumi.Output<{ [key: string]: string; } | undefined>; /** * Loction of the quotaRule. QuotaRules are child resources of volumes and live in the same location. */ readonly location: pulumi.Output; /** * The resource name of the quotaRule. */ readonly name: pulumi.Output; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ readonly project: pulumi.Output; /** * The combination of labels configured directly on the resource * and default labels configured on the provider. */ readonly pulumiLabels: pulumi.Output<{ [key: string]: string; }>; /** * The state of the quota rule. Possible Values : [STATE_UNSPECIFIED, CREATING, UPDATING, READY, DELETING, ERROR] */ readonly state: pulumi.Output; /** * State details of the quota rule */ readonly stateDetails: pulumi.Output; /** * The quota rule applies to the specified user or group. * Valid targets for volumes with NFS protocol enabled: * - UNIX UID for individual user quota * - UNIX GID for individual group quota * Valid targets for volumes with SMB protocol enabled: * - Windows SID for individual user quota * Leave empty for default quotas */ readonly target: pulumi.Output; /** * Types of Quota Rule. * Possible values are: `INDIVIDUAL_USER_QUOTA`, `INDIVIDUAL_GROUP_QUOTA`, `DEFAULT_USER_QUOTA`, `DEFAULT_GROUP_QUOTA`. */ readonly type: pulumi.Output; /** * Name of the volume to create the quotaRule in. */ readonly volumeName: pulumi.Output; /** * Create a VolumeQuotaRule 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: VolumeQuotaRuleArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering VolumeQuotaRule resources. */ export interface VolumeQuotaRuleState { /** * Create time of the quota rule. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z". */ createTime?: pulumi.Input; /** * Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. * When a 'terraform destroy' or 'pulumi up' would delete the resource, * the command will fail if this field is set to "PREVENT" in Terraform state. * When set to "ABANDON", the command will remove the resource from Terraform * management without updating or deleting the resource in the API. * When set to "DELETE", deleting the resource is allowed. */ deletionPolicy?: pulumi.Input; /** * Description for the quota rule. */ description?: pulumi.Input; /** * The maximum allowed capacity in MiB. */ diskLimitMib?: pulumi.Input; /** * All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services. */ effectiveLabels?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * Labels as key value pairs of the quota rule. Example: `{ "owner": "Bob", "department": "finance", "purpose": "testing" }`. * * **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. * Please refer to the field `effectiveLabels` for all of the labels present on the resource. */ labels?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * Loction of the quotaRule. QuotaRules are child resources of volumes and live in the same location. */ location?: pulumi.Input; /** * The resource name of the quotaRule. */ name?: pulumi.Input; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input; /** * The combination of labels configured directly on the resource * and default labels configured on the provider. */ pulumiLabels?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * The state of the quota rule. Possible Values : [STATE_UNSPECIFIED, CREATING, UPDATING, READY, DELETING, ERROR] */ state?: pulumi.Input; /** * State details of the quota rule */ stateDetails?: pulumi.Input; /** * The quota rule applies to the specified user or group. * Valid targets for volumes with NFS protocol enabled: * - UNIX UID for individual user quota * - UNIX GID for individual group quota * Valid targets for volumes with SMB protocol enabled: * - Windows SID for individual user quota * Leave empty for default quotas */ target?: pulumi.Input; /** * Types of Quota Rule. * Possible values are: `INDIVIDUAL_USER_QUOTA`, `INDIVIDUAL_GROUP_QUOTA`, `DEFAULT_USER_QUOTA`, `DEFAULT_GROUP_QUOTA`. */ type?: pulumi.Input; /** * Name of the volume to create the quotaRule in. */ volumeName?: pulumi.Input; } /** * The set of arguments for constructing a VolumeQuotaRule resource. */ export interface VolumeQuotaRuleArgs { /** * Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. * When a 'terraform destroy' or 'pulumi up' would delete the resource, * the command will fail if this field is set to "PREVENT" in Terraform state. * When set to "ABANDON", the command will remove the resource from Terraform * management without updating or deleting the resource in the API. * When set to "DELETE", deleting the resource is allowed. */ deletionPolicy?: pulumi.Input; /** * Description for the quota rule. */ description?: pulumi.Input; /** * The maximum allowed capacity in MiB. */ diskLimitMib: pulumi.Input; /** * Labels as key value pairs of the quota rule. Example: `{ "owner": "Bob", "department": "finance", "purpose": "testing" }`. * * **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. * Please refer to the field `effectiveLabels` for all of the labels present on the resource. */ labels?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * Loction of the quotaRule. QuotaRules are child resources of volumes and live in the same location. */ location?: pulumi.Input; /** * The resource name of the quotaRule. */ name?: pulumi.Input; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input; /** * The quota rule applies to the specified user or group. * Valid targets for volumes with NFS protocol enabled: * - UNIX UID for individual user quota * - UNIX GID for individual group quota * Valid targets for volumes with SMB protocol enabled: * - Windows SID for individual user quota * Leave empty for default quotas */ target?: pulumi.Input; /** * Types of Quota Rule. * Possible values are: `INDIVIDUAL_USER_QUOTA`, `INDIVIDUAL_GROUP_QUOTA`, `DEFAULT_USER_QUOTA`, `DEFAULT_GROUP_QUOTA`. */ type: pulumi.Input; /** * Name of the volume to create the quotaRule in. */ volumeName: pulumi.Input; } //# sourceMappingURL=volumeQuotaRule.d.ts.map