aws-sdk-backup 1.25.0 → 1.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39704815da4eb2102775ce38fe491663510a35309b5c0e099a71060fa6ea3fb2
-  data.tar.gz: c623eac9a57f64cf5fbc7257a14f3b45abee0ec776b084c0e56dc9eb9fcf5a80
+  metadata.gz: 5a2da2d0b24a6598093a2ce086bb3e7bc3a01f86f7378ce5960740b4777491c9
+  data.tar.gz: 0e6cef251009ca80a97a7c192447f54a25ca8533659a111725aab903bba47b26
 SHA512:
-  metadata.gz: 20c9f0e9a57d4feeb1fe57dc32cbbe4c92d928f6d55f40d7a824b300043905dbd44c2050dd564f59c3e70e2331fb429bb0962ce2d5489bfbe6a572df76e8203f
-  data.tar.gz: 9453623baf49ff92db67eee606087707e89ebdd7a25425acb2cfb471976b12bf62b1a4997bd7561d42a093f819aeb9c0a5b1915c07be823c77c9af96dbacc4cb
+  metadata.gz: 9cef63b5084ce21e60247a0c8ccde705a4c2c8c9500ca34314e56dc22eada36470aed50c371cbb02e9036bc7256fef8a734a7937aabac012db19af3d0058cd8a
+  data.tar.gz: 6e303867550d1efd2a3053fb012c080232aa3a77ae4d66a3bb79a8d904b59e2fc88b054311205142f283401c0b42359d8b11beba063b87340f438bc9262b76ee

data/lib/aws-sdk-backup.rb

@@ -48,6 +48,6 @@ require_relative 'aws-sdk-backup/customizations'
 # @!group service
 module Aws::Backup
 
-  GEM_VERSION = '1.25.0'
+  GEM_VERSION = '1.26.0'
 
 end

data/lib/aws-sdk-backup/client.rb

@@ -518,7 +518,7 @@ module Aws::Backup
     #   The name of a logical container where backups are stored. Backup
     #   vaults are identified by names that are unique to the account used to
     #   create them and the AWS Region where they are created. They consist of
-    #   lowercase letters, numbers, and hyphens.
+    #   letters, numbers, and hyphens.
     #
     # @option params [Hash<String,String>] :backup_vault_tags
     #   Metadata that you can assign to help organize the resources that you
@@ -894,7 +894,8 @@ module Aws::Backup
       req.send_request(options)
     end
 
-    # The current feature settings for the AWS Account.
+    # Describes the global settings of the AWS account, including whether it
+    # is opted in to cross-account backup.
     #
     # @return [Types::DescribeGlobalSettingsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -1532,12 +1533,17 @@ module Aws::Backup
     #
     #   * `RDS` for Amazon Relational Database Service
     #
+    #   * `Aurora` for Amazon Aurora
+    #
     #   * `Storage Gateway` for AWS Storage Gateway
     #
     # @option params [String] :by_account_id
     #   The account ID to list the jobs from. Returns only backup jobs
     #   associated with the specified account ID.
     #
+    #   If used from an AWS Organizations management account, passing `*`
+    #   returns all jobs across the organization.
+    #
     # @return [Types::ListBackupJobsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::ListBackupJobsOutput#backup_jobs #backup_jobs} => Array&lt;Types::BackupJob&gt;
@@ -1889,6 +1895,8 @@ module Aws::Backup
     #
     #   * `RDS` for Amazon Relational Database Service
     #
+    #   * `Aurora` for Amazon Aurora
+    #
     #   * `Storage Gateway` for AWS Storage Gateway
     #
     # @option params [String] :by_destination_vault_arn
@@ -2351,12 +2359,15 @@ module Aws::Backup
     #
     # @option params [Integer] :start_window_minutes
     #   A value in minutes after a backup is scheduled before a job will be
-    #   canceled if it doesn't start successfully. This value is optional.
+    #   canceled if it doesn't start successfully. This value is optional,
+    #   and the default is 8 hours.
     #
     # @option params [Integer] :complete_window_minutes
-    #   A value in minutes after a backup job is successfully started before
-    #   it must be completed or it will be canceled by AWS Backup. This value
-    #   is optional.
+    #   A value in minutes during which a successfully started backup must
+    #   complete, or else AWS Backup will cancel the job. This value is
+    #   optional. This value begins counting down from when the backup was
+    #   scheduled. It does not add additional time for `StartWindowMinutes`,
+    #   or if the backup started later than scheduled.
     #
     # @option params [Types::Lifecycle] :lifecycle
     #   The lifecycle defines when a protected resource is transitioned to
@@ -2370,6 +2381,9 @@ module Aws::Backup
     #   setting. The “transition to cold after days” setting cannot be changed
     #   after a backup has been transitioned to cold.
     #
+    #   Only Amazon EFS file system backups can be transitioned to cold
+    #   storage.
+    #
     # @option params [Hash<String,String>] :recovery_point_tags
     #   To help organize your resources, you can assign your own metadata to
     #   the resources that you create. Each tag is a key-value pair.
@@ -2461,6 +2475,9 @@ module Aws::Backup
     #   after days” setting. The “transition to cold after days” setting
     #   cannot be changed after a backup has been transitioned to cold.
     #
+    #   Only Amazon EFS file system backups can be transitioned to cold
+    #   storage.
+    #
     # @return [Types::StartCopyJobOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::StartCopyJobOutput#copy_job_id #copy_job_id} => String
@@ -2537,10 +2554,11 @@ module Aws::Backup
     #   * `newFileSystem`\: A Boolean value that, if true, specifies that the
     #     recovery point is restored to a new Amazon EFS file system.
     #
-    #   * `ItemsToRestore `\: A serialized list of up to five strings where
-    #     each string is a file path. Use `ItemsToRestore` to restore specific
+    #   * `ItemsToRestore `\: An array of one to five strings where each
+    #     string is a file path. Use `ItemsToRestore` to restore specific
     #     files or directories rather than the entire file system. This
-    #     parameter is optional.
+    #     parameter is optional. For example,
+    #     `"itemsToRestore":"["/my.test"]"`.
     #
     # @option params [required, String] :iam_role_arn
     #   The Amazon Resource Name (ARN) of the IAM role that AWS Backup uses to
@@ -2565,6 +2583,8 @@ module Aws::Backup
     #
     #   * `RDS` for Amazon Relational Database Service
     #
+    #   * `Aurora` for Amazon Aurora
+    #
     #   * `Storage Gateway` for AWS Storage Gateway
     #
     # @return [Types::StartRestoreJobOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -2759,7 +2779,7 @@ module Aws::Backup
       req.send_request(options)
     end
 
-    # Updates the current global settings for the AWS Account. Use the
+    # Updates the current global settings for the AWS account. Use the
     # `DescribeGlobalSettings` API to determine the current settings.
     #
     # @option params [Hash<String,String>] :global_settings
@@ -2796,6 +2816,9 @@ module Aws::Backup
     # setting. The “transition to cold after days” setting cannot be changed
     # after a backup has been transitioned to cold.
     #
+    # Only Amazon EFS file system backups can be transitioned to cold
+    # storage.
+    #
     # @option params [required, String] :backup_vault_name
     #   The name of a logical container where backups are stored. Backup
     #   vaults are identified by names that are unique to the account used to
@@ -2898,7 +2921,7 @@ module Aws::Backup
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-backup'
-      context[:gem_version] = '1.25.0'
+      context[:gem_version] = '1.26.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-backup/types.rb

@@ -23,10 +23,16 @@ module Aws::Backup
     #       }
     #
     # @!attribute [rw] resource_type
-    #   The type of AWS resource to be backed up. For VSS Windows backups,
-    #   the only supported resource type is Amazon EC2.
+    #   Specifies an object containing resource type and backup options. The
+    #   only supported resource type is Amazon EC2 instances with Windows
+    #   VSS. For an CloudFormation example, see the [sample CloudFormation
+    #   template to enable Windows VSS][1] in the *AWS Backup User Guide*.
     #
     #   Valid values: `EC2`.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/integrate-cloudformation-with-aws-backup.html
     #   @return [String]
     #
     # @!attribute [rw] backup_options
@@ -160,8 +166,11 @@ module Aws::Backup
     #   @return [Integer]
     #
     # @!attribute [rw] iam_role_arn
-    #   Specifies the IAM role ARN used to create the target recovery point;
-    #   for example, `arn:aws:iam::123456789012:role/S3Access`.
+    #   Specifies the IAM role ARN used to create the target recovery point.
+    #   IAM roles other than the default role must include either
+    #   `AWSBackup` or `AwsBackup` in the role name. For example,
+    #   `arn:aws:iam::123456789012:role/AWSBackupRDSAccess`. Role names
+    #   without those strings lack permissions to perform backup jobs.
     #   @return [String]
     #
     # @!attribute [rw] created_by
@@ -475,6 +484,9 @@ module Aws::Backup
     #   must be 90 days greater than the “transition to cold after days”
     #   setting. The “transition to cold after days” setting cannot be
     #   changed after a backup has been transitioned to cold.
+    #
+    #   Only Amazon EFS file system backups can be transitioned to cold
+    #   storage.
     #   @return [Types::Lifecycle]
     #
     # @!attribute [rw] recovery_point_tags
@@ -574,6 +586,9 @@ module Aws::Backup
     #   must be 90 days greater than the “transition to cold after days”
     #   setting. The “transition to cold after days” setting cannot be
     #   changed after a backup has been transitioned to cold.
+    #
+    #   Only Amazon EFS file system backups can be transitioned to cold
+    #   storage.
     #   @return [Types::Lifecycle]
     #
     # @!attribute [rw] recovery_point_tags
@@ -637,7 +652,8 @@ module Aws::Backup
     # @!attribute [rw] list_of_tags
     #   An array of conditions used to specify a set of resources to assign
     #   to a backup plan; for example, `"StringEquals":
-    #   \{"ec2:ResourceTag/Department": "accounting"`.
+    #   \{"ec2:ResourceTag/Department": "accounting"`. Assigns the backup
+    #   plan to every resource with at least one matching tag.
     #   @return [Array<Types::Condition>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/BackupSelection AWS API Documentation
@@ -762,6 +778,9 @@ module Aws::Backup
     # setting. The “transition to cold after days” setting cannot be changed
     # after a backup has been transitioned to cold.
     #
+    # Only Amazon EFS file system backups can be transitioned to cold
+    # storage.
+    #
     # @!attribute [rw] move_to_cold_storage_at
     #   A timestamp that specifies when to transition a recovery point to
     #   cold storage.
@@ -844,6 +863,9 @@ module Aws::Backup
     #   cold after days” setting. The “transition to cold after days”
     #   setting cannot be changed after a backup has been transitioned to
     #   cold.
+    #
+    #   Only Amazon EFS file system backups can be transitioned to cold
+    #   storage.
     #   @return [Types::Lifecycle]
     #
     # @!attribute [rw] destination_backup_vault_arn
@@ -1167,7 +1189,7 @@ module Aws::Backup
     #   The name of a logical container where backups are stored. Backup
     #   vaults are identified by names that are unique to the account used
     #   to create them and the AWS Region where they are created. They
-    #   consist of lowercase letters, numbers, and hyphens.
+    #   consist of letters, numbers, and hyphens.
     #   @return [String]
     #
     # @!attribute [rw] backup_vault_tags
@@ -1704,7 +1726,7 @@ module Aws::Backup
     #   @return [Hash<String,String>]
     #
     # @!attribute [rw] last_update_time
-    #   The date and time that the global settings was last updated. This
+    #   The date and time that the global settings were last updated. This
     #   update is in Unix format and Coordinated Universal Time (UTC). The
     #   value of `LastUpdateTime` is accurate to milliseconds. For example,
     #   the value 1516925490.087 represents Friday, January 26, 2018
@@ -1888,6 +1910,9 @@ module Aws::Backup
     #   setting must be 90 days greater than the “transition to cold after
     #   days” setting. The “transition to cold after days” setting cannot be
     #   changed after a backup has been transitioned to cold.
+    #
+    #   Only Amazon EFS file system backups can be transitioned to cold
+    #   storage.
     #   @return [Types::Lifecycle]
     #
     # @!attribute [rw] encryption_key_arn
@@ -2500,6 +2525,8 @@ module Aws::Backup
     #
     #   * `RDS` for Amazon Relational Database Service
     #
+    #   * `Aurora` for Amazon Aurora
+    #
     #   * `Storage Gateway` for AWS Storage Gateway
     #   @return [Array<String>]
     #
@@ -2572,6 +2599,9 @@ module Aws::Backup
     # after days” setting. The “transition to cold after days” setting
     # cannot be changed after a backup has been transitioned to cold.
     #
+    # Only Amazon EFS file system backups can be transitioned to cold
+    # storage.
+    #
     # @note When making an API call, you may pass Lifecycle
     #   data as a hash:
     #
@@ -2690,12 +2720,17 @@ module Aws::Backup
     #
     #   * `RDS` for Amazon Relational Database Service
     #
+    #   * `Aurora` for Amazon Aurora
+    #
     #   * `Storage Gateway` for AWS Storage Gateway
     #   @return [String]
     #
     # @!attribute [rw] by_account_id
     #   The account ID to list the jobs from. Returns only backup jobs
     #   associated with the specified account ID.
+    #
+    #   If used from an AWS Organizations management account, passing `*`
+    #   returns all jobs across the organization.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListBackupJobsInput AWS API Documentation
@@ -3057,6 +3092,8 @@ module Aws::Backup
     #
     #   * `RDS` for Amazon Relational Database Service
     #
+    #   * `Aurora` for Amazon Aurora
+    #
     #   * `Storage Gateway` for AWS Storage Gateway
     #   @return [String]
     #
@@ -3648,6 +3685,9 @@ module Aws::Backup
     #   must be 90 days greater than the “transition to cold after days”
     #   setting. The “transition to cold after days” setting cannot be
     #   changed after a backup has been transitioned to cold.
+    #
+    #   Only Amazon EFS file system backups can be transitioned to cold
+    #   storage.
     #   @return [Types::Lifecycle]
     #
     # @!attribute [rw] encryption_key_arn
@@ -3962,13 +4002,16 @@ module Aws::Backup
     #
     # @!attribute [rw] start_window_minutes
     #   A value in minutes after a backup is scheduled before a job will be
-    #   canceled if it doesn't start successfully. This value is optional.
+    #   canceled if it doesn't start successfully. This value is optional,
+    #   and the default is 8 hours.
     #   @return [Integer]
     #
     # @!attribute [rw] complete_window_minutes
-    #   A value in minutes after a backup job is successfully started before
-    #   it must be completed or it will be canceled by AWS Backup. This
-    #   value is optional.
+    #   A value in minutes during which a successfully started backup must
+    #   complete, or else AWS Backup will cancel the job. This value is
+    #   optional. This value begins counting down from when the backup was
+    #   scheduled. It does not add additional time for `StartWindowMinutes`,
+    #   or if the backup started later than scheduled.
     #   @return [Integer]
     #
     # @!attribute [rw] lifecycle
@@ -3982,6 +4025,9 @@ module Aws::Backup
     #   must be 90 days greater than the “transition to cold after days”
     #   setting. The “transition to cold after days” setting cannot be
     #   changed after a backup has been transitioned to cold.
+    #
+    #   Only Amazon EFS file system backups can be transitioned to cold
+    #   storage.
     #   @return [Types::Lifecycle]
     #
     # @!attribute [rw] recovery_point_tags
@@ -4025,7 +4071,7 @@ module Aws::Backup
     #   @return [String]
     #
     # @!attribute [rw] creation_date
-    #   The date and time that a backup job is started, in Unix format and
+    #   The date and time that a backup job is created, in Unix format and
     #   Coordinated Universal Time (UTC). The value of `CreationDate` is
     #   accurate to milliseconds. For example, the value 1516925490.087
     #   represents Friday, January 26, 2018 12:11:30.087 AM.
@@ -4096,6 +4142,9 @@ module Aws::Backup
     #   cold after days” setting. The “transition to cold after days”
     #   setting cannot be changed after a backup has been transitioned to
     #   cold.
+    #
+    #   Only Amazon EFS file system backups can be transitioned to cold
+    #   storage.
     #   @return [Types::Lifecycle]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/StartCopyJobInput AWS API Documentation
@@ -4116,7 +4165,7 @@ module Aws::Backup
     #   @return [String]
     #
     # @!attribute [rw] creation_date
-    #   The date and time that a copy job is started, in Unix format and
+    #   The date and time that a copy job is created, in Unix format and
     #   Coordinated Universal Time (UTC). The value of `CreationDate` is
     #   accurate to milliseconds. For example, the value 1516925490.087
     #   represents Friday, January 26, 2018 12:11:30.087 AM.
@@ -4185,10 +4234,11 @@ module Aws::Backup
     #   * `newFileSystem`\: A Boolean value that, if true, specifies that
     #     the recovery point is restored to a new Amazon EFS file system.
     #
-    #   * `ItemsToRestore `\: A serialized list of up to five strings where
-    #     each string is a file path. Use `ItemsToRestore` to restore
-    #     specific files or directories rather than the entire file system.
-    #     This parameter is optional.
+    #   * `ItemsToRestore `\: An array of one to five strings where each
+    #     string is a file path. Use `ItemsToRestore` to restore specific
+    #     files or directories rather than the entire file system. This
+    #     parameter is optional. For example,
+    #     `"itemsToRestore":"["/my.test"]"`.
     #   @return [Hash<String,String>]
     #
     # @!attribute [rw] iam_role_arn
@@ -4216,6 +4266,8 @@ module Aws::Backup
     #
     #   * `RDS` for Amazon Relational Database Service
     #
+    #   * `Aurora` for Amazon Aurora
+    #
     #   * `Storage Gateway` for AWS Storage Gateway
     #   @return [String]
     #
@@ -4507,6 +4559,9 @@ module Aws::Backup
     #   must be 90 days greater than the “transition to cold after days”
     #   setting. The “transition to cold after days” setting cannot be
     #   changed after a backup has been transitioned to cold.
+    #
+    #   Only Amazon EFS file system backups can be transitioned to cold
+    #   storage.
     #   @return [Types::Lifecycle]
     #
     # @!attribute [rw] calculated_lifecycle

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-backup
 version: !ruby/object:Gem::Version
-  version: 1.25.0
+  version: 1.26.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-18 00:00:00.000000000 Z
+date: 2021-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core