Class: Aws::StorageGateway::Types::PoolInfo

Inherits:

Struct

• Object
• Struct
• Aws::StorageGateway::Types::PoolInfo

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-storagegateway/types.rb

Overview

Describes a custom tape pool.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #pool_arn ⇒ String

  The Amazon Resource Name (ARN) of the custom tape pool.

• #pool_name ⇒ String

  The name of the custom tape pool.

• #pool_status ⇒ String

  Status of the custom tape pool.

• #retention_lock_time_in_days ⇒ Integer

  Tape retention lock time is set in days.

• #retention_lock_type ⇒ String

  Tape retention lock type, which can be configured in two modes.

• #storage_class ⇒ String

  The storage class that is associated with the custom pool.

Instance Attribute Details

#pool_arn ⇒ String

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 AWS Region.

Returns:

• (String)

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

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_name ⇒ String

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

Returns:

• (String)

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

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_status ⇒ String

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

Returns:

• (String)

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

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_days ⇒ Integer

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

Returns:

• (Integer)

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

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_type ⇒ String

Tape retention lock type, which can be configured in two modes. When configured in governance mode, AWS 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 AWS account.

Returns:

• (String)

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

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_class ⇒ String

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)

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

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