CfnBackupPlanProps

class aws_cdk.aws_backup.CfnBackupPlanProps(*, backup_plan, backup_plan_tags=None)

Bases: object

Properties for defining a CfnBackupPlan.

Parameters
  • backup_plan (Union[BackupPlanResourceTypeProperty, Dict[str, Any], IResolvable]) – Uniquely identifies the backup plan to be associated with the selection of resources.

  • backup_plan_tags (Union[IResolvable, Mapping[str, str], None]) – To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair. The specified tags are assigned to all backups created with this plan.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupplan.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

# backup_options: Any

cfn_backup_plan_props = backup.CfnBackupPlanProps(
    backup_plan=backup.CfnBackupPlan.BackupPlanResourceTypeProperty(
        backup_plan_name="backupPlanName",
        backup_plan_rule=[backup.CfnBackupPlan.BackupRuleResourceTypeProperty(
            rule_name="ruleName",
            target_backup_vault="targetBackupVault",

            # the properties below are optional
            completion_window_minutes=123,
            copy_actions=[backup.CfnBackupPlan.CopyActionResourceTypeProperty(
                destination_backup_vault_arn="destinationBackupVaultArn",

                # the properties below are optional
                lifecycle=backup.CfnBackupPlan.LifecycleResourceTypeProperty(
                    delete_after_days=123,
                    move_to_cold_storage_after_days=123
                )
            )],
            enable_continuous_backup=False,
            lifecycle=backup.CfnBackupPlan.LifecycleResourceTypeProperty(
                delete_after_days=123,
                move_to_cold_storage_after_days=123
            ),
            recovery_point_tags={
                "recovery_point_tags_key": "recoveryPointTags"
            },
            schedule_expression="scheduleExpression",
            start_window_minutes=123
        )],

        # the properties below are optional
        advanced_backup_settings=[backup.CfnBackupPlan.AdvancedBackupSettingResourceTypeProperty(
            backup_options=backup_options,
            resource_type="resourceType"
        )]
    ),

    # the properties below are optional
    backup_plan_tags={
        "backup_plan_tags_key": "backupPlanTags"
    }
)

Attributes

backup_plan

Uniquely identifies the backup plan to be associated with the selection of resources.

Link

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

Return type

Union[BackupPlanResourceTypeProperty, IResolvable]

backup_plan_tags

To help organize your resources, you can assign your own metadata to the resources that you create.

Each tag is a key-value pair. The specified tags are assigned to all backups created with this plan.

Link

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

Return type

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