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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb

Overview

Note:

When making an API call, you may pass CreateTapeWithBarcodeInput data as a hash:

{
  gateway_arn: "GatewayARN", # required
  tape_size_in_bytes: 1, # required
  tape_barcode: "TapeBarcode", # required
  kms_encrypted: false,
  kms_key: "KMSKey",
  pool_id: "PoolId",
  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)


1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1567

class CreateTapeWithBarcodeInput < Struct.new(
  :gateway_arn,
  :tape_size_in_bytes,
  :tape_barcode,
  :kms_encrypted,
  :kms_key,
  :pool_id,
  :tags)
  include Aws::Structure
end

#kms_encryptedBoolean

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.

Returns:

  • (Boolean)


1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1567

class CreateTapeWithBarcodeInput < Struct.new(
  :gateway_arn,
  :tape_size_in_bytes,
  :tape_barcode,
  :kms_encrypted,
  :kms_key,
  :pool_id,
  :tags)
  include Aws::Structure
end

#kms_keyString

The Amazon Resource Name (ARN) of the AWS KMS Key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.

Returns:

  • (String)


1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1567

class CreateTapeWithBarcodeInput < Struct.new(
  :gateway_arn,
  :tape_size_in_bytes,
  :tape_barcode,
  :kms_encrypted,
  :kms_key,
  :pool_id,
  :tags)
  include Aws::Structure
end

#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 (Glacier or Deep Archive) that corresponds to the pool.

Valid values: "GLACIER", "DEEP_ARCHIVE"

Returns:

  • (String)


1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1567

class CreateTapeWithBarcodeInput < Struct.new(
  :gateway_arn,
  :tape_size_in_bytes,
  :tape_barcode,
  :kms_encrypted,
  :kms_key,
  :pool_id,
  :tags)
  include Aws::Structure
end

#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:



1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1567

class CreateTapeWithBarcodeInput < Struct.new(
  :gateway_arn,
  :tape_size_in_bytes,
  :tape_barcode,
  :kms_encrypted,
  :kms_key,
  :pool_id,
  :tags)
  include Aws::Structure
end

#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)


1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1567

class CreateTapeWithBarcodeInput < Struct.new(
  :gateway_arn,
  :tape_size_in_bytes,
  :tape_barcode,
  :kms_encrypted,
  :kms_key,
  :pool_id,
  :tags)
  include Aws::Structure
end

#tape_size_in_bytesInteger

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

The size must be aligned by gigabyte (102410241024 byte).

Returns:

  • (Integer)


1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1567

class CreateTapeWithBarcodeInput < Struct.new(
  :gateway_arn,
  :tape_size_in_bytes,
  :tape_barcode,
  :kms_encrypted,
  :kms_key,
  :pool_id,
  :tags)
  include Aws::Structure
end