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

Description

Creates a virtual tape by using your own barcode. You write data to the virtual tape and then archive the tape. A barcode is unique and cannot be reused if it has already been used on a tape. This applies to barcodes used on deleted tapes. This operation is only supported in the tape gateway type.

Cache storage must be allocated to the gateway before you can create a virtual tape. Use the AddCache operation to add cache storage to a gateway.

Synopsis

Creating a Request

data CreateTapeWithBarcode Source #

CreateTapeWithBarcodeInput

See: newCreateTapeWithBarcode smart constructor.

Constructors

CreateTapeWithBarcode' 

Fields

  • kmsKey :: Maybe Text

    The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true. Optional.

  • kmsEncrypted :: Maybe Bool

    Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3. Optional.

    Valid Values: true | false

  • poolId :: Maybe Text

    The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Deep Archive) that corresponds to the pool.

    Valid Values: GLACIER | DEEP_ARCHIVE

  • worm :: Maybe Bool

    Set to TRUE if the tape you are creating is to be configured as a write-once-read-many (WORM) tape.

  • tags :: Maybe [Tag]

    A list of up to 50 tags that can be assigned to a virtual tape that has a barcode. 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.

  • gatewayARN :: Text

    The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tape with. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

  • tapeSizeInBytes :: Integer

    The size, in bytes, of the virtual tape that you want to create.

    The size must be aligned by gigabyte (1024*1024*1024 bytes).

  • tapeBarcode :: Text

    The barcode that you want to assign to the tape.

    Barcodes cannot be reused. This includes barcodes used for tapes that have been deleted.

Instances

Instances details
Eq CreateTapeWithBarcode Source # 
Instance details

Defined in Amazonka.StorageGateway.CreateTapeWithBarcode

Read CreateTapeWithBarcode Source # 
Instance details

Defined in Amazonka.StorageGateway.CreateTapeWithBarcode

Show CreateTapeWithBarcode Source # 
Instance details

Defined in Amazonka.StorageGateway.CreateTapeWithBarcode

Generic CreateTapeWithBarcode Source # 
Instance details

Defined in Amazonka.StorageGateway.CreateTapeWithBarcode

Associated Types

type Rep CreateTapeWithBarcode :: Type -> Type #

NFData CreateTapeWithBarcode Source # 
Instance details

Defined in Amazonka.StorageGateway.CreateTapeWithBarcode

Methods

rnf :: CreateTapeWithBarcode -> () #

Hashable CreateTapeWithBarcode Source # 
Instance details

Defined in Amazonka.StorageGateway.CreateTapeWithBarcode

ToJSON CreateTapeWithBarcode Source # 
Instance details

Defined in Amazonka.StorageGateway.CreateTapeWithBarcode

AWSRequest CreateTapeWithBarcode Source # 
Instance details

Defined in Amazonka.StorageGateway.CreateTapeWithBarcode

Associated Types

type AWSResponse CreateTapeWithBarcode #

ToHeaders CreateTapeWithBarcode Source # 
Instance details

Defined in Amazonka.StorageGateway.CreateTapeWithBarcode

ToPath CreateTapeWithBarcode Source # 
Instance details

Defined in Amazonka.StorageGateway.CreateTapeWithBarcode

ToQuery CreateTapeWithBarcode Source # 
Instance details

Defined in Amazonka.StorageGateway.CreateTapeWithBarcode

type Rep CreateTapeWithBarcode Source # 
Instance details

Defined in Amazonka.StorageGateway.CreateTapeWithBarcode

type Rep CreateTapeWithBarcode = D1 ('MetaData "CreateTapeWithBarcode" "Amazonka.StorageGateway.CreateTapeWithBarcode" "libZSservicesZSamazonka-storagegatewayZSamazonka-storagegateway" 'False) (C1 ('MetaCons "CreateTapeWithBarcode'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "kmsKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "kmsEncrypted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "poolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "worm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "gatewayARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "tapeSizeInBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer) :*: S1 ('MetaSel ('Just "tapeBarcode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse CreateTapeWithBarcode Source # 
Instance details

Defined in Amazonka.StorageGateway.CreateTapeWithBarcode

newCreateTapeWithBarcode Source #

Create a value of CreateTapeWithBarcode 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:kmsKey:CreateTapeWithBarcode', createTapeWithBarcode_kmsKey - The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true. Optional.

$sel:kmsEncrypted:CreateTapeWithBarcode', createTapeWithBarcode_kmsEncrypted - Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3. Optional.

Valid Values: true | false

$sel:poolId:CreateTapeWithBarcode', createTapeWithBarcode_poolId - The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Deep Archive) that corresponds to the pool.

Valid Values: GLACIER | DEEP_ARCHIVE

$sel:worm:CreateTapeWithBarcode', createTapeWithBarcode_worm - Set to TRUE if the tape you are creating is to be configured as a write-once-read-many (WORM) tape.

$sel:tags:CreateTapeWithBarcode', createTapeWithBarcode_tags - A list of up to 50 tags that can be assigned to a virtual tape that has a barcode. 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.

$sel:gatewayARN:CreateTapeWithBarcode', createTapeWithBarcode_gatewayARN - The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tape with. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

$sel:tapeSizeInBytes:CreateTapeWithBarcode', createTapeWithBarcode_tapeSizeInBytes - The size, in bytes, of the virtual tape that you want to create.

The size must be aligned by gigabyte (1024*1024*1024 bytes).

$sel:tapeBarcode:CreateTapeWithBarcode', createTapeWithBarcode_tapeBarcode - The barcode that you want to assign to the tape.

Barcodes cannot be reused. This includes barcodes used for tapes that have been deleted.

Request Lenses

createTapeWithBarcode_kmsKey :: Lens' CreateTapeWithBarcode (Maybe Text) Source #

The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true. Optional.

createTapeWithBarcode_kmsEncrypted :: Lens' CreateTapeWithBarcode (Maybe Bool) Source #

Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3. Optional.

Valid Values: true | false

createTapeWithBarcode_poolId :: Lens' CreateTapeWithBarcode (Maybe Text) Source #

The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Deep Archive) that corresponds to the pool.

Valid Values: GLACIER | DEEP_ARCHIVE

createTapeWithBarcode_worm :: Lens' CreateTapeWithBarcode (Maybe Bool) Source #

Set to TRUE if the tape you are creating is to be configured as a write-once-read-many (WORM) tape.

createTapeWithBarcode_tags :: Lens' CreateTapeWithBarcode (Maybe [Tag]) Source #

A list of up to 50 tags that can be assigned to a virtual tape that has a barcode. 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.

createTapeWithBarcode_gatewayARN :: Lens' CreateTapeWithBarcode Text Source #

The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tape with. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

createTapeWithBarcode_tapeSizeInBytes :: Lens' CreateTapeWithBarcode Integer Source #

The size, in bytes, of the virtual tape that you want to create.

The size must be aligned by gigabyte (1024*1024*1024 bytes).

createTapeWithBarcode_tapeBarcode :: Lens' CreateTapeWithBarcode Text Source #

The barcode that you want to assign to the tape.

Barcodes cannot be reused. This includes barcodes used for tapes that have been deleted.

Destructuring the Response

data CreateTapeWithBarcodeResponse Source #

CreateTapeOutput

See: newCreateTapeWithBarcodeResponse smart constructor.

Constructors

CreateTapeWithBarcodeResponse' 

Fields

  • tapeARN :: Maybe Text

    A unique Amazon Resource Name (ARN) that represents the virtual tape that was created.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq CreateTapeWithBarcodeResponse Source # 
Instance details

Defined in Amazonka.StorageGateway.CreateTapeWithBarcode

Read CreateTapeWithBarcodeResponse Source # 
Instance details

Defined in Amazonka.StorageGateway.CreateTapeWithBarcode

Show CreateTapeWithBarcodeResponse Source # 
Instance details

Defined in Amazonka.StorageGateway.CreateTapeWithBarcode

Generic CreateTapeWithBarcodeResponse Source # 
Instance details

Defined in Amazonka.StorageGateway.CreateTapeWithBarcode

Associated Types

type Rep CreateTapeWithBarcodeResponse :: Type -> Type #

NFData CreateTapeWithBarcodeResponse Source # 
Instance details

Defined in Amazonka.StorageGateway.CreateTapeWithBarcode

type Rep CreateTapeWithBarcodeResponse Source # 
Instance details

Defined in Amazonka.StorageGateway.CreateTapeWithBarcode

type Rep CreateTapeWithBarcodeResponse = D1 ('MetaData "CreateTapeWithBarcodeResponse" "Amazonka.StorageGateway.CreateTapeWithBarcode" "libZSservicesZSamazonka-storagegatewayZSamazonka-storagegateway" 'False) (C1 ('MetaCons "CreateTapeWithBarcodeResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "tapeARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateTapeWithBarcodeResponse Source #

Create a value of CreateTapeWithBarcodeResponse 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:tapeARN:CreateTapeWithBarcodeResponse', createTapeWithBarcodeResponse_tapeARN - A unique Amazon Resource Name (ARN) that represents the virtual tape that was created.

$sel:httpStatus:CreateTapeWithBarcodeResponse', createTapeWithBarcodeResponse_httpStatus - The response's http status code.

Response Lenses

createTapeWithBarcodeResponse_tapeARN :: Lens' CreateTapeWithBarcodeResponse (Maybe Text) Source #

A unique Amazon Resource Name (ARN) that represents the virtual tape that was created.