The CDK Construct Library for AWS::Backup
Project description
AWS Backup Construct Library
---AWS Backup is a fully managed backup service that makes it easy to centralize and automate the backup of data across AWS services in the cloud and on premises. Using AWS Backup, you can configure backup policies and monitor backup activity for your AWS resources in one place.
Backup plan and selection
In AWS Backup, a backup plan is a policy expression that defines when and how you want to back up your AWS resources, such as Amazon DynamoDB tables or Amazon Elastic File System (Amazon EFS) file systems. You can assign resources to backup plans, and AWS Backup automatically backs up and retains backups for those resources according to the backup plan. You can create multiple backup plans if you have workloads with different backup requirements.
This module provides ready-made backup plans (similar to the console experience):
# Example automatically generated. See https://github.com/aws/jsii/issues/826
# Daily, weekly and monthly with 5 year retention
plan = backup.BackupPlan.daily_weekly_monthly5_year_retention(self, "Plan")
Assigning resources to a plan can be done with addSelection()
:
# Example automatically generated. See https://github.com/aws/jsii/issues/826
my_table = dynamodb.Table.from_table_name(self, "Table", "myTableName")
my_cool_construct = Construct(self, "MyCoolConstruct")
plan.add_selection("Selection",
resources=[
backup.BackupResource.from_dynamo_db_table(my_table), # A DynamoDB table
backup.BackupResource.from_tag("stage", "prod"), # All resources that are tagged stage=prod in the region/account
backup.BackupResource.from_construct(my_cool_construct)
]
)
If not specified, a new IAM role with a managed policy for backup will be
created for the selection. The BackupSelection
implements IGrantable
.
To add rules to a plan, use addRule()
:
# Example automatically generated. See https://github.com/aws/jsii/issues/826
plan.add_rule(backup.BackupPlanRule(
completion_window=Duration.hours(2),
start_window=Duration.hours(1),
schedule_expression=events.Schedule.cron(# Only cron expressions are supported
day="15",
hour="3",
minute="30"),
move_to_cold_storage_after=Duration.days(30)
))
Ready-made rules are also available:
# Example automatically generated. See https://github.com/aws/jsii/issues/826
plan.add_rule(backup.BackupPlanRule.daily())
plan.add_rule(backup.BackupPlanRule.weekly())
By default a new vault is created when creating a plan. It is also possible to specify a vault either at the plan level or at the rule level.
# Example automatically generated. See https://github.com/aws/jsii/issues/826
my_vault = backup.BackupVault.from_backup_vault_name(self, "Vault1", "myVault")
other_vault = backup.BackupVault.from_backup_vault_name(self, "Vault2", "otherVault")
plan = backup.BackupPlan.daily35_day_retention(self, "Plan", my_vault)# Use `myVault` for all plan rules
plan.add_rule(backup.BackupPlanRule.monthly1_year(other_vault))
Backup vault
In AWS Backup, a backup vault is a container that you organize your backups in. You can use backup vaults to set the AWS Key Management Service (AWS KMS) encryption key that is used to encrypt backups in the backup vault and to control access to the backups in the backup vault. If you require different encryption keys or access policies for different groups of backups, you can optionally create multiple backup vaults.
# Example automatically generated. See https://github.com/aws/jsii/issues/826
my_key = kms.Key.from_key_arn(self, "MyKey", "aaa")
my_topic = sns.Topic.from_topic_arn(self, "MyTopic", "bbb")
vault = backup.BackupVault(self, "Vault",
encryption_key=my_key, # Custom encryption key
notification_topic=my_topic
)
A vault has a default RemovalPolicy
set to RETAIN
. Note that removing a vault
that contains recovery points will fail.
Importing existing backup vault
To import an existing backup vault into your CDK application, use the BackupVault.fromBackupVaultArn
or BackupVault.fromBackupVaultName
static method. Here is an example of giving an IAM Role permission to start a backup job:
# Example automatically generated. See https://github.com/aws/jsii/issues/826
imported_vault = backup.BackupVault.from_backup_vault_name(self, "Vault", "myVaultName")
role = iam.Role(self, "Access Role", assumed_by=iam.ServicePrincipal("lambda.amazonaws.com"))
imported_vault.grant(role, "backup:StartBackupJob")
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for aws-cdk.aws-backup-1.116.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1b79cbcec6174991ba8f65b6fe551121f4cf9c0dc49403a8a505a65a78b06598 |
|
MD5 | 7bbdeba462b672d3275fd58b19e3cd0b |
|
BLAKE2b-256 | 86db53976737607970851d00438737f2e7f33da726a17b48f895fdc2322a61d1 |
Hashes for aws_cdk.aws_backup-1.116.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 605fe27fac08df231c19d881625918c6dd32201bba5653380bc461120f934f0d |
|
MD5 | 6872f526ac06c0e3ab823040c074a49e |
|
BLAKE2b-256 | b145ef4e4ffcf42fd8116f5089c9c0285fe28a0ecbae8e4984d6017cae426250 |