Class: Aws::FSx::Types::CreateBackupRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::FSx::Types::CreateBackupRequest
- Defined in:
- gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb
Overview
When making an API call, you may pass CreateBackupRequest data as a hash:
{
file_system_id: "FileSystemId",
client_request_token: "ClientRequestToken",
tags: [
{
key: "TagKey", # required
value: "TagValue", # required
},
],
volume_id: "VolumeId",
}
The request object for the CreateBackup
operation.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#client_request_token ⇒ String
(Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation.
-
#file_system_id ⇒ String
The ID of the file system to back up.
-
#tags ⇒ Array<Types::Tag>
(Optional) The tags to apply to the backup at backup creation.
-
#volume_id ⇒ String
(Optional) The ID of the FSx for ONTAP volume to back up.
Instance Attribute Details
#client_request_token ⇒ String
(Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
A suitable default value is auto-generated. You should normally not need to pass this option.
911 912 913 914 915 916 917 918 |
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 911 class CreateBackupRequest < Struct.new( :file_system_id, :client_request_token, :tags, :volume_id) SENSITIVE = [] include Aws::Structure end |
#file_system_id ⇒ String
The ID of the file system to back up.
911 912 913 914 915 916 917 918 |
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 911 class CreateBackupRequest < Struct.new( :file_system_id, :client_request_token, :tags, :volume_id) SENSITIVE = [] include Aws::Structure end |
#tags ⇒ Array<Types::Tag>
(Optional) The tags to apply to the backup at backup creation. The
key value of the Name
tag appears in the console as the backup
name. If you have set CopyTagsToBackups
to true
, and you specify
one or more tags using the CreateBackup
operation, no existing
file system tags are copied from the file system to the backup.
911 912 913 914 915 916 917 918 |
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 911 class CreateBackupRequest < Struct.new( :file_system_id, :client_request_token, :tags, :volume_id) SENSITIVE = [] include Aws::Structure end |
#volume_id ⇒ String
(Optional) The ID of the FSx for ONTAP volume to back up.
911 912 913 914 915 916 917 918 |
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 911 class CreateBackupRequest < Struct.new( :file_system_id, :client_request_token, :tags, :volume_id) SENSITIVE = [] include Aws::Structure end |