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

Class CreateTapesRequest

    • Method Detail

      • gatewayARN

        public final 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.

        Returns:
        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.

      • tapeSizeInBytes

        public final 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).

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

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

      • clientToken

        public final 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.

        Returns:
        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.

      • numTapesToCreate

        public final Integer numTapesToCreate()

        The number of virtual tapes that you want to create.

        Returns:
        The number of virtual tapes that you want to create.

      • tapeBarcodePrefix

        public final 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.

        Returns:
        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.

      • kmsEncrypted

        public final 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

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

      • kmsKey

        public final 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.

        Returns:
        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.

      • poolId

        public final 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.

        Returns:
        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.

      • worm

        public final Boolean worm()

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

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

      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • tags

        public final List<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.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

        Returns:
        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.

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object