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

#include <CopyBackupRequest.h>

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

Public Member Functions

 CopyBackupRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetClientRequestToken () const
 
bool ClientRequestTokenHasBeenSet () const
 
void SetClientRequestToken (const Aws::String &value)
 
void SetClientRequestToken (Aws::String &&value)
 
void SetClientRequestToken (const char *value)
 
CopyBackupRequestWithClientRequestToken (const Aws::String &value)
 
CopyBackupRequestWithClientRequestToken (Aws::String &&value)
 
CopyBackupRequestWithClientRequestToken (const char *value)
 
const Aws::StringGetSourceBackupId () const
 
bool SourceBackupIdHasBeenSet () const
 
void SetSourceBackupId (const Aws::String &value)
 
void SetSourceBackupId (Aws::String &&value)
 
void SetSourceBackupId (const char *value)
 
CopyBackupRequestWithSourceBackupId (const Aws::String &value)
 
CopyBackupRequestWithSourceBackupId (Aws::String &&value)
 
CopyBackupRequestWithSourceBackupId (const char *value)
 
const Aws::StringGetSourceRegion () const
 
bool SourceRegionHasBeenSet () const
 
void SetSourceRegion (const Aws::String &value)
 
void SetSourceRegion (Aws::String &&value)
 
void SetSourceRegion (const char *value)
 
CopyBackupRequestWithSourceRegion (const Aws::String &value)
 
CopyBackupRequestWithSourceRegion (Aws::String &&value)
 
CopyBackupRequestWithSourceRegion (const char *value)
 
const Aws::StringGetKmsKeyId () const
 
bool KmsKeyIdHasBeenSet () const
 
void SetKmsKeyId (const Aws::String &value)
 
void SetKmsKeyId (Aws::String &&value)
 
void SetKmsKeyId (const char *value)
 
CopyBackupRequestWithKmsKeyId (const Aws::String &value)
 
CopyBackupRequestWithKmsKeyId (Aws::String &&value)
 
CopyBackupRequestWithKmsKeyId (const char *value)
 
bool GetCopyTags () const
 
bool CopyTagsHasBeenSet () const
 
void SetCopyTags (bool value)
 
CopyBackupRequestWithCopyTags (bool value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
CopyBackupRequestWithTags (const Aws::Vector< Tag > &value)
 
CopyBackupRequestWithTags (Aws::Vector< Tag > &&value)
 
CopyBackupRequestAddTags (const Tag &value)
 
CopyBackupRequestAddTags (Tag &&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

Definition at line 24 of file CopyBackupRequest.h.

Constructor & Destructor Documentation

◆ CopyBackupRequest()

Aws::FSx::Model::CopyBackupRequest::CopyBackupRequest ( )

Member Function Documentation

◆ AddTags() [1/2]

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

Definition at line 280 of file CopyBackupRequest.h.

◆ AddTags() [2/2]

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

Definition at line 283 of file CopyBackupRequest.h.

◆ ClientRequestTokenHasBeenSet()

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

Definition at line 44 of file CopyBackupRequest.h.

◆ CopyTagsHasBeenSet()

bool Aws::FSx::Model::CopyBackupRequest::CopyTagsHasBeenSet ( ) const
inline

A boolean flag indicating whether tags from the source backup should be copied to the backup copy. This value defaults to false.

If you set CopyTags to true and the source backup has existing tags, you can use the Tags parameter to create new tags, provided that the sum of the source backup tags and the new tags doesn't exceed 50. Both sets of tags are merged. If there are tag conflicts (for example, two tags with the same key but different values), the tags created with the Tags parameter take precedence.

Definition at line 234 of file CopyBackupRequest.h.

◆ GetClientRequestToken()

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

Definition at line 41 of file CopyBackupRequest.h.

◆ GetCopyTags()

bool Aws::FSx::Model::CopyBackupRequest::GetCopyTags ( ) const
inline

A boolean flag indicating whether tags from the source backup should be copied to the backup copy. This value defaults to false.

If you set CopyTags to true and the source backup has existing tags, you can use the Tags parameter to create new tags, provided that the sum of the source backup tags and the new tags doesn't exceed 50. Both sets of tags are merged. If there are tag conflicts (for example, two tags with the same key but different values), the tags created with the Tags parameter take precedence.

Definition at line 222 of file CopyBackupRequest.h.

◆ GetKmsKeyId()

const Aws::String& Aws::FSx::Model::CopyBackupRequest::GetKmsKeyId ( ) const
inline

Definition at line 188 of file CopyBackupRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::FSx::FSxRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file CopyBackupRequest.h.

◆ GetSourceBackupId()

const Aws::String& Aws::FSx::Model::CopyBackupRequest::GetSourceBackupId ( ) const
inline

The ID of the source backup. Specifies the ID of the backup that is being copied.

Definition at line 69 of file CopyBackupRequest.h.

◆ GetSourceRegion()

const Aws::String& Aws::FSx::Model::CopyBackupRequest::GetSourceRegion ( ) const
inline

The source Amazon Web Services Region of the backup. Specifies the Amazon Web Services Region from which the backup is being copied. The source and destination Regions must be in the same Amazon Web Services partition. If you don't specify a Region, it defaults to the Region where the request is sent from (in-Region copy).

Definition at line 121 of file CopyBackupRequest.h.

◆ GetTags()

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

Definition at line 262 of file CopyBackupRequest.h.

◆ KmsKeyIdHasBeenSet()

bool Aws::FSx::Model::CopyBackupRequest::KmsKeyIdHasBeenSet ( ) const
inline

Definition at line 191 of file CopyBackupRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetClientRequestToken() [1/3]

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

Definition at line 50 of file CopyBackupRequest.h.

◆ SetClientRequestToken() [2/3]

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

Definition at line 47 of file CopyBackupRequest.h.

◆ SetClientRequestToken() [3/3]

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

Definition at line 53 of file CopyBackupRequest.h.

◆ SetCopyTags()

void Aws::FSx::Model::CopyBackupRequest::SetCopyTags ( bool  value)
inline

A boolean flag indicating whether tags from the source backup should be copied to the backup copy. This value defaults to false.

If you set CopyTags to true and the source backup has existing tags, you can use the Tags parameter to create new tags, provided that the sum of the source backup tags and the new tags doesn't exceed 50. Both sets of tags are merged. If there are tag conflicts (for example, two tags with the same key but different values), the tags created with the Tags parameter take precedence.

Definition at line 246 of file CopyBackupRequest.h.

◆ SetKmsKeyId() [1/3]

void Aws::FSx::Model::CopyBackupRequest::SetKmsKeyId ( Aws::String &&  value)
inline

Definition at line 197 of file CopyBackupRequest.h.

◆ SetKmsKeyId() [2/3]

void Aws::FSx::Model::CopyBackupRequest::SetKmsKeyId ( const Aws::String value)
inline

Definition at line 194 of file CopyBackupRequest.h.

◆ SetKmsKeyId() [3/3]

void Aws::FSx::Model::CopyBackupRequest::SetKmsKeyId ( const char *  value)
inline

Definition at line 200 of file CopyBackupRequest.h.

◆ SetSourceBackupId() [1/3]

void Aws::FSx::Model::CopyBackupRequest::SetSourceBackupId ( Aws::String &&  value)
inline

The ID of the source backup. Specifies the ID of the backup that is being copied.

Definition at line 87 of file CopyBackupRequest.h.

◆ SetSourceBackupId() [2/3]

void Aws::FSx::Model::CopyBackupRequest::SetSourceBackupId ( const Aws::String value)
inline

The ID of the source backup. Specifies the ID of the backup that is being copied.

Definition at line 81 of file CopyBackupRequest.h.

◆ SetSourceBackupId() [3/3]

void Aws::FSx::Model::CopyBackupRequest::SetSourceBackupId ( const char *  value)
inline

The ID of the source backup. Specifies the ID of the backup that is being copied.

Definition at line 93 of file CopyBackupRequest.h.

◆ SetSourceRegion() [1/3]

void Aws::FSx::Model::CopyBackupRequest::SetSourceRegion ( Aws::String &&  value)
inline

The source Amazon Web Services Region of the backup. Specifies the Amazon Web Services Region from which the backup is being copied. The source and destination Regions must be in the same Amazon Web Services partition. If you don't specify a Region, it defaults to the Region where the request is sent from (in-Region copy).

Definition at line 148 of file CopyBackupRequest.h.

◆ SetSourceRegion() [2/3]

void Aws::FSx::Model::CopyBackupRequest::SetSourceRegion ( const Aws::String value)
inline

The source Amazon Web Services Region of the backup. Specifies the Amazon Web Services Region from which the backup is being copied. The source and destination Regions must be in the same Amazon Web Services partition. If you don't specify a Region, it defaults to the Region where the request is sent from (in-Region copy).

Definition at line 139 of file CopyBackupRequest.h.

◆ SetSourceRegion() [3/3]

void Aws::FSx::Model::CopyBackupRequest::SetSourceRegion ( const char *  value)
inline

The source Amazon Web Services Region of the backup. Specifies the Amazon Web Services Region from which the backup is being copied. The source and destination Regions must be in the same Amazon Web Services partition. If you don't specify a Region, it defaults to the Region where the request is sent from (in-Region copy).

Definition at line 157 of file CopyBackupRequest.h.

◆ SetTags() [1/2]

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

Definition at line 271 of file CopyBackupRequest.h.

◆ SetTags() [2/2]

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

Definition at line 268 of file CopyBackupRequest.h.

◆ SourceBackupIdHasBeenSet()

bool Aws::FSx::Model::CopyBackupRequest::SourceBackupIdHasBeenSet ( ) const
inline

The ID of the source backup. Specifies the ID of the backup that is being copied.

Definition at line 75 of file CopyBackupRequest.h.

◆ SourceRegionHasBeenSet()

bool Aws::FSx::Model::CopyBackupRequest::SourceRegionHasBeenSet ( ) const
inline

The source Amazon Web Services Region of the backup. Specifies the Amazon Web Services Region from which the backup is being copied. The source and destination Regions must be in the same Amazon Web Services partition. If you don't specify a Region, it defaults to the Region where the request is sent from (in-Region copy).

Definition at line 130 of file CopyBackupRequest.h.

◆ TagsHasBeenSet()

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

Definition at line 265 of file CopyBackupRequest.h.

◆ WithClientRequestToken() [1/3]

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

Definition at line 59 of file CopyBackupRequest.h.

◆ WithClientRequestToken() [2/3]

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

Definition at line 56 of file CopyBackupRequest.h.

◆ WithClientRequestToken() [3/3]

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

Definition at line 62 of file CopyBackupRequest.h.

◆ WithCopyTags()

CopyBackupRequest& Aws::FSx::Model::CopyBackupRequest::WithCopyTags ( bool  value)
inline

A boolean flag indicating whether tags from the source backup should be copied to the backup copy. This value defaults to false.

If you set CopyTags to true and the source backup has existing tags, you can use the Tags parameter to create new tags, provided that the sum of the source backup tags and the new tags doesn't exceed 50. Both sets of tags are merged. If there are tag conflicts (for example, two tags with the same key but different values), the tags created with the Tags parameter take precedence.

Definition at line 258 of file CopyBackupRequest.h.

◆ WithKmsKeyId() [1/3]

CopyBackupRequest& Aws::FSx::Model::CopyBackupRequest::WithKmsKeyId ( Aws::String &&  value)
inline

Definition at line 206 of file CopyBackupRequest.h.

◆ WithKmsKeyId() [2/3]

CopyBackupRequest& Aws::FSx::Model::CopyBackupRequest::WithKmsKeyId ( const Aws::String value)
inline

Definition at line 203 of file CopyBackupRequest.h.

◆ WithKmsKeyId() [3/3]

CopyBackupRequest& Aws::FSx::Model::CopyBackupRequest::WithKmsKeyId ( const char *  value)
inline

Definition at line 209 of file CopyBackupRequest.h.

◆ WithSourceBackupId() [1/3]

CopyBackupRequest& Aws::FSx::Model::CopyBackupRequest::WithSourceBackupId ( Aws::String &&  value)
inline

The ID of the source backup. Specifies the ID of the backup that is being copied.

Definition at line 105 of file CopyBackupRequest.h.

◆ WithSourceBackupId() [2/3]

CopyBackupRequest& Aws::FSx::Model::CopyBackupRequest::WithSourceBackupId ( const Aws::String value)
inline

The ID of the source backup. Specifies the ID of the backup that is being copied.

Definition at line 99 of file CopyBackupRequest.h.

◆ WithSourceBackupId() [3/3]

CopyBackupRequest& Aws::FSx::Model::CopyBackupRequest::WithSourceBackupId ( const char *  value)
inline

The ID of the source backup. Specifies the ID of the backup that is being copied.

Definition at line 111 of file CopyBackupRequest.h.

◆ WithSourceRegion() [1/3]

CopyBackupRequest& Aws::FSx::Model::CopyBackupRequest::WithSourceRegion ( Aws::String &&  value)
inline

The source Amazon Web Services Region of the backup. Specifies the Amazon Web Services Region from which the backup is being copied. The source and destination Regions must be in the same Amazon Web Services partition. If you don't specify a Region, it defaults to the Region where the request is sent from (in-Region copy).

Definition at line 175 of file CopyBackupRequest.h.

◆ WithSourceRegion() [2/3]

CopyBackupRequest& Aws::FSx::Model::CopyBackupRequest::WithSourceRegion ( const Aws::String value)
inline

The source Amazon Web Services Region of the backup. Specifies the Amazon Web Services Region from which the backup is being copied. The source and destination Regions must be in the same Amazon Web Services partition. If you don't specify a Region, it defaults to the Region where the request is sent from (in-Region copy).

Definition at line 166 of file CopyBackupRequest.h.

◆ WithSourceRegion() [3/3]

CopyBackupRequest& Aws::FSx::Model::CopyBackupRequest::WithSourceRegion ( const char *  value)
inline

The source Amazon Web Services Region of the backup. Specifies the Amazon Web Services Region from which the backup is being copied. The source and destination Regions must be in the same Amazon Web Services partition. If you don't specify a Region, it defaults to the Region where the request is sent from (in-Region copy).

Definition at line 184 of file CopyBackupRequest.h.

◆ WithTags() [1/2]

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

Definition at line 277 of file CopyBackupRequest.h.

◆ WithTags() [2/2]

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

Definition at line 274 of file CopyBackupRequest.h.


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