UNPKG

@cdktf/provider-google

Version:

Prebuilt google Provider for Terraform CDK (cdktf)

168 lines (167 loc) 8.88 kB
/** * Copyright (c) HashiCorp, Inc. * SPDX-License-Identifier: MPL-2.0 */ import { Construct } from 'constructs'; import * as cdktf from 'cdktf'; export interface ComputeAttachedDiskConfig extends cdktf.TerraformMetaArguments { /** * Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance. If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. * * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/compute_attached_disk#device_name ComputeAttachedDisk#device_name} */ readonly deviceName?: string; /** * name or self_link of the disk that will be attached. * * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/compute_attached_disk#disk ComputeAttachedDisk#disk} */ readonly disk: string; /** * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/compute_attached_disk#id ComputeAttachedDisk#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; /** * name or self_link of the compute instance that the disk will be attached to. If the self_link is provided then zone and project are extracted from the self link. If only the name is used then zone and project must be defined as properties on the resource or provider. * * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/compute_attached_disk#instance ComputeAttachedDisk#instance} */ readonly instance: string; /** * The disk interface used for attaching this disk. One of SCSI or NVME. (This field is only used for specific cases, please don't specify this field without advice from Google.) * * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/compute_attached_disk#interface ComputeAttachedDisk#interface} */ readonly interface?: string; /** * The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode. * * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/compute_attached_disk#mode ComputeAttachedDisk#mode} */ readonly mode?: string; /** * The project that the referenced compute instance is a part of. If instance is referenced by its self_link the project defined in the link will take precedence. * * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/compute_attached_disk#project ComputeAttachedDisk#project} */ readonly project?: string; /** * The zone that the referenced compute instance is located within. If instance is referenced by its self_link the zone defined in the link will take precedence. * * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/compute_attached_disk#zone ComputeAttachedDisk#zone} */ readonly zone?: string; /** * timeouts block * * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/compute_attached_disk#timeouts ComputeAttachedDisk#timeouts} */ readonly timeouts?: ComputeAttachedDiskTimeouts; } export interface ComputeAttachedDiskTimeouts { /** * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/compute_attached_disk#create ComputeAttachedDisk#create} */ readonly create?: string; /** * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/compute_attached_disk#delete ComputeAttachedDisk#delete} */ readonly delete?: string; } export declare function computeAttachedDiskTimeoutsToTerraform(struct?: ComputeAttachedDiskTimeouts | cdktf.IResolvable): any; export declare function computeAttachedDiskTimeoutsToHclTerraform(struct?: ComputeAttachedDiskTimeouts | cdktf.IResolvable): any; export declare class ComputeAttachedDiskTimeoutsOutputReference 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(): ComputeAttachedDiskTimeouts | cdktf.IResolvable | undefined; set internalValue(value: ComputeAttachedDiskTimeouts | 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; } /** * Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/compute_attached_disk google_compute_attached_disk} */ export declare class ComputeAttachedDisk extends cdktf.TerraformResource { static readonly tfResourceType = "google_compute_attached_disk"; /** * Generates CDKTF code for importing a ComputeAttachedDisk 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 ComputeAttachedDisk to import * @param importFromId The id of the existing ComputeAttachedDisk that should be imported. Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/compute_attached_disk#import import section} in the documentation of this resource for the id to use * @param provider? Optional instance of the provider where the ComputeAttachedDisk 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.13.0/docs/resources/compute_attached_disk google_compute_attached_disk} 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 ComputeAttachedDiskConfig */ constructor(scope: Construct, id: string, config: ComputeAttachedDiskConfig); private _deviceName?; get deviceName(): string; set deviceName(value: string); resetDeviceName(): void; get deviceNameInput(): string | undefined; private _disk?; get disk(): string; set disk(value: string); get diskInput(): string | undefined; private _id?; get id(): string; set id(value: string); resetId(): void; get idInput(): string | undefined; private _instance?; get instance(): string; set instance(value: string); get instanceInput(): string | undefined; private _interface?; get interface(): string; set interface(value: string); resetInterface(): void; get interfaceInput(): string | undefined; private _mode?; get mode(): string; set mode(value: string); resetMode(): void; get modeInput(): string | undefined; private _project?; get project(): string; set project(value: string); resetProject(): void; get projectInput(): string | undefined; private _zone?; get zone(): string; set zone(value: string); resetZone(): void; get zoneInput(): string | undefined; private _timeouts; get timeouts(): ComputeAttachedDiskTimeoutsOutputReference; putTimeouts(value: ComputeAttachedDiskTimeouts): void; resetTimeouts(): void; get timeoutsInput(): cdktf.IResolvable | ComputeAttachedDiskTimeouts | undefined; protected synthesizeAttributes(): { [name: string]: any; }; protected synthesizeHclAttributes(): { [name: string]: any; }; }