feat(backup): add recovery point tags param to backup plan rule (#25863)

go-to-k · web-flow · commit 445543cb8e23 · 2023-06-08T16:07:35.000Z
This PR adds a `RecoveryPointTags` property to `BackupPlanRule`. Closes #25671 ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
diff --git a/packages/@aws-cdk-testing/framework-integ/test/aws-backup/test/integ.backup.js.snapshot/cdk-backup.assets.json b/packages/@aws-cdk-testing/framework-integ/test/aws-backup/test/integ.backup.js.snapshot/cdk-backup.assets.json
@@ -1,15 +1,15 @@
 {
-  "version": "21.0.0",
+  "version": "32.0.0",
   "files": {
-    "14e034eeffbdd95a18b6c1a8c7a4876e1dfbedde51220bb1a196a337a6848c16": {
+    "cf2d89a4eac2c90005b9a1e142f1cac80cf9cd29d1b8f98f002b9f3a1849454c": {
       "source": {
         "path": "cdk-backup.template.json",
         "packaging": "file"
       },
       "destinations": {
         "current_account-current_region": {
           "bucketName": "cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}",
-          "objectKey": "14e034eeffbdd95a18b6c1a8c7a4876e1dfbedde51220bb1a196a337a6848c16.json",
+          "objectKey": "cf2d89a4eac2c90005b9a1e142f1cac80cf9cd29d1b8f98f002b9f3a1849454c.json",
           "assumeRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-file-publishing-role-${AWS::AccountId}-${AWS::Region}"
         }
       }
diff --git a/packages/@aws-cdk-testing/framework-integ/test/aws-backup/test/integ.backup.js.snapshot/cdk-backup.template.json b/packages/@aws-cdk-testing/framework-integ/test/aws-backup/test/integ.backup.js.snapshot/cdk-backup.template.json
@@ -111,6 +111,9 @@
          }
         }
        ],
+       "RecoveryPointTags": {
+        "stage": "prod"
+       },
        "RuleName": "PlanRule3",
        "TargetBackupVault": {
         "Fn::GetAtt": [
diff --git a/packages/@aws-cdk-testing/framework-integ/test/aws-backup/test/integ.backup.js.snapshot/cdk.out b/packages/@aws-cdk-testing/framework-integ/test/aws-backup/test/integ.backup.js.snapshot/cdk.out
@@ -1 +1 @@
-{"version":"21.0.0"}
+{"version":"32.0.0"}
diff --git a/packages/@aws-cdk-testing/framework-integ/test/aws-backup/test/integ.backup.js.snapshot/integ.json b/packages/@aws-cdk-testing/framework-integ/test/aws-backup/test/integ.backup.js.snapshot/integ.json
@@ -1,5 +1,5 @@
 {
-  "version": "21.0.0",
+  "version": "32.0.0",
   "testCases": {
     "integ.backup": {
       "stacks": [
diff --git a/packages/@aws-cdk-testing/framework-integ/test/aws-backup/test/integ.backup.js.snapshot/manifest.json b/packages/@aws-cdk-testing/framework-integ/test/aws-backup/test/integ.backup.js.snapshot/manifest.json
@@ -1,12 +1,6 @@
 {
-  "version": "21.0.0",
+  "version": "32.0.0",
   "artifacts": {
-    "Tree": {
-      "type": "cdk:tree",
-      "properties": {
-        "file": "tree.json"
-      }
-    },
     "cdk-backup.assets": {
       "type": "cdk:asset-manifest",
       "properties": {
@@ -23,7 +17,7 @@
         "validateOnSynth": false,
         "assumeRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-deploy-role-${AWS::AccountId}-${AWS::Region}",
         "cloudFormationExecutionRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-cfn-exec-role-${AWS::AccountId}-${AWS::Region}",
-        "stackTemplateAssetObjectUrl": "s3://cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}/14e034eeffbdd95a18b6c1a8c7a4876e1dfbedde51220bb1a196a337a6848c16.json",
+        "stackTemplateAssetObjectUrl": "s3://cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}/cf2d89a4eac2c90005b9a1e142f1cac80cf9cd29d1b8f98f002b9f3a1849454c.json",
         "requiresBootstrapStackVersion": 6,
         "bootstrapStackVersionSsmParameter": "/cdk-bootstrap/hnb659fds/version",
         "additionalDependencies": [
@@ -95,6 +89,12 @@
         ]
       },
       "displayName": "cdk-backup"
+    },
+    "Tree": {
+      "type": "cdk:tree",
+      "properties": {
+        "file": "tree.json"
+      }
     }
   }
 }
diff --git a/packages/@aws-cdk-testing/framework-integ/test/aws-backup/test/integ.backup.js.snapshot/tree.json b/packages/@aws-cdk-testing/framework-integ/test/aws-backup/test/integ.backup.js.snapshot/tree.json
@@ -4,14 +4,6 @@
     "id": "App",
     "path": "",
     "children": {
-      "Tree": {
-        "id": "Tree",
-        "path": "Tree",
-        "constructInfo": {
-          "fqn": "constructs.Construct",
-          "version": "10.1.102"
-        }
-      },
       "cdk-backup": {
         "id": "cdk-backup",
         "path": "cdk-backup",
@@ -45,21 +37,21 @@
                   }
                 },
                 "constructInfo": {
-                  "fqn": "@aws-cdk/aws-dynamodb.CfnTable",
+                  "fqn": "aws-cdk-lib.aws_dynamodb.CfnTable",
                   "version": "0.0.0"
                 }
               },
               "ScalingRole": {
                 "id": "ScalingRole",
                 "path": "cdk-backup/Table/ScalingRole",
                 "constructInfo": {
-                  "fqn": "@aws-cdk/core.Resource",
+                  "fqn": "aws-cdk-lib.Resource",
                   "version": "0.0.0"
                 }
               }
             },
             "constructInfo": {
-              "fqn": "@aws-cdk/aws-dynamodb.Table",
+              "fqn": "aws-cdk-lib.aws_dynamodb.Table",
               "version": "0.0.0"
             }
           },
@@ -71,7 +63,7 @@
               "aws:cdk:cloudformation:props": {}
             },
             "constructInfo": {
-              "fqn": "@aws-cdk/aws-efs.CfnFileSystem",
+              "fqn": "aws-cdk-lib.aws_efs.CfnFileSystem",
               "version": "0.0.0"
             }
           },
@@ -92,13 +84,13 @@
                   }
                 },
                 "constructInfo": {
-                  "fqn": "@aws-cdk/aws-backup.CfnBackupVault",
+                  "fqn": "aws-cdk-lib.aws_backup.CfnBackupVault",
                   "version": "0.0.0"
                 }
               }
             },
             "constructInfo": {
-              "fqn": "@aws-cdk/aws-backup.BackupVault",
+              "fqn": "aws-cdk-lib.aws_backup.BackupVault",
               "version": "0.0.0"
             }
           },
@@ -119,13 +111,13 @@
                   }
                 },
                 "constructInfo": {
-                  "fqn": "@aws-cdk/aws-backup.CfnBackupVault",
+                  "fqn": "aws-cdk-lib.aws_backup.CfnBackupVault",
                   "version": "0.0.0"
                 }
               }
             },
             "constructInfo": {
-              "fqn": "@aws-cdk/aws-backup.BackupVault",
+              "fqn": "aws-cdk-lib.aws_backup.BackupVault",
               "version": "0.0.0"
             }
           },
@@ -203,14 +195,17 @@
                                 "moveToColdStorageAfterDays": 30
                               }
                             }
-                          ]
+                          ],
+                          "recoveryPointTags": {
+                            "stage": "prod"
+                          }
                         }
                       ]
                     }
                   }
                 },
                 "constructInfo": {
-                  "fqn": "@aws-cdk/aws-backup.CfnBackupPlan",
+                  "fqn": "aws-cdk-lib.aws_backup.CfnBackupPlan",
                   "version": "0.0.0"
                 }
               },
@@ -222,6 +217,14 @@
                     "id": "Role",
                     "path": "cdk-backup/Plan/Selection/Role",
                     "children": {
+                      "ImportRole": {
+                        "id": "ImportRole",
+                        "path": "cdk-backup/Plan/Selection/Role/ImportRole",
+                        "constructInfo": {
+                          "fqn": "aws-cdk-lib.Resource",
+                          "version": "0.0.0"
+                        }
+                      },
                       "Resource": {
                         "id": "Resource",
                         "path": "cdk-backup/Plan/Selection/Role/Resource",
@@ -257,13 +260,13 @@
                           }
                         },
                         "constructInfo": {
-                          "fqn": "@aws-cdk/aws-iam.CfnRole",
+                          "fqn": "aws-cdk-lib.aws_iam.CfnRole",
                           "version": "0.0.0"
                         }
                       }
                     },
                     "constructInfo": {
-                      "fqn": "@aws-cdk/aws-iam.Role",
+                      "fqn": "aws-cdk-lib.aws_iam.Role",
                       "version": "0.0.0"
                     }
                   },
@@ -346,31 +349,55 @@
                       }
                     },
                     "constructInfo": {
-                      "fqn": "@aws-cdk/aws-backup.CfnBackupSelection",
+                      "fqn": "aws-cdk-lib.aws_backup.CfnBackupSelection",
                       "version": "0.0.0"
                     }
                   }
                 },
                 "constructInfo": {
-                  "fqn": "@aws-cdk/aws-backup.BackupSelection",
+                  "fqn": "aws-cdk-lib.aws_backup.BackupSelection",
                   "version": "0.0.0"
                 }
               }
             },
             "constructInfo": {
-              "fqn": "@aws-cdk/aws-backup.BackupPlan",
+              "fqn": "aws-cdk-lib.aws_backup.BackupPlan",
+              "version": "0.0.0"
+            }
+          },
+          "BootstrapVersion": {
+            "id": "BootstrapVersion",
+            "path": "cdk-backup/BootstrapVersion",
+            "constructInfo": {
+              "fqn": "aws-cdk-lib.CfnParameter",
+              "version": "0.0.0"
+            }
+          },
+          "CheckBootstrapVersion": {
+            "id": "CheckBootstrapVersion",
+            "path": "cdk-backup/CheckBootstrapVersion",
+            "constructInfo": {
+              "fqn": "aws-cdk-lib.CfnRule",
               "version": "0.0.0"
             }
           }
         },
         "constructInfo": {
-          "fqn": "@aws-cdk/core.Stack",
+          "fqn": "aws-cdk-lib.Stack",
           "version": "0.0.0"
         }
+      },
+      "Tree": {
+        "id": "Tree",
+        "path": "Tree",
+        "constructInfo": {
+          "fqn": "constructs.Construct",
+          "version": "10.2.26"
+        }
       }
     },
     "constructInfo": {
-      "fqn": "@aws-cdk/core.App",
+      "fqn": "aws-cdk-lib.App",
       "version": "0.0.0"
     }
   }
diff --git a/packages/@aws-cdk-testing/framework-integ/test/aws-backup/test/integ.backup.ts b/packages/@aws-cdk-testing/framework-integ/test/aws-backup/test/integ.backup.ts
@@ -46,6 +46,9 @@ class TestStack extends Stack {
         moveToColdStorageAfter: Duration.days(30),
         deleteAfter: Duration.days(120),
       }],
+      recoveryPointTags: {
+        stage: 'prod',
+      },
     }));
   }
 }
diff --git a/packages/aws-cdk-lib/aws-backup/README.md b/packages/aws-cdk-lib/aws-backup/README.md
@@ -104,6 +104,17 @@ plan.addRule(new backup.BackupPlanRule({
 }));
 ```
 
+You can assign your own metadata to the resources that are associated with the rule when restored from backup using `recoveryPointTags`. Each tag is a key-value pair.
+
+```ts
+declare const plan: backup.BackupPlan;
+plan.addRule(new backup.BackupPlanRule({
+  recoveryPointTags: {
+    key: 'value',
+  },
+}));
+```
+
 Ready-made rules are also available:
 
 ```ts
diff --git a/packages/aws-cdk-lib/aws-backup/lib/plan.ts b/packages/aws-cdk-lib/aws-backup/lib/plan.ts
@@ -192,6 +192,7 @@ export class BackupPlan extends Resource implements IBackupPlan {
       enableContinuousBackup: rule.props.enableContinuousBackup,
       targetBackupVault: vault.backupVaultName,
       copyActions: rule.props.copyActions?.map(this.planCopyActions),
+      recoveryPointTags: rule.props.recoveryPointTags,
     });
   }
 
diff --git a/packages/aws-cdk-lib/aws-backup/lib/rule.ts b/packages/aws-cdk-lib/aws-backup/lib/rule.ts
@@ -77,6 +77,13 @@ export interface BackupPlanRuleProps {
    * @default - no copy actions
    */
   readonly copyActions?: BackupPlanCopyActionProps[];
+
+  /**
+   * To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.
+   *
+   * @default - no recovery point tags.
+   */
+  readonly recoveryPointTags?: { [key: string]: string };
 }
 
 /**
diff --git a/packages/aws-cdk-lib/aws-backup/test/plan.test.ts b/packages/aws-cdk-lib/aws-backup/test/plan.test.ts
@@ -336,6 +336,43 @@ test('create a plan and add rule to copy to a different vault', () => {
   });
 });
 
+test('create a plan and add rule with recoveryPointTags', () => {
+  // GIVEN
+  const tags = {
+    key: 'value',
+  };
+
+  // WHEN
+  new BackupPlan(stack, 'Plan', {
+    backupPlanRules: [
+      new BackupPlanRule({
+        recoveryPointTags: tags,
+      }),
+    ],
+  });
+
+  // THEN
+  Template.fromStack(stack).hasResourceProperties('AWS::Backup::BackupPlan', {
+    BackupPlan: {
+      BackupPlanName: 'Plan',
+      BackupPlanRule: [
+        {
+          RuleName: 'PlanRule0',
+          TargetBackupVault: {
+            'Fn::GetAtt': [
+              'PlanVault0284B0C2',
+              'BackupVaultName',
+            ],
+          },
+          RecoveryPointTags: {
+            key: 'value',
+          },
+        },
+      ],
+    },
+  });
+});
+
 test('throws when deleteAfter is not greater than moveToColdStorageAfter', () => {
   expect(() => new BackupPlanRule({
     deleteAfter: Duration.days(5),

Original file line number	Diff line number	Diff line change
`@@ -1,15 +1,15 @@`
`1`	`1`	`{`
`2`		`- "version": "21.0.0",`
	`2`	`+ "version": "32.0.0",`
`3`	`3`	`"files": {`
`4`		`- "14e034eeffbdd95a18b6c1a8c7a4876e1dfbedde51220bb1a196a337a6848c16": {`
	`4`	`+ "cf2d89a4eac2c90005b9a1e142f1cac80cf9cd29d1b8f98f002b9f3a1849454c": {`
`5`	`5`	`"source": {`
`6`	`6`	`"path": "cdk-backup.template.json",`
`7`	`7`	`"packaging": "file"`
`8`	`8`	`},`
`9`	`9`	`"destinations": {`
`10`	`10`	`"current_account-current_region": {`
`11`	`11`	`"bucketName": "cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}",`
`12`		`- "objectKey": "14e034eeffbdd95a18b6c1a8c7a4876e1dfbedde51220bb1a196a337a6848c16.json",`
	`12`	`+ "objectKey": "cf2d89a4eac2c90005b9a1e142f1cac80cf9cd29d1b8f98f002b9f3a1849454c.json",`
`13`	`13`	`"assumeRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-file-publishing-role-${AWS::AccountId}-${AWS::Region}"`
`14`	`14`	`}`
`15`	`15`	`}`
Original file line number	Diff line number	Diff line change
`@@ -111,6 +111,9 @@`
`111`	`111`	`}`
`112`	`112`	`}`
`113`	`113`	`],`
	`114`	`+ "RecoveryPointTags": {`
	`115`	`+ "stage": "prod"`
	`116`	`+ },`
`114`	`117`	`"RuleName": "PlanRule3",`
`115`	`118`	`"TargetBackupVault": {`
`116`	`119`	`"Fn::GetAtt": [`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-{"version":"21.0.0"}`
	`1`	`+{"version":"32.0.0"}`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "version": "21.0.0",`
	`2`	`+ "version": "32.0.0",`
`3`	`3`	`"testCases": {`
`4`	`4`	`"integ.backup": {`
`5`	`5`	`"stacks": [`
Original file line number	Diff line number	Diff line change
`@@ -46,6 +46,9 @@ class TestStack extends Stack {`
`46`	`46`	`moveToColdStorageAfter: Duration.days(30),`
`47`	`47`	`deleteAfter: Duration.days(120),`
`48`	`48`	`}],`
	`49`	`+ recoveryPointTags: {`
	`50`	`+ stage: 'prod',`
	`51`	`+ },`
`49`	`52`	`}));`
`50`	`53`	`}`
`51`	`54`	`}`
Original file line number	Diff line number	Diff line change
`@@ -192,6 +192,7 @@ export class BackupPlan extends Resource implements IBackupPlan {`
`192`	`192`	`enableContinuousBackup: rule.props.enableContinuousBackup,`
`193`	`193`	`targetBackupVault: vault.backupVaultName,`
`194`	`194`	`copyActions: rule.props.copyActions?.map(this.planCopyActions),`
	`195`	`+ recoveryPointTags: rule.props.recoveryPointTags,`
`195`	`196`	`});`
`196`	`197`	`}`
`197`	`198`