Skip to content

Commit 2474732

Browse files
author
AWS
committed
AWS Backup Update: The AWS Backup job attribute extension enhancement helps customers better understand the plan that initiated each job, and the properties of the resource each job creates.
1 parent 891c2ff commit 2474732

File tree

3 files changed

+90
-5
lines changed

3 files changed

+90
-5
lines changed

‎.changes/next-release/feature-AWSBackup-5034735.json‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "AWS Backup",
4+
"contributor": "",
5+
"description": "The AWS Backup job attribute extension enhancement helps customers better understand the plan that initiated each job, and the properties of the resource each job creates."
6+
}

‎services/backup/src/main/resources/codegen-resources/endpoint-rule-set.json‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,27 +5,27 @@
55
"builtIn": "AWS::Region",
66
"required": false,
77
"documentation": "The AWS region used to dispatch the request.",
8-
"type": "String"
8+
"type": "string"
99
},
1010
"UseDualStack": {
1111
"builtIn": "AWS::UseDualStack",
1212
"required": true,
1313
"default": false,
1414
"documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.",
15-
"type": "Boolean"
15+
"type": "boolean"
1616
},
1717
"UseFIPS": {
1818
"builtIn": "AWS::UseFIPS",
1919
"required": true,
2020
"default": false,
2121
"documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.",
22-
"type": "Boolean"
22+
"type": "boolean"
2323
},
2424
"Endpoint": {
2525
"builtIn": "SDK::Endpoint",
2626
"required": false,
2727
"documentation": "Override the endpoint used to send this request",
28-
"type": "String"
28+
"type": "string"
2929
}
3030
},
3131
"rules": [

‎services/backup/src/main/resources/codegen-resources/service-2.json‎

Lines changed: 80 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1671,7 +1671,7 @@
16711671
},
16721672
"BackupOptions":{
16731673
"shape":"BackupOptions",
1674-
"documentation":"<p>Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.</p> <p>Valid values: </p> <p>Set to <code>\"WindowsVSS\":\"enabled\"</code> to enable the <code>WindowsVSS</code> backup option and create a Windows VSS backup. </p> <p>Set to <code>\"WindowsVSS\":\"disabled\"</code> to create a regular backup. The <code>WindowsVSS</code> option is not enabled by default.</p> <p>If you specify an invalid option, you get an <code>InvalidParameterValueException</code> exception.</p> <p>For more information about Windows VSS backups, see <a href=\"https://docs.aws.amazon.com/aws-backup/latest/devguide/windows-backups.html\">Creating a VSS-Enabled Windows Backup</a>.</p>"
1674+
"documentation":"<p>Specifies the backup option for a selected resource. This option is available for Windows VSS backup jobs and S3 backups.</p> <p>Valid values: </p> <p>Set to <code>\"WindowsVSS\":\"enabled\"</code> to enable the <code>WindowsVSS</code> backup option and create a Windows VSS backup. </p> <p>Set to <code>\"WindowsVSS\":\"disabled\"</code> to create a regular backup. The <code>WindowsVSS</code> option is not enabled by default.</p> <p>For S3 backups, set to <code>\"S3BackupACLs\":\"disabled\"</code> to exclude ACLs from the backup, or <code>\"S3BackupObjectTags\":\"disabled\"</code> to exclude object tags from the backup. By default, both ACLs and object tags are included in S3 backups.</p> <p>If you specify an invalid option, you get an <code>InvalidParameterValueException</code> exception.</p> <p>For more information about Windows VSS backups, see <a href=\"https://docs.aws.amazon.com/aws-backup/latest/devguide/windows-backups.html\">Creating a VSS-Enabled Windows Backup</a>.</p>"
16751675
}
16761676
},
16771677
"documentation":"<p>The backup options for each resource type.</p>"
@@ -1755,10 +1755,27 @@
17551755
"shape":"ARN",
17561756
"documentation":"<p>An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, <code>arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault</code>.</p>"
17571757
},
1758+
"VaultType":{
1759+
"shape":"string",
1760+
"documentation":"<p>The type of backup vault where the recovery point is stored. Valid values are <code>BACKUP_VAULT</code> for standard backup vaults and <code>LOGICALLY_AIR_GAPPED_BACKUP_VAULT</code> for logically air-gapped vaults.</p>"
1761+
},
1762+
"VaultLockState":{
1763+
"shape":"string",
1764+
"documentation":"<p>The lock state of the backup vault. For logically air-gapped vaults, this indicates whether the vault is locked in compliance mode. Valid values include <code>LOCKED</code> and <code>UNLOCKED</code>.</p>"
1765+
},
17581766
"RecoveryPointArn":{
17591767
"shape":"ARN",
17601768
"documentation":"<p>An ARN that uniquely identifies a recovery point; for example, <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>"
17611769
},
1770+
"RecoveryPointLifecycle":{"shape":"Lifecycle"},
1771+
"EncryptionKeyArn":{
1772+
"shape":"ARN",
1773+
"documentation":"<p>The Amazon Resource Name (ARN) of the KMS key used to encrypt the backup. This can be a customer-managed key or an Amazon Web Services managed key, depending on the vault configuration.</p>"
1774+
},
1775+
"IsEncrypted":{
1776+
"shape":"boolean",
1777+
"documentation":"<p>A boolean value indicating whether the backup is encrypted. All backups in Backup are encrypted, but this field indicates the encryption status for transparency.</p>"
1778+
},
17621779
"ResourceArn":{
17631780
"shape":"ARN",
17641781
"documentation":"<p>An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.</p>"
@@ -2551,10 +2568,23 @@
25512568
"shape":"ARN",
25522569
"documentation":"<p>An Amazon Resource Name (ARN) that uniquely identifies a destination copy vault; for example, <code>arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault</code>.</p>"
25532570
},
2571+
"DestinationVaultType":{
2572+
"shape":"string",
2573+
"documentation":"<p>The type of destination backup vault where the copied recovery point is stored. Valid values are <code>BACKUP_VAULT</code> for standard backup vaults and <code>LOGICALLY_AIR_GAPPED_BACKUP_VAULT</code> for logically air-gapped vaults.</p>"
2574+
},
2575+
"DestinationVaultLockState":{
2576+
"shape":"string",
2577+
"documentation":"<p>The lock state of the destination backup vault. For logically air-gapped vaults, this indicates whether the vault is locked in compliance mode. Valid values include <code>LOCKED</code> and <code>UNLOCKED</code>.</p>"
2578+
},
25542579
"DestinationRecoveryPointArn":{
25552580
"shape":"ARN",
25562581
"documentation":"<p>An ARN that uniquely identifies a destination recovery point; for example, <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>"
25572582
},
2583+
"DestinationEncryptionKeyArn":{
2584+
"shape":"ARN",
2585+
"documentation":"<p>The Amazon Resource Name (ARN) of the KMS key used to encrypt the copied backup in the destination vault. This can be a customer-managed key or an Amazon Web Services managed key.</p>"
2586+
},
2587+
"DestinationRecoveryPointLifecycle":{"shape":"Lifecycle"},
25582588
"ResourceArn":{
25592589
"shape":"ARN",
25602590
"documentation":"<p>The Amazon Web Services resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.</p>"
@@ -3417,14 +3447,31 @@
34173447
"shape":"BackupVaultName",
34183448
"documentation":"<p>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 Amazon Web Services Region where they are created.</p>"
34193449
},
3450+
"RecoveryPointLifecycle":{"shape":"Lifecycle"},
34203451
"BackupVaultArn":{
34213452
"shape":"ARN",
34223453
"documentation":"<p>An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, <code>arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault</code>.</p>"
34233454
},
3455+
"VaultType":{
3456+
"shape":"string",
3457+
"documentation":"<p>The type of backup vault where the recovery point is stored. Valid values are <code>BACKUP_VAULT</code> for standard backup vaults and <code>LOGICALLY_AIR_GAPPED_BACKUP_VAULT</code> for logically air-gapped vaults.</p>"
3458+
},
3459+
"VaultLockState":{
3460+
"shape":"string",
3461+
"documentation":"<p>The lock state of the backup vault. For logically air-gapped vaults, this indicates whether the vault is locked in compliance mode. Valid values include <code>LOCKED</code> and <code>UNLOCKED</code>.</p>"
3462+
},
34243463
"RecoveryPointArn":{
34253464
"shape":"ARN",
34263465
"documentation":"<p>An ARN that uniquely identifies a recovery point; for example, <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>"
34273466
},
3467+
"EncryptionKeyArn":{
3468+
"shape":"ARN",
3469+
"documentation":"<p>The Amazon Resource Name (ARN) of the KMS key used to encrypt the backup. This can be a customer-managed key or an Amazon Web Services managed key, depending on the vault configuration.</p>"
3470+
},
3471+
"IsEncrypted":{
3472+
"shape":"boolean",
3473+
"documentation":"<p>A boolean value indicating whether the backup is encrypted. All backups in Backup are encrypted, but this field indicates the encryption status for transparency.</p>"
3474+
},
34283475
"ResourceArn":{
34293476
"shape":"ARN",
34303477
"documentation":"<p>An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.</p>"
@@ -3968,6 +4015,14 @@
39684015
"shape":"ARN",
39694016
"documentation":"<p>An ARN that uniquely identifies a recovery point; for example, <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>"
39704017
},
4018+
"SourceResourceArn":{
4019+
"shape":"ARN",
4020+
"documentation":"<p>The Amazon Resource Name (ARN) of the original resource that was backed up. This provides context about what resource is being restored.</p>"
4021+
},
4022+
"BackupVaultArn":{
4023+
"shape":"ARN",
4024+
"documentation":"<p>The Amazon Resource Name (ARN) of the backup vault containing the recovery point being restored. This helps identify vault access policies and permissions.</p>"
4025+
},
39714026
"CreationDate":{
39724027
"shape":"timestamp",
39734028
"documentation":"<p>The date and time that a restore job is created, in Unix format and Coordinated Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"
@@ -6656,13 +6711,29 @@
66566711
"shape":"ARN",
66576712
"documentation":"<p>An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, <code>arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50</code>.</p>"
66586713
},
6714+
"BackupPlanName":{
6715+
"shape":"string",
6716+
"documentation":"<p>The name of the backup plan that created this recovery point. This provides human-readable context about which backup plan was responsible for the backup job.</p>"
6717+
},
66596718
"BackupPlanVersion":{
66606719
"shape":"string",
66616720
"documentation":"<p>Version IDs are unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited.</p>"
66626721
},
66636722
"BackupRuleId":{
66646723
"shape":"string",
66656724
"documentation":"<p>Uniquely identifies a rule used to schedule the backup of a selection of resources.</p>"
6725+
},
6726+
"BackupRuleName":{
6727+
"shape":"string",
6728+
"documentation":"<p>The name of the backup rule within the backup plan that created this recovery point. This helps identify which specific rule triggered the backup job.</p>"
6729+
},
6730+
"BackupRuleCron":{
6731+
"shape":"string",
6732+
"documentation":"<p>The cron expression that defines the schedule for the backup rule. This shows the frequency and timing of when backups are automatically triggered.</p>"
6733+
},
6734+
"BackupRuleTimezone":{
6735+
"shape":"string",
6736+
"documentation":"<p>The timezone used for the backup rule schedule. This provides context for when backups are scheduled to run in the specified timezone.</p>"
66666737
}
66676738
},
66686739
"documentation":"<p>Contains information about the backup plan and rule that Backup used to initiate the recovery point backup.</p>"
@@ -7066,6 +7137,14 @@
70667137
"shape":"ARN",
70677138
"documentation":"<p>An ARN that uniquely identifies a recovery point; for example, <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>"
70687139
},
7140+
"SourceResourceArn":{
7141+
"shape":"ARN",
7142+
"documentation":"<p>The Amazon Resource Name (ARN) of the original resource that was backed up. This provides context about what resource is being restored.</p>"
7143+
},
7144+
"BackupVaultArn":{
7145+
"shape":"ARN",
7146+
"documentation":"<p>The Amazon Resource Name (ARN) of the backup vault containing the recovery point being restored. This helps identify vault access policies and permissions.</p>"
7147+
},
70697148
"CreationDate":{
70707149
"shape":"timestamp",
70717150
"documentation":"<p>The date and time a restore job is created, in Unix format and Coordinated Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"

0 commit comments

Comments
 (0)