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

Class: Aws::StorageGateway::Types::CreateTapesInput

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 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",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

CreateTapesInput

Instance Attribute Summary collapse

Instance Attribute Details

#client_tokenString

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.

Returns:

  • (String)


1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1688

class CreateTapesInput < Struct.new(
  :gateway_arn,
  :tape_size_in_bytes,
  :client_token,
  :num_tapes_to_create,
  :tape_barcode_prefix,
  :kms_encrypted,
  :kms_key,
  :pool_id,
  :tags)
  include Aws::Structure
end

#gateway_arnString

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

Returns:

  • (String)


1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1688

class CreateTapesInput < Struct.new(
  :gateway_arn,
  :tape_size_in_bytes,
  :client_token,
  :num_tapes_to_create,
  :tape_barcode_prefix,
  :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)


1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1688

class CreateTapesInput < Struct.new(
  :gateway_arn,
  :tape_size_in_bytes,
  :client_token,
  :num_tapes_to_create,
  :tape_barcode_prefix,
  :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)


1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1688

class CreateTapesInput < Struct.new(
  :gateway_arn,
  :tape_size_in_bytes,
  :client_token,
  :num_tapes_to_create,
  :tape_barcode_prefix,
  :kms_encrypted,
  :kms_key,
  :pool_id,
  :tags)
  include Aws::Structure
end

#num_tapes_to_createInteger

The number of virtual tapes that you want to create.

Returns:

  • (Integer)


1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1688

class CreateTapesInput < Struct.new(
  :gateway_arn,
  :tape_size_in_bytes,
  :client_token,
  :num_tapes_to_create,
  :tape_barcode_prefix,
  :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)


1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1688

class CreateTapesInput < Struct.new(
  :gateway_arn,
  :tape_size_in_bytes,
  :client_token,
  :num_tapes_to_create,
  :tape_barcode_prefix,
  :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. 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:



1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1688

class CreateTapesInput < Struct.new(
  :gateway_arn,
  :tape_size_in_bytes,
  :client_token,
  :num_tapes_to_create,
  :tape_barcode_prefix,
  :kms_encrypted,
  :kms_key,
  :pool_id,
  :tags)
  include Aws::Structure
end

#tape_barcode_prefixString

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 to 4 characters in length and must be one of the uppercase letters from A to Z.

Returns:

  • (String)


1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1688

class CreateTapesInput < Struct.new(
  :gateway_arn,
  :tape_size_in_bytes,
  :client_token,
  :num_tapes_to_create,
  :tape_barcode_prefix,
  :kms_encrypted,
  :kms_key,
  :pool_id,
  :tags)
  include Aws::Structure
end

#tape_size_in_bytesInteger

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

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

Returns:

  • (Integer)


1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1688

class CreateTapesInput < Struct.new(
  :gateway_arn,
  :tape_size_in_bytes,
  :client_token,
  :num_tapes_to_create,
  :tape_barcode_prefix,
  :kms_encrypted,
  :kms_key,
  :pool_id,
  :tags)
  include Aws::Structure
end