backupDrBackupVault.typescript.md

backupDrBackupVault Submodule

Constructs

BackupDrBackupVault

Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/backup_dr_backup_vault google_backup_dr_backup_vault}.

Initializers

import { backupDrBackupVault } from '@cdktf/provider-google'

new backupDrBackupVault.BackupDrBackupVault(scope: Construct, id: string, config: BackupDrBackupVaultConfig)

Name	Type	Description
scope	constructs.Construct	The scope in which to define this construct.
id	string	The scoped construct ID.
config	BackupDrBackupVaultConfig	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: BackupDrBackupVaultConfig

---

Methods

Name	Description
toString	Returns a string representation of 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".
putTimeouts	No description.
resetAccessRestriction	No description.
resetAllowMissing	No description.
resetAnnotations	No description.
resetDescription	No description.
resetEffectiveTime	No description.
resetForceDelete	No description.
resetForceUpdate	No description.
resetId	No description.
resetIgnoreBackupPlanReferences	No description.
resetIgnoreInactiveDatasources	No description.
resetLabels	No description.
resetProject	No description.
resetTimeouts	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

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: cdktf.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".

---

putTimeouts

public putTimeouts(value: BackupDrBackupVaultTimeouts): void

value^Required

• Type: BackupDrBackupVaultTimeouts

---

resetAccessRestriction

public resetAccessRestriction(): void

resetAllowMissing

public resetAllowMissing(): void

resetAnnotations

public resetAnnotations(): void

resetDescription

public resetDescription(): void

resetEffectiveTime

public resetEffectiveTime(): void

resetForceDelete

public resetForceDelete(): void

resetForceUpdate

public resetForceUpdate(): void

resetId

public resetId(): void

resetIgnoreBackupPlanReferences

public resetIgnoreBackupPlanReferences(): void

resetIgnoreInactiveDatasources

public resetIgnoreInactiveDatasources(): 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 CDKTF code for importing a BackupDrBackupVault resource upon running "cdktf plan ".

---

isConstruct

import { backupDrBackupVault } from '@cdktf/provider-google'

backupDrBackupVault.BackupDrBackupVault.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 { backupDrBackupVault } from '@cdktf/provider-google'

backupDrBackupVault.BackupDrBackupVault.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

import { backupDrBackupVault } from '@cdktf/provider-google'

backupDrBackupVault.BackupDrBackupVault.isTerraformResource(x: any)

x^Required

• Type: any

---

generateConfigForImport

import { backupDrBackupVault } from '@cdktf/provider-google'

backupDrBackupVault.BackupDrBackupVault.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a BackupDrBackupVault resource upon running "cdktf 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 BackupDrBackupVault to import.

---

importFromId^Required

• Type: string

The id of the existing BackupDrBackupVault that should be imported.

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

---

provider^Optional

• Type: cdktf.TerraformProvider

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

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
cdktfStack	cdktf.TerraformStack	No description.
fqn	string	No description.
friendlyUniqueId	string	No description.
terraformMetaArguments	{[ key: string ]: any}	No description.
terraformResourceType	string	No description.
terraformGeneratorMetadata	cdktf.TerraformProviderGeneratorMetadata	No description.
connection	cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection	No description.
count	number | cdktf.TerraformCount	No description.
dependsOn	string[]	No description.
forEach	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
provisioners	cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]	No description.
backupCount	string	No description.
createTime	string	No description.
deletable	cdktf.IResolvable	No description.
effectiveAnnotations	cdktf.StringMap	No description.
effectiveLabels	cdktf.StringMap	No description.
etag	string	No description.
name	string	No description.
serviceAccount	string	No description.
state	string	No description.
terraformLabels	cdktf.StringMap	No description.
timeouts	BackupDrBackupVaultTimeoutsOutputReference	No description.
totalStoredBytes	string	No description.
uid	string	No description.
updateTime	string	No description.
accessRestrictionInput	string	No description.
allowMissingInput	boolean | cdktf.IResolvable	No description.
annotationsInput	{[ key: string ]: string}	No description.
backupMinimumEnforcedRetentionDurationInput	string	No description.
backupVaultIdInput	string	No description.
descriptionInput	string	No description.
effectiveTimeInput	string	No description.
forceDeleteInput	boolean | cdktf.IResolvable	No description.
forceUpdateInput	boolean | cdktf.IResolvable	No description.
idInput	string	No description.
ignoreBackupPlanReferencesInput	boolean | cdktf.IResolvable	No description.
ignoreInactiveDatasourcesInput	boolean | cdktf.IResolvable	No description.
labelsInput	{[ key: string ]: string}	No description.
locationInput	string	No description.
projectInput	string	No description.
timeoutsInput	cdktf.IResolvable | BackupDrBackupVaultTimeouts	No description.
accessRestriction	string	No description.
allowMissing	boolean | cdktf.IResolvable	No description.
annotations	{[ key: string ]: string}	No description.
backupMinimumEnforcedRetentionDuration	string	No description.
backupVaultId	string	No description.
description	string	No description.
effectiveTime	string	No description.
forceDelete	boolean | cdktf.IResolvable	No description.
forceUpdate	boolean | cdktf.IResolvable	No description.
id	string	No description.
ignoreBackupPlanReferences	boolean | cdktf.IResolvable	No description.
ignoreInactiveDatasources	boolean | cdktf.IResolvable	No description.
labels	{[ key: string ]: string}	No description.
location	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: cdktf.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: cdktf.TerraformProviderGeneratorMetadata

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: string[];

• Type: string[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

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

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

---

backupCount^Required

public readonly backupCount: string;

• Type: string

---

createTime^Required

public readonly createTime: string;

• Type: string

---

deletable^Required

public readonly deletable: IResolvable;

• Type: cdktf.IResolvable

---

effectiveAnnotations^Required

public readonly effectiveAnnotations: StringMap;

• Type: cdktf.StringMap

---

effectiveLabels^Required

public readonly effectiveLabels: StringMap;

• Type: cdktf.StringMap

---

etag^Required

public readonly etag: string;

• Type: string

---

name^Required

public readonly name: string;

• Type: string

---

serviceAccount^Required

public readonly serviceAccount: string;

• Type: string

---

state^Required

public readonly state: string;

• Type: string

---

terraformLabels^Required

public readonly terraformLabels: StringMap;

• Type: cdktf.StringMap

---

timeouts^Required

public readonly timeouts: BackupDrBackupVaultTimeoutsOutputReference;

• Type: BackupDrBackupVaultTimeoutsOutputReference

---

totalStoredBytes^Required

public readonly totalStoredBytes: string;

• Type: string

---

uid^Required

public readonly uid: string;

• Type: string

---

updateTime^Required

public readonly updateTime: string;

• Type: string

---

accessRestrictionInput^Optional

public readonly accessRestrictionInput: string;

• Type: string

---

allowMissingInput^Optional

public readonly allowMissingInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

annotationsInput^Optional

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

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

---

backupMinimumEnforcedRetentionDurationInput^Optional

public readonly backupMinimumEnforcedRetentionDurationInput: string;

• Type: string

---

backupVaultIdInput^Optional

public readonly backupVaultIdInput: string;

• Type: string

---

descriptionInput^Optional

public readonly descriptionInput: string;

• Type: string

---

effectiveTimeInput^Optional

public readonly effectiveTimeInput: string;

• Type: string

---

forceDeleteInput^Optional

public readonly forceDeleteInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

forceUpdateInput^Optional

public readonly forceUpdateInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

ignoreBackupPlanReferencesInput^Optional

public readonly ignoreBackupPlanReferencesInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

ignoreInactiveDatasourcesInput^Optional

public readonly ignoreInactiveDatasourcesInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

labelsInput^Optional

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

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

---

locationInput^Optional

public readonly locationInput: string;

• Type: string

---

projectInput^Optional

public readonly projectInput: string;

• Type: string

---

timeoutsInput^Optional

public readonly timeoutsInput: IResolvable | BackupDrBackupVaultTimeouts;

• Type: cdktf.IResolvable | BackupDrBackupVaultTimeouts

---

accessRestriction^Required

public readonly accessRestriction: string;

• Type: string

---

allowMissing^Required

public readonly allowMissing: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

annotations^Required

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

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

---

backupMinimumEnforcedRetentionDuration^Required

public readonly backupMinimumEnforcedRetentionDuration: string;

• Type: string

---

backupVaultId^Required

public readonly backupVaultId: string;

• Type: string

---

description^Required

public readonly description: string;

• Type: string

---

effectiveTime^Required

public readonly effectiveTime: string;

• Type: string

---

forceDelete^Required

public readonly forceDelete: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

forceUpdate^Required

public readonly forceUpdate: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

id^Required

public readonly id: string;

• Type: string

---

ignoreBackupPlanReferences^Required

public readonly ignoreBackupPlanReferences: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

ignoreInactiveDatasources^Required

public readonly ignoreInactiveDatasources: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

labels^Required

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

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

---

location^Required

public readonly location: 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

BackupDrBackupVaultConfig

Initializer

import { backupDrBackupVault } from '@cdktf/provider-google'

const backupDrBackupVaultConfig: backupDrBackupVault.BackupDrBackupVaultConfig = { ... }

Properties

Name	Type	Description
connection	cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection	No description.
count	number | cdktf.TerraformCount	No description.
dependsOn	cdktf.ITerraformDependable[]	No description.
forEach	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
provisioners	cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]	No description.
backupMinimumEnforcedRetentionDuration	string	Required.
backupVaultId	string	Required. ID of the requesting object.
location	string	The GCP location for the backup vault.
accessRestriction	string	Access restriction for the backup vault.
allowMissing	boolean | cdktf.IResolvable	Allow idempotent deletion of backup vault. The request will still succeed in case the backup vault does not exist.
annotations	{[ key: string ]: string}	Optional. User annotations. See https://google.aip.dev/128#annotations Stores small amounts of arbitrary data.
description	string	Optional. The description of the BackupVault instance (2048 characters or less).
effectiveTime	string	Optional. Time after which the BackupVault resource is locked.
forceDelete	boolean | cdktf.IResolvable	If set, the following restrictions against deletion of the backup vault instance can be overridden: * deletion of a backup vault instance containing no backups, but still containing empty datasources.
forceUpdate	boolean | cdktf.IResolvable	If set, allow update to extend the minimum enforced retention for backup vault.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/backup_dr_backup_vault#id BackupDrBackupVault#id}.
ignoreBackupPlanReferences	boolean | cdktf.IResolvable	If set, the following restrictions against deletion of the backup vault instance can be overridden: * deletion of a backup vault instance that is being referenced by an active backup plan.
ignoreInactiveDatasources	boolean | cdktf.IResolvable	If set, the following restrictions against deletion of the backup vault instance can be overridden: * deletion of a backup vault instance containing no backups, but still containing empty datasources.
labels	{[ key: string ]: string}	Optional. Resource labels to represent user provided metadata.
project	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/backup_dr_backup_vault#project BackupDrBackupVault#project}.
timeouts	BackupDrBackupVaultTimeouts	timeouts block.

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: ITerraformDependable[];

• Type: cdktf.ITerraformDependable[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

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

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

---

backupMinimumEnforcedRetentionDuration^Required

public readonly backupMinimumEnforcedRetentionDuration: string;

• Type: string

Required.

The default and minimum enforced retention for each backup within the backup vault. The enforced retention for each backup can be extended.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/backup_dr_backup_vault#backup_minimum_enforced_retention_duration BackupDrBackupVault#backup_minimum_enforced_retention_duration}

---

backupVaultId^Required

public readonly backupVaultId: string;

• Type: string

Required. ID of the requesting object.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/backup_dr_backup_vault#backup_vault_id BackupDrBackupVault#backup_vault_id}

---

location^Required

public readonly location: string;

• Type: string

The GCP location for the backup vault.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/backup_dr_backup_vault#location BackupDrBackupVault#location}

---

accessRestriction^Optional

public readonly accessRestriction: string;

• Type: string

Access restriction for the backup vault.

Default value is 'WITHIN_ORGANIZATION' if not provided during creation. Default value: "WITHIN_ORGANIZATION" Possible values: ["ACCESS_RESTRICTION_UNSPECIFIED", "WITHIN_PROJECT", "WITHIN_ORGANIZATION", "UNRESTRICTED", "WITHIN_ORG_BUT_UNRESTRICTED_FOR_BA"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/backup_dr_backup_vault#access_restriction BackupDrBackupVault#access_restriction}

---

allowMissing^Optional

public readonly allowMissing: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Allow idempotent deletion of backup vault. The request will still succeed in case the backup vault does not exist.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/backup_dr_backup_vault#allow_missing BackupDrBackupVault#allow_missing}

---

annotations^Optional

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

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

Optional. User annotations. See https://google.aip.dev/128#annotations Stores small amounts of arbitrary data.

Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field 'effective_annotations' for all of the annotations present on the resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/backup_dr_backup_vault#annotations BackupDrBackupVault#annotations}

---

description^Optional

public readonly description: string;

• Type: string

Optional. The description of the BackupVault instance (2048 characters or less).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/backup_dr_backup_vault#description BackupDrBackupVault#description}

---

effectiveTime^Optional

public readonly effectiveTime: string;

• Type: string

Optional. Time after which the BackupVault resource is locked.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/backup_dr_backup_vault#effective_time BackupDrBackupVault#effective_time}

---

forceDelete^Optional

public readonly forceDelete: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

If set, the following restrictions against deletion of the backup vault instance can be overridden: * deletion of a backup vault instance containing no backups, but still containing empty datasources.

• deletion of a backup vault instance that is being referenced by an active backup plan.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/backup_dr_backup_vault#force_delete BackupDrBackupVault#force_delete}

---

forceUpdate^Optional

public readonly forceUpdate: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

If set, allow update to extend the minimum enforced retention for backup vault.

This overrides the restriction against conflicting retention periods. This conflict may occur when the expiration schedule defined by the associated backup plan is shorter than the minimum retention set by the backup vault.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/backup_dr_backup_vault#force_update BackupDrBackupVault#force_update}

---

id^Optional

public readonly id: string;

• Type: string

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

---

ignoreBackupPlanReferences^Optional

public readonly ignoreBackupPlanReferences: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

If set, the following restrictions against deletion of the backup vault instance can be overridden: * deletion of a backup vault instance that is being referenced by an active backup plan.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/backup_dr_backup_vault#ignore_backup_plan_references BackupDrBackupVault#ignore_backup_plan_references}

---

ignoreInactiveDatasources^Optional

public readonly ignoreInactiveDatasources: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

If set, the following restrictions against deletion of the backup vault instance can be overridden: * deletion of a backup vault instance containing no backups, but still containing empty datasources.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/backup_dr_backup_vault#ignore_inactive_datasources BackupDrBackupVault#ignore_inactive_datasources}

---

labels^Optional

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

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

Optional. Resource labels to represent user provided metadata.

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.15.0/docs/resources/backup_dr_backup_vault#labels BackupDrBackupVault#labels}

---

project^Optional

public readonly project: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/backup_dr_backup_vault#project BackupDrBackupVault#project}.

---

timeouts^Optional

public readonly timeouts: BackupDrBackupVaultTimeouts;

• Type: BackupDrBackupVaultTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/backup_dr_backup_vault#timeouts BackupDrBackupVault#timeouts}

---

BackupDrBackupVaultTimeouts

Initializer

import { backupDrBackupVault } from '@cdktf/provider-google'

const backupDrBackupVaultTimeouts: backupDrBackupVault.BackupDrBackupVaultTimeouts = { ... }

Properties

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

---

create^Optional

public readonly create: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/backup_dr_backup_vault#create BackupDrBackupVault#create}.

---

delete^Optional

public readonly delete: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/backup_dr_backup_vault#delete BackupDrBackupVault#delete}.

---

update^Optional

public readonly update: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/backup_dr_backup_vault#update BackupDrBackupVault#update}.

---

Classes

BackupDrBackupVaultTimeoutsOutputReference

Initializers

import { backupDrBackupVault } from '@cdktf/provider-google'

new backupDrBackupVault.BackupDrBackupVaultTimeoutsOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

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

---

terraformResource^Required

• Type: cdktf.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: cdktf.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	cdktf.IResolvable | BackupDrBackupVaultTimeouts	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 | BackupDrBackupVaultTimeouts;

• Type: cdktf.IResolvable | BackupDrBackupVaultTimeouts

---