Amazonka.StorageGateway.Types.PoolInfo

Documentation

data PoolInfo

Describes a custom tape pool.

See: newPoolInfo smart constructor.

Constructors

PoolInfo'

Fields

• poolARN :: Maybe Text

  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.

• poolName :: Maybe Text

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

• poolStatus :: Maybe PoolStatus

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

• retentionLockTimeInDays :: Maybe Natural

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

• retentionLockType :: Maybe RetentionLockType

  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.

• storageClass :: Maybe TapeStorageClass

  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.

Instances

FromJSON PoolInfo

Defined in Amazonka.StorageGateway.Types.PoolInfo

Methods

parseJSON :: Value -> Parser PoolInfo

parseJSONList :: Value -> Parser [PoolInfo]

Generic PoolInfo

Defined in Amazonka.StorageGateway.Types.PoolInfo

Associated Types

type Rep PoolInfo :: Type -> Type

Methods

from :: PoolInfo -> Rep PoolInfo x

to :: Rep PoolInfo x -> PoolInfo

Read PoolInfo

Defined in Amazonka.StorageGateway.Types.PoolInfo

Methods

readsPrec :: Int -> ReadS PoolInfo

readList :: ReadS [PoolInfo]

readPrec :: ReadPrec PoolInfo

readListPrec :: ReadPrec [PoolInfo]

Show PoolInfo

Defined in Amazonka.StorageGateway.Types.PoolInfo

Methods

showsPrec :: Int -> PoolInfo -> ShowS

show :: PoolInfo -> String

showList :: [PoolInfo] -> ShowS

NFData PoolInfo

Defined in Amazonka.StorageGateway.Types.PoolInfo

Methods

rnf :: PoolInfo -> ()

Eq PoolInfo

Defined in Amazonka.StorageGateway.Types.PoolInfo

Methods

(==) :: PoolInfo -> PoolInfo -> Bool

(/=) :: PoolInfo -> PoolInfo -> Bool

Hashable PoolInfo

Defined in Amazonka.StorageGateway.Types.PoolInfo

Methods

hashWithSalt :: Int -> PoolInfo -> Int

hash :: PoolInfo -> Int

type Rep PoolInfo

Defined in Amazonka.StorageGateway.Types.PoolInfo

type Rep PoolInfo = D1 ('MetaData "PoolInfo" "Amazonka.StorageGateway.Types.PoolInfo" "amazonka-storagegateway-2.0-A8x7b0LCNm33wkCZlwgcSL" 'False) (C1 ('MetaCons "PoolInfo'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "poolARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "poolName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "poolStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PoolStatus)))) :*: (S1 ('MetaSel ('Just "retentionLockTimeInDays") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "retentionLockType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RetentionLockType)) :*: S1 ('MetaSel ('Just "storageClass") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TapeStorageClass))))))

newPoolInfo :: PoolInfo

Create a value of PoolInfo with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:poolARN:PoolInfo', poolInfo_poolARN - 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.

$sel:poolName:PoolInfo', poolInfo_poolName - The name of the custom tape pool. PoolName can use all ASCII characters, except '/' and '\'.

$sel:poolStatus:PoolInfo', poolInfo_poolStatus - Status of the custom tape pool. Pool can be ACTIVE or DELETED.

$sel:retentionLockTimeInDays:PoolInfo', poolInfo_retentionLockTimeInDays - Tape retention lock time is set in days. Tape retention lock can be enabled for up to 100 years (36,500 days).

$sel:retentionLockType:PoolInfo', poolInfo_retentionLockType - 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.

$sel:storageClass:PoolInfo', poolInfo_storageClass - 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.

poolInfo_poolARN :: Lens' PoolInfo (Maybe Text)

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.

poolInfo_poolName :: Lens' PoolInfo (Maybe Text)

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

poolInfo_poolStatus :: Lens' PoolInfo (Maybe PoolStatus)

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

poolInfo_retentionLockTimeInDays :: Lens' PoolInfo (Maybe Natural)

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

poolInfo_retentionLockType :: Lens' PoolInfo (Maybe RetentionLockType)

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.

poolInfo_storageClass :: Lens' PoolInfo (Maybe TapeStorageClass)

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.