amazonka-storagegateway-2.0: Amazon Storage Gateway SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.StorageGateway.CreateTapePool

Description

Creates a new custom tape pool. You can use custom tape pool to enable tape retention lock on tapes that are archived in the custom pool.

Synopsis

Creating a Request

data CreateTapePool Source #

See: newCreateTapePool smart constructor.

Constructors

CreateTapePool' 

Fields

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

  • tags :: Maybe [Tag]

    A list of up to 50 tags that can be assigned to tape pool. Each tag is a key-value pair.

    Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.

  • poolName :: Text

    The name of the new custom tape pool.

  • storageClass :: TapeStorageClass

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

Instances details
ToJSON CreateTapePool Source # 
Instance details

Defined in Amazonka.StorageGateway.CreateTapePool

ToHeaders CreateTapePool Source # 
Instance details

Defined in Amazonka.StorageGateway.CreateTapePool

ToPath CreateTapePool Source # 
Instance details

Defined in Amazonka.StorageGateway.CreateTapePool

ToQuery CreateTapePool Source # 
Instance details

Defined in Amazonka.StorageGateway.CreateTapePool

AWSRequest CreateTapePool Source # 
Instance details

Defined in Amazonka.StorageGateway.CreateTapePool

Associated Types

type AWSResponse CreateTapePool #

Generic CreateTapePool Source # 
Instance details

Defined in Amazonka.StorageGateway.CreateTapePool

Associated Types

type Rep CreateTapePool :: Type -> Type #

Read CreateTapePool Source # 
Instance details

Defined in Amazonka.StorageGateway.CreateTapePool

Show CreateTapePool Source # 
Instance details

Defined in Amazonka.StorageGateway.CreateTapePool

NFData CreateTapePool Source # 
Instance details

Defined in Amazonka.StorageGateway.CreateTapePool

Methods

rnf :: CreateTapePool -> () #

Eq CreateTapePool Source # 
Instance details

Defined in Amazonka.StorageGateway.CreateTapePool

Hashable CreateTapePool Source # 
Instance details

Defined in Amazonka.StorageGateway.CreateTapePool

type AWSResponse CreateTapePool Source # 
Instance details

Defined in Amazonka.StorageGateway.CreateTapePool

type Rep CreateTapePool Source # 
Instance details

Defined in Amazonka.StorageGateway.CreateTapePool

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

newCreateTapePool Source #

Create a value of CreateTapePool 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:

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

CreateTapePool, createTapePool_retentionLockType - Tape retention lock 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.

CreateTapePool, createTapePool_tags - A list of up to 50 tags that can be assigned to tape pool. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.

CreateTapePool, createTapePool_poolName - The name of the new custom tape pool.

CreateTapePool, createTapePool_storageClass - The storage class that is associated with the new 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.

Request Lenses

createTapePool_retentionLockTimeInDays :: Lens' CreateTapePool (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).

createTapePool_retentionLockType :: Lens' CreateTapePool (Maybe RetentionLockType) Source #

Tape retention lock 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.

createTapePool_tags :: Lens' CreateTapePool (Maybe [Tag]) Source #

A list of up to 50 tags that can be assigned to tape pool. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.

createTapePool_poolName :: Lens' CreateTapePool Text Source #

The name of the new custom tape pool.

createTapePool_storageClass :: Lens' CreateTapePool TapeStorageClass Source #

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

Destructuring the Response

data CreateTapePoolResponse Source #

See: newCreateTapePoolResponse smart constructor.

Constructors

CreateTapePoolResponse' 

Fields

  • poolARN :: Maybe Text

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

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic CreateTapePoolResponse Source # 
Instance details

Defined in Amazonka.StorageGateway.CreateTapePool

Associated Types

type Rep CreateTapePoolResponse :: Type -> Type #

Read CreateTapePoolResponse Source # 
Instance details

Defined in Amazonka.StorageGateway.CreateTapePool

Show CreateTapePoolResponse Source # 
Instance details

Defined in Amazonka.StorageGateway.CreateTapePool

NFData CreateTapePoolResponse Source # 
Instance details

Defined in Amazonka.StorageGateway.CreateTapePool

Methods

rnf :: CreateTapePoolResponse -> () #

Eq CreateTapePoolResponse Source # 
Instance details

Defined in Amazonka.StorageGateway.CreateTapePool

type Rep CreateTapePoolResponse Source # 
Instance details

Defined in Amazonka.StorageGateway.CreateTapePool

type Rep CreateTapePoolResponse = D1 ('MetaData "CreateTapePoolResponse" "Amazonka.StorageGateway.CreateTapePool" "amazonka-storagegateway-2.0-A8x7b0LCNm33wkCZlwgcSL" 'False) (C1 ('MetaCons "CreateTapePoolResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "poolARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateTapePoolResponse Source #

Create a value of CreateTapePoolResponse 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:

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

$sel:httpStatus:CreateTapePoolResponse', createTapePoolResponse_httpStatus - The response's http status code.

Response Lenses

createTapePoolResponse_poolARN :: Lens' CreateTapePoolResponse (Maybe Text) Source #

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