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::PoolInfo

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

Overview

Describes a custom tape pool.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#pool_arnString

The Amazon Resource Name (ARN) of the custom tape pool. Use the ListTapePools operation to return a list of custom tape pools for your account and Amazon Web Services Region.

Returns:

  • (String)


5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5829

class PoolInfo < Struct.new(
  :pool_arn,
  :pool_name,
  :storage_class,
  :retention_lock_type,
  :retention_lock_time_in_days,
  :pool_status)
  SENSITIVE = []
  include Aws::Structure
end

#pool_nameString

The name of the custom tape pool. PoolName can use all ASCII characters, except '/' and '\'.

Returns:

  • (String)


5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5829

class PoolInfo < Struct.new(
  :pool_arn,
  :pool_name,
  :storage_class,
  :retention_lock_type,
  :retention_lock_time_in_days,
  :pool_status)
  SENSITIVE = []
  include Aws::Structure
end

#pool_statusString

Status of the custom tape pool. Pool can be ACTIVE or DELETED.

Returns:

  • (String)


5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5829

class PoolInfo < Struct.new(
  :pool_arn,
  :pool_name,
  :storage_class,
  :retention_lock_type,
  :retention_lock_time_in_days,
  :pool_status)
  SENSITIVE = []
  include Aws::Structure
end

#retention_lock_time_in_daysInteger

Tape retention lock time is set in days. Tape retention lock can be enabled for up to 100 years (36,500 days).

Returns:

  • (Integer)


5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5829

class PoolInfo < Struct.new(
  :pool_arn,
  :pool_name,
  :storage_class,
  :retention_lock_type,
  :retention_lock_time_in_days,
  :pool_status)
  SENSITIVE = []
  include Aws::Structure
end

#retention_lock_typeString

Tape retention lock type, which can be configured in two modes. When configured in governance mode, Amazon Web Services accounts with specific IAM permissions are authorized to remove the tape retention lock from archived virtual tapes. When configured in compliance mode, the tape retention lock cannot be removed by any user, including the root Amazon Web Services account.

Returns:

  • (String)


5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5829

class PoolInfo < Struct.new(
  :pool_arn,
  :pool_name,
  :storage_class,
  :retention_lock_type,
  :retention_lock_time_in_days,
  :pool_status)
  SENSITIVE = []
  include Aws::Structure
end

#storage_classString

The storage class that is associated with the custom 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.

Returns:

  • (String)


5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5829

class PoolInfo < Struct.new(
  :pool_arn,
  :pool_name,
  :storage_class,
  :retention_lock_type,
  :retention_lock_time_in_days,
  :pool_status)
  SENSITIVE = []
  include Aws::Structure
end