netappBackupVault.typescript.md

netappBackupVault Submodule

Constructs

NetappBackupVault

Represents a {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/netapp_backup_vault google_netapp_backup_vault}.

Initializers

import { netappBackupVault } from '@cdktn/provider-google'

new netappBackupVault.NetappBackupVault(scope: Construct, id: string, config: NetappBackupVaultConfig)

Name	Type	Description
scope	constructs.Construct	The scope in which to define this construct.
id	string	The scoped construct ID.
config	NetappBackupVaultConfig	No description.

---

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

id^Required

• Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

---

config^Required

• Type: NetappBackupVaultConfig

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
addOverride	No description.
overrideLogicalId	Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId	Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform	No description.
toMetadata	No description.
toTerraform	Adds this resource to the terraform JSON output.
addMoveTarget	Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
getAnyMapAttribute	No description.
getBooleanAttribute	No description.
getBooleanMapAttribute	No description.
getListAttribute	No description.
getNumberAttribute	No description.
getNumberListAttribute	No description.
getNumberMapAttribute	No description.
getStringAttribute	No description.
getStringMapAttribute	No description.
hasResourceMove	No description.
importFrom	No description.
interpolationForAttribute	No description.
moveFromId	Move the resource corresponding to "id" to this resource.
moveTo	Moves this resource to the target resource given by moveTarget.
moveToId	Moves this resource to the resource corresponding to "id".
putBackupRetentionPolicy	No description.
putTimeouts	No description.
resetBackupRegion	No description.
resetBackupRetentionPolicy	No description.
resetBackupVaultType	No description.
resetDeletionPolicy	No description.
resetDescription	No description.
resetId	No description.
resetKmsConfig	No description.
resetLabels	No description.
resetProject	No description.
resetTimeouts	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: ...constructs.IMixin[]

The mixins to apply.

---

addOverride

public addOverride(path: string, value: any): void

path^Required

• Type: string

---

value^Required

• Type: any

---

overrideLogicalId

public overrideLogicalId(newLogicalId: string): void

Overrides the auto-generated logical ID with a specific ID.

newLogicalId^Required

• Type: string

The new logical ID to use for this stack element.

---

resetOverrideLogicalId

public resetOverrideLogicalId(): void

Resets a previously passed logical Id to use the auto-generated logical id again.

toHclTerraform

public toHclTerraform(): any

toMetadata

public toMetadata(): any

toTerraform

public toTerraform(): any

Adds this resource to the terraform JSON output.

addMoveTarget

public addMoveTarget(moveTarget: string): void

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

moveTarget^Required

• Type: string

The string move target that will correspond to this resource.

---

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

hasResourceMove

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

importFrom

public importFrom(id: string, provider?: TerraformProvider): void

id^Required

• Type: string

---

provider^Optional

• Type: cdktn.TerraformProvider

---

interpolationForAttribute

public interpolationForAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

moveFromId

public moveFromId(id: string): void

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

id^Required

• Type: string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

---

moveTo

public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

moveTarget^Required

• Type: string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

---

index^Optional

• Type: string | number

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

---

moveToId

public moveToId(id: string): void

Moves this resource to the resource corresponding to "id".

id^Required

• Type: string

Full id of resource to move to, e.g. "aws_s3_bucket.example".

---

putBackupRetentionPolicy

public putBackupRetentionPolicy(value: NetappBackupVaultBackupRetentionPolicy): void

value^Required

• Type: NetappBackupVaultBackupRetentionPolicy

---

putTimeouts

public putTimeouts(value: NetappBackupVaultTimeouts): void

value^Required

• Type: NetappBackupVaultTimeouts

---

resetBackupRegion

public resetBackupRegion(): void

resetBackupRetentionPolicy

public resetBackupRetentionPolicy(): void

resetBackupVaultType

public resetBackupVaultType(): void

resetDeletionPolicy

public resetDeletionPolicy(): void

resetDescription

public resetDescription(): void

resetId

public resetId(): void

resetKmsConfig

public resetKmsConfig(): void

resetLabels

public resetLabels(): void

resetProject

public resetProject(): void

resetTimeouts

public resetTimeouts(): void

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isTerraformElement	No description.
isTerraformResource	No description.
generateConfigForImport	Generates CDKTN code for importing a NetappBackupVault resource upon running "cdktn plan ".

---

isConstruct

import { netappBackupVault } from '@cdktn/provider-google'

netappBackupVault.NetappBackupVault.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

x^Required

• Type: any

Any object.

---

isTerraformElement

import { netappBackupVault } from '@cdktn/provider-google'

netappBackupVault.NetappBackupVault.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

import { netappBackupVault } from '@cdktn/provider-google'

netappBackupVault.NetappBackupVault.isTerraformResource(x: any)

x^Required

• Type: any

---

generateConfigForImport

import { netappBackupVault } from '@cdktn/provider-google'

netappBackupVault.NetappBackupVault.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTN code for importing a NetappBackupVault resource upon running "cdktn plan ".

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

importToId^Required

• Type: string

The construct id used in the generated config for the NetappBackupVault to import.

---

importFromId^Required

• Type: string

The id of the existing NetappBackupVault that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/netapp_backup_vault#import import section} in the documentation of this resource for the id to use

---

provider^Optional

• Type: cdktn.TerraformProvider

? Optional instance of the provider where the NetappBackupVault to import is found.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
cdktfStack	cdktn.TerraformStack	No description.
fqn	string	No description.
friendlyUniqueId	string	No description.
terraformMetaArguments	{[ key: string ]: any}	No description.
terraformResourceType	string	No description.
terraformGeneratorMetadata	cdktn.TerraformProviderGeneratorMetadata	No description.
connection	cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection	No description.
count	number | cdktn.TerraformCount	No description.
dependsOn	string[]	No description.
forEach	cdktn.ITerraformIterator	No description.
lifecycle	cdktn.TerraformResourceLifecycle	No description.
provider	cdktn.TerraformProvider	No description.
provisioners	cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner[]	No description.
backupRetentionPolicy	NetappBackupVaultBackupRetentionPolicyOutputReference	No description.
backupsCryptoKeyVersion	string	No description.
createTime	string	No description.
destinationBackupVault	string	No description.
effectiveLabels	cdktn.StringMap	No description.
encryptionState	string	No description.
sourceBackupVault	string	No description.
sourceRegion	string	No description.
state	string	No description.
terraformLabels	cdktn.StringMap	No description.
timeouts	NetappBackupVaultTimeoutsOutputReference	No description.
backupRegionInput	string	No description.
backupRetentionPolicyInput	NetappBackupVaultBackupRetentionPolicy	No description.
backupVaultTypeInput	string	No description.
deletionPolicyInput	string	No description.
descriptionInput	string	No description.
idInput	string	No description.
kmsConfigInput	string	No description.
labelsInput	{[ key: string ]: string}	No description.
locationInput	string	No description.
nameInput	string	No description.
projectInput	string	No description.
timeoutsInput	cdktn.IResolvable | NetappBackupVaultTimeouts	No description.
backupRegion	string	No description.
backupVaultType	string	No description.
deletionPolicy	string	No description.
description	string	No description.
id	string	No description.
kmsConfig	string	No description.
labels	{[ key: string ]: string}	No description.
location	string	No description.
name	string	No description.
project	string	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

cdktfStack^Required

public readonly cdktfStack: TerraformStack;

• Type: cdktn.TerraformStack

---

fqn^Required

public readonly fqn: string;

• Type: string

---

friendlyUniqueId^Required

public readonly friendlyUniqueId: string;

• Type: string

---

terraformMetaArguments^Required

public readonly terraformMetaArguments: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

terraformResourceType^Required

public readonly terraformResourceType: string;

• Type: string

---

terraformGeneratorMetadata^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

• Type: cdktn.TerraformProviderGeneratorMetadata

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktn.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: string[];

• Type: string[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktn.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktn.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktn.TerraformProvider

---

provisioners^Optional

public readonly provisioners: (FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner)[];

• Type: cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner[]

---

backupRetentionPolicy^Required

public readonly backupRetentionPolicy: NetappBackupVaultBackupRetentionPolicyOutputReference;

• Type: NetappBackupVaultBackupRetentionPolicyOutputReference

---

backupsCryptoKeyVersion^Required

public readonly backupsCryptoKeyVersion: string;

• Type: string

---

createTime^Required

public readonly createTime: string;

• Type: string

---

destinationBackupVault^Required

public readonly destinationBackupVault: string;

• Type: string

---

effectiveLabels^Required

public readonly effectiveLabels: StringMap;

• Type: cdktn.StringMap

---

encryptionState^Required

public readonly encryptionState: string;

• Type: string

---

sourceBackupVault^Required

public readonly sourceBackupVault: string;

• Type: string

---

sourceRegion^Required

public readonly sourceRegion: string;

• Type: string

---

state^Required

public readonly state: string;

• Type: string

---

terraformLabels^Required

public readonly terraformLabels: StringMap;

• Type: cdktn.StringMap

---

timeouts^Required

public readonly timeouts: NetappBackupVaultTimeoutsOutputReference;

• Type: NetappBackupVaultTimeoutsOutputReference

---

backupRegionInput^Optional

public readonly backupRegionInput: string;

• Type: string

---

backupRetentionPolicyInput^Optional

public readonly backupRetentionPolicyInput: NetappBackupVaultBackupRetentionPolicy;

• Type: NetappBackupVaultBackupRetentionPolicy

---

backupVaultTypeInput^Optional

public readonly backupVaultTypeInput: string;

• Type: string

---

deletionPolicyInput^Optional

public readonly deletionPolicyInput: string;

• Type: string

---

descriptionInput^Optional

public readonly descriptionInput: string;

• Type: string

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

kmsConfigInput^Optional

public readonly kmsConfigInput: string;

• Type: string

---

labelsInput^Optional

public readonly labelsInput: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

locationInput^Optional

public readonly locationInput: string;

• Type: string

---

nameInput^Optional

public readonly nameInput: string;

• Type: string

---

projectInput^Optional

public readonly projectInput: string;

• Type: string

---

timeoutsInput^Optional

public readonly timeoutsInput: IResolvable | NetappBackupVaultTimeouts;

• Type: cdktn.IResolvable | NetappBackupVaultTimeouts

---

backupRegion^Required

public readonly backupRegion: string;

• Type: string

---

backupVaultType^Required

public readonly backupVaultType: string;

• Type: string

---

deletionPolicy^Required

public readonly deletionPolicy: string;

• Type: string

---

description^Required

public readonly description: string;

• Type: string

---

id^Required

public readonly id: string;

• Type: string

---

kmsConfig^Required

public readonly kmsConfig: string;

• Type: string

---

labels^Required

public readonly labels: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

location^Required

public readonly location: string;

• Type: string

---

name^Required

public readonly name: string;

• Type: string

---

project^Required

public readonly project: string;

• Type: string

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

NetappBackupVaultBackupRetentionPolicy

Initializer

import { netappBackupVault } from '@cdktn/provider-google'

const netappBackupVaultBackupRetentionPolicy: netappBackupVault.NetappBackupVaultBackupRetentionPolicy = { ... }

Properties

Name	Type	Description
backupMinimumEnforcedRetentionDays	number	Minimum retention duration in days for backups in the backup vault.
dailyBackupImmutable	boolean | cdktn.IResolvable	Indicates if the daily backups are immutable. At least one of daily_backup_immutable, weekly_backup_immutable, monthly_backup_immutable and manual_backup_immutable must be true.
manualBackupImmutable	boolean | cdktn.IResolvable	Indicates if the manual backups are immutable. At least one of daily_backup_immutable, weekly_backup_immutable, monthly_backup_immutable and manual_backup_immutable must be true.
monthlyBackupImmutable	boolean | cdktn.IResolvable	Indicates if the monthly backups are immutable. At least one of daily_backup_immutable, weekly_backup_immutable, monthly_backup_immutable and manual_backup_immutable must be true.
weeklyBackupImmutable	boolean | cdktn.IResolvable	Indicates if the weekly backups are immutable. At least one of daily_backup_immutable, weekly_backup_immutable, monthly_backup_immutable and manual_backup_immutable must be true.

---

backupMinimumEnforcedRetentionDays^Required

public readonly backupMinimumEnforcedRetentionDays: number;

• Type: number

Minimum retention duration in days for backups in the backup vault.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/netapp_backup_vault#backup_minimum_enforced_retention_days NetappBackupVault#backup_minimum_enforced_retention_days}

---

dailyBackupImmutable^Optional

public readonly dailyBackupImmutable: boolean | IResolvable;

• Type: boolean | cdktn.IResolvable

Indicates if the daily backups are immutable. At least one of daily_backup_immutable, weekly_backup_immutable, monthly_backup_immutable and manual_backup_immutable must be true.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/netapp_backup_vault#daily_backup_immutable NetappBackupVault#daily_backup_immutable}

---

manualBackupImmutable^Optional

public readonly manualBackupImmutable: boolean | IResolvable;

• Type: boolean | cdktn.IResolvable

Indicates if the manual backups are immutable. At least one of daily_backup_immutable, weekly_backup_immutable, monthly_backup_immutable and manual_backup_immutable must be true.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/netapp_backup_vault#manual_backup_immutable NetappBackupVault#manual_backup_immutable}

---

monthlyBackupImmutable^Optional

public readonly monthlyBackupImmutable: boolean | IResolvable;

• Type: boolean | cdktn.IResolvable

Indicates if the monthly backups are immutable. At least one of daily_backup_immutable, weekly_backup_immutable, monthly_backup_immutable and manual_backup_immutable must be true.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/netapp_backup_vault#monthly_backup_immutable NetappBackupVault#monthly_backup_immutable}

---

weeklyBackupImmutable^Optional

public readonly weeklyBackupImmutable: boolean | IResolvable;

• Type: boolean | cdktn.IResolvable

Indicates if the weekly backups are immutable. At least one of daily_backup_immutable, weekly_backup_immutable, monthly_backup_immutable and manual_backup_immutable must be true.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/netapp_backup_vault#weekly_backup_immutable NetappBackupVault#weekly_backup_immutable}

---

NetappBackupVaultConfig

Initializer

import { netappBackupVault } from '@cdktn/provider-google'

const netappBackupVaultConfig: netappBackupVault.NetappBackupVaultConfig = { ... }

Properties

Name	Type	Description
connection	cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection	No description.
count	number | cdktn.TerraformCount	No description.
dependsOn	cdktn.ITerraformDependable[]	No description.
forEach	cdktn.ITerraformIterator	No description.
lifecycle	cdktn.TerraformResourceLifecycle	No description.
provider	cdktn.TerraformProvider	No description.
provisioners	cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner[]	No description.
location	string	Location (region) of the backup vault.
name	string	The resource name of the backup vault. Needs to be unique per location.
backupRegion	string	Region in which backup is stored.
backupRetentionPolicy	NetappBackupVaultBackupRetentionPolicy	backup_retention_policy block.
backupVaultType	string	Type of the backup vault to be created. Default is IN_REGION. Possible values: ["BACKUP_VAULT_TYPE_UNSPECIFIED", "IN_REGION", "CROSS_REGION"].
deletionPolicy	string	Whether Terraform will be prevented from destroying the instance.
description	string	An optional description of this resource.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/netapp_backup_vault#id NetappBackupVault#id}.
kmsConfig	string	Specifies the Key Management System (KMS) configuration to be used for backup encryption. Format: 'projects/{{project}}/locations/{{location}}/kmsConfigs/{{kms_config}}'.
labels	{[ key: string ]: string}	Labels as key value pairs. Example: '{ "owner": "Bob", "department": "finance", "purpose": "testing" }'.
project	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/netapp_backup_vault#project NetappBackupVault#project}.
timeouts	NetappBackupVaultTimeouts	timeouts block.

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktn.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: ITerraformDependable[];

• Type: cdktn.ITerraformDependable[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktn.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktn.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktn.TerraformProvider

---

provisioners^Optional

public readonly provisioners: (FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner)[];

• Type: cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner[]

---

location^Required

public readonly location: string;

• Type: string

Location (region) of the backup vault.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/netapp_backup_vault#location NetappBackupVault#location}

---

name^Required

public readonly name: string;

• Type: string

The resource name of the backup vault. Needs to be unique per location.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/netapp_backup_vault#name NetappBackupVault#name}

---

backupRegion^Optional

public readonly backupRegion: string;

• Type: string

Region in which backup is stored.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/netapp_backup_vault#backup_region NetappBackupVault#backup_region}

---

backupRetentionPolicy^Optional

public readonly backupRetentionPolicy: NetappBackupVaultBackupRetentionPolicy;

• Type: NetappBackupVaultBackupRetentionPolicy

backup_retention_policy block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/netapp_backup_vault#backup_retention_policy NetappBackupVault#backup_retention_policy}

---

backupVaultType^Optional

public readonly backupVaultType: string;

• Type: string

Type of the backup vault to be created. Default is IN_REGION. Possible values: ["BACKUP_VAULT_TYPE_UNSPECIFIED", "IN_REGION", "CROSS_REGION"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/netapp_backup_vault#backup_vault_type NetappBackupVault#backup_vault_type}

---

deletionPolicy^Optional

public readonly deletionPolicy: string;

• Type: string

Whether Terraform will be prevented from destroying the instance.

Defaults to "DELETE". When a 'terraform destroy' or 'terraform apply' would delete the instance, 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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/netapp_backup_vault#deletion_policy NetappBackupVault#deletion_policy}

---

description^Optional

public readonly description: string;

• Type: string

An optional description of this resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/netapp_backup_vault#description NetappBackupVault#description}

---

id^Optional

public readonly id: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/netapp_backup_vault#id NetappBackupVault#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.

---

kmsConfig^Optional

public readonly kmsConfig: string;

• Type: string

Specifies the Key Management System (KMS) configuration to be used for backup encryption. Format: 'projects/{{project}}/locations/{{location}}/kmsConfigs/{{kms_config}}'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/netapp_backup_vault#kms_config NetappBackupVault#kms_config}

---

labels^Optional

public readonly labels: {[ key: string ]: string};

• Type: {[ key: string ]: 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/7.40.0/docs/resources/netapp_backup_vault#labels NetappBackupVault#labels}

---

project^Optional

public readonly project: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/netapp_backup_vault#project NetappBackupVault#project}.

---

timeouts^Optional

public readonly timeouts: NetappBackupVaultTimeouts;

• Type: NetappBackupVaultTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/netapp_backup_vault#timeouts NetappBackupVault#timeouts}

---

NetappBackupVaultTimeouts

Initializer

import { netappBackupVault } from '@cdktn/provider-google'

const netappBackupVaultTimeouts: netappBackupVault.NetappBackupVaultTimeouts = { ... }

Properties

Name	Type	Description
create	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/netapp_backup_vault#create NetappBackupVault#create}.
delete	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/netapp_backup_vault#delete NetappBackupVault#delete}.
update	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/netapp_backup_vault#update NetappBackupVault#update}.

---

create^Optional

public readonly create: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/netapp_backup_vault#create NetappBackupVault#create}.

---

delete^Optional

public readonly delete: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/netapp_backup_vault#delete NetappBackupVault#delete}.

---

update^Optional

public readonly update: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/netapp_backup_vault#update NetappBackupVault#update}.

---

Classes

NetappBackupVaultBackupRetentionPolicyOutputReference

Initializers

import { netappBackupVault } from '@cdktn/provider-google'

new netappBackupVault.NetappBackupVaultBackupRetentionPolicyOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
terraformResource	cdktn.IInterpolatingParent	The parent resource.
terraformAttribute	string	The attribute on the parent resource this class is referencing.

---

terraformResource^Required

• Type: cdktn.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

Methods

Name	Description
computeFqn	No description.
getAnyMapAttribute	No description.
getBooleanAttribute	No description.
getBooleanMapAttribute	No description.
getListAttribute	No description.
getNumberAttribute	No description.
getNumberListAttribute	No description.
getNumberMapAttribute	No description.
getStringAttribute	No description.
getStringMapAttribute	No description.
interpolationForAttribute	No description.
resolve	Produce the Token's value at resolution time.
toString	Return a string representation of this resolvable object.
resetDailyBackupImmutable	No description.
resetManualBackupImmutable	No description.
resetMonthlyBackupImmutable	No description.
resetWeeklyBackupImmutable	No description.

---

computeFqn

public computeFqn(): string

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

interpolationForAttribute

public interpolationForAttribute(property: string): IResolvable

property^Required

• Type: string

---

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktn.IResolveContext

---

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetDailyBackupImmutable

public resetDailyBackupImmutable(): void

resetManualBackupImmutable

public resetManualBackupImmutable(): void

resetMonthlyBackupImmutable

public resetMonthlyBackupImmutable(): void

resetWeeklyBackupImmutable

public resetWeeklyBackupImmutable(): void

Properties

Name	Type	Description
creationStack	string[]	The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn	string	No description.
backupMinimumEnforcedRetentionDaysInput	number	No description.
dailyBackupImmutableInput	boolean | cdktn.IResolvable	No description.
manualBackupImmutableInput	boolean | cdktn.IResolvable	No description.
monthlyBackupImmutableInput	boolean | cdktn.IResolvable	No description.
weeklyBackupImmutableInput	boolean | cdktn.IResolvable	No description.
backupMinimumEnforcedRetentionDays	number	No description.
dailyBackupImmutable	boolean | cdktn.IResolvable	No description.
manualBackupImmutable	boolean | cdktn.IResolvable	No description.
monthlyBackupImmutable	boolean | cdktn.IResolvable	No description.
weeklyBackupImmutable	boolean | cdktn.IResolvable	No description.
internalValue	NetappBackupVaultBackupRetentionPolicy	No description.

---

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

---

fqn^Required

public readonly fqn: string;

• Type: string

---

backupMinimumEnforcedRetentionDaysInput^Optional

public readonly backupMinimumEnforcedRetentionDaysInput: number;

• Type: number

---

dailyBackupImmutableInput^Optional

public readonly dailyBackupImmutableInput: boolean | IResolvable;

• Type: boolean | cdktn.IResolvable

---

manualBackupImmutableInput^Optional

public readonly manualBackupImmutableInput: boolean | IResolvable;

• Type: boolean | cdktn.IResolvable

---

monthlyBackupImmutableInput^Optional

public readonly monthlyBackupImmutableInput: boolean | IResolvable;

• Type: boolean | cdktn.IResolvable

---

weeklyBackupImmutableInput^Optional

public readonly weeklyBackupImmutableInput: boolean | IResolvable;

• Type: boolean | cdktn.IResolvable

---

backupMinimumEnforcedRetentionDays^Required

public readonly backupMinimumEnforcedRetentionDays: number;

• Type: number

---

dailyBackupImmutable^Required

public readonly dailyBackupImmutable: boolean | IResolvable;

• Type: boolean | cdktn.IResolvable

---

manualBackupImmutable^Required

public readonly manualBackupImmutable: boolean | IResolvable;

• Type: boolean | cdktn.IResolvable

---

monthlyBackupImmutable^Required

public readonly monthlyBackupImmutable: boolean | IResolvable;

• Type: boolean | cdktn.IResolvable

---

weeklyBackupImmutable^Required

public readonly weeklyBackupImmutable: boolean | IResolvable;

• Type: boolean | cdktn.IResolvable

---

internalValue^Optional

public readonly internalValue: NetappBackupVaultBackupRetentionPolicy;

• Type: NetappBackupVaultBackupRetentionPolicy

---

NetappBackupVaultTimeoutsOutputReference

Initializers

import { netappBackupVault } from '@cdktn/provider-google'

new netappBackupVault.NetappBackupVaultTimeoutsOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
terraformResource	cdktn.IInterpolatingParent	The parent resource.
terraformAttribute	string	The attribute on the parent resource this class is referencing.

---

terraformResource^Required

• Type: cdktn.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

Methods

Name	Description
computeFqn	No description.
getAnyMapAttribute	No description.
getBooleanAttribute	No description.
getBooleanMapAttribute	No description.
getListAttribute	No description.
getNumberAttribute	No description.
getNumberListAttribute	No description.
getNumberMapAttribute	No description.
getStringAttribute	No description.
getStringMapAttribute	No description.
interpolationForAttribute	No description.
resolve	Produce the Token's value at resolution time.
toString	Return a string representation of this resolvable object.
resetCreate	No description.
resetDelete	No description.
resetUpdate	No description.

---

computeFqn

public computeFqn(): string

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

interpolationForAttribute

public interpolationForAttribute(property: string): IResolvable

property^Required

• Type: string

---

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktn.IResolveContext

---

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetCreate

public resetCreate(): void

resetDelete

public resetDelete(): void

resetUpdate

public resetUpdate(): void

Properties

Name	Type	Description
creationStack	string[]	The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn	string	No description.
createInput	string	No description.
deleteInput	string	No description.
updateInput	string	No description.
create	string	No description.
delete	string	No description.
update	string	No description.
internalValue	cdktn.IResolvable | NetappBackupVaultTimeouts	No description.

---

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

---

fqn^Required

public readonly fqn: string;

• Type: string

---

createInput^Optional

public readonly createInput: string;

• Type: string

---

deleteInput^Optional

public readonly deleteInput: string;

• Type: string

---

updateInput^Optional

public readonly updateInput: string;

• Type: string

---

create^Required

public readonly create: string;

• Type: string

---

delete^Required

public readonly delete: string;

• Type: string

---

update^Required

public readonly update: string;

• Type: string

---

internalValue^Optional

public readonly internalValue: IResolvable | NetappBackupVaultTimeouts;

• Type: cdktn.IResolvable | NetappBackupVaultTimeouts

---