Skip to content

Latest commit

 

History

History
2391 lines (1521 loc) · 108 KB

backupDrBackupVault.python.md

File metadata and controls

2391 lines (1521 loc) · 108 KB
Raw

backupDrBackupVault Submodule

Constructs

BackupDrBackupVault

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

Initializers 

from cdktf_cdktf_provider_google import backup_dr_backup_vault

backupDrBackupVault.BackupDrBackupVault(
  scope: Construct,
  id: str,
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  backup_minimum_enforced_retention_duration: str,
  backup_vault_id: str,
  location: str,
  access_restriction: str = None,
  allow_missing: typing.Union[bool, IResolvable] = None,
  annotations: typing.Mapping[str] = None,
  description: str = None,
  effective_time: str = None,
  force_delete: typing.Union[bool, IResolvable] = None,
  force_update: typing.Union[bool, IResolvable] = None,
  id: str = None,
  ignore_backup_plan_references: typing.Union[bool, IResolvable] = None,
  ignore_inactive_datasources: typing.Union[bool, IResolvable] = None,
  labels: typing.Mapping[str] = None,
  project: str = None,
  timeouts: BackupDrBackupVaultTimeouts = None
)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id str The scoped construct ID.
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
backup_minimum_enforced_retention_duration str Required.
backup_vault_id str Required. ID of the requesting object.
location str The GCP location for the backup vault.
access_restriction str Access restriction for the backup vault.
allow_missing typing.Union[bool, cdktf.IResolvable] Allow idempotent deletion of backup vault. The request will still succeed in case the backup vault does not exist.
annotations typing.Mapping[str] Optional. User annotations. See https://google.aip.dev/128#annotations Stores small amounts of arbitrary data.
description str Optional. The description of the BackupVault instance (2048 characters or less).
effective_time str Optional. Time after which the BackupVault resource is locked.
force_delete typing.Union[bool, 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.
force_update typing.Union[bool, cdktf.IResolvable] If set, allow update to extend the minimum enforced retention for backup vault.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/backup_dr_backup_vault#id BackupDrBackupVault#id}.
ignore_backup_plan_references typing.Union[bool, 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.
ignore_inactive_datasources typing.Union[bool, 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 typing.Mapping[str] Optional. Resource labels to represent user provided metadata.
project str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/backup_dr_backup_vault#project BackupDrBackupVault#project}.
timeouts BackupDrBackupVaultTimeouts timeouts block.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional
  • Type: typing.List[cdktf.ITerraformDependable]
for_eachOptional
  • Type: cdktf.ITerraformIterator
lifecycleOptional
  • Type: cdktf.TerraformResourceLifecycle
providerOptional
  • Type: cdktf.TerraformProvider
provisionersOptional
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
backup_minimum_enforced_retention_durationRequired
  • Type: str

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

backup_vault_idRequired
  • Type: str

Required. ID of the requesting object.

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

locationRequired
  • Type: str

The GCP location for the backup vault.

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

access_restrictionOptional
  • Type: str

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

allow_missingOptional
  • Type: typing.Union[bool, 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.14.1/docs/resources/backup_dr_backup_vault#allow_missing BackupDrBackupVault#allow_missing}

annotationsOptional
  • Type: typing.Mapping[str]

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

descriptionOptional
  • Type: str

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

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

effective_timeOptional
  • Type: str

Optional. Time after which the BackupVault resource is locked.

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

force_deleteOptional
  • Type: typing.Union[bool, 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.14.1/docs/resources/backup_dr_backup_vault#force_delete BackupDrBackupVault#force_delete}

force_updateOptional
  • Type: typing.Union[bool, 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.14.1/docs/resources/backup_dr_backup_vault#force_update BackupDrBackupVault#force_update}

idOptional
  • Type: str

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

ignore_backup_plan_referencesOptional
  • Type: typing.Union[bool, 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.14.1/docs/resources/backup_dr_backup_vault#ignore_backup_plan_references BackupDrBackupVault#ignore_backup_plan_references}

ignore_inactive_datasourcesOptional
  • Type: typing.Union[bool, 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.14.1/docs/resources/backup_dr_backup_vault#ignore_inactive_datasources BackupDrBackupVault#ignore_inactive_datasources}

labelsOptional
  • Type: typing.Mapping[str]

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

projectOptional
  • Type: str

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

timeoutsOptional

timeouts block.

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

Methods

Name Description
to_string Returns a string representation of this construct.
add_override No description.
override_logical_id Overrides the auto-generated logical ID with a specific ID.
reset_override_logical_id Resets a previously passed logical Id to use the auto-generated logical id again.
to_hcl_terraform No description.
to_metadata No description.
to_terraform Adds this resource to the terraform JSON output.
add_move_target Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
has_resource_move No description.
import_from No description.
interpolation_for_attribute No description.
move_from_id Move the resource corresponding to "id" to this resource.
move_to Moves this resource to the target resource given by moveTarget.
move_to_id Moves this resource to the resource corresponding to "id".
put_timeouts No description.
reset_access_restriction No description.
reset_allow_missing No description.
reset_annotations No description.
reset_description No description.
reset_effective_time No description.
reset_force_delete No description.
reset_force_update No description.
reset_id No description.
reset_ignore_backup_plan_references No description.
reset_ignore_inactive_datasources No description.
reset_labels No description.
reset_project No description.
reset_timeouts No description.
to_string 
def to_string() -> str

Returns a string representation of this construct.

add_override 
def add_override(
  path: str,
  value: typing.Any
) -> None
pathRequired
  • Type: str
valueRequired
  • Type: typing.Any
override_logical_id 
def override_logical_id(
  new_logical_id: str
) -> None

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

new_logical_idRequired
  • Type: str

The new logical ID to use for this stack element.

reset_override_logical_id 
def reset_override_logical_id() -> None

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

to_hcl_terraform 
def to_hcl_terraform() -> typing.Any
to_metadata 
def to_metadata() -> typing.Any
to_terraform 
def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

add_move_target 
def add_move_target(
  move_target: str
) -> None

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

move_targetRequired
  • Type: str

The string move target that will correspond to this resource.

get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
has_resource_move 
def has_resource_move() -> typing.Union[TerraformResourceMoveByTarget, TerraformResourceMoveById]
import_from 
def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None
idRequired
  • Type: str
providerOptional
  • Type: cdktf.TerraformProvider
interpolation_for_attribute 
def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
move_from_id 
def move_from_id(
  id: str
) -> None

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.

idRequired
  • Type: str

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

move_to 
def move_to(
  move_target: str,
  index: typing.Union[str, typing.Union[int, float]] = None
) -> None

Moves this resource to the target resource given by moveTarget.

move_targetRequired
  • Type: str

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

indexOptional
  • Type: typing.Union[str, typing.Union[int, float]]

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

move_to_id 
def move_to_id(
  id: str
) -> None

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

idRequired
  • Type: str

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

put_timeouts 
def put_timeouts(
  create: str = None,
  delete: str = None,
  update: str = None
) -> None
createOptional
  • Type: str

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

deleteOptional
  • Type: str

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

updateOptional
  • Type: str

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

reset_access_restriction 
def reset_access_restriction() -> None
reset_allow_missing 
def reset_allow_missing() -> None
reset_annotations 
def reset_annotations() -> None
reset_description 
def reset_description() -> None
reset_effective_time 
def reset_effective_time() -> None
reset_force_delete 
def reset_force_delete() -> None
reset_force_update 
def reset_force_update() -> None
reset_id 
def reset_id() -> None
reset_ignore_backup_plan_references 
def reset_ignore_backup_plan_references() -> None
reset_ignore_inactive_datasources 
def reset_ignore_inactive_datasources() -> None
reset_labels 
def reset_labels() -> None
reset_project 
def reset_project() -> None
reset_timeouts 
def reset_timeouts() -> None

Static Functions

Name Description
is_construct Checks if x is a construct.
is_terraform_element No description.
is_terraform_resource No description.
generate_config_for_import Generates CDKTF code for importing a BackupDrBackupVault resource upon running "cdktf plan ".
is_construct 
from cdktf_cdktf_provider_google import backup_dr_backup_vault

backupDrBackupVault.BackupDrBackupVault.is_construct(
  x: typing.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.

xRequired
  • Type: typing.Any

Any object.

is_terraform_element 
from cdktf_cdktf_provider_google import backup_dr_backup_vault

backupDrBackupVault.BackupDrBackupVault.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any
is_terraform_resource 
from cdktf_cdktf_provider_google import backup_dr_backup_vault

backupDrBackupVault.BackupDrBackupVault.is_terraform_resource(
  x: typing.Any
)
xRequired
  • Type: typing.Any
generate_config_for_import 
from cdktf_cdktf_provider_google import backup_dr_backup_vault

backupDrBackupVault.BackupDrBackupVault.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

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

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

import_to_idRequired
  • Type: str

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

import_from_idRequired
  • Type: str

The id of the existing BackupDrBackupVault that should be imported.

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

providerOptional
  • 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.
cdktf_stack cdktf.TerraformStack No description.
fqn str No description.
friendly_unique_id str No description.
terraform_meta_arguments typing.Mapping[typing.Any] No description.
terraform_resource_type str No description.
terraform_generator_metadata cdktf.TerraformProviderGeneratorMetadata No description.
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[str] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
backup_count str No description.
create_time str No description.
deletable cdktf.IResolvable No description.
effective_annotations cdktf.StringMap No description.
effective_labels cdktf.StringMap No description.
etag str No description.
name str No description.
service_account str No description.
state str No description.
terraform_labels cdktf.StringMap No description.
timeouts BackupDrBackupVaultTimeoutsOutputReference No description.
total_stored_bytes str No description.
uid str No description.
update_time str No description.
access_restriction_input str No description.
allow_missing_input typing.Union[bool, cdktf.IResolvable] No description.
annotations_input typing.Mapping[str] No description.
backup_minimum_enforced_retention_duration_input str No description.
backup_vault_id_input str No description.
description_input str No description.
effective_time_input str No description.
force_delete_input typing.Union[bool, cdktf.IResolvable] No description.
force_update_input typing.Union[bool, cdktf.IResolvable] No description.
id_input str No description.
ignore_backup_plan_references_input typing.Union[bool, cdktf.IResolvable] No description.
ignore_inactive_datasources_input typing.Union[bool, cdktf.IResolvable] No description.
labels_input typing.Mapping[str] No description.
location_input str No description.
project_input str No description.
timeouts_input typing.Union[cdktf.IResolvable, BackupDrBackupVaultTimeouts] No description.
access_restriction str No description.
allow_missing typing.Union[bool, cdktf.IResolvable] No description.
annotations typing.Mapping[str] No description.
backup_minimum_enforced_retention_duration str No description.
backup_vault_id str No description.
description str No description.
effective_time str No description.
force_delete typing.Union[bool, cdktf.IResolvable] No description.
force_update typing.Union[bool, cdktf.IResolvable] No description.
id str No description.
ignore_backup_plan_references typing.Union[bool, cdktf.IResolvable] No description.
ignore_inactive_datasources typing.Union[bool, cdktf.IResolvable] No description.
labels typing.Mapping[str] No description.
location str No description.
project str No description.
nodeRequired 
node: Node
  • Type: constructs.Node

The tree node.

cdktf_stackRequired 
cdktf_stack: TerraformStack
  • Type: cdktf.TerraformStack
fqnRequired 
fqn: str
  • Type: str
friendly_unique_idRequired 
friendly_unique_id: str
  • Type: str
terraform_meta_argumentsRequired 
terraform_meta_arguments: typing.Mapping[typing.Any]
  • Type: typing.Mapping[typing.Any]
terraform_resource_typeRequired 
terraform_resource_type: str
  • Type: str
terraform_generator_metadataOptional 
terraform_generator_metadata: TerraformProviderGeneratorMetadata
  • Type: cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional 
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional 
depends_on: typing.List[str]
  • Type: typing.List[str]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
provisionersOptional 
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
backup_countRequired 
backup_count: str
  • Type: str
create_timeRequired 
create_time: str
  • Type: str
deletableRequired 
deletable: IResolvable
  • Type: cdktf.IResolvable
effective_annotationsRequired 
effective_annotations: StringMap
  • Type: cdktf.StringMap
effective_labelsRequired 
effective_labels: StringMap
  • Type: cdktf.StringMap
etagRequired 
etag: str
  • Type: str
nameRequired 
name: str
  • Type: str
service_accountRequired 
service_account: str
  • Type: str
stateRequired 
state: str
  • Type: str
terraform_labelsRequired 
terraform_labels: StringMap
  • Type: cdktf.StringMap
timeoutsRequired 
timeouts: BackupDrBackupVaultTimeoutsOutputReference
total_stored_bytesRequired 
total_stored_bytes: str
  • Type: str
uidRequired 
uid: str
  • Type: str
update_timeRequired 
update_time: str
  • Type: str
access_restriction_inputOptional 
access_restriction_input: str
  • Type: str
allow_missing_inputOptional 
allow_missing_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
annotations_inputOptional 
annotations_input: typing.Mapping[str]
  • Type: typing.Mapping[str]
backup_minimum_enforced_retention_duration_inputOptional 
backup_minimum_enforced_retention_duration_input: str
  • Type: str
backup_vault_id_inputOptional 
backup_vault_id_input: str
  • Type: str
description_inputOptional 
description_input: str
  • Type: str
effective_time_inputOptional 
effective_time_input: str
  • Type: str
force_delete_inputOptional 
force_delete_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
force_update_inputOptional 
force_update_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
id_inputOptional 
id_input: str
  • Type: str
ignore_backup_plan_references_inputOptional 
ignore_backup_plan_references_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
ignore_inactive_datasources_inputOptional 
ignore_inactive_datasources_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
labels_inputOptional 
labels_input: typing.Mapping[str]
  • Type: typing.Mapping[str]
location_inputOptional 
location_input: str
  • Type: str
project_inputOptional 
project_input: str
  • Type: str
timeouts_inputOptional 
timeouts_input: typing.Union[IResolvable, BackupDrBackupVaultTimeouts]
access_restrictionRequired 
access_restriction: str
  • Type: str
allow_missingRequired 
allow_missing: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
annotationsRequired 
annotations: typing.Mapping[str]
  • Type: typing.Mapping[str]
backup_minimum_enforced_retention_durationRequired 
backup_minimum_enforced_retention_duration: str
  • Type: str
backup_vault_idRequired 
backup_vault_id: str
  • Type: str
descriptionRequired 
description: str
  • Type: str
effective_timeRequired 
effective_time: str
  • Type: str
force_deleteRequired 
force_delete: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
force_updateRequired 
force_update: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
idRequired 
id: str
  • Type: str
ignore_backup_plan_referencesRequired 
ignore_backup_plan_references: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
ignore_inactive_datasourcesRequired 
ignore_inactive_datasources: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
labelsRequired 
labels: typing.Mapping[str]
  • Type: typing.Mapping[str]
locationRequired 
location: str
  • Type: str
projectRequired 
project: str
  • Type: str

Constants

Name Type Description
tfResourceType str No description.
tfResourceTypeRequired 
tfResourceType: str
  • Type: str

Structs

BackupDrBackupVaultConfig

Initializer 

from cdktf_cdktf_provider_google import backup_dr_backup_vault

backupDrBackupVault.BackupDrBackupVaultConfig(
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  backup_minimum_enforced_retention_duration: str,
  backup_vault_id: str,
  location: str,
  access_restriction: str = None,
  allow_missing: typing.Union[bool, IResolvable] = None,
  annotations: typing.Mapping[str] = None,
  description: str = None,
  effective_time: str = None,
  force_delete: typing.Union[bool, IResolvable] = None,
  force_update: typing.Union[bool, IResolvable] = None,
  id: str = None,
  ignore_backup_plan_references: typing.Union[bool, IResolvable] = None,
  ignore_inactive_datasources: typing.Union[bool, IResolvable] = None,
  labels: typing.Mapping[str] = None,
  project: str = None,
  timeouts: BackupDrBackupVaultTimeouts = None
)

Properties

Name Type Description
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
backup_minimum_enforced_retention_duration str Required.
backup_vault_id str Required. ID of the requesting object.
location str The GCP location for the backup vault.
access_restriction str Access restriction for the backup vault.
allow_missing typing.Union[bool, cdktf.IResolvable] Allow idempotent deletion of backup vault. The request will still succeed in case the backup vault does not exist.
annotations typing.Mapping[str] Optional. User annotations. See https://google.aip.dev/128#annotations Stores small amounts of arbitrary data.
description str Optional. The description of the BackupVault instance (2048 characters or less).
effective_time str Optional. Time after which the BackupVault resource is locked.
force_delete typing.Union[bool, 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.
force_update typing.Union[bool, cdktf.IResolvable] If set, allow update to extend the minimum enforced retention for backup vault.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/backup_dr_backup_vault#id BackupDrBackupVault#id}.
ignore_backup_plan_references typing.Union[bool, 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.
ignore_inactive_datasources typing.Union[bool, 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 typing.Mapping[str] Optional. Resource labels to represent user provided metadata.
project str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/backup_dr_backup_vault#project BackupDrBackupVault#project}.
timeouts BackupDrBackupVaultTimeouts timeouts block.
connectionOptional 
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional 
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional 
depends_on: typing.List[ITerraformDependable]
  • Type: typing.List[cdktf.ITerraformDependable]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
provisionersOptional 
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
backup_minimum_enforced_retention_durationRequired 
backup_minimum_enforced_retention_duration: str
  • Type: str

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

backup_vault_idRequired 
backup_vault_id: str
  • Type: str

Required. ID of the requesting object.

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

locationRequired 
location: str
  • Type: str

The GCP location for the backup vault.

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

access_restrictionOptional 
access_restriction: str
  • Type: str

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

allow_missingOptional 
allow_missing: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, 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.14.1/docs/resources/backup_dr_backup_vault#allow_missing BackupDrBackupVault#allow_missing}

annotationsOptional 
annotations: typing.Mapping[str]
  • Type: typing.Mapping[str]

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

descriptionOptional 
description: str
  • Type: str

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

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

effective_timeOptional 
effective_time: str
  • Type: str

Optional. Time after which the BackupVault resource is locked.

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

force_deleteOptional 
force_delete: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, 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.14.1/docs/resources/backup_dr_backup_vault#force_delete BackupDrBackupVault#force_delete}

force_updateOptional 
force_update: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, 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.14.1/docs/resources/backup_dr_backup_vault#force_update BackupDrBackupVault#force_update}

idOptional 
id: str
  • Type: str

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

ignore_backup_plan_referencesOptional 
ignore_backup_plan_references: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, 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.14.1/docs/resources/backup_dr_backup_vault#ignore_backup_plan_references BackupDrBackupVault#ignore_backup_plan_references}

ignore_inactive_datasourcesOptional 
ignore_inactive_datasources: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, 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.14.1/docs/resources/backup_dr_backup_vault#ignore_inactive_datasources BackupDrBackupVault#ignore_inactive_datasources}

labelsOptional 
labels: typing.Mapping[str]
  • Type: typing.Mapping[str]

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

projectOptional 
project: str
  • Type: str

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

timeoutsOptional 
timeouts: BackupDrBackupVaultTimeouts

timeouts block.

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

BackupDrBackupVaultTimeouts

Initializer 

from cdktf_cdktf_provider_google import backup_dr_backup_vault

backupDrBackupVault.BackupDrBackupVaultTimeouts(
  create: str = None,
  delete: str = None,
  update: str = None
)

Properties

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

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

deleteOptional 
delete: str
  • Type: str

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

updateOptional 
update: str
  • Type: str

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

Classes

BackupDrBackupVaultTimeoutsOutputReference

Initializers 

from cdktf_cdktf_provider_google import backup_dr_backup_vault

backupDrBackupVault.BackupDrBackupVaultTimeoutsOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

Methods

Name Description
compute_fqn No description.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
reset_create No description.
reset_delete No description.
reset_update No description.
compute_fqn 
def compute_fqn() -> str
get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
interpolation_for_attribute 
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

reset_create 
def reset_create() -> None
reset_delete 
def reset_delete() -> None
reset_update 
def reset_update() -> None

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
create_input str No description.
delete_input str No description.
update_input str No description.
create str No description.
delete str No description.
update str No description.
internal_value typing.Union[cdktf.IResolvable, BackupDrBackupVaultTimeouts] No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

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.

fqnRequired 
fqn: str
  • Type: str
create_inputOptional 
create_input: str
  • Type: str
delete_inputOptional 
delete_input: str
  • Type: str
update_inputOptional 
update_input: str
  • Type: str
createRequired 
create: str
  • Type: str
deleteRequired 
delete: str
  • Type: str
updateRequired 
update: str
  • Type: str
internal_valueOptional 
internal_value: typing.Union[IResolvable, BackupDrBackupVaultTimeouts]