aws-sdk-backup 1.21.0 → 1.26.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 +1 -1
- data/lib/aws-sdk-backup/client.rb +195 -41
- data/lib/aws-sdk-backup/client_api.rb +67 -0
- data/lib/aws-sdk-backup/types.rb +343 -48
- metadata +4 -4
@@ -15,10 +15,15 @@ module Aws::Backup
|
|
15
15
|
|
16
16
|
ARN = Shapes::StringShape.new(name: 'ARN')
|
17
17
|
AccountId = Shapes::StringShape.new(name: 'AccountId')
|
18
|
+
AdvancedBackupSetting = Shapes::StructureShape.new(name: 'AdvancedBackupSetting')
|
19
|
+
AdvancedBackupSettings = Shapes::ListShape.new(name: 'AdvancedBackupSettings')
|
18
20
|
AlreadyExistsException = Shapes::StructureShape.new(name: 'AlreadyExistsException')
|
19
21
|
BackupJob = Shapes::StructureShape.new(name: 'BackupJob')
|
20
22
|
BackupJobState = Shapes::StringShape.new(name: 'BackupJobState')
|
21
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')
|
22
27
|
BackupPlan = Shapes::StructureShape.new(name: 'BackupPlan')
|
23
28
|
BackupPlanInput = Shapes::StructureShape.new(name: 'BackupPlanInput')
|
24
29
|
BackupPlanName = Shapes::StringShape.new(name: 'BackupPlanName')
|
@@ -73,6 +78,8 @@ module Aws::Backup
|
|
73
78
|
DescribeBackupVaultOutput = Shapes::StructureShape.new(name: 'DescribeBackupVaultOutput')
|
74
79
|
DescribeCopyJobInput = Shapes::StructureShape.new(name: 'DescribeCopyJobInput')
|
75
80
|
DescribeCopyJobOutput = Shapes::StructureShape.new(name: 'DescribeCopyJobOutput')
|
81
|
+
DescribeGlobalSettingsInput = Shapes::StructureShape.new(name: 'DescribeGlobalSettingsInput')
|
82
|
+
DescribeGlobalSettingsOutput = Shapes::StructureShape.new(name: 'DescribeGlobalSettingsOutput')
|
76
83
|
DescribeProtectedResourceInput = Shapes::StructureShape.new(name: 'DescribeProtectedResourceInput')
|
77
84
|
DescribeProtectedResourceOutput = Shapes::StructureShape.new(name: 'DescribeProtectedResourceOutput')
|
78
85
|
DescribeRecoveryPointInput = Shapes::StructureShape.new(name: 'DescribeRecoveryPointInput')
|
@@ -98,6 +105,9 @@ module Aws::Backup
|
|
98
105
|
GetRecoveryPointRestoreMetadataInput = Shapes::StructureShape.new(name: 'GetRecoveryPointRestoreMetadataInput')
|
99
106
|
GetRecoveryPointRestoreMetadataOutput = Shapes::StructureShape.new(name: 'GetRecoveryPointRestoreMetadataOutput')
|
100
107
|
GetSupportedResourceTypesOutput = Shapes::StructureShape.new(name: 'GetSupportedResourceTypesOutput')
|
108
|
+
GlobalSettings = Shapes::MapShape.new(name: 'GlobalSettings')
|
109
|
+
GlobalSettingsName = Shapes::StringShape.new(name: 'GlobalSettingsName')
|
110
|
+
GlobalSettingsValue = Shapes::StringShape.new(name: 'GlobalSettingsValue')
|
101
111
|
IAMPolicy = Shapes::StringShape.new(name: 'IAMPolicy')
|
102
112
|
IAMRoleArn = Shapes::StringShape.new(name: 'IAMRoleArn')
|
103
113
|
InvalidParameterValueException = Shapes::StructureShape.new(name: 'InvalidParameterValueException')
|
@@ -172,6 +182,7 @@ module Aws::Backup
|
|
172
182
|
UntagResourceInput = Shapes::StructureShape.new(name: 'UntagResourceInput')
|
173
183
|
UpdateBackupPlanInput = Shapes::StructureShape.new(name: 'UpdateBackupPlanInput')
|
174
184
|
UpdateBackupPlanOutput = Shapes::StructureShape.new(name: 'UpdateBackupPlanOutput')
|
185
|
+
UpdateGlobalSettingsInput = Shapes::StructureShape.new(name: 'UpdateGlobalSettingsInput')
|
175
186
|
UpdateRecoveryPointLifecycleInput = Shapes::StructureShape.new(name: 'UpdateRecoveryPointLifecycleInput')
|
176
187
|
UpdateRecoveryPointLifecycleOutput = Shapes::StructureShape.new(name: 'UpdateRecoveryPointLifecycleOutput')
|
177
188
|
UpdateRegionSettingsInput = Shapes::StructureShape.new(name: 'UpdateRegionSettingsInput')
|
@@ -181,6 +192,12 @@ module Aws::Backup
|
|
181
192
|
string = Shapes::StringShape.new(name: 'string')
|
182
193
|
timestamp = Shapes::TimestampShape.new(name: 'timestamp')
|
183
194
|
|
195
|
+
AdvancedBackupSetting.add_member(:resource_type, Shapes::ShapeRef.new(shape: ResourceType, location_name: "ResourceType"))
|
196
|
+
AdvancedBackupSetting.add_member(:backup_options, Shapes::ShapeRef.new(shape: BackupOptions, location_name: "BackupOptions"))
|
197
|
+
AdvancedBackupSetting.struct_class = Types::AdvancedBackupSetting
|
198
|
+
|
199
|
+
AdvancedBackupSettings.member = Shapes::ShapeRef.new(shape: AdvancedBackupSetting)
|
200
|
+
|
184
201
|
AlreadyExistsException.add_member(:code, Shapes::ShapeRef.new(shape: string, location_name: "Code"))
|
185
202
|
AlreadyExistsException.add_member(:message, Shapes::ShapeRef.new(shape: string, location_name: "Message"))
|
186
203
|
AlreadyExistsException.add_member(:creator_request_id, Shapes::ShapeRef.new(shape: string, location_name: "CreatorRequestId"))
|
@@ -207,16 +224,23 @@ module Aws::Backup
|
|
207
224
|
BackupJob.add_member(:start_by, Shapes::ShapeRef.new(shape: timestamp, location_name: "StartBy"))
|
208
225
|
BackupJob.add_member(:resource_type, Shapes::ShapeRef.new(shape: ResourceType, location_name: "ResourceType"))
|
209
226
|
BackupJob.add_member(:bytes_transferred, Shapes::ShapeRef.new(shape: Long, location_name: "BytesTransferred"))
|
227
|
+
BackupJob.add_member(:backup_options, Shapes::ShapeRef.new(shape: BackupOptions, location_name: "BackupOptions"))
|
228
|
+
BackupJob.add_member(:backup_type, Shapes::ShapeRef.new(shape: string, location_name: "BackupType"))
|
210
229
|
BackupJob.struct_class = Types::BackupJob
|
211
230
|
|
212
231
|
BackupJobsList.member = Shapes::ShapeRef.new(shape: BackupJob)
|
213
232
|
|
233
|
+
BackupOptions.key = Shapes::ShapeRef.new(shape: BackupOptionKey)
|
234
|
+
BackupOptions.value = Shapes::ShapeRef.new(shape: BackupOptionValue)
|
235
|
+
|
214
236
|
BackupPlan.add_member(:backup_plan_name, Shapes::ShapeRef.new(shape: BackupPlanName, required: true, location_name: "BackupPlanName"))
|
215
237
|
BackupPlan.add_member(:rules, Shapes::ShapeRef.new(shape: BackupRules, required: true, location_name: "Rules"))
|
238
|
+
BackupPlan.add_member(:advanced_backup_settings, Shapes::ShapeRef.new(shape: AdvancedBackupSettings, location_name: "AdvancedBackupSettings"))
|
216
239
|
BackupPlan.struct_class = Types::BackupPlan
|
217
240
|
|
218
241
|
BackupPlanInput.add_member(:backup_plan_name, Shapes::ShapeRef.new(shape: BackupPlanName, required: true, location_name: "BackupPlanName"))
|
219
242
|
BackupPlanInput.add_member(:rules, Shapes::ShapeRef.new(shape: BackupRulesInput, required: true, location_name: "Rules"))
|
243
|
+
BackupPlanInput.add_member(:advanced_backup_settings, Shapes::ShapeRef.new(shape: AdvancedBackupSettings, location_name: "AdvancedBackupSettings"))
|
220
244
|
BackupPlanInput.struct_class = Types::BackupPlanInput
|
221
245
|
|
222
246
|
BackupPlanTemplatesList.member = Shapes::ShapeRef.new(shape: BackupPlanTemplatesListMember)
|
@@ -237,6 +261,7 @@ module Aws::Backup
|
|
237
261
|
BackupPlansListMember.add_member(:backup_plan_name, Shapes::ShapeRef.new(shape: BackupPlanName, location_name: "BackupPlanName"))
|
238
262
|
BackupPlansListMember.add_member(:creator_request_id, Shapes::ShapeRef.new(shape: string, location_name: "CreatorRequestId"))
|
239
263
|
BackupPlansListMember.add_member(:last_execution_date, Shapes::ShapeRef.new(shape: timestamp, location_name: "LastExecutionDate"))
|
264
|
+
BackupPlansListMember.add_member(:advanced_backup_settings, Shapes::ShapeRef.new(shape: AdvancedBackupSettings, location_name: "AdvancedBackupSettings"))
|
240
265
|
BackupPlansListMember.struct_class = Types::BackupPlansListMember
|
241
266
|
|
242
267
|
BackupRule.add_member(:rule_name, Shapes::ShapeRef.new(shape: BackupRuleName, required: true, location_name: "RuleName"))
|
@@ -335,6 +360,7 @@ module Aws::Backup
|
|
335
360
|
CreateBackupPlanOutput.add_member(:backup_plan_arn, Shapes::ShapeRef.new(shape: ARN, location_name: "BackupPlanArn"))
|
336
361
|
CreateBackupPlanOutput.add_member(:creation_date, Shapes::ShapeRef.new(shape: timestamp, location_name: "CreationDate"))
|
337
362
|
CreateBackupPlanOutput.add_member(:version_id, Shapes::ShapeRef.new(shape: string, location_name: "VersionId"))
|
363
|
+
CreateBackupPlanOutput.add_member(:advanced_backup_settings, Shapes::ShapeRef.new(shape: AdvancedBackupSettings, location_name: "AdvancedBackupSettings"))
|
338
364
|
CreateBackupPlanOutput.struct_class = Types::CreateBackupPlanOutput
|
339
365
|
|
340
366
|
CreateBackupSelectionInput.add_member(:backup_plan_id, Shapes::ShapeRef.new(shape: string, required: true, location: "uri", location_name: "backupPlanId"))
|
@@ -411,6 +437,8 @@ module Aws::Backup
|
|
411
437
|
DescribeBackupJobOutput.add_member(:bytes_transferred, Shapes::ShapeRef.new(shape: Long, location_name: "BytesTransferred"))
|
412
438
|
DescribeBackupJobOutput.add_member(:expected_completion_date, Shapes::ShapeRef.new(shape: timestamp, location_name: "ExpectedCompletionDate"))
|
413
439
|
DescribeBackupJobOutput.add_member(:start_by, Shapes::ShapeRef.new(shape: timestamp, location_name: "StartBy"))
|
440
|
+
DescribeBackupJobOutput.add_member(:backup_options, Shapes::ShapeRef.new(shape: BackupOptions, location_name: "BackupOptions"))
|
441
|
+
DescribeBackupJobOutput.add_member(:backup_type, Shapes::ShapeRef.new(shape: string, location_name: "BackupType"))
|
414
442
|
DescribeBackupJobOutput.struct_class = Types::DescribeBackupJobOutput
|
415
443
|
|
416
444
|
DescribeBackupVaultInput.add_member(:backup_vault_name, Shapes::ShapeRef.new(shape: string, required: true, location: "uri", location_name: "backupVaultName"))
|
@@ -430,6 +458,12 @@ module Aws::Backup
|
|
430
458
|
DescribeCopyJobOutput.add_member(:copy_job, Shapes::ShapeRef.new(shape: CopyJob, location_name: "CopyJob"))
|
431
459
|
DescribeCopyJobOutput.struct_class = Types::DescribeCopyJobOutput
|
432
460
|
|
461
|
+
DescribeGlobalSettingsInput.struct_class = Types::DescribeGlobalSettingsInput
|
462
|
+
|
463
|
+
DescribeGlobalSettingsOutput.add_member(:global_settings, Shapes::ShapeRef.new(shape: GlobalSettings, location_name: "GlobalSettings"))
|
464
|
+
DescribeGlobalSettingsOutput.add_member(:last_update_time, Shapes::ShapeRef.new(shape: timestamp, location_name: "LastUpdateTime"))
|
465
|
+
DescribeGlobalSettingsOutput.struct_class = Types::DescribeGlobalSettingsOutput
|
466
|
+
|
433
467
|
DescribeProtectedResourceInput.add_member(:resource_arn, Shapes::ShapeRef.new(shape: ARN, required: true, location: "uri", location_name: "resourceArn"))
|
434
468
|
DescribeProtectedResourceInput.struct_class = Types::DescribeProtectedResourceInput
|
435
469
|
|
@@ -445,6 +479,7 @@ module Aws::Backup
|
|
445
479
|
DescribeRecoveryPointOutput.add_member(:recovery_point_arn, Shapes::ShapeRef.new(shape: ARN, location_name: "RecoveryPointArn"))
|
446
480
|
DescribeRecoveryPointOutput.add_member(:backup_vault_name, Shapes::ShapeRef.new(shape: BackupVaultName, location_name: "BackupVaultName"))
|
447
481
|
DescribeRecoveryPointOutput.add_member(:backup_vault_arn, Shapes::ShapeRef.new(shape: ARN, location_name: "BackupVaultArn"))
|
482
|
+
DescribeRecoveryPointOutput.add_member(:source_backup_vault_arn, Shapes::ShapeRef.new(shape: ARN, location_name: "SourceBackupVaultArn"))
|
448
483
|
DescribeRecoveryPointOutput.add_member(:resource_arn, Shapes::ShapeRef.new(shape: ARN, location_name: "ResourceArn"))
|
449
484
|
DescribeRecoveryPointOutput.add_member(:resource_type, Shapes::ShapeRef.new(shape: ResourceType, location_name: "ResourceType"))
|
450
485
|
DescribeRecoveryPointOutput.add_member(:created_by, Shapes::ShapeRef.new(shape: RecoveryPointCreator, location_name: "CreatedBy"))
|
@@ -514,6 +549,7 @@ module Aws::Backup
|
|
514
549
|
GetBackupPlanOutput.add_member(:creation_date, Shapes::ShapeRef.new(shape: timestamp, location_name: "CreationDate"))
|
515
550
|
GetBackupPlanOutput.add_member(:deletion_date, Shapes::ShapeRef.new(shape: timestamp, location_name: "DeletionDate"))
|
516
551
|
GetBackupPlanOutput.add_member(:last_execution_date, Shapes::ShapeRef.new(shape: timestamp, location_name: "LastExecutionDate"))
|
552
|
+
GetBackupPlanOutput.add_member(:advanced_backup_settings, Shapes::ShapeRef.new(shape: AdvancedBackupSettings, location_name: "AdvancedBackupSettings"))
|
517
553
|
GetBackupPlanOutput.struct_class = Types::GetBackupPlanOutput
|
518
554
|
|
519
555
|
GetBackupSelectionInput.add_member(:backup_plan_id, Shapes::ShapeRef.new(shape: string, required: true, location: "uri", location_name: "backupPlanId"))
|
@@ -556,6 +592,9 @@ module Aws::Backup
|
|
556
592
|
GetSupportedResourceTypesOutput.add_member(:resource_types, Shapes::ShapeRef.new(shape: ResourceTypes, location_name: "ResourceTypes"))
|
557
593
|
GetSupportedResourceTypesOutput.struct_class = Types::GetSupportedResourceTypesOutput
|
558
594
|
|
595
|
+
GlobalSettings.key = Shapes::ShapeRef.new(shape: GlobalSettingsName)
|
596
|
+
GlobalSettings.value = Shapes::ShapeRef.new(shape: GlobalSettingsValue)
|
597
|
+
|
559
598
|
InvalidParameterValueException.add_member(:code, Shapes::ShapeRef.new(shape: string, location_name: "Code"))
|
560
599
|
InvalidParameterValueException.add_member(:message, Shapes::ShapeRef.new(shape: string, location_name: "Message"))
|
561
600
|
InvalidParameterValueException.add_member(:type, Shapes::ShapeRef.new(shape: string, location_name: "Type"))
|
@@ -733,6 +772,7 @@ module Aws::Backup
|
|
733
772
|
RecoveryPointByBackupVault.add_member(:recovery_point_arn, Shapes::ShapeRef.new(shape: ARN, location_name: "RecoveryPointArn"))
|
734
773
|
RecoveryPointByBackupVault.add_member(:backup_vault_name, Shapes::ShapeRef.new(shape: BackupVaultName, location_name: "BackupVaultName"))
|
735
774
|
RecoveryPointByBackupVault.add_member(:backup_vault_arn, Shapes::ShapeRef.new(shape: ARN, location_name: "BackupVaultArn"))
|
775
|
+
RecoveryPointByBackupVault.add_member(:source_backup_vault_arn, Shapes::ShapeRef.new(shape: ARN, location_name: "SourceBackupVaultArn"))
|
736
776
|
RecoveryPointByBackupVault.add_member(:resource_arn, Shapes::ShapeRef.new(shape: ARN, location_name: "ResourceArn"))
|
737
777
|
RecoveryPointByBackupVault.add_member(:resource_type, Shapes::ShapeRef.new(shape: ResourceType, location_name: "ResourceType"))
|
738
778
|
RecoveryPointByBackupVault.add_member(:created_by, Shapes::ShapeRef.new(shape: RecoveryPointCreator, location_name: "CreatedBy"))
|
@@ -810,6 +850,7 @@ module Aws::Backup
|
|
810
850
|
StartBackupJobInput.add_member(:complete_window_minutes, Shapes::ShapeRef.new(shape: WindowMinutes, location_name: "CompleteWindowMinutes"))
|
811
851
|
StartBackupJobInput.add_member(:lifecycle, Shapes::ShapeRef.new(shape: Lifecycle, location_name: "Lifecycle"))
|
812
852
|
StartBackupJobInput.add_member(:recovery_point_tags, Shapes::ShapeRef.new(shape: Tags, location_name: "RecoveryPointTags"))
|
853
|
+
StartBackupJobInput.add_member(:backup_options, Shapes::ShapeRef.new(shape: BackupOptions, location_name: "BackupOptions"))
|
813
854
|
StartBackupJobInput.struct_class = Types::StartBackupJobInput
|
814
855
|
|
815
856
|
StartBackupJobOutput.add_member(:backup_job_id, Shapes::ShapeRef.new(shape: string, location_name: "BackupJobId"))
|
@@ -863,8 +904,12 @@ module Aws::Backup
|
|
863
904
|
UpdateBackupPlanOutput.add_member(:backup_plan_arn, Shapes::ShapeRef.new(shape: ARN, location_name: "BackupPlanArn"))
|
864
905
|
UpdateBackupPlanOutput.add_member(:creation_date, Shapes::ShapeRef.new(shape: timestamp, location_name: "CreationDate"))
|
865
906
|
UpdateBackupPlanOutput.add_member(:version_id, Shapes::ShapeRef.new(shape: string, location_name: "VersionId"))
|
907
|
+
UpdateBackupPlanOutput.add_member(:advanced_backup_settings, Shapes::ShapeRef.new(shape: AdvancedBackupSettings, location_name: "AdvancedBackupSettings"))
|
866
908
|
UpdateBackupPlanOutput.struct_class = Types::UpdateBackupPlanOutput
|
867
909
|
|
910
|
+
UpdateGlobalSettingsInput.add_member(:global_settings, Shapes::ShapeRef.new(shape: GlobalSettings, location_name: "GlobalSettings"))
|
911
|
+
UpdateGlobalSettingsInput.struct_class = Types::UpdateGlobalSettingsInput
|
912
|
+
|
868
913
|
UpdateRecoveryPointLifecycleInput.add_member(:backup_vault_name, Shapes::ShapeRef.new(shape: BackupVaultName, required: true, location: "uri", location_name: "backupVaultName"))
|
869
914
|
UpdateRecoveryPointLifecycleInput.add_member(:recovery_point_arn, Shapes::ShapeRef.new(shape: ARN, required: true, location: "uri", location_name: "recoveryPointArn"))
|
870
915
|
UpdateRecoveryPointLifecycleInput.add_member(:lifecycle, Shapes::ShapeRef.new(shape: Lifecycle, location_name: "Lifecycle"))
|
@@ -1047,6 +1092,15 @@ module Aws::Backup
|
|
1047
1092
|
o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
|
1048
1093
|
end)
|
1049
1094
|
|
1095
|
+
api.add_operation(:describe_global_settings, Seahorse::Model::Operation.new.tap do |o|
|
1096
|
+
o.name = "DescribeGlobalSettings"
|
1097
|
+
o.http_method = "GET"
|
1098
|
+
o.http_request_uri = "/global-settings"
|
1099
|
+
o.input = Shapes::ShapeRef.new(shape: DescribeGlobalSettingsInput)
|
1100
|
+
o.output = Shapes::ShapeRef.new(shape: DescribeGlobalSettingsOutput)
|
1101
|
+
o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
|
1102
|
+
end)
|
1103
|
+
|
1050
1104
|
api.add_operation(:describe_protected_resource, Seahorse::Model::Operation.new.tap do |o|
|
1051
1105
|
o.name = "DescribeProtectedResource"
|
1052
1106
|
o.http_method = "GET"
|
@@ -1442,6 +1496,7 @@ module Aws::Backup
|
|
1442
1496
|
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
1443
1497
|
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterValueException)
|
1444
1498
|
o.errors << Shapes::ShapeRef.new(shape: MissingParameterValueException)
|
1499
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
1445
1500
|
o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
|
1446
1501
|
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
|
1447
1502
|
end)
|
@@ -1521,6 +1576,18 @@ module Aws::Backup
|
|
1521
1576
|
o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
|
1522
1577
|
end)
|
1523
1578
|
|
1579
|
+
api.add_operation(:update_global_settings, Seahorse::Model::Operation.new.tap do |o|
|
1580
|
+
o.name = "UpdateGlobalSettings"
|
1581
|
+
o.http_method = "PUT"
|
1582
|
+
o.http_request_uri = "/global-settings"
|
1583
|
+
o.input = Shapes::ShapeRef.new(shape: UpdateGlobalSettingsInput)
|
1584
|
+
o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
|
1585
|
+
o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
|
1586
|
+
o.errors << Shapes::ShapeRef.new(shape: MissingParameterValueException)
|
1587
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterValueException)
|
1588
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
1589
|
+
end)
|
1590
|
+
|
1524
1591
|
api.add_operation(:update_recovery_point_lifecycle, Seahorse::Model::Operation.new.tap do |o|
|
1525
1592
|
o.name = "UpdateRecoveryPointLifecycle"
|
1526
1593
|
o.http_method = "POST"
|
data/lib/aws-sdk-backup/types.rb
CHANGED
@@ -10,6 +10,63 @@
|
|
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
|
+
# Specifies an object containing resource type and backup options. The
|
27
|
+
# only supported resource type is Amazon EC2 instances with Windows
|
28
|
+
# VSS. For an CloudFormation example, see the [sample CloudFormation
|
29
|
+
# template to enable Windows VSS][1] in the *AWS Backup User Guide*.
|
30
|
+
#
|
31
|
+
# Valid values: `EC2`.
|
32
|
+
#
|
33
|
+
#
|
34
|
+
#
|
35
|
+
# [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/integrate-cloudformation-with-aws-backup.html
|
36
|
+
# @return [String]
|
37
|
+
#
|
38
|
+
# @!attribute [rw] backup_options
|
39
|
+
# Specifies the backup option for a selected resource. This option is
|
40
|
+
# only available for Windows VSS backup jobs.
|
41
|
+
#
|
42
|
+
# Valid values:
|
43
|
+
#
|
44
|
+
# Set to `"WindowsVSS":"enabled"` to enable the WindowsVSS backup
|
45
|
+
# option and create a VSS Windows backup.
|
46
|
+
#
|
47
|
+
# Set to `"WindowsVSS":"disabled"` to create a regular backup. The
|
48
|
+
# WindowsVSS option is not enabled by default.
|
49
|
+
#
|
50
|
+
# If you specify an invalid option, you get an
|
51
|
+
# `InvalidParameterValueException` exception.
|
52
|
+
#
|
53
|
+
# For more information about Windows VSS backups, see [Creating a
|
54
|
+
# VSS-Enabled Windows Backup][1].
|
55
|
+
#
|
56
|
+
#
|
57
|
+
#
|
58
|
+
# [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/windows-backups.html
|
59
|
+
# @return [Hash<String,String>]
|
60
|
+
#
|
61
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/AdvancedBackupSetting AWS API Documentation
|
62
|
+
#
|
63
|
+
class AdvancedBackupSetting < Struct.new(
|
64
|
+
:resource_type,
|
65
|
+
:backup_options)
|
66
|
+
SENSITIVE = []
|
67
|
+
include Aws::Structure
|
68
|
+
end
|
69
|
+
|
13
70
|
# The required resource already exists.
|
14
71
|
#
|
15
72
|
# @!attribute [rw] code
|
@@ -109,8 +166,11 @@ module Aws::Backup
|
|
109
166
|
# @return [Integer]
|
110
167
|
#
|
111
168
|
# @!attribute [rw] iam_role_arn
|
112
|
-
# Specifies the IAM role ARN used to create the target recovery point
|
113
|
-
#
|
169
|
+
# Specifies the IAM role ARN used to create the target recovery point.
|
170
|
+
# IAM roles other than the default role must include either
|
171
|
+
# `AWSBackup` or `AwsBackup` in the role name. For example,
|
172
|
+
# `arn:aws:iam::123456789012:role/AWSBackupRDSAccess`. Role names
|
173
|
+
# without those strings lack permissions to perform backup jobs.
|
114
174
|
# @return [String]
|
115
175
|
#
|
116
176
|
# @!attribute [rw] created_by
|
@@ -141,7 +201,8 @@ module Aws::Backup
|
|
141
201
|
# @!attribute [rw] resource_type
|
142
202
|
# The type of AWS resource to be backed up; for example, an Amazon
|
143
203
|
# Elastic Block Store (Amazon EBS) volume or an Amazon Relational
|
144
|
-
# Database Service (Amazon RDS) database.
|
204
|
+
# Database Service (Amazon RDS) database. For VSS Windows backups, the
|
205
|
+
# only supported resource type is Amazon EC2.
|
145
206
|
# @return [String]
|
146
207
|
#
|
147
208
|
# @!attribute [rw] bytes_transferred
|
@@ -149,6 +210,21 @@ module Aws::Backup
|
|
149
210
|
# job status was queried.
|
150
211
|
# @return [Integer]
|
151
212
|
#
|
213
|
+
# @!attribute [rw] backup_options
|
214
|
+
# Specifies the backup option for a selected resource. This option is
|
215
|
+
# only available for Windows VSS backup jobs.
|
216
|
+
#
|
217
|
+
# Valid values: Set to `"WindowsVSS”:“enabled"` to enable WindowsVSS
|
218
|
+
# backup option and create a VSS Windows backup. Set to
|
219
|
+
# “WindowsVSS”:”disabled” to create a regular backup. If you specify
|
220
|
+
# an invalid option, you get an `InvalidParameterValueException`
|
221
|
+
# exception.
|
222
|
+
# @return [Hash<String,String>]
|
223
|
+
#
|
224
|
+
# @!attribute [rw] backup_type
|
225
|
+
# Represents the type of backup for a backup job.
|
226
|
+
# @return [String]
|
227
|
+
#
|
152
228
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/BackupJob AWS API Documentation
|
153
229
|
#
|
154
230
|
class BackupJob < Struct.new(
|
@@ -169,7 +245,9 @@ module Aws::Backup
|
|
169
245
|
:expected_completion_date,
|
170
246
|
:start_by,
|
171
247
|
:resource_type,
|
172
|
-
:bytes_transferred
|
248
|
+
:bytes_transferred,
|
249
|
+
:backup_options,
|
250
|
+
:backup_type)
|
173
251
|
SENSITIVE = []
|
174
252
|
include Aws::Structure
|
175
253
|
end
|
@@ -188,11 +266,16 @@ module Aws::Backup
|
|
188
266
|
# scheduled task that is used to back up a selection of resources.
|
189
267
|
# @return [Array<Types::BackupRule>]
|
190
268
|
#
|
269
|
+
# @!attribute [rw] advanced_backup_settings
|
270
|
+
# Contains a list of `BackupOptions` for each resource type.
|
271
|
+
# @return [Array<Types::AdvancedBackupSetting>]
|
272
|
+
#
|
191
273
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/BackupPlan AWS API Documentation
|
192
274
|
#
|
193
275
|
class BackupPlan < Struct.new(
|
194
276
|
:backup_plan_name,
|
195
|
-
:rules
|
277
|
+
:rules,
|
278
|
+
:advanced_backup_settings)
|
196
279
|
SENSITIVE = []
|
197
280
|
include Aws::Structure
|
198
281
|
end
|
@@ -232,6 +315,14 @@ module Aws::Backup
|
|
232
315
|
# ],
|
233
316
|
# },
|
234
317
|
# ],
|
318
|
+
# advanced_backup_settings: [
|
319
|
+
# {
|
320
|
+
# resource_type: "ResourceType",
|
321
|
+
# backup_options: {
|
322
|
+
# "BackupOptionKey" => "BackupOptionValue",
|
323
|
+
# },
|
324
|
+
# },
|
325
|
+
# ],
|
235
326
|
# }
|
236
327
|
#
|
237
328
|
# @!attribute [rw] backup_plan_name
|
@@ -243,11 +334,17 @@ module Aws::Backup
|
|
243
334
|
# scheduled task that is used to back up a selection of resources.
|
244
335
|
# @return [Array<Types::BackupRuleInput>]
|
245
336
|
#
|
337
|
+
# @!attribute [rw] advanced_backup_settings
|
338
|
+
# Specifies a list of `BackupOptions` for each resource type. These
|
339
|
+
# settings are only available for Windows VSS backup jobs.
|
340
|
+
# @return [Array<Types::AdvancedBackupSetting>]
|
341
|
+
#
|
246
342
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/BackupPlanInput AWS API Documentation
|
247
343
|
#
|
248
344
|
class BackupPlanInput < Struct.new(
|
249
345
|
:backup_plan_name,
|
250
|
-
:rules
|
346
|
+
:rules,
|
347
|
+
:advanced_backup_settings)
|
251
348
|
SENSITIVE = []
|
252
349
|
include Aws::Structure
|
253
350
|
end
|
@@ -308,18 +405,22 @@ module Aws::Backup
|
|
308
405
|
#
|
309
406
|
# @!attribute [rw] creator_request_id
|
310
407
|
# A unique string that identifies the request and allows failed
|
311
|
-
# requests to be retried without the risk of
|
408
|
+
# requests to be retried without the risk of running the operation
|
312
409
|
# twice.
|
313
410
|
# @return [String]
|
314
411
|
#
|
315
412
|
# @!attribute [rw] last_execution_date
|
316
|
-
# The last time a job to back up resources was
|
317
|
-
#
|
318
|
-
#
|
319
|
-
#
|
413
|
+
# The last time a job to back up resources was run with this rule. A
|
414
|
+
# date and time, in Unix format and Coordinated Universal Time (UTC).
|
415
|
+
# The value of `LastExecutionDate` is accurate to milliseconds. For
|
416
|
+
# example, the value 1516925490.087 represents Friday, January 26,
|
320
417
|
# 2018 12:11:30.087 AM.
|
321
418
|
# @return [Time]
|
322
419
|
#
|
420
|
+
# @!attribute [rw] advanced_backup_settings
|
421
|
+
# Contains a list of `BackupOptions` for a resource type.
|
422
|
+
# @return [Array<Types::AdvancedBackupSetting>]
|
423
|
+
#
|
323
424
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/BackupPlansListMember AWS API Documentation
|
324
425
|
#
|
325
426
|
class BackupPlansListMember < Struct.new(
|
@@ -330,7 +431,8 @@ module Aws::Backup
|
|
330
431
|
:version_id,
|
331
432
|
:backup_plan_name,
|
332
433
|
:creator_request_id,
|
333
|
-
:last_execution_date
|
434
|
+
:last_execution_date,
|
435
|
+
:advanced_backup_settings)
|
334
436
|
SENSITIVE = []
|
335
437
|
include Aws::Structure
|
336
438
|
end
|
@@ -350,6 +452,15 @@ module Aws::Backup
|
|
350
452
|
#
|
351
453
|
# @!attribute [rw] schedule_expression
|
352
454
|
# A CRON expression specifying when AWS Backup initiates a backup job.
|
455
|
+
# For more information about cron expressions, see [Schedule
|
456
|
+
# Expressions for Rules][1] in the *Amazon CloudWatch Events User
|
457
|
+
# Guide.*. Prior to specifying a value for this parameter, we
|
458
|
+
# recommend testing your cron expression using one of the many
|
459
|
+
# available cron generator and testing tools.
|
460
|
+
#
|
461
|
+
#
|
462
|
+
#
|
463
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html
|
353
464
|
# @return [String]
|
354
465
|
#
|
355
466
|
# @!attribute [rw] start_window_minutes
|
@@ -373,6 +484,9 @@ module Aws::Backup
|
|
373
484
|
# must be 90 days greater than the “transition to cold after days”
|
374
485
|
# setting. The “transition to cold after days” setting cannot be
|
375
486
|
# changed after a backup has been transitioned to cold.
|
487
|
+
#
|
488
|
+
# Only Amazon EFS file system backups can be transitioned to cold
|
489
|
+
# storage.
|
376
490
|
# @return [Types::Lifecycle]
|
377
491
|
#
|
378
492
|
# @!attribute [rw] recovery_point_tags
|
@@ -472,6 +586,9 @@ module Aws::Backup
|
|
472
586
|
# must be 90 days greater than the “transition to cold after days”
|
473
587
|
# setting. The “transition to cold after days” setting cannot be
|
474
588
|
# changed after a backup has been transitioned to cold.
|
589
|
+
#
|
590
|
+
# Only Amazon EFS file system backups can be transitioned to cold
|
591
|
+
# storage.
|
475
592
|
# @return [Types::Lifecycle]
|
476
593
|
#
|
477
594
|
# @!attribute [rw] recovery_point_tags
|
@@ -535,7 +652,8 @@ module Aws::Backup
|
|
535
652
|
# @!attribute [rw] list_of_tags
|
536
653
|
# An array of conditions used to specify a set of resources to assign
|
537
654
|
# to a backup plan; for example, `"StringEquals":
|
538
|
-
# \{"ec2:ResourceTag/Department": "accounting"`.
|
655
|
+
# \{"ec2:ResourceTag/Department": "accounting"`. Assigns the backup
|
656
|
+
# plan to every resource with at least one matching tag.
|
539
657
|
# @return [Array<Types::Condition>]
|
540
658
|
#
|
541
659
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/BackupSelection AWS API Documentation
|
@@ -573,7 +691,7 @@ module Aws::Backup
|
|
573
691
|
#
|
574
692
|
# @!attribute [rw] creator_request_id
|
575
693
|
# A unique string that identifies the request and allows failed
|
576
|
-
# requests to be retried without the risk of
|
694
|
+
# requests to be retried without the risk of running the operation
|
577
695
|
# twice.
|
578
696
|
# @return [String]
|
579
697
|
#
|
@@ -626,7 +744,7 @@ module Aws::Backup
|
|
626
744
|
#
|
627
745
|
# @!attribute [rw] creator_request_id
|
628
746
|
# A unique string that identifies the request and allows failed
|
629
|
-
# requests to be retried without the risk of
|
747
|
+
# requests to be retried without the risk of running the operation
|
630
748
|
# twice.
|
631
749
|
# @return [String]
|
632
750
|
#
|
@@ -660,6 +778,9 @@ module Aws::Backup
|
|
660
778
|
# setting. The “transition to cold after days” setting cannot be changed
|
661
779
|
# after a backup has been transitioned to cold.
|
662
780
|
#
|
781
|
+
# Only Amazon EFS file system backups can be transitioned to cold
|
782
|
+
# storage.
|
783
|
+
#
|
663
784
|
# @!attribute [rw] move_to_cold_storage_at
|
664
785
|
# A timestamp that specifies when to transition a recovery point to
|
665
786
|
# cold storage.
|
@@ -742,6 +863,9 @@ module Aws::Backup
|
|
742
863
|
# cold after days” setting. The “transition to cold after days”
|
743
864
|
# setting cannot be changed after a backup has been transitioned to
|
744
865
|
# cold.
|
866
|
+
#
|
867
|
+
# Only Amazon EFS file system backups can be transitioned to cold
|
868
|
+
# storage.
|
745
869
|
# @return [Types::Lifecycle]
|
746
870
|
#
|
747
871
|
# @!attribute [rw] destination_backup_vault_arn
|
@@ -895,6 +1019,14 @@ module Aws::Backup
|
|
895
1019
|
# ],
|
896
1020
|
# },
|
897
1021
|
# ],
|
1022
|
+
# advanced_backup_settings: [
|
1023
|
+
# {
|
1024
|
+
# resource_type: "ResourceType",
|
1025
|
+
# backup_options: {
|
1026
|
+
# "BackupOptionKey" => "BackupOptionValue",
|
1027
|
+
# },
|
1028
|
+
# },
|
1029
|
+
# ],
|
898
1030
|
# },
|
899
1031
|
# backup_plan_tags: {
|
900
1032
|
# "TagKey" => "TagValue",
|
@@ -915,7 +1047,7 @@ module Aws::Backup
|
|
915
1047
|
#
|
916
1048
|
# @!attribute [rw] creator_request_id
|
917
1049
|
# Identifies the request and allows failed requests to be retried
|
918
|
-
# without the risk of
|
1050
|
+
# without the risk of running the operation twice. If the request
|
919
1051
|
# includes a `CreatorRequestId` that matches an existing backup plan,
|
920
1052
|
# that plan is returned. This parameter is optional.
|
921
1053
|
# @return [String]
|
@@ -952,13 +1084,19 @@ module Aws::Backup
|
|
952
1084
|
# at most 1,024 bytes long. They cannot be edited.
|
953
1085
|
# @return [String]
|
954
1086
|
#
|
1087
|
+
# @!attribute [rw] advanced_backup_settings
|
1088
|
+
# A list of `BackupOptions` settings for a resource type. This option
|
1089
|
+
# is only available for Windows VSS backup jobs.
|
1090
|
+
# @return [Array<Types::AdvancedBackupSetting>]
|
1091
|
+
#
|
955
1092
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/CreateBackupPlanOutput AWS API Documentation
|
956
1093
|
#
|
957
1094
|
class CreateBackupPlanOutput < Struct.new(
|
958
1095
|
:backup_plan_id,
|
959
1096
|
:backup_plan_arn,
|
960
1097
|
:creation_date,
|
961
|
-
:version_id
|
1098
|
+
:version_id,
|
1099
|
+
:advanced_backup_settings)
|
962
1100
|
SENSITIVE = []
|
963
1101
|
include Aws::Structure
|
964
1102
|
end
|
@@ -995,7 +1133,7 @@ module Aws::Backup
|
|
995
1133
|
#
|
996
1134
|
# @!attribute [rw] creator_request_id
|
997
1135
|
# A unique string that identifies the request and allows failed
|
998
|
-
# requests to be retried without the risk of
|
1136
|
+
# requests to be retried without the risk of running the operation
|
999
1137
|
# twice.
|
1000
1138
|
# @return [String]
|
1001
1139
|
#
|
@@ -1051,7 +1189,7 @@ module Aws::Backup
|
|
1051
1189
|
# The name of a logical container where backups are stored. Backup
|
1052
1190
|
# vaults are identified by names that are unique to the account used
|
1053
1191
|
# to create them and the AWS Region where they are created. They
|
1054
|
-
# consist of
|
1192
|
+
# consist of letters, numbers, and hyphens.
|
1055
1193
|
# @return [String]
|
1056
1194
|
#
|
1057
1195
|
# @!attribute [rw] backup_vault_tags
|
@@ -1067,7 +1205,7 @@ module Aws::Backup
|
|
1067
1205
|
#
|
1068
1206
|
# @!attribute [rw] creator_request_id
|
1069
1207
|
# A unique string that identifies the request and allows failed
|
1070
|
-
# requests to be retried without the risk of
|
1208
|
+
# requests to be retried without the risk of running the operation
|
1071
1209
|
# twice.
|
1072
1210
|
# @return [String]
|
1073
1211
|
#
|
@@ -1150,7 +1288,7 @@ module Aws::Backup
|
|
1150
1288
|
#
|
1151
1289
|
# @!attribute [rw] version_id
|
1152
1290
|
# Unique, randomly generated, Unicode, UTF-8 encoded strings that are
|
1153
|
-
# at most 1,024 bytes long. Version
|
1291
|
+
# at most 1,024 bytes long. Version IDs cannot be edited.
|
1154
1292
|
# @return [String]
|
1155
1293
|
#
|
1156
1294
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DeleteBackupPlanOutput AWS API Documentation
|
@@ -1435,6 +1573,18 @@ module Aws::Backup
|
|
1435
1573
|
# 12:11:30.087 AM.
|
1436
1574
|
# @return [Time]
|
1437
1575
|
#
|
1576
|
+
# @!attribute [rw] backup_options
|
1577
|
+
# Represents the options specified as part of backup plan or on-demand
|
1578
|
+
# backup job.
|
1579
|
+
# @return [Hash<String,String>]
|
1580
|
+
#
|
1581
|
+
# @!attribute [rw] backup_type
|
1582
|
+
# Represents the actual backup type selected for a backup job. For
|
1583
|
+
# example, if a successful WindowsVSS backup was taken, `BackupType`
|
1584
|
+
# returns "WindowsVSS". If `BackupType` is empty, then the backup
|
1585
|
+
# type that was is a regular backup.
|
1586
|
+
# @return [String]
|
1587
|
+
#
|
1438
1588
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeBackupJobOutput AWS API Documentation
|
1439
1589
|
#
|
1440
1590
|
class DescribeBackupJobOutput < Struct.new(
|
@@ -1455,7 +1605,9 @@ module Aws::Backup
|
|
1455
1605
|
:resource_type,
|
1456
1606
|
:bytes_transferred,
|
1457
1607
|
:expected_completion_date,
|
1458
|
-
:start_by
|
1608
|
+
:start_by,
|
1609
|
+
:backup_options,
|
1610
|
+
:backup_type)
|
1459
1611
|
SENSITIVE = []
|
1460
1612
|
include Aws::Structure
|
1461
1613
|
end
|
@@ -1510,7 +1662,7 @@ module Aws::Backup
|
|
1510
1662
|
#
|
1511
1663
|
# @!attribute [rw] creator_request_id
|
1512
1664
|
# A unique string that identifies the request and allows failed
|
1513
|
-
# requests to be retried without the risk of
|
1665
|
+
# requests to be retried without the risk of running the operation
|
1514
1666
|
# twice.
|
1515
1667
|
# @return [String]
|
1516
1668
|
#
|
@@ -1562,6 +1714,34 @@ module Aws::Backup
|
|
1562
1714
|
include Aws::Structure
|
1563
1715
|
end
|
1564
1716
|
|
1717
|
+
# @api private
|
1718
|
+
#
|
1719
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeGlobalSettingsInput AWS API Documentation
|
1720
|
+
#
|
1721
|
+
class DescribeGlobalSettingsInput < Aws::EmptyStructure; end
|
1722
|
+
|
1723
|
+
# @!attribute [rw] global_settings
|
1724
|
+
# A list of resources along with the opt-in preferences for the
|
1725
|
+
# account.
|
1726
|
+
# @return [Hash<String,String>]
|
1727
|
+
#
|
1728
|
+
# @!attribute [rw] last_update_time
|
1729
|
+
# The date and time that the global settings were last updated. This
|
1730
|
+
# update is in Unix format and Coordinated Universal Time (UTC). The
|
1731
|
+
# value of `LastUpdateTime` is accurate to milliseconds. For example,
|
1732
|
+
# the value 1516925490.087 represents Friday, January 26, 2018
|
1733
|
+
# 12:11:30.087 AM.
|
1734
|
+
# @return [Time]
|
1735
|
+
#
|
1736
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeGlobalSettingsOutput AWS API Documentation
|
1737
|
+
#
|
1738
|
+
class DescribeGlobalSettingsOutput < Struct.new(
|
1739
|
+
:global_settings,
|
1740
|
+
:last_update_time)
|
1741
|
+
SENSITIVE = []
|
1742
|
+
include Aws::Structure
|
1743
|
+
end
|
1744
|
+
|
1565
1745
|
# @note When making an API call, you may pass DescribeProtectedResourceInput
|
1566
1746
|
# data as a hash:
|
1567
1747
|
#
|
@@ -1656,6 +1836,14 @@ module Aws::Backup
|
|
1656
1836
|
# `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`.
|
1657
1837
|
# @return [String]
|
1658
1838
|
#
|
1839
|
+
# @!attribute [rw] source_backup_vault_arn
|
1840
|
+
# An Amazon Resource Name (ARN) that uniquely identifies the source
|
1841
|
+
# vault where the resource was originally backed up in; for example,
|
1842
|
+
# `arn:aws:backup:us-east-1:123456789012:vault:BackupVault`. If the
|
1843
|
+
# recovery is restored to the same AWS account or Region, this value
|
1844
|
+
# will be `null`.
|
1845
|
+
# @return [String]
|
1846
|
+
#
|
1659
1847
|
# @!attribute [rw] resource_arn
|
1660
1848
|
# An ARN that uniquely identifies a saved resource. The format of the
|
1661
1849
|
# ARN depends on the resource type.
|
@@ -1722,6 +1910,9 @@ module Aws::Backup
|
|
1722
1910
|
# setting must be 90 days greater than the “transition to cold after
|
1723
1911
|
# days” setting. The “transition to cold after days” setting cannot be
|
1724
1912
|
# changed after a backup has been transitioned to cold.
|
1913
|
+
#
|
1914
|
+
# Only Amazon EFS file system backups can be transitioned to cold
|
1915
|
+
# storage.
|
1725
1916
|
# @return [Types::Lifecycle]
|
1726
1917
|
#
|
1727
1918
|
# @!attribute [rw] encryption_key_arn
|
@@ -1755,6 +1946,7 @@ module Aws::Backup
|
|
1755
1946
|
:recovery_point_arn,
|
1756
1947
|
:backup_vault_name,
|
1757
1948
|
:backup_vault_arn,
|
1949
|
+
:source_backup_vault_arn,
|
1758
1950
|
:resource_arn,
|
1759
1951
|
:resource_type,
|
1760
1952
|
:created_by,
|
@@ -1781,7 +1973,7 @@ module Aws::Backup
|
|
1781
1973
|
|
1782
1974
|
# @!attribute [rw] resource_type_opt_in_preference
|
1783
1975
|
# Returns a list of all services along with the opt-in preferences in
|
1784
|
-
# the
|
1976
|
+
# the Region.
|
1785
1977
|
# @return [Hash<String,Boolean>]
|
1786
1978
|
#
|
1787
1979
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeRegionSettingsOutput AWS API Documentation
|
@@ -2046,7 +2238,7 @@ module Aws::Backup
|
|
2046
2238
|
#
|
2047
2239
|
# @!attribute [rw] creator_request_id
|
2048
2240
|
# A unique string that identifies the request and allows failed
|
2049
|
-
# requests to be retried without the risk of
|
2241
|
+
# requests to be retried without the risk of running the operation
|
2050
2242
|
# twice.
|
2051
2243
|
# @return [String]
|
2052
2244
|
#
|
@@ -2065,13 +2257,18 @@ module Aws::Backup
|
|
2065
2257
|
# @return [Time]
|
2066
2258
|
#
|
2067
2259
|
# @!attribute [rw] last_execution_date
|
2068
|
-
# The last time a job to back up resources was
|
2069
|
-
#
|
2070
|
-
#
|
2071
|
-
#
|
2072
|
-
#
|
2260
|
+
# The last time a job to back up resources was run with this backup
|
2261
|
+
# plan. A date and time, in Unix format and Coordinated Universal Time
|
2262
|
+
# (UTC). The value of `LastExecutionDate` is accurate to milliseconds.
|
2263
|
+
# For example, the value 1516925490.087 represents Friday, January 26,
|
2264
|
+
# 2018 12:11:30.087 AM.
|
2073
2265
|
# @return [Time]
|
2074
2266
|
#
|
2267
|
+
# @!attribute [rw] advanced_backup_settings
|
2268
|
+
# Contains a list of `BackupOptions` for each resource type. The list
|
2269
|
+
# is populated only if the advanced option is set for the backup plan.
|
2270
|
+
# @return [Array<Types::AdvancedBackupSetting>]
|
2271
|
+
#
|
2075
2272
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetBackupPlanOutput AWS API Documentation
|
2076
2273
|
#
|
2077
2274
|
class GetBackupPlanOutput < Struct.new(
|
@@ -2082,7 +2279,8 @@ module Aws::Backup
|
|
2082
2279
|
:creator_request_id,
|
2083
2280
|
:creation_date,
|
2084
2281
|
:deletion_date,
|
2085
|
-
:last_execution_date
|
2282
|
+
:last_execution_date,
|
2283
|
+
:advanced_backup_settings)
|
2086
2284
|
SENSITIVE = []
|
2087
2285
|
include Aws::Structure
|
2088
2286
|
end
|
@@ -2136,7 +2334,7 @@ module Aws::Backup
|
|
2136
2334
|
#
|
2137
2335
|
# @!attribute [rw] creator_request_id
|
2138
2336
|
# A unique string that identifies the request and allows failed
|
2139
|
-
# requests to be retried without the risk of
|
2337
|
+
# requests to be retried without the risk of running the operation
|
2140
2338
|
# twice.
|
2141
2339
|
# @return [String]
|
2142
2340
|
#
|
@@ -2299,7 +2497,7 @@ module Aws::Backup
|
|
2299
2497
|
# @return [String]
|
2300
2498
|
#
|
2301
2499
|
# @!attribute [rw] restore_metadata
|
2302
|
-
# The set of metadata key-value pairs that
|
2500
|
+
# The set of metadata key-value pairs that describe the original
|
2303
2501
|
# configuration of the backed-up resource. These values vary depending
|
2304
2502
|
# on the service that is being restored.
|
2305
2503
|
# @return [Hash<String,String>]
|
@@ -2327,6 +2525,8 @@ module Aws::Backup
|
|
2327
2525
|
#
|
2328
2526
|
# * `RDS` for Amazon Relational Database Service
|
2329
2527
|
#
|
2528
|
+
# * `Aurora` for Amazon Aurora
|
2529
|
+
#
|
2330
2530
|
# * `Storage Gateway` for AWS Storage Gateway
|
2331
2531
|
# @return [Array<String>]
|
2332
2532
|
#
|
@@ -2399,6 +2599,9 @@ module Aws::Backup
|
|
2399
2599
|
# after days” setting. The “transition to cold after days” setting
|
2400
2600
|
# cannot be changed after a backup has been transitioned to cold.
|
2401
2601
|
#
|
2602
|
+
# Only Amazon EFS file system backups can be transitioned to cold
|
2603
|
+
# storage.
|
2604
|
+
#
|
2402
2605
|
# @note When making an API call, you may pass Lifecycle
|
2403
2606
|
# data as a hash:
|
2404
2607
|
#
|
@@ -2517,12 +2720,17 @@ module Aws::Backup
|
|
2517
2720
|
#
|
2518
2721
|
# * `RDS` for Amazon Relational Database Service
|
2519
2722
|
#
|
2723
|
+
# * `Aurora` for Amazon Aurora
|
2724
|
+
#
|
2520
2725
|
# * `Storage Gateway` for AWS Storage Gateway
|
2521
2726
|
# @return [String]
|
2522
2727
|
#
|
2523
2728
|
# @!attribute [rw] by_account_id
|
2524
2729
|
# The account ID to list the jobs from. Returns only backup jobs
|
2525
2730
|
# associated with the specified account ID.
|
2731
|
+
#
|
2732
|
+
# If used from an AWS Organizations management account, passing `*`
|
2733
|
+
# returns all jobs across the organization.
|
2526
2734
|
# @return [String]
|
2527
2735
|
#
|
2528
2736
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListBackupJobsInput AWS API Documentation
|
@@ -2884,6 +3092,8 @@ module Aws::Backup
|
|
2884
3092
|
#
|
2885
3093
|
# * `RDS` for Amazon Relational Database Service
|
2886
3094
|
#
|
3095
|
+
# * `Aurora` for Amazon Aurora
|
3096
|
+
#
|
2887
3097
|
# * `Storage Gateway` for AWS Storage Gateway
|
2888
3098
|
# @return [String]
|
2889
3099
|
#
|
@@ -3301,7 +3511,8 @@ module Aws::Backup
|
|
3301
3511
|
# @!attribute [rw] resource_type
|
3302
3512
|
# The type of AWS resource; for example, an Amazon Elastic Block Store
|
3303
3513
|
# (Amazon EBS) volume or an Amazon Relational Database Service (Amazon
|
3304
|
-
# RDS) database.
|
3514
|
+
# RDS) database. For VSS Windows backups, the only supported resource
|
3515
|
+
# type is Amazon EC2.
|
3305
3516
|
# @return [String]
|
3306
3517
|
#
|
3307
3518
|
# @!attribute [rw] last_backup_time
|
@@ -3407,6 +3618,12 @@ module Aws::Backup
|
|
3407
3618
|
# `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`.
|
3408
3619
|
# @return [String]
|
3409
3620
|
#
|
3621
|
+
# @!attribute [rw] source_backup_vault_arn
|
3622
|
+
# The backup vault where the recovery point was originally copied
|
3623
|
+
# from. If the recovery point is restored to the same account this
|
3624
|
+
# value will be `null`.
|
3625
|
+
# @return [String]
|
3626
|
+
#
|
3410
3627
|
# @!attribute [rw] resource_arn
|
3411
3628
|
# An ARN that uniquely identifies a resource. The format of the ARN
|
3412
3629
|
# depends on the resource type.
|
@@ -3415,7 +3632,8 @@ module Aws::Backup
|
|
3415
3632
|
# @!attribute [rw] resource_type
|
3416
3633
|
# The type of AWS resource saved as a recovery point; for example, an
|
3417
3634
|
# Amazon Elastic Block Store (Amazon EBS) volume or an Amazon
|
3418
|
-
# Relational Database Service (Amazon RDS) database.
|
3635
|
+
# Relational Database Service (Amazon RDS) database. For VSS Windows
|
3636
|
+
# backups, the only supported resource type is Amazon EC2.
|
3419
3637
|
# @return [String]
|
3420
3638
|
#
|
3421
3639
|
# @!attribute [rw] created_by
|
@@ -3467,6 +3685,9 @@ module Aws::Backup
|
|
3467
3685
|
# must be 90 days greater than the “transition to cold after days”
|
3468
3686
|
# setting. The “transition to cold after days” setting cannot be
|
3469
3687
|
# changed after a backup has been transitioned to cold.
|
3688
|
+
#
|
3689
|
+
# Only Amazon EFS file system backups can be transitioned to cold
|
3690
|
+
# storage.
|
3470
3691
|
# @return [Types::Lifecycle]
|
3471
3692
|
#
|
3472
3693
|
# @!attribute [rw] encryption_key_arn
|
@@ -3494,6 +3715,7 @@ module Aws::Backup
|
|
3494
3715
|
:recovery_point_arn,
|
3495
3716
|
:backup_vault_name,
|
3496
3717
|
:backup_vault_arn,
|
3718
|
+
:source_backup_vault_arn,
|
3497
3719
|
:resource_arn,
|
3498
3720
|
:resource_type,
|
3499
3721
|
:created_by,
|
@@ -3685,7 +3907,8 @@ module Aws::Backup
|
|
3685
3907
|
# @!attribute [rw] resource_type
|
3686
3908
|
# The resource type of the listed restore jobs; for example, an Amazon
|
3687
3909
|
# Elastic Block Store (Amazon EBS) volume or an Amazon Relational
|
3688
|
-
# Database Service (Amazon RDS) database.
|
3910
|
+
# Database Service (Amazon RDS) database. For VSS Windows backups, the
|
3911
|
+
# only supported resource type is Amazon EC2.
|
3689
3912
|
# @return [String]
|
3690
3913
|
#
|
3691
3914
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/RestoreJobsListMember AWS API Documentation
|
@@ -3750,6 +3973,9 @@ module Aws::Backup
|
|
3750
3973
|
# recovery_point_tags: {
|
3751
3974
|
# "TagKey" => "TagValue",
|
3752
3975
|
# },
|
3976
|
+
# backup_options: {
|
3977
|
+
# "BackupOptionKey" => "BackupOptionValue",
|
3978
|
+
# },
|
3753
3979
|
# }
|
3754
3980
|
#
|
3755
3981
|
# @!attribute [rw] backup_vault_name
|
@@ -3776,13 +4002,16 @@ module Aws::Backup
|
|
3776
4002
|
#
|
3777
4003
|
# @!attribute [rw] start_window_minutes
|
3778
4004
|
# A value in minutes after a backup is scheduled before a job will be
|
3779
|
-
# canceled if it doesn't start successfully. This value is optional
|
4005
|
+
# canceled if it doesn't start successfully. This value is optional,
|
4006
|
+
# and the default is 8 hours.
|
3780
4007
|
# @return [Integer]
|
3781
4008
|
#
|
3782
4009
|
# @!attribute [rw] complete_window_minutes
|
3783
|
-
# A value in minutes
|
3784
|
-
#
|
3785
|
-
# value
|
4010
|
+
# A value in minutes during which a successfully started backup must
|
4011
|
+
# complete, or else AWS Backup will cancel the job. This value is
|
4012
|
+
# optional. This value begins counting down from when the backup was
|
4013
|
+
# scheduled. It does not add additional time for `StartWindowMinutes`,
|
4014
|
+
# or if the backup started later than scheduled.
|
3786
4015
|
# @return [Integer]
|
3787
4016
|
#
|
3788
4017
|
# @!attribute [rw] lifecycle
|
@@ -3796,6 +4025,9 @@ module Aws::Backup
|
|
3796
4025
|
# must be 90 days greater than the “transition to cold after days”
|
3797
4026
|
# setting. The “transition to cold after days” setting cannot be
|
3798
4027
|
# changed after a backup has been transitioned to cold.
|
4028
|
+
#
|
4029
|
+
# Only Amazon EFS file system backups can be transitioned to cold
|
4030
|
+
# storage.
|
3799
4031
|
# @return [Types::Lifecycle]
|
3800
4032
|
#
|
3801
4033
|
# @!attribute [rw] recovery_point_tags
|
@@ -3803,6 +4035,16 @@ module Aws::Backup
|
|
3803
4035
|
# the resources that you create. Each tag is a key-value pair.
|
3804
4036
|
# @return [Hash<String,String>]
|
3805
4037
|
#
|
4038
|
+
# @!attribute [rw] backup_options
|
4039
|
+
# Specifies the backup option for a selected resource. This option is
|
4040
|
+
# only available for Windows VSS backup jobs.
|
4041
|
+
#
|
4042
|
+
# Valid values: Set to `"WindowsVSS”:“enabled"` to enable WindowsVSS
|
4043
|
+
# backup option and create a VSS Windows backup. Set to
|
4044
|
+
# “WindowsVSS”:”disabled” to create a regular backup. The WindowsVSS
|
4045
|
+
# option is not enabled by default.
|
4046
|
+
# @return [Hash<String,String>]
|
4047
|
+
#
|
3806
4048
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/StartBackupJobInput AWS API Documentation
|
3807
4049
|
#
|
3808
4050
|
class StartBackupJobInput < Struct.new(
|
@@ -3813,7 +4055,8 @@ module Aws::Backup
|
|
3813
4055
|
:start_window_minutes,
|
3814
4056
|
:complete_window_minutes,
|
3815
4057
|
:lifecycle,
|
3816
|
-
:recovery_point_tags
|
4058
|
+
:recovery_point_tags,
|
4059
|
+
:backup_options)
|
3817
4060
|
SENSITIVE = [:recovery_point_tags]
|
3818
4061
|
include Aws::Structure
|
3819
4062
|
end
|
@@ -3828,7 +4071,7 @@ module Aws::Backup
|
|
3828
4071
|
# @return [String]
|
3829
4072
|
#
|
3830
4073
|
# @!attribute [rw] creation_date
|
3831
|
-
# The date and time that a backup job is
|
4074
|
+
# The date and time that a backup job is created, in Unix format and
|
3832
4075
|
# Coordinated Universal Time (UTC). The value of `CreationDate` is
|
3833
4076
|
# accurate to milliseconds. For example, the value 1516925490.087
|
3834
4077
|
# represents Friday, January 26, 2018 12:11:30.087 AM.
|
@@ -3899,6 +4142,9 @@ module Aws::Backup
|
|
3899
4142
|
# cold after days” setting. The “transition to cold after days”
|
3900
4143
|
# setting cannot be changed after a backup has been transitioned to
|
3901
4144
|
# cold.
|
4145
|
+
#
|
4146
|
+
# Only Amazon EFS file system backups can be transitioned to cold
|
4147
|
+
# storage.
|
3902
4148
|
# @return [Types::Lifecycle]
|
3903
4149
|
#
|
3904
4150
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/StartCopyJobInput AWS API Documentation
|
@@ -3919,7 +4165,7 @@ module Aws::Backup
|
|
3919
4165
|
# @return [String]
|
3920
4166
|
#
|
3921
4167
|
# @!attribute [rw] creation_date
|
3922
|
-
# The date and time that a copy job is
|
4168
|
+
# The date and time that a copy job is created, in Unix format and
|
3923
4169
|
# Coordinated Universal Time (UTC). The value of `CreationDate` is
|
3924
4170
|
# accurate to milliseconds. For example, the value 1516925490.087
|
3925
4171
|
# represents Friday, January 26, 2018 12:11:30.087 AM.
|
@@ -3966,15 +4212,18 @@ module Aws::Backup
|
|
3966
4212
|
# You need to specify specific metadata to restore an Amazon Elastic
|
3967
4213
|
# File System (Amazon EFS) instance:
|
3968
4214
|
#
|
3969
|
-
# * `file-system-id`\: ID of the Amazon EFS file system that is
|
3970
|
-
# up by AWS Backup. Returned in
|
4215
|
+
# * `file-system-id`\: The ID of the Amazon EFS file system that is
|
4216
|
+
# backed up by AWS Backup. Returned in
|
4217
|
+
# `GetRecoveryPointRestoreMetadata`.
|
3971
4218
|
#
|
3972
4219
|
# * `Encrypted`\: A Boolean value that, if true, specifies that the
|
3973
4220
|
# file system is encrypted. If `KmsKeyId` is specified, `Encrypted`
|
3974
4221
|
# must be set to `true`.
|
3975
4222
|
#
|
3976
4223
|
# * `KmsKeyId`\: Specifies the AWS KMS key that is used to encrypt the
|
3977
|
-
# restored file system.
|
4224
|
+
# restored file system. You can specify a key from another AWS
|
4225
|
+
# account provided that key it is properly shared with your account
|
4226
|
+
# via AWS KMS.
|
3978
4227
|
#
|
3979
4228
|
# * `PerformanceMode`\: Specifies the throughput mode of the file
|
3980
4229
|
# system.
|
@@ -3984,6 +4233,12 @@ module Aws::Backup
|
|
3984
4233
|
#
|
3985
4234
|
# * `newFileSystem`\: A Boolean value that, if true, specifies that
|
3986
4235
|
# the recovery point is restored to a new Amazon EFS file system.
|
4236
|
+
#
|
4237
|
+
# * `ItemsToRestore `\: An array of one to five strings where each
|
4238
|
+
# string is a file path. Use `ItemsToRestore` to restore specific
|
4239
|
+
# files or directories rather than the entire file system. This
|
4240
|
+
# parameter is optional. For example,
|
4241
|
+
# `"itemsToRestore":"["/my.test"]"`.
|
3987
4242
|
# @return [Hash<String,String>]
|
3988
4243
|
#
|
3989
4244
|
# @!attribute [rw] iam_role_arn
|
@@ -4011,6 +4266,8 @@ module Aws::Backup
|
|
4011
4266
|
#
|
4012
4267
|
# * `RDS` for Amazon Relational Database Service
|
4013
4268
|
#
|
4269
|
+
# * `Aurora` for Amazon Aurora
|
4270
|
+
#
|
4014
4271
|
# * `Storage Gateway` for AWS Storage Gateway
|
4015
4272
|
# @return [String]
|
4016
4273
|
#
|
@@ -4145,6 +4402,14 @@ module Aws::Backup
|
|
4145
4402
|
# ],
|
4146
4403
|
# },
|
4147
4404
|
# ],
|
4405
|
+
# advanced_backup_settings: [
|
4406
|
+
# {
|
4407
|
+
# resource_type: "ResourceType",
|
4408
|
+
# backup_options: {
|
4409
|
+
# "BackupOptionKey" => "BackupOptionValue",
|
4410
|
+
# },
|
4411
|
+
# },
|
4412
|
+
# ],
|
4148
4413
|
# },
|
4149
4414
|
# }
|
4150
4415
|
#
|
@@ -4188,13 +4453,40 @@ module Aws::Backup
|
|
4188
4453
|
# at most 1,024 bytes long. Version Ids cannot be edited.
|
4189
4454
|
# @return [String]
|
4190
4455
|
#
|
4456
|
+
# @!attribute [rw] advanced_backup_settings
|
4457
|
+
# Contains a list of `BackupOptions` for each resource type.
|
4458
|
+
# @return [Array<Types::AdvancedBackupSetting>]
|
4459
|
+
#
|
4191
4460
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/UpdateBackupPlanOutput AWS API Documentation
|
4192
4461
|
#
|
4193
4462
|
class UpdateBackupPlanOutput < Struct.new(
|
4194
4463
|
:backup_plan_id,
|
4195
4464
|
:backup_plan_arn,
|
4196
4465
|
:creation_date,
|
4197
|
-
:version_id
|
4466
|
+
:version_id,
|
4467
|
+
:advanced_backup_settings)
|
4468
|
+
SENSITIVE = []
|
4469
|
+
include Aws::Structure
|
4470
|
+
end
|
4471
|
+
|
4472
|
+
# @note When making an API call, you may pass UpdateGlobalSettingsInput
|
4473
|
+
# data as a hash:
|
4474
|
+
#
|
4475
|
+
# {
|
4476
|
+
# global_settings: {
|
4477
|
+
# "GlobalSettingsName" => "GlobalSettingsValue",
|
4478
|
+
# },
|
4479
|
+
# }
|
4480
|
+
#
|
4481
|
+
# @!attribute [rw] global_settings
|
4482
|
+
# A list of resources along with the opt-in preferences for the
|
4483
|
+
# account.
|
4484
|
+
# @return [Hash<String,String>]
|
4485
|
+
#
|
4486
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/UpdateGlobalSettingsInput AWS API Documentation
|
4487
|
+
#
|
4488
|
+
class UpdateGlobalSettingsInput < Struct.new(
|
4489
|
+
:global_settings)
|
4198
4490
|
SENSITIVE = []
|
4199
4491
|
include Aws::Structure
|
4200
4492
|
end
|
@@ -4267,6 +4559,9 @@ module Aws::Backup
|
|
4267
4559
|
# must be 90 days greater than the “transition to cold after days”
|
4268
4560
|
# setting. The “transition to cold after days” setting cannot be
|
4269
4561
|
# changed after a backup has been transitioned to cold.
|
4562
|
+
#
|
4563
|
+
# Only Amazon EFS file system backups can be transitioned to cold
|
4564
|
+
# storage.
|
4270
4565
|
# @return [Types::Lifecycle]
|
4271
4566
|
#
|
4272
4567
|
# @!attribute [rw] calculated_lifecycle
|
@@ -4296,7 +4591,7 @@ module Aws::Backup
|
|
4296
4591
|
#
|
4297
4592
|
# @!attribute [rw] resource_type_opt_in_preference
|
4298
4593
|
# Updates the list of services along with the opt-in preferences for
|
4299
|
-
# the
|
4594
|
+
# the Region.
|
4300
4595
|
# @return [Hash<String,Boolean>]
|
4301
4596
|
#
|
4302
4597
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/UpdateRegionSettingsInput AWS API Documentation
|