AWS SDK for C++  1.8.98
AWS SDK for C++
Public Member Functions | List of all members
Aws::StorageGateway::Model::CreateTapesRequest Class Reference

#include <CreateTapesRequest.h>

+ Inheritance diagram for Aws::StorageGateway::Model::CreateTapesRequest:

Public Member Functions

 CreateTapesRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetGatewayARN () const
 
bool GatewayARNHasBeenSet () const
 
void SetGatewayARN (const Aws::String &value)
 
void SetGatewayARN (Aws::String &&value)
 
void SetGatewayARN (const char *value)
 
CreateTapesRequestWithGatewayARN (const Aws::String &value)
 
CreateTapesRequestWithGatewayARN (Aws::String &&value)
 
CreateTapesRequestWithGatewayARN (const char *value)
 
long long GetTapeSizeInBytes () const
 
bool TapeSizeInBytesHasBeenSet () const
 
void SetTapeSizeInBytes (long long value)
 
CreateTapesRequestWithTapeSizeInBytes (long long value)
 
const Aws::StringGetClientToken () const
 
bool ClientTokenHasBeenSet () const
 
void SetClientToken (const Aws::String &value)
 
void SetClientToken (Aws::String &&value)
 
void SetClientToken (const char *value)
 
CreateTapesRequestWithClientToken (const Aws::String &value)
 
CreateTapesRequestWithClientToken (Aws::String &&value)
 
CreateTapesRequestWithClientToken (const char *value)
 
int GetNumTapesToCreate () const
 
bool NumTapesToCreateHasBeenSet () const
 
void SetNumTapesToCreate (int value)
 
CreateTapesRequestWithNumTapesToCreate (int value)
 
const Aws::StringGetTapeBarcodePrefix () const
 
bool TapeBarcodePrefixHasBeenSet () const
 
void SetTapeBarcodePrefix (const Aws::String &value)
 
void SetTapeBarcodePrefix (Aws::String &&value)
 
void SetTapeBarcodePrefix (const char *value)
 
CreateTapesRequestWithTapeBarcodePrefix (const Aws::String &value)
 
CreateTapesRequestWithTapeBarcodePrefix (Aws::String &&value)
 
CreateTapesRequestWithTapeBarcodePrefix (const char *value)
 
bool GetKMSEncrypted () const
 
bool KMSEncryptedHasBeenSet () const
 
void SetKMSEncrypted (bool value)
 
CreateTapesRequestWithKMSEncrypted (bool value)
 
const Aws::StringGetKMSKey () const
 
bool KMSKeyHasBeenSet () const
 
void SetKMSKey (const Aws::String &value)
 
void SetKMSKey (Aws::String &&value)
 
void SetKMSKey (const char *value)
 
CreateTapesRequestWithKMSKey (const Aws::String &value)
 
CreateTapesRequestWithKMSKey (Aws::String &&value)
 
CreateTapesRequestWithKMSKey (const char *value)
 
const Aws::StringGetPoolId () const
 
bool PoolIdHasBeenSet () const
 
void SetPoolId (const Aws::String &value)
 
void SetPoolId (Aws::String &&value)
 
void SetPoolId (const char *value)
 
CreateTapesRequestWithPoolId (const Aws::String &value)
 
CreateTapesRequestWithPoolId (Aws::String &&value)
 
CreateTapesRequestWithPoolId (const char *value)
 
bool GetWorm () const
 
bool WormHasBeenSet () const
 
void SetWorm (bool value)
 
CreateTapesRequestWithWorm (bool value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
CreateTapesRequestWithTags (const Aws::Vector< Tag > &value)
 
CreateTapesRequestWithTags (Aws::Vector< Tag > &&value)
 
CreateTapesRequestAddTags (const Tag &value)
 
CreateTapesRequestAddTags (Tag &&value)
 
- Public Member Functions inherited from Aws::StorageGateway::StorageGatewayRequest
virtual ~StorageGatewayRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

CreateTapesInput

See Also:

AWS API Reference

Definition at line 26 of file CreateTapesRequest.h.

Constructor & Destructor Documentation

◆ CreateTapesRequest()

Aws::StorageGateway::Model::CreateTapesRequest::CreateTapesRequest ( )

Member Function Documentation

◆ AddTags() [1/2]

CreateTapesRequest& Aws::StorageGateway::Model::CreateTapesRequest::AddTags ( const Tag value)
inline

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.

Definition at line 536 of file CreateTapesRequest.h.

◆ AddTags() [2/2]

CreateTapesRequest& Aws::StorageGateway::Model::CreateTapesRequest::AddTags ( Tag &&  value)
inline

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.

Definition at line 545 of file CreateTapesRequest.h.

◆ ClientTokenHasBeenSet()

bool Aws::StorageGateway::Model::CreateTapesRequest::ClientTokenHasBeenSet ( ) const
inline

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.

Definition at line 138 of file CreateTapesRequest.h.

◆ GatewayARNHasBeenSet()

bool Aws::StorageGateway::Model::CreateTapesRequest::GatewayARNHasBeenSet ( ) const
inline

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.

Definition at line 54 of file CreateTapesRequest.h.

◆ GetClientToken()

const Aws::String& Aws::StorageGateway::Model::CreateTapesRequest::GetClientToken ( ) const
inline

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.

Definition at line 130 of file CreateTapesRequest.h.

◆ GetGatewayARN()

const Aws::String& Aws::StorageGateway::Model::CreateTapesRequest::GetGatewayARN ( ) const
inline

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.

Definition at line 47 of file CreateTapesRequest.h.

◆ GetKMSEncrypted()

bool Aws::StorageGateway::Model::CreateTapesRequest::GetKMSEncrypted ( ) const
inline

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

Definition at line 280 of file CreateTapesRequest.h.

◆ GetKMSKey()

const Aws::String& Aws::StorageGateway::Model::CreateTapesRequest::GetKMSKey ( ) const
inline

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.

Definition at line 310 of file CreateTapesRequest.h.

◆ GetNumTapesToCreate()

int Aws::StorageGateway::Model::CreateTapesRequest::GetNumTapesToCreate ( ) const
inline

The number of virtual tapes that you want to create.

Definition at line 192 of file CreateTapesRequest.h.

◆ GetPoolId()

const Aws::String& Aws::StorageGateway::Model::CreateTapesRequest::GetPoolId ( ) const
inline

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

Definition at line 377 of file CreateTapesRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::StorageGateway::Model::CreateTapesRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetServiceRequestName()

virtual const char* Aws::StorageGateway::Model::CreateTapesRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file CreateTapesRequest.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::StorageGateway::Model::CreateTapesRequest::GetTags ( ) const
inline

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.

Definition at line 482 of file CreateTapesRequest.h.

◆ GetTapeBarcodePrefix()

const Aws::String& Aws::StorageGateway::Model::CreateTapesRequest::GetTapeBarcodePrefix ( ) const
inline

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.

Definition at line 216 of file CreateTapesRequest.h.

◆ GetTapeSizeInBytes()

long long Aws::StorageGateway::Model::CreateTapesRequest::GetTapeSizeInBytes ( ) const
inline

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

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

Definition at line 103 of file CreateTapesRequest.h.

◆ GetWorm()

bool Aws::StorageGateway::Model::CreateTapesRequest::GetWorm ( ) const
inline

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

Definition at line 454 of file CreateTapesRequest.h.

◆ KMSEncryptedHasBeenSet()

bool Aws::StorageGateway::Model::CreateTapesRequest::KMSEncryptedHasBeenSet ( ) const
inline

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

Definition at line 287 of file CreateTapesRequest.h.

◆ KMSKeyHasBeenSet()

bool Aws::StorageGateway::Model::CreateTapesRequest::KMSKeyHasBeenSet ( ) const
inline

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.

Definition at line 318 of file CreateTapesRequest.h.

◆ NumTapesToCreateHasBeenSet()

bool Aws::StorageGateway::Model::CreateTapesRequest::NumTapesToCreateHasBeenSet ( ) const
inline

The number of virtual tapes that you want to create.

Definition at line 197 of file CreateTapesRequest.h.

◆ PoolIdHasBeenSet()

bool Aws::StorageGateway::Model::CreateTapesRequest::PoolIdHasBeenSet ( ) const
inline

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

Definition at line 387 of file CreateTapesRequest.h.

◆ SerializePayload()

Aws::String Aws::StorageGateway::Model::CreateTapesRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetClientToken() [1/3]

void Aws::StorageGateway::Model::CreateTapesRequest::SetClientToken ( const Aws::String value)
inline

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.

Definition at line 146 of file CreateTapesRequest.h.

◆ SetClientToken() [2/3]

void Aws::StorageGateway::Model::CreateTapesRequest::SetClientToken ( Aws::String &&  value)
inline

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.

Definition at line 154 of file CreateTapesRequest.h.

◆ SetClientToken() [3/3]

void Aws::StorageGateway::Model::CreateTapesRequest::SetClientToken ( const char *  value)
inline

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.

Definition at line 162 of file CreateTapesRequest.h.

◆ SetGatewayARN() [1/3]

void Aws::StorageGateway::Model::CreateTapesRequest::SetGatewayARN ( const Aws::String value)
inline

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.

Definition at line 61 of file CreateTapesRequest.h.

◆ SetGatewayARN() [2/3]

void Aws::StorageGateway::Model::CreateTapesRequest::SetGatewayARN ( Aws::String &&  value)
inline

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.

Definition at line 68 of file CreateTapesRequest.h.

◆ SetGatewayARN() [3/3]

void Aws::StorageGateway::Model::CreateTapesRequest::SetGatewayARN ( const char *  value)
inline

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.

Definition at line 75 of file CreateTapesRequest.h.

◆ SetKMSEncrypted()

void Aws::StorageGateway::Model::CreateTapesRequest::SetKMSEncrypted ( bool  value)
inline

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

Definition at line 294 of file CreateTapesRequest.h.

◆ SetKMSKey() [1/3]

void Aws::StorageGateway::Model::CreateTapesRequest::SetKMSKey ( const Aws::String value)
inline

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.

Definition at line 326 of file CreateTapesRequest.h.

◆ SetKMSKey() [2/3]

void Aws::StorageGateway::Model::CreateTapesRequest::SetKMSKey ( Aws::String &&  value)
inline

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.

Definition at line 334 of file CreateTapesRequest.h.

◆ SetKMSKey() [3/3]

void Aws::StorageGateway::Model::CreateTapesRequest::SetKMSKey ( const char *  value)
inline

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.

Definition at line 342 of file CreateTapesRequest.h.

◆ SetNumTapesToCreate()

void Aws::StorageGateway::Model::CreateTapesRequest::SetNumTapesToCreate ( int  value)
inline

The number of virtual tapes that you want to create.

Definition at line 202 of file CreateTapesRequest.h.

◆ SetPoolId() [1/3]

void Aws::StorageGateway::Model::CreateTapesRequest::SetPoolId ( const Aws::String value)
inline

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

Definition at line 397 of file CreateTapesRequest.h.

◆ SetPoolId() [2/3]

void Aws::StorageGateway::Model::CreateTapesRequest::SetPoolId ( Aws::String &&  value)
inline

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

Definition at line 407 of file CreateTapesRequest.h.

◆ SetPoolId() [3/3]

void Aws::StorageGateway::Model::CreateTapesRequest::SetPoolId ( const char *  value)
inline

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

Definition at line 417 of file CreateTapesRequest.h.

◆ SetTags() [1/2]

void Aws::StorageGateway::Model::CreateTapesRequest::SetTags ( const Aws::Vector< Tag > &  value)
inline

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.

Definition at line 500 of file CreateTapesRequest.h.

◆ SetTags() [2/2]

void Aws::StorageGateway::Model::CreateTapesRequest::SetTags ( Aws::Vector< Tag > &&  value)
inline

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.

Definition at line 509 of file CreateTapesRequest.h.

◆ SetTapeBarcodePrefix() [1/3]

void Aws::StorageGateway::Model::CreateTapesRequest::SetTapeBarcodePrefix ( const Aws::String value)
inline

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.

Definition at line 232 of file CreateTapesRequest.h.

◆ SetTapeBarcodePrefix() [2/3]

void Aws::StorageGateway::Model::CreateTapesRequest::SetTapeBarcodePrefix ( Aws::String &&  value)
inline

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.

Definition at line 240 of file CreateTapesRequest.h.

◆ SetTapeBarcodePrefix() [3/3]

void Aws::StorageGateway::Model::CreateTapesRequest::SetTapeBarcodePrefix ( const char *  value)
inline

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.

Definition at line 248 of file CreateTapesRequest.h.

◆ SetTapeSizeInBytes()

void Aws::StorageGateway::Model::CreateTapesRequest::SetTapeSizeInBytes ( long long  value)
inline

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

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

Definition at line 115 of file CreateTapesRequest.h.

◆ SetWorm()

void Aws::StorageGateway::Model::CreateTapesRequest::SetWorm ( bool  value)
inline

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

Definition at line 466 of file CreateTapesRequest.h.

◆ TagsHasBeenSet()

bool Aws::StorageGateway::Model::CreateTapesRequest::TagsHasBeenSet ( ) const
inline

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.

Definition at line 491 of file CreateTapesRequest.h.

◆ TapeBarcodePrefixHasBeenSet()

bool Aws::StorageGateway::Model::CreateTapesRequest::TapeBarcodePrefixHasBeenSet ( ) const
inline

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.

Definition at line 224 of file CreateTapesRequest.h.

◆ TapeSizeInBytesHasBeenSet()

bool Aws::StorageGateway::Model::CreateTapesRequest::TapeSizeInBytesHasBeenSet ( ) const
inline

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

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

Definition at line 109 of file CreateTapesRequest.h.

◆ WithClientToken() [1/3]

CreateTapesRequest& Aws::StorageGateway::Model::CreateTapesRequest::WithClientToken ( const Aws::String value)
inline

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.

Definition at line 170 of file CreateTapesRequest.h.

◆ WithClientToken() [2/3]

CreateTapesRequest& Aws::StorageGateway::Model::CreateTapesRequest::WithClientToken ( Aws::String &&  value)
inline

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.

Definition at line 178 of file CreateTapesRequest.h.

◆ WithClientToken() [3/3]

CreateTapesRequest& Aws::StorageGateway::Model::CreateTapesRequest::WithClientToken ( const char *  value)
inline

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.

Definition at line 186 of file CreateTapesRequest.h.

◆ WithGatewayARN() [1/3]

CreateTapesRequest& Aws::StorageGateway::Model::CreateTapesRequest::WithGatewayARN ( const Aws::String value)
inline

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.

Definition at line 82 of file CreateTapesRequest.h.

◆ WithGatewayARN() [2/3]

CreateTapesRequest& Aws::StorageGateway::Model::CreateTapesRequest::WithGatewayARN ( Aws::String &&  value)
inline

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.

Definition at line 89 of file CreateTapesRequest.h.

◆ WithGatewayARN() [3/3]

CreateTapesRequest& Aws::StorageGateway::Model::CreateTapesRequest::WithGatewayARN ( const char *  value)
inline

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.

Definition at line 96 of file CreateTapesRequest.h.

◆ WithKMSEncrypted()

CreateTapesRequest& Aws::StorageGateway::Model::CreateTapesRequest::WithKMSEncrypted ( bool  value)
inline

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

Definition at line 301 of file CreateTapesRequest.h.

◆ WithKMSKey() [1/3]

CreateTapesRequest& Aws::StorageGateway::Model::CreateTapesRequest::WithKMSKey ( const Aws::String value)
inline

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.

Definition at line 350 of file CreateTapesRequest.h.

◆ WithKMSKey() [2/3]

CreateTapesRequest& Aws::StorageGateway::Model::CreateTapesRequest::WithKMSKey ( Aws::String &&  value)
inline

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.

Definition at line 358 of file CreateTapesRequest.h.

◆ WithKMSKey() [3/3]

CreateTapesRequest& Aws::StorageGateway::Model::CreateTapesRequest::WithKMSKey ( const char *  value)
inline

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.

Definition at line 366 of file CreateTapesRequest.h.

◆ WithNumTapesToCreate()

CreateTapesRequest& Aws::StorageGateway::Model::CreateTapesRequest::WithNumTapesToCreate ( int  value)
inline

The number of virtual tapes that you want to create.

Definition at line 207 of file CreateTapesRequest.h.

◆ WithPoolId() [1/3]

CreateTapesRequest& Aws::StorageGateway::Model::CreateTapesRequest::WithPoolId ( const Aws::String value)
inline

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

Definition at line 427 of file CreateTapesRequest.h.

◆ WithPoolId() [2/3]

CreateTapesRequest& Aws::StorageGateway::Model::CreateTapesRequest::WithPoolId ( Aws::String &&  value)
inline

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

Definition at line 437 of file CreateTapesRequest.h.

◆ WithPoolId() [3/3]

CreateTapesRequest& Aws::StorageGateway::Model::CreateTapesRequest::WithPoolId ( const char *  value)
inline

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

Definition at line 447 of file CreateTapesRequest.h.

◆ WithTags() [1/2]

CreateTapesRequest& Aws::StorageGateway::Model::CreateTapesRequest::WithTags ( const Aws::Vector< Tag > &  value)
inline

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.

Definition at line 518 of file CreateTapesRequest.h.

◆ WithTags() [2/2]

CreateTapesRequest& Aws::StorageGateway::Model::CreateTapesRequest::WithTags ( Aws::Vector< Tag > &&  value)
inline

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.

Definition at line 527 of file CreateTapesRequest.h.

◆ WithTapeBarcodePrefix() [1/3]

CreateTapesRequest& Aws::StorageGateway::Model::CreateTapesRequest::WithTapeBarcodePrefix ( const Aws::String value)
inline

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.

Definition at line 256 of file CreateTapesRequest.h.

◆ WithTapeBarcodePrefix() [2/3]

CreateTapesRequest& Aws::StorageGateway::Model::CreateTapesRequest::WithTapeBarcodePrefix ( Aws::String &&  value)
inline

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.

Definition at line 264 of file CreateTapesRequest.h.

◆ WithTapeBarcodePrefix() [3/3]

CreateTapesRequest& Aws::StorageGateway::Model::CreateTapesRequest::WithTapeBarcodePrefix ( const char *  value)
inline

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.

Definition at line 272 of file CreateTapesRequest.h.

◆ WithTapeSizeInBytes()

CreateTapesRequest& Aws::StorageGateway::Model::CreateTapesRequest::WithTapeSizeInBytes ( long long  value)
inline

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

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

Definition at line 121 of file CreateTapesRequest.h.

◆ WithWorm()

CreateTapesRequest& Aws::StorageGateway::Model::CreateTapesRequest::WithWorm ( bool  value)
inline

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

Definition at line 472 of file CreateTapesRequest.h.

◆ WormHasBeenSet()

bool Aws::StorageGateway::Model::CreateTapesRequest::WormHasBeenSet ( ) const
inline

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

Definition at line 460 of file CreateTapesRequest.h.


The documentation for this class was generated from the following file: