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.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::StorageGateway::Types::CreateTapeWithBarcodeInput

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateTapeWithBarcodeInput as input to an Aws::Client method, you can use a vanilla Hash:

{
  gateway_arn: "GatewayARN", # required
  tape_size_in_bytes: 1, # required
  tape_barcode: "TapeBarcode", # required
  kms_encrypted: false,
  kms_key: "KMSKey",
  pool_id: "PoolId",
  worm: false,
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

CreateTapeWithBarcodeInput

Instance Attribute Summary collapse

Instance Attribute Details

#gateway_arnString

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 AWS Region.

Returns:

  • (String)

    The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tape with.

#kms_encryptedBoolean

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

Valid Values: true | false

Returns:

  • (Boolean)

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

#kms_keyString

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.

Returns:

  • (String)

    The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption.

#pool_idString

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

Returns:

  • (String)

    The ID of the pool that you want to add your tape to for archiving.

#tagsArray<Types::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.

Returns:

  • (Array<Types::Tag>)

    A list of up to 50 tags that can be assigned to a virtual tape that has a barcode.

#tape_barcodeString

The barcode that you want to assign to the tape.

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

Returns:

  • (String)

    The barcode that you want to assign to the tape.

#tape_size_in_bytesInteger

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

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

Returns:

  • (Integer)

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

#wormBoolean

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

Returns:

  • (Boolean)

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