BackupVaultProps

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

Bases: object

(experimental) Properties for a BackupVault.

Parameters
  • 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

Attributes

access_policy

(experimental) A resource-based policy that is used to manage access permissions on the backup vault.

Default
  • access is not restricted

Stability

experimental

Return type

Optional[PolicyDocument]

backup_vault_name

(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

Stability

experimental

Return type

Optional[str]

encryption_key

(experimental) The server-side encryption key to use to protect your backups.

Default
  • an Amazon managed KMS key

Stability

experimental

Return type

Optional[IKey]

notification_events

(experimental) The vault events to send.

Default
  • all vault events if notificationTopic is defined

See

https://docs.aws.amazon.com/aws-backup/latest/devguide/sns-notifications.html

Stability

experimental

Return type

Optional[List[BackupVaultEvents]]

notification_topic

(experimental) A SNS topic to send vault events to.

Default
  • no notifications

See

https://docs.aws.amazon.com/aws-backup/latest/devguide/sns-notifications.html

Stability

experimental

Return type

Optional[ITopic]

removal_policy

(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

Return type

Optional[RemovalPolicy]