Skip to content

Commit ceb62a1

Browse files
aws-sdk-dotnet-automationaws-sdk-dotnet-automation
committed
You can now subscribe to Amazon SNS notifications and Amazon EventBridge events for backup indexing. You can now receive notifications when a backup index is created, deleted, or fails to create, enhancing your ability to monitor and track your backup operations.
1 parent 8b7145a commit ceb62a1

24 files changed

+815
-520
lines changed

‎generator/ServiceModels/backup/backup-2018-11-15.api.json

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1775,7 +1775,10 @@
17751775
"BACKUP_PLAN_CREATED",
17761776
"BACKUP_PLAN_MODIFIED",
17771777
"S3_BACKUP_OBJECT_FAILED",
1778-
"S3_RESTORE_OBJECT_FAILED"
1778+
"S3_RESTORE_OBJECT_FAILED",
1779+
"RECOVERY_POINT_INDEX_COMPLETED",
1780+
"RECOVERY_POINT_INDEX_DELETED",
1781+
"RECOVERY_POINT_INDEXING_FAILED"
17791782
]
17801783
},
17811784
"BackupVaultEvents":{
@@ -1841,8 +1844,7 @@
18411844
},
18421845
"CancelLegalHoldOutput":{
18431846
"type":"structure",
1844-
"members":{
1845-
}
1847+
"members":{}
18461848
},
18471849
"ComplianceResourceIdList":{
18481850
"type":"list",
@@ -2529,8 +2531,7 @@
25292531
},
25302532
"DescribeGlobalSettingsInput":{
25312533
"type":"structure",
2532-
"members":{
2533-
}
2534+
"members":{}
25342535
},
25352536
"DescribeGlobalSettingsOutput":{
25362537
"type":"structure",
@@ -2621,8 +2622,7 @@
26212622
},
26222623
"DescribeRegionSettingsInput":{
26232624
"type":"structure",
2624-
"members":{
2625-
}
2625+
"members":{}
26262626
},
26272627
"DescribeRegionSettingsOutput":{
26282628
"type":"structure",
@@ -4426,7 +4426,10 @@
44264426
"COMPLETED",
44274427
"PARTIAL",
44284428
"DELETING",
4429-
"EXPIRED"
4429+
"EXPIRED",
4430+
"AVAILABLE",
4431+
"STOPPED",
4432+
"CREATING"
44304433
]
44314434
},
44324435
"RecoveryPointsList":{

‎generator/ServiceModels/backup/backup-2018-11-15.docs.json

Lines changed: 192 additions & 368 deletions
Large diffs are not rendered by default.

‎generator/ServiceModels/backup/backup-2018-11-15.examples.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
{
22
"version": "1.0",
3-
"examples": {
4-
}
3+
"examples": {}
54
}

‎generator/ServiceModels/backup/backup-2018-11-15.normal.json

Lines changed: 27 additions & 24 deletions
Large diffs are not rendered by default.

‎sdk/src/Services/Backup/Generated/Model/BackupJob.cs

Lines changed: 47 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,8 +125,54 @@ internal bool IsSetBackupOptions()
125125
/// <summary>
126126
/// Gets and sets the property BackupSizeInBytes.
127127
/// <para>
128-
/// The size, in bytes, of a backup.
128+
/// The size, in bytes, of a backup (recovery point).
129129
/// </para>
130+
///
131+
/// <para>
132+
/// This value can render differently depending on the resource type as Backup pulls in
133+
/// data information from other Amazon Web Services services. For example, the value returned
134+
/// may show a value of <c>0</c>, which may differ from the anticipated value.
135+
/// </para>
136+
///
137+
/// <para>
138+
/// The expected behavior for values by resource type are described as follows:
139+
/// </para>
140+
/// <ul> <li>
141+
/// <para>
142+
/// Amazon Aurora, Amazon DocumentDB, and Amazon Neptune do not have this value populate
143+
/// from the operation <c>GetBackupJobStatus</c>.
144+
/// </para>
145+
/// </li> <li>
146+
/// <para>
147+
/// For Amazon DynamoDB with advanced features, this value refers to the size of the recovery
148+
/// point (backup).
149+
/// </para>
150+
/// </li> <li>
151+
/// <para>
152+
/// Amazon EC2 and Amazon EBS show volume size (provisioned storage) returned as part
153+
/// of this value. Amazon EBS does not return backup size information; snapshot size will
154+
/// have the same value as the original resource that was backed up.
155+
/// </para>
156+
/// </li> <li>
157+
/// <para>
158+
/// For Amazon EFS, this value refers to the delta bytes transferred during a backup.
159+
/// </para>
160+
/// </li> <li>
161+
/// <para>
162+
/// Amazon FSx does not populate this value from the operation <c>GetBackupJobStatus</c>
163+
/// for FSx file systems.
164+
/// </para>
165+
/// </li> <li>
166+
/// <para>
167+
/// An Amazon RDS instance will show as <c>0</c>.
168+
/// </para>
169+
/// </li> <li>
170+
/// <para>
171+
/// For virtual machines running VMware, this value is passed to Backup through an asynchronous
172+
/// workflow, which can mean this displayed value can under-represent the actual backup
173+
/// size.
174+
/// </para>
175+
/// </li> </ul>
130176
/// </summary>
131177
public long? BackupSizeInBytes
132178
{

‎sdk/src/Services/Backup/Generated/Model/BackupRule.cs

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -224,13 +224,23 @@ internal bool IsSetRuleName()
224224
/// <summary>
225225
/// Gets and sets the property ScheduleExpression.
226226
/// <para>
227-
/// A cron expression in UTC specifying when Backup initiates a backup job. For more information
228-
/// about Amazon Web Services cron expressions, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html">Schedule
229-
/// Expressions for Rules</a> in the <i>Amazon CloudWatch Events User Guide.</i>. Two
230-
/// examples of Amazon Web Services cron expressions are <c> 15 * ? * * *</c> (take a
231-
/// backup every hour at 15 minutes past the hour) and <c>0 12 * * ? *</c> (take a backup
232-
/// every day at 12 noon UTC). For a table of examples, click the preceding link and scroll
233-
/// down the page.
227+
/// A cron expression in UTC specifying when Backup initiates a backup job. When no CRON
228+
/// expression is provided, Backup will use the default expression <c>cron(0 5 ? * * *)</c>.
229+
/// </para>
230+
///
231+
/// <para>
232+
/// For more information about Amazon Web Services cron expressions, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html">Schedule
233+
/// Expressions for Rules</a> in the <i>Amazon CloudWatch Events User Guide</i>.
234+
/// </para>
235+
///
236+
/// <para>
237+
/// Two examples of Amazon Web Services cron expressions are <c> 15 * ? * * *</c> (take
238+
/// a backup every hour at 15 minutes past the hour) and <c>0 12 * * ? *</c> (take a backup
239+
/// every day at 12 noon UTC).
240+
/// </para>
241+
///
242+
/// <para>
243+
/// For a table of examples, click the preceding link and scroll down the page.
234244
/// </para>
235245
/// </summary>
236246
public string ScheduleExpression

‎sdk/src/Services/Backup/Generated/Model/BackupRuleInput.cs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,8 @@ internal bool IsSetRuleName()
214214
/// <summary>
215215
/// Gets and sets the property ScheduleExpression.
216216
/// <para>
217-
/// A CRON expression in UTC specifying when Backup initiates a backup job.
217+
/// A CRON expression in UTC specifying when Backup initiates a backup job. When no CRON
218+
/// expression is provided, Backup will use the default expression <c>cron(0 5 ? * * *)</c>.
218219
/// </para>
219220
/// </summary>
220221
public string ScheduleExpression

‎sdk/src/Services/Backup/Generated/Model/DescribeBackupJobResponse.cs

Lines changed: 47 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,8 +119,54 @@ internal bool IsSetBackupOptions()
119119
/// <summary>
120120
/// Gets and sets the property BackupSizeInBytes.
121121
/// <para>
122-
/// The size, in bytes, of a backup.
122+
/// The size, in bytes, of a backup (recovery point).
123123
/// </para>
124+
///
125+
/// <para>
126+
/// This value can render differently depending on the resource type as Backup pulls in
127+
/// data information from other Amazon Web Services services. For example, the value returned
128+
/// may show a value of <c>0</c>, which may differ from the anticipated value.
129+
/// </para>
130+
///
131+
/// <para>
132+
/// The expected behavior for values by resource type are described as follows:
133+
/// </para>
134+
/// <ul> <li>
135+
/// <para>
136+
/// Amazon Aurora, Amazon DocumentDB, and Amazon Neptune do not have this value populate
137+
/// from the operation <c>GetBackupJobStatus</c>.
138+
/// </para>
139+
/// </li> <li>
140+
/// <para>
141+
/// For Amazon DynamoDB with advanced features, this value refers to the size of the recovery
142+
/// point (backup).
143+
/// </para>
144+
/// </li> <li>
145+
/// <para>
146+
/// Amazon EC2 and Amazon EBS show volume size (provisioned storage) returned as part
147+
/// of this value. Amazon EBS does not return backup size information; snapshot size will
148+
/// have the same value as the original resource that was backed up.
149+
/// </para>
150+
/// </li> <li>
151+
/// <para>
152+
/// For Amazon EFS, this value refers to the delta bytes transferred during a backup.
153+
/// </para>
154+
/// </li> <li>
155+
/// <para>
156+
/// Amazon FSx does not populate this value from the operation <c>GetBackupJobStatus</c>
157+
/// for FSx file systems.
158+
/// </para>
159+
/// </li> <li>
160+
/// <para>
161+
/// An Amazon RDS instance will show as <c>0</c>.
162+
/// </para>
163+
/// </li> <li>
164+
/// <para>
165+
/// For virtual machines running VMware, this value is passed to Backup through an asynchronous
166+
/// workflow, which can mean this displayed value can under-represent the actual backup
167+
/// size.
168+
/// </para>
169+
/// </li> </ul>
124170
/// </summary>
125171
public long? BackupSizeInBytes
126172
{

‎sdk/src/Services/Backup/Generated/Model/DescribeBackupVaultResponse.cs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -259,6 +259,12 @@ internal bool IsSetMinRetentionDays()
259259
/// <para>
260260
/// The number of recovery points that are stored in a backup vault.
261261
/// </para>
262+
///
263+
/// <para>
264+
/// Recovery point count value displayed in the console can be an approximation. Use <a
265+
/// href="https://docs.aws.amazon.com/aws-backup/latest/devguide/API_ListRecoveryPointsByBackupVault.html">
266+
/// <c>ListRecoveryPointsByBackupVault</c> </a> API to obtain the exact count.
267+
/// </para>
262268
/// </summary>
263269
public long? NumberOfRecoveryPoints
264270
{

‎sdk/src/Services/Backup/Generated/Model/DescribeRecoveryPointResponse.cs

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -511,25 +511,36 @@ internal bool IsSetSourceBackupVaultArn()
511511
/// <summary>
512512
/// Gets and sets the property Status.
513513
/// <para>
514-
/// A status code specifying the state of the recovery point.
514+
/// A status code specifying the state of the recovery point. For more information, see
515+
/// <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/applicationstackbackups.html#cfnrecoverypointstatus">
516+
/// Recovery point status</a> in the <i>Backup Developer Guide</i>.
515517
/// </para>
516-
///
518+
/// <ul> <li>
517519
/// <para>
518-
/// <c>PARTIAL</c> status indicates Backup could not create the recovery point before
519-
/// the backup window closed. To increase your backup plan window using the API, see <a
520-
/// href="https://docs.aws.amazon.com/aws-backup/latest/devguide/API_UpdateBackupPlan.html">UpdateBackupPlan</a>.
521-
/// You can also increase your backup plan window using the Console by choosing and editing
522-
/// your backup plan.
520+
/// <c>CREATING</c> status indicates that an Backup job has been initiated for a resource.
521+
/// The backup process has started and is actively processing a backup job for the associated
522+
/// recovery point.
523523
/// </para>
524-
///
524+
/// </li> <li>
525+
/// <para>
526+
/// <c>AVAILABLE</c> status indicates that the backup was successfully created for the
527+
/// recovery point. The backup process has completed without any issues, and the recovery
528+
/// point is now ready for use.
529+
/// </para>
530+
/// </li> <li>
531+
/// <para>
532+
/// <c>PARTIAL</c> status indicates a composite recovery point has one or more nested
533+
/// recovery points that were not in the backup.
534+
/// </para>
535+
/// </li> <li>
525536
/// <para>
526537
/// <c>EXPIRED</c> status indicates that the recovery point has exceeded its retention
527538
/// period, but Backup lacks permission or is otherwise unable to delete it. To manually
528539
/// delete these recovery points, see <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/gs-cleanup-resources.html#cleanup-backups">
529540
/// Step 3: Delete the recovery points</a> in the <i>Clean up resources</i> section of
530541
/// <i>Getting started</i>.
531542
/// </para>
532-
///
543+
/// </li> <li>
533544
/// <para>
534545
/// <c>STOPPED</c> status occurs on a continuous backup where a user has taken some action
535546
/// that causes the continuous backup to be disabled. This can be caused by the removal
@@ -551,6 +562,7 @@ internal bool IsSetSourceBackupVaultArn()
551562
/// misconfiguration, or backup failure. To ensure that future continuous backups succeed,
552563
/// refer to the recovery point status and check SAP HANA for details.
553564
/// </para>
565+
/// </li> </ul>
554566
/// </summary>
555567
public RecoveryPointStatus Status
556568
{

0 commit comments

Comments
 (0)