Class: Aws::StorageGateway::Types::TapeArchive

Inherits:

Struct

Object
Struct
Aws::StorageGateway::Types::TapeArchive

show all

Includes:: Aws::Structure

Defined in:: lib/aws-sdk-storagegateway/types.rb

Overview

Represents a virtual tape that is archived in the virtual tape shelf (VTS).

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#completion_time ⇒ Time

The time that the archiving of the virtual tape was completed.
#kms_key ⇒ String

The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption.
#pool_entry_date ⇒ Time

The time that the tape entered the custom tape pool.
#pool_id ⇒ String

The ID of the pool that was used to archive the tape.
#retention_start_date ⇒ Time

If the archived tape is subject to tape retention lock, the date that the archived tape started being retained.
#retrieved_to ⇒ String

The Amazon Resource Name (ARN) of the tape gateway that the virtual tape is being retrieved to.
#tape_arn ⇒ String

The Amazon Resource Name (ARN) of an archived virtual tape.
#tape_barcode ⇒ String

The barcode that identifies the archived virtual tape.
#tape_created_date ⇒ Time

The date the virtual tape was created.
#tape_size_in_bytes ⇒ Integer

The size, in bytes, of the archived virtual tape.
#tape_status ⇒ String

The current state of the archived virtual tape.
#tape_used_in_bytes ⇒ Integer

The size, in bytes, of data stored on the virtual tape.
#worm ⇒ Boolean

Set to ‘true` if the archived tape is stored as write-once-read-many (WORM).

Instance Attribute Details

#completion_time ⇒ `Time`

The time that the archiving of the virtual tape was completed.

The default timestamp format is in the ISO8601 extended YYYY-MM-DD’T’HH:MM:SS’Z’ format.

Returns:

(Time)

# File 'lib/aws-sdk-storagegateway/types.rb', line 6206

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

#kms_key ⇒ `String`

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)

# File 'lib/aws-sdk-storagegateway/types.rb', line 6206

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

#pool_entry_date ⇒ `Time`

The time that the tape entered the custom tape pool.

The default timestamp format is in the ISO8601 extended YYYY-MM-DD’T’HH:MM:SS’Z’ format.

Returns:

(Time)

# File 'lib/aws-sdk-storagegateway/types.rb', line 6206

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

#pool_id ⇒ `String`

The ID of the pool that was used to archive the tape. The tapes in this pool are archived in the S3 storage class that is associated with the pool.

Valid Values: ‘GLACIER` | `DEEP_ARCHIVE`

Returns:

(String)

# File 'lib/aws-sdk-storagegateway/types.rb', line 6206

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

#retention_start_date ⇒ `Time`

If the archived tape is subject to tape retention lock, the date that the archived tape started being retained.

Returns:

(Time)

# File 'lib/aws-sdk-storagegateway/types.rb', line 6206

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

#retrieved_to ⇒ `String`

The Amazon Resource Name (ARN) of the tape gateway that the virtual tape is being retrieved to.

The virtual tape is retrieved from the virtual tape shelf (VTS).

Returns:

(String)

# File 'lib/aws-sdk-storagegateway/types.rb', line 6206

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

#tape_arn ⇒ `String`

The Amazon Resource Name (ARN) of an archived virtual tape.

Returns:

(String)

# File 'lib/aws-sdk-storagegateway/types.rb', line 6206

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

#tape_barcode ⇒ `String`

The barcode that identifies the archived virtual tape.

Returns:

(String)

# File 'lib/aws-sdk-storagegateway/types.rb', line 6206

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

#tape_created_date ⇒ `Time`

The date the virtual tape was created.

Returns:

(Time)

# File 'lib/aws-sdk-storagegateway/types.rb', line 6206

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

#tape_size_in_bytes ⇒ `Integer`

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

Returns:

(Integer)

# File 'lib/aws-sdk-storagegateway/types.rb', line 6206

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

#tape_status ⇒ `String`

The current state of the archived virtual tape.

Returns:

(String)

# File 'lib/aws-sdk-storagegateway/types.rb', line 6206

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

#tape_used_in_bytes ⇒ `Integer`

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

<note markdown=“1”> This value is not available for tapes created prior to May 13, 2015.

</note>

Returns:

(Integer)

# File 'lib/aws-sdk-storagegateway/types.rb', line 6206

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

#worm ⇒ `Boolean`

Set to ‘true` if the archived tape is stored as write-once-read-many (WORM).

Returns:

(Boolean)

# File 'lib/aws-sdk-storagegateway/types.rb', line 6206

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

Class: Aws::StorageGateway::Types::TapeArchive

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#completion_time ⇒ Time

#kms_key ⇒ String

#pool_entry_date ⇒ Time

#pool_id ⇒ String

#retention_start_date ⇒ Time

#retrieved_to ⇒ String

#tape_arn ⇒ String

#tape_barcode ⇒ String

#tape_created_date ⇒ Time

#tape_size_in_bytes ⇒ Integer

#tape_status ⇒ String

#tape_used_in_bytes ⇒ Integer

#worm ⇒ Boolean

#completion_time ⇒ `Time`

#kms_key ⇒ `String`

#pool_entry_date ⇒ `Time`

#pool_id ⇒ `String`

#retention_start_date ⇒ `Time`

#retrieved_to ⇒ `String`

#tape_arn ⇒ `String`

#tape_barcode ⇒ `String`

#tape_created_date ⇒ `Time`

#tape_size_in_bytes ⇒ `Integer`

#tape_status ⇒ `String`

#tape_used_in_bytes ⇒ `Integer`

#worm ⇒ `Boolean`