aws-sdk-backup 1.88.0 → 1.89.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-backup/client.rb +50 -24
- data/lib/aws-sdk-backup/types.rb +147 -61
- data/lib/aws-sdk-backup.rb +1 -1
- data/sig/client.rbs +3 -3
- data/sig/types.rbs +5 -5
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 16f2e6faf6c67f03d4357868390b16157def8069d0d108bf4c62efaed9b46fc9
|
4
|
+
data.tar.gz: ba2fe8687a03d75be3ef2aef63e3306bb99de26cb2eac92fb58c80ba0fdbf2d2
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: c6d50e69b8636ffe837884fd74bb45bf05ade6d9712ef58a7f245d9703c0f879ebadb7388846e353b33ff3d417819ae755ad78d594cbe81433e5761c10296d68
|
7
|
+
data.tar.gz: 402cb8380cf482d64ca78659c492eb17c6ce592209e58082fcbeb4c7697d36eec74a9ff3424e54384cdea488ed38cf1e5a09b7be761d563070ee778c1e06fc3e
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,11 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.89.0 (2025-06-02)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - 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.
|
8
|
+
|
4
9
|
1.88.0 (2025-05-12)
|
5
10
|
------------------
|
6
11
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.89.0
|
@@ -1951,7 +1951,7 @@ module Aws::Backup
|
|
1951
1951
|
# resp.created_by.backup_plan_version #=> String
|
1952
1952
|
# resp.created_by.backup_rule_id #=> String
|
1953
1953
|
# resp.iam_role_arn #=> String
|
1954
|
-
# resp.status #=> String, one of "COMPLETED", "PARTIAL", "DELETING", "EXPIRED"
|
1954
|
+
# resp.status #=> String, one of "COMPLETED", "PARTIAL", "DELETING", "EXPIRED", "AVAILABLE", "STOPPED", "CREATING"
|
1955
1955
|
# resp.status_message #=> String
|
1956
1956
|
# resp.creation_date #=> Time
|
1957
1957
|
# resp.completion_date #=> Time
|
@@ -2570,7 +2570,7 @@ module Aws::Backup
|
|
2570
2570
|
# resp.backup_vault_arn #=> String
|
2571
2571
|
# resp.sns_topic_arn #=> String
|
2572
2572
|
# resp.backup_vault_events #=> Array
|
2573
|
-
# resp.backup_vault_events[0] #=> String, one of "BACKUP_JOB_STARTED", "BACKUP_JOB_COMPLETED", "BACKUP_JOB_SUCCESSFUL", "BACKUP_JOB_FAILED", "BACKUP_JOB_EXPIRED", "RESTORE_JOB_STARTED", "RESTORE_JOB_COMPLETED", "RESTORE_JOB_SUCCESSFUL", "RESTORE_JOB_FAILED", "COPY_JOB_STARTED", "COPY_JOB_SUCCESSFUL", "COPY_JOB_FAILED", "RECOVERY_POINT_MODIFIED", "BACKUP_PLAN_CREATED", "BACKUP_PLAN_MODIFIED", "S3_BACKUP_OBJECT_FAILED", "S3_RESTORE_OBJECT_FAILED"
|
2573
|
+
# resp.backup_vault_events[0] #=> String, one of "BACKUP_JOB_STARTED", "BACKUP_JOB_COMPLETED", "BACKUP_JOB_SUCCESSFUL", "BACKUP_JOB_FAILED", "BACKUP_JOB_EXPIRED", "RESTORE_JOB_STARTED", "RESTORE_JOB_COMPLETED", "RESTORE_JOB_SUCCESSFUL", "RESTORE_JOB_FAILED", "COPY_JOB_STARTED", "COPY_JOB_SUCCESSFUL", "COPY_JOB_FAILED", "RECOVERY_POINT_MODIFIED", "BACKUP_PLAN_CREATED", "BACKUP_PLAN_MODIFIED", "S3_BACKUP_OBJECT_FAILED", "S3_RESTORE_OBJECT_FAILED", "RECOVERY_POINT_INDEX_COMPLETED", "RECOVERY_POINT_INDEX_DELETED", "RECOVERY_POINT_INDEXING_FAILED"
|
2574
2574
|
#
|
2575
2575
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetBackupVaultNotifications AWS API Documentation
|
2576
2576
|
#
|
@@ -4206,7 +4206,7 @@ module Aws::Backup
|
|
4206
4206
|
# resp.recovery_points[0].created_by.backup_plan_version #=> String
|
4207
4207
|
# resp.recovery_points[0].created_by.backup_rule_id #=> String
|
4208
4208
|
# resp.recovery_points[0].iam_role_arn #=> String
|
4209
|
-
# resp.recovery_points[0].status #=> String, one of "COMPLETED", "PARTIAL", "DELETING", "EXPIRED"
|
4209
|
+
# resp.recovery_points[0].status #=> String, one of "COMPLETED", "PARTIAL", "DELETING", "EXPIRED", "AVAILABLE", "STOPPED", "CREATING"
|
4210
4210
|
# resp.recovery_points[0].status_message #=> String
|
4211
4211
|
# resp.recovery_points[0].creation_date #=> Time
|
4212
4212
|
# resp.recovery_points[0].completion_date #=> Time
|
@@ -4342,7 +4342,7 @@ module Aws::Backup
|
|
4342
4342
|
# resp.recovery_points #=> Array
|
4343
4343
|
# resp.recovery_points[0].recovery_point_arn #=> String
|
4344
4344
|
# resp.recovery_points[0].creation_date #=> Time
|
4345
|
-
# resp.recovery_points[0].status #=> String, one of "COMPLETED", "PARTIAL", "DELETING", "EXPIRED"
|
4345
|
+
# resp.recovery_points[0].status #=> String, one of "COMPLETED", "PARTIAL", "DELETING", "EXPIRED", "AVAILABLE", "STOPPED", "CREATING"
|
4346
4346
|
# resp.recovery_points[0].status_message #=> String
|
4347
4347
|
# resp.recovery_points[0].encryption_key_arn #=> String
|
4348
4348
|
# resp.recovery_points[0].backup_size_bytes #=> Integer
|
@@ -4917,6 +4917,24 @@ module Aws::Backup
|
|
4917
4917
|
# Returns the tags assigned to the resource, such as a target recovery
|
4918
4918
|
# point, backup plan, or backup vault.
|
4919
4919
|
#
|
4920
|
+
# This operation returns results depending on the resource type used in
|
4921
|
+
# the value for `resourceArn`. For example, recovery points of Amazon
|
4922
|
+
# DynamoDB with Advanced Settings have an ARN (Amazon Resource Name)
|
4923
|
+
# that begins with `arn:aws:backup`. Recovery points (backups) of
|
4924
|
+
# DynamoDB without Advanced Settings enabled have an ARN that begins
|
4925
|
+
# with `arn:aws:dynamodb`.
|
4926
|
+
#
|
4927
|
+
# When this operation is called and when you include values of
|
4928
|
+
# `resourceArn` that have an ARN other than `arn:aws:backup`, it may
|
4929
|
+
# return one of the exceptions listed below. To prevent this exception,
|
4930
|
+
# include only values representing resource types that are fully managed
|
4931
|
+
# by Backup. These have an ARN that begins `arn:aws:backup` and they are
|
4932
|
+
# noted in the [Feature availability by resource][1] table.
|
4933
|
+
#
|
4934
|
+
#
|
4935
|
+
#
|
4936
|
+
# [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource
|
4937
|
+
#
|
4920
4938
|
# @option params [required, String] :resource_arn
|
4921
4939
|
# An Amazon Resource Name (ARN) that uniquely identifies a resource. The
|
4922
4940
|
# format of the ARN depends on the type of resource. Valid targets for
|
@@ -5124,7 +5142,8 @@ module Aws::Backup
|
|
5124
5142
|
#
|
5125
5143
|
# The following events are supported:
|
5126
5144
|
#
|
5127
|
-
# * `BACKUP_JOB_STARTED` \| `BACKUP_JOB_COMPLETED`
|
5145
|
+
# * `BACKUP_JOB_STARTED` \| `BACKUP_JOB_COMPLETED` \|
|
5146
|
+
# `BACKUP_JOB_FAILED`
|
5128
5147
|
#
|
5129
5148
|
# * `COPY_JOB_STARTED` \| `COPY_JOB_SUCCESSFUL` \| `COPY_JOB_FAILED`
|
5130
5149
|
#
|
@@ -5133,6 +5152,9 @@ module Aws::Backup
|
|
5133
5152
|
#
|
5134
5153
|
# * `S3_BACKUP_OBJECT_FAILED` \| `S3_RESTORE_OBJECT_FAILED`
|
5135
5154
|
#
|
5155
|
+
# * `RECOVERY_POINT_INDEX_COMPLETED` \| `RECOVERY_POINT_INDEX_DELETED`
|
5156
|
+
# \| `RECOVERY_POINT_INDEXING_FAILED`
|
5157
|
+
#
|
5136
5158
|
# <note markdown="1"> The list below includes both supported events and deprecated events
|
5137
5159
|
# that are no longer in use (for reference). Deprecated events do not
|
5138
5160
|
# return statuses or notifications. Refer to the list above for the
|
@@ -5151,7 +5173,7 @@ module Aws::Backup
|
|
5151
5173
|
# resp = client.put_backup_vault_notifications({
|
5152
5174
|
# backup_vault_name: "BackupVaultName", # required
|
5153
5175
|
# sns_topic_arn: "ARN", # required
|
5154
|
-
# backup_vault_events: ["BACKUP_JOB_STARTED"], # required, accepts BACKUP_JOB_STARTED, BACKUP_JOB_COMPLETED, BACKUP_JOB_SUCCESSFUL, BACKUP_JOB_FAILED, BACKUP_JOB_EXPIRED, RESTORE_JOB_STARTED, RESTORE_JOB_COMPLETED, RESTORE_JOB_SUCCESSFUL, RESTORE_JOB_FAILED, COPY_JOB_STARTED, COPY_JOB_SUCCESSFUL, COPY_JOB_FAILED, RECOVERY_POINT_MODIFIED, BACKUP_PLAN_CREATED, BACKUP_PLAN_MODIFIED, S3_BACKUP_OBJECT_FAILED, S3_RESTORE_OBJECT_FAILED
|
5176
|
+
# backup_vault_events: ["BACKUP_JOB_STARTED"], # required, accepts BACKUP_JOB_STARTED, BACKUP_JOB_COMPLETED, BACKUP_JOB_SUCCESSFUL, BACKUP_JOB_FAILED, BACKUP_JOB_EXPIRED, RESTORE_JOB_STARTED, RESTORE_JOB_COMPLETED, RESTORE_JOB_SUCCESSFUL, RESTORE_JOB_FAILED, COPY_JOB_STARTED, COPY_JOB_SUCCESSFUL, COPY_JOB_FAILED, RECOVERY_POINT_MODIFIED, BACKUP_PLAN_CREATED, BACKUP_PLAN_MODIFIED, S3_BACKUP_OBJECT_FAILED, S3_RESTORE_OBJECT_FAILED, RECOVERY_POINT_INDEX_COMPLETED, RECOVERY_POINT_INDEX_DELETED, RECOVERY_POINT_INDEXING_FAILED
|
5155
5177
|
# })
|
5156
5178
|
#
|
5157
5179
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/PutBackupVaultNotifications AWS API Documentation
|
@@ -5617,10 +5639,25 @@ module Aws::Backup
|
|
5617
5639
|
|
5618
5640
|
# Attempts to cancel a job to create a one-time backup of a resource.
|
5619
5641
|
#
|
5620
|
-
# This action is not supported for the following services:
|
5621
|
-
#
|
5622
|
-
#
|
5623
|
-
#
|
5642
|
+
# This action is not supported for the following services:
|
5643
|
+
#
|
5644
|
+
# * Amazon Aurora
|
5645
|
+
#
|
5646
|
+
# * Amazon DocumentDB (with MongoDB compatibility)
|
5647
|
+
#
|
5648
|
+
# * Amazon FSx for Lustre
|
5649
|
+
#
|
5650
|
+
# * Amazon FSx for NetApp ONTAP
|
5651
|
+
#
|
5652
|
+
# * Amazon FSx for OpenZFS
|
5653
|
+
#
|
5654
|
+
# * Amazon FSx for Windows File Server
|
5655
|
+
#
|
5656
|
+
# * Amazon Neptune
|
5657
|
+
#
|
5658
|
+
# * SAP HANA databases on Amazon EC2 instances
|
5659
|
+
#
|
5660
|
+
# * Amazon RDS
|
5624
5661
|
#
|
5625
5662
|
# @option params [required, String] :backup_job_id
|
5626
5663
|
# Uniquely identifies a request to Backup to back up a resource.
|
@@ -5642,21 +5679,10 @@ module Aws::Backup
|
|
5642
5679
|
req.send_request(options)
|
5643
5680
|
end
|
5644
5681
|
|
5645
|
-
# Assigns a set of key-value pairs to a
|
5646
|
-
# backup vault identified by an Amazon Resource Name (ARN).
|
5647
|
-
#
|
5648
|
-
# This API is supported for recovery points for resource types including
|
5649
|
-
# Aurora, Amazon DocumentDB. Amazon EBS, Amazon FSx, Neptune, and Amazon
|
5650
|
-
# RDS.
|
5682
|
+
# Assigns a set of key-value pairs to a resource.
|
5651
5683
|
#
|
5652
5684
|
# @option params [required, String] :resource_arn
|
5653
|
-
#
|
5654
|
-
# depends on the type of the tagged resource.
|
5655
|
-
#
|
5656
|
-
# ARNs that do not include `backup` are incompatible with tagging.
|
5657
|
-
# `TagResource` and `UntagResource` with invalid ARNs will result in an
|
5658
|
-
# error. Acceptable ARN content can include `arn:aws:backup:us-east`.
|
5659
|
-
# Invalid ARN content may look like `arn:aws:ec2:us-east`.
|
5685
|
+
# The ARN that uniquely identifies the resource.
|
5660
5686
|
#
|
5661
5687
|
# @option params [required, Hash<String,String>] :tags
|
5662
5688
|
# Key-value pairs that are used to help organize your resources. You can
|
@@ -6340,7 +6366,7 @@ module Aws::Backup
|
|
6340
6366
|
tracer: tracer
|
6341
6367
|
)
|
6342
6368
|
context[:gem_name] = 'aws-sdk-backup'
|
6343
|
-
context[:gem_version] = '1.
|
6369
|
+
context[:gem_version] = '1.89.0'
|
6344
6370
|
Seahorse::Client::Request.new(handlers, context)
|
6345
6371
|
end
|
6346
6372
|
|
data/lib/aws-sdk-backup/types.rb
CHANGED
@@ -153,7 +153,38 @@ module Aws::Backup
|
|
153
153
|
# @return [String]
|
154
154
|
#
|
155
155
|
# @!attribute [rw] backup_size_in_bytes
|
156
|
-
# The size, in bytes, of a backup.
|
156
|
+
# The size, in bytes, of a backup (recovery point).
|
157
|
+
#
|
158
|
+
# This value can render differently depending on the resource type as
|
159
|
+
# Backup pulls in data information from other Amazon Web Services
|
160
|
+
# services. For example, the value returned may show a value of `0`,
|
161
|
+
# which may differ from the anticipated value.
|
162
|
+
#
|
163
|
+
# The expected behavior for values by resource type are described as
|
164
|
+
# follows:
|
165
|
+
#
|
166
|
+
# * Amazon Aurora, Amazon DocumentDB, and Amazon Neptune do not have
|
167
|
+
# this value populate from the operation `GetBackupJobStatus`.
|
168
|
+
#
|
169
|
+
# * For Amazon DynamoDB with advanced features, this value refers to
|
170
|
+
# the size of the recovery point (backup).
|
171
|
+
#
|
172
|
+
# * Amazon EC2 and Amazon EBS show volume size (provisioned storage)
|
173
|
+
# returned as part of this value. Amazon EBS does not return backup
|
174
|
+
# size information; snapshot size will have the same value as the
|
175
|
+
# original resource that was backed up.
|
176
|
+
#
|
177
|
+
# * For Amazon EFS, this value refers to the delta bytes transferred
|
178
|
+
# during a backup.
|
179
|
+
#
|
180
|
+
# * Amazon FSx does not populate this value from the operation
|
181
|
+
# `GetBackupJobStatus` for FSx file systems.
|
182
|
+
#
|
183
|
+
# * An Amazon RDS instance will show as `0`.
|
184
|
+
#
|
185
|
+
# * For virtual machines running VMware, this value is passed to
|
186
|
+
# Backup through an asynchronous workflow, which can mean this
|
187
|
+
# displayed value can under-represent the actual backup size.
|
157
188
|
# @return [Integer]
|
158
189
|
#
|
159
190
|
# @!attribute [rw] iam_role_arn
|
@@ -532,13 +563,19 @@ module Aws::Backup
|
|
532
563
|
#
|
533
564
|
# @!attribute [rw] schedule_expression
|
534
565
|
# A cron expression in UTC specifying when Backup initiates a backup
|
535
|
-
# job.
|
536
|
-
#
|
537
|
-
#
|
538
|
-
#
|
539
|
-
#
|
540
|
-
#
|
541
|
-
#
|
566
|
+
# job. When no CRON expression is provided, Backup will use the
|
567
|
+
# default expression `cron(0 5 ? * * *)`.
|
568
|
+
#
|
569
|
+
# For more information about Amazon Web Services cron expressions, see
|
570
|
+
# [Schedule Expressions for Rules][1] in the *Amazon CloudWatch Events
|
571
|
+
# User Guide*.
|
572
|
+
#
|
573
|
+
# Two examples of Amazon Web Services cron expressions are ` 15 * ? *
|
574
|
+
# * *` (take a backup every hour at 15 minutes past the hour) and `0
|
575
|
+
# 12 * * ? *` (take a backup every day at 12 noon UTC).
|
576
|
+
#
|
577
|
+
# For a table of examples, click the preceding link and scroll down
|
578
|
+
# the page.
|
542
579
|
#
|
543
580
|
#
|
544
581
|
#
|
@@ -661,7 +698,8 @@ module Aws::Backup
|
|
661
698
|
#
|
662
699
|
# @!attribute [rw] schedule_expression
|
663
700
|
# A CRON expression in UTC specifying when Backup initiates a backup
|
664
|
-
# job.
|
701
|
+
# job. When no CRON expression is provided, Backup will use the
|
702
|
+
# default expression `cron(0 5 ? * * *)`.
|
665
703
|
# @return [String]
|
666
704
|
#
|
667
705
|
# @!attribute [rw] start_window_minutes
|
@@ -2515,7 +2553,38 @@ module Aws::Backup
|
|
2515
2553
|
# @return [String]
|
2516
2554
|
#
|
2517
2555
|
# @!attribute [rw] backup_size_in_bytes
|
2518
|
-
# The size, in bytes, of a backup.
|
2556
|
+
# The size, in bytes, of a backup (recovery point).
|
2557
|
+
#
|
2558
|
+
# This value can render differently depending on the resource type as
|
2559
|
+
# Backup pulls in data information from other Amazon Web Services
|
2560
|
+
# services. For example, the value returned may show a value of `0`,
|
2561
|
+
# which may differ from the anticipated value.
|
2562
|
+
#
|
2563
|
+
# The expected behavior for values by resource type are described as
|
2564
|
+
# follows:
|
2565
|
+
#
|
2566
|
+
# * Amazon Aurora, Amazon DocumentDB, and Amazon Neptune do not have
|
2567
|
+
# this value populate from the operation `GetBackupJobStatus`.
|
2568
|
+
#
|
2569
|
+
# * For Amazon DynamoDB with advanced features, this value refers to
|
2570
|
+
# the size of the recovery point (backup).
|
2571
|
+
#
|
2572
|
+
# * Amazon EC2 and Amazon EBS show volume size (provisioned storage)
|
2573
|
+
# returned as part of this value. Amazon EBS does not return backup
|
2574
|
+
# size information; snapshot size will have the same value as the
|
2575
|
+
# original resource that was backed up.
|
2576
|
+
#
|
2577
|
+
# * For Amazon EFS, this value refers to the delta bytes transferred
|
2578
|
+
# during a backup.
|
2579
|
+
#
|
2580
|
+
# * Amazon FSx does not populate this value from the operation
|
2581
|
+
# `GetBackupJobStatus` for FSx file systems.
|
2582
|
+
#
|
2583
|
+
# * An Amazon RDS instance will show as `0`.
|
2584
|
+
#
|
2585
|
+
# * For virtual machines running VMware, this value is passed to
|
2586
|
+
# Backup through an asynchronous workflow, which can mean this
|
2587
|
+
# displayed value can under-represent the actual backup size.
|
2519
2588
|
# @return [Integer]
|
2520
2589
|
#
|
2521
2590
|
# @!attribute [rw] iam_role_arn
|
@@ -2706,6 +2775,14 @@ module Aws::Backup
|
|
2706
2775
|
#
|
2707
2776
|
# @!attribute [rw] number_of_recovery_points
|
2708
2777
|
# The number of recovery points that are stored in a backup vault.
|
2778
|
+
#
|
2779
|
+
# Recovery point count value displayed in the console can be an
|
2780
|
+
# approximation. Use [ `ListRecoveryPointsByBackupVault` ][1] API to
|
2781
|
+
# obtain the exact count.
|
2782
|
+
#
|
2783
|
+
#
|
2784
|
+
#
|
2785
|
+
# [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/API_ListRecoveryPointsByBackupVault.html
|
2709
2786
|
# @return [Integer]
|
2710
2787
|
#
|
2711
2788
|
# @!attribute [rw] locked
|
@@ -3062,43 +3139,51 @@ module Aws::Backup
|
|
3062
3139
|
# @return [String]
|
3063
3140
|
#
|
3064
3141
|
# @!attribute [rw] status
|
3065
|
-
# A status code specifying the state of the recovery point.
|
3066
|
-
#
|
3067
|
-
#
|
3068
|
-
#
|
3069
|
-
#
|
3070
|
-
#
|
3071
|
-
#
|
3072
|
-
#
|
3073
|
-
# `
|
3074
|
-
#
|
3075
|
-
#
|
3076
|
-
#
|
3077
|
-
#
|
3078
|
-
#
|
3079
|
-
#
|
3080
|
-
#
|
3081
|
-
#
|
3082
|
-
#
|
3083
|
-
#
|
3084
|
-
#
|
3085
|
-
#
|
3086
|
-
# continuous backup
|
3087
|
-
#
|
3088
|
-
#
|
3089
|
-
#
|
3090
|
-
#
|
3091
|
-
#
|
3092
|
-
#
|
3093
|
-
#
|
3094
|
-
#
|
3095
|
-
#
|
3096
|
-
#
|
3097
|
-
#
|
3098
|
-
#
|
3099
|
-
#
|
3100
|
-
#
|
3101
|
-
#
|
3142
|
+
# A status code specifying the state of the recovery point. For more
|
3143
|
+
# information, see [ Recovery point status][1] in the *Backup
|
3144
|
+
# Developer Guide*.
|
3145
|
+
#
|
3146
|
+
# * `CREATING` status indicates that an Backup job has been initiated
|
3147
|
+
# for a resource. The backup process has started and is actively
|
3148
|
+
# processing a backup job for the associated recovery point.
|
3149
|
+
#
|
3150
|
+
# * `AVAILABLE` status indicates that the backup was successfully
|
3151
|
+
# created for the recovery point. The backup process has completed
|
3152
|
+
# without any issues, and the recovery point is now ready for use.
|
3153
|
+
#
|
3154
|
+
# * `PARTIAL` status indicates a composite recovery point has one or
|
3155
|
+
# more nested recovery points that were not in the backup.
|
3156
|
+
#
|
3157
|
+
# * `EXPIRED` status indicates that the recovery point has exceeded
|
3158
|
+
# its retention period, but Backup lacks permission or is otherwise
|
3159
|
+
# unable to delete it. To manually delete these recovery points, see
|
3160
|
+
# [ Step 3: Delete the recovery points][2] in the *Clean up
|
3161
|
+
# resources* section of *Getting started*.
|
3162
|
+
#
|
3163
|
+
# * `STOPPED` status occurs on a continuous backup where a user has
|
3164
|
+
# taken some action that causes the continuous backup to be
|
3165
|
+
# disabled. This can be caused by the removal of permissions,
|
3166
|
+
# turning off versioning, turning off events being sent to
|
3167
|
+
# EventBridge, or disabling the EventBridge rules that are put in
|
3168
|
+
# place by Backup. For recovery points of Amazon S3, Amazon RDS, and
|
3169
|
+
# Amazon Aurora resources, this status occurs when the retention
|
3170
|
+
# period of a continuous backup rule is changed.
|
3171
|
+
#
|
3172
|
+
# To resolve `STOPPED` status, ensure that all requested permissions
|
3173
|
+
# are in place and that versioning is enabled on the S3 bucket. Once
|
3174
|
+
# these conditions are met, the next instance of a backup rule
|
3175
|
+
# running will result in a new continuous recovery point being
|
3176
|
+
# created. The recovery points with STOPPED status do not need to be
|
3177
|
+
# deleted.
|
3178
|
+
#
|
3179
|
+
# For SAP HANA on Amazon EC2 `STOPPED` status occurs due to user
|
3180
|
+
# action, application misconfiguration, or backup failure. To ensure
|
3181
|
+
# that future continuous backups succeed, refer to the recovery
|
3182
|
+
# point status and check SAP HANA for details.
|
3183
|
+
#
|
3184
|
+
#
|
3185
|
+
#
|
3186
|
+
# [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/applicationstackbackups.html#cfnrecoverypointstatus
|
3102
3187
|
# [2]: https://docs.aws.amazon.com/aws-backup/latest/devguide/gs-cleanup-resources.html#cleanup-backups
|
3103
3188
|
# @return [String]
|
3104
3189
|
#
|
@@ -6724,7 +6809,8 @@ module Aws::Backup
|
|
6724
6809
|
#
|
6725
6810
|
# The following events are supported:
|
6726
6811
|
#
|
6727
|
-
# * `BACKUP_JOB_STARTED` \| `BACKUP_JOB_COMPLETED`
|
6812
|
+
# * `BACKUP_JOB_STARTED` \| `BACKUP_JOB_COMPLETED` \|
|
6813
|
+
# `BACKUP_JOB_FAILED`
|
6728
6814
|
#
|
6729
6815
|
# * `COPY_JOB_STARTED` \| `COPY_JOB_SUCCESSFUL` \| `COPY_JOB_FAILED`
|
6730
6816
|
#
|
@@ -6733,6 +6819,9 @@ module Aws::Backup
|
|
6733
6819
|
#
|
6734
6820
|
# * `S3_BACKUP_OBJECT_FAILED` \| `S3_RESTORE_OBJECT_FAILED`
|
6735
6821
|
#
|
6822
|
+
# * `RECOVERY_POINT_INDEX_COMPLETED` \| `RECOVERY_POINT_INDEX_DELETED`
|
6823
|
+
# \| `RECOVERY_POINT_INDEXING_FAILED`
|
6824
|
+
#
|
6736
6825
|
# <note markdown="1"> The list below includes both supported events and deprecated events
|
6737
6826
|
# that are no longer in use (for reference). Deprecated events do not
|
6738
6827
|
# return statuses or notifications. Refer to the list above for the
|
@@ -7692,7 +7781,8 @@ module Aws::Backup
|
|
7692
7781
|
#
|
7693
7782
|
# @!attribute [rw] schedule_expression
|
7694
7783
|
# A CRON expression in specified timezone when a restore testing plan
|
7695
|
-
# is executed.
|
7784
|
+
# is executed. When no CRON expression is provided, Backup will use
|
7785
|
+
# the default expression `cron(0 5 ? * * *)`.
|
7696
7786
|
# @return [String]
|
7697
7787
|
#
|
7698
7788
|
# @!attribute [rw] schedule_expression_timezone
|
@@ -7773,7 +7863,8 @@ module Aws::Backup
|
|
7773
7863
|
#
|
7774
7864
|
# @!attribute [rw] schedule_expression
|
7775
7865
|
# A CRON expression in specified timezone when a restore testing plan
|
7776
|
-
# is executed.
|
7866
|
+
# is executed. When no CRON expression is provided, Backup will use
|
7867
|
+
# the default expression `cron(0 5 ? * * *)`.
|
7777
7868
|
# @return [String]
|
7778
7869
|
#
|
7779
7870
|
# @!attribute [rw] schedule_expression_timezone
|
@@ -7844,7 +7935,8 @@ module Aws::Backup
|
|
7844
7935
|
#
|
7845
7936
|
# @!attribute [rw] schedule_expression
|
7846
7937
|
# A CRON expression in specified timezone when a restore testing plan
|
7847
|
-
# is executed.
|
7938
|
+
# is executed. When no CRON expression is provided, Backup will use
|
7939
|
+
# the default expression `cron(0 5 ? * * *)`.
|
7848
7940
|
# @return [String]
|
7849
7941
|
#
|
7850
7942
|
# @!attribute [rw] schedule_expression_timezone
|
@@ -7889,7 +7981,8 @@ module Aws::Backup
|
|
7889
7981
|
#
|
7890
7982
|
# @!attribute [rw] schedule_expression
|
7891
7983
|
# A CRON expression in specified timezone when a restore testing plan
|
7892
|
-
# is executed.
|
7984
|
+
# is executed. When no CRON expression is provided, Backup will use
|
7985
|
+
# the default expression `cron(0 5 ? * * *)`.
|
7893
7986
|
# @return [String]
|
7894
7987
|
#
|
7895
7988
|
# @!attribute [rw] schedule_expression_timezone
|
@@ -8074,7 +8167,7 @@ module Aws::Backup
|
|
8074
8167
|
# @return [String]
|
8075
8168
|
#
|
8076
8169
|
# @!attribute [rw] validation_window_hours
|
8077
|
-
# This is amount of hours (
|
8170
|
+
# This is amount of hours (0 to 168) available to run a validation
|
8078
8171
|
# script on the data. The data will be deleted upon the completion of
|
8079
8172
|
# the validation script or the end of the specified retention period,
|
8080
8173
|
# whichever comes first.
|
@@ -8762,14 +8855,7 @@ module Aws::Backup
|
|
8762
8855
|
end
|
8763
8856
|
|
8764
8857
|
# @!attribute [rw] resource_arn
|
8765
|
-
#
|
8766
|
-
# depends on the type of the tagged resource.
|
8767
|
-
#
|
8768
|
-
# ARNs that do not include `backup` are incompatible with tagging.
|
8769
|
-
# `TagResource` and `UntagResource` with invalid ARNs will result in
|
8770
|
-
# an error. Acceptable ARN content can include
|
8771
|
-
# `arn:aws:backup:us-east`. Invalid ARN content may look like
|
8772
|
-
# `arn:aws:ec2:us-east`.
|
8858
|
+
# The ARN that uniquely identifies the resource.
|
8773
8859
|
# @return [String]
|
8774
8860
|
#
|
8775
8861
|
# @!attribute [rw] tags
|
data/lib/aws-sdk-backup.rb
CHANGED
data/sig/client.rbs
CHANGED
@@ -574,7 +574,7 @@ module Aws
|
|
574
574
|
def resource_type: () -> ::String
|
575
575
|
def created_by: () -> Types::RecoveryPointCreator
|
576
576
|
def iam_role_arn: () -> ::String
|
577
|
-
def status: () -> ("COMPLETED" | "PARTIAL" | "DELETING" | "EXPIRED")
|
577
|
+
def status: () -> ("COMPLETED" | "PARTIAL" | "DELETING" | "EXPIRED" | "AVAILABLE" | "STOPPED" | "CREATING")
|
578
578
|
def status_message: () -> ::String
|
579
579
|
def creation_date: () -> ::Time
|
580
580
|
def completion_date: () -> ::Time
|
@@ -754,7 +754,7 @@ module Aws
|
|
754
754
|
def backup_vault_name: () -> ::String
|
755
755
|
def backup_vault_arn: () -> ::String
|
756
756
|
def sns_topic_arn: () -> ::String
|
757
|
-
def backup_vault_events: () -> ::Array[("BACKUP_JOB_STARTED" | "BACKUP_JOB_COMPLETED" | "BACKUP_JOB_SUCCESSFUL" | "BACKUP_JOB_FAILED" | "BACKUP_JOB_EXPIRED" | "RESTORE_JOB_STARTED" | "RESTORE_JOB_COMPLETED" | "RESTORE_JOB_SUCCESSFUL" | "RESTORE_JOB_FAILED" | "COPY_JOB_STARTED" | "COPY_JOB_SUCCESSFUL" | "COPY_JOB_FAILED" | "RECOVERY_POINT_MODIFIED" | "BACKUP_PLAN_CREATED" | "BACKUP_PLAN_MODIFIED" | "S3_BACKUP_OBJECT_FAILED" | "S3_RESTORE_OBJECT_FAILED")]
|
757
|
+
def backup_vault_events: () -> ::Array[("BACKUP_JOB_STARTED" | "BACKUP_JOB_COMPLETED" | "BACKUP_JOB_SUCCESSFUL" | "BACKUP_JOB_FAILED" | "BACKUP_JOB_EXPIRED" | "RESTORE_JOB_STARTED" | "RESTORE_JOB_COMPLETED" | "RESTORE_JOB_SUCCESSFUL" | "RESTORE_JOB_FAILED" | "COPY_JOB_STARTED" | "COPY_JOB_SUCCESSFUL" | "COPY_JOB_FAILED" | "RECOVERY_POINT_MODIFIED" | "BACKUP_PLAN_CREATED" | "BACKUP_PLAN_MODIFIED" | "S3_BACKUP_OBJECT_FAILED" | "S3_RESTORE_OBJECT_FAILED" | "RECOVERY_POINT_INDEX_COMPLETED" | "RECOVERY_POINT_INDEX_DELETED" | "RECOVERY_POINT_INDEXING_FAILED")]
|
758
758
|
end
|
759
759
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Backup/Client.html#get_backup_vault_notifications-instance_method
|
760
760
|
def get_backup_vault_notifications: (
|
@@ -1267,7 +1267,7 @@ module Aws
|
|
1267
1267
|
def put_backup_vault_notifications: (
|
1268
1268
|
backup_vault_name: ::String,
|
1269
1269
|
sns_topic_arn: ::String,
|
1270
|
-
backup_vault_events: Array[("BACKUP_JOB_STARTED" | "BACKUP_JOB_COMPLETED" | "BACKUP_JOB_SUCCESSFUL" | "BACKUP_JOB_FAILED" | "BACKUP_JOB_EXPIRED" | "RESTORE_JOB_STARTED" | "RESTORE_JOB_COMPLETED" | "RESTORE_JOB_SUCCESSFUL" | "RESTORE_JOB_FAILED" | "COPY_JOB_STARTED" | "COPY_JOB_SUCCESSFUL" | "COPY_JOB_FAILED" | "RECOVERY_POINT_MODIFIED" | "BACKUP_PLAN_CREATED" | "BACKUP_PLAN_MODIFIED" | "S3_BACKUP_OBJECT_FAILED" | "S3_RESTORE_OBJECT_FAILED")]
|
1270
|
+
backup_vault_events: Array[("BACKUP_JOB_STARTED" | "BACKUP_JOB_COMPLETED" | "BACKUP_JOB_SUCCESSFUL" | "BACKUP_JOB_FAILED" | "BACKUP_JOB_EXPIRED" | "RESTORE_JOB_STARTED" | "RESTORE_JOB_COMPLETED" | "RESTORE_JOB_SUCCESSFUL" | "RESTORE_JOB_FAILED" | "COPY_JOB_STARTED" | "COPY_JOB_SUCCESSFUL" | "COPY_JOB_FAILED" | "RECOVERY_POINT_MODIFIED" | "BACKUP_PLAN_CREATED" | "BACKUP_PLAN_MODIFIED" | "S3_BACKUP_OBJECT_FAILED" | "S3_RESTORE_OBJECT_FAILED" | "RECOVERY_POINT_INDEX_COMPLETED" | "RECOVERY_POINT_INDEX_DELETED" | "RECOVERY_POINT_INDEXING_FAILED")]
|
1271
1271
|
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
1272
1272
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
1273
1273
|
|
data/sig/types.rbs
CHANGED
@@ -618,7 +618,7 @@ module Aws::Backup
|
|
618
618
|
attr_accessor resource_type: ::String
|
619
619
|
attr_accessor created_by: Types::RecoveryPointCreator
|
620
620
|
attr_accessor iam_role_arn: ::String
|
621
|
-
attr_accessor status: ("COMPLETED" | "PARTIAL" | "DELETING" | "EXPIRED")
|
621
|
+
attr_accessor status: ("COMPLETED" | "PARTIAL" | "DELETING" | "EXPIRED" | "AVAILABLE" | "STOPPED" | "CREATING")
|
622
622
|
attr_accessor status_message: ::String
|
623
623
|
attr_accessor creation_date: ::Time
|
624
624
|
attr_accessor completion_date: ::Time
|
@@ -810,7 +810,7 @@ module Aws::Backup
|
|
810
810
|
attr_accessor backup_vault_name: ::String
|
811
811
|
attr_accessor backup_vault_arn: ::String
|
812
812
|
attr_accessor sns_topic_arn: ::String
|
813
|
-
attr_accessor backup_vault_events: ::Array[("BACKUP_JOB_STARTED" | "BACKUP_JOB_COMPLETED" | "BACKUP_JOB_SUCCESSFUL" | "BACKUP_JOB_FAILED" | "BACKUP_JOB_EXPIRED" | "RESTORE_JOB_STARTED" | "RESTORE_JOB_COMPLETED" | "RESTORE_JOB_SUCCESSFUL" | "RESTORE_JOB_FAILED" | "COPY_JOB_STARTED" | "COPY_JOB_SUCCESSFUL" | "COPY_JOB_FAILED" | "RECOVERY_POINT_MODIFIED" | "BACKUP_PLAN_CREATED" | "BACKUP_PLAN_MODIFIED" | "S3_BACKUP_OBJECT_FAILED" | "S3_RESTORE_OBJECT_FAILED")]
|
813
|
+
attr_accessor backup_vault_events: ::Array[("BACKUP_JOB_STARTED" | "BACKUP_JOB_COMPLETED" | "BACKUP_JOB_SUCCESSFUL" | "BACKUP_JOB_FAILED" | "BACKUP_JOB_EXPIRED" | "RESTORE_JOB_STARTED" | "RESTORE_JOB_COMPLETED" | "RESTORE_JOB_SUCCESSFUL" | "RESTORE_JOB_FAILED" | "COPY_JOB_STARTED" | "COPY_JOB_SUCCESSFUL" | "COPY_JOB_FAILED" | "RECOVERY_POINT_MODIFIED" | "BACKUP_PLAN_CREATED" | "BACKUP_PLAN_MODIFIED" | "S3_BACKUP_OBJECT_FAILED" | "S3_RESTORE_OBJECT_FAILED" | "RECOVERY_POINT_INDEX_COMPLETED" | "RECOVERY_POINT_INDEX_DELETED" | "RECOVERY_POINT_INDEXING_FAILED")]
|
814
814
|
SENSITIVE: []
|
815
815
|
end
|
816
816
|
|
@@ -1411,7 +1411,7 @@ module Aws::Backup
|
|
1411
1411
|
class PutBackupVaultNotificationsInput
|
1412
1412
|
attr_accessor backup_vault_name: ::String
|
1413
1413
|
attr_accessor sns_topic_arn: ::String
|
1414
|
-
attr_accessor backup_vault_events: ::Array[("BACKUP_JOB_STARTED" | "BACKUP_JOB_COMPLETED" | "BACKUP_JOB_SUCCESSFUL" | "BACKUP_JOB_FAILED" | "BACKUP_JOB_EXPIRED" | "RESTORE_JOB_STARTED" | "RESTORE_JOB_COMPLETED" | "RESTORE_JOB_SUCCESSFUL" | "RESTORE_JOB_FAILED" | "COPY_JOB_STARTED" | "COPY_JOB_SUCCESSFUL" | "COPY_JOB_FAILED" | "RECOVERY_POINT_MODIFIED" | "BACKUP_PLAN_CREATED" | "BACKUP_PLAN_MODIFIED" | "S3_BACKUP_OBJECT_FAILED" | "S3_RESTORE_OBJECT_FAILED")]
|
1414
|
+
attr_accessor backup_vault_events: ::Array[("BACKUP_JOB_STARTED" | "BACKUP_JOB_COMPLETED" | "BACKUP_JOB_SUCCESSFUL" | "BACKUP_JOB_FAILED" | "BACKUP_JOB_EXPIRED" | "RESTORE_JOB_STARTED" | "RESTORE_JOB_COMPLETED" | "RESTORE_JOB_SUCCESSFUL" | "RESTORE_JOB_FAILED" | "COPY_JOB_STARTED" | "COPY_JOB_SUCCESSFUL" | "COPY_JOB_FAILED" | "RECOVERY_POINT_MODIFIED" | "BACKUP_PLAN_CREATED" | "BACKUP_PLAN_MODIFIED" | "S3_BACKUP_OBJECT_FAILED" | "S3_RESTORE_OBJECT_FAILED" | "RECOVERY_POINT_INDEX_COMPLETED" | "RECOVERY_POINT_INDEX_DELETED" | "RECOVERY_POINT_INDEXING_FAILED")]
|
1415
1415
|
SENSITIVE: []
|
1416
1416
|
end
|
1417
1417
|
|
@@ -1431,7 +1431,7 @@ module Aws::Backup
|
|
1431
1431
|
attr_accessor resource_type: ::String
|
1432
1432
|
attr_accessor created_by: Types::RecoveryPointCreator
|
1433
1433
|
attr_accessor iam_role_arn: ::String
|
1434
|
-
attr_accessor status: ("COMPLETED" | "PARTIAL" | "DELETING" | "EXPIRED")
|
1434
|
+
attr_accessor status: ("COMPLETED" | "PARTIAL" | "DELETING" | "EXPIRED" | "AVAILABLE" | "STOPPED" | "CREATING")
|
1435
1435
|
attr_accessor status_message: ::String
|
1436
1436
|
attr_accessor creation_date: ::Time
|
1437
1437
|
attr_accessor completion_date: ::Time
|
@@ -1454,7 +1454,7 @@ module Aws::Backup
|
|
1454
1454
|
class RecoveryPointByResource
|
1455
1455
|
attr_accessor recovery_point_arn: ::String
|
1456
1456
|
attr_accessor creation_date: ::Time
|
1457
|
-
attr_accessor status: ("COMPLETED" | "PARTIAL" | "DELETING" | "EXPIRED")
|
1457
|
+
attr_accessor status: ("COMPLETED" | "PARTIAL" | "DELETING" | "EXPIRED" | "AVAILABLE" | "STOPPED" | "CREATING")
|
1458
1458
|
attr_accessor status_message: ::String
|
1459
1459
|
attr_accessor encryption_key_arn: ::String
|
1460
1460
|
attr_accessor backup_size_bytes: ::Integer
|
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-backup
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.89.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
@@ -18,7 +18,7 @@ dependencies:
|
|
18
18
|
version: '3'
|
19
19
|
- - ">="
|
20
20
|
- !ruby/object:Gem::Version
|
21
|
-
version: 3.
|
21
|
+
version: 3.225.0
|
22
22
|
type: :runtime
|
23
23
|
prerelease: false
|
24
24
|
version_requirements: !ruby/object:Gem::Requirement
|
@@ -28,7 +28,7 @@ dependencies:
|
|
28
28
|
version: '3'
|
29
29
|
- - ">="
|
30
30
|
- !ruby/object:Gem::Version
|
31
|
-
version: 3.
|
31
|
+
version: 3.225.0
|
32
32
|
- !ruby/object:Gem::Dependency
|
33
33
|
name: aws-sigv4
|
34
34
|
requirement: !ruby/object:Gem::Requirement
|
@@ -83,7 +83,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
83
83
|
requirements:
|
84
84
|
- - ">="
|
85
85
|
- !ruby/object:Gem::Version
|
86
|
-
version: '2.
|
86
|
+
version: '2.7'
|
87
87
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
88
88
|
requirements:
|
89
89
|
- - ">="
|