You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::FSx::Types::CreateBackupRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb

Overview

Note:

When making an API call, you may pass CreateBackupRequest data as a hash:

{
  file_system_id: "FileSystemId", # required
  client_request_token: "ClientRequestToken",
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
}

The request object for the CreateBackup operation.

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_tokenString

(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 AWS Command Line Interface (AWS CLI) or an AWS SDK.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


231
232
233
234
235
236
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 231

class CreateBackupRequest < Struct.new(
  :file_system_id,
  :client_request_token,
  :tags)
  include Aws::Structure
end

#file_system_idString

The ID of the file system to back up.

Returns:

  • (String)


231
232
233
234
235
236
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 231

class CreateBackupRequest < Struct.new(
  :file_system_id,
  :client_request_token,
  :tags)
  include Aws::Structure
end

#tagsArray<Types::Tag>

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.

Returns:



231
232
233
234
235
236
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 231

class CreateBackupRequest < Struct.new(
  :file_system_id,
  :client_request_token,
  :tags)
  include Aws::Structure
end