aws-sdk-backup 1.98.0 → 1.104.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +30 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-backup/client.rb +770 -3
- data/lib/aws-sdk-backup/client_api.rb +425 -0
- data/lib/aws-sdk-backup/types.rb +1486 -53
- data/lib/aws-sdk-backup.rb +1 -1
- data/sig/client.rbs +221 -10
- data/sig/types.rbs +289 -0
- metadata +3 -3
data/lib/aws-sdk-backup/types.rb
CHANGED
|
@@ -63,6 +63,33 @@ module Aws::Backup
|
|
|
63
63
|
include Aws::Structure
|
|
64
64
|
end
|
|
65
65
|
|
|
66
|
+
# Contains aggregated scan results across multiple scan operations,
|
|
67
|
+
# providing a summary of scan status and findings.
|
|
68
|
+
#
|
|
69
|
+
# @!attribute [rw] failed_scan
|
|
70
|
+
# A Boolean value indicating whether any of the aggregated scans
|
|
71
|
+
# failed.
|
|
72
|
+
# @return [Boolean]
|
|
73
|
+
#
|
|
74
|
+
# @!attribute [rw] findings
|
|
75
|
+
# An array of findings discovered across all aggregated scans.
|
|
76
|
+
# @return [Array<String>]
|
|
77
|
+
#
|
|
78
|
+
# @!attribute [rw] last_computed
|
|
79
|
+
# The timestamp when the aggregated scan result was last computed, in
|
|
80
|
+
# Unix format and Coordinated Universal Time (UTC).
|
|
81
|
+
# @return [Time]
|
|
82
|
+
#
|
|
83
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/AggregatedScanResult AWS API Documentation
|
|
84
|
+
#
|
|
85
|
+
class AggregatedScanResult < Struct.new(
|
|
86
|
+
:failed_scan,
|
|
87
|
+
:findings,
|
|
88
|
+
:last_computed)
|
|
89
|
+
SENSITIVE = []
|
|
90
|
+
include Aws::Structure
|
|
91
|
+
end
|
|
92
|
+
|
|
66
93
|
# The required resource already exists.
|
|
67
94
|
#
|
|
68
95
|
# @!attribute [rw] code
|
|
@@ -498,12 +525,19 @@ module Aws::Backup
|
|
|
498
525
|
# Contains a list of `BackupOptions` for each resource type.
|
|
499
526
|
# @return [Array<Types::AdvancedBackupSetting>]
|
|
500
527
|
#
|
|
528
|
+
# @!attribute [rw] scan_settings
|
|
529
|
+
# Contains your scanning configuration for the backup plan and
|
|
530
|
+
# includes the Malware scanner, your selected resources, and scanner
|
|
531
|
+
# role.
|
|
532
|
+
# @return [Array<Types::ScanSetting>]
|
|
533
|
+
#
|
|
501
534
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/BackupPlan AWS API Documentation
|
|
502
535
|
#
|
|
503
536
|
class BackupPlan < Struct.new(
|
|
504
537
|
:backup_plan_name,
|
|
505
538
|
:rules,
|
|
506
|
-
:advanced_backup_settings
|
|
539
|
+
:advanced_backup_settings,
|
|
540
|
+
:scan_settings)
|
|
507
541
|
SENSITIVE = []
|
|
508
542
|
include Aws::Structure
|
|
509
543
|
end
|
|
@@ -528,12 +562,19 @@ module Aws::Backup
|
|
|
528
562
|
# (VSS) backup jobs.
|
|
529
563
|
# @return [Array<Types::AdvancedBackupSetting>]
|
|
530
564
|
#
|
|
565
|
+
# @!attribute [rw] scan_settings
|
|
566
|
+
# Contains your scanning configuration for the backup rule and
|
|
567
|
+
# includes the malware scanner, and scan mode of either full or
|
|
568
|
+
# incremental.
|
|
569
|
+
# @return [Array<Types::ScanSetting>]
|
|
570
|
+
#
|
|
531
571
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/BackupPlanInput AWS API Documentation
|
|
532
572
|
#
|
|
533
573
|
class BackupPlanInput < Struct.new(
|
|
534
574
|
:backup_plan_name,
|
|
535
575
|
:rules,
|
|
536
|
-
:advanced_backup_settings
|
|
576
|
+
:advanced_backup_settings,
|
|
577
|
+
:scan_settings)
|
|
537
578
|
SENSITIVE = []
|
|
538
579
|
include Aws::Structure
|
|
539
580
|
end
|
|
@@ -643,6 +684,15 @@ module Aws::Backup
|
|
|
643
684
|
# created.
|
|
644
685
|
# @return [String]
|
|
645
686
|
#
|
|
687
|
+
# @!attribute [rw] target_logically_air_gapped_backup_vault_arn
|
|
688
|
+
# The ARN of a logically air-gapped vault. ARN must be in the same
|
|
689
|
+
# account and Region. If provided, supported fully managed resources
|
|
690
|
+
# back up directly to logically air-gapped vault, while other
|
|
691
|
+
# supported resources create a temporary (billable) snapshot in backup
|
|
692
|
+
# vault, then copy it to logically air-gapped vault. Unsupported
|
|
693
|
+
# resources only back up to the specified backup vault.
|
|
694
|
+
# @return [String]
|
|
695
|
+
#
|
|
646
696
|
# @!attribute [rw] schedule_expression
|
|
647
697
|
# A cron expression in UTC specifying when Backup initiates a backup
|
|
648
698
|
# job. When no CRON expression is provided, Backup will use the
|
|
@@ -745,11 +795,18 @@ module Aws::Backup
|
|
|
745
795
|
# BackupRule.
|
|
746
796
|
# @return [Array<Types::IndexAction>]
|
|
747
797
|
#
|
|
798
|
+
# @!attribute [rw] scan_actions
|
|
799
|
+
# Contains your scanning configuration for the backup rule and
|
|
800
|
+
# includes the malware scanner, and scan mode of either full or
|
|
801
|
+
# incremental.
|
|
802
|
+
# @return [Array<Types::ScanAction>]
|
|
803
|
+
#
|
|
748
804
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/BackupRule AWS API Documentation
|
|
749
805
|
#
|
|
750
806
|
class BackupRule < Struct.new(
|
|
751
807
|
:rule_name,
|
|
752
808
|
:target_backup_vault_name,
|
|
809
|
+
:target_logically_air_gapped_backup_vault_arn,
|
|
753
810
|
:schedule_expression,
|
|
754
811
|
:start_window_minutes,
|
|
755
812
|
:completion_window_minutes,
|
|
@@ -759,7 +816,8 @@ module Aws::Backup
|
|
|
759
816
|
:copy_actions,
|
|
760
817
|
:enable_continuous_backup,
|
|
761
818
|
:schedule_expression_timezone,
|
|
762
|
-
:index_actions
|
|
819
|
+
:index_actions,
|
|
820
|
+
:scan_actions)
|
|
763
821
|
SENSITIVE = [:recovery_point_tags]
|
|
764
822
|
include Aws::Structure
|
|
765
823
|
end
|
|
@@ -778,6 +836,15 @@ module Aws::Backup
|
|
|
778
836
|
# created.
|
|
779
837
|
# @return [String]
|
|
780
838
|
#
|
|
839
|
+
# @!attribute [rw] target_logically_air_gapped_backup_vault_arn
|
|
840
|
+
# The ARN of a logically air-gapped vault. ARN must be in the same
|
|
841
|
+
# account and Region. If provided, supported fully managed resources
|
|
842
|
+
# back up directly to logically air-gapped vault, while other
|
|
843
|
+
# supported resources create a temporary (billable) snapshot in backup
|
|
844
|
+
# vault, then copy it to logically air-gapped vault. Unsupported
|
|
845
|
+
# resources only back up to the specified backup vault.
|
|
846
|
+
# @return [String]
|
|
847
|
+
#
|
|
781
848
|
# @!attribute [rw] schedule_expression
|
|
782
849
|
# A CRON expression in UTC specifying when Backup initiates a backup
|
|
783
850
|
# job. When no CRON expression is provided, Backup will use the
|
|
@@ -865,11 +932,18 @@ module Aws::Backup
|
|
|
865
932
|
# * `S3` for Amazon Simple Storage Service (Amazon S3)
|
|
866
933
|
# @return [Array<Types::IndexAction>]
|
|
867
934
|
#
|
|
935
|
+
# @!attribute [rw] scan_actions
|
|
936
|
+
# Contains your scanning configuration for the backup rule and
|
|
937
|
+
# includes the malware scanner, and scan mode of either full or
|
|
938
|
+
# incremental.
|
|
939
|
+
# @return [Array<Types::ScanAction>]
|
|
940
|
+
#
|
|
868
941
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/BackupRuleInput AWS API Documentation
|
|
869
942
|
#
|
|
870
943
|
class BackupRuleInput < Struct.new(
|
|
871
944
|
:rule_name,
|
|
872
945
|
:target_backup_vault_name,
|
|
946
|
+
:target_logically_air_gapped_backup_vault_arn,
|
|
873
947
|
:schedule_expression,
|
|
874
948
|
:start_window_minutes,
|
|
875
949
|
:completion_window_minutes,
|
|
@@ -878,7 +952,8 @@ module Aws::Backup
|
|
|
878
952
|
:copy_actions,
|
|
879
953
|
:enable_continuous_backup,
|
|
880
954
|
:schedule_expression_timezone,
|
|
881
|
-
:index_actions
|
|
955
|
+
:index_actions,
|
|
956
|
+
:scan_actions)
|
|
882
957
|
SENSITIVE = [:recovery_point_tags]
|
|
883
958
|
include Aws::Structure
|
|
884
959
|
end
|
|
@@ -1129,6 +1204,12 @@ module Aws::Backup
|
|
|
1129
1204
|
# represents Friday, January 26, 2018 12:11:30.087 AM.
|
|
1130
1205
|
# @return [Time]
|
|
1131
1206
|
#
|
|
1207
|
+
# @!attribute [rw] encryption_key_type
|
|
1208
|
+
# The type of encryption key used for the backup vault. Valid values
|
|
1209
|
+
# are CUSTOMER\_MANAGED\_KMS\_KEY for customer-managed keys or Amazon
|
|
1210
|
+
# Web Services\_OWNED\_KMS\_KEY for Amazon Web Services-owned keys.
|
|
1211
|
+
# @return [String]
|
|
1212
|
+
#
|
|
1132
1213
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/BackupVaultListMember AWS API Documentation
|
|
1133
1214
|
#
|
|
1134
1215
|
class BackupVaultListMember < Struct.new(
|
|
@@ -1143,7 +1224,8 @@ module Aws::Backup
|
|
|
1143
1224
|
:locked,
|
|
1144
1225
|
:min_retention_days,
|
|
1145
1226
|
:max_retention_days,
|
|
1146
|
-
:lock_date
|
|
1227
|
+
:lock_date,
|
|
1228
|
+
:encryption_key_type)
|
|
1147
1229
|
SENSITIVE = []
|
|
1148
1230
|
include Aws::Structure
|
|
1149
1231
|
end
|
|
@@ -1565,6 +1647,12 @@ module Aws::Backup
|
|
|
1565
1647
|
# to initiate the recovery point backup.
|
|
1566
1648
|
# @return [Types::RecoveryPointCreator]
|
|
1567
1649
|
#
|
|
1650
|
+
# @!attribute [rw] created_by_backup_job_id
|
|
1651
|
+
# The backup job ID that initiated this copy job. Only applicable to
|
|
1652
|
+
# scheduled copy jobs and automatic copy jobs to logically air-gapped
|
|
1653
|
+
# vault.
|
|
1654
|
+
# @return [String]
|
|
1655
|
+
#
|
|
1568
1656
|
# @!attribute [rw] resource_type
|
|
1569
1657
|
# The type of Amazon Web Services resource to be copied; for example,
|
|
1570
1658
|
# an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon
|
|
@@ -1644,6 +1732,7 @@ module Aws::Backup
|
|
|
1644
1732
|
:backup_size_in_bytes,
|
|
1645
1733
|
:iam_role_arn,
|
|
1646
1734
|
:created_by,
|
|
1735
|
+
:created_by_backup_job_id,
|
|
1647
1736
|
:resource_type,
|
|
1648
1737
|
:parent_job_id,
|
|
1649
1738
|
:is_parent,
|
|
@@ -2109,6 +2198,13 @@ module Aws::Backup
|
|
|
2109
2198
|
# points.
|
|
2110
2199
|
# @return [Integer]
|
|
2111
2200
|
#
|
|
2201
|
+
# @!attribute [rw] encryption_key_arn
|
|
2202
|
+
# The ARN of the customer-managed KMS key to use for encrypting the
|
|
2203
|
+
# logically air-gapped backup vault. If not specified, the vault will
|
|
2204
|
+
# be encrypted with an Amazon Web Services-owned key managed by Amazon
|
|
2205
|
+
# Web Services Backup.
|
|
2206
|
+
# @return [String]
|
|
2207
|
+
#
|
|
2112
2208
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/CreateLogicallyAirGappedBackupVaultInput AWS API Documentation
|
|
2113
2209
|
#
|
|
2114
2210
|
class CreateLogicallyAirGappedBackupVaultInput < Struct.new(
|
|
@@ -2116,7 +2212,8 @@ module Aws::Backup
|
|
|
2116
2212
|
:backup_vault_tags,
|
|
2117
2213
|
:creator_request_id,
|
|
2118
2214
|
:min_retention_days,
|
|
2119
|
-
:max_retention_days
|
|
2215
|
+
:max_retention_days,
|
|
2216
|
+
:encryption_key_arn)
|
|
2120
2217
|
SENSITIVE = [:backup_vault_tags]
|
|
2121
2218
|
include Aws::Structure
|
|
2122
2219
|
end
|
|
@@ -2177,7 +2274,8 @@ module Aws::Backup
|
|
|
2177
2274
|
# using a report template. The report templates are:
|
|
2178
2275
|
#
|
|
2179
2276
|
# `RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT |
|
|
2180
|
-
# BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT
|
|
2277
|
+
# BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT |
|
|
2278
|
+
# SCAN_JOB_REPORT `
|
|
2181
2279
|
#
|
|
2182
2280
|
# If the report template is `RESOURCE_COMPLIANCE_REPORT` or
|
|
2183
2281
|
# `CONTROL_COMPLIANCE_REPORT`, this API resource also describes the
|
|
@@ -2423,6 +2521,9 @@ module Aws::Backup
|
|
|
2423
2521
|
# @!attribute [rw] restore_testing_selection_name
|
|
2424
2522
|
# The name of the restore testing selection for the related restore
|
|
2425
2523
|
# testing plan.
|
|
2524
|
+
#
|
|
2525
|
+
# The name cannot be changed after creation. The name consists of only
|
|
2526
|
+
# alphanumeric characters and underscores. Maximum length is 50.
|
|
2426
2527
|
# @return [String]
|
|
2427
2528
|
#
|
|
2428
2529
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/CreateRestoreTestingSelectionOutput AWS API Documentation
|
|
@@ -2436,6 +2537,70 @@ module Aws::Backup
|
|
|
2436
2537
|
include Aws::Structure
|
|
2437
2538
|
end
|
|
2438
2539
|
|
|
2540
|
+
# @!attribute [rw] tiering_configuration
|
|
2541
|
+
# A tiering configuration must contain a unique
|
|
2542
|
+
# `TieringConfigurationName` string you create and must contain a
|
|
2543
|
+
# `BackupVaultName` and `ResourceSelection`. You may optionally
|
|
2544
|
+
# include a `CreatorRequestId` string.
|
|
2545
|
+
#
|
|
2546
|
+
# The `TieringConfigurationName` is a unique string that is the name
|
|
2547
|
+
# of the tiering configuration. This cannot be changed after creation,
|
|
2548
|
+
# and it must consist of only alphanumeric characters and underscores.
|
|
2549
|
+
# @return [Types::TieringConfigurationInputForCreate]
|
|
2550
|
+
#
|
|
2551
|
+
# @!attribute [rw] tiering_configuration_tags
|
|
2552
|
+
# The tags to assign to the tiering configuration.
|
|
2553
|
+
# @return [Hash<String,String>]
|
|
2554
|
+
#
|
|
2555
|
+
# @!attribute [rw] creator_request_id
|
|
2556
|
+
# This is a unique string that identifies the request and allows
|
|
2557
|
+
# failed requests to be retried without the risk of running the
|
|
2558
|
+
# operation twice. This parameter is optional. If used, this parameter
|
|
2559
|
+
# must contain 1 to 50 alphanumeric or '-\_.' characters.
|
|
2560
|
+
#
|
|
2561
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
2562
|
+
# not need to pass this option.
|
|
2563
|
+
# @return [String]
|
|
2564
|
+
#
|
|
2565
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/CreateTieringConfigurationInput AWS API Documentation
|
|
2566
|
+
#
|
|
2567
|
+
class CreateTieringConfigurationInput < Struct.new(
|
|
2568
|
+
:tiering_configuration,
|
|
2569
|
+
:tiering_configuration_tags,
|
|
2570
|
+
:creator_request_id)
|
|
2571
|
+
SENSITIVE = [:tiering_configuration_tags]
|
|
2572
|
+
include Aws::Structure
|
|
2573
|
+
end
|
|
2574
|
+
|
|
2575
|
+
# @!attribute [rw] tiering_configuration_arn
|
|
2576
|
+
# An Amazon Resource Name (ARN) that uniquely identifies the created
|
|
2577
|
+
# tiering configuration.
|
|
2578
|
+
# @return [String]
|
|
2579
|
+
#
|
|
2580
|
+
# @!attribute [rw] tiering_configuration_name
|
|
2581
|
+
# This unique string is the name of the tiering configuration.
|
|
2582
|
+
#
|
|
2583
|
+
# The name cannot be changed after creation. The name consists of only
|
|
2584
|
+
# alphanumeric characters and underscores. Maximum length is 200.
|
|
2585
|
+
# @return [String]
|
|
2586
|
+
#
|
|
2587
|
+
# @!attribute [rw] creation_time
|
|
2588
|
+
# The date and time a tiering configuration was created, in Unix
|
|
2589
|
+
# format and Coordinated Universal Time (UTC). The value of
|
|
2590
|
+
# `CreationTime` is accurate to milliseconds. For example, the value
|
|
2591
|
+
# 1516925490.087 represents Friday, January 26, 2018 12:11:30.087AM.
|
|
2592
|
+
# @return [Time]
|
|
2593
|
+
#
|
|
2594
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/CreateTieringConfigurationOutput AWS API Documentation
|
|
2595
|
+
#
|
|
2596
|
+
class CreateTieringConfigurationOutput < Struct.new(
|
|
2597
|
+
:tiering_configuration_arn,
|
|
2598
|
+
:tiering_configuration_name,
|
|
2599
|
+
:creation_time)
|
|
2600
|
+
SENSITIVE = []
|
|
2601
|
+
include Aws::Structure
|
|
2602
|
+
end
|
|
2603
|
+
|
|
2439
2604
|
# This is a resource filter containing FromDate: DateTime and ToDate:
|
|
2440
2605
|
# DateTime. Both values are required. Future DateTime values are not
|
|
2441
2606
|
# permitted.
|
|
@@ -2666,6 +2831,22 @@ module Aws::Backup
|
|
|
2666
2831
|
include Aws::Structure
|
|
2667
2832
|
end
|
|
2668
2833
|
|
|
2834
|
+
# @!attribute [rw] tiering_configuration_name
|
|
2835
|
+
# The unique name of a tiering configuration.
|
|
2836
|
+
# @return [String]
|
|
2837
|
+
#
|
|
2838
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DeleteTieringConfigurationInput AWS API Documentation
|
|
2839
|
+
#
|
|
2840
|
+
class DeleteTieringConfigurationInput < Struct.new(
|
|
2841
|
+
:tiering_configuration_name)
|
|
2842
|
+
SENSITIVE = []
|
|
2843
|
+
include Aws::Structure
|
|
2844
|
+
end
|
|
2845
|
+
|
|
2846
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DeleteTieringConfigurationOutput AWS API Documentation
|
|
2847
|
+
#
|
|
2848
|
+
class DeleteTieringConfigurationOutput < Aws::EmptyStructure; end
|
|
2849
|
+
|
|
2669
2850
|
# A dependent Amazon Web Services service or resource returned an error
|
|
2670
2851
|
# to the Backup service, and the action cannot be completed.
|
|
2671
2852
|
#
|
|
@@ -3117,6 +3298,12 @@ module Aws::Backup
|
|
|
3117
3298
|
# association for this backup vault.
|
|
3118
3299
|
# @return [Types::LatestMpaApprovalTeamUpdate]
|
|
3119
3300
|
#
|
|
3301
|
+
# @!attribute [rw] encryption_key_type
|
|
3302
|
+
# The type of encryption key used for the backup vault. Valid values
|
|
3303
|
+
# are CUSTOMER\_MANAGED\_KMS\_KEY for customer-managed keys or Amazon
|
|
3304
|
+
# Web Services\_OWNED\_KMS\_KEY for Amazon Web Services-owned keys.
|
|
3305
|
+
# @return [String]
|
|
3306
|
+
#
|
|
3120
3307
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeBackupVaultOutput AWS API Documentation
|
|
3121
3308
|
#
|
|
3122
3309
|
class DescribeBackupVaultOutput < Struct.new(
|
|
@@ -3135,7 +3322,8 @@ module Aws::Backup
|
|
|
3135
3322
|
:source_backup_vault_arn,
|
|
3136
3323
|
:mpa_approval_team_arn,
|
|
3137
3324
|
:mpa_session_arn,
|
|
3138
|
-
:latest_mpa_approval_team_update
|
|
3325
|
+
:latest_mpa_approval_team_update,
|
|
3326
|
+
:encryption_key_type)
|
|
3139
3327
|
SENSITIVE = []
|
|
3140
3328
|
include Aws::Structure
|
|
3141
3329
|
end
|
|
@@ -3256,8 +3444,9 @@ module Aws::Backup
|
|
|
3256
3444
|
class DescribeGlobalSettingsInput < Aws::EmptyStructure; end
|
|
3257
3445
|
|
|
3258
3446
|
# @!attribute [rw] global_settings
|
|
3259
|
-
# The status of the flags `isCrossAccountBackupEnabled
|
|
3260
|
-
# `isMpaEnabled` ('Mpa' refers to multi-party approval)
|
|
3447
|
+
# The status of the flags `isCrossAccountBackupEnabled`,
|
|
3448
|
+
# `isMpaEnabled` ('Mpa' refers to multi-party approval), and
|
|
3449
|
+
# `isDelegatedAdministratorEnabled`.
|
|
3261
3450
|
# @return [Hash<String,String>]
|
|
3262
3451
|
#
|
|
3263
3452
|
# @!attribute [rw] last_update_time
|
|
@@ -3597,6 +3786,18 @@ module Aws::Backup
|
|
|
3597
3786
|
# a backup index associated with the recovery point.
|
|
3598
3787
|
# @return [String]
|
|
3599
3788
|
#
|
|
3789
|
+
# @!attribute [rw] encryption_key_type
|
|
3790
|
+
# The type of encryption key used for the recovery point. Valid values
|
|
3791
|
+
# are CUSTOMER\_MANAGED\_KMS\_KEY for customer-managed keys or Amazon
|
|
3792
|
+
# Web Services\_OWNED\_KMS\_KEY for Amazon Web Services-owned keys.
|
|
3793
|
+
# @return [String]
|
|
3794
|
+
#
|
|
3795
|
+
# @!attribute [rw] scan_results
|
|
3796
|
+
# Contains the latest scanning results against the recovery point and
|
|
3797
|
+
# currently include `MalwareScanner`, `ScanJobState`, `Findings`, and
|
|
3798
|
+
# `LastScanTimestamp`
|
|
3799
|
+
# @return [Array<Types::ScanResult>]
|
|
3800
|
+
#
|
|
3600
3801
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeRecoveryPointOutput AWS API Documentation
|
|
3601
3802
|
#
|
|
3602
3803
|
class DescribeRecoveryPointOutput < Struct.new(
|
|
@@ -3626,7 +3827,9 @@ module Aws::Backup
|
|
|
3626
3827
|
:resource_name,
|
|
3627
3828
|
:vault_type,
|
|
3628
3829
|
:index_status,
|
|
3629
|
-
:index_status_message
|
|
3830
|
+
:index_status_message,
|
|
3831
|
+
:encryption_key_type,
|
|
3832
|
+
:scan_results)
|
|
3630
3833
|
SENSITIVE = []
|
|
3631
3834
|
include Aws::Structure
|
|
3632
3835
|
end
|
|
@@ -3845,6 +4048,16 @@ module Aws::Backup
|
|
|
3845
4048
|
# This describes the restore job deletion status.
|
|
3846
4049
|
# @return [String]
|
|
3847
4050
|
#
|
|
4051
|
+
# @!attribute [rw] is_parent
|
|
4052
|
+
# This is a boolean value indicating whether the restore job is a
|
|
4053
|
+
# parent (composite) restore job.
|
|
4054
|
+
# @return [Boolean]
|
|
4055
|
+
#
|
|
4056
|
+
# @!attribute [rw] parent_job_id
|
|
4057
|
+
# This is the unique identifier of the parent restore job for the
|
|
4058
|
+
# selected restore job.
|
|
4059
|
+
# @return [String]
|
|
4060
|
+
#
|
|
3848
4061
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeRestoreJobOutput AWS API Documentation
|
|
3849
4062
|
#
|
|
3850
4063
|
class DescribeRestoreJobOutput < Struct.new(
|
|
@@ -3868,7 +4081,158 @@ module Aws::Backup
|
|
|
3868
4081
|
:validation_status,
|
|
3869
4082
|
:validation_status_message,
|
|
3870
4083
|
:deletion_status,
|
|
3871
|
-
:deletion_status_message
|
|
4084
|
+
:deletion_status_message,
|
|
4085
|
+
:is_parent,
|
|
4086
|
+
:parent_job_id)
|
|
4087
|
+
SENSITIVE = []
|
|
4088
|
+
include Aws::Structure
|
|
4089
|
+
end
|
|
4090
|
+
|
|
4091
|
+
# @!attribute [rw] scan_job_id
|
|
4092
|
+
# Uniquely identifies a request to Backup to scan a resource.
|
|
4093
|
+
# @return [String]
|
|
4094
|
+
#
|
|
4095
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeScanJobInput AWS API Documentation
|
|
4096
|
+
#
|
|
4097
|
+
class DescribeScanJobInput < Struct.new(
|
|
4098
|
+
:scan_job_id)
|
|
4099
|
+
SENSITIVE = []
|
|
4100
|
+
include Aws::Structure
|
|
4101
|
+
end
|
|
4102
|
+
|
|
4103
|
+
# @!attribute [rw] account_id
|
|
4104
|
+
# Returns the account ID that owns the scan job.
|
|
4105
|
+
#
|
|
4106
|
+
# Pattern: `^[0-9]{12}$`
|
|
4107
|
+
# @return [String]
|
|
4108
|
+
#
|
|
4109
|
+
# @!attribute [rw] backup_vault_arn
|
|
4110
|
+
# An Amazon Resource Name (ARN) that uniquely identifies a backup
|
|
4111
|
+
# vault; for example,
|
|
4112
|
+
# `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`
|
|
4113
|
+
# @return [String]
|
|
4114
|
+
#
|
|
4115
|
+
# @!attribute [rw] backup_vault_name
|
|
4116
|
+
# The name of a logical container where backups are stored. Backup
|
|
4117
|
+
# vaults are identified by names that are unique to the account used
|
|
4118
|
+
# to create them and the Amazon Web Services Region where they are
|
|
4119
|
+
# created.
|
|
4120
|
+
#
|
|
4121
|
+
# Pattern: `^[a-zA-Z0-9\-\_\.]{2,50}$`
|
|
4122
|
+
# @return [String]
|
|
4123
|
+
#
|
|
4124
|
+
# @!attribute [rw] completion_date
|
|
4125
|
+
# The date and time that a backup index finished creation, in Unix
|
|
4126
|
+
# format and Coordinated Universal Time (UTC). The value of
|
|
4127
|
+
# `CompletionDate` is accurate to milliseconds. For example, the value
|
|
4128
|
+
# 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
|
|
4129
|
+
# @return [Time]
|
|
4130
|
+
#
|
|
4131
|
+
# @!attribute [rw] created_by
|
|
4132
|
+
# Contains identifying information about the creation of a scan job,
|
|
4133
|
+
# including the backup plan and rule that initiated the scan.
|
|
4134
|
+
# @return [Types::ScanJobCreator]
|
|
4135
|
+
#
|
|
4136
|
+
# @!attribute [rw] creation_date
|
|
4137
|
+
# The date and time that a backup index finished creation, in Unix
|
|
4138
|
+
# format and Coordinated Universal Time (UTC). The value of
|
|
4139
|
+
# `CreationDate` is accurate to milliseconds. For example, the value
|
|
4140
|
+
# 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
|
|
4141
|
+
# @return [Time]
|
|
4142
|
+
#
|
|
4143
|
+
# @!attribute [rw] iam_role_arn
|
|
4144
|
+
# An Amazon Resource Name (ARN) that uniquely identifies a backup
|
|
4145
|
+
# vault; for example, `arn:aws:iam::123456789012:role/S3Access`.
|
|
4146
|
+
# @return [String]
|
|
4147
|
+
#
|
|
4148
|
+
# @!attribute [rw] malware_scanner
|
|
4149
|
+
# The scanning engine used for the corresponding scan job. Currently
|
|
4150
|
+
# only `GUARDUTY` is supported.
|
|
4151
|
+
# @return [String]
|
|
4152
|
+
#
|
|
4153
|
+
# @!attribute [rw] recovery_point_arn
|
|
4154
|
+
# An ARN that uniquely identifies the target recovery point for
|
|
4155
|
+
# scanning.; for example,
|
|
4156
|
+
# `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
|
|
4157
|
+
# @return [String]
|
|
4158
|
+
#
|
|
4159
|
+
# @!attribute [rw] resource_arn
|
|
4160
|
+
# An ARN that uniquely identifies the source resource of the
|
|
4161
|
+
# corresponding recovery point ARN.
|
|
4162
|
+
# @return [String]
|
|
4163
|
+
#
|
|
4164
|
+
# @!attribute [rw] resource_name
|
|
4165
|
+
# The non-unique name of the resource that belongs to the specified
|
|
4166
|
+
# backup.
|
|
4167
|
+
# @return [String]
|
|
4168
|
+
#
|
|
4169
|
+
# @!attribute [rw] resource_type
|
|
4170
|
+
# The type of Amazon Web Services Resource to be backed up; for
|
|
4171
|
+
# example, an Amazon Elastic Block Store (Amazon EBS) volume.
|
|
4172
|
+
#
|
|
4173
|
+
# Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`
|
|
4174
|
+
# @return [String]
|
|
4175
|
+
#
|
|
4176
|
+
# @!attribute [rw] scan_base_recovery_point_arn
|
|
4177
|
+
# An ARN that uniquely identifies the base recovery point for
|
|
4178
|
+
# scanning. This field will only be populated when an incremental scan
|
|
4179
|
+
# job has taken place.
|
|
4180
|
+
# @return [String]
|
|
4181
|
+
#
|
|
4182
|
+
# @!attribute [rw] scan_id
|
|
4183
|
+
# The scan ID generated by Amazon GuardDuty for the corresponding Scan
|
|
4184
|
+
# Job ID request from Backup.
|
|
4185
|
+
# @return [String]
|
|
4186
|
+
#
|
|
4187
|
+
# @!attribute [rw] scan_job_id
|
|
4188
|
+
# The scan job ID that uniquely identified the request to Backup.
|
|
4189
|
+
# @return [String]
|
|
4190
|
+
#
|
|
4191
|
+
# @!attribute [rw] scan_mode
|
|
4192
|
+
# Specifies the scan type used for the scan job.
|
|
4193
|
+
# @return [String]
|
|
4194
|
+
#
|
|
4195
|
+
# @!attribute [rw] scan_result
|
|
4196
|
+
# Contains the `ScanResultsStatus` for the scanning job and returns
|
|
4197
|
+
# `THREATS_FOUND` or `NO_THREATS_FOUND` for completed jobs.
|
|
4198
|
+
# @return [Types::ScanResultInfo]
|
|
4199
|
+
#
|
|
4200
|
+
# @!attribute [rw] scanner_role_arn
|
|
4201
|
+
# Specifies the scanner IAM role ARN used to for the scan job.
|
|
4202
|
+
# @return [String]
|
|
4203
|
+
#
|
|
4204
|
+
# @!attribute [rw] state
|
|
4205
|
+
# The current state of a scan job.
|
|
4206
|
+
# @return [String]
|
|
4207
|
+
#
|
|
4208
|
+
# @!attribute [rw] status_message
|
|
4209
|
+
# A detailed message explaining the status of the job to back up a
|
|
4210
|
+
# resource.
|
|
4211
|
+
# @return [String]
|
|
4212
|
+
#
|
|
4213
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeScanJobOutput AWS API Documentation
|
|
4214
|
+
#
|
|
4215
|
+
class DescribeScanJobOutput < Struct.new(
|
|
4216
|
+
:account_id,
|
|
4217
|
+
:backup_vault_arn,
|
|
4218
|
+
:backup_vault_name,
|
|
4219
|
+
:completion_date,
|
|
4220
|
+
:created_by,
|
|
4221
|
+
:creation_date,
|
|
4222
|
+
:iam_role_arn,
|
|
4223
|
+
:malware_scanner,
|
|
4224
|
+
:recovery_point_arn,
|
|
4225
|
+
:resource_arn,
|
|
4226
|
+
:resource_name,
|
|
4227
|
+
:resource_type,
|
|
4228
|
+
:scan_base_recovery_point_arn,
|
|
4229
|
+
:scan_id,
|
|
4230
|
+
:scan_job_id,
|
|
4231
|
+
:scan_mode,
|
|
4232
|
+
:scan_result,
|
|
4233
|
+
:scanner_role_arn,
|
|
4234
|
+
:state,
|
|
4235
|
+
:status_message)
|
|
3872
4236
|
SENSITIVE = []
|
|
3873
4237
|
include Aws::Structure
|
|
3874
4238
|
end
|
|
@@ -4739,6 +5103,31 @@ module Aws::Backup
|
|
|
4739
5103
|
include Aws::Structure
|
|
4740
5104
|
end
|
|
4741
5105
|
|
|
5106
|
+
# @!attribute [rw] tiering_configuration_name
|
|
5107
|
+
# The unique name of a tiering configuration.
|
|
5108
|
+
# @return [String]
|
|
5109
|
+
#
|
|
5110
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetTieringConfigurationInput AWS API Documentation
|
|
5111
|
+
#
|
|
5112
|
+
class GetTieringConfigurationInput < Struct.new(
|
|
5113
|
+
:tiering_configuration_name)
|
|
5114
|
+
SENSITIVE = []
|
|
5115
|
+
include Aws::Structure
|
|
5116
|
+
end
|
|
5117
|
+
|
|
5118
|
+
# @!attribute [rw] tiering_configuration
|
|
5119
|
+
# Specifies the body of a tiering configuration. Includes
|
|
5120
|
+
# `TieringConfigurationName`.
|
|
5121
|
+
# @return [Types::TieringConfiguration]
|
|
5122
|
+
#
|
|
5123
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetTieringConfigurationOutput AWS API Documentation
|
|
5124
|
+
#
|
|
5125
|
+
class GetTieringConfigurationOutput < Struct.new(
|
|
5126
|
+
:tiering_configuration)
|
|
5127
|
+
SENSITIVE = []
|
|
5128
|
+
include Aws::Structure
|
|
5129
|
+
end
|
|
5130
|
+
|
|
4742
5131
|
# This is an optional array within a BackupRule.
|
|
4743
5132
|
#
|
|
4744
5133
|
# IndexAction consists of one ResourceTypes.
|
|
@@ -5111,12 +5500,19 @@ module Aws::Backup
|
|
|
5111
5500
|
# lifecycle settings.
|
|
5112
5501
|
# @return [Boolean]
|
|
5113
5502
|
#
|
|
5503
|
+
# @!attribute [rw] delete_after_event
|
|
5504
|
+
# The event after which a recovery point is deleted. A recovery point
|
|
5505
|
+
# with both `DeleteAfterDays` and `DeleteAfterEvent` will delete after
|
|
5506
|
+
# whichever condition is satisfied first. Not valid as an input.
|
|
5507
|
+
# @return [String]
|
|
5508
|
+
#
|
|
5114
5509
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/Lifecycle AWS API Documentation
|
|
5115
5510
|
#
|
|
5116
5511
|
class Lifecycle < Struct.new(
|
|
5117
5512
|
:move_to_cold_storage_after_days,
|
|
5118
5513
|
:delete_after_days,
|
|
5119
|
-
:opt_in_to_archive_for_supported_resources
|
|
5514
|
+
:opt_in_to_archive_for_supported_resources,
|
|
5515
|
+
:delete_after_event)
|
|
5120
5516
|
SENSITIVE = []
|
|
5121
5517
|
include Aws::Structure
|
|
5122
5518
|
end
|
|
@@ -5921,6 +6317,10 @@ module Aws::Backup
|
|
|
5921
6317
|
# [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html
|
|
5922
6318
|
# @return [String]
|
|
5923
6319
|
#
|
|
6320
|
+
# @!attribute [rw] by_source_recovery_point_arn
|
|
6321
|
+
# Filters copy jobs by the specified source recovery point ARN.
|
|
6322
|
+
# @return [String]
|
|
6323
|
+
#
|
|
5924
6324
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListCopyJobsInput AWS API Documentation
|
|
5925
6325
|
#
|
|
5926
6326
|
class ListCopyJobsInput < Struct.new(
|
|
@@ -5936,7 +6336,8 @@ module Aws::Backup
|
|
|
5936
6336
|
:by_complete_before,
|
|
5937
6337
|
:by_complete_after,
|
|
5938
6338
|
:by_parent_job_id,
|
|
5939
|
-
:by_message_category
|
|
6339
|
+
:by_message_category,
|
|
6340
|
+
:by_source_recovery_point_arn)
|
|
5940
6341
|
SENSITIVE = []
|
|
5941
6342
|
include Aws::Structure
|
|
5942
6343
|
end
|
|
@@ -6483,7 +6884,11 @@ module Aws::Backup
|
|
|
6483
6884
|
# Returns only report jobs that are in the specified status. The
|
|
6484
6885
|
# statuses are:
|
|
6485
6886
|
#
|
|
6486
|
-
# `CREATED | RUNNING | COMPLETED | FAILED`
|
|
6887
|
+
# `CREATED | RUNNING | COMPLETED | FAILED | COMPLETED_WITH_ISSUES`
|
|
6888
|
+
#
|
|
6889
|
+
# Please note that only scanning jobs finish with state completed with
|
|
6890
|
+
# issues. For backup jobs this is a console interpretation of a job
|
|
6891
|
+
# that finishes in completed state and has a status message.
|
|
6487
6892
|
# @return [String]
|
|
6488
6893
|
#
|
|
6489
6894
|
# @!attribute [rw] max_results
|
|
@@ -6870,6 +7275,11 @@ module Aws::Backup
|
|
|
6870
7275
|
# resource Amazon Resource Name (ARN).
|
|
6871
7276
|
# @return [String]
|
|
6872
7277
|
#
|
|
7278
|
+
# @!attribute [rw] by_parent_job_id
|
|
7279
|
+
# This is a filter to list child (nested) restore jobs based on parent
|
|
7280
|
+
# restore job ID.
|
|
7281
|
+
# @return [String]
|
|
7282
|
+
#
|
|
6873
7283
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListRestoreJobsInput AWS API Documentation
|
|
6874
7284
|
#
|
|
6875
7285
|
class ListRestoreJobsInput < Struct.new(
|
|
@@ -6882,7 +7292,8 @@ module Aws::Backup
|
|
|
6882
7292
|
:by_status,
|
|
6883
7293
|
:by_complete_before,
|
|
6884
7294
|
:by_complete_after,
|
|
6885
|
-
:by_restore_testing_plan_arn
|
|
7295
|
+
:by_restore_testing_plan_arn,
|
|
7296
|
+
:by_parent_job_id)
|
|
6886
7297
|
SENSITIVE = []
|
|
6887
7298
|
include Aws::Structure
|
|
6888
7299
|
end
|
|
@@ -6995,29 +7406,261 @@ module Aws::Backup
|
|
|
6995
7406
|
include Aws::Structure
|
|
6996
7407
|
end
|
|
6997
7408
|
|
|
6998
|
-
# @!attribute [rw]
|
|
6999
|
-
#
|
|
7000
|
-
#
|
|
7001
|
-
#
|
|
7409
|
+
# @!attribute [rw] account_id
|
|
7410
|
+
# Returns the job count for the specified account.
|
|
7411
|
+
#
|
|
7412
|
+
# If the request is sent from a member account or an account not part
|
|
7413
|
+
# of Amazon Web Services Organizations, jobs within requestor's
|
|
7414
|
+
# account will be returned.
|
|
7415
|
+
#
|
|
7416
|
+
# Root, admin, and delegated administrator accounts can use the value
|
|
7417
|
+
# `ANY` to return job counts from every account in the organization.
|
|
7418
|
+
#
|
|
7419
|
+
# `AGGREGATE_ALL` aggregates job counts from all accounts within the
|
|
7420
|
+
# authenticated organization, then returns the sum.
|
|
7002
7421
|
# @return [String]
|
|
7003
7422
|
#
|
|
7004
|
-
# @!attribute [rw]
|
|
7005
|
-
#
|
|
7006
|
-
#
|
|
7007
|
-
#
|
|
7008
|
-
#
|
|
7423
|
+
# @!attribute [rw] resource_type
|
|
7424
|
+
# Returns the job count for the specified resource type. Use request
|
|
7425
|
+
# `GetSupportedResourceTypes` to obtain strings for supported resource
|
|
7426
|
+
# types.
|
|
7427
|
+
#
|
|
7428
|
+
# The the value `ANY` returns count of all resource types.
|
|
7429
|
+
#
|
|
7430
|
+
# `AGGREGATE_ALL` aggregates job counts for all resource types and
|
|
7431
|
+
# returns the sum.
|
|
7009
7432
|
# @return [String]
|
|
7010
7433
|
#
|
|
7011
|
-
# @!attribute [rw]
|
|
7012
|
-
#
|
|
7013
|
-
#
|
|
7434
|
+
# @!attribute [rw] malware_scanner
|
|
7435
|
+
# Returns only the scan jobs for the specified malware scanner.
|
|
7436
|
+
# Currently the only MalwareScanner is `GUARDDUTY`. But the field also
|
|
7437
|
+
# supports `ANY`, and `AGGREGATE_ALL`.
|
|
7438
|
+
# @return [String]
|
|
7014
7439
|
#
|
|
7015
|
-
#
|
|
7440
|
+
# @!attribute [rw] scan_result_status
|
|
7441
|
+
# Returns only the scan jobs for the specified scan results.
|
|
7442
|
+
# @return [String]
|
|
7016
7443
|
#
|
|
7017
|
-
|
|
7018
|
-
|
|
7019
|
-
|
|
7020
|
-
|
|
7444
|
+
# @!attribute [rw] state
|
|
7445
|
+
# Returns only the scan jobs for the specified scanning job state.
|
|
7446
|
+
# @return [String]
|
|
7447
|
+
#
|
|
7448
|
+
# @!attribute [rw] aggregation_period
|
|
7449
|
+
# The period for the returned results.
|
|
7450
|
+
#
|
|
7451
|
+
# * `ONE_DAY`The daily job count for the prior 1 day.
|
|
7452
|
+
#
|
|
7453
|
+
# * `SEVEN_DAYS`The daily job count for the prior 7 days.
|
|
7454
|
+
#
|
|
7455
|
+
# * `FOURTEEN_DAYS`The daily job count for the prior 14 days.
|
|
7456
|
+
# @return [String]
|
|
7457
|
+
#
|
|
7458
|
+
# @!attribute [rw] max_results
|
|
7459
|
+
# The maximum number of items to be returned.
|
|
7460
|
+
#
|
|
7461
|
+
# The value is an integer. Range of accepted values is from 1 to 500.
|
|
7462
|
+
# @return [Integer]
|
|
7463
|
+
#
|
|
7464
|
+
# @!attribute [rw] next_token
|
|
7465
|
+
# The next item following a partial list of returned items. For
|
|
7466
|
+
# example, if a request is made to return `MaxResults` number of
|
|
7467
|
+
# items, `NextToken` allows you to return more items in your list
|
|
7468
|
+
# starting at the location pointed to by the next token.
|
|
7469
|
+
# @return [String]
|
|
7470
|
+
#
|
|
7471
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListScanJobSummariesInput AWS API Documentation
|
|
7472
|
+
#
|
|
7473
|
+
class ListScanJobSummariesInput < Struct.new(
|
|
7474
|
+
:account_id,
|
|
7475
|
+
:resource_type,
|
|
7476
|
+
:malware_scanner,
|
|
7477
|
+
:scan_result_status,
|
|
7478
|
+
:state,
|
|
7479
|
+
:aggregation_period,
|
|
7480
|
+
:max_results,
|
|
7481
|
+
:next_token)
|
|
7482
|
+
SENSITIVE = []
|
|
7483
|
+
include Aws::Structure
|
|
7484
|
+
end
|
|
7485
|
+
|
|
7486
|
+
# @!attribute [rw] scan_job_summaries
|
|
7487
|
+
# The summary information.
|
|
7488
|
+
# @return [Array<Types::ScanJobSummary>]
|
|
7489
|
+
#
|
|
7490
|
+
# @!attribute [rw] aggregation_period
|
|
7491
|
+
# The period for the returned results.
|
|
7492
|
+
#
|
|
7493
|
+
# * `ONE_DAY`The daily job count for the prior 1 day.
|
|
7494
|
+
#
|
|
7495
|
+
# * `SEVEN_DAYS`The daily job count for the prior 7 days.
|
|
7496
|
+
#
|
|
7497
|
+
# * `FOURTEEN_DAYS`The daily job count for the prior 14 days.
|
|
7498
|
+
#
|
|
7499
|
+
# Valid Values: `'ONE_DAY'` \| `'SEVEN_DAYS'` \| `'FOURTEEN_DAYS'`
|
|
7500
|
+
# @return [String]
|
|
7501
|
+
#
|
|
7502
|
+
# @!attribute [rw] next_token
|
|
7503
|
+
# The next item following a partial list of returned items. For
|
|
7504
|
+
# example, if a request is made to return `MaxResults` number of
|
|
7505
|
+
# items, `NextToken` allows you to return more items in your list
|
|
7506
|
+
# starting at the location pointed to by the next token.
|
|
7507
|
+
# @return [String]
|
|
7508
|
+
#
|
|
7509
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListScanJobSummariesOutput AWS API Documentation
|
|
7510
|
+
#
|
|
7511
|
+
class ListScanJobSummariesOutput < Struct.new(
|
|
7512
|
+
:scan_job_summaries,
|
|
7513
|
+
:aggregation_period,
|
|
7514
|
+
:next_token)
|
|
7515
|
+
SENSITIVE = []
|
|
7516
|
+
include Aws::Structure
|
|
7517
|
+
end
|
|
7518
|
+
|
|
7519
|
+
# @!attribute [rw] by_account_id
|
|
7520
|
+
# The account ID to list the jobs from. Returns only backup jobs
|
|
7521
|
+
# associated with the specified account ID.
|
|
7522
|
+
#
|
|
7523
|
+
# If used from an Amazon Web Services Organizations management
|
|
7524
|
+
# account, passing `*` returns all jobs across the organization.
|
|
7525
|
+
#
|
|
7526
|
+
# Pattern: `^[0-9]{12}$`
|
|
7527
|
+
# @return [String]
|
|
7528
|
+
#
|
|
7529
|
+
# @!attribute [rw] by_backup_vault_name
|
|
7530
|
+
# Returns only scan jobs that will be stored in the specified backup
|
|
7531
|
+
# vault. Backup vaults are identified by names that are unique to the
|
|
7532
|
+
# account used to create them and the Amazon Web Services Region where
|
|
7533
|
+
# they are created.
|
|
7534
|
+
#
|
|
7535
|
+
# Pattern: `^[a-zA-Z0-9\-\_\.]{2,50}$`
|
|
7536
|
+
# @return [String]
|
|
7537
|
+
#
|
|
7538
|
+
# @!attribute [rw] by_complete_after
|
|
7539
|
+
# Returns only scan jobs completed after a date expressed in Unix
|
|
7540
|
+
# format and Coordinated Universal Time (UTC).
|
|
7541
|
+
# @return [Time]
|
|
7542
|
+
#
|
|
7543
|
+
# @!attribute [rw] by_complete_before
|
|
7544
|
+
# Returns only backup jobs completed before a date expressed in Unix
|
|
7545
|
+
# format and Coordinated Universal Time (UTC).
|
|
7546
|
+
# @return [Time]
|
|
7547
|
+
#
|
|
7548
|
+
# @!attribute [rw] by_malware_scanner
|
|
7549
|
+
# Returns only the scan jobs for the specified malware scanner.
|
|
7550
|
+
# Currently only supports `GUARDDUTY`.
|
|
7551
|
+
# @return [String]
|
|
7552
|
+
#
|
|
7553
|
+
# @!attribute [rw] by_recovery_point_arn
|
|
7554
|
+
# Returns only the scan jobs that are ran against the specified
|
|
7555
|
+
# recovery point.
|
|
7556
|
+
# @return [String]
|
|
7557
|
+
#
|
|
7558
|
+
# @!attribute [rw] by_resource_arn
|
|
7559
|
+
# Returns only scan jobs that match the specified resource Amazon
|
|
7560
|
+
# Resource Name (ARN).
|
|
7561
|
+
# @return [String]
|
|
7562
|
+
#
|
|
7563
|
+
# @!attribute [rw] by_resource_type
|
|
7564
|
+
# Returns restore testing selections by the specified restore testing
|
|
7565
|
+
# plan name.
|
|
7566
|
+
#
|
|
7567
|
+
# * `EBS`for Amazon Elastic Block Store
|
|
7568
|
+
#
|
|
7569
|
+
# * `EC2`for Amazon Elastic Compute Cloud
|
|
7570
|
+
#
|
|
7571
|
+
# * `S3`for Amazon Simple Storage Service (Amazon S3)
|
|
7572
|
+
#
|
|
7573
|
+
# Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`
|
|
7574
|
+
# @return [String]
|
|
7575
|
+
#
|
|
7576
|
+
# @!attribute [rw] by_scan_result_status
|
|
7577
|
+
# Returns only the scan jobs for the specified scan results:
|
|
7578
|
+
#
|
|
7579
|
+
# * `THREATS_FOUND`
|
|
7580
|
+
#
|
|
7581
|
+
# * `NO_THREATS_FOUND`
|
|
7582
|
+
# @return [String]
|
|
7583
|
+
#
|
|
7584
|
+
# @!attribute [rw] by_state
|
|
7585
|
+
# Returns only the scan jobs for the specified scanning job state.
|
|
7586
|
+
# @return [String]
|
|
7587
|
+
#
|
|
7588
|
+
# @!attribute [rw] max_results
|
|
7589
|
+
# The maximum number of items to be returned.
|
|
7590
|
+
#
|
|
7591
|
+
# Valid Range: Minimum value of 1. Maximum value of 1000.
|
|
7592
|
+
# @return [Integer]
|
|
7593
|
+
#
|
|
7594
|
+
# @!attribute [rw] next_token
|
|
7595
|
+
# The next item following a partial list of returned items. For
|
|
7596
|
+
# example, if a request is made to return `MaxResults` number of
|
|
7597
|
+
# items, `NextToken` allows you to return more items in your list
|
|
7598
|
+
# starting at the location pointed to by the next token.
|
|
7599
|
+
# @return [String]
|
|
7600
|
+
#
|
|
7601
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListScanJobsInput AWS API Documentation
|
|
7602
|
+
#
|
|
7603
|
+
class ListScanJobsInput < Struct.new(
|
|
7604
|
+
:by_account_id,
|
|
7605
|
+
:by_backup_vault_name,
|
|
7606
|
+
:by_complete_after,
|
|
7607
|
+
:by_complete_before,
|
|
7608
|
+
:by_malware_scanner,
|
|
7609
|
+
:by_recovery_point_arn,
|
|
7610
|
+
:by_resource_arn,
|
|
7611
|
+
:by_resource_type,
|
|
7612
|
+
:by_scan_result_status,
|
|
7613
|
+
:by_state,
|
|
7614
|
+
:max_results,
|
|
7615
|
+
:next_token)
|
|
7616
|
+
SENSITIVE = []
|
|
7617
|
+
include Aws::Structure
|
|
7618
|
+
end
|
|
7619
|
+
|
|
7620
|
+
# @!attribute [rw] next_token
|
|
7621
|
+
# The next item following a partial list of returned items. For
|
|
7622
|
+
# example, if a request is made to return `MaxResults` number of
|
|
7623
|
+
# items, `NextToken` allows you to return more items in your list
|
|
7624
|
+
# starting at the location pointed to by the next token.
|
|
7625
|
+
# @return [String]
|
|
7626
|
+
#
|
|
7627
|
+
# @!attribute [rw] scan_jobs
|
|
7628
|
+
# An array of structures containing metadata about your scan jobs
|
|
7629
|
+
# returned in JSON format.
|
|
7630
|
+
# @return [Array<Types::ScanJob>]
|
|
7631
|
+
#
|
|
7632
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListScanJobsOutput AWS API Documentation
|
|
7633
|
+
#
|
|
7634
|
+
class ListScanJobsOutput < Struct.new(
|
|
7635
|
+
:next_token,
|
|
7636
|
+
:scan_jobs)
|
|
7637
|
+
SENSITIVE = []
|
|
7638
|
+
include Aws::Structure
|
|
7639
|
+
end
|
|
7640
|
+
|
|
7641
|
+
# @!attribute [rw] resource_arn
|
|
7642
|
+
# An Amazon Resource Name (ARN) that uniquely identifies a resource.
|
|
7643
|
+
# The format of the ARN depends on the type of resource. Valid targets
|
|
7644
|
+
# for `ListTags` are recovery points, backup plans, and backup vaults.
|
|
7645
|
+
# @return [String]
|
|
7646
|
+
#
|
|
7647
|
+
# @!attribute [rw] next_token
|
|
7648
|
+
# The next item following a partial list of returned items. For
|
|
7649
|
+
# example, if a request is made to return `MaxResults` number of
|
|
7650
|
+
# items, `NextToken` allows you to return more items in your list
|
|
7651
|
+
# starting at the location pointed to by the next token.
|
|
7652
|
+
# @return [String]
|
|
7653
|
+
#
|
|
7654
|
+
# @!attribute [rw] max_results
|
|
7655
|
+
# The maximum number of items to be returned.
|
|
7656
|
+
# @return [Integer]
|
|
7657
|
+
#
|
|
7658
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListTagsInput AWS API Documentation
|
|
7659
|
+
#
|
|
7660
|
+
class ListTagsInput < Struct.new(
|
|
7661
|
+
:resource_arn,
|
|
7662
|
+
:next_token,
|
|
7663
|
+
:max_results)
|
|
7021
7664
|
SENSITIVE = []
|
|
7022
7665
|
include Aws::Structure
|
|
7023
7666
|
end
|
|
@@ -7042,6 +7685,47 @@ module Aws::Backup
|
|
|
7042
7685
|
include Aws::Structure
|
|
7043
7686
|
end
|
|
7044
7687
|
|
|
7688
|
+
# @!attribute [rw] max_results
|
|
7689
|
+
# The maximum number of items to be returned.
|
|
7690
|
+
# @return [Integer]
|
|
7691
|
+
#
|
|
7692
|
+
# @!attribute [rw] next_token
|
|
7693
|
+
# The next item following a partial list of returned items. For
|
|
7694
|
+
# example, if a request is made to return `MaxResults` number of
|
|
7695
|
+
# items, `NextToken` allows you to return more items in your list
|
|
7696
|
+
# starting at the location pointed to by the next token.
|
|
7697
|
+
# @return [String]
|
|
7698
|
+
#
|
|
7699
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListTieringConfigurationsInput AWS API Documentation
|
|
7700
|
+
#
|
|
7701
|
+
class ListTieringConfigurationsInput < Struct.new(
|
|
7702
|
+
:max_results,
|
|
7703
|
+
:next_token)
|
|
7704
|
+
SENSITIVE = []
|
|
7705
|
+
include Aws::Structure
|
|
7706
|
+
end
|
|
7707
|
+
|
|
7708
|
+
# @!attribute [rw] tiering_configurations
|
|
7709
|
+
# An array of tiering configurations returned by the
|
|
7710
|
+
# `ListTieringConfigurations` call.
|
|
7711
|
+
# @return [Array<Types::TieringConfigurationsListMember>]
|
|
7712
|
+
#
|
|
7713
|
+
# @!attribute [rw] next_token
|
|
7714
|
+
# The next item following a partial list of returned items. For
|
|
7715
|
+
# example, if a request is made to return `MaxResults` number of
|
|
7716
|
+
# items, `NextToken` allows you to return more items in your list
|
|
7717
|
+
# starting at the location pointed to by the next token.
|
|
7718
|
+
# @return [String]
|
|
7719
|
+
#
|
|
7720
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListTieringConfigurationsOutput AWS API Documentation
|
|
7721
|
+
#
|
|
7722
|
+
class ListTieringConfigurationsOutput < Struct.new(
|
|
7723
|
+
:tiering_configurations,
|
|
7724
|
+
:next_token)
|
|
7725
|
+
SENSITIVE = []
|
|
7726
|
+
include Aws::Structure
|
|
7727
|
+
end
|
|
7728
|
+
|
|
7045
7729
|
# Indicates that a required parameter is missing.
|
|
7046
7730
|
#
|
|
7047
7731
|
# @!attribute [rw] code
|
|
@@ -7472,6 +8156,17 @@ module Aws::Backup
|
|
|
7472
8156
|
# a backup index associated with the recovery point.
|
|
7473
8157
|
# @return [String]
|
|
7474
8158
|
#
|
|
8159
|
+
# @!attribute [rw] encryption_key_type
|
|
8160
|
+
# The type of encryption key used for the recovery point. Valid values
|
|
8161
|
+
# are CUSTOMER\_MANAGED\_KMS\_KEY for customer-managed keys or Amazon
|
|
8162
|
+
# Web Services\_OWNED\_KMS\_KEY for Amazon Web Services-owned keys.
|
|
8163
|
+
# @return [String]
|
|
8164
|
+
#
|
|
8165
|
+
# @!attribute [rw] aggregated_scan_result
|
|
8166
|
+
# Contains the latest scanning results against the recovery point and
|
|
8167
|
+
# currently include `FailedScan`, `Findings`, `LastComputed`.
|
|
8168
|
+
# @return [Types::AggregatedScanResult]
|
|
8169
|
+
#
|
|
7475
8170
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/RecoveryPointByBackupVault AWS API Documentation
|
|
7476
8171
|
#
|
|
7477
8172
|
class RecoveryPointByBackupVault < Struct.new(
|
|
@@ -7500,7 +8195,9 @@ module Aws::Backup
|
|
|
7500
8195
|
:resource_name,
|
|
7501
8196
|
:vault_type,
|
|
7502
8197
|
:index_status,
|
|
7503
|
-
:index_status_message
|
|
8198
|
+
:index_status_message,
|
|
8199
|
+
:encryption_key_type,
|
|
8200
|
+
:aggregated_scan_result)
|
|
7504
8201
|
SENSITIVE = []
|
|
7505
8202
|
include Aws::Structure
|
|
7506
8203
|
end
|
|
@@ -7579,6 +8276,17 @@ module Aws::Backup
|
|
|
7579
8276
|
# a backup index associated with the recovery point.
|
|
7580
8277
|
# @return [String]
|
|
7581
8278
|
#
|
|
8279
|
+
# @!attribute [rw] encryption_key_type
|
|
8280
|
+
# The type of encryption key used for the recovery point. Valid values
|
|
8281
|
+
# are CUSTOMER\_MANAGED\_KMS\_KEY for customer-managed keys or Amazon
|
|
8282
|
+
# Web Services\_OWNED\_KMS\_KEY for Amazon Web Services-owned keys.
|
|
8283
|
+
# @return [String]
|
|
8284
|
+
#
|
|
8285
|
+
# @!attribute [rw] aggregated_scan_result
|
|
8286
|
+
# Contains the latest scanning results against the recovery point and
|
|
8287
|
+
# currently include `FailedScan`, `Findings`, `LastComputed`.
|
|
8288
|
+
# @return [Types::AggregatedScanResult]
|
|
8289
|
+
#
|
|
7582
8290
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/RecoveryPointByResource AWS API Documentation
|
|
7583
8291
|
#
|
|
7584
8292
|
class RecoveryPointByResource < Struct.new(
|
|
@@ -7594,7 +8302,9 @@ module Aws::Backup
|
|
|
7594
8302
|
:resource_name,
|
|
7595
8303
|
:vault_type,
|
|
7596
8304
|
:index_status,
|
|
7597
|
-
:index_status_message
|
|
8305
|
+
:index_status_message,
|
|
8306
|
+
:encryption_key_type,
|
|
8307
|
+
:aggregated_scan_result)
|
|
7598
8308
|
SENSITIVE = []
|
|
7599
8309
|
include Aws::Structure
|
|
7600
8310
|
end
|
|
@@ -7942,7 +8652,8 @@ module Aws::Backup
|
|
|
7942
8652
|
# using a report template. The report templates are:
|
|
7943
8653
|
#
|
|
7944
8654
|
# `RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT |
|
|
7945
|
-
# BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT
|
|
8655
|
+
# BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT |
|
|
8656
|
+
# SCAN_JOB_REPORT`
|
|
7946
8657
|
# @return [String]
|
|
7947
8658
|
#
|
|
7948
8659
|
# @!attribute [rw] framework_arns
|
|
@@ -8007,6 +8718,41 @@ module Aws::Backup
|
|
|
8007
8718
|
include Aws::Structure
|
|
8008
8719
|
end
|
|
8009
8720
|
|
|
8721
|
+
# This contains metadata about resource selection for tiering
|
|
8722
|
+
# configurations.
|
|
8723
|
+
#
|
|
8724
|
+
# You can specify up to 5 different resource selections per tiering
|
|
8725
|
+
# configuration. Data moved to lower-cost tier remains there until
|
|
8726
|
+
# deletion (one-way transition).
|
|
8727
|
+
#
|
|
8728
|
+
# @!attribute [rw] resources
|
|
8729
|
+
# An array of strings that either contains ARNs of the associated
|
|
8730
|
+
# resources or contains a wildcard `*` to specify all resources. You
|
|
8731
|
+
# can specify up to 100 specific resources per tiering configuration.
|
|
8732
|
+
# @return [Array<String>]
|
|
8733
|
+
#
|
|
8734
|
+
# @!attribute [rw] tiering_down_settings_in_days
|
|
8735
|
+
# The number of days after creation within a backup vault that an
|
|
8736
|
+
# object can transition to the low cost warm storage tier. Must be a
|
|
8737
|
+
# positive integer between 60 and 36500 days.
|
|
8738
|
+
# @return [Integer]
|
|
8739
|
+
#
|
|
8740
|
+
# @!attribute [rw] resource_type
|
|
8741
|
+
# The type of Amazon Web Services resource; for example, `S3` for
|
|
8742
|
+
# Amazon S3. For tiering configurations, this is currently limited to
|
|
8743
|
+
# `S3`.
|
|
8744
|
+
# @return [String]
|
|
8745
|
+
#
|
|
8746
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ResourceSelection AWS API Documentation
|
|
8747
|
+
#
|
|
8748
|
+
class ResourceSelection < Struct.new(
|
|
8749
|
+
:resources,
|
|
8750
|
+
:tiering_down_settings_in_days,
|
|
8751
|
+
:resource_type)
|
|
8752
|
+
SENSITIVE = []
|
|
8753
|
+
include Aws::Structure
|
|
8754
|
+
end
|
|
8755
|
+
|
|
8010
8756
|
# Contains information about a restore access backup vault.
|
|
8011
8757
|
#
|
|
8012
8758
|
# @!attribute [rw] restore_access_backup_vault_arn
|
|
@@ -8204,6 +8950,16 @@ module Aws::Backup
|
|
|
8204
8950
|
# The date on which a recovery point was created.
|
|
8205
8951
|
# @return [Time]
|
|
8206
8952
|
#
|
|
8953
|
+
# @!attribute [rw] is_parent
|
|
8954
|
+
# This is a boolean value indicating whether the restore job is a
|
|
8955
|
+
# parent (composite) restore job.
|
|
8956
|
+
# @return [Boolean]
|
|
8957
|
+
#
|
|
8958
|
+
# @!attribute [rw] parent_job_id
|
|
8959
|
+
# This is the unique identifier of the parent restore job for the
|
|
8960
|
+
# selected restore job.
|
|
8961
|
+
# @return [String]
|
|
8962
|
+
#
|
|
8207
8963
|
# @!attribute [rw] created_by
|
|
8208
8964
|
# Contains identifying information about the creation of a restore
|
|
8209
8965
|
# job.
|
|
@@ -8246,6 +9002,8 @@ module Aws::Backup
|
|
|
8246
9002
|
:created_resource_arn,
|
|
8247
9003
|
:resource_type,
|
|
8248
9004
|
:recovery_point_creation_date,
|
|
9005
|
+
:is_parent,
|
|
9006
|
+
:parent_job_id,
|
|
8249
9007
|
:created_by,
|
|
8250
9008
|
:validation_status,
|
|
8251
9009
|
:validation_status_message,
|
|
@@ -8680,6 +9438,9 @@ module Aws::Backup
|
|
|
8680
9438
|
# @!attribute [rw] restore_testing_selection_name
|
|
8681
9439
|
# The unique name of the restore testing selection that belongs to the
|
|
8682
9440
|
# related restore testing plan.
|
|
9441
|
+
#
|
|
9442
|
+
# The name consists of only alphanumeric characters and underscores.
|
|
9443
|
+
# Maximum length is 50.
|
|
8683
9444
|
# @return [String]
|
|
8684
9445
|
#
|
|
8685
9446
|
# @!attribute [rw] validation_window_hours
|
|
@@ -8765,6 +9526,9 @@ module Aws::Backup
|
|
|
8765
9526
|
# @!attribute [rw] restore_testing_selection_name
|
|
8766
9527
|
# The unique name of the restore testing selection that belongs to the
|
|
8767
9528
|
# related restore testing plan.
|
|
9529
|
+
#
|
|
9530
|
+
# The name consists of only alphanumeric characters and underscores.
|
|
9531
|
+
# Maximum length is 50.
|
|
8768
9532
|
# @return [String]
|
|
8769
9533
|
#
|
|
8770
9534
|
# @!attribute [rw] validation_window_hours
|
|
@@ -8821,6 +9585,9 @@ module Aws::Backup
|
|
|
8821
9585
|
#
|
|
8822
9586
|
# @!attribute [rw] restore_testing_selection_name
|
|
8823
9587
|
# Unique name of a restore testing selection.
|
|
9588
|
+
#
|
|
9589
|
+
# The name consists of only alphanumeric characters and underscores.
|
|
9590
|
+
# Maximum length is 50.
|
|
8824
9591
|
# @return [String]
|
|
8825
9592
|
#
|
|
8826
9593
|
# @!attribute [rw] validation_window_hours
|
|
@@ -8919,25 +9686,373 @@ module Aws::Backup
|
|
|
8919
9686
|
include Aws::Structure
|
|
8920
9687
|
end
|
|
8921
9688
|
|
|
8922
|
-
#
|
|
8923
|
-
#
|
|
8924
|
-
# identifier.
|
|
8925
|
-
#
|
|
8926
|
-
# @!attribute [rw] execution_time
|
|
8927
|
-
# The timestamp when the backup is scheduled to run, in Unix format
|
|
8928
|
-
# and Coordinated Universal Time (UTC). The value is accurate to
|
|
8929
|
-
# milliseconds.
|
|
8930
|
-
# @return [Time]
|
|
9689
|
+
# Defines a scanning action that specifies the malware scanner and scan
|
|
9690
|
+
# mode to use.
|
|
8931
9691
|
#
|
|
8932
|
-
# @!attribute [rw]
|
|
8933
|
-
# The
|
|
8934
|
-
#
|
|
9692
|
+
# @!attribute [rw] malware_scanner
|
|
9693
|
+
# The malware scanner to use for the scan action. Currently only
|
|
9694
|
+
# `GUARDDUTY` is supported.
|
|
8935
9695
|
# @return [String]
|
|
8936
9696
|
#
|
|
8937
|
-
# @!attribute [rw]
|
|
8938
|
-
# The
|
|
8939
|
-
#
|
|
8940
|
-
# `
|
|
9697
|
+
# @!attribute [rw] scan_mode
|
|
9698
|
+
# The scanning mode to use for the scan action.
|
|
9699
|
+
#
|
|
9700
|
+
# Valid values: `FULL_SCAN` \| `INCREMENTAL_SCAN`.
|
|
9701
|
+
# @return [String]
|
|
9702
|
+
#
|
|
9703
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ScanAction AWS API Documentation
|
|
9704
|
+
#
|
|
9705
|
+
class ScanAction < Struct.new(
|
|
9706
|
+
:malware_scanner,
|
|
9707
|
+
:scan_mode)
|
|
9708
|
+
SENSITIVE = []
|
|
9709
|
+
include Aws::Structure
|
|
9710
|
+
end
|
|
9711
|
+
|
|
9712
|
+
# Contains metadata about a scan job, including information about the
|
|
9713
|
+
# scanning process, results, and associated resources.
|
|
9714
|
+
#
|
|
9715
|
+
# @!attribute [rw] account_id
|
|
9716
|
+
# The account ID that owns the scan job.
|
|
9717
|
+
# @return [String]
|
|
9718
|
+
#
|
|
9719
|
+
# @!attribute [rw] backup_vault_arn
|
|
9720
|
+
# An Amazon Resource Name (ARN) that uniquely identifies a backup
|
|
9721
|
+
# vault; for example,
|
|
9722
|
+
# `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.
|
|
9723
|
+
# @return [String]
|
|
9724
|
+
#
|
|
9725
|
+
# @!attribute [rw] backup_vault_name
|
|
9726
|
+
# The name of a logical container where backups are stored. Backup
|
|
9727
|
+
# vaults are identified by names that are unique to the account used
|
|
9728
|
+
# to create them and the Amazon Web Services Region where they are
|
|
9729
|
+
# created.
|
|
9730
|
+
# @return [String]
|
|
9731
|
+
#
|
|
9732
|
+
# @!attribute [rw] completion_date
|
|
9733
|
+
# The date and time that a scan job is completed, in Unix format and
|
|
9734
|
+
# Coordinated Universal Time (UTC). The value of `CompletionDate` is
|
|
9735
|
+
# accurate to milliseconds. For example, the value 1516925490.087
|
|
9736
|
+
# represents Friday, January 26, 2018 12:11:30.087 AM.
|
|
9737
|
+
# @return [Time]
|
|
9738
|
+
#
|
|
9739
|
+
# @!attribute [rw] created_by
|
|
9740
|
+
# Contains identifying information about the creation of a scan job.
|
|
9741
|
+
# @return [Types::ScanJobCreator]
|
|
9742
|
+
#
|
|
9743
|
+
# @!attribute [rw] creation_date
|
|
9744
|
+
# The date and time that a scan job is created, in Unix format and
|
|
9745
|
+
# Coordinated Universal Time (UTC). The value of `CreationDate` is
|
|
9746
|
+
# accurate to milliseconds. For example, the value 1516925490.087
|
|
9747
|
+
# represents Friday, January 26, 2018 12:11:30.087 AM.
|
|
9748
|
+
# @return [Time]
|
|
9749
|
+
#
|
|
9750
|
+
# @!attribute [rw] iam_role_arn
|
|
9751
|
+
# Specifies the IAM role ARN used to create the scan job; for example,
|
|
9752
|
+
# `arn:aws:iam::123456789012:role/S3Access`.
|
|
9753
|
+
# @return [String]
|
|
9754
|
+
#
|
|
9755
|
+
# @!attribute [rw] malware_scanner
|
|
9756
|
+
# The scanning engine used for the scan job. Currently only
|
|
9757
|
+
# `GUARDDUTY` is supported.
|
|
9758
|
+
# @return [String]
|
|
9759
|
+
#
|
|
9760
|
+
# @!attribute [rw] recovery_point_arn
|
|
9761
|
+
# An ARN that uniquely identifies the recovery point being scanned;
|
|
9762
|
+
# for example,
|
|
9763
|
+
# `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
|
|
9764
|
+
# @return [String]
|
|
9765
|
+
#
|
|
9766
|
+
# @!attribute [rw] resource_arn
|
|
9767
|
+
# An ARN that uniquely identifies the source resource of the recovery
|
|
9768
|
+
# point being scanned.
|
|
9769
|
+
# @return [String]
|
|
9770
|
+
#
|
|
9771
|
+
# @!attribute [rw] resource_name
|
|
9772
|
+
# The non-unique name of the resource that belongs to the specified
|
|
9773
|
+
# backup.
|
|
9774
|
+
# @return [String]
|
|
9775
|
+
#
|
|
9776
|
+
# @!attribute [rw] resource_type
|
|
9777
|
+
# The type of Amazon Web Services resource being scanned; for example,
|
|
9778
|
+
# an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon
|
|
9779
|
+
# Relational Database Service (Amazon RDS) database.
|
|
9780
|
+
# @return [String]
|
|
9781
|
+
#
|
|
9782
|
+
# @!attribute [rw] scan_base_recovery_point_arn
|
|
9783
|
+
# An ARN that uniquely identifies the base recovery point for
|
|
9784
|
+
# scanning. This field is populated when an incremental scan job has
|
|
9785
|
+
# taken place.
|
|
9786
|
+
# @return [String]
|
|
9787
|
+
#
|
|
9788
|
+
# @!attribute [rw] scan_id
|
|
9789
|
+
# The scan ID generated by the malware scanner for the corresponding
|
|
9790
|
+
# scan job.
|
|
9791
|
+
# @return [String]
|
|
9792
|
+
#
|
|
9793
|
+
# @!attribute [rw] scan_job_id
|
|
9794
|
+
# The unique identifier that identifies the scan job request to
|
|
9795
|
+
# Backup.
|
|
9796
|
+
# @return [String]
|
|
9797
|
+
#
|
|
9798
|
+
# @!attribute [rw] scan_mode
|
|
9799
|
+
# Specifies the scan type use for the scan job.
|
|
9800
|
+
#
|
|
9801
|
+
# Includes:
|
|
9802
|
+
#
|
|
9803
|
+
# `FULL_SCAN` will scan the entire data lineage within the backup.
|
|
9804
|
+
#
|
|
9805
|
+
# `INCREMENTAL_SCAN` will scan the data difference between the target
|
|
9806
|
+
# recovery point and base recovery point ARN.
|
|
9807
|
+
# @return [String]
|
|
9808
|
+
#
|
|
9809
|
+
# @!attribute [rw] scan_result
|
|
9810
|
+
# Contains the scan results information, including the status of
|
|
9811
|
+
# threats found during scanning.
|
|
9812
|
+
# @return [Types::ScanResultInfo]
|
|
9813
|
+
#
|
|
9814
|
+
# @!attribute [rw] scanner_role_arn
|
|
9815
|
+
# Specifies the scanner IAM role ARN used for the scan job.
|
|
9816
|
+
# @return [String]
|
|
9817
|
+
#
|
|
9818
|
+
# @!attribute [rw] state
|
|
9819
|
+
# The current state of the scan job.
|
|
9820
|
+
#
|
|
9821
|
+
# Valid values: `CREATED` \| `RUNNING` \| `COMPLETED` \|
|
|
9822
|
+
# `COMPLETED_WITH_ISSUES` \| `FAILED` \| `CANCELED`.
|
|
9823
|
+
# @return [String]
|
|
9824
|
+
#
|
|
9825
|
+
# @!attribute [rw] status_message
|
|
9826
|
+
# A detailed message explaining the status of the scan job.
|
|
9827
|
+
# @return [String]
|
|
9828
|
+
#
|
|
9829
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ScanJob AWS API Documentation
|
|
9830
|
+
#
|
|
9831
|
+
class ScanJob < Struct.new(
|
|
9832
|
+
:account_id,
|
|
9833
|
+
:backup_vault_arn,
|
|
9834
|
+
:backup_vault_name,
|
|
9835
|
+
:completion_date,
|
|
9836
|
+
:created_by,
|
|
9837
|
+
:creation_date,
|
|
9838
|
+
:iam_role_arn,
|
|
9839
|
+
:malware_scanner,
|
|
9840
|
+
:recovery_point_arn,
|
|
9841
|
+
:resource_arn,
|
|
9842
|
+
:resource_name,
|
|
9843
|
+
:resource_type,
|
|
9844
|
+
:scan_base_recovery_point_arn,
|
|
9845
|
+
:scan_id,
|
|
9846
|
+
:scan_job_id,
|
|
9847
|
+
:scan_mode,
|
|
9848
|
+
:scan_result,
|
|
9849
|
+
:scanner_role_arn,
|
|
9850
|
+
:state,
|
|
9851
|
+
:status_message)
|
|
9852
|
+
SENSITIVE = []
|
|
9853
|
+
include Aws::Structure
|
|
9854
|
+
end
|
|
9855
|
+
|
|
9856
|
+
# Contains identifying information about the creation of a scan job,
|
|
9857
|
+
# including the backup plan and rule that initiated the scan.
|
|
9858
|
+
#
|
|
9859
|
+
# @!attribute [rw] backup_plan_arn
|
|
9860
|
+
# An Amazon Resource Name (ARN) that uniquely identifies a backup
|
|
9861
|
+
# plan; for example,
|
|
9862
|
+
# `arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50`.
|
|
9863
|
+
# @return [String]
|
|
9864
|
+
#
|
|
9865
|
+
# @!attribute [rw] backup_plan_id
|
|
9866
|
+
# The ID of the backup plan.
|
|
9867
|
+
# @return [String]
|
|
9868
|
+
#
|
|
9869
|
+
# @!attribute [rw] backup_plan_version
|
|
9870
|
+
# Unique, randomly generated, Unicode, UTF-8 encoded strings that are
|
|
9871
|
+
# at most 1,024 bytes long. Version IDs cannot be edited.
|
|
9872
|
+
# @return [String]
|
|
9873
|
+
#
|
|
9874
|
+
# @!attribute [rw] backup_rule_id
|
|
9875
|
+
# Uniquely identifies the backup rule that initiated the scan job.
|
|
9876
|
+
# @return [String]
|
|
9877
|
+
#
|
|
9878
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ScanJobCreator AWS API Documentation
|
|
9879
|
+
#
|
|
9880
|
+
class ScanJobCreator < Struct.new(
|
|
9881
|
+
:backup_plan_arn,
|
|
9882
|
+
:backup_plan_id,
|
|
9883
|
+
:backup_plan_version,
|
|
9884
|
+
:backup_rule_id)
|
|
9885
|
+
SENSITIVE = []
|
|
9886
|
+
include Aws::Structure
|
|
9887
|
+
end
|
|
9888
|
+
|
|
9889
|
+
# Contains summary information about scan jobs, including counts and
|
|
9890
|
+
# metadata for a specific time period and criteria.
|
|
9891
|
+
#
|
|
9892
|
+
# @!attribute [rw] region
|
|
9893
|
+
# The Amazon Web Services Region where the scan jobs were executed.
|
|
9894
|
+
# @return [String]
|
|
9895
|
+
#
|
|
9896
|
+
# @!attribute [rw] account_id
|
|
9897
|
+
# The account ID that owns the scan jobs included in this summary.
|
|
9898
|
+
# @return [String]
|
|
9899
|
+
#
|
|
9900
|
+
# @!attribute [rw] state
|
|
9901
|
+
# The state of the scan jobs included in this summary.
|
|
9902
|
+
#
|
|
9903
|
+
# Valid values: `CREATED` \| `RUNNING` \| `COMPLETED` \|
|
|
9904
|
+
# `COMPLETED_WITH_ISSUES` \| `FAILED` \| `CANCELED`.
|
|
9905
|
+
# @return [String]
|
|
9906
|
+
#
|
|
9907
|
+
# @!attribute [rw] resource_type
|
|
9908
|
+
# The type of Amazon Web Services resource for the scan jobs included
|
|
9909
|
+
# in this summary.
|
|
9910
|
+
# @return [String]
|
|
9911
|
+
#
|
|
9912
|
+
# @!attribute [rw] count
|
|
9913
|
+
# The number of scan jobs that match the specified criteria.
|
|
9914
|
+
# @return [Integer]
|
|
9915
|
+
#
|
|
9916
|
+
# @!attribute [rw] start_time
|
|
9917
|
+
# The value of time in number format of a job start time.
|
|
9918
|
+
#
|
|
9919
|
+
# This value is the time in Unix format, Coordinated Universal Time
|
|
9920
|
+
# (UTC), and accurate to milliseconds. For example, the value
|
|
9921
|
+
# 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
|
|
9922
|
+
# @return [Time]
|
|
9923
|
+
#
|
|
9924
|
+
# @!attribute [rw] end_time
|
|
9925
|
+
# The value of time in number format of a job end time.
|
|
9926
|
+
#
|
|
9927
|
+
# This value is the time in Unix format, Coordinated Universal Time
|
|
9928
|
+
# (UTC), and accurate to milliseconds. For example, the value
|
|
9929
|
+
# 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
|
|
9930
|
+
# @return [Time]
|
|
9931
|
+
#
|
|
9932
|
+
# @!attribute [rw] malware_scanner
|
|
9933
|
+
# Specifies the malware scanner used during the scan job. Currently
|
|
9934
|
+
# only supports `GUARDDUTY`.
|
|
9935
|
+
# @return [String]
|
|
9936
|
+
#
|
|
9937
|
+
# @!attribute [rw] scan_result_status
|
|
9938
|
+
# The scan result status for the scan jobs included in this summary.
|
|
9939
|
+
#
|
|
9940
|
+
# Valid values: `THREATS_FOUND` \| `NO_THREATS_FOUND`.
|
|
9941
|
+
# @return [String]
|
|
9942
|
+
#
|
|
9943
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ScanJobSummary AWS API Documentation
|
|
9944
|
+
#
|
|
9945
|
+
class ScanJobSummary < Struct.new(
|
|
9946
|
+
:region,
|
|
9947
|
+
:account_id,
|
|
9948
|
+
:state,
|
|
9949
|
+
:resource_type,
|
|
9950
|
+
:count,
|
|
9951
|
+
:start_time,
|
|
9952
|
+
:end_time,
|
|
9953
|
+
:malware_scanner,
|
|
9954
|
+
:scan_result_status)
|
|
9955
|
+
SENSITIVE = []
|
|
9956
|
+
include Aws::Structure
|
|
9957
|
+
end
|
|
9958
|
+
|
|
9959
|
+
# Contains the results of a security scan, including scanner
|
|
9960
|
+
# information, scan state, and any findings discovered.
|
|
9961
|
+
#
|
|
9962
|
+
# @!attribute [rw] malware_scanner
|
|
9963
|
+
# The malware scanner used to perform the scan. Currently only
|
|
9964
|
+
# `GUARDDUTY` is supported.
|
|
9965
|
+
# @return [String]
|
|
9966
|
+
#
|
|
9967
|
+
# @!attribute [rw] scan_job_state
|
|
9968
|
+
# The final state of the scan job.
|
|
9969
|
+
#
|
|
9970
|
+
# Valid values: `COMPLETED` \| `FAILED` \| `CANCELED`.
|
|
9971
|
+
# @return [String]
|
|
9972
|
+
#
|
|
9973
|
+
# @!attribute [rw] last_scan_timestamp
|
|
9974
|
+
# The timestamp of when the last scan was performed, in Unix format
|
|
9975
|
+
# and Coordinated Universal Time (UTC).
|
|
9976
|
+
# @return [Time]
|
|
9977
|
+
#
|
|
9978
|
+
# @!attribute [rw] findings
|
|
9979
|
+
# An array of findings discovered during the scan.
|
|
9980
|
+
# @return [Array<String>]
|
|
9981
|
+
#
|
|
9982
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ScanResult AWS API Documentation
|
|
9983
|
+
#
|
|
9984
|
+
class ScanResult < Struct.new(
|
|
9985
|
+
:malware_scanner,
|
|
9986
|
+
:scan_job_state,
|
|
9987
|
+
:last_scan_timestamp,
|
|
9988
|
+
:findings)
|
|
9989
|
+
SENSITIVE = []
|
|
9990
|
+
include Aws::Structure
|
|
9991
|
+
end
|
|
9992
|
+
|
|
9993
|
+
# Contains information about the results of a scan job.
|
|
9994
|
+
#
|
|
9995
|
+
# @!attribute [rw] scan_result_status
|
|
9996
|
+
# The status of the scan results.
|
|
9997
|
+
#
|
|
9998
|
+
# Valid values: `THREATS_FOUND` \| `NO_THREATS_FOUND`.
|
|
9999
|
+
# @return [String]
|
|
10000
|
+
#
|
|
10001
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ScanResultInfo AWS API Documentation
|
|
10002
|
+
#
|
|
10003
|
+
class ScanResultInfo < Struct.new(
|
|
10004
|
+
:scan_result_status)
|
|
10005
|
+
SENSITIVE = []
|
|
10006
|
+
include Aws::Structure
|
|
10007
|
+
end
|
|
10008
|
+
|
|
10009
|
+
# Contains configuration settings for malware scanning, including the
|
|
10010
|
+
# scanner type, target resource types, and scanner role.
|
|
10011
|
+
#
|
|
10012
|
+
# @!attribute [rw] malware_scanner
|
|
10013
|
+
# The malware scanner to use for scanning. Currently only `GUARDDUTY`
|
|
10014
|
+
# is supported.
|
|
10015
|
+
# @return [String]
|
|
10016
|
+
#
|
|
10017
|
+
# @!attribute [rw] resource_types
|
|
10018
|
+
# An array of resource types to be scanned for malware.
|
|
10019
|
+
# @return [Array<String>]
|
|
10020
|
+
#
|
|
10021
|
+
# @!attribute [rw] scanner_role_arn
|
|
10022
|
+
# The Amazon Resource Name (ARN) of the IAM role that the scanner uses
|
|
10023
|
+
# to access resources; for example,
|
|
10024
|
+
# `arn:aws:iam::123456789012:role/ScannerRole`.
|
|
10025
|
+
# @return [String]
|
|
10026
|
+
#
|
|
10027
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ScanSetting AWS API Documentation
|
|
10028
|
+
#
|
|
10029
|
+
class ScanSetting < Struct.new(
|
|
10030
|
+
:malware_scanner,
|
|
10031
|
+
:resource_types,
|
|
10032
|
+
:scanner_role_arn)
|
|
10033
|
+
SENSITIVE = []
|
|
10034
|
+
include Aws::Structure
|
|
10035
|
+
end
|
|
10036
|
+
|
|
10037
|
+
# Contains information about a scheduled backup plan execution,
|
|
10038
|
+
# including the execution time, rule type, and associated rule
|
|
10039
|
+
# identifier.
|
|
10040
|
+
#
|
|
10041
|
+
# @!attribute [rw] execution_time
|
|
10042
|
+
# The timestamp when the backup is scheduled to run, in Unix format
|
|
10043
|
+
# and Coordinated Universal Time (UTC). The value is accurate to
|
|
10044
|
+
# milliseconds.
|
|
10045
|
+
# @return [Time]
|
|
10046
|
+
#
|
|
10047
|
+
# @!attribute [rw] rule_id
|
|
10048
|
+
# The unique identifier of the backup rule that will execute at the
|
|
10049
|
+
# scheduled time.
|
|
10050
|
+
# @return [String]
|
|
10051
|
+
#
|
|
10052
|
+
# @!attribute [rw] rule_execution_type
|
|
10053
|
+
# The type of backup rule execution. Valid values are `CONTINUOUS`
|
|
10054
|
+
# (point-in-time recovery), `SNAPSHOTS` (snapshot backups), or
|
|
10055
|
+
# `CONTINUOUS_AND_SNAPSHOTS` (both types combined).
|
|
8941
10056
|
# @return [String]
|
|
8942
10057
|
#
|
|
8943
10058
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ScheduledPlanExecutionMember AWS API Documentation
|
|
@@ -8982,6 +10097,15 @@ module Aws::Backup
|
|
|
8982
10097
|
# created.
|
|
8983
10098
|
# @return [String]
|
|
8984
10099
|
#
|
|
10100
|
+
# @!attribute [rw] logically_air_gapped_backup_vault_arn
|
|
10101
|
+
# The ARN of a logically air-gapped vault. ARN must be in the same
|
|
10102
|
+
# account and Region. If provided, supported fully managed resources
|
|
10103
|
+
# back up directly to logically air-gapped vault, while other
|
|
10104
|
+
# supported resources create a temporary (billable) snapshot in backup
|
|
10105
|
+
# vault, then copy it to logically air-gapped vault. Unsupported
|
|
10106
|
+
# resources only back up to the specified backup vault.
|
|
10107
|
+
# @return [String]
|
|
10108
|
+
#
|
|
8985
10109
|
# @!attribute [rw] resource_arn
|
|
8986
10110
|
# An Amazon Resource Name (ARN) that uniquely identifies a resource.
|
|
8987
10111
|
# The format of the ARN depends on the resource type.
|
|
@@ -9091,6 +10215,7 @@ module Aws::Backup
|
|
|
9091
10215
|
#
|
|
9092
10216
|
class StartBackupJobInput < Struct.new(
|
|
9093
10217
|
:backup_vault_name,
|
|
10218
|
+
:logically_air_gapped_backup_vault_arn,
|
|
9094
10219
|
:resource_arn,
|
|
9095
10220
|
:iam_role_arn,
|
|
9096
10221
|
:idempotency_token,
|
|
@@ -9422,6 +10547,94 @@ module Aws::Backup
|
|
|
9422
10547
|
include Aws::Structure
|
|
9423
10548
|
end
|
|
9424
10549
|
|
|
10550
|
+
# @!attribute [rw] backup_vault_name
|
|
10551
|
+
# The name of a logical container where backups are stored. Backup
|
|
10552
|
+
# vaults are identified by names that are unique to the account used
|
|
10553
|
+
# to create them and the Amazon Web Services Region where they are
|
|
10554
|
+
# created.
|
|
10555
|
+
#
|
|
10556
|
+
# Pattern: `^[a-zA-Z0-9\-\_]{2,50}$`
|
|
10557
|
+
# @return [String]
|
|
10558
|
+
#
|
|
10559
|
+
# @!attribute [rw] iam_role_arn
|
|
10560
|
+
# Specifies the IAM role ARN used to create the target recovery point;
|
|
10561
|
+
# for example, `arn:aws:iam::123456789012:role/S3Access`.
|
|
10562
|
+
# @return [String]
|
|
10563
|
+
#
|
|
10564
|
+
# @!attribute [rw] idempotency_token
|
|
10565
|
+
# A customer-chosen string that you can use to distinguish between
|
|
10566
|
+
# otherwise identical calls to `StartScanJob`. Retrying a successful
|
|
10567
|
+
# request with the same idempotency token results in a success message
|
|
10568
|
+
# with no action taken.
|
|
10569
|
+
# @return [String]
|
|
10570
|
+
#
|
|
10571
|
+
# @!attribute [rw] malware_scanner
|
|
10572
|
+
# Specifies the malware scanner used during the scan job. Currently
|
|
10573
|
+
# only supports `GUARDDUTY`.
|
|
10574
|
+
# @return [String]
|
|
10575
|
+
#
|
|
10576
|
+
# @!attribute [rw] recovery_point_arn
|
|
10577
|
+
# An Amazon Resource Name (ARN) that uniquely identifies a recovery
|
|
10578
|
+
# point. This is your target recovery point for a full scan. If you
|
|
10579
|
+
# are running an incremental scan, this will be your a recovery point
|
|
10580
|
+
# which has been created after your base recovery point selection.
|
|
10581
|
+
# @return [String]
|
|
10582
|
+
#
|
|
10583
|
+
# @!attribute [rw] scan_base_recovery_point_arn
|
|
10584
|
+
# An ARN that uniquely identifies the base recovery point to be used
|
|
10585
|
+
# for incremental scanning.
|
|
10586
|
+
# @return [String]
|
|
10587
|
+
#
|
|
10588
|
+
# @!attribute [rw] scan_mode
|
|
10589
|
+
# Specifies the scan type use for the scan job.
|
|
10590
|
+
#
|
|
10591
|
+
# Includes:
|
|
10592
|
+
#
|
|
10593
|
+
# * `FULL_SCAN` will scan the entire data lineage within the backup.
|
|
10594
|
+
#
|
|
10595
|
+
# * `INCREMENTAL_SCAN` will scan the data difference between the
|
|
10596
|
+
# target recovery point and base recovery point ARN.
|
|
10597
|
+
# @return [String]
|
|
10598
|
+
#
|
|
10599
|
+
# @!attribute [rw] scanner_role_arn
|
|
10600
|
+
# Specified the IAM scanner role ARN.
|
|
10601
|
+
# @return [String]
|
|
10602
|
+
#
|
|
10603
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/StartScanJobInput AWS API Documentation
|
|
10604
|
+
#
|
|
10605
|
+
class StartScanJobInput < Struct.new(
|
|
10606
|
+
:backup_vault_name,
|
|
10607
|
+
:iam_role_arn,
|
|
10608
|
+
:idempotency_token,
|
|
10609
|
+
:malware_scanner,
|
|
10610
|
+
:recovery_point_arn,
|
|
10611
|
+
:scan_base_recovery_point_arn,
|
|
10612
|
+
:scan_mode,
|
|
10613
|
+
:scanner_role_arn)
|
|
10614
|
+
SENSITIVE = []
|
|
10615
|
+
include Aws::Structure
|
|
10616
|
+
end
|
|
10617
|
+
|
|
10618
|
+
# @!attribute [rw] creation_date
|
|
10619
|
+
# The date and time that a backup job is created, in Unix format and
|
|
10620
|
+
# Coordinated Universal Time (UTC). The value of `CreationDate` is
|
|
10621
|
+
# accurate to milliseconds. For example, the value 1516925490.087
|
|
10622
|
+
# represents Friday, January 26, 2018 12:11:30.087 AM.
|
|
10623
|
+
# @return [Time]
|
|
10624
|
+
#
|
|
10625
|
+
# @!attribute [rw] scan_job_id
|
|
10626
|
+
# Uniquely identifies a request to Backup to back up a resource.
|
|
10627
|
+
# @return [String]
|
|
10628
|
+
#
|
|
10629
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/StartScanJobOutput AWS API Documentation
|
|
10630
|
+
#
|
|
10631
|
+
class StartScanJobOutput < Struct.new(
|
|
10632
|
+
:creation_date,
|
|
10633
|
+
:scan_job_id)
|
|
10634
|
+
SENSITIVE = []
|
|
10635
|
+
include Aws::Structure
|
|
10636
|
+
end
|
|
10637
|
+
|
|
9425
10638
|
# @!attribute [rw] backup_job_id
|
|
9426
10639
|
# Uniquely identifies a request to Backup to back up a resource.
|
|
9427
10640
|
# @return [String]
|
|
@@ -9454,6 +10667,162 @@ module Aws::Backup
|
|
|
9454
10667
|
include Aws::Structure
|
|
9455
10668
|
end
|
|
9456
10669
|
|
|
10670
|
+
# This contains metadata about a tiering configuration.
|
|
10671
|
+
#
|
|
10672
|
+
# @!attribute [rw] tiering_configuration_name
|
|
10673
|
+
# The unique name of the tiering configuration. This cannot be changed
|
|
10674
|
+
# after creation, and it must consist of only alphanumeric characters
|
|
10675
|
+
# and underscores.
|
|
10676
|
+
# @return [String]
|
|
10677
|
+
#
|
|
10678
|
+
# @!attribute [rw] tiering_configuration_arn
|
|
10679
|
+
# An Amazon Resource Name (ARN) that uniquely identifies the tiering
|
|
10680
|
+
# configuration.
|
|
10681
|
+
# @return [String]
|
|
10682
|
+
#
|
|
10683
|
+
# @!attribute [rw] backup_vault_name
|
|
10684
|
+
# The name of the backup vault where the tiering configuration
|
|
10685
|
+
# applies. Use `*` to apply to all backup vaults.
|
|
10686
|
+
# @return [String]
|
|
10687
|
+
#
|
|
10688
|
+
# @!attribute [rw] resource_selection
|
|
10689
|
+
# An array of resource selection objects that specify which resources
|
|
10690
|
+
# are included in the tiering configuration and their tiering
|
|
10691
|
+
# settings.
|
|
10692
|
+
# @return [Array<Types::ResourceSelection>]
|
|
10693
|
+
#
|
|
10694
|
+
# @!attribute [rw] creator_request_id
|
|
10695
|
+
# This is a unique string that identifies the request and allows
|
|
10696
|
+
# failed requests to be retried without the risk of running the
|
|
10697
|
+
# operation twice.
|
|
10698
|
+
# @return [String]
|
|
10699
|
+
#
|
|
10700
|
+
# @!attribute [rw] creation_time
|
|
10701
|
+
# The date and time a tiering configuration was created, in Unix
|
|
10702
|
+
# format and Coordinated Universal Time (UTC). The value of
|
|
10703
|
+
# `CreationTime` is accurate to milliseconds. For example, the value
|
|
10704
|
+
# 1516925490.087 represents Friday, January 26, 2018 12:11:30.087AM.
|
|
10705
|
+
# @return [Time]
|
|
10706
|
+
#
|
|
10707
|
+
# @!attribute [rw] last_updated_time
|
|
10708
|
+
# The date and time a tiering configuration was updated, in Unix
|
|
10709
|
+
# format and Coordinated Universal Time (UTC). The value of
|
|
10710
|
+
# `LastUpdatedTime` is accurate to milliseconds. For example, the
|
|
10711
|
+
# value 1516925490.087 represents Friday, January 26, 2018
|
|
10712
|
+
# 12:11:30.087AM.
|
|
10713
|
+
# @return [Time]
|
|
10714
|
+
#
|
|
10715
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/TieringConfiguration AWS API Documentation
|
|
10716
|
+
#
|
|
10717
|
+
class TieringConfiguration < Struct.new(
|
|
10718
|
+
:tiering_configuration_name,
|
|
10719
|
+
:tiering_configuration_arn,
|
|
10720
|
+
:backup_vault_name,
|
|
10721
|
+
:resource_selection,
|
|
10722
|
+
:creator_request_id,
|
|
10723
|
+
:creation_time,
|
|
10724
|
+
:last_updated_time)
|
|
10725
|
+
SENSITIVE = []
|
|
10726
|
+
include Aws::Structure
|
|
10727
|
+
end
|
|
10728
|
+
|
|
10729
|
+
# This contains metadata about a tiering configuration for create
|
|
10730
|
+
# operations.
|
|
10731
|
+
#
|
|
10732
|
+
# @!attribute [rw] tiering_configuration_name
|
|
10733
|
+
# The unique name of the tiering configuration. This cannot be changed
|
|
10734
|
+
# after creation, and it must consist of only alphanumeric characters
|
|
10735
|
+
# and underscores.
|
|
10736
|
+
# @return [String]
|
|
10737
|
+
#
|
|
10738
|
+
# @!attribute [rw] backup_vault_name
|
|
10739
|
+
# The name of the backup vault where the tiering configuration
|
|
10740
|
+
# applies. Use `*` to apply to all backup vaults.
|
|
10741
|
+
# @return [String]
|
|
10742
|
+
#
|
|
10743
|
+
# @!attribute [rw] resource_selection
|
|
10744
|
+
# An array of resource selection objects that specify which resources
|
|
10745
|
+
# are included in the tiering configuration and their tiering
|
|
10746
|
+
# settings.
|
|
10747
|
+
# @return [Array<Types::ResourceSelection>]
|
|
10748
|
+
#
|
|
10749
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/TieringConfigurationInputForCreate AWS API Documentation
|
|
10750
|
+
#
|
|
10751
|
+
class TieringConfigurationInputForCreate < Struct.new(
|
|
10752
|
+
:tiering_configuration_name,
|
|
10753
|
+
:backup_vault_name,
|
|
10754
|
+
:resource_selection)
|
|
10755
|
+
SENSITIVE = []
|
|
10756
|
+
include Aws::Structure
|
|
10757
|
+
end
|
|
10758
|
+
|
|
10759
|
+
# This contains metadata about a tiering configuration for update
|
|
10760
|
+
# operations.
|
|
10761
|
+
#
|
|
10762
|
+
# @!attribute [rw] resource_selection
|
|
10763
|
+
# An array of resource selection objects that specify which resources
|
|
10764
|
+
# are included in the tiering configuration and their tiering
|
|
10765
|
+
# settings.
|
|
10766
|
+
# @return [Array<Types::ResourceSelection>]
|
|
10767
|
+
#
|
|
10768
|
+
# @!attribute [rw] backup_vault_name
|
|
10769
|
+
# The name of the backup vault where the tiering configuration
|
|
10770
|
+
# applies. Use `*` to apply to all backup vaults.
|
|
10771
|
+
# @return [String]
|
|
10772
|
+
#
|
|
10773
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/TieringConfigurationInputForUpdate AWS API Documentation
|
|
10774
|
+
#
|
|
10775
|
+
class TieringConfigurationInputForUpdate < Struct.new(
|
|
10776
|
+
:resource_selection,
|
|
10777
|
+
:backup_vault_name)
|
|
10778
|
+
SENSITIVE = []
|
|
10779
|
+
include Aws::Structure
|
|
10780
|
+
end
|
|
10781
|
+
|
|
10782
|
+
# This contains metadata about a tiering configuration returned in a
|
|
10783
|
+
# list.
|
|
10784
|
+
#
|
|
10785
|
+
# @!attribute [rw] tiering_configuration_arn
|
|
10786
|
+
# An Amazon Resource Name (ARN) that uniquely identifies the tiering
|
|
10787
|
+
# configuration.
|
|
10788
|
+
# @return [String]
|
|
10789
|
+
#
|
|
10790
|
+
# @!attribute [rw] tiering_configuration_name
|
|
10791
|
+
# The unique name of the tiering configuration.
|
|
10792
|
+
# @return [String]
|
|
10793
|
+
#
|
|
10794
|
+
# @!attribute [rw] backup_vault_name
|
|
10795
|
+
# The name of the backup vault where the tiering configuration
|
|
10796
|
+
# applies. Use `*` to apply to all backup vaults.
|
|
10797
|
+
# @return [String]
|
|
10798
|
+
#
|
|
10799
|
+
# @!attribute [rw] creation_time
|
|
10800
|
+
# The date and time a tiering configuration was created, in Unix
|
|
10801
|
+
# format and Coordinated Universal Time (UTC). The value of
|
|
10802
|
+
# `CreationTime` is accurate to milliseconds. For example, the value
|
|
10803
|
+
# 1516925490.087 represents Friday, January 26, 2018 12:11:30.087AM.
|
|
10804
|
+
# @return [Time]
|
|
10805
|
+
#
|
|
10806
|
+
# @!attribute [rw] last_updated_time
|
|
10807
|
+
# The date and time a tiering configuration was updated, in Unix
|
|
10808
|
+
# format and Coordinated Universal Time (UTC). The value of
|
|
10809
|
+
# `LastUpdatedTime` is accurate to milliseconds. For example, the
|
|
10810
|
+
# value 1516925490.087 represents Friday, January 26, 2018
|
|
10811
|
+
# 12:11:30.087AM.
|
|
10812
|
+
# @return [Time]
|
|
10813
|
+
#
|
|
10814
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/TieringConfigurationsListMember AWS API Documentation
|
|
10815
|
+
#
|
|
10816
|
+
class TieringConfigurationsListMember < Struct.new(
|
|
10817
|
+
:tiering_configuration_arn,
|
|
10818
|
+
:tiering_configuration_name,
|
|
10819
|
+
:backup_vault_name,
|
|
10820
|
+
:creation_time,
|
|
10821
|
+
:last_updated_time)
|
|
10822
|
+
SENSITIVE = []
|
|
10823
|
+
include Aws::Structure
|
|
10824
|
+
end
|
|
10825
|
+
|
|
9457
10826
|
# @!attribute [rw] resource_arn
|
|
9458
10827
|
# An ARN that uniquely identifies a resource. The format of the ARN
|
|
9459
10828
|
# depends on the type of the tagged resource.
|
|
@@ -9522,6 +10891,12 @@ module Aws::Backup
|
|
|
9522
10891
|
# Contains a list of `BackupOptions` for each resource type.
|
|
9523
10892
|
# @return [Array<Types::AdvancedBackupSetting>]
|
|
9524
10893
|
#
|
|
10894
|
+
# @!attribute [rw] scan_settings
|
|
10895
|
+
# Contains your scanning configuration for the backup plan and
|
|
10896
|
+
# includes the Malware scanner, your selected resources, and scanner
|
|
10897
|
+
# role.
|
|
10898
|
+
# @return [Array<Types::ScanSetting>]
|
|
10899
|
+
#
|
|
9525
10900
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/UpdateBackupPlanOutput AWS API Documentation
|
|
9526
10901
|
#
|
|
9527
10902
|
class UpdateBackupPlanOutput < Struct.new(
|
|
@@ -9529,7 +10904,8 @@ module Aws::Backup
|
|
|
9529
10904
|
:backup_plan_arn,
|
|
9530
10905
|
:creation_date,
|
|
9531
10906
|
:version_id,
|
|
9532
|
-
:advanced_backup_settings
|
|
10907
|
+
:advanced_backup_settings,
|
|
10908
|
+
:scan_settings)
|
|
9533
10909
|
SENSITIVE = []
|
|
9534
10910
|
include Aws::Structure
|
|
9535
10911
|
end
|
|
@@ -9609,6 +10985,11 @@ module Aws::Backup
|
|
|
9609
10985
|
# A value for Multi-party approval, styled as "Mpa": `isMpaEnabled`.
|
|
9610
10986
|
# Values can be true or false. Example: `update-global-settings
|
|
9611
10987
|
# --global-settings isMpaEnabled=false --region us-west-2`.
|
|
10988
|
+
#
|
|
10989
|
+
# A value for Backup Service-Linked Role creation, styled
|
|
10990
|
+
# as`isDelegatedAdministratorEnabled`. Values can be true or false.
|
|
10991
|
+
# Example: `update-global-settings --global-settings
|
|
10992
|
+
# isDelegatedAdministratorEnabled=false --region us-west-2`.
|
|
9612
10993
|
# @return [Hash<String,String>]
|
|
9613
10994
|
#
|
|
9614
10995
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/UpdateGlobalSettingsInput AWS API Documentation
|
|
@@ -10001,6 +11382,58 @@ module Aws::Backup
|
|
|
10001
11382
|
include Aws::Structure
|
|
10002
11383
|
end
|
|
10003
11384
|
|
|
11385
|
+
# @!attribute [rw] tiering_configuration_name
|
|
11386
|
+
# The name of a tiering configuration to update.
|
|
11387
|
+
# @return [String]
|
|
11388
|
+
#
|
|
11389
|
+
# @!attribute [rw] tiering_configuration
|
|
11390
|
+
# Specifies the body of a tiering configuration.
|
|
11391
|
+
# @return [Types::TieringConfigurationInputForUpdate]
|
|
11392
|
+
#
|
|
11393
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/UpdateTieringConfigurationInput AWS API Documentation
|
|
11394
|
+
#
|
|
11395
|
+
class UpdateTieringConfigurationInput < Struct.new(
|
|
11396
|
+
:tiering_configuration_name,
|
|
11397
|
+
:tiering_configuration)
|
|
11398
|
+
SENSITIVE = []
|
|
11399
|
+
include Aws::Structure
|
|
11400
|
+
end
|
|
11401
|
+
|
|
11402
|
+
# @!attribute [rw] tiering_configuration_arn
|
|
11403
|
+
# An Amazon Resource Name (ARN) that uniquely identifies the updated
|
|
11404
|
+
# tiering configuration.
|
|
11405
|
+
# @return [String]
|
|
11406
|
+
#
|
|
11407
|
+
# @!attribute [rw] tiering_configuration_name
|
|
11408
|
+
# This unique string is the name of the tiering configuration.
|
|
11409
|
+
# @return [String]
|
|
11410
|
+
#
|
|
11411
|
+
# @!attribute [rw] creation_time
|
|
11412
|
+
# The date and time a tiering configuration was created, in Unix
|
|
11413
|
+
# format and Coordinated Universal Time (UTC). The value of
|
|
11414
|
+
# `CreationTime` is accurate to milliseconds. For example, the value
|
|
11415
|
+
# 1516925490.087 represents Friday, January 26, 2018 12:11:30.087AM.
|
|
11416
|
+
# @return [Time]
|
|
11417
|
+
#
|
|
11418
|
+
# @!attribute [rw] last_updated_time
|
|
11419
|
+
# The date and time a tiering configuration was updated, in Unix
|
|
11420
|
+
# format and Coordinated Universal Time (UTC). The value of
|
|
11421
|
+
# `LastUpdatedTime` is accurate to milliseconds. For example, the
|
|
11422
|
+
# value 1516925490.087 represents Friday, January 26, 2018
|
|
11423
|
+
# 12:11:30.087AM.
|
|
11424
|
+
# @return [Time]
|
|
11425
|
+
#
|
|
11426
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/UpdateTieringConfigurationOutput AWS API Documentation
|
|
11427
|
+
#
|
|
11428
|
+
class UpdateTieringConfigurationOutput < Struct.new(
|
|
11429
|
+
:tiering_configuration_arn,
|
|
11430
|
+
:tiering_configuration_name,
|
|
11431
|
+
:creation_time,
|
|
11432
|
+
:last_updated_time)
|
|
11433
|
+
SENSITIVE = []
|
|
11434
|
+
include Aws::Structure
|
|
11435
|
+
end
|
|
11436
|
+
|
|
10004
11437
|
end
|
|
10005
11438
|
end
|
|
10006
11439
|
|