libZSservicesZSamazonka-storagegatewayZSamazonka-storagegateway
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.StorageGateway.Types.PoolInfo

Description

 
Synopsis

Documentation

data PoolInfo Source #

Describes a custom tape pool.

See: newPoolInfo smart constructor.

Constructors

PoolInfo' 

Fields

  • 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.

  • 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).

  • poolName :: Maybe Text

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

  • 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.

  • poolStatus :: Maybe PoolStatus

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

  • 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.

Instances

Instances details
Eq PoolInfo Source # 
Instance details

Defined in Amazonka.StorageGateway.Types.PoolInfo

Read PoolInfo Source # 
Instance details

Defined in Amazonka.StorageGateway.Types.PoolInfo

Show PoolInfo Source # 
Instance details

Defined in Amazonka.StorageGateway.Types.PoolInfo

Generic PoolInfo Source # 
Instance details

Defined in Amazonka.StorageGateway.Types.PoolInfo

Associated Types

type Rep PoolInfo :: Type -> Type #

Methods

from :: PoolInfo -> Rep PoolInfo x #

to :: Rep PoolInfo x -> PoolInfo #

NFData PoolInfo Source # 
Instance details

Defined in Amazonka.StorageGateway.Types.PoolInfo

Methods

rnf :: PoolInfo -> () #

Hashable PoolInfo Source # 
Instance details

Defined in Amazonka.StorageGateway.Types.PoolInfo

Methods

hashWithSalt :: Int -> PoolInfo -> Int #

hash :: PoolInfo -> Int #

FromJSON PoolInfo Source # 
Instance details

Defined in Amazonka.StorageGateway.Types.PoolInfo

type Rep PoolInfo Source # 
Instance details

Defined in Amazonka.StorageGateway.Types.PoolInfo

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

newPoolInfo :: PoolInfo Source #

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: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: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:poolName:PoolInfo', poolInfo_poolName - The name of the custom tape pool. PoolName can use all ASCII characters, except '/' and '\'.

$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.

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

$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.

poolInfo_retentionLockType :: Lens' PoolInfo (Maybe RetentionLockType) Source #

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_retentionLockTimeInDays :: Lens' PoolInfo (Maybe Natural) Source #

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

poolInfo_poolName :: Lens' PoolInfo (Maybe Text) Source #

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

poolInfo_storageClass :: Lens' PoolInfo (Maybe TapeStorageClass) Source #

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_poolStatus :: Lens' PoolInfo (Maybe PoolStatus) Source #

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

poolInfo_poolARN :: Lens' PoolInfo (Maybe Text) Source #

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.