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

Inherits:

Struct

• Object
• Struct
• Aws::StorageGateway::Types::CreateTapesInput

Includes:

Aws::Structure

Defined in:

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

CreateTapesInput

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_token ⇒ String

  A unique identifier that you use to retry a request.

• #gateway_arn ⇒ String

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

• #kms_encrypted ⇒ 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_key ⇒ String

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

• #num_tapes_to_create ⇒ Integer

  The number of virtual tapes that you want to create.

• #pool_id ⇒ String

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

• #tags ⇒ Array<Types::Tag>

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

• #tape_barcode_prefix ⇒ String

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

• #tape_size_in_bytes ⇒ Integer

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

• #worm ⇒ Boolean

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

Instance Attribute Details

#client_token ⇒ String

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>

Returns:

• (String)

# File 'lib/aws-sdk-storagegateway/types.rb', line 2156

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,
  :worm,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#gateway_arn ⇒ String

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)

# File 'lib/aws-sdk-storagegateway/types.rb', line 2156

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,
  :worm,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#kms_encrypted ⇒ 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. Optional.

Valid Values: ‘true` | `false`

Returns:

• (Boolean)

# File 'lib/aws-sdk-storagegateway/types.rb', line 2156

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,
  :worm,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key ⇒ String

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)

# File 'lib/aws-sdk-storagegateway/types.rb', line 2156

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,
  :worm,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#num_tapes_to_create ⇒ Integer

The number of virtual tapes that you want to create.

Returns:

• (Integer)

# File 'lib/aws-sdk-storagegateway/types.rb', line 2156

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,
  :worm,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#pool_id ⇒ String

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`

Returns:

• (String)

# File 'lib/aws-sdk-storagegateway/types.rb', line 2156

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,
  :worm,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

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>

Returns:

• (Array<Types::Tag>)

# File 'lib/aws-sdk-storagegateway/types.rb', line 2156

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,
  :worm,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tape_barcode_prefix ⇒ String

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

</note>

Returns:

• (String)

# File 'lib/aws-sdk-storagegateway/types.rb', line 2156

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,
  :worm,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tape_size_in_bytes ⇒ Integer

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>

Returns:

• (Integer)

# File 'lib/aws-sdk-storagegateway/types.rb', line 2156

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,
  :worm,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#worm ⇒ Boolean

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

Returns:

• (Boolean)

# File 'lib/aws-sdk-storagegateway/types.rb', line 2156

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,
  :worm,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end