AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::StorageGateway::Types::Tape

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

Overview

Describes a virtual tape object.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#kms_keyString

The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true. Optional.

Returns:

  • (String)


6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 6883

class Tape < Struct.new(
  :tape_arn,
  :tape_barcode,
  :tape_created_date,
  :tape_size_in_bytes,
  :tape_status,
  :vtl_device,
  :progress,
  :tape_used_in_bytes,
  :kms_key,
  :pool_id,
  :worm,
  :retention_start_date,
  :pool_entry_date)
  SENSITIVE = []
  include Aws::Structure
end

#pool_entry_dateTime

The date that the tape enters a custom tape pool.

Returns:

  • (Time)


6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 6883

class Tape < Struct.new(
  :tape_arn,
  :tape_barcode,
  :tape_created_date,
  :tape_size_in_bytes,
  :tape_status,
  :vtl_device,
  :progress,
  :tape_used_in_bytes,
  :kms_key,
  :pool_id,
  :worm,
  :retention_start_date,
  :pool_entry_date)
  SENSITIVE = []
  include Aws::Structure
end

#pool_idString

The ID of the pool that contains tapes that will be archived. The tapes in this pool are archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

Valid Values: GLACIER | DEEP_ARCHIVE

Returns:

  • (String)


6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 6883

class Tape < Struct.new(
  :tape_arn,
  :tape_barcode,
  :tape_created_date,
  :tape_size_in_bytes,
  :tape_status,
  :vtl_device,
  :progress,
  :tape_used_in_bytes,
  :kms_key,
  :pool_id,
  :worm,
  :retention_start_date,
  :pool_entry_date)
  SENSITIVE = []
  include Aws::Structure
end

#progressFloat

For archiving virtual tapes, indicates how much data remains to be uploaded before archiving is complete.

Range: 0 (not started) to 100 (complete).

Returns:

  • (Float)


6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 6883

class Tape < Struct.new(
  :tape_arn,
  :tape_barcode,
  :tape_created_date,
  :tape_size_in_bytes,
  :tape_status,
  :vtl_device,
  :progress,
  :tape_used_in_bytes,
  :kms_key,
  :pool_id,
  :worm,
  :retention_start_date,
  :pool_entry_date)
  SENSITIVE = []
  include Aws::Structure
end

#retention_start_dateTime

The date that the tape is first archived with tape retention lock enabled.

Returns:

  • (Time)


6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 6883

class Tape < Struct.new(
  :tape_arn,
  :tape_barcode,
  :tape_created_date,
  :tape_size_in_bytes,
  :tape_status,
  :vtl_device,
  :progress,
  :tape_used_in_bytes,
  :kms_key,
  :pool_id,
  :worm,
  :retention_start_date,
  :pool_entry_date)
  SENSITIVE = []
  include Aws::Structure
end

#tape_arnString

The Amazon Resource Name (ARN) of the virtual tape.

Returns:

  • (String)


6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 6883

class Tape < Struct.new(
  :tape_arn,
  :tape_barcode,
  :tape_created_date,
  :tape_size_in_bytes,
  :tape_status,
  :vtl_device,
  :progress,
  :tape_used_in_bytes,
  :kms_key,
  :pool_id,
  :worm,
  :retention_start_date,
  :pool_entry_date)
  SENSITIVE = []
  include Aws::Structure
end

#tape_barcodeString

The barcode that identifies a specific virtual tape.

Returns:

  • (String)


6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 6883

class Tape < Struct.new(
  :tape_arn,
  :tape_barcode,
  :tape_created_date,
  :tape_size_in_bytes,
  :tape_status,
  :vtl_device,
  :progress,
  :tape_used_in_bytes,
  :kms_key,
  :pool_id,
  :worm,
  :retention_start_date,
  :pool_entry_date)
  SENSITIVE = []
  include Aws::Structure
end

#tape_created_dateTime

The date the virtual tape was created.

Returns:

  • (Time)


6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 6883

class Tape < Struct.new(
  :tape_arn,
  :tape_barcode,
  :tape_created_date,
  :tape_size_in_bytes,
  :tape_status,
  :vtl_device,
  :progress,
  :tape_used_in_bytes,
  :kms_key,
  :pool_id,
  :worm,
  :retention_start_date,
  :pool_entry_date)
  SENSITIVE = []
  include Aws::Structure
end

#tape_size_in_bytesInteger

The size, in bytes, of the virtual tape capacity.

Returns:

  • (Integer)


6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 6883

class Tape < Struct.new(
  :tape_arn,
  :tape_barcode,
  :tape_created_date,
  :tape_size_in_bytes,
  :tape_status,
  :vtl_device,
  :progress,
  :tape_used_in_bytes,
  :kms_key,
  :pool_id,
  :worm,
  :retention_start_date,
  :pool_entry_date)
  SENSITIVE = []
  include Aws::Structure
end

#tape_statusString

The current state of the virtual tape.

Returns:

  • (String)


6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 6883

class Tape < Struct.new(
  :tape_arn,
  :tape_barcode,
  :tape_created_date,
  :tape_size_in_bytes,
  :tape_status,
  :vtl_device,
  :progress,
  :tape_used_in_bytes,
  :kms_key,
  :pool_id,
  :worm,
  :retention_start_date,
  :pool_entry_date)
  SENSITIVE = []
  include Aws::Structure
end

#tape_used_in_bytesInteger

The size, in bytes, of data stored on the virtual tape.

This value is not available for tapes created prior to May 13, 2015.

Returns:

  • (Integer)


6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 6883

class Tape < Struct.new(
  :tape_arn,
  :tape_barcode,
  :tape_created_date,
  :tape_size_in_bytes,
  :tape_status,
  :vtl_device,
  :progress,
  :tape_used_in_bytes,
  :kms_key,
  :pool_id,
  :worm,
  :retention_start_date,
  :pool_entry_date)
  SENSITIVE = []
  include Aws::Structure
end

#vtl_deviceString

The virtual tape library (VTL) device that the virtual tape is associated with.

Returns:

  • (String)


6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 6883

class Tape < Struct.new(
  :tape_arn,
  :tape_barcode,
  :tape_created_date,
  :tape_size_in_bytes,
  :tape_status,
  :vtl_device,
  :progress,
  :tape_used_in_bytes,
  :kms_key,
  :pool_id,
  :worm,
  :retention_start_date,
  :pool_entry_date)
  SENSITIVE = []
  include Aws::Structure
end

#wormBoolean

If the tape is archived as write-once-read-many (WORM), this value is true.

Returns:

  • (Boolean)


6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 6883

class Tape < Struct.new(
  :tape_arn,
  :tape_barcode,
  :tape_created_date,
  :tape_size_in_bytes,
  :tape_status,
  :vtl_device,
  :progress,
  :tape_used_in_bytes,
  :kms_key,
  :pool_id,
  :worm,
  :retention_start_date,
  :pool_entry_date)
  SENSITIVE = []
  include Aws::Structure
end