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

__init__(*, access_policy=None, backup_vault_name=None, encryption_key=None, notification_events=None, notification_topic=None, removal_policy=None)

Properties for a BackupVault.

Parameters
  • access_policy (Optional[PolicyDocument]) – 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]) – 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]) – The server-side encryption key to use to protect your backups. Default: - an Amazon managed KMS key

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

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

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

stability :stability: experimental

Return type

None

Attributes

access_policy

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

default :default: - access is not restricted

stability :stability: experimental

Return type

Optional[PolicyDocument]

backup_vault_name

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 :default: - A CDK generated name

stability :stability: experimental

Return type

Optional[str]

encryption_key

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

default :default: - an Amazon managed KMS key

stability :stability: experimental

Return type

Optional[IKey]

notification_events

The vault events to send.

default :default: - all vault events if notificationTopic is defined

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

Return type

Optional[List[BackupVaultEvents]]

notification_topic

A SNS topic to send vault events to.

default :default: - no notifications

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

Return type

Optional[ITopic]

removal_policy

The removal policy to apply to the vault.

Note that removing a vault that contains recovery points will fail.

default :default: RemovalPolicy.RETAIN

stability :stability: experimental

Return type

Optional[RemovalPolicy]