Package software.amazon.awssdk.services.storagegateway.model

Interface CreateTapesRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateTapesRequest.Builder,CreateTapesRequest>, SdkBuilder<CreateTapesRequest.Builder,CreateTapesRequest>, SdkPojo, SdkRequest.Builder, StorageGatewayRequest.Builder
Enclosing class:
CreateTapesRequest
public static interface CreateTapesRequest.Builder extends StorageGatewayRequest.Builder, SdkPojo, CopyableBuilder<CreateTapesRequest.Builder,CreateTapesRequest>

  • Method Details

    • gatewayARN

      CreateTapesRequest.Builder gatewayARN(String gatewayARN)

      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 Amazon Web Services Region.

      Parameters:
      gatewayARN - 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 Amazon Web Services Region.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tapeSizeInBytes

      CreateTapesRequest.Builder tapeSizeInBytes(Long tapeSizeInBytes)

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

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

      Parameters:
      tapeSizeInBytes - The size, in bytes, of the virtual tapes that you want to create.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientToken

      CreateTapesRequest.Builder clientToken(String clientToken)

      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.

      Parameters:
      clientToken - 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:
      Returns a reference to this object so that method calls can be chained together.

    • numTapesToCreate

      CreateTapesRequest.Builder numTapesToCreate(Integer numTapesToCreate)

      The number of virtual tapes that you want to create.

      Parameters:
      numTapesToCreate - The number of virtual tapes that you want to create.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tapeBarcodePrefix

      CreateTapesRequest.Builder tapeBarcodePrefix(String tapeBarcodePrefix)

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

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • kmsEncrypted

      CreateTapesRequest.Builder kmsEncrypted(Boolean kmsEncrypted)

      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

      Parameters:
      kmsEncrypted - 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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • kmsKey

      CreateTapesRequest.Builder kmsKey(String kmsKey)

      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.

      Parameters:
      kmsKey - 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:
      Returns a reference to this object so that method calls can be chained together.

    • poolId

      CreateTapesRequest.Builder poolId(String poolId)

      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.

      Parameters:
      poolId - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • worm

      CreateTapesRequest.Builder worm(Boolean worm)

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

      Parameters:
      worm - Set to TRUE if the tape you are creating is to be configured as a write-once-read-many (WORM) tape.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateTapesRequest.Builder tags(Collection<Tag> tags)

      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.

      Parameters:
      tags - 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:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateTapesRequest.Builder tags(Tag... tags)

      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.

      Parameters:
      tags - 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:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateTapesRequest.Builder tags(Consumer<Tag.Builder>... tags)

      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.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      CreateTapesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateTapesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.