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 CreateTapes operation. Creates one or more virtual tapes. You write data to the virtual tapes and then archive the tapes. This operation is only supported in the tape gateway type.

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

Inheritance Hierarchy

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

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

Syntax

C#
public class CreateTapesRequest : AmazonStorageGatewayRequest
         IAmazonWebServiceRequest

The CreateTapesRequest type exposes the following members

Constructors

NameDescription
Public Method CreateTapesRequest()

Properties

NameTypeDescription
Public Property ClientToken System.String

Gets and sets the property ClientToken.

A unique identifier that you use to retry a request. If you retry a request, use the same ClientToken you specified in the initial request.

Using the same ClientToken prevents creating the tape multiple times.

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 tapes 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 NumTapesToCreate System.Int32

Gets and sets the property NumTapesToCreate.

The number of virtual tapes that you want to create.

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 Glacier 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. 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 TapeBarcodePrefix System.String

Gets and sets the property TapeBarcodePrefix.

A prefix that you append to the barcode of the virtual tape you are creating. This prefix makes the barcode unique.

The prefix must be 1-4 characters in length and must be one of the uppercase letters from A to Z.

Public Property TapeSizeInBytes System.Int64

Gets and sets the property TapeSizeInBytes.

The size, in bytes, of the virtual tapes 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 one or more virtual tapes.

To create a virtual tape


var client = new AmazonStorageGatewayClient();
var response = client.CreateTapes(new CreateTapesRequest 
{
    ClientToken = "77777",
    GatewayARN = "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B",
    NumTapesToCreate = 3,
    TapeBarcodePrefix = "TEST",
    TapeSizeInBytes = 107374182400
});

List<string> tapeARNs = response.TapeARNs;

            

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