AWS SDK for C++  1.9.108
AWS SDK for C++
Public Member Functions | List of all members
Aws::FSx::Model::CreateBackupRequest Class Reference

#include <CreateBackupRequest.h>

+ Inheritance diagram for Aws::FSx::Model::CreateBackupRequest:

Public Member Functions

 CreateBackupRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetFileSystemId () const
 
bool FileSystemIdHasBeenSet () const
 
void SetFileSystemId (const Aws::String &value)
 
void SetFileSystemId (Aws::String &&value)
 
void SetFileSystemId (const char *value)
 
CreateBackupRequestWithFileSystemId (const Aws::String &value)
 
CreateBackupRequestWithFileSystemId (Aws::String &&value)
 
CreateBackupRequestWithFileSystemId (const char *value)
 
const Aws::StringGetClientRequestToken () const
 
bool ClientRequestTokenHasBeenSet () const
 
void SetClientRequestToken (const Aws::String &value)
 
void SetClientRequestToken (Aws::String &&value)
 
void SetClientRequestToken (const char *value)
 
CreateBackupRequestWithClientRequestToken (const Aws::String &value)
 
CreateBackupRequestWithClientRequestToken (Aws::String &&value)
 
CreateBackupRequestWithClientRequestToken (const char *value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
CreateBackupRequestWithTags (const Aws::Vector< Tag > &value)
 
CreateBackupRequestWithTags (Aws::Vector< Tag > &&value)
 
CreateBackupRequestAddTags (const Tag &value)
 
CreateBackupRequestAddTags (Tag &&value)
 
const Aws::StringGetVolumeId () const
 
bool VolumeIdHasBeenSet () const
 
void SetVolumeId (const Aws::String &value)
 
void SetVolumeId (Aws::String &&value)
 
void SetVolumeId (const char *value)
 
CreateBackupRequestWithVolumeId (const Aws::String &value)
 
CreateBackupRequestWithVolumeId (Aws::String &&value)
 
CreateBackupRequestWithVolumeId (const char *value)
 
- Public Member Functions inherited from Aws::FSx::FSxRequest
virtual ~FSxRequest ()
 
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

The request object for the CreateBackup operation.

See Also:

AWS API Reference

Definition at line 28 of file CreateBackupRequest.h.

Constructor & Destructor Documentation

◆ CreateBackupRequest()

Aws::FSx::Model::CreateBackupRequest::CreateBackupRequest ( )

Member Function Documentation

◆ AddTags() [1/2]

CreateBackupRequest& Aws::FSx::Model::CreateBackupRequest::AddTags ( const Tag value)
inline

(Optional) The tags to apply to the backup at backup creation. The key value of the Name tag appears in the console as the backup name. If you have set CopyTagsToBackups to true, and you specify one or more tags using the CreateBackup action, no existing file system tags are copied from the file system to the backup.

Definition at line 203 of file CreateBackupRequest.h.

◆ AddTags() [2/2]

CreateBackupRequest& Aws::FSx::Model::CreateBackupRequest::AddTags ( Tag &&  value)
inline

(Optional) The tags to apply to the backup at backup creation. The key value of the Name tag appears in the console as the backup name. If you have set CopyTagsToBackups to true, and you specify one or more tags using the CreateBackup action, no existing file system tags are copied from the file system to the backup.

Definition at line 212 of file CreateBackupRequest.h.

◆ ClientRequestTokenHasBeenSet()

bool Aws::FSx::Model::CreateBackupRequest::ClientRequestTokenHasBeenSet ( ) const
inline

(Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

Definition at line 97 of file CreateBackupRequest.h.

◆ FileSystemIdHasBeenSet()

bool Aws::FSx::Model::CreateBackupRequest::FileSystemIdHasBeenSet ( ) const
inline

The ID of the file system to back up.

Definition at line 52 of file CreateBackupRequest.h.

◆ GetClientRequestToken()

const Aws::String& Aws::FSx::Model::CreateBackupRequest::GetClientRequestToken ( ) const
inline

(Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

Definition at line 90 of file CreateBackupRequest.h.

◆ GetFileSystemId()

const Aws::String& Aws::FSx::Model::CreateBackupRequest::GetFileSystemId ( ) const
inline

The ID of the file system to back up.

Definition at line 47 of file CreateBackupRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::FSx::Model::CreateBackupRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::FSx::FSxRequest.

◆ GetServiceRequestName()

virtual const char* Aws::FSx::Model::CreateBackupRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 37 of file CreateBackupRequest.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::FSx::Model::CreateBackupRequest::GetTags ( ) const
inline

(Optional) The tags to apply to the backup at backup creation. The key value of the Name tag appears in the console as the backup name. If you have set CopyTagsToBackups to true, and you specify one or more tags using the CreateBackup action, no existing file system tags are copied from the file system to the backup.

Definition at line 149 of file CreateBackupRequest.h.

◆ GetVolumeId()

const Aws::String& Aws::FSx::Model::CreateBackupRequest::GetVolumeId ( ) const
inline

The ID of he FSx for NetApp ONTAP volume to back up.

Definition at line 218 of file CreateBackupRequest.h.

◆ SerializePayload()

Aws::String Aws::FSx::Model::CreateBackupRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetClientRequestToken() [1/3]

void Aws::FSx::Model::CreateBackupRequest::SetClientRequestToken ( Aws::String &&  value)
inline

(Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

Definition at line 111 of file CreateBackupRequest.h.

◆ SetClientRequestToken() [2/3]

void Aws::FSx::Model::CreateBackupRequest::SetClientRequestToken ( const Aws::String value)
inline

(Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

Definition at line 104 of file CreateBackupRequest.h.

◆ SetClientRequestToken() [3/3]

void Aws::FSx::Model::CreateBackupRequest::SetClientRequestToken ( const char *  value)
inline

(Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

Definition at line 118 of file CreateBackupRequest.h.

◆ SetFileSystemId() [1/3]

void Aws::FSx::Model::CreateBackupRequest::SetFileSystemId ( Aws::String &&  value)
inline

The ID of the file system to back up.

Definition at line 62 of file CreateBackupRequest.h.

◆ SetFileSystemId() [2/3]

void Aws::FSx::Model::CreateBackupRequest::SetFileSystemId ( const Aws::String value)
inline

The ID of the file system to back up.

Definition at line 57 of file CreateBackupRequest.h.

◆ SetFileSystemId() [3/3]

void Aws::FSx::Model::CreateBackupRequest::SetFileSystemId ( const char *  value)
inline

The ID of the file system to back up.

Definition at line 67 of file CreateBackupRequest.h.

◆ SetTags() [1/2]

void Aws::FSx::Model::CreateBackupRequest::SetTags ( Aws::Vector< Tag > &&  value)
inline

(Optional) The tags to apply to the backup at backup creation. The key value of the Name tag appears in the console as the backup name. If you have set CopyTagsToBackups to true, and you specify one or more tags using the CreateBackup action, no existing file system tags are copied from the file system to the backup.

Definition at line 176 of file CreateBackupRequest.h.

◆ SetTags() [2/2]

void Aws::FSx::Model::CreateBackupRequest::SetTags ( const Aws::Vector< Tag > &  value)
inline

(Optional) The tags to apply to the backup at backup creation. The key value of the Name tag appears in the console as the backup name. If you have set CopyTagsToBackups to true, and you specify one or more tags using the CreateBackup action, no existing file system tags are copied from the file system to the backup.

Definition at line 167 of file CreateBackupRequest.h.

◆ SetVolumeId() [1/3]

void Aws::FSx::Model::CreateBackupRequest::SetVolumeId ( Aws::String &&  value)
inline

The ID of he FSx for NetApp ONTAP volume to back up.

Definition at line 233 of file CreateBackupRequest.h.

◆ SetVolumeId() [2/3]

void Aws::FSx::Model::CreateBackupRequest::SetVolumeId ( const Aws::String value)
inline

The ID of he FSx for NetApp ONTAP volume to back up.

Definition at line 228 of file CreateBackupRequest.h.

◆ SetVolumeId() [3/3]

void Aws::FSx::Model::CreateBackupRequest::SetVolumeId ( const char *  value)
inline

The ID of he FSx for NetApp ONTAP volume to back up.

Definition at line 238 of file CreateBackupRequest.h.

◆ TagsHasBeenSet()

bool Aws::FSx::Model::CreateBackupRequest::TagsHasBeenSet ( ) const
inline

(Optional) The tags to apply to the backup at backup creation. The key value of the Name tag appears in the console as the backup name. If you have set CopyTagsToBackups to true, and you specify one or more tags using the CreateBackup action, no existing file system tags are copied from the file system to the backup.

Definition at line 158 of file CreateBackupRequest.h.

◆ VolumeIdHasBeenSet()

bool Aws::FSx::Model::CreateBackupRequest::VolumeIdHasBeenSet ( ) const
inline

The ID of he FSx for NetApp ONTAP volume to back up.

Definition at line 223 of file CreateBackupRequest.h.

◆ WithClientRequestToken() [1/3]

CreateBackupRequest& Aws::FSx::Model::CreateBackupRequest::WithClientRequestToken ( Aws::String &&  value)
inline

(Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

Definition at line 132 of file CreateBackupRequest.h.

◆ WithClientRequestToken() [2/3]

CreateBackupRequest& Aws::FSx::Model::CreateBackupRequest::WithClientRequestToken ( const Aws::String value)
inline

(Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

Definition at line 125 of file CreateBackupRequest.h.

◆ WithClientRequestToken() [3/3]

CreateBackupRequest& Aws::FSx::Model::CreateBackupRequest::WithClientRequestToken ( const char *  value)
inline

(Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

Definition at line 139 of file CreateBackupRequest.h.

◆ WithFileSystemId() [1/3]

CreateBackupRequest& Aws::FSx::Model::CreateBackupRequest::WithFileSystemId ( Aws::String &&  value)
inline

The ID of the file system to back up.

Definition at line 77 of file CreateBackupRequest.h.

◆ WithFileSystemId() [2/3]

CreateBackupRequest& Aws::FSx::Model::CreateBackupRequest::WithFileSystemId ( const Aws::String value)
inline

The ID of the file system to back up.

Definition at line 72 of file CreateBackupRequest.h.

◆ WithFileSystemId() [3/3]

CreateBackupRequest& Aws::FSx::Model::CreateBackupRequest::WithFileSystemId ( const char *  value)
inline

The ID of the file system to back up.

Definition at line 82 of file CreateBackupRequest.h.

◆ WithTags() [1/2]

CreateBackupRequest& Aws::FSx::Model::CreateBackupRequest::WithTags ( Aws::Vector< Tag > &&  value)
inline

(Optional) The tags to apply to the backup at backup creation. The key value of the Name tag appears in the console as the backup name. If you have set CopyTagsToBackups to true, and you specify one or more tags using the CreateBackup action, no existing file system tags are copied from the file system to the backup.

Definition at line 194 of file CreateBackupRequest.h.

◆ WithTags() [2/2]

CreateBackupRequest& Aws::FSx::Model::CreateBackupRequest::WithTags ( const Aws::Vector< Tag > &  value)
inline

(Optional) The tags to apply to the backup at backup creation. The key value of the Name tag appears in the console as the backup name. If you have set CopyTagsToBackups to true, and you specify one or more tags using the CreateBackup action, no existing file system tags are copied from the file system to the backup.

Definition at line 185 of file CreateBackupRequest.h.

◆ WithVolumeId() [1/3]

CreateBackupRequest& Aws::FSx::Model::CreateBackupRequest::WithVolumeId ( Aws::String &&  value)
inline

The ID of he FSx for NetApp ONTAP volume to back up.

Definition at line 248 of file CreateBackupRequest.h.

◆ WithVolumeId() [2/3]

CreateBackupRequest& Aws::FSx::Model::CreateBackupRequest::WithVolumeId ( const Aws::String value)
inline

The ID of he FSx for NetApp ONTAP volume to back up.

Definition at line 243 of file CreateBackupRequest.h.

◆ WithVolumeId() [3/3]

CreateBackupRequest& Aws::FSx::Model::CreateBackupRequest::WithVolumeId ( const char *  value)
inline

The ID of he FSx for NetApp ONTAP volume to back up.

Definition at line 253 of file CreateBackupRequest.h.


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