BackupVault

class aws_cdk.aws_backup.BackupVault(scope, id, *, access_policy=None, backup_vault_name=None, encryption_key=None, notification_events=None, notification_topic=None, removal_policy=None)

Bases: aws_cdk.core.Resource

(experimental) A backup vault.

Stability

experimental

Parameters
  • scope (Construct) –

  • id (str) –

  • access_policy (Optional[PolicyDocument]) – (experimental) A resource-based policy that is used to manage access permissions on the backup vault. Default: - access is not restricted

  • backup_vault_name (Optional[str]) – (experimental) The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. Default: - A CDK generated name

  • encryption_key (Optional[IKey]) – (experimental) The server-side encryption key to use to protect your backups. Default: - an Amazon managed KMS key

  • notification_events (Optional[List[BackupVaultEvents]]) – (experimental) The vault events to send. Default: - all vault events if notificationTopic is defined

  • notification_topic (Optional[ITopic]) – (experimental) A SNS topic to send vault events to. Default: - no notifications

  • removal_policy (Optional[RemovalPolicy]) – (experimental) The removal policy to apply to the vault. Note that removing a vault that contains recovery points will fail. Default: RemovalPolicy.RETAIN

Stability

experimental

Methods

to_string()

Returns a string representation of this construct.

Return type

str

Attributes

backup_vault_arn

(experimental) The ARN of the backup vault.

Stability

experimental

Attribute

true

Return type

str

backup_vault_name

(experimental) The name of a logical container where backups are stored.

Stability

experimental

Return type

str

env

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

Return type

ResourceEnvironment

node

The construct tree node associated with this construct.

Return type

ConstructNode

stack

The stack in which this resource is defined.

Return type

Stack

Static Methods

classmethod from_backup_vault_name(scope, id, backup_vault_name)

(experimental) Import an existing backup vault.

Parameters
  • scope (Construct) –

  • id (str) –

  • backup_vault_name (str) –

Stability

experimental

Return type

IBackupVault

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool