aws-sdk-backup 1.17.0 → 1.22.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/lib/aws-sdk-backup.rb +3 -2
- data/lib/aws-sdk-backup/client.rb +179 -44
- data/lib/aws-sdk-backup/client_api.rb +39 -1
- data/lib/aws-sdk-backup/types.rb +299 -61
- metadata +2 -2
@@ -14,10 +14,16 @@ module Aws::Backup
|
|
14
14
|
include Seahorse::Model
|
15
15
|
|
16
16
|
ARN = Shapes::StringShape.new(name: 'ARN')
|
17
|
+
AccountId = Shapes::StringShape.new(name: 'AccountId')
|
18
|
+
AdvancedBackupSetting = Shapes::StructureShape.new(name: 'AdvancedBackupSetting')
|
19
|
+
AdvancedBackupSettings = Shapes::ListShape.new(name: 'AdvancedBackupSettings')
|
17
20
|
AlreadyExistsException = Shapes::StructureShape.new(name: 'AlreadyExistsException')
|
18
21
|
BackupJob = Shapes::StructureShape.new(name: 'BackupJob')
|
19
22
|
BackupJobState = Shapes::StringShape.new(name: 'BackupJobState')
|
20
23
|
BackupJobsList = Shapes::ListShape.new(name: 'BackupJobsList')
|
24
|
+
BackupOptionKey = Shapes::StringShape.new(name: 'BackupOptionKey')
|
25
|
+
BackupOptionValue = Shapes::StringShape.new(name: 'BackupOptionValue')
|
26
|
+
BackupOptions = Shapes::MapShape.new(name: 'BackupOptions')
|
21
27
|
BackupPlan = Shapes::StructureShape.new(name: 'BackupPlan')
|
22
28
|
BackupPlanInput = Shapes::StructureShape.new(name: 'BackupPlanInput')
|
23
29
|
BackupPlanName = Shapes::StringShape.new(name: 'BackupPlanName')
|
@@ -180,6 +186,12 @@ module Aws::Backup
|
|
180
186
|
string = Shapes::StringShape.new(name: 'string')
|
181
187
|
timestamp = Shapes::TimestampShape.new(name: 'timestamp')
|
182
188
|
|
189
|
+
AdvancedBackupSetting.add_member(:resource_type, Shapes::ShapeRef.new(shape: ResourceType, location_name: "ResourceType"))
|
190
|
+
AdvancedBackupSetting.add_member(:backup_options, Shapes::ShapeRef.new(shape: BackupOptions, location_name: "BackupOptions"))
|
191
|
+
AdvancedBackupSetting.struct_class = Types::AdvancedBackupSetting
|
192
|
+
|
193
|
+
AdvancedBackupSettings.member = Shapes::ShapeRef.new(shape: AdvancedBackupSetting)
|
194
|
+
|
183
195
|
AlreadyExistsException.add_member(:code, Shapes::ShapeRef.new(shape: string, location_name: "Code"))
|
184
196
|
AlreadyExistsException.add_member(:message, Shapes::ShapeRef.new(shape: string, location_name: "Message"))
|
185
197
|
AlreadyExistsException.add_member(:creator_request_id, Shapes::ShapeRef.new(shape: string, location_name: "CreatorRequestId"))
|
@@ -188,6 +200,7 @@ module Aws::Backup
|
|
188
200
|
AlreadyExistsException.add_member(:context, Shapes::ShapeRef.new(shape: string, location_name: "Context"))
|
189
201
|
AlreadyExistsException.struct_class = Types::AlreadyExistsException
|
190
202
|
|
203
|
+
BackupJob.add_member(:account_id, Shapes::ShapeRef.new(shape: AccountId, location_name: "AccountId"))
|
191
204
|
BackupJob.add_member(:backup_job_id, Shapes::ShapeRef.new(shape: string, location_name: "BackupJobId"))
|
192
205
|
BackupJob.add_member(:backup_vault_name, Shapes::ShapeRef.new(shape: BackupVaultName, location_name: "BackupVaultName"))
|
193
206
|
BackupJob.add_member(:backup_vault_arn, Shapes::ShapeRef.new(shape: ARN, location_name: "BackupVaultArn"))
|
@@ -205,16 +218,23 @@ module Aws::Backup
|
|
205
218
|
BackupJob.add_member(:start_by, Shapes::ShapeRef.new(shape: timestamp, location_name: "StartBy"))
|
206
219
|
BackupJob.add_member(:resource_type, Shapes::ShapeRef.new(shape: ResourceType, location_name: "ResourceType"))
|
207
220
|
BackupJob.add_member(:bytes_transferred, Shapes::ShapeRef.new(shape: Long, location_name: "BytesTransferred"))
|
221
|
+
BackupJob.add_member(:backup_options, Shapes::ShapeRef.new(shape: BackupOptions, location_name: "BackupOptions"))
|
222
|
+
BackupJob.add_member(:backup_type, Shapes::ShapeRef.new(shape: string, location_name: "BackupType"))
|
208
223
|
BackupJob.struct_class = Types::BackupJob
|
209
224
|
|
210
225
|
BackupJobsList.member = Shapes::ShapeRef.new(shape: BackupJob)
|
211
226
|
|
227
|
+
BackupOptions.key = Shapes::ShapeRef.new(shape: BackupOptionKey)
|
228
|
+
BackupOptions.value = Shapes::ShapeRef.new(shape: BackupOptionValue)
|
229
|
+
|
212
230
|
BackupPlan.add_member(:backup_plan_name, Shapes::ShapeRef.new(shape: BackupPlanName, required: true, location_name: "BackupPlanName"))
|
213
231
|
BackupPlan.add_member(:rules, Shapes::ShapeRef.new(shape: BackupRules, required: true, location_name: "Rules"))
|
232
|
+
BackupPlan.add_member(:advanced_backup_settings, Shapes::ShapeRef.new(shape: AdvancedBackupSettings, location_name: "AdvancedBackupSettings"))
|
214
233
|
BackupPlan.struct_class = Types::BackupPlan
|
215
234
|
|
216
235
|
BackupPlanInput.add_member(:backup_plan_name, Shapes::ShapeRef.new(shape: BackupPlanName, required: true, location_name: "BackupPlanName"))
|
217
236
|
BackupPlanInput.add_member(:rules, Shapes::ShapeRef.new(shape: BackupRulesInput, required: true, location_name: "Rules"))
|
237
|
+
BackupPlanInput.add_member(:advanced_backup_settings, Shapes::ShapeRef.new(shape: AdvancedBackupSettings, location_name: "AdvancedBackupSettings"))
|
218
238
|
BackupPlanInput.struct_class = Types::BackupPlanInput
|
219
239
|
|
220
240
|
BackupPlanTemplatesList.member = Shapes::ShapeRef.new(shape: BackupPlanTemplatesListMember)
|
@@ -235,6 +255,7 @@ module Aws::Backup
|
|
235
255
|
BackupPlansListMember.add_member(:backup_plan_name, Shapes::ShapeRef.new(shape: BackupPlanName, location_name: "BackupPlanName"))
|
236
256
|
BackupPlansListMember.add_member(:creator_request_id, Shapes::ShapeRef.new(shape: string, location_name: "CreatorRequestId"))
|
237
257
|
BackupPlansListMember.add_member(:last_execution_date, Shapes::ShapeRef.new(shape: timestamp, location_name: "LastExecutionDate"))
|
258
|
+
BackupPlansListMember.add_member(:advanced_backup_settings, Shapes::ShapeRef.new(shape: AdvancedBackupSettings, location_name: "AdvancedBackupSettings"))
|
238
259
|
BackupPlansListMember.struct_class = Types::BackupPlansListMember
|
239
260
|
|
240
261
|
BackupRule.add_member(:rule_name, Shapes::ShapeRef.new(shape: BackupRuleName, required: true, location_name: "RuleName"))
|
@@ -305,6 +326,7 @@ module Aws::Backup
|
|
305
326
|
|
306
327
|
CopyActions.member = Shapes::ShapeRef.new(shape: CopyAction)
|
307
328
|
|
329
|
+
CopyJob.add_member(:account_id, Shapes::ShapeRef.new(shape: AccountId, location_name: "AccountId"))
|
308
330
|
CopyJob.add_member(:copy_job_id, Shapes::ShapeRef.new(shape: string, location_name: "CopyJobId"))
|
309
331
|
CopyJob.add_member(:source_backup_vault_arn, Shapes::ShapeRef.new(shape: ARN, location_name: "SourceBackupVaultArn"))
|
310
332
|
CopyJob.add_member(:source_recovery_point_arn, Shapes::ShapeRef.new(shape: ARN, location_name: "SourceRecoveryPointArn"))
|
@@ -332,6 +354,7 @@ module Aws::Backup
|
|
332
354
|
CreateBackupPlanOutput.add_member(:backup_plan_arn, Shapes::ShapeRef.new(shape: ARN, location_name: "BackupPlanArn"))
|
333
355
|
CreateBackupPlanOutput.add_member(:creation_date, Shapes::ShapeRef.new(shape: timestamp, location_name: "CreationDate"))
|
334
356
|
CreateBackupPlanOutput.add_member(:version_id, Shapes::ShapeRef.new(shape: string, location_name: "VersionId"))
|
357
|
+
CreateBackupPlanOutput.add_member(:advanced_backup_settings, Shapes::ShapeRef.new(shape: AdvancedBackupSettings, location_name: "AdvancedBackupSettings"))
|
335
358
|
CreateBackupPlanOutput.struct_class = Types::CreateBackupPlanOutput
|
336
359
|
|
337
360
|
CreateBackupSelectionInput.add_member(:backup_plan_id, Shapes::ShapeRef.new(shape: string, required: true, location: "uri", location_name: "backupPlanId"))
|
@@ -390,6 +413,7 @@ module Aws::Backup
|
|
390
413
|
DescribeBackupJobInput.add_member(:backup_job_id, Shapes::ShapeRef.new(shape: string, required: true, location: "uri", location_name: "backupJobId"))
|
391
414
|
DescribeBackupJobInput.struct_class = Types::DescribeBackupJobInput
|
392
415
|
|
416
|
+
DescribeBackupJobOutput.add_member(:account_id, Shapes::ShapeRef.new(shape: AccountId, location_name: "AccountId"))
|
393
417
|
DescribeBackupJobOutput.add_member(:backup_job_id, Shapes::ShapeRef.new(shape: string, location_name: "BackupJobId"))
|
394
418
|
DescribeBackupJobOutput.add_member(:backup_vault_name, Shapes::ShapeRef.new(shape: BackupVaultName, location_name: "BackupVaultName"))
|
395
419
|
DescribeBackupJobOutput.add_member(:backup_vault_arn, Shapes::ShapeRef.new(shape: ARN, location_name: "BackupVaultArn"))
|
@@ -407,6 +431,8 @@ module Aws::Backup
|
|
407
431
|
DescribeBackupJobOutput.add_member(:bytes_transferred, Shapes::ShapeRef.new(shape: Long, location_name: "BytesTransferred"))
|
408
432
|
DescribeBackupJobOutput.add_member(:expected_completion_date, Shapes::ShapeRef.new(shape: timestamp, location_name: "ExpectedCompletionDate"))
|
409
433
|
DescribeBackupJobOutput.add_member(:start_by, Shapes::ShapeRef.new(shape: timestamp, location_name: "StartBy"))
|
434
|
+
DescribeBackupJobOutput.add_member(:backup_options, Shapes::ShapeRef.new(shape: BackupOptions, location_name: "BackupOptions"))
|
435
|
+
DescribeBackupJobOutput.add_member(:backup_type, Shapes::ShapeRef.new(shape: string, location_name: "BackupType"))
|
410
436
|
DescribeBackupJobOutput.struct_class = Types::DescribeBackupJobOutput
|
411
437
|
|
412
438
|
DescribeBackupVaultInput.add_member(:backup_vault_name, Shapes::ShapeRef.new(shape: string, required: true, location: "uri", location_name: "backupVaultName"))
|
@@ -465,6 +491,7 @@ module Aws::Backup
|
|
465
491
|
DescribeRestoreJobInput.add_member(:restore_job_id, Shapes::ShapeRef.new(shape: RestoreJobId, required: true, location: "uri", location_name: "restoreJobId"))
|
466
492
|
DescribeRestoreJobInput.struct_class = Types::DescribeRestoreJobInput
|
467
493
|
|
494
|
+
DescribeRestoreJobOutput.add_member(:account_id, Shapes::ShapeRef.new(shape: AccountId, location_name: "AccountId"))
|
468
495
|
DescribeRestoreJobOutput.add_member(:restore_job_id, Shapes::ShapeRef.new(shape: string, location_name: "RestoreJobId"))
|
469
496
|
DescribeRestoreJobOutput.add_member(:recovery_point_arn, Shapes::ShapeRef.new(shape: ARN, location_name: "RecoveryPointArn"))
|
470
497
|
DescribeRestoreJobOutput.add_member(:creation_date, Shapes::ShapeRef.new(shape: timestamp, location_name: "CreationDate"))
|
@@ -476,6 +503,7 @@ module Aws::Backup
|
|
476
503
|
DescribeRestoreJobOutput.add_member(:iam_role_arn, Shapes::ShapeRef.new(shape: IAMRoleArn, location_name: "IamRoleArn"))
|
477
504
|
DescribeRestoreJobOutput.add_member(:expected_completion_time_minutes, Shapes::ShapeRef.new(shape: Long, location_name: "ExpectedCompletionTimeMinutes"))
|
478
505
|
DescribeRestoreJobOutput.add_member(:created_resource_arn, Shapes::ShapeRef.new(shape: ARN, location_name: "CreatedResourceArn"))
|
506
|
+
DescribeRestoreJobOutput.add_member(:resource_type, Shapes::ShapeRef.new(shape: ResourceType, location_name: "ResourceType"))
|
479
507
|
DescribeRestoreJobOutput.struct_class = Types::DescribeRestoreJobOutput
|
480
508
|
|
481
509
|
ExportBackupPlanTemplateInput.add_member(:backup_plan_id, Shapes::ShapeRef.new(shape: string, required: true, location: "uri", location_name: "backupPlanId"))
|
@@ -508,6 +536,7 @@ module Aws::Backup
|
|
508
536
|
GetBackupPlanOutput.add_member(:creation_date, Shapes::ShapeRef.new(shape: timestamp, location_name: "CreationDate"))
|
509
537
|
GetBackupPlanOutput.add_member(:deletion_date, Shapes::ShapeRef.new(shape: timestamp, location_name: "DeletionDate"))
|
510
538
|
GetBackupPlanOutput.add_member(:last_execution_date, Shapes::ShapeRef.new(shape: timestamp, location_name: "LastExecutionDate"))
|
539
|
+
GetBackupPlanOutput.add_member(:advanced_backup_settings, Shapes::ShapeRef.new(shape: AdvancedBackupSettings, location_name: "AdvancedBackupSettings"))
|
511
540
|
GetBackupPlanOutput.struct_class = Types::GetBackupPlanOutput
|
512
541
|
|
513
542
|
GetBackupSelectionInput.add_member(:backup_plan_id, Shapes::ShapeRef.new(shape: string, required: true, location: "uri", location_name: "backupPlanId"))
|
@@ -580,6 +609,7 @@ module Aws::Backup
|
|
580
609
|
ListBackupJobsInput.add_member(:by_created_before, Shapes::ShapeRef.new(shape: timestamp, location: "querystring", location_name: "createdBefore"))
|
581
610
|
ListBackupJobsInput.add_member(:by_created_after, Shapes::ShapeRef.new(shape: timestamp, location: "querystring", location_name: "createdAfter"))
|
582
611
|
ListBackupJobsInput.add_member(:by_resource_type, Shapes::ShapeRef.new(shape: ResourceType, location: "querystring", location_name: "resourceType"))
|
612
|
+
ListBackupJobsInput.add_member(:by_account_id, Shapes::ShapeRef.new(shape: AccountId, location: "querystring", location_name: "accountId"))
|
583
613
|
ListBackupJobsInput.struct_class = Types::ListBackupJobsInput
|
584
614
|
|
585
615
|
ListBackupJobsOutput.add_member(:backup_jobs, Shapes::ShapeRef.new(shape: BackupJobsList, location_name: "BackupJobs"))
|
@@ -637,6 +667,7 @@ module Aws::Backup
|
|
637
667
|
ListCopyJobsInput.add_member(:by_created_after, Shapes::ShapeRef.new(shape: timestamp, location: "querystring", location_name: "createdAfter"))
|
638
668
|
ListCopyJobsInput.add_member(:by_resource_type, Shapes::ShapeRef.new(shape: ResourceType, location: "querystring", location_name: "resourceType"))
|
639
669
|
ListCopyJobsInput.add_member(:by_destination_vault_arn, Shapes::ShapeRef.new(shape: string, location: "querystring", location_name: "destinationVaultArn"))
|
670
|
+
ListCopyJobsInput.add_member(:by_account_id, Shapes::ShapeRef.new(shape: AccountId, location: "querystring", location_name: "accountId"))
|
640
671
|
ListCopyJobsInput.struct_class = Types::ListCopyJobsInput
|
641
672
|
|
642
673
|
ListCopyJobsOutput.add_member(:copy_jobs, Shapes::ShapeRef.new(shape: CopyJobsList, location_name: "CopyJobs"))
|
@@ -678,6 +709,10 @@ module Aws::Backup
|
|
678
709
|
|
679
710
|
ListRestoreJobsInput.add_member(:next_token, Shapes::ShapeRef.new(shape: string, location: "querystring", location_name: "nextToken"))
|
680
711
|
ListRestoreJobsInput.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location: "querystring", location_name: "maxResults"))
|
712
|
+
ListRestoreJobsInput.add_member(:by_account_id, Shapes::ShapeRef.new(shape: AccountId, location: "querystring", location_name: "accountId"))
|
713
|
+
ListRestoreJobsInput.add_member(:by_created_before, Shapes::ShapeRef.new(shape: timestamp, location: "querystring", location_name: "createdBefore"))
|
714
|
+
ListRestoreJobsInput.add_member(:by_created_after, Shapes::ShapeRef.new(shape: timestamp, location: "querystring", location_name: "createdAfter"))
|
715
|
+
ListRestoreJobsInput.add_member(:by_status, Shapes::ShapeRef.new(shape: RestoreJobStatus, location: "querystring", location_name: "status"))
|
681
716
|
ListRestoreJobsInput.struct_class = Types::ListRestoreJobsInput
|
682
717
|
|
683
718
|
ListRestoreJobsOutput.add_member(:restore_jobs, Shapes::ShapeRef.new(shape: RestoreJobsList, location_name: "RestoreJobs"))
|
@@ -769,6 +804,7 @@ module Aws::Backup
|
|
769
804
|
|
770
805
|
RestoreJobsList.member = Shapes::ShapeRef.new(shape: RestoreJobsListMember)
|
771
806
|
|
807
|
+
RestoreJobsListMember.add_member(:account_id, Shapes::ShapeRef.new(shape: AccountId, location_name: "AccountId"))
|
772
808
|
RestoreJobsListMember.add_member(:restore_job_id, Shapes::ShapeRef.new(shape: string, location_name: "RestoreJobId"))
|
773
809
|
RestoreJobsListMember.add_member(:recovery_point_arn, Shapes::ShapeRef.new(shape: ARN, location_name: "RecoveryPointArn"))
|
774
810
|
RestoreJobsListMember.add_member(:creation_date, Shapes::ShapeRef.new(shape: timestamp, location_name: "CreationDate"))
|
@@ -780,6 +816,7 @@ module Aws::Backup
|
|
780
816
|
RestoreJobsListMember.add_member(:iam_role_arn, Shapes::ShapeRef.new(shape: IAMRoleArn, location_name: "IamRoleArn"))
|
781
817
|
RestoreJobsListMember.add_member(:expected_completion_time_minutes, Shapes::ShapeRef.new(shape: Long, location_name: "ExpectedCompletionTimeMinutes"))
|
782
818
|
RestoreJobsListMember.add_member(:created_resource_arn, Shapes::ShapeRef.new(shape: ARN, location_name: "CreatedResourceArn"))
|
819
|
+
RestoreJobsListMember.add_member(:resource_type, Shapes::ShapeRef.new(shape: ResourceType, location_name: "ResourceType"))
|
783
820
|
RestoreJobsListMember.struct_class = Types::RestoreJobsListMember
|
784
821
|
|
785
822
|
ServiceUnavailableException.add_member(:code, Shapes::ShapeRef.new(shape: string, location_name: "Code"))
|
@@ -796,6 +833,7 @@ module Aws::Backup
|
|
796
833
|
StartBackupJobInput.add_member(:complete_window_minutes, Shapes::ShapeRef.new(shape: WindowMinutes, location_name: "CompleteWindowMinutes"))
|
797
834
|
StartBackupJobInput.add_member(:lifecycle, Shapes::ShapeRef.new(shape: Lifecycle, location_name: "Lifecycle"))
|
798
835
|
StartBackupJobInput.add_member(:recovery_point_tags, Shapes::ShapeRef.new(shape: Tags, location_name: "RecoveryPointTags"))
|
836
|
+
StartBackupJobInput.add_member(:backup_options, Shapes::ShapeRef.new(shape: BackupOptions, location_name: "BackupOptions"))
|
799
837
|
StartBackupJobInput.struct_class = Types::StartBackupJobInput
|
800
838
|
|
801
839
|
StartBackupJobOutput.add_member(:backup_job_id, Shapes::ShapeRef.new(shape: string, location_name: "BackupJobId"))
|
@@ -849,6 +887,7 @@ module Aws::Backup
|
|
849
887
|
UpdateBackupPlanOutput.add_member(:backup_plan_arn, Shapes::ShapeRef.new(shape: ARN, location_name: "BackupPlanArn"))
|
850
888
|
UpdateBackupPlanOutput.add_member(:creation_date, Shapes::ShapeRef.new(shape: timestamp, location_name: "CreationDate"))
|
851
889
|
UpdateBackupPlanOutput.add_member(:version_id, Shapes::ShapeRef.new(shape: string, location_name: "VersionId"))
|
890
|
+
UpdateBackupPlanOutput.add_member(:advanced_backup_settings, Shapes::ShapeRef.new(shape: AdvancedBackupSettings, location_name: "AdvancedBackupSettings"))
|
852
891
|
UpdateBackupPlanOutput.struct_class = Types::UpdateBackupPlanOutput
|
853
892
|
|
854
893
|
UpdateRecoveryPointLifecycleInput.add_member(:backup_vault_name, Shapes::ShapeRef.new(shape: BackupVaultName, required: true, location: "uri", location_name: "backupVaultName"))
|
@@ -1192,7 +1231,6 @@ module Aws::Backup
|
|
1192
1231
|
o.input = Shapes::ShapeRef.new(shape: ListBackupJobsInput)
|
1193
1232
|
o.output = Shapes::ShapeRef.new(shape: ListBackupJobsOutput)
|
1194
1233
|
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterValueException)
|
1195
|
-
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
1196
1234
|
o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
|
1197
1235
|
o[:pager] = Aws::Pager.new(
|
1198
1236
|
limit_key: "max_results",
|
data/lib/aws-sdk-backup/types.rb
CHANGED
@@ -10,6 +10,52 @@
|
|
10
10
|
module Aws::Backup
|
11
11
|
module Types
|
12
12
|
|
13
|
+
# A list of backup options for each resource type.
|
14
|
+
#
|
15
|
+
# @note When making an API call, you may pass AdvancedBackupSetting
|
16
|
+
# data as a hash:
|
17
|
+
#
|
18
|
+
# {
|
19
|
+
# resource_type: "ResourceType",
|
20
|
+
# backup_options: {
|
21
|
+
# "BackupOptionKey" => "BackupOptionValue",
|
22
|
+
# },
|
23
|
+
# }
|
24
|
+
#
|
25
|
+
# @!attribute [rw] resource_type
|
26
|
+
# The type of AWS resource to be backed up. For VSS Windows backups,
|
27
|
+
# the only supported resource type is Amazon EC2.
|
28
|
+
#
|
29
|
+
# Valid values: `EC2`.
|
30
|
+
# @return [String]
|
31
|
+
#
|
32
|
+
# @!attribute [rw] backup_options
|
33
|
+
# Specifies the backup option for a selected resource. This option is
|
34
|
+
# only available for Windows VSS backup jobs.
|
35
|
+
#
|
36
|
+
# Valid value: `"WindowsVSS”:“enabled"`. If enabled, creates a VSS
|
37
|
+
# Windows backup; otherwise, creates a regular backup.
|
38
|
+
#
|
39
|
+
# If you specify an invalid option, you get an
|
40
|
+
# `InvalidParameterValueException` exception.
|
41
|
+
#
|
42
|
+
# For more information about Windows VSS backups, see [Creating a
|
43
|
+
# VSS-Enabled Windows Backup][1].
|
44
|
+
#
|
45
|
+
#
|
46
|
+
#
|
47
|
+
# [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/windows-backups.html
|
48
|
+
# @return [Hash<String,String>]
|
49
|
+
#
|
50
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/AdvancedBackupSetting AWS API Documentation
|
51
|
+
#
|
52
|
+
class AdvancedBackupSetting < Struct.new(
|
53
|
+
:resource_type,
|
54
|
+
:backup_options)
|
55
|
+
SENSITIVE = []
|
56
|
+
include Aws::Structure
|
57
|
+
end
|
58
|
+
|
13
59
|
# The required resource already exists.
|
14
60
|
#
|
15
61
|
# @!attribute [rw] code
|
@@ -45,6 +91,10 @@ module Aws::Backup
|
|
45
91
|
|
46
92
|
# Contains detailed information about a backup job.
|
47
93
|
#
|
94
|
+
# @!attribute [rw] account_id
|
95
|
+
# The account ID that owns the backup job.
|
96
|
+
# @return [String]
|
97
|
+
#
|
48
98
|
# @!attribute [rw] backup_job_id
|
49
99
|
# Uniquely identifies a request to AWS Backup to back up a resource.
|
50
100
|
# @return [String]
|
@@ -137,7 +187,8 @@ module Aws::Backup
|
|
137
187
|
# @!attribute [rw] resource_type
|
138
188
|
# The type of AWS resource to be backed up; for example, an Amazon
|
139
189
|
# Elastic Block Store (Amazon EBS) volume or an Amazon Relational
|
140
|
-
# Database Service (Amazon RDS) database.
|
190
|
+
# Database Service (Amazon RDS) database. For VSS Windows backups, the
|
191
|
+
# only supported resource type is Amazon EC2.
|
141
192
|
# @return [String]
|
142
193
|
#
|
143
194
|
# @!attribute [rw] bytes_transferred
|
@@ -145,9 +196,24 @@ module Aws::Backup
|
|
145
196
|
# job status was queried.
|
146
197
|
# @return [Integer]
|
147
198
|
#
|
199
|
+
# @!attribute [rw] backup_options
|
200
|
+
# Specifies the backup option for a selected resource. This option is
|
201
|
+
# only available for Windows VSS backup jobs.
|
202
|
+
#
|
203
|
+
# Valid value: `"WindowsVSS”:“enabled"`. If enabled, creates a VSS
|
204
|
+
# Windows backup; otherwise, creates a regular backup. If you specify
|
205
|
+
# an invalid option, you get an `InvalidParameterValueException`
|
206
|
+
# exception.
|
207
|
+
# @return [Hash<String,String>]
|
208
|
+
#
|
209
|
+
# @!attribute [rw] backup_type
|
210
|
+
# Represents the type of backup for a backup job.
|
211
|
+
# @return [String]
|
212
|
+
#
|
148
213
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/BackupJob AWS API Documentation
|
149
214
|
#
|
150
215
|
class BackupJob < Struct.new(
|
216
|
+
:account_id,
|
151
217
|
:backup_job_id,
|
152
218
|
:backup_vault_name,
|
153
219
|
:backup_vault_arn,
|
@@ -164,7 +230,9 @@ module Aws::Backup
|
|
164
230
|
:expected_completion_date,
|
165
231
|
:start_by,
|
166
232
|
:resource_type,
|
167
|
-
:bytes_transferred
|
233
|
+
:bytes_transferred,
|
234
|
+
:backup_options,
|
235
|
+
:backup_type)
|
168
236
|
SENSITIVE = []
|
169
237
|
include Aws::Structure
|
170
238
|
end
|
@@ -183,11 +251,16 @@ module Aws::Backup
|
|
183
251
|
# scheduled task that is used to back up a selection of resources.
|
184
252
|
# @return [Array<Types::BackupRule>]
|
185
253
|
#
|
254
|
+
# @!attribute [rw] advanced_backup_settings
|
255
|
+
# Contains a list of `BackupOptions` for each resource type.
|
256
|
+
# @return [Array<Types::AdvancedBackupSetting>]
|
257
|
+
#
|
186
258
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/BackupPlan AWS API Documentation
|
187
259
|
#
|
188
260
|
class BackupPlan < Struct.new(
|
189
261
|
:backup_plan_name,
|
190
|
-
:rules
|
262
|
+
:rules,
|
263
|
+
:advanced_backup_settings)
|
191
264
|
SENSITIVE = []
|
192
265
|
include Aws::Structure
|
193
266
|
end
|
@@ -227,10 +300,18 @@ module Aws::Backup
|
|
227
300
|
# ],
|
228
301
|
# },
|
229
302
|
# ],
|
303
|
+
# advanced_backup_settings: [
|
304
|
+
# {
|
305
|
+
# resource_type: "ResourceType",
|
306
|
+
# backup_options: {
|
307
|
+
# "BackupOptionKey" => "BackupOptionValue",
|
308
|
+
# },
|
309
|
+
# },
|
310
|
+
# ],
|
230
311
|
# }
|
231
312
|
#
|
232
313
|
# @!attribute [rw] backup_plan_name
|
233
|
-
# The display name of a backup plan.
|
314
|
+
# The optional display name of a backup plan.
|
234
315
|
# @return [String]
|
235
316
|
#
|
236
317
|
# @!attribute [rw] rules
|
@@ -238,11 +319,17 @@ module Aws::Backup
|
|
238
319
|
# scheduled task that is used to back up a selection of resources.
|
239
320
|
# @return [Array<Types::BackupRuleInput>]
|
240
321
|
#
|
322
|
+
# @!attribute [rw] advanced_backup_settings
|
323
|
+
# Specifies a list of `BackupOptions` for each resource type. These
|
324
|
+
# settings are only available for Windows VSS backup jobs.
|
325
|
+
# @return [Array<Types::AdvancedBackupSetting>]
|
326
|
+
#
|
241
327
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/BackupPlanInput AWS API Documentation
|
242
328
|
#
|
243
329
|
class BackupPlanInput < Struct.new(
|
244
330
|
:backup_plan_name,
|
245
|
-
:rules
|
331
|
+
:rules,
|
332
|
+
:advanced_backup_settings)
|
246
333
|
SENSITIVE = []
|
247
334
|
include Aws::Structure
|
248
335
|
end
|
@@ -303,18 +390,22 @@ module Aws::Backup
|
|
303
390
|
#
|
304
391
|
# @!attribute [rw] creator_request_id
|
305
392
|
# A unique string that identifies the request and allows failed
|
306
|
-
# requests to be retried without the risk of
|
393
|
+
# requests to be retried without the risk of running the operation
|
307
394
|
# twice.
|
308
395
|
# @return [String]
|
309
396
|
#
|
310
397
|
# @!attribute [rw] last_execution_date
|
311
|
-
# The last time a job to back up resources was
|
312
|
-
#
|
313
|
-
#
|
314
|
-
#
|
398
|
+
# The last time a job to back up resources was run with this rule. A
|
399
|
+
# date and time, in Unix format and Coordinated Universal Time (UTC).
|
400
|
+
# The value of `LastExecutionDate` is accurate to milliseconds. For
|
401
|
+
# example, the value 1516925490.087 represents Friday, January 26,
|
315
402
|
# 2018 12:11:30.087 AM.
|
316
403
|
# @return [Time]
|
317
404
|
#
|
405
|
+
# @!attribute [rw] advanced_backup_settings
|
406
|
+
# Contains a list of `BackupOptions` for a resource type.
|
407
|
+
# @return [Array<Types::AdvancedBackupSetting>]
|
408
|
+
#
|
318
409
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/BackupPlansListMember AWS API Documentation
|
319
410
|
#
|
320
411
|
class BackupPlansListMember < Struct.new(
|
@@ -325,7 +416,8 @@ module Aws::Backup
|
|
325
416
|
:version_id,
|
326
417
|
:backup_plan_name,
|
327
418
|
:creator_request_id,
|
328
|
-
:last_execution_date
|
419
|
+
:last_execution_date,
|
420
|
+
:advanced_backup_settings)
|
329
421
|
SENSITIVE = []
|
330
422
|
include Aws::Structure
|
331
423
|
end
|
@@ -518,7 +610,7 @@ module Aws::Backup
|
|
518
610
|
#
|
519
611
|
# @!attribute [rw] iam_role_arn
|
520
612
|
# The ARN of the IAM role that AWS Backup uses to authenticate when
|
521
|
-
#
|
613
|
+
# backing up the target resource; for example,
|
522
614
|
# `arn:aws:iam::123456789012:role/S3Access`.
|
523
615
|
# @return [String]
|
524
616
|
#
|
@@ -529,7 +621,7 @@ module Aws::Backup
|
|
529
621
|
#
|
530
622
|
# @!attribute [rw] list_of_tags
|
531
623
|
# An array of conditions used to specify a set of resources to assign
|
532
|
-
# to a backup plan; for example, `"
|
624
|
+
# to a backup plan; for example, `"StringEquals":
|
533
625
|
# \{"ec2:ResourceTag/Department": "accounting"`.
|
534
626
|
# @return [Array<Types::Condition>]
|
535
627
|
#
|
@@ -568,7 +660,7 @@ module Aws::Backup
|
|
568
660
|
#
|
569
661
|
# @!attribute [rw] creator_request_id
|
570
662
|
# A unique string that identifies the request and allows failed
|
571
|
-
# requests to be retried without the risk of
|
663
|
+
# requests to be retried without the risk of running the operation
|
572
664
|
# twice.
|
573
665
|
# @return [String]
|
574
666
|
#
|
@@ -621,7 +713,7 @@ module Aws::Backup
|
|
621
713
|
#
|
622
714
|
# @!attribute [rw] creator_request_id
|
623
715
|
# A unique string that identifies the request and allows failed
|
624
|
-
# requests to be retried without the risk of
|
716
|
+
# requests to be retried without the risk of running the operation
|
625
717
|
# twice.
|
626
718
|
# @return [String]
|
627
719
|
#
|
@@ -674,7 +766,7 @@ module Aws::Backup
|
|
674
766
|
end
|
675
767
|
|
676
768
|
# Contains an array of triplets made up of a condition type (such as
|
677
|
-
# `
|
769
|
+
# `StringEquals`), a key, and a value. Conditions are used to filter
|
678
770
|
# resources in a selection that is assigned to a backup plan.
|
679
771
|
#
|
680
772
|
# @note When making an API call, you may pass Condition
|
@@ -687,7 +779,7 @@ module Aws::Backup
|
|
687
779
|
# }
|
688
780
|
#
|
689
781
|
# @!attribute [rw] condition_type
|
690
|
-
# An operation, such as `
|
782
|
+
# An operation, such as `StringEquals`, that is applied to a key-value
|
691
783
|
# pair used to filter resources in a selection.
|
692
784
|
# @return [String]
|
693
785
|
#
|
@@ -756,6 +848,10 @@ module Aws::Backup
|
|
756
848
|
|
757
849
|
# Contains detailed information about a copy job.
|
758
850
|
#
|
851
|
+
# @!attribute [rw] account_id
|
852
|
+
# The account ID that owns the copy job.
|
853
|
+
# @return [String]
|
854
|
+
#
|
759
855
|
# @!attribute [rw] copy_job_id
|
760
856
|
# Uniquely identifies a copy job.
|
761
857
|
# @return [String]
|
@@ -792,14 +888,14 @@ module Aws::Backup
|
|
792
888
|
#
|
793
889
|
# @!attribute [rw] creation_date
|
794
890
|
# The date and time a copy job is created, in Unix format and
|
795
|
-
# Coordinated Universal Time (UTC). The value of CreationDate is
|
891
|
+
# Coordinated Universal Time (UTC). The value of `CreationDate` is
|
796
892
|
# accurate to milliseconds. For example, the value 1516925490.087
|
797
893
|
# represents Friday, January 26, 2018 12:11:30.087 AM.
|
798
894
|
# @return [Time]
|
799
895
|
#
|
800
896
|
# @!attribute [rw] completion_date
|
801
897
|
# The date and time a copy job is completed, in Unix format and
|
802
|
-
# Coordinated Universal Time (UTC). The value of CompletionDate is
|
898
|
+
# Coordinated Universal Time (UTC). The value of `CompletionDate` is
|
803
899
|
# accurate to milliseconds. For example, the value 1516925490.087
|
804
900
|
# represents Friday, January 26, 2018 12:11:30.087 AM.
|
805
901
|
# @return [Time]
|
@@ -836,6 +932,7 @@ module Aws::Backup
|
|
836
932
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/CopyJob AWS API Documentation
|
837
933
|
#
|
838
934
|
class CopyJob < Struct.new(
|
935
|
+
:account_id,
|
839
936
|
:copy_job_id,
|
840
937
|
:source_backup_vault_arn,
|
841
938
|
:source_recovery_point_arn,
|
@@ -885,6 +982,14 @@ module Aws::Backup
|
|
885
982
|
# ],
|
886
983
|
# },
|
887
984
|
# ],
|
985
|
+
# advanced_backup_settings: [
|
986
|
+
# {
|
987
|
+
# resource_type: "ResourceType",
|
988
|
+
# backup_options: {
|
989
|
+
# "BackupOptionKey" => "BackupOptionValue",
|
990
|
+
# },
|
991
|
+
# },
|
992
|
+
# ],
|
888
993
|
# },
|
889
994
|
# backup_plan_tags: {
|
890
995
|
# "TagKey" => "TagValue",
|
@@ -905,7 +1010,7 @@ module Aws::Backup
|
|
905
1010
|
#
|
906
1011
|
# @!attribute [rw] creator_request_id
|
907
1012
|
# Identifies the request and allows failed requests to be retried
|
908
|
-
# without the risk of
|
1013
|
+
# without the risk of running the operation twice. If the request
|
909
1014
|
# includes a `CreatorRequestId` that matches an existing backup plan,
|
910
1015
|
# that plan is returned. This parameter is optional.
|
911
1016
|
# @return [String]
|
@@ -942,13 +1047,19 @@ module Aws::Backup
|
|
942
1047
|
# at most 1,024 bytes long. They cannot be edited.
|
943
1048
|
# @return [String]
|
944
1049
|
#
|
1050
|
+
# @!attribute [rw] advanced_backup_settings
|
1051
|
+
# A list of `BackupOptions` settings for a resource type. This option
|
1052
|
+
# is only available for Windows VSS backup jobs.
|
1053
|
+
# @return [Array<Types::AdvancedBackupSetting>]
|
1054
|
+
#
|
945
1055
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/CreateBackupPlanOutput AWS API Documentation
|
946
1056
|
#
|
947
1057
|
class CreateBackupPlanOutput < Struct.new(
|
948
1058
|
:backup_plan_id,
|
949
1059
|
:backup_plan_arn,
|
950
1060
|
:creation_date,
|
951
|
-
:version_id
|
1061
|
+
:version_id,
|
1062
|
+
:advanced_backup_settings)
|
952
1063
|
SENSITIVE = []
|
953
1064
|
include Aws::Structure
|
954
1065
|
end
|
@@ -985,7 +1096,7 @@ module Aws::Backup
|
|
985
1096
|
#
|
986
1097
|
# @!attribute [rw] creator_request_id
|
987
1098
|
# A unique string that identifies the request and allows failed
|
988
|
-
# requests to be retried without the risk of
|
1099
|
+
# requests to be retried without the risk of running the operation
|
989
1100
|
# twice.
|
990
1101
|
# @return [String]
|
991
1102
|
#
|
@@ -1057,7 +1168,7 @@ module Aws::Backup
|
|
1057
1168
|
#
|
1058
1169
|
# @!attribute [rw] creator_request_id
|
1059
1170
|
# A unique string that identifies the request and allows failed
|
1060
|
-
# requests to be retried without the risk of
|
1171
|
+
# requests to be retried without the risk of running the operation
|
1061
1172
|
# twice.
|
1062
1173
|
# @return [String]
|
1063
1174
|
#
|
@@ -1133,14 +1244,14 @@ module Aws::Backup
|
|
1133
1244
|
#
|
1134
1245
|
# @!attribute [rw] deletion_date
|
1135
1246
|
# The date and time a backup plan is deleted, in Unix format and
|
1136
|
-
# Coordinated Universal Time (UTC). The value of `
|
1247
|
+
# Coordinated Universal Time (UTC). The value of `DeletionDate` is
|
1137
1248
|
# accurate to milliseconds. For example, the value 1516925490.087
|
1138
1249
|
# represents Friday, January 26, 2018 12:11:30.087 AM.
|
1139
1250
|
# @return [Time]
|
1140
1251
|
#
|
1141
1252
|
# @!attribute [rw] version_id
|
1142
1253
|
# Unique, randomly generated, Unicode, UTF-8 encoded strings that are
|
1143
|
-
# at most 1,024 bytes long. Version
|
1254
|
+
# at most 1,024 bytes long. Version IDs cannot be edited.
|
1144
1255
|
# @return [String]
|
1145
1256
|
#
|
1146
1257
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DeleteBackupPlanOutput AWS API Documentation
|
@@ -1321,6 +1432,10 @@ module Aws::Backup
|
|
1321
1432
|
include Aws::Structure
|
1322
1433
|
end
|
1323
1434
|
|
1435
|
+
# @!attribute [rw] account_id
|
1436
|
+
# Returns the account ID that owns the backup job.
|
1437
|
+
# @return [String]
|
1438
|
+
#
|
1324
1439
|
# @!attribute [rw] backup_job_id
|
1325
1440
|
# Uniquely identifies a request to AWS Backup to back up a resource.
|
1326
1441
|
# @return [String]
|
@@ -1358,7 +1473,7 @@ module Aws::Backup
|
|
1358
1473
|
# @!attribute [rw] completion_date
|
1359
1474
|
# The date and time that a job to create a backup job is completed, in
|
1360
1475
|
# Unix format and Coordinated Universal Time (UTC). The value of
|
1361
|
-
# `
|
1476
|
+
# `CompletionDate` is accurate to milliseconds. For example, the value
|
1362
1477
|
# 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
|
1363
1478
|
# @return [Time]
|
1364
1479
|
#
|
@@ -1421,9 +1536,22 @@ module Aws::Backup
|
|
1421
1536
|
# 12:11:30.087 AM.
|
1422
1537
|
# @return [Time]
|
1423
1538
|
#
|
1539
|
+
# @!attribute [rw] backup_options
|
1540
|
+
# Represents the options specified as part of backup plan or on-demand
|
1541
|
+
# backup job.
|
1542
|
+
# @return [Hash<String,String>]
|
1543
|
+
#
|
1544
|
+
# @!attribute [rw] backup_type
|
1545
|
+
# Represents the actual backup type selected for a backup job. For
|
1546
|
+
# example, if a successful WindowsVSS backup was taken, `BackupType`
|
1547
|
+
# returns “WindowsVSS”. If `BackupType` is empty, then it is a regular
|
1548
|
+
# backup.
|
1549
|
+
# @return [String]
|
1550
|
+
#
|
1424
1551
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeBackupJobOutput AWS API Documentation
|
1425
1552
|
#
|
1426
1553
|
class DescribeBackupJobOutput < Struct.new(
|
1554
|
+
:account_id,
|
1427
1555
|
:backup_job_id,
|
1428
1556
|
:backup_vault_name,
|
1429
1557
|
:backup_vault_arn,
|
@@ -1440,7 +1568,9 @@ module Aws::Backup
|
|
1440
1568
|
:resource_type,
|
1441
1569
|
:bytes_transferred,
|
1442
1570
|
:expected_completion_date,
|
1443
|
-
:start_by
|
1571
|
+
:start_by,
|
1572
|
+
:backup_options,
|
1573
|
+
:backup_type)
|
1444
1574
|
SENSITIVE = []
|
1445
1575
|
include Aws::Structure
|
1446
1576
|
end
|
@@ -1495,7 +1625,7 @@ module Aws::Backup
|
|
1495
1625
|
#
|
1496
1626
|
# @!attribute [rw] creator_request_id
|
1497
1627
|
# A unique string that identifies the request and allows failed
|
1498
|
-
# requests to be retried without the risk of
|
1628
|
+
# requests to be retried without the risk of running the operation
|
1499
1629
|
# twice.
|
1500
1630
|
# @return [String]
|
1501
1631
|
#
|
@@ -1766,7 +1896,7 @@ module Aws::Backup
|
|
1766
1896
|
|
1767
1897
|
# @!attribute [rw] resource_type_opt_in_preference
|
1768
1898
|
# Returns a list of all services along with the opt-in preferences in
|
1769
|
-
# the
|
1899
|
+
# the Region.
|
1770
1900
|
# @return [Hash<String,Boolean>]
|
1771
1901
|
#
|
1772
1902
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeRegionSettingsOutput AWS API Documentation
|
@@ -1796,6 +1926,10 @@ module Aws::Backup
|
|
1796
1926
|
include Aws::Structure
|
1797
1927
|
end
|
1798
1928
|
|
1929
|
+
# @!attribute [rw] account_id
|
1930
|
+
# Returns the account ID that owns the restore job.
|
1931
|
+
# @return [String]
|
1932
|
+
#
|
1799
1933
|
# @!attribute [rw] restore_job_id
|
1800
1934
|
# Uniquely identifies the job that restores a recovery point.
|
1801
1935
|
# @return [String]
|
@@ -1826,8 +1960,7 @@ module Aws::Backup
|
|
1826
1960
|
# @return [String]
|
1827
1961
|
#
|
1828
1962
|
# @!attribute [rw] status_message
|
1829
|
-
# A
|
1830
|
-
# recovery point.
|
1963
|
+
# A message showing the status of a job to restore a recovery point.
|
1831
1964
|
# @return [String]
|
1832
1965
|
#
|
1833
1966
|
# @!attribute [rw] percent_done
|
@@ -1855,9 +1988,15 @@ module Aws::Backup
|
|
1855
1988
|
# depends on the resource type of the backed-up resource.
|
1856
1989
|
# @return [String]
|
1857
1990
|
#
|
1991
|
+
# @!attribute [rw] resource_type
|
1992
|
+
# Returns metadata associated with a restore job listed by resource
|
1993
|
+
# type.
|
1994
|
+
# @return [String]
|
1995
|
+
#
|
1858
1996
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeRestoreJobOutput AWS API Documentation
|
1859
1997
|
#
|
1860
1998
|
class DescribeRestoreJobOutput < Struct.new(
|
1999
|
+
:account_id,
|
1861
2000
|
:restore_job_id,
|
1862
2001
|
:recovery_point_arn,
|
1863
2002
|
:creation_date,
|
@@ -1868,7 +2007,8 @@ module Aws::Backup
|
|
1868
2007
|
:backup_size_in_bytes,
|
1869
2008
|
:iam_role_arn,
|
1870
2009
|
:expected_completion_time_minutes,
|
1871
|
-
:created_resource_arn
|
2010
|
+
:created_resource_arn,
|
2011
|
+
:resource_type)
|
1872
2012
|
SENSITIVE = []
|
1873
2013
|
include Aws::Structure
|
1874
2014
|
end
|
@@ -2021,7 +2161,7 @@ module Aws::Backup
|
|
2021
2161
|
#
|
2022
2162
|
# @!attribute [rw] creator_request_id
|
2023
2163
|
# A unique string that identifies the request and allows failed
|
2024
|
-
# requests to be retried without the risk of
|
2164
|
+
# requests to be retried without the risk of running the operation
|
2025
2165
|
# twice.
|
2026
2166
|
# @return [String]
|
2027
2167
|
#
|
@@ -2034,19 +2174,24 @@ module Aws::Backup
|
|
2034
2174
|
#
|
2035
2175
|
# @!attribute [rw] deletion_date
|
2036
2176
|
# The date and time that a backup plan is deleted, in Unix format and
|
2037
|
-
# Coordinated Universal Time (UTC). The value of `
|
2177
|
+
# Coordinated Universal Time (UTC). The value of `DeletionDate` is
|
2038
2178
|
# accurate to milliseconds. For example, the value 1516925490.087
|
2039
2179
|
# represents Friday, January 26, 2018 12:11:30.087 AM.
|
2040
2180
|
# @return [Time]
|
2041
2181
|
#
|
2042
2182
|
# @!attribute [rw] last_execution_date
|
2043
|
-
# The last time a job to back up resources was
|
2044
|
-
#
|
2045
|
-
#
|
2046
|
-
#
|
2047
|
-
#
|
2183
|
+
# The last time a job to back up resources was run with this backup
|
2184
|
+
# plan. A date and time, in Unix format and Coordinated Universal Time
|
2185
|
+
# (UTC). The value of `LastExecutionDate` is accurate to milliseconds.
|
2186
|
+
# For example, the value 1516925490.087 represents Friday, January 26,
|
2187
|
+
# 2018 12:11:30.087 AM.
|
2048
2188
|
# @return [Time]
|
2049
2189
|
#
|
2190
|
+
# @!attribute [rw] advanced_backup_settings
|
2191
|
+
# Contains a list of `BackupOptions` for each resource type. The list
|
2192
|
+
# is populated only if the advanced option is set for the backup plan.
|
2193
|
+
# @return [Array<Types::AdvancedBackupSetting>]
|
2194
|
+
#
|
2050
2195
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetBackupPlanOutput AWS API Documentation
|
2051
2196
|
#
|
2052
2197
|
class GetBackupPlanOutput < Struct.new(
|
@@ -2057,7 +2202,8 @@ module Aws::Backup
|
|
2057
2202
|
:creator_request_id,
|
2058
2203
|
:creation_date,
|
2059
2204
|
:deletion_date,
|
2060
|
-
:last_execution_date
|
2205
|
+
:last_execution_date,
|
2206
|
+
:advanced_backup_settings)
|
2061
2207
|
SENSITIVE = []
|
2062
2208
|
include Aws::Structure
|
2063
2209
|
end
|
@@ -2111,7 +2257,7 @@ module Aws::Backup
|
|
2111
2257
|
#
|
2112
2258
|
# @!attribute [rw] creator_request_id
|
2113
2259
|
# A unique string that identifies the request and allows failed
|
2114
|
-
# requests to be retried without the risk of
|
2260
|
+
# requests to be retried without the risk of running the operation
|
2115
2261
|
# twice.
|
2116
2262
|
# @return [String]
|
2117
2263
|
#
|
@@ -2274,7 +2420,7 @@ module Aws::Backup
|
|
2274
2420
|
# @return [String]
|
2275
2421
|
#
|
2276
2422
|
# @!attribute [rw] restore_metadata
|
2277
|
-
# The set of metadata key-value pairs that
|
2423
|
+
# The set of metadata key-value pairs that describe the original
|
2278
2424
|
# configuration of the backed-up resource. These values vary depending
|
2279
2425
|
# on the service that is being restored.
|
2280
2426
|
# @return [Hash<String,String>]
|
@@ -2292,15 +2438,17 @@ module Aws::Backup
|
|
2292
2438
|
# @!attribute [rw] resource_types
|
2293
2439
|
# Contains a string with the supported AWS resource types:
|
2294
2440
|
#
|
2441
|
+
# * `DynamoDB` for Amazon DynamoDB
|
2442
|
+
#
|
2295
2443
|
# * `EBS` for Amazon Elastic Block Store
|
2296
2444
|
#
|
2297
|
-
# * `
|
2445
|
+
# * `EC2` for Amazon Elastic Compute Cloud
|
2298
2446
|
#
|
2299
|
-
# * `
|
2447
|
+
# * `EFS` for Amazon Elastic File System
|
2300
2448
|
#
|
2301
|
-
# * `
|
2449
|
+
# * `RDS` for Amazon Relational Database Service
|
2302
2450
|
#
|
2303
|
-
# * `
|
2451
|
+
# * `Storage Gateway` for AWS Storage Gateway
|
2304
2452
|
# @return [Array<String>]
|
2305
2453
|
#
|
2306
2454
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetSupportedResourceTypesOutput AWS API Documentation
|
@@ -2438,6 +2586,7 @@ module Aws::Backup
|
|
2438
2586
|
# by_created_before: Time.now,
|
2439
2587
|
# by_created_after: Time.now,
|
2440
2588
|
# by_resource_type: "ResourceType",
|
2589
|
+
# by_account_id: "AccountId",
|
2441
2590
|
# }
|
2442
2591
|
#
|
2443
2592
|
# @!attribute [rw] next_token
|
@@ -2483,6 +2632,8 @@ module Aws::Backup
|
|
2483
2632
|
#
|
2484
2633
|
# * `EBS` for Amazon Elastic Block Store
|
2485
2634
|
#
|
2635
|
+
# * `EC2` for Amazon Elastic Compute Cloud
|
2636
|
+
#
|
2486
2637
|
# * `EFS` for Amazon Elastic File System
|
2487
2638
|
#
|
2488
2639
|
# * `RDS` for Amazon Relational Database Service
|
@@ -2490,6 +2641,11 @@ module Aws::Backup
|
|
2490
2641
|
# * `Storage Gateway` for AWS Storage Gateway
|
2491
2642
|
# @return [String]
|
2492
2643
|
#
|
2644
|
+
# @!attribute [rw] by_account_id
|
2645
|
+
# The account ID to list the jobs from. Returns only backup jobs
|
2646
|
+
# associated with the specified account ID.
|
2647
|
+
# @return [String]
|
2648
|
+
#
|
2493
2649
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListBackupJobsInput AWS API Documentation
|
2494
2650
|
#
|
2495
2651
|
class ListBackupJobsInput < Struct.new(
|
@@ -2500,7 +2656,8 @@ module Aws::Backup
|
|
2500
2656
|
:by_backup_vault_name,
|
2501
2657
|
:by_created_before,
|
2502
2658
|
:by_created_after,
|
2503
|
-
:by_resource_type
|
2659
|
+
:by_resource_type,
|
2660
|
+
:by_account_id)
|
2504
2661
|
SENSITIVE = []
|
2505
2662
|
include Aws::Structure
|
2506
2663
|
end
|
@@ -2804,6 +2961,7 @@ module Aws::Backup
|
|
2804
2961
|
# by_created_after: Time.now,
|
2805
2962
|
# by_resource_type: "ResourceType",
|
2806
2963
|
# by_destination_vault_arn: "string",
|
2964
|
+
# by_account_id: "AccountId",
|
2807
2965
|
# }
|
2808
2966
|
#
|
2809
2967
|
# @!attribute [rw] next_token
|
@@ -2837,8 +2995,12 @@ module Aws::Backup
|
|
2837
2995
|
# @!attribute [rw] by_resource_type
|
2838
2996
|
# Returns only backup jobs for the specified resources:
|
2839
2997
|
#
|
2998
|
+
# * `DynamoDB` for Amazon DynamoDB
|
2999
|
+
#
|
2840
3000
|
# * `EBS` for Amazon Elastic Block Store
|
2841
3001
|
#
|
3002
|
+
# * `EC2` for Amazon Elastic Compute Cloud
|
3003
|
+
#
|
2842
3004
|
# * `EFS` for Amazon Elastic File System
|
2843
3005
|
#
|
2844
3006
|
# * `RDS` for Amazon Relational Database Service
|
@@ -2852,6 +3014,11 @@ module Aws::Backup
|
|
2852
3014
|
# `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`.
|
2853
3015
|
# @return [String]
|
2854
3016
|
#
|
3017
|
+
# @!attribute [rw] by_account_id
|
3018
|
+
# The account ID to list the jobs from. Returns only copy jobs
|
3019
|
+
# associated with the specified account ID.
|
3020
|
+
# @return [String]
|
3021
|
+
#
|
2855
3022
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListCopyJobsInput AWS API Documentation
|
2856
3023
|
#
|
2857
3024
|
class ListCopyJobsInput < Struct.new(
|
@@ -2862,7 +3029,8 @@ module Aws::Backup
|
|
2862
3029
|
:by_created_before,
|
2863
3030
|
:by_created_after,
|
2864
3031
|
:by_resource_type,
|
2865
|
-
:by_destination_vault_arn
|
3032
|
+
:by_destination_vault_arn,
|
3033
|
+
:by_account_id)
|
2866
3034
|
SENSITIVE = []
|
2867
3035
|
include Aws::Structure
|
2868
3036
|
end
|
@@ -3092,6 +3260,10 @@ module Aws::Backup
|
|
3092
3260
|
# {
|
3093
3261
|
# next_token: "string",
|
3094
3262
|
# max_results: 1,
|
3263
|
+
# by_account_id: "AccountId",
|
3264
|
+
# by_created_before: Time.now,
|
3265
|
+
# by_created_after: Time.now,
|
3266
|
+
# by_status: "PENDING", # accepts PENDING, RUNNING, COMPLETED, ABORTED, FAILED
|
3095
3267
|
# }
|
3096
3268
|
#
|
3097
3269
|
# @!attribute [rw] next_token
|
@@ -3105,11 +3277,34 @@ module Aws::Backup
|
|
3105
3277
|
# The maximum number of items to be returned.
|
3106
3278
|
# @return [Integer]
|
3107
3279
|
#
|
3280
|
+
# @!attribute [rw] by_account_id
|
3281
|
+
# The account ID to list the jobs from. Returns only restore jobs
|
3282
|
+
# associated with the specified account ID.
|
3283
|
+
# @return [String]
|
3284
|
+
#
|
3285
|
+
# @!attribute [rw] by_created_before
|
3286
|
+
# Returns only restore jobs that were created before the specified
|
3287
|
+
# date.
|
3288
|
+
# @return [Time]
|
3289
|
+
#
|
3290
|
+
# @!attribute [rw] by_created_after
|
3291
|
+
# Returns only restore jobs that were created after the specified
|
3292
|
+
# date.
|
3293
|
+
# @return [Time]
|
3294
|
+
#
|
3295
|
+
# @!attribute [rw] by_status
|
3296
|
+
# Returns only restore jobs associated with the specified job status.
|
3297
|
+
# @return [String]
|
3298
|
+
#
|
3108
3299
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListRestoreJobsInput AWS API Documentation
|
3109
3300
|
#
|
3110
3301
|
class ListRestoreJobsInput < Struct.new(
|
3111
3302
|
:next_token,
|
3112
|
-
:max_results
|
3303
|
+
:max_results,
|
3304
|
+
:by_account_id,
|
3305
|
+
:by_created_before,
|
3306
|
+
:by_created_after,
|
3307
|
+
:by_status)
|
3113
3308
|
SENSITIVE = []
|
3114
3309
|
include Aws::Structure
|
3115
3310
|
end
|
@@ -3227,7 +3422,8 @@ module Aws::Backup
|
|
3227
3422
|
# @!attribute [rw] resource_type
|
3228
3423
|
# The type of AWS resource; for example, an Amazon Elastic Block Store
|
3229
3424
|
# (Amazon EBS) volume or an Amazon Relational Database Service (Amazon
|
3230
|
-
# RDS) database.
|
3425
|
+
# RDS) database. For VSS Windows backups, the only supported resource
|
3426
|
+
# type is Amazon EC2.
|
3231
3427
|
# @return [String]
|
3232
3428
|
#
|
3233
3429
|
# @!attribute [rw] last_backup_time
|
@@ -3341,7 +3537,8 @@ module Aws::Backup
|
|
3341
3537
|
# @!attribute [rw] resource_type
|
3342
3538
|
# The type of AWS resource saved as a recovery point; for example, an
|
3343
3539
|
# Amazon Elastic Block Store (Amazon EBS) volume or an Amazon
|
3344
|
-
# Relational Database Service (Amazon RDS) database.
|
3540
|
+
# Relational Database Service (Amazon RDS) database. For VSS Windows
|
3541
|
+
# backups, the only supported resource type is Amazon EC2.
|
3345
3542
|
# @return [String]
|
3346
3543
|
#
|
3347
3544
|
# @!attribute [rw] created_by
|
@@ -3547,6 +3744,10 @@ module Aws::Backup
|
|
3547
3744
|
|
3548
3745
|
# Contains metadata about a restore job.
|
3549
3746
|
#
|
3747
|
+
# @!attribute [rw] account_id
|
3748
|
+
# The account ID that owns the restore job.
|
3749
|
+
# @return [String]
|
3750
|
+
#
|
3550
3751
|
# @!attribute [rw] restore_job_id
|
3551
3752
|
# Uniquely identifies the job that restores a recovery point.
|
3552
3753
|
# @return [String]
|
@@ -3604,9 +3805,17 @@ module Aws::Backup
|
|
3604
3805
|
# The format of the ARN depends on the resource type.
|
3605
3806
|
# @return [String]
|
3606
3807
|
#
|
3808
|
+
# @!attribute [rw] resource_type
|
3809
|
+
# The resource type of the listed restore jobs; for example, an Amazon
|
3810
|
+
# Elastic Block Store (Amazon EBS) volume or an Amazon Relational
|
3811
|
+
# Database Service (Amazon RDS) database. For VSS Windows backups, the
|
3812
|
+
# only supported resource type is Amazon EC2.
|
3813
|
+
# @return [String]
|
3814
|
+
#
|
3607
3815
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/RestoreJobsListMember AWS API Documentation
|
3608
3816
|
#
|
3609
3817
|
class RestoreJobsListMember < Struct.new(
|
3818
|
+
:account_id,
|
3610
3819
|
:restore_job_id,
|
3611
3820
|
:recovery_point_arn,
|
3612
3821
|
:creation_date,
|
@@ -3617,7 +3826,8 @@ module Aws::Backup
|
|
3617
3826
|
:backup_size_in_bytes,
|
3618
3827
|
:iam_role_arn,
|
3619
3828
|
:expected_completion_time_minutes,
|
3620
|
-
:created_resource_arn
|
3829
|
+
:created_resource_arn,
|
3830
|
+
:resource_type)
|
3621
3831
|
SENSITIVE = []
|
3622
3832
|
include Aws::Structure
|
3623
3833
|
end
|
@@ -3664,6 +3874,9 @@ module Aws::Backup
|
|
3664
3874
|
# recovery_point_tags: {
|
3665
3875
|
# "TagKey" => "TagValue",
|
3666
3876
|
# },
|
3877
|
+
# backup_options: {
|
3878
|
+
# "BackupOptionKey" => "BackupOptionValue",
|
3879
|
+
# },
|
3667
3880
|
# }
|
3668
3881
|
#
|
3669
3882
|
# @!attribute [rw] backup_vault_name
|
@@ -3717,6 +3930,14 @@ module Aws::Backup
|
|
3717
3930
|
# the resources that you create. Each tag is a key-value pair.
|
3718
3931
|
# @return [Hash<String,String>]
|
3719
3932
|
#
|
3933
|
+
# @!attribute [rw] backup_options
|
3934
|
+
# Specifies the backup option for a selected resource. This option is
|
3935
|
+
# only available for Windows VSS backup jobs.
|
3936
|
+
#
|
3937
|
+
# Valid value: `"WindowsVSS”:“enabled"`. If enabled, creates a VSS
|
3938
|
+
# Windows backup; otherwise, creates a regular backup.
|
3939
|
+
# @return [Hash<String,String>]
|
3940
|
+
#
|
3720
3941
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/StartBackupJobInput AWS API Documentation
|
3721
3942
|
#
|
3722
3943
|
class StartBackupJobInput < Struct.new(
|
@@ -3727,7 +3948,8 @@ module Aws::Backup
|
|
3727
3948
|
:start_window_minutes,
|
3728
3949
|
:complete_window_minutes,
|
3729
3950
|
:lifecycle,
|
3730
|
-
:recovery_point_tags
|
3951
|
+
:recovery_point_tags,
|
3952
|
+
:backup_options)
|
3731
3953
|
SENSITIVE = [:recovery_point_tags]
|
3732
3954
|
include Aws::Structure
|
3733
3955
|
end
|
@@ -3880,8 +4102,9 @@ module Aws::Backup
|
|
3880
4102
|
# You need to specify specific metadata to restore an Amazon Elastic
|
3881
4103
|
# File System (Amazon EFS) instance:
|
3882
4104
|
#
|
3883
|
-
# * `file-system-id`\: ID of the Amazon EFS file system that is
|
3884
|
-
# up by AWS Backup. Returned in
|
4105
|
+
# * `file-system-id`\: The ID of the Amazon EFS file system that is
|
4106
|
+
# backed up by AWS Backup. Returned in
|
4107
|
+
# `GetRecoveryPointRestoreMetadata`.
|
3885
4108
|
#
|
3886
4109
|
# * `Encrypted`\: A Boolean value that, if true, specifies that the
|
3887
4110
|
# file system is encrypted. If `KmsKeyId` is specified, `Encrypted`
|
@@ -3915,15 +4138,17 @@ module Aws::Backup
|
|
3915
4138
|
# Starts a job to restore a recovery point for one of the following
|
3916
4139
|
# resources:
|
3917
4140
|
#
|
4141
|
+
# * `DynamoDB` for Amazon DynamoDB
|
4142
|
+
#
|
3918
4143
|
# * `EBS` for Amazon Elastic Block Store
|
3919
4144
|
#
|
3920
|
-
# * `
|
4145
|
+
# * `EC2` for Amazon Elastic Compute Cloud
|
3921
4146
|
#
|
3922
|
-
# * `
|
4147
|
+
# * `EFS` for Amazon Elastic File System
|
3923
4148
|
#
|
3924
|
-
# * `
|
4149
|
+
# * `RDS` for Amazon Relational Database Service
|
3925
4150
|
#
|
3926
|
-
# * `
|
4151
|
+
# * `Storage Gateway` for AWS Storage Gateway
|
3927
4152
|
# @return [String]
|
3928
4153
|
#
|
3929
4154
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/StartRestoreJobInput AWS API Documentation
|
@@ -4057,6 +4282,14 @@ module Aws::Backup
|
|
4057
4282
|
# ],
|
4058
4283
|
# },
|
4059
4284
|
# ],
|
4285
|
+
# advanced_backup_settings: [
|
4286
|
+
# {
|
4287
|
+
# resource_type: "ResourceType",
|
4288
|
+
# backup_options: {
|
4289
|
+
# "BackupOptionKey" => "BackupOptionValue",
|
4290
|
+
# },
|
4291
|
+
# },
|
4292
|
+
# ],
|
4060
4293
|
# },
|
4061
4294
|
# }
|
4062
4295
|
#
|
@@ -4100,13 +4333,18 @@ module Aws::Backup
|
|
4100
4333
|
# at most 1,024 bytes long. Version Ids cannot be edited.
|
4101
4334
|
# @return [String]
|
4102
4335
|
#
|
4336
|
+
# @!attribute [rw] advanced_backup_settings
|
4337
|
+
# Contains a list of `BackupOptions` for each resource type.
|
4338
|
+
# @return [Array<Types::AdvancedBackupSetting>]
|
4339
|
+
#
|
4103
4340
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/UpdateBackupPlanOutput AWS API Documentation
|
4104
4341
|
#
|
4105
4342
|
class UpdateBackupPlanOutput < Struct.new(
|
4106
4343
|
:backup_plan_id,
|
4107
4344
|
:backup_plan_arn,
|
4108
4345
|
:creation_date,
|
4109
|
-
:version_id
|
4346
|
+
:version_id,
|
4347
|
+
:advanced_backup_settings)
|
4110
4348
|
SENSITIVE = []
|
4111
4349
|
include Aws::Structure
|
4112
4350
|
end
|
@@ -4208,7 +4446,7 @@ module Aws::Backup
|
|
4208
4446
|
#
|
4209
4447
|
# @!attribute [rw] resource_type_opt_in_preference
|
4210
4448
|
# Updates the list of services along with the opt-in preferences for
|
4211
|
-
# the
|
4449
|
+
# the Region.
|
4212
4450
|
# @return [Hash<String,Boolean>]
|
4213
4451
|
#
|
4214
4452
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/UpdateRegionSettingsInput AWS API Documentation
|