/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include namespace Aws { namespace StorageGateway { namespace Model { /** *

CreateTapesInput

See Also:

AWS * API Reference

*/ class CreateTapesRequest : public StorageGatewayRequest { public: AWS_STORAGEGATEWAY_API CreateTapesRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "CreateTapes"; } AWS_STORAGEGATEWAY_API Aws::String SerializePayload() const override; AWS_STORAGEGATEWAY_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

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.

*/ inline const Aws::String& GetGatewayARN() const{ return m_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.

*/ inline bool GatewayARNHasBeenSet() const { return m_gatewayARNHasBeenSet; } /** *

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.

*/ inline void SetGatewayARN(const Aws::String& value) { m_gatewayARNHasBeenSet = true; m_gatewayARN = value; } /** *

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.

*/ inline void SetGatewayARN(Aws::String&& value) { m_gatewayARNHasBeenSet = true; m_gatewayARN = std::move(value); } /** *

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.

*/ inline void SetGatewayARN(const char* value) { m_gatewayARNHasBeenSet = true; m_gatewayARN.assign(value); } /** *

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.

*/ inline CreateTapesRequest& WithGatewayARN(const Aws::String& value) { SetGatewayARN(value); return *this;} /** *

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.

*/ inline CreateTapesRequest& WithGatewayARN(Aws::String&& value) { SetGatewayARN(std::move(value)); return *this;} /** *

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.

*/ inline CreateTapesRequest& WithGatewayARN(const char* value) { SetGatewayARN(value); return *this;} /** *

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

*

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

*/ inline long long GetTapeSizeInBytes() const{ return m_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).

*/ inline bool TapeSizeInBytesHasBeenSet() const { return m_tapeSizeInBytesHasBeenSet; } /** *

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

*

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

*/ inline void SetTapeSizeInBytes(long long value) { m_tapeSizeInBytesHasBeenSet = true; m_tapeSizeInBytes = value; } /** *

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

*

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

*/ inline CreateTapesRequest& WithTapeSizeInBytes(long long value) { SetTapeSizeInBytes(value); return *this;} /** *

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.

*/ inline const Aws::String& GetClientToken() const{ return m_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.

*/ inline bool ClientTokenHasBeenSet() const { return m_clientTokenHasBeenSet; } /** *

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.

*/ inline void SetClientToken(const Aws::String& value) { m_clientTokenHasBeenSet = true; m_clientToken = value; } /** *

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.

*/ inline void SetClientToken(Aws::String&& value) { m_clientTokenHasBeenSet = true; m_clientToken = std::move(value); } /** *

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.

*/ inline void SetClientToken(const char* value) { m_clientTokenHasBeenSet = true; m_clientToken.assign(value); } /** *

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.

*/ inline CreateTapesRequest& WithClientToken(const Aws::String& value) { SetClientToken(value); return *this;} /** *

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.

*/ inline CreateTapesRequest& WithClientToken(Aws::String&& value) { SetClientToken(std::move(value)); return *this;} /** *

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.

*/ inline CreateTapesRequest& WithClientToken(const char* value) { SetClientToken(value); return *this;} /** *

The number of virtual tapes that you want to create.

*/ inline int GetNumTapesToCreate() const{ return m_numTapesToCreate; } /** *

The number of virtual tapes that you want to create.

*/ inline bool NumTapesToCreateHasBeenSet() const { return m_numTapesToCreateHasBeenSet; } /** *

The number of virtual tapes that you want to create.

*/ inline void SetNumTapesToCreate(int value) { m_numTapesToCreateHasBeenSet = true; m_numTapesToCreate = value; } /** *

The number of virtual tapes that you want to create.

*/ inline CreateTapesRequest& WithNumTapesToCreate(int value) { SetNumTapesToCreate(value); return *this;} /** *

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.

* */ inline const Aws::String& GetTapeBarcodePrefix() const{ return m_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.

* */ inline bool TapeBarcodePrefixHasBeenSet() const { return m_tapeBarcodePrefixHasBeenSet; } /** *

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.

* */ inline void SetTapeBarcodePrefix(const Aws::String& value) { m_tapeBarcodePrefixHasBeenSet = true; m_tapeBarcodePrefix = value; } /** *

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.

* */ inline void SetTapeBarcodePrefix(Aws::String&& value) { m_tapeBarcodePrefixHasBeenSet = true; m_tapeBarcodePrefix = std::move(value); } /** *

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.

* */ inline void SetTapeBarcodePrefix(const char* value) { m_tapeBarcodePrefixHasBeenSet = true; m_tapeBarcodePrefix.assign(value); } /** *

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.

* */ inline CreateTapesRequest& WithTapeBarcodePrefix(const Aws::String& value) { SetTapeBarcodePrefix(value); return *this;} /** *

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.

* */ inline CreateTapesRequest& WithTapeBarcodePrefix(Aws::String&& value) { SetTapeBarcodePrefix(std::move(value)); return *this;} /** *

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.

* */ inline CreateTapesRequest& WithTapeBarcodePrefix(const char* value) { SetTapeBarcodePrefix(value); return *this;} /** *

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

*/ inline bool GetKMSEncrypted() const{ return m_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

*/ inline bool KMSEncryptedHasBeenSet() const { return m_kMSEncryptedHasBeenSet; } /** *

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

*/ inline void SetKMSEncrypted(bool value) { m_kMSEncryptedHasBeenSet = true; m_kMSEncrypted = value; } /** *

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

*/ inline CreateTapesRequest& WithKMSEncrypted(bool value) { SetKMSEncrypted(value); return *this;} /** *

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.

*/ inline const Aws::String& GetKMSKey() const{ return m_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.

*/ inline bool KMSKeyHasBeenSet() const { return m_kMSKeyHasBeenSet; } /** *

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.

*/ inline void SetKMSKey(const Aws::String& value) { m_kMSKeyHasBeenSet = true; m_kMSKey = value; } /** *

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.

*/ inline void SetKMSKey(Aws::String&& value) { m_kMSKeyHasBeenSet = true; m_kMSKey = std::move(value); } /** *

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.

*/ inline void SetKMSKey(const char* value) { m_kMSKeyHasBeenSet = true; m_kMSKey.assign(value); } /** *

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.

*/ inline CreateTapesRequest& WithKMSKey(const Aws::String& value) { SetKMSKey(value); return *this;} /** *

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.

*/ inline CreateTapesRequest& WithKMSKey(Aws::String&& value) { SetKMSKey(std::move(value)); return *this;} /** *

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.

*/ inline CreateTapesRequest& WithKMSKey(const char* value) { SetKMSKey(value); return *this;} /** *

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.

*/ inline const Aws::String& GetPoolId() const{ return m_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.

*/ inline bool PoolIdHasBeenSet() const { return m_poolIdHasBeenSet; } /** *

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.

*/ inline void SetPoolId(const Aws::String& value) { m_poolIdHasBeenSet = true; m_poolId = value; } /** *

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.

*/ inline void SetPoolId(Aws::String&& value) { m_poolIdHasBeenSet = true; m_poolId = std::move(value); } /** *

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.

*/ inline void SetPoolId(const char* value) { m_poolIdHasBeenSet = true; m_poolId.assign(value); } /** *

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.

*/ inline CreateTapesRequest& WithPoolId(const Aws::String& value) { SetPoolId(value); return *this;} /** *

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.

*/ inline CreateTapesRequest& WithPoolId(Aws::String&& value) { SetPoolId(std::move(value)); return *this;} /** *

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.

*/ inline CreateTapesRequest& WithPoolId(const char* value) { SetPoolId(value); return *this;} /** *

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

*/ inline bool GetWorm() const{ return m_worm; } /** *

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

*/ inline bool WormHasBeenSet() const { return m_wormHasBeenSet; } /** *

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

*/ inline void SetWorm(bool value) { m_wormHasBeenSet = true; m_worm = value; } /** *

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

*/ inline CreateTapesRequest& WithWorm(bool value) { SetWorm(value); return *this;} /** *

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.

*/ inline const Aws::Vector& GetTags() const{ return m_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.

*/ inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; } /** *

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.

*/ inline void SetTags(const Aws::Vector& value) { m_tagsHasBeenSet = true; m_tags = value; } /** *

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.

*/ inline void SetTags(Aws::Vector&& value) { m_tagsHasBeenSet = true; m_tags = std::move(value); } /** *

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.

*/ inline CreateTapesRequest& WithTags(const Aws::Vector& value) { SetTags(value); return *this;} /** *

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.

*/ inline CreateTapesRequest& WithTags(Aws::Vector&& value) { SetTags(std::move(value)); return *this;} /** *

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.

*/ inline CreateTapesRequest& AddTags(const Tag& value) { m_tagsHasBeenSet = true; m_tags.push_back(value); return *this; } /** *

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.

*/ inline CreateTapesRequest& AddTags(Tag&& value) { m_tagsHasBeenSet = true; m_tags.push_back(std::move(value)); return *this; } private: Aws::String m_gatewayARN; bool m_gatewayARNHasBeenSet = false; long long m_tapeSizeInBytes; bool m_tapeSizeInBytesHasBeenSet = false; Aws::String m_clientToken; bool m_clientTokenHasBeenSet = false; int m_numTapesToCreate; bool m_numTapesToCreateHasBeenSet = false; Aws::String m_tapeBarcodePrefix; bool m_tapeBarcodePrefixHasBeenSet = false; bool m_kMSEncrypted; bool m_kMSEncryptedHasBeenSet = false; Aws::String m_kMSKey; bool m_kMSKeyHasBeenSet = false; Aws::String m_poolId; bool m_poolIdHasBeenSet = false; bool m_worm; bool m_wormHasBeenSet = false; Aws::Vector m_tags; bool m_tagsHasBeenSet = false; }; } // namespace Model } // namespace StorageGateway } // namespace Aws