aws-sdk-backup 1.88.0 → 1.90.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 +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-backup/client.rb +301 -52
- data/lib/aws-sdk-backup/client_api.rb +159 -8
- data/lib/aws-sdk-backup/types.rb +492 -84
- data/lib/aws-sdk-backup.rb +2 -2
- data/sig/client.rbs +64 -6
- data/sig/types.rbs +94 -11
- metadata +4 -4
data/lib/aws-sdk-backup/types.rb
CHANGED
@@ -91,6 +91,31 @@ module Aws::Backup
|
|
91
91
|
include Aws::Structure
|
92
92
|
end
|
93
93
|
|
94
|
+
# @!attribute [rw] backup_vault_name
|
95
|
+
# The name of the backup vault to associate with the MPA approval
|
96
|
+
# team.
|
97
|
+
# @return [String]
|
98
|
+
#
|
99
|
+
# @!attribute [rw] mpa_approval_team_arn
|
100
|
+
# The Amazon Resource Name (ARN) of the MPA approval team to associate
|
101
|
+
# with the backup vault.
|
102
|
+
# @return [String]
|
103
|
+
#
|
104
|
+
# @!attribute [rw] requester_comment
|
105
|
+
# A comment provided by the requester explaining the association
|
106
|
+
# request.
|
107
|
+
# @return [String]
|
108
|
+
#
|
109
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/AssociateBackupVaultMpaApprovalTeamInput AWS API Documentation
|
110
|
+
#
|
111
|
+
class AssociateBackupVaultMpaApprovalTeamInput < Struct.new(
|
112
|
+
:backup_vault_name,
|
113
|
+
:mpa_approval_team_arn,
|
114
|
+
:requester_comment)
|
115
|
+
SENSITIVE = [:requester_comment]
|
116
|
+
include Aws::Structure
|
117
|
+
end
|
118
|
+
|
94
119
|
# Contains detailed information about a backup job.
|
95
120
|
#
|
96
121
|
# @!attribute [rw] account_id
|
@@ -153,7 +178,38 @@ module Aws::Backup
|
|
153
178
|
# @return [String]
|
154
179
|
#
|
155
180
|
# @!attribute [rw] backup_size_in_bytes
|
156
|
-
# The size, in bytes, of a backup.
|
181
|
+
# The size, in bytes, of a backup (recovery point).
|
182
|
+
#
|
183
|
+
# This value can render differently depending on the resource type as
|
184
|
+
# Backup pulls in data information from other Amazon Web Services
|
185
|
+
# services. For example, the value returned may show a value of `0`,
|
186
|
+
# which may differ from the anticipated value.
|
187
|
+
#
|
188
|
+
# The expected behavior for values by resource type are described as
|
189
|
+
# follows:
|
190
|
+
#
|
191
|
+
# * Amazon Aurora, Amazon DocumentDB, and Amazon Neptune do not have
|
192
|
+
# this value populate from the operation `GetBackupJobStatus`.
|
193
|
+
#
|
194
|
+
# * For Amazon DynamoDB with advanced features, this value refers to
|
195
|
+
# the size of the recovery point (backup).
|
196
|
+
#
|
197
|
+
# * Amazon EC2 and Amazon EBS show volume size (provisioned storage)
|
198
|
+
# returned as part of this value. Amazon EBS does not return backup
|
199
|
+
# size information; snapshot size will have the same value as the
|
200
|
+
# original resource that was backed up.
|
201
|
+
#
|
202
|
+
# * For Amazon EFS, this value refers to the delta bytes transferred
|
203
|
+
# during a backup.
|
204
|
+
#
|
205
|
+
# * Amazon FSx does not populate this value from the operation
|
206
|
+
# `GetBackupJobStatus` for FSx file systems.
|
207
|
+
#
|
208
|
+
# * An Amazon RDS instance will show as `0`.
|
209
|
+
#
|
210
|
+
# * For virtual machines running VMware, this value is passed to
|
211
|
+
# Backup through an asynchronous workflow, which can mean this
|
212
|
+
# displayed value can under-represent the actual backup size.
|
157
213
|
# @return [Integer]
|
158
214
|
#
|
159
215
|
# @!attribute [rw] iam_role_arn
|
@@ -532,13 +588,19 @@ module Aws::Backup
|
|
532
588
|
#
|
533
589
|
# @!attribute [rw] schedule_expression
|
534
590
|
# A cron expression in UTC specifying when Backup initiates a backup
|
535
|
-
# job.
|
536
|
-
#
|
537
|
-
#
|
538
|
-
#
|
539
|
-
#
|
540
|
-
#
|
541
|
-
#
|
591
|
+
# job. When no CRON expression is provided, Backup will use the
|
592
|
+
# default expression `cron(0 5 ? * * *)`.
|
593
|
+
#
|
594
|
+
# For more information about Amazon Web Services cron expressions, see
|
595
|
+
# [Schedule Expressions for Rules][1] in the *Amazon CloudWatch Events
|
596
|
+
# User Guide*.
|
597
|
+
#
|
598
|
+
# Two examples of Amazon Web Services cron expressions are ` 15 * ? *
|
599
|
+
# * *` (take a backup every hour at 15 minutes past the hour) and `0
|
600
|
+
# 12 * * ? *` (take a backup every day at 12 noon UTC).
|
601
|
+
#
|
602
|
+
# For a table of examples, click the preceding link and scroll down
|
603
|
+
# the page.
|
542
604
|
#
|
543
605
|
#
|
544
606
|
#
|
@@ -661,7 +723,8 @@ module Aws::Backup
|
|
661
723
|
#
|
662
724
|
# @!attribute [rw] schedule_expression
|
663
725
|
# A CRON expression in UTC specifying when Backup initiates a backup
|
664
|
-
# job.
|
726
|
+
# job. When no CRON expression is provided, Backup will use the
|
727
|
+
# default expression `cron(0 5 ? * * *)`.
|
665
728
|
# @return [String]
|
666
729
|
#
|
667
730
|
# @!attribute [rw] start_window_minutes
|
@@ -1584,6 +1647,9 @@ module Aws::Backup
|
|
1584
1647
|
#
|
1585
1648
|
# If used, this parameter must contain 1 to 50 alphanumeric or
|
1586
1649
|
# '-\_.' characters.
|
1650
|
+
#
|
1651
|
+
# **A suitable default value is auto-generated.** You should normally
|
1652
|
+
# not need to pass this option.
|
1587
1653
|
# @return [String]
|
1588
1654
|
#
|
1589
1655
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/CreateBackupPlanInput AWS API Documentation
|
@@ -1650,6 +1716,9 @@ module Aws::Backup
|
|
1650
1716
|
#
|
1651
1717
|
# If used, this parameter must contain 1 to 50 alphanumeric or
|
1652
1718
|
# '-\_.' characters.
|
1719
|
+
#
|
1720
|
+
# **A suitable default value is auto-generated.** You should normally
|
1721
|
+
# not need to pass this option.
|
1653
1722
|
# @return [String]
|
1654
1723
|
#
|
1655
1724
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/CreateBackupSelectionInput AWS API Documentation
|
@@ -1712,6 +1781,9 @@ module Aws::Backup
|
|
1712
1781
|
#
|
1713
1782
|
# If used, this parameter must contain 1 to 50 alphanumeric or
|
1714
1783
|
# '-\_.' characters.
|
1784
|
+
#
|
1785
|
+
# **A suitable default value is auto-generated.** You should normally
|
1786
|
+
# not need to pass this option.
|
1715
1787
|
# @return [String]
|
1716
1788
|
#
|
1717
1789
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/CreateBackupVaultInput AWS API Documentation
|
@@ -1829,6 +1901,9 @@ module Aws::Backup
|
|
1829
1901
|
# This is a user-chosen string used to distinguish between otherwise
|
1830
1902
|
# identical calls. Retrying a successful request with the same
|
1831
1903
|
# idempotency token results in a success message with no action taken.
|
1904
|
+
#
|
1905
|
+
# **A suitable default value is auto-generated.** You should normally
|
1906
|
+
# not need to pass this option.
|
1832
1907
|
# @return [String]
|
1833
1908
|
#
|
1834
1909
|
# @!attribute [rw] recovery_point_selection
|
@@ -1914,6 +1989,9 @@ module Aws::Backup
|
|
1914
1989
|
#
|
1915
1990
|
# This parameter is optional. If used, this parameter must contain 1
|
1916
1991
|
# to 50 alphanumeric or '-\_.' characters.
|
1992
|
+
#
|
1993
|
+
# **A suitable default value is auto-generated.** You should normally
|
1994
|
+
# not need to pass this option.
|
1917
1995
|
# @return [String]
|
1918
1996
|
#
|
1919
1997
|
# @!attribute [rw] min_retention_days
|
@@ -2056,6 +2134,74 @@ module Aws::Backup
|
|
2056
2134
|
include Aws::Structure
|
2057
2135
|
end
|
2058
2136
|
|
2137
|
+
# @!attribute [rw] source_backup_vault_arn
|
2138
|
+
# The ARN of the source backup vault containing the recovery points to
|
2139
|
+
# which temporary access is requested.
|
2140
|
+
# @return [String]
|
2141
|
+
#
|
2142
|
+
# @!attribute [rw] backup_vault_name
|
2143
|
+
# The name of the backup vault to associate with an MPA approval team.
|
2144
|
+
# @return [String]
|
2145
|
+
#
|
2146
|
+
# @!attribute [rw] backup_vault_tags
|
2147
|
+
# Optional tags to assign to the restore access backup vault.
|
2148
|
+
# @return [Hash<String,String>]
|
2149
|
+
#
|
2150
|
+
# @!attribute [rw] creator_request_id
|
2151
|
+
# A unique string that identifies the request and allows failed
|
2152
|
+
# requests to be retried without the risk of executing the operation
|
2153
|
+
# twice.
|
2154
|
+
#
|
2155
|
+
# **A suitable default value is auto-generated.** You should normally
|
2156
|
+
# not need to pass this option.
|
2157
|
+
# @return [String]
|
2158
|
+
#
|
2159
|
+
# @!attribute [rw] requester_comment
|
2160
|
+
# A comment explaining the reason for requesting restore access to the
|
2161
|
+
# backup vault.
|
2162
|
+
# @return [String]
|
2163
|
+
#
|
2164
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/CreateRestoreAccessBackupVaultInput AWS API Documentation
|
2165
|
+
#
|
2166
|
+
class CreateRestoreAccessBackupVaultInput < Struct.new(
|
2167
|
+
:source_backup_vault_arn,
|
2168
|
+
:backup_vault_name,
|
2169
|
+
:backup_vault_tags,
|
2170
|
+
:creator_request_id,
|
2171
|
+
:requester_comment)
|
2172
|
+
SENSITIVE = [:backup_vault_tags, :requester_comment]
|
2173
|
+
include Aws::Structure
|
2174
|
+
end
|
2175
|
+
|
2176
|
+
# @!attribute [rw] restore_access_backup_vault_arn
|
2177
|
+
# The ARN that uniquely identifies the created restore access backup
|
2178
|
+
# vault.
|
2179
|
+
# @return [String]
|
2180
|
+
#
|
2181
|
+
# @!attribute [rw] vault_state
|
2182
|
+
# The current state of the restore access backup vault.
|
2183
|
+
# @return [String]
|
2184
|
+
#
|
2185
|
+
# @!attribute [rw] restore_access_backup_vault_name
|
2186
|
+
# The name of the created restore access backup vault.
|
2187
|
+
# @return [String]
|
2188
|
+
#
|
2189
|
+
# @!attribute [rw] creation_date
|
2190
|
+
# >The date and time when the restore access backup vault was
|
2191
|
+
# created, in Unix format and Coordinated Universal Time
|
2192
|
+
# @return [Time]
|
2193
|
+
#
|
2194
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/CreateRestoreAccessBackupVaultOutput AWS API Documentation
|
2195
|
+
#
|
2196
|
+
class CreateRestoreAccessBackupVaultOutput < Struct.new(
|
2197
|
+
:restore_access_backup_vault_arn,
|
2198
|
+
:vault_state,
|
2199
|
+
:restore_access_backup_vault_name,
|
2200
|
+
:creation_date)
|
2201
|
+
SENSITIVE = []
|
2202
|
+
include Aws::Structure
|
2203
|
+
end
|
2204
|
+
|
2059
2205
|
# @!attribute [rw] creator_request_id
|
2060
2206
|
# This is a unique string that identifies the request and allows
|
2061
2207
|
# failed requests to be retriedwithout the risk of running the
|
@@ -2515,7 +2661,38 @@ module Aws::Backup
|
|
2515
2661
|
# @return [String]
|
2516
2662
|
#
|
2517
2663
|
# @!attribute [rw] backup_size_in_bytes
|
2518
|
-
# The size, in bytes, of a backup.
|
2664
|
+
# The size, in bytes, of a backup (recovery point).
|
2665
|
+
#
|
2666
|
+
# This value can render differently depending on the resource type as
|
2667
|
+
# Backup pulls in data information from other Amazon Web Services
|
2668
|
+
# services. For example, the value returned may show a value of `0`,
|
2669
|
+
# which may differ from the anticipated value.
|
2670
|
+
#
|
2671
|
+
# The expected behavior for values by resource type are described as
|
2672
|
+
# follows:
|
2673
|
+
#
|
2674
|
+
# * Amazon Aurora, Amazon DocumentDB, and Amazon Neptune do not have
|
2675
|
+
# this value populate from the operation `GetBackupJobStatus`.
|
2676
|
+
#
|
2677
|
+
# * For Amazon DynamoDB with advanced features, this value refers to
|
2678
|
+
# the size of the recovery point (backup).
|
2679
|
+
#
|
2680
|
+
# * Amazon EC2 and Amazon EBS show volume size (provisioned storage)
|
2681
|
+
# returned as part of this value. Amazon EBS does not return backup
|
2682
|
+
# size information; snapshot size will have the same value as the
|
2683
|
+
# original resource that was backed up.
|
2684
|
+
#
|
2685
|
+
# * For Amazon EFS, this value refers to the delta bytes transferred
|
2686
|
+
# during a backup.
|
2687
|
+
#
|
2688
|
+
# * Amazon FSx does not populate this value from the operation
|
2689
|
+
# `GetBackupJobStatus` for FSx file systems.
|
2690
|
+
#
|
2691
|
+
# * An Amazon RDS instance will show as `0`.
|
2692
|
+
#
|
2693
|
+
# * For virtual machines running VMware, this value is passed to
|
2694
|
+
# Backup through an asynchronous workflow, which can mean this
|
2695
|
+
# displayed value can under-represent the actual backup size.
|
2519
2696
|
# @return [Integer]
|
2520
2697
|
#
|
2521
2698
|
# @!attribute [rw] iam_role_arn
|
@@ -2706,6 +2883,14 @@ module Aws::Backup
|
|
2706
2883
|
#
|
2707
2884
|
# @!attribute [rw] number_of_recovery_points
|
2708
2885
|
# The number of recovery points that are stored in a backup vault.
|
2886
|
+
#
|
2887
|
+
# Recovery point count value displayed in the console can be an
|
2888
|
+
# approximation. Use [ `ListRecoveryPointsByBackupVault` ][1] API to
|
2889
|
+
# obtain the exact count.
|
2890
|
+
#
|
2891
|
+
#
|
2892
|
+
#
|
2893
|
+
# [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/API_ListRecoveryPointsByBackupVault.html
|
2709
2894
|
# @return [Integer]
|
2710
2895
|
#
|
2711
2896
|
# @!attribute [rw] locked
|
@@ -2759,6 +2944,24 @@ module Aws::Backup
|
|
2759
2944
|
# represents Friday, January 26, 2018 12:11:30.087 AM.
|
2760
2945
|
# @return [Time]
|
2761
2946
|
#
|
2947
|
+
# @!attribute [rw] source_backup_vault_arn
|
2948
|
+
# The ARN of the source backup vault from which this restore access
|
2949
|
+
# backup vault was created.
|
2950
|
+
# @return [String]
|
2951
|
+
#
|
2952
|
+
# @!attribute [rw] mpa_approval_team_arn
|
2953
|
+
# The ARN of the MPA approval team associated with this backup vault.
|
2954
|
+
# @return [String]
|
2955
|
+
#
|
2956
|
+
# @!attribute [rw] mpa_session_arn
|
2957
|
+
# The ARN of the MPA session associated with this backup vault.
|
2958
|
+
# @return [String]
|
2959
|
+
#
|
2960
|
+
# @!attribute [rw] latest_mpa_approval_team_update
|
2961
|
+
# Information about the latest update to the MPA approval team
|
2962
|
+
# association for this backup vault.
|
2963
|
+
# @return [Types::LatestMpaApprovalTeamUpdate]
|
2964
|
+
#
|
2762
2965
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeBackupVaultOutput AWS API Documentation
|
2763
2966
|
#
|
2764
2967
|
class DescribeBackupVaultOutput < Struct.new(
|
@@ -2773,7 +2976,11 @@ module Aws::Backup
|
|
2773
2976
|
:locked,
|
2774
2977
|
:min_retention_days,
|
2775
2978
|
:max_retention_days,
|
2776
|
-
:lock_date
|
2979
|
+
:lock_date,
|
2980
|
+
:source_backup_vault_arn,
|
2981
|
+
:mpa_approval_team_arn,
|
2982
|
+
:mpa_session_arn,
|
2983
|
+
:latest_mpa_approval_team_update)
|
2777
2984
|
SENSITIVE = []
|
2778
2985
|
include Aws::Structure
|
2779
2986
|
end
|
@@ -3062,43 +3269,51 @@ module Aws::Backup
|
|
3062
3269
|
# @return [String]
|
3063
3270
|
#
|
3064
3271
|
# @!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
|
-
#
|
3272
|
+
# A status code specifying the state of the recovery point. For more
|
3273
|
+
# information, see [ Recovery point status][1] in the *Backup
|
3274
|
+
# Developer Guide*.
|
3275
|
+
#
|
3276
|
+
# * `CREATING` status indicates that an Backup job has been initiated
|
3277
|
+
# for a resource. The backup process has started and is actively
|
3278
|
+
# processing a backup job for the associated recovery point.
|
3279
|
+
#
|
3280
|
+
# * `AVAILABLE` status indicates that the backup was successfully
|
3281
|
+
# created for the recovery point. The backup process has completed
|
3282
|
+
# without any issues, and the recovery point is now ready for use.
|
3283
|
+
#
|
3284
|
+
# * `PARTIAL` status indicates a composite recovery point has one or
|
3285
|
+
# more nested recovery points that were not in the backup.
|
3286
|
+
#
|
3287
|
+
# * `EXPIRED` status indicates that the recovery point has exceeded
|
3288
|
+
# its retention period, but Backup lacks permission or is otherwise
|
3289
|
+
# unable to delete it. To manually delete these recovery points, see
|
3290
|
+
# [ Step 3: Delete the recovery points][2] in the *Clean up
|
3291
|
+
# resources* section of *Getting started*.
|
3292
|
+
#
|
3293
|
+
# * `STOPPED` status occurs on a continuous backup where a user has
|
3294
|
+
# taken some action that causes the continuous backup to be
|
3295
|
+
# disabled. This can be caused by the removal of permissions,
|
3296
|
+
# turning off versioning, turning off events being sent to
|
3297
|
+
# EventBridge, or disabling the EventBridge rules that are put in
|
3298
|
+
# place by Backup. For recovery points of Amazon S3, Amazon RDS, and
|
3299
|
+
# Amazon Aurora resources, this status occurs when the retention
|
3300
|
+
# period of a continuous backup rule is changed.
|
3301
|
+
#
|
3302
|
+
# To resolve `STOPPED` status, ensure that all requested permissions
|
3303
|
+
# are in place and that versioning is enabled on the S3 bucket. Once
|
3304
|
+
# these conditions are met, the next instance of a backup rule
|
3305
|
+
# running will result in a new continuous recovery point being
|
3306
|
+
# created. The recovery points with STOPPED status do not need to be
|
3307
|
+
# deleted.
|
3308
|
+
#
|
3309
|
+
# For SAP HANA on Amazon EC2 `STOPPED` status occurs due to user
|
3310
|
+
# action, application misconfiguration, or backup failure. To ensure
|
3311
|
+
# that future continuous backups succeed, refer to the recovery
|
3312
|
+
# point status and check SAP HANA for details.
|
3313
|
+
#
|
3314
|
+
#
|
3315
|
+
#
|
3316
|
+
# [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/applicationstackbackups.html#cfnrecoverypointstatus
|
3102
3317
|
# [2]: https://docs.aws.amazon.com/aws-backup/latest/devguide/gs-cleanup-resources.html#cleanup-backups
|
3103
3318
|
# @return [String]
|
3104
3319
|
#
|
@@ -3113,6 +3328,12 @@ module Aws::Backup
|
|
3113
3328
|
# represents Friday, January 26, 2018 12:11:30.087 AM.
|
3114
3329
|
# @return [Time]
|
3115
3330
|
#
|
3331
|
+
# @!attribute [rw] initiation_date
|
3332
|
+
# The date and time when the backup job that created this recovery
|
3333
|
+
# point was initiated, in Unix format and Coordinated Universal Time
|
3334
|
+
# (UTC).
|
3335
|
+
# @return [Time]
|
3336
|
+
#
|
3116
3337
|
# @!attribute [rw] completion_date
|
3117
3338
|
# The date and time that a job to create a recovery point is
|
3118
3339
|
# completed, in Unix format and Coordinated Universal Time (UTC). The
|
@@ -3234,6 +3455,7 @@ module Aws::Backup
|
|
3234
3455
|
:status,
|
3235
3456
|
:status_message,
|
3236
3457
|
:creation_date,
|
3458
|
+
:initiation_date,
|
3237
3459
|
:completion_date,
|
3238
3460
|
:backup_size_in_bytes,
|
3239
3461
|
:calculated_lifecycle,
|
@@ -3481,6 +3703,25 @@ module Aws::Backup
|
|
3481
3703
|
include Aws::Structure
|
3482
3704
|
end
|
3483
3705
|
|
3706
|
+
# @!attribute [rw] backup_vault_name
|
3707
|
+
# The name of the backup vault from which to disassociate the MPA
|
3708
|
+
# approval team.
|
3709
|
+
# @return [String]
|
3710
|
+
#
|
3711
|
+
# @!attribute [rw] requester_comment
|
3712
|
+
# An optional comment explaining the reason for disassociating the MPA
|
3713
|
+
# approval team from the backup vault.
|
3714
|
+
# @return [String]
|
3715
|
+
#
|
3716
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DisassociateBackupVaultMpaApprovalTeamInput AWS API Documentation
|
3717
|
+
#
|
3718
|
+
class DisassociateBackupVaultMpaApprovalTeamInput < Struct.new(
|
3719
|
+
:backup_vault_name,
|
3720
|
+
:requester_comment)
|
3721
|
+
SENSITIVE = [:requester_comment]
|
3722
|
+
include Aws::Structure
|
3723
|
+
end
|
3724
|
+
|
3484
3725
|
# @!attribute [rw] backup_vault_name
|
3485
3726
|
# The name of a logical container where the child (nested) recovery
|
3486
3727
|
# point is stored. Backup vaults are identified by names that are
|
@@ -4524,6 +4765,77 @@ module Aws::Backup
|
|
4524
4765
|
include Aws::Structure
|
4525
4766
|
end
|
4526
4767
|
|
4768
|
+
# Contains information about the latest update to an MPA approval team
|
4769
|
+
# association.
|
4770
|
+
#
|
4771
|
+
# @!attribute [rw] mpa_session_arn
|
4772
|
+
# The ARN of the MPA session associated with this update.
|
4773
|
+
# @return [String]
|
4774
|
+
#
|
4775
|
+
# @!attribute [rw] status
|
4776
|
+
# The current status of the MPA approval team update.
|
4777
|
+
# @return [String]
|
4778
|
+
#
|
4779
|
+
# @!attribute [rw] status_message
|
4780
|
+
# A message describing the current status of the MPA approval team
|
4781
|
+
# update.
|
4782
|
+
# @return [String]
|
4783
|
+
#
|
4784
|
+
# @!attribute [rw] initiation_date
|
4785
|
+
# The date and time when the MPA approval team update was initiated.
|
4786
|
+
# @return [Time]
|
4787
|
+
#
|
4788
|
+
# @!attribute [rw] expiry_date
|
4789
|
+
# The date and time when the MPA approval team update will expire.
|
4790
|
+
# @return [Time]
|
4791
|
+
#
|
4792
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/LatestMpaApprovalTeamUpdate AWS API Documentation
|
4793
|
+
#
|
4794
|
+
class LatestMpaApprovalTeamUpdate < Struct.new(
|
4795
|
+
:mpa_session_arn,
|
4796
|
+
:status,
|
4797
|
+
:status_message,
|
4798
|
+
:initiation_date,
|
4799
|
+
:expiry_date)
|
4800
|
+
SENSITIVE = []
|
4801
|
+
include Aws::Structure
|
4802
|
+
end
|
4803
|
+
|
4804
|
+
# Contains information about the latest request to revoke access to a
|
4805
|
+
# backup vault.
|
4806
|
+
#
|
4807
|
+
# @!attribute [rw] mpa_session_arn
|
4808
|
+
# The ARN of the MPA session associated with this revoke request.
|
4809
|
+
# @return [String]
|
4810
|
+
#
|
4811
|
+
# @!attribute [rw] status
|
4812
|
+
# The current status of the revoke request.
|
4813
|
+
# @return [String]
|
4814
|
+
#
|
4815
|
+
# @!attribute [rw] status_message
|
4816
|
+
# A message describing the current status of the revoke request.
|
4817
|
+
# @return [String]
|
4818
|
+
#
|
4819
|
+
# @!attribute [rw] initiation_date
|
4820
|
+
# The date and time when the revoke request was initiated.
|
4821
|
+
# @return [Time]
|
4822
|
+
#
|
4823
|
+
# @!attribute [rw] expiry_date
|
4824
|
+
# The date and time when the revoke request will expire.
|
4825
|
+
# @return [Time]
|
4826
|
+
#
|
4827
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/LatestRevokeRequest AWS API Documentation
|
4828
|
+
#
|
4829
|
+
class LatestRevokeRequest < Struct.new(
|
4830
|
+
:mpa_session_arn,
|
4831
|
+
:status,
|
4832
|
+
:status_message,
|
4833
|
+
:initiation_date,
|
4834
|
+
:expiry_date)
|
4835
|
+
SENSITIVE = []
|
4836
|
+
include Aws::Structure
|
4837
|
+
end
|
4838
|
+
|
4527
4839
|
# A legal hold is an administrative tool that helps prevent backups from
|
4528
4840
|
# being deleted while under a hold. While the hold is in place, backups
|
4529
4841
|
# under a hold cannot be deleted and lifecycle policies that would alter
|
@@ -6075,6 +6387,49 @@ module Aws::Backup
|
|
6075
6387
|
include Aws::Structure
|
6076
6388
|
end
|
6077
6389
|
|
6390
|
+
# @!attribute [rw] backup_vault_name
|
6391
|
+
# The name of the backup vault for which to list associated restore
|
6392
|
+
# access backup vaults.
|
6393
|
+
# @return [String]
|
6394
|
+
#
|
6395
|
+
# @!attribute [rw] next_token
|
6396
|
+
# The pagination token from a previous request to retrieve the next
|
6397
|
+
# set of results.
|
6398
|
+
# @return [String]
|
6399
|
+
#
|
6400
|
+
# @!attribute [rw] max_results
|
6401
|
+
# The maximum number of items to return in the response.
|
6402
|
+
# @return [Integer]
|
6403
|
+
#
|
6404
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListRestoreAccessBackupVaultsInput AWS API Documentation
|
6405
|
+
#
|
6406
|
+
class ListRestoreAccessBackupVaultsInput < Struct.new(
|
6407
|
+
:backup_vault_name,
|
6408
|
+
:next_token,
|
6409
|
+
:max_results)
|
6410
|
+
SENSITIVE = []
|
6411
|
+
include Aws::Structure
|
6412
|
+
end
|
6413
|
+
|
6414
|
+
# @!attribute [rw] next_token
|
6415
|
+
# The pagination token to use in a subsequent request to retrieve the
|
6416
|
+
# next set of results.
|
6417
|
+
# @return [String]
|
6418
|
+
#
|
6419
|
+
# @!attribute [rw] restore_access_backup_vaults
|
6420
|
+
# A list of restore access backup vaults associated with the specified
|
6421
|
+
# backup vault.
|
6422
|
+
# @return [Array<Types::RestoreAccessBackupVaultListMember>]
|
6423
|
+
#
|
6424
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListRestoreAccessBackupVaultsOutput AWS API Documentation
|
6425
|
+
#
|
6426
|
+
class ListRestoreAccessBackupVaultsOutput < Struct.new(
|
6427
|
+
:next_token,
|
6428
|
+
:restore_access_backup_vaults)
|
6429
|
+
SENSITIVE = []
|
6430
|
+
include Aws::Structure
|
6431
|
+
end
|
6432
|
+
|
6078
6433
|
# @!attribute [rw] account_id
|
6079
6434
|
# Returns the job count for the specified account.
|
6080
6435
|
#
|
@@ -6717,32 +7072,13 @@ module Aws::Backup
|
|
6717
7072
|
#
|
6718
7073
|
# @!attribute [rw] backup_vault_events
|
6719
7074
|
# An array of events that indicate the status of jobs to back up
|
6720
|
-
# resources to the backup vault.
|
6721
|
-
#
|
6722
|
-
#
|
6723
|
-
# track Backup events][1].
|
6724
|
-
#
|
6725
|
-
# The following events are supported:
|
7075
|
+
# resources to the backup vault. For the list of supported events,
|
7076
|
+
# common use cases, and code samples, see [Notification options with
|
7077
|
+
# Backup][1].
|
6726
7078
|
#
|
6727
|
-
# * `BACKUP_JOB_STARTED` \| `BACKUP_JOB_COMPLETED`
|
6728
7079
|
#
|
6729
|
-
# * `COPY_JOB_STARTED` \| `COPY_JOB_SUCCESSFUL` \| `COPY_JOB_FAILED`
|
6730
7080
|
#
|
6731
|
-
#
|
6732
|
-
# `RECOVERY_POINT_MODIFIED`
|
6733
|
-
#
|
6734
|
-
# * `S3_BACKUP_OBJECT_FAILED` \| `S3_RESTORE_OBJECT_FAILED`
|
6735
|
-
#
|
6736
|
-
# <note markdown="1"> The list below includes both supported events and deprecated events
|
6737
|
-
# that are no longer in use (for reference). Deprecated events do not
|
6738
|
-
# return statuses or notifications. Refer to the list above for the
|
6739
|
-
# supported events.
|
6740
|
-
#
|
6741
|
-
# </note>
|
6742
|
-
#
|
6743
|
-
#
|
6744
|
-
#
|
6745
|
-
# [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/sns-notifications.html
|
7081
|
+
# [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-notifications.html
|
6746
7082
|
# @return [Array<String>]
|
6747
7083
|
#
|
6748
7084
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/PutBackupVaultNotificationsInput AWS API Documentation
|
@@ -6845,6 +7181,12 @@ module Aws::Backup
|
|
6845
7181
|
# represents Friday, January 26, 2018 12:11:30.087 AM.
|
6846
7182
|
# @return [Time]
|
6847
7183
|
#
|
7184
|
+
# @!attribute [rw] initiation_date
|
7185
|
+
# The date and time when the backup job that created this recovery
|
7186
|
+
# point was initiated, in Unix format and Coordinated Universal Time
|
7187
|
+
# (UTC).
|
7188
|
+
# @return [Time]
|
7189
|
+
#
|
6848
7190
|
# @!attribute [rw] completion_date
|
6849
7191
|
# The date and time a job to restore a recovery point is completed, in
|
6850
7192
|
# Unix format and Coordinated Universal Time (UTC). The value of
|
@@ -6959,6 +7301,7 @@ module Aws::Backup
|
|
6959
7301
|
:status,
|
6960
7302
|
:status_message,
|
6961
7303
|
:creation_date,
|
7304
|
+
:initiation_date,
|
6962
7305
|
:completion_date,
|
6963
7306
|
:backup_size_in_bytes,
|
6964
7307
|
:calculated_lifecycle,
|
@@ -7451,6 +7794,41 @@ module Aws::Backup
|
|
7451
7794
|
include Aws::Structure
|
7452
7795
|
end
|
7453
7796
|
|
7797
|
+
# Contains information about a restore access backup vault.
|
7798
|
+
#
|
7799
|
+
# @!attribute [rw] restore_access_backup_vault_arn
|
7800
|
+
# The ARN of the restore access backup vault.
|
7801
|
+
# @return [String]
|
7802
|
+
#
|
7803
|
+
# @!attribute [rw] creation_date
|
7804
|
+
# The date and time when the restore access backup vault was created.
|
7805
|
+
# @return [Time]
|
7806
|
+
#
|
7807
|
+
# @!attribute [rw] approval_date
|
7808
|
+
# The date and time when the restore access backup vault was approved.
|
7809
|
+
# @return [Time]
|
7810
|
+
#
|
7811
|
+
# @!attribute [rw] vault_state
|
7812
|
+
# The current state of the restore access backup vault.
|
7813
|
+
# @return [String]
|
7814
|
+
#
|
7815
|
+
# @!attribute [rw] latest_revoke_request
|
7816
|
+
# Information about the latest request to revoke access to this backup
|
7817
|
+
# vault.
|
7818
|
+
# @return [Types::LatestRevokeRequest]
|
7819
|
+
#
|
7820
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/RestoreAccessBackupVaultListMember AWS API Documentation
|
7821
|
+
#
|
7822
|
+
class RestoreAccessBackupVaultListMember < Struct.new(
|
7823
|
+
:restore_access_backup_vault_arn,
|
7824
|
+
:creation_date,
|
7825
|
+
:approval_date,
|
7826
|
+
:vault_state,
|
7827
|
+
:latest_revoke_request)
|
7828
|
+
SENSITIVE = []
|
7829
|
+
include Aws::Structure
|
7830
|
+
end
|
7831
|
+
|
7454
7832
|
# Contains information about the restore testing plan that Backup used
|
7455
7833
|
# to initiate the restore job.
|
7456
7834
|
#
|
@@ -7692,7 +8070,8 @@ module Aws::Backup
|
|
7692
8070
|
#
|
7693
8071
|
# @!attribute [rw] schedule_expression
|
7694
8072
|
# A CRON expression in specified timezone when a restore testing plan
|
7695
|
-
# is executed.
|
8073
|
+
# is executed. When no CRON expression is provided, Backup will use
|
8074
|
+
# the default expression `cron(0 5 ? * * *)`.
|
7696
8075
|
# @return [String]
|
7697
8076
|
#
|
7698
8077
|
# @!attribute [rw] schedule_expression_timezone
|
@@ -7773,7 +8152,8 @@ module Aws::Backup
|
|
7773
8152
|
#
|
7774
8153
|
# @!attribute [rw] schedule_expression
|
7775
8154
|
# A CRON expression in specified timezone when a restore testing plan
|
7776
|
-
# is executed.
|
8155
|
+
# is executed. When no CRON expression is provided, Backup will use
|
8156
|
+
# the default expression `cron(0 5 ? * * *)`.
|
7777
8157
|
# @return [String]
|
7778
8158
|
#
|
7779
8159
|
# @!attribute [rw] schedule_expression_timezone
|
@@ -7844,7 +8224,8 @@ module Aws::Backup
|
|
7844
8224
|
#
|
7845
8225
|
# @!attribute [rw] schedule_expression
|
7846
8226
|
# A CRON expression in specified timezone when a restore testing plan
|
7847
|
-
# is executed.
|
8227
|
+
# is executed. When no CRON expression is provided, Backup will use
|
8228
|
+
# the default expression `cron(0 5 ? * * *)`.
|
7848
8229
|
# @return [String]
|
7849
8230
|
#
|
7850
8231
|
# @!attribute [rw] schedule_expression_timezone
|
@@ -7889,7 +8270,8 @@ module Aws::Backup
|
|
7889
8270
|
#
|
7890
8271
|
# @!attribute [rw] schedule_expression
|
7891
8272
|
# A CRON expression in specified timezone when a restore testing plan
|
7892
|
-
# is executed.
|
8273
|
+
# is executed. When no CRON expression is provided, Backup will use
|
8274
|
+
# the default expression `cron(0 5 ? * * *)`.
|
7893
8275
|
# @return [String]
|
7894
8276
|
#
|
7895
8277
|
# @!attribute [rw] schedule_expression_timezone
|
@@ -8074,7 +8456,7 @@ module Aws::Backup
|
|
8074
8456
|
# @return [String]
|
8075
8457
|
#
|
8076
8458
|
# @!attribute [rw] validation_window_hours
|
8077
|
-
# This is amount of hours (
|
8459
|
+
# This is amount of hours (0 to 168) available to run a validation
|
8078
8460
|
# script on the data. The data will be deleted upon the completion of
|
8079
8461
|
# the validation script or the end of the specified retention period,
|
8080
8462
|
# whichever comes first.
|
@@ -8286,6 +8668,30 @@ module Aws::Backup
|
|
8286
8668
|
include Aws::Structure
|
8287
8669
|
end
|
8288
8670
|
|
8671
|
+
# @!attribute [rw] backup_vault_name
|
8672
|
+
# The name of the source backup vault associated with the restore
|
8673
|
+
# access backup vault to be revoked.
|
8674
|
+
# @return [String]
|
8675
|
+
#
|
8676
|
+
# @!attribute [rw] restore_access_backup_vault_arn
|
8677
|
+
# The ARN of the restore access backup vault to revoke.
|
8678
|
+
# @return [String]
|
8679
|
+
#
|
8680
|
+
# @!attribute [rw] requester_comment
|
8681
|
+
# A comment explaining the reason for revoking access to the restore
|
8682
|
+
# access backup vault.
|
8683
|
+
# @return [String]
|
8684
|
+
#
|
8685
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/RevokeRestoreAccessBackupVaultInput AWS API Documentation
|
8686
|
+
#
|
8687
|
+
class RevokeRestoreAccessBackupVaultInput < Struct.new(
|
8688
|
+
:backup_vault_name,
|
8689
|
+
:restore_access_backup_vault_arn,
|
8690
|
+
:requester_comment)
|
8691
|
+
SENSITIVE = [:requester_comment]
|
8692
|
+
include Aws::Structure
|
8693
|
+
end
|
8694
|
+
|
8289
8695
|
# The request failed due to a temporary failure of the server.
|
8290
8696
|
#
|
8291
8697
|
# @!attribute [rw] code
|
@@ -8333,6 +8739,9 @@ module Aws::Backup
|
|
8333
8739
|
# otherwise identical calls to `StartBackupJob`. Retrying a successful
|
8334
8740
|
# request with the same idempotency token results in a success message
|
8335
8741
|
# with no action taken.
|
8742
|
+
#
|
8743
|
+
# **A suitable default value is auto-generated.** You should normally
|
8744
|
+
# not need to pass this option.
|
8336
8745
|
# @return [String]
|
8337
8746
|
#
|
8338
8747
|
# @!attribute [rw] start_window_minutes
|
@@ -8501,6 +8910,9 @@ module Aws::Backup
|
|
8501
8910
|
# otherwise identical calls to `StartCopyJob`. Retrying a successful
|
8502
8911
|
# request with the same idempotency token results in a success message
|
8503
8912
|
# with no action taken.
|
8913
|
+
#
|
8914
|
+
# **A suitable default value is auto-generated.** You should normally
|
8915
|
+
# not need to pass this option.
|
8504
8916
|
# @return [String]
|
8505
8917
|
#
|
8506
8918
|
# @!attribute [rw] lifecycle
|
@@ -8680,6 +9092,9 @@ module Aws::Backup
|
|
8680
9092
|
# otherwise identical calls to `StartRestoreJob`. Retrying a
|
8681
9093
|
# successful request with the same idempotency token results in a
|
8682
9094
|
# success message with no action taken.
|
9095
|
+
#
|
9096
|
+
# **A suitable default value is auto-generated.** You should normally
|
9097
|
+
# not need to pass this option.
|
8683
9098
|
# @return [String]
|
8684
9099
|
#
|
8685
9100
|
# @!attribute [rw] resource_type
|
@@ -8762,14 +9177,7 @@ module Aws::Backup
|
|
8762
9177
|
end
|
8763
9178
|
|
8764
9179
|
# @!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`.
|
9180
|
+
# The ARN that uniquely identifies the resource.
|
8773
9181
|
# @return [String]
|
8774
9182
|
#
|
8775
9183
|
# @!attribute [rw] tags
|