AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the CreateTapeWithBarcode operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.StorageGateway.AmazonStorageGatewayRequest
      Amazon.StorageGateway.Model.CreateTapeWithBarcodeRequest

Namespace: Amazon.StorageGateway.Model
Assembly: AWSSDK.StorageGateway.dll
Version: 3.x.y.z

Syntax

C#
public class CreateTapeWithBarcodeRequest : AmazonStorageGatewayRequest
         IAmazonWebServiceRequest

The CreateTapeWithBarcodeRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property GatewayARN System.String

Gets and sets the property 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.

Public Property KMSEncrypted System.Boolean

Gets and sets the property 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

Public Property KMSKey System.String

Gets and sets the property 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.

Public Property PoolId System.String

Gets and sets the property 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.

Public Property Tags System.Collections.Generic.List<Amazon.StorageGateway.Model.Tag>

Gets and sets the property 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.

Public Property TapeBarcode System.String

Gets and sets the property 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.

Public Property TapeSizeInBytes System.Int64

Gets and sets the property 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).

Public Property Worm System.Boolean

Gets and sets the property Worm.

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

Examples

Creates a virtual tape by using your own barcode.

To create a virtual tape using a barcode


var client = new AmazonStorageGatewayClient();
var response = client.CreateTapeWithBarcode(new CreateTapeWithBarcodeRequest 
{
    GatewayARN = "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B",
    TapeBarcode = "TEST12345",
    TapeSizeInBytes = 107374182400
});

string tapeARN = response.TapeARN;

            

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5