class Aws::StorageGateway::Types::CreateTapesInput

CreateTapesInput

@note When making an API call, you may pass CreateTapesInput

data as a hash:

    {
      gateway_arn: "GatewayARN", # required
      tape_size_in_bytes: 1, # required
      client_token: "ClientToken", # required
      num_tapes_to_create: 1, # required
      tape_barcode_prefix: "TapeBarcodePrefix", # required
      kms_encrypted: false,
      kms_key: "KMSKey",
      pool_id: "PoolId",
      worm: false,
      tags: [
        {
          key: "TagKey", # required
          value: "TagValue", # required
        },
      ],
    }

@!attribute [rw] gateway_arn

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 Region.
@return [String]

@!attribute [rw] tape_size_in_bytes

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

<note markdown="1"> The size must be aligned by gigabyte (1024*1024*1024 bytes).

 </note>
@return [Integer]

@!attribute [rw] client_token

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.

<note markdown="1"> Using the same `ClientToken` prevents creating the tape multiple
times.

 </note>
@return [String]

@!attribute [rw] num_tapes_to_create

The number of virtual tapes that you want to create.
@return [Integer]

@!attribute [rw] tape_barcode_prefix

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

<note markdown="1"> The prefix must be 1-4 characters in length and must be one of the
uppercase letters from A to Z.

 </note>
@return [String]

@!attribute [rw] kms_encrypted

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`
@return [Boolean]

@!attribute [rw] kms_key

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.
@return [String]

@!attribute [rw] pool_id

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.

Valid Values: `GLACIER` \| `DEEP_ARCHIVE`
@return [String]

@!attribute [rw] worm

Set to `TRUE` if the tape you are creating is to be configured as a
write-once-read-many (WORM) tape.
@return [Boolean]

@!attribute [rw] tags

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

<note markdown="1"> 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.

 </note>
@return [Array<Types::Tag>]

@see docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/CreateTapesInput AWS API Documentation

Constants

SENSITIVE