@cdktf/provider-google
Version:
Prebuilt google Provider for Terraform CDK (cdktf)
208 lines (207 loc) • 9.36 kB
TypeScript
/**
* Copyright (c) HashiCorp, Inc.
* SPDX-License-Identifier: MPL-2.0
*/
import { Construct } from 'constructs';
import * as cdktf from 'cdktf';
export interface NetappBackupConfig extends cdktf.TerraformMetaArguments {
/**
* A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/netapp_backup#description NetappBackup#description}
*/
readonly description?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/netapp_backup#id NetappBackup#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. 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.13.0/docs/resources/netapp_backup#labels NetappBackup#labels}
*/
readonly labels?: {
[key: string]: string;
};
/**
* Location of the backup.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/netapp_backup#location NetappBackup#location}
*/
readonly location: string;
/**
* The resource name of the backup. Needs to be unique per location.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/netapp_backup#name NetappBackup#name}
*/
readonly name: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/netapp_backup#project NetappBackup#project}
*/
readonly project?: string;
/**
* If specified, backup will be created from the given snapshot. If not specified,
* there will be a new snapshot taken to initiate the backup creation.
* Format: 'projects/{{projectId}}/locations/{{location}}/volumes/{{volumename}}/snapshots/{{snapshotname}}''
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/netapp_backup#source_snapshot NetappBackup#source_snapshot}
*/
readonly sourceSnapshot?: string;
/**
* ID of volumes this backup belongs to. Format: 'projects/{{projects_id}}/locations/{{location}}/volumes/{{name}}''
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/netapp_backup#source_volume NetappBackup#source_volume}
*/
readonly sourceVolume?: string;
/**
* Name of the backup vault to store the backup in.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/netapp_backup#vault_name NetappBackup#vault_name}
*/
readonly vaultName: string;
/**
* timeouts block
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/netapp_backup#timeouts NetappBackup#timeouts}
*/
readonly timeouts?: NetappBackupTimeouts;
}
export interface NetappBackupTimeouts {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/netapp_backup#create NetappBackup#create}
*/
readonly create?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/netapp_backup#delete NetappBackup#delete}
*/
readonly delete?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/netapp_backup#update NetappBackup#update}
*/
readonly update?: string;
}
export declare function netappBackupTimeoutsToTerraform(struct?: NetappBackupTimeouts | cdktf.IResolvable): any;
export declare function netappBackupTimeoutsToHclTerraform(struct?: NetappBackupTimeouts | cdktf.IResolvable): any;
export declare class NetappBackupTimeoutsOutputReference 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(): NetappBackupTimeouts | cdktf.IResolvable | undefined;
set internalValue(value: NetappBackupTimeouts | 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.13.0/docs/resources/netapp_backup google_netapp_backup}
*/
export declare class NetappBackup extends cdktf.TerraformResource {
static readonly tfResourceType = "google_netapp_backup";
/**
* Generates CDKTF code for importing a NetappBackup 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 NetappBackup to import
* @param importFromId The id of the existing NetappBackup that should be imported. Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/netapp_backup#import import section} in the documentation of this resource for the id to use
* @param provider? Optional instance of the provider where the NetappBackup 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/netapp_backup google_netapp_backup} 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 NetappBackupConfig
*/
constructor(scope: Construct, id: string, config: NetappBackupConfig);
get backupType(): string;
get chainStorageBytes(): string;
get createTime(): string;
private _description?;
get description(): string;
set description(value: string);
resetDescription(): void;
get descriptionInput(): string | 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);
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;
private _sourceSnapshot?;
get sourceSnapshot(): string;
set sourceSnapshot(value: string);
resetSourceSnapshot(): void;
get sourceSnapshotInput(): string | undefined;
private _sourceVolume?;
get sourceVolume(): string;
set sourceVolume(value: string);
resetSourceVolume(): void;
get sourceVolumeInput(): string | undefined;
get state(): string;
private _terraformLabels;
get terraformLabels(): cdktf.StringMap;
private _vaultName?;
get vaultName(): string;
set vaultName(value: string);
get vaultNameInput(): string | undefined;
get volumeUsageBytes(): string;
private _timeouts;
get timeouts(): NetappBackupTimeoutsOutputReference;
putTimeouts(value: NetappBackupTimeouts): void;
resetTimeouts(): void;
get timeoutsInput(): cdktf.IResolvable | NetappBackupTimeouts | undefined;
protected synthesizeAttributes(): {
[name: string]: any;
};
protected synthesizeHclAttributes(): {
[name: string]: any;
};
}