Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
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
- data CreateTapeWithBarcode = CreateTapeWithBarcode' {}
- newCreateTapeWithBarcode :: Text -> Integer -> Text -> CreateTapeWithBarcode
- createTapeWithBarcode_kmsKey :: Lens' CreateTapeWithBarcode (Maybe Text)
- createTapeWithBarcode_kmsEncrypted :: Lens' CreateTapeWithBarcode (Maybe Bool)
- createTapeWithBarcode_poolId :: Lens' CreateTapeWithBarcode (Maybe Text)
- createTapeWithBarcode_worm :: Lens' CreateTapeWithBarcode (Maybe Bool)
- createTapeWithBarcode_tags :: Lens' CreateTapeWithBarcode (Maybe [Tag])
- createTapeWithBarcode_gatewayARN :: Lens' CreateTapeWithBarcode Text
- createTapeWithBarcode_tapeSizeInBytes :: Lens' CreateTapeWithBarcode Integer
- createTapeWithBarcode_tapeBarcode :: Lens' CreateTapeWithBarcode Text
- data CreateTapeWithBarcodeResponse = CreateTapeWithBarcodeResponse' {
- tapeARN :: Maybe Text
- httpStatus :: Int
- newCreateTapeWithBarcodeResponse :: Int -> CreateTapeWithBarcodeResponse
- createTapeWithBarcodeResponse_tapeARN :: Lens' CreateTapeWithBarcodeResponse (Maybe Text)
- createTapeWithBarcodeResponse_httpStatus :: Lens' CreateTapeWithBarcodeResponse Int
Creating a Request
data CreateTapeWithBarcode Source #
CreateTapeWithBarcodeInput
See: newCreateTapeWithBarcode
smart constructor.
CreateTapeWithBarcode' | |
|
Instances
newCreateTapeWithBarcode Source #
:: Text | |
-> Integer | |
-> Text | |
-> CreateTapeWithBarcode |
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.
CreateTapeWithBarcodeResponse' | |
|
Instances
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.
createTapeWithBarcodeResponse_httpStatus :: Lens' CreateTapeWithBarcodeResponse Int Source #
The response's http status code.