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

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

Overview

The request object for the ‘CreateBackup` operation.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_token ⇒ String

(Optional) A string of up to 63 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.

Returns:

  • (String) 


917
918
919
920
921
922
923
924
 
# File 'lib/aws-sdk-fsx/types.rb', line 917

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.

Returns:

  • (String) 


917
918
919
920
921
922
923
924
 
# File 'lib/aws-sdk-fsx/types.rb', line 917

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.

Returns:



917
918
919
920
921
922
923
924
 
# File 'lib/aws-sdk-fsx/types.rb', line 917

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.

Returns:

  • (String) 


917
918
919
920
921
922
923
924
 
# File 'lib/aws-sdk-fsx/types.rb', line 917

class CreateBackupRequest < Struct.new(
  :file_system_id,
  :client_request_token,
  :tags,
  :volume_id)
  SENSITIVE = []
  include Aws::Structure
end