@cdktf/provider-google
Version:
Prebuilt google Provider for Terraform CDK (cdktf)
220 lines (219 loc) • 10.2 kB
TypeScript
/**
* Copyright (c) HashiCorp, Inc.
* SPDX-License-Identifier: MPL-2.0
*/
import { Construct } from 'constructs';
import * as cdktf from 'cdktf';
export interface NetappVolumeQuotaRuleConfig extends cdktf.TerraformMetaArguments {
/**
* Description for the quota rule.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/netapp_volume_quota_rule#description NetappVolumeQuotaRule#description}
*/
readonly description?: string;
/**
* The maximum allowed capacity in MiB.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/netapp_volume_quota_rule#disk_limit_mib NetappVolumeQuotaRule#disk_limit_mib}
*/
readonly diskLimitMib: number;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/netapp_volume_quota_rule#id NetappVolumeQuotaRule#id}
*
* Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2.
* If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.
*/
readonly id?: 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 'effective_labels' for all of the labels present on the resource.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/netapp_volume_quota_rule#labels NetappVolumeQuotaRule#labels}
*/
readonly labels?: {
[key: string]: string;
};
/**
* Loction of the quotaRule. QuotaRules are child resources of volumes and live in the same location.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/netapp_volume_quota_rule#location NetappVolumeQuotaRule#location}
*/
readonly location?: string;
/**
* The resource name of the quotaRule.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/netapp_volume_quota_rule#name NetappVolumeQuotaRule#name}
*/
readonly name: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/netapp_volume_quota_rule#project NetappVolumeQuotaRule#project}
*/
readonly project?: string;
/**
* 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
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/netapp_volume_quota_rule#target NetappVolumeQuotaRule#target}
*/
readonly target?: string;
/**
* Types of Quota Rule. Possible values: ["INDIVIDUAL_USER_QUOTA", "INDIVIDUAL_GROUP_QUOTA", "DEFAULT_USER_QUOTA", "DEFAULT_GROUP_QUOTA"]
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/netapp_volume_quota_rule#type NetappVolumeQuotaRule#type}
*/
readonly type: string;
/**
* Name of the volume to create the quotaRule in.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/netapp_volume_quota_rule#volume_name NetappVolumeQuotaRule#volume_name}
*/
readonly volumeName: string;
/**
* timeouts block
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/netapp_volume_quota_rule#timeouts NetappVolumeQuotaRule#timeouts}
*/
readonly timeouts?: NetappVolumeQuotaRuleTimeouts;
}
export interface NetappVolumeQuotaRuleTimeouts {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/netapp_volume_quota_rule#create NetappVolumeQuotaRule#create}
*/
readonly create?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/netapp_volume_quota_rule#delete NetappVolumeQuotaRule#delete}
*/
readonly delete?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/netapp_volume_quota_rule#update NetappVolumeQuotaRule#update}
*/
readonly update?: string;
}
export declare function netappVolumeQuotaRuleTimeoutsToTerraform(struct?: NetappVolumeQuotaRuleTimeouts | cdktf.IResolvable): any;
export declare function netappVolumeQuotaRuleTimeoutsToHclTerraform(struct?: NetappVolumeQuotaRuleTimeouts | cdktf.IResolvable): any;
export declare class NetappVolumeQuotaRuleTimeoutsOutputReference extends cdktf.ComplexObject {
private isEmptyObject;
private resolvableValue?;
/**
* @param terraformResource The parent resource
* @param terraformAttribute The attribute on the parent resource this class is referencing
*/
constructor(terraformResource: cdktf.IInterpolatingParent, terraformAttribute: string);
get internalValue(): NetappVolumeQuotaRuleTimeouts | cdktf.IResolvable | undefined;
set internalValue(value: NetappVolumeQuotaRuleTimeouts | cdktf.IResolvable | undefined);
private _create?;
get create(): string;
set create(value: string);
resetCreate(): void;
get createInput(): string | undefined;
private _delete?;
get delete(): string;
set delete(value: string);
resetDelete(): void;
get deleteInput(): string | undefined;
private _update?;
get update(): string;
set update(value: string);
resetUpdate(): void;
get updateInput(): string | undefined;
}
/**
* Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/netapp_volume_quota_rule google_netapp_volume_quota_rule}
*/
export declare class NetappVolumeQuotaRule extends cdktf.TerraformResource {
static readonly tfResourceType = "google_netapp_volume_quota_rule";
/**
* Generates CDKTF code for importing a NetappVolumeQuotaRule resource upon running "cdktf plan <stack-name>"
* @param scope The scope in which to define this construct
* @param importToId The construct id used in the generated config for the NetappVolumeQuotaRule to import
* @param importFromId The id of the existing NetappVolumeQuotaRule that should be imported. Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/netapp_volume_quota_rule#import import section} in the documentation of this resource for the id to use
* @param provider? Optional instance of the provider where the NetappVolumeQuotaRule to import is found
*/
static generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: cdktf.TerraformProvider): cdktf.ImportableResource;
/**
* Create a new {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/netapp_volume_quota_rule google_netapp_volume_quota_rule} Resource
*
* @param scope The scope in which to define this construct
* @param id The scoped construct ID. Must be unique amongst siblings in the same scope
* @param options NetappVolumeQuotaRuleConfig
*/
constructor(scope: Construct, id: string, config: NetappVolumeQuotaRuleConfig);
get createTime(): string;
private _description?;
get description(): string;
set description(value: string);
resetDescription(): void;
get descriptionInput(): string | undefined;
private _diskLimitMib?;
get diskLimitMib(): number;
set diskLimitMib(value: number);
get diskLimitMibInput(): number | undefined;
private _effectiveLabels;
get effectiveLabels(): cdktf.StringMap;
private _id?;
get id(): string;
set id(value: string);
resetId(): void;
get idInput(): string | undefined;
private _labels?;
get labels(): {
[key: string]: string;
};
set labels(value: {
[key: string]: string;
});
resetLabels(): void;
get labelsInput(): {
[key: string]: string;
} | undefined;
private _location?;
get location(): string;
set location(value: string);
resetLocation(): void;
get locationInput(): string | undefined;
private _name?;
get name(): string;
set name(value: string);
get nameInput(): string | undefined;
private _project?;
get project(): string;
set project(value: string);
resetProject(): void;
get projectInput(): string | undefined;
get state(): string;
get stateDetails(): string;
private _target?;
get target(): string;
set target(value: string);
resetTarget(): void;
get targetInput(): string | undefined;
private _terraformLabels;
get terraformLabels(): cdktf.StringMap;
private _type?;
get type(): string;
set type(value: string);
get typeInput(): string | undefined;
private _volumeName?;
get volumeName(): string;
set volumeName(value: string);
get volumeNameInput(): string | undefined;
private _timeouts;
get timeouts(): NetappVolumeQuotaRuleTimeoutsOutputReference;
putTimeouts(value: NetappVolumeQuotaRuleTimeouts): void;
resetTimeouts(): void;
get timeoutsInput(): cdktf.IResolvable | NetappVolumeQuotaRuleTimeouts | undefined;
protected synthesizeAttributes(): {
[name: string]: any;
};
protected synthesizeHclAttributes(): {
[name: string]: any;
};
}