`backupDrBackupVault` Submodule

Constructs

BackupDrBackupVault

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

Initializers

import "github.com/cdktf/cdktf-provider-google-go/google/v14/backupdrbackupvault"

backupdrbackupvault.NewBackupDrBackupVault(scope Construct, id *string, config BackupDrBackupVaultConfig) BackupDrBackupVault

Name	Type	Description
`scope`	`github.com/aws/constructs-go/constructs/v10.Construct`	The scope in which to define this construct.
`id`	`*string`	The scoped construct ID.
`config`	`BackupDrBackupVaultConfig`	No description.

`scope`^Required

Type: github.com/aws/constructs-go/constructs/v10.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`

func ToString() *string

Returns a string representation of this construct.

`AddOverride`

func AddOverride(path *string, value interface{})

`path`^Required

Type: *string

`value`^Required

Type: interface{}

`OverrideLogicalId`

func OverrideLogicalId(newLogicalId *string)

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`

func ResetOverrideLogicalId()

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

`ToHclTerraform`

func ToHclTerraform() interface{}

`ToMetadata`

func ToMetadata() interface{}

`ToTerraform`

func ToTerraform() interface{}

Adds this resource to the terraform JSON output.

`AddMoveTarget`

func AddMoveTarget(moveTarget *string)

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`

func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}

`terraformAttribute`^Required

Type: *string

`GetBooleanAttribute`

func GetBooleanAttribute(terraformAttribute *string) IResolvable

`terraformAttribute`^Required

Type: *string

`GetBooleanMapAttribute`

func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool

`terraformAttribute`^Required

Type: *string

`GetListAttribute`

func GetListAttribute(terraformAttribute *string) *[]*string

`terraformAttribute`^Required

Type: *string

`GetNumberAttribute`

func GetNumberAttribute(terraformAttribute *string) *f64

`terraformAttribute`^Required

Type: *string

`GetNumberListAttribute`

func GetNumberListAttribute(terraformAttribute *string) *[]*f64

`terraformAttribute`^Required

Type: *string

`GetNumberMapAttribute`

func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64

`terraformAttribute`^Required

Type: *string

`GetStringAttribute`

func GetStringAttribute(terraformAttribute *string) *string

`terraformAttribute`^Required

Type: *string

`GetStringMapAttribute`

func GetStringMapAttribute(terraformAttribute *string) *map[string]*string

`terraformAttribute`^Required

Type: *string

`HasResourceMove`

func HasResourceMove() interface{}

`ImportFrom`

func ImportFrom(id *string, provider TerraformProvider)

`id`^Required

Type: *string

`provider`^Optional

Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

`InterpolationForAttribute`

func InterpolationForAttribute(terraformAttribute *string) IResolvable

`terraformAttribute`^Required

Type: *string

`MoveFromId`

func MoveFromId(id *string)

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`

func MoveTo(moveTarget *string, index interface{})

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: interface{}

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

`MoveToId`

func MoveToId(id *string)

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`

func PutTimeouts(value BackupDrBackupVaultTimeouts)

`value`^Required

Type: BackupDrBackupVaultTimeouts

`ResetAccessRestriction`

func ResetAccessRestriction()

`ResetAllowMissing`

func ResetAllowMissing()

`ResetAnnotations`

func ResetAnnotations()

`ResetDescription`

func ResetDescription()

`ResetEffectiveTime`

func ResetEffectiveTime()

`ResetForceDelete`

func ResetForceDelete()

`ResetForceUpdate`

func ResetForceUpdate()

`ResetId`

func ResetId()

`ResetIgnoreBackupPlanReferences`

func ResetIgnoreBackupPlanReferences()

`ResetIgnoreInactiveDatasources`

func ResetIgnoreInactiveDatasources()

`ResetLabels`

func ResetLabels()

`ResetProject`

func ResetProject()

`ResetTimeouts`

func ResetTimeouts()

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 "github.com/cdktf/cdktf-provider-google-go/google/v14/backupdrbackupvault"

backupdrbackupvault.BackupDrBackupVault_IsConstruct(x interface{}) *bool

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: interface{}

Any object.

`IsTerraformElement`

import "github.com/cdktf/cdktf-provider-google-go/google/v14/backupdrbackupvault"

backupdrbackupvault.BackupDrBackupVault_IsTerraformElement(x interface{}) *bool

`x`^Required

Type: interface{}

`IsTerraformResource`

import "github.com/cdktf/cdktf-provider-google-go/google/v14/backupdrbackupvault"

backupdrbackupvault.BackupDrBackupVault_IsTerraformResource(x interface{}) *bool

`x`^Required

Type: interface{}

`GenerateConfigForImport`

import "github.com/cdktf/cdktf-provider-google-go/google/v14/backupdrbackupvault"

backupdrbackupvault.BackupDrBackupVault_GenerateConfigForImport(scope Construct, importToId *string, importFromId *string, provider TerraformProvider) ImportableResource

Generates CDKTF code for importing a BackupDrBackupVault resource upon running "cdktf plan ".

`scope`^Required

Type: github.com/aws/constructs-go/constructs/v10.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.17.0/docs/resources/backup_dr_backup_vault#import import section} in the documentation of this resource for the id to use

`provider`^Optional

Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

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

Properties

Name	Type	Description
`Node`	`github.com/aws/constructs-go/constructs/v10.Node`	The tree node.
`CdktfStack`	`github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack`	No description.
`Fqn`	`*string`	No description.
`FriendlyUniqueId`	`*string`	No description.
`TerraformMetaArguments`	`*map[string]interface{}`	No description.
`TerraformResourceType`	`*string`	No description.
`TerraformGeneratorMetadata`	`github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata`	No description.
`Connection`	`interface{}`	No description.
`Count`	`interface{}`	No description.
`DependsOn`	`[]string`	No description.
`ForEach`	`github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator`	No description.
`Lifecycle`	`github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle`	No description.
`Provider`	`github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider`	No description.
`Provisioners`	`*[]interface{}`	No description.
`BackupCount`	`*string`	No description.
`CreateTime`	`*string`	No description.
`Deletable`	`github.com/hashicorp/terraform-cdk-go/cdktf.IResolvable`	No description.
`EffectiveAnnotations`	`github.com/hashicorp/terraform-cdk-go/cdktf.StringMap`	No description.
`EffectiveLabels`	`github.com/hashicorp/terraform-cdk-go/cdktf.StringMap`	No description.
`Etag`	`*string`	No description.
`Name`	`*string`	No description.
`ServiceAccount`	`*string`	No description.
`State`	`*string`	No description.
`TerraformLabels`	`github.com/hashicorp/terraform-cdk-go/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`	`interface{}`	No description.
`AnnotationsInput`	`map[string]string`	No description.
`BackupMinimumEnforcedRetentionDurationInput`	`*string`	No description.
`BackupVaultIdInput`	`*string`	No description.
`DescriptionInput`	`*string`	No description.
`EffectiveTimeInput`	`*string`	No description.
`ForceDeleteInput`	`interface{}`	No description.
`ForceUpdateInput`	`interface{}`	No description.
`IdInput`	`*string`	No description.
`IgnoreBackupPlanReferencesInput`	`interface{}`	No description.
`IgnoreInactiveDatasourcesInput`	`interface{}`	No description.
`LabelsInput`	`map[string]string`	No description.
`LocationInput`	`*string`	No description.
`ProjectInput`	`*string`	No description.
`TimeoutsInput`	`interface{}`	No description.
`AccessRestriction`	`*string`	No description.
`AllowMissing`	`interface{}`	No description.
`Annotations`	`map[string]string`	No description.
`BackupMinimumEnforcedRetentionDuration`	`*string`	No description.
`BackupVaultId`	`*string`	No description.
`Description`	`*string`	No description.
`EffectiveTime`	`*string`	No description.
`ForceDelete`	`interface{}`	No description.
`ForceUpdate`	`interface{}`	No description.
`Id`	`*string`	No description.
`IgnoreBackupPlanReferences`	`interface{}`	No description.
`IgnoreInactiveDatasources`	`interface{}`	No description.
`Labels`	`map[string]string`	No description.
`Location`	`*string`	No description.
`Project`	`*string`	No description.

`Node`^Required

func Node() Node

Type: github.com/aws/constructs-go/constructs/v10.Node

The tree node.

`CdktfStack`^Required

func CdktfStack() TerraformStack

Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack

`Fqn`^Required

func Fqn() *string

Type: *string

`FriendlyUniqueId`^Required

func FriendlyUniqueId() *string

Type: *string

`TerraformMetaArguments`^Required

func TerraformMetaArguments() *map[string]interface{}

Type: *map[string]interface{}

`TerraformResourceType`^Required

func TerraformResourceType() *string

Type: *string

`TerraformGeneratorMetadata`^Optional

func TerraformGeneratorMetadata() TerraformProviderGeneratorMetadata

Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata

`Connection`^Optional

func Connection() interface{}

Type: interface{}

`Count`^Optional

func Count() interface{}

Type: interface{}

`DependsOn`^Optional

func DependsOn() *[]*string

Type: *[]*string

`ForEach`^Optional

func ForEach() ITerraformIterator

Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator

`Lifecycle`^Optional

func Lifecycle() TerraformResourceLifecycle

Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle

`Provider`^Optional

func Provider() TerraformProvider

Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

`Provisioners`^Optional

func Provisioners() *[]interface{}

Type: *[]interface{}

`BackupCount`^Required

func BackupCount() *string

Type: *string

`CreateTime`^Required

func CreateTime() *string

Type: *string

`Deletable`^Required

func Deletable() IResolvable

Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolvable

`EffectiveAnnotations`^Required

func EffectiveAnnotations() StringMap

Type: github.com/hashicorp/terraform-cdk-go/cdktf.StringMap

`EffectiveLabels`^Required

func EffectiveLabels() StringMap

Type: github.com/hashicorp/terraform-cdk-go/cdktf.StringMap

`Etag`^Required

func Etag() *string

Type: *string

`Name`^Required

func Name() *string

Type: *string

`ServiceAccount`^Required

func ServiceAccount() *string

Type: *string

`State`^Required

func State() *string

Type: *string

`TerraformLabels`^Required

func TerraformLabels() StringMap

Type: github.com/hashicorp/terraform-cdk-go/cdktf.StringMap

`Timeouts`^Required

func Timeouts() BackupDrBackupVaultTimeoutsOutputReference

Type: BackupDrBackupVaultTimeoutsOutputReference

`TotalStoredBytes`^Required

func TotalStoredBytes() *string

Type: *string

`Uid`^Required

func Uid() *string

Type: *string

`UpdateTime`^Required

func UpdateTime() *string

Type: *string

`AccessRestrictionInput`^Optional

func AccessRestrictionInput() *string

Type: *string

`AllowMissingInput`^Optional

func AllowMissingInput() interface{}

Type: interface{}

`AnnotationsInput`^Optional

func AnnotationsInput() *map[string]*string

Type: *map[string]*string

`BackupMinimumEnforcedRetentionDurationInput`^Optional

func BackupMinimumEnforcedRetentionDurationInput() *string

Type: *string

`BackupVaultIdInput`^Optional

func BackupVaultIdInput() *string

Type: *string

`DescriptionInput`^Optional

func DescriptionInput() *string

Type: *string

`EffectiveTimeInput`^Optional

func EffectiveTimeInput() *string

Type: *string

`ForceDeleteInput`^Optional

func ForceDeleteInput() interface{}

Type: interface{}

`ForceUpdateInput`^Optional

func ForceUpdateInput() interface{}

Type: interface{}

`IdInput`^Optional

func IdInput() *string

Type: *string

`IgnoreBackupPlanReferencesInput`^Optional

func IgnoreBackupPlanReferencesInput() interface{}

Type: interface{}

`IgnoreInactiveDatasourcesInput`^Optional

func IgnoreInactiveDatasourcesInput() interface{}

Type: interface{}

`LabelsInput`^Optional

func LabelsInput() *map[string]*string

Type: *map[string]*string

`LocationInput`^Optional

func LocationInput() *string

Type: *string

`ProjectInput`^Optional

func ProjectInput() *string

Type: *string

`TimeoutsInput`^Optional

func TimeoutsInput() interface{}

Type: interface{}

`AccessRestriction`^Required

func AccessRestriction() *string

Type: *string

`AllowMissing`^Required

func AllowMissing() interface{}

Type: interface{}

`Annotations`^Required

func Annotations() *map[string]*string

Type: *map[string]*string

`BackupMinimumEnforcedRetentionDuration`^Required

func BackupMinimumEnforcedRetentionDuration() *string

Type: *string

`BackupVaultId`^Required

func BackupVaultId() *string

Type: *string

`Description`^Required

func Description() *string

Type: *string

`EffectiveTime`^Required

func EffectiveTime() *string

Type: *string

`ForceDelete`^Required

func ForceDelete() interface{}

Type: interface{}

`ForceUpdate`^Required

func ForceUpdate() interface{}

Type: interface{}

`Id`^Required

func Id() *string

Type: *string

`IgnoreBackupPlanReferences`^Required

func IgnoreBackupPlanReferences() interface{}

Type: interface{}

`IgnoreInactiveDatasources`^Required

func IgnoreInactiveDatasources() interface{}

Type: interface{}

`Labels`^Required

func Labels() *map[string]*string

Type: *map[string]*string

`Location`^Required

func Location() *string

Type: *string

`Project`^Required

func Project() *string

Type: *string

Constants

Name	Type	Description
`TfResourceType`	`*string`	No description.

`TfResourceType`^Required

func TfResourceType() *string

Type: *string

Structs

BackupDrBackupVaultConfig

Initializer

import "github.com/cdktf/cdktf-provider-google-go/google/v14/backupdrbackupvault"

&backupdrbackupvault.BackupDrBackupVaultConfig {
	Connection: interface{},
	Count: interface{},
	DependsOn: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable,
	ForEach: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator,
	Lifecycle: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle,
	Provider: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider,
	Provisioners: *[]interface{},
	BackupMinimumEnforcedRetentionDuration: *string,
	BackupVaultId: *string,
	Location: *string,
	AccessRestriction: *string,
	AllowMissing: interface{},
	Annotations: *map[string]*string,
	Description: *string,
	EffectiveTime: *string,
	ForceDelete: interface{},
	ForceUpdate: interface{},
	Id: *string,
	IgnoreBackupPlanReferences: interface{},
	IgnoreInactiveDatasources: interface{},
	Labels: *map[string]*string,
	Project: *string,
	Timeouts: github.com/cdktf/cdktf-provider-google-go/google/v14.backupDrBackupVault.BackupDrBackupVaultTimeouts,
}

Properties

Name	Type	Description
`Connection`	`interface{}`	No description.
`Count`	`interface{}`	No description.
`DependsOn`	`*[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable`	No description.
`ForEach`	`github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator`	No description.
`Lifecycle`	`github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle`	No description.
`Provider`	`github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider`	No description.
`Provisioners`	`*[]interface{}`	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`	`interface{}`	Allow idempotent deletion of backup vault. The request will still succeed in case the backup vault does not exist.
`Annotations`	`map[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`	`interface{}`	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`	`interface{}`	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.17.0/docs/resources/backup_dr_backup_vault#id BackupDrBackupVault#id}.
`IgnoreBackupPlanReferences`	`interface{}`	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`	`interface{}`	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`	`map[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.17.0/docs/resources/backup_dr_backup_vault#project BackupDrBackupVault#project}.
`Timeouts`	`BackupDrBackupVaultTimeouts`	timeouts block.

`Connection`^Optional

Connection interface{}

Type: interface{}

`Count`^Optional

Count interface{}

Type: interface{}

`DependsOn`^Optional

DependsOn *[]ITerraformDependable

Type: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable

`ForEach`^Optional

ForEach ITerraformIterator

Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator

`Lifecycle`^Optional

Lifecycle TerraformResourceLifecycle

Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle

`Provider`^Optional

Provider TerraformProvider

Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

`Provisioners`^Optional

Provisioners *[]interface{}

Type: *[]interface{}

`BackupMinimumEnforcedRetentionDuration`^Required

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

`BackupVaultId`^Required

BackupVaultId *string

Type: *string

Required. ID of the requesting object.

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

`Location`^Required

Location *string

Type: *string

The GCP location for the backup vault.

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

`AccessRestriction`^Optional

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

`AllowMissing`^Optional

AllowMissing interface{}

Type: interface{}

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

`Annotations`^Optional

Annotations *map[string]*string

Type: *map[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.17.0/docs/resources/backup_dr_backup_vault#annotations BackupDrBackupVault#annotations}

`Description`^Optional

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

`EffectiveTime`^Optional

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

`ForceDelete`^Optional

ForceDelete interface{}

Type: interface{}

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

`ForceUpdate`^Optional

ForceUpdate interface{}

Type: interface{}

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

`Id`^Optional

Id *string

Type: *string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.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

IgnoreBackupPlanReferences interface{}

Type: interface{}

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

`IgnoreInactiveDatasources`^Optional

IgnoreInactiveDatasources interface{}

Type: interface{}

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

`Labels`^Optional

Labels *map[string]*string

Type: *map[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.17.0/docs/resources/backup_dr_backup_vault#labels BackupDrBackupVault#labels}

`Project`^Optional

Project *string

Type: *string

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

`Timeouts`^Optional

Timeouts BackupDrBackupVaultTimeouts

Type: BackupDrBackupVaultTimeouts

timeouts block.

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

BackupDrBackupVaultTimeouts

Initializer

import "github.com/cdktf/cdktf-provider-google-go/google/v14/backupdrbackupvault"

&backupdrbackupvault.BackupDrBackupVaultTimeouts {
	Create: *string,
	Delete: *string,
	Update: *string,
}

Properties

Name	Type	Description
`Create`	`*string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.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.17.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.17.0/docs/resources/backup_dr_backup_vault#update BackupDrBackupVault#update}.

`Create`^Optional

Create *string

Type: *string

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

`Delete`^Optional

Delete *string

Type: *string

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

`Update`^Optional

Update *string

Type: *string

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

Classes

BackupDrBackupVaultTimeoutsOutputReference

Initializers

import "github.com/cdktf/cdktf-provider-google-go/google/v14/backupdrbackupvault"

backupdrbackupvault.NewBackupDrBackupVaultTimeoutsOutputReference(terraformResource IInterpolatingParent, terraformAttribute *string) BackupDrBackupVaultTimeoutsOutputReference

Name	Type	Description
`terraformResource`	`github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`*string`	The attribute on the parent resource this class is referencing.

`terraformResource`^Required

Type: github.com/hashicorp/terraform-cdk-go/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`

func ComputeFqn() *string

`GetAnyMapAttribute`

func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}

`terraformAttribute`^Required

Type: *string

`GetBooleanAttribute`

func GetBooleanAttribute(terraformAttribute *string) IResolvable

`terraformAttribute`^Required

Type: *string

`GetBooleanMapAttribute`

func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool

`terraformAttribute`^Required

Type: *string

`GetListAttribute`

func GetListAttribute(terraformAttribute *string) *[]*string

`terraformAttribute`^Required

Type: *string

`GetNumberAttribute`

func GetNumberAttribute(terraformAttribute *string) *f64

`terraformAttribute`^Required

Type: *string

`GetNumberListAttribute`

func GetNumberListAttribute(terraformAttribute *string) *[]*f64

`terraformAttribute`^Required

Type: *string

`GetNumberMapAttribute`

func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64

`terraformAttribute`^Required

Type: *string

`GetStringAttribute`

func GetStringAttribute(terraformAttribute *string) *string

`terraformAttribute`^Required

Type: *string

`GetStringMapAttribute`

func GetStringMapAttribute(terraformAttribute *string) *map[string]*string

`terraformAttribute`^Required

Type: *string

`InterpolationForAttribute`

func InterpolationForAttribute(property *string) IResolvable

`property`^Required

Type: *string

`Resolve`

func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

`_context`^Required

Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolveContext

`ToString`

func ToString() *string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`ResetCreate`

func ResetCreate()

`ResetDelete`

func ResetDelete()

`ResetUpdate`

func ResetUpdate()

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`	`interface{}`	No description.

`CreationStack`^Required

func 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

func Fqn() *string

Type: *string

`CreateInput`^Optional

func CreateInput() *string

Type: *string

`DeleteInput`^Optional

func DeleteInput() *string

Type: *string

`UpdateInput`^Optional

func UpdateInput() *string

Type: *string

`Create`^Required

func Create() *string

Type: *string

`Delete`^Required

func Delete() *string

Type: *string

`Update`^Required

func Update() *string

Type: *string

`InternalValue`^Optional

func InternalValue() interface{}

Type: interface{}

Files

backupDrBackupVault.go.md

Latest commit

History

backupDrBackupVault.go.md

File metadata and controls

backupDrBackupVault Submodule

Constructs