CfnBackupVaultProps

class aws_cdk.aws_backup.CfnBackupVaultProps(*, backup_vault_name, access_policy=None, backup_vault_tags=None, encryption_key_arn=None, lock_configuration=None, notifications=None)

Bases: object

Properties for defining a CfnBackupVault.

Parameters
  • backup_vault_name (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. They consist of lowercase letters, numbers, and hyphens.

  • access_policy (Optional[Any]) – A resource-based policy that is used to manage access permissions on the target backup vault.

  • backup_vault_tags (Union[IResolvable, Mapping[str, str], None]) – Metadata that you can assign to help organize the resources that you create. Each tag is a key-value pair.

  • encryption_key_arn (Optional[str]) – A server-side encryption key you can specify to encrypt your backups from services that support full AWS Backup management; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab . If you specify a key, you must specify its ARN, not its alias. If you do not specify a key, AWS Backup creates a KMS key for you by default. To learn which AWS Backup services support full AWS Backup management and how AWS Backup handles encryption for backups from services that do not yet support full AWS Backup , see Encryption for backups in AWS Backup

  • lock_configuration (Union[IResolvable, LockConfigurationTypeProperty, Dict[str, Any], None]) – Configuration for AWS Backup Vault Lock .

  • notifications (Union[IResolvable, NotificationObjectTypeProperty, Dict[str, Any], None]) – The SNS event notifications for the specified backup vault.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupvault.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_backup as backup

# access_policy: Any

cfn_backup_vault_props = backup.CfnBackupVaultProps(
    backup_vault_name="backupVaultName",

    # the properties below are optional
    access_policy=access_policy,
    backup_vault_tags={
        "backup_vault_tags_key": "backupVaultTags"
    },
    encryption_key_arn="encryptionKeyArn",
    lock_configuration=backup.CfnBackupVault.LockConfigurationTypeProperty(
        min_retention_days=123,

        # the properties below are optional
        changeable_for_days=123,
        max_retention_days=123
    ),
    notifications=backup.CfnBackupVault.NotificationObjectTypeProperty(
        backup_vault_events=["backupVaultEvents"],
        sns_topic_arn="snsTopicArn"
    )
)

Attributes

access_policy

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupvault.html#cfn-backup-backupvault-accesspolicy

Return type

Any

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. They consist of lowercase letters, numbers, and hyphens.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupvault.html#cfn-backup-backupvault-backupvaultname

Return type

str

backup_vault_tags

Metadata that you can assign to help organize the resources that you create.

Each tag is a key-value pair.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupvault.html#cfn-backup-backupvault-backupvaulttags

Return type

Union[IResolvable, Mapping[str, str], None]

encryption_key_arn

A server-side encryption key you can specify to encrypt your backups from services that support full AWS Backup management;

for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab . If you specify a key, you must specify its ARN, not its alias. If you do not specify a key, AWS Backup creates a KMS key for you by default.

To learn which AWS Backup services support full AWS Backup management and how AWS Backup handles encryption for backups from services that do not yet support full AWS Backup , see Encryption for backups in AWS Backup

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupvault.html#cfn-backup-backupvault-encryptionkeyarn

Return type

Optional[str]

lock_configuration

//docs.aws.amazon.com/aws-backup/latest/devguide/vault-lock.html>`_ .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupvault.html#cfn-backup-backupvault-lockconfiguration

Type

Configuration for `AWS Backup Vault Lock <https

Return type

Union[IResolvable, LockConfigurationTypeProperty, None]

notifications

The SNS event notifications for the specified backup vault.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupvault.html#cfn-backup-backupvault-notifications

Return type

Union[IResolvable, NotificationObjectTypeProperty, None]