AWS SDK for C++  1.9.132
AWS SDK for C++
Public Member Functions | List of all members
Aws::Backup::Model::PutBackupVaultNotificationsRequest Class Reference

#include <PutBackupVaultNotificationsRequest.h>

+ Inheritance diagram for Aws::Backup::Model::PutBackupVaultNotificationsRequest:

Public Member Functions

 PutBackupVaultNotificationsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetBackupVaultName () const
 
bool BackupVaultNameHasBeenSet () const
 
void SetBackupVaultName (const Aws::String &value)
 
void SetBackupVaultName (Aws::String &&value)
 
void SetBackupVaultName (const char *value)
 
PutBackupVaultNotificationsRequestWithBackupVaultName (const Aws::String &value)
 
PutBackupVaultNotificationsRequestWithBackupVaultName (Aws::String &&value)
 
PutBackupVaultNotificationsRequestWithBackupVaultName (const char *value)
 
const Aws::StringGetSNSTopicArn () const
 
bool SNSTopicArnHasBeenSet () const
 
void SetSNSTopicArn (const Aws::String &value)
 
void SetSNSTopicArn (Aws::String &&value)
 
void SetSNSTopicArn (const char *value)
 
PutBackupVaultNotificationsRequestWithSNSTopicArn (const Aws::String &value)
 
PutBackupVaultNotificationsRequestWithSNSTopicArn (Aws::String &&value)
 
PutBackupVaultNotificationsRequestWithSNSTopicArn (const char *value)
 
const Aws::Vector< BackupVaultEvent > & GetBackupVaultEvents () const
 
bool BackupVaultEventsHasBeenSet () const
 
void SetBackupVaultEvents (const Aws::Vector< BackupVaultEvent > &value)
 
void SetBackupVaultEvents (Aws::Vector< BackupVaultEvent > &&value)
 
PutBackupVaultNotificationsRequestWithBackupVaultEvents (const Aws::Vector< BackupVaultEvent > &value)
 
PutBackupVaultNotificationsRequestWithBackupVaultEvents (Aws::Vector< BackupVaultEvent > &&value)
 
PutBackupVaultNotificationsRequestAddBackupVaultEvents (const BackupVaultEvent &value)
 
PutBackupVaultNotificationsRequestAddBackupVaultEvents (BackupVaultEvent &&value)
 
- Public Member Functions inherited from Aws::Backup::BackupRequest
virtual ~BackupRequest ()
 
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::Backup::BackupRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 23 of file PutBackupVaultNotificationsRequest.h.

Constructor & Destructor Documentation

◆ PutBackupVaultNotificationsRequest()

Aws::Backup::Model::PutBackupVaultNotificationsRequest::PutBackupVaultNotificationsRequest ( )

Member Function Documentation

◆ AddBackupVaultEvents() [1/2]

PutBackupVaultNotificationsRequest& Aws::Backup::Model::PutBackupVaultNotificationsRequest::AddBackupVaultEvents ( BackupVaultEvent &&  value)
inline

An array of events that indicate the status of jobs to back up resources to the backup vault.

The following events are supported:

BACKUP_JOB_STARTED, BACKUP_JOB_COMPLETED,

COPY_JOB_STARTED, COPY_JOB_SUCCESSFUL, COPY_JOB_FAILED,

RESTORE_JOB_STARTED, RESTORE_JOB_COMPLETED, and RECOVERY_POINT_MODIFIED.

To find failed backup jobs, use BACKUP_JOB_COMPLETED and filter using event metadata.

Other events in the following list are deprecated.

Definition at line 261 of file PutBackupVaultNotificationsRequest.h.

◆ AddBackupVaultEvents() [2/2]

PutBackupVaultNotificationsRequest& Aws::Backup::Model::PutBackupVaultNotificationsRequest::AddBackupVaultEvents ( const BackupVaultEvent value)
inline

An array of events that indicate the status of jobs to back up resources to the backup vault.

The following events are supported:

BACKUP_JOB_STARTED, BACKUP_JOB_COMPLETED,

COPY_JOB_STARTED, COPY_JOB_SUCCESSFUL, COPY_JOB_FAILED,

RESTORE_JOB_STARTED, RESTORE_JOB_COMPLETED, and RECOVERY_POINT_MODIFIED.

To find failed backup jobs, use BACKUP_JOB_COMPLETED and filter using event metadata.

Other events in the following list are deprecated.

Definition at line 248 of file PutBackupVaultNotificationsRequest.h.

◆ BackupVaultEventsHasBeenSet()

bool Aws::Backup::Model::PutBackupVaultNotificationsRequest::BackupVaultEventsHasBeenSet ( ) const
inline

An array of events that indicate the status of jobs to back up resources to the backup vault.

The following events are supported:

BACKUP_JOB_STARTED, BACKUP_JOB_COMPLETED,

COPY_JOB_STARTED, COPY_JOB_SUCCESSFUL, COPY_JOB_FAILED,

RESTORE_JOB_STARTED, RESTORE_JOB_COMPLETED, and RECOVERY_POINT_MODIFIED.

To find failed backup jobs, use BACKUP_JOB_COMPLETED and filter using event metadata.

Other events in the following list are deprecated.

Definition at line 183 of file PutBackupVaultNotificationsRequest.h.

◆ BackupVaultNameHasBeenSet()

bool Aws::Backup::Model::PutBackupVaultNotificationsRequest::BackupVaultNameHasBeenSet ( ) const
inline

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

Definition at line 51 of file PutBackupVaultNotificationsRequest.h.

◆ GetBackupVaultEvents()

const Aws::Vector<BackupVaultEvent>& Aws::Backup::Model::PutBackupVaultNotificationsRequest::GetBackupVaultEvents ( ) const
inline

An array of events that indicate the status of jobs to back up resources to the backup vault.

The following events are supported:

BACKUP_JOB_STARTED, BACKUP_JOB_COMPLETED,

COPY_JOB_STARTED, COPY_JOB_SUCCESSFUL, COPY_JOB_FAILED,

RESTORE_JOB_STARTED, RESTORE_JOB_COMPLETED, and RECOVERY_POINT_MODIFIED.

To find failed backup jobs, use BACKUP_JOB_COMPLETED and filter using event metadata.

Other events in the following list are deprecated.

Definition at line 170 of file PutBackupVaultNotificationsRequest.h.

◆ GetBackupVaultName()

const Aws::String& Aws::Backup::Model::PutBackupVaultNotificationsRequest::GetBackupVaultName ( ) const
inline

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

Definition at line 43 of file PutBackupVaultNotificationsRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::Backup::Model::PutBackupVaultNotificationsRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file PutBackupVaultNotificationsRequest.h.

◆ GetSNSTopicArn()

const Aws::String& Aws::Backup::Model::PutBackupVaultNotificationsRequest::GetSNSTopicArn ( ) const
inline

The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s events; for example, arn:aws:sns:us-west-2:111122223333:MyVaultTopic.

Definition at line 107 of file PutBackupVaultNotificationsRequest.h.

◆ SerializePayload()

Aws::String Aws::Backup::Model::PutBackupVaultNotificationsRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetBackupVaultEvents() [1/2]

void Aws::Backup::Model::PutBackupVaultNotificationsRequest::SetBackupVaultEvents ( Aws::Vector< BackupVaultEvent > &&  value)
inline

An array of events that indicate the status of jobs to back up resources to the backup vault.

The following events are supported:

BACKUP_JOB_STARTED, BACKUP_JOB_COMPLETED,

COPY_JOB_STARTED, COPY_JOB_SUCCESSFUL, COPY_JOB_FAILED,

RESTORE_JOB_STARTED, RESTORE_JOB_COMPLETED, and RECOVERY_POINT_MODIFIED.

To find failed backup jobs, use BACKUP_JOB_COMPLETED and filter using event metadata.

Other events in the following list are deprecated.

Definition at line 209 of file PutBackupVaultNotificationsRequest.h.

◆ SetBackupVaultEvents() [2/2]

void Aws::Backup::Model::PutBackupVaultNotificationsRequest::SetBackupVaultEvents ( const Aws::Vector< BackupVaultEvent > &  value)
inline

An array of events that indicate the status of jobs to back up resources to the backup vault.

The following events are supported:

BACKUP_JOB_STARTED, BACKUP_JOB_COMPLETED,

COPY_JOB_STARTED, COPY_JOB_SUCCESSFUL, COPY_JOB_FAILED,

RESTORE_JOB_STARTED, RESTORE_JOB_COMPLETED, and RECOVERY_POINT_MODIFIED.

To find failed backup jobs, use BACKUP_JOB_COMPLETED and filter using event metadata.

Other events in the following list are deprecated.

Definition at line 196 of file PutBackupVaultNotificationsRequest.h.

◆ SetBackupVaultName() [1/3]

void Aws::Backup::Model::PutBackupVaultNotificationsRequest::SetBackupVaultName ( Aws::String &&  value)
inline

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

Definition at line 67 of file PutBackupVaultNotificationsRequest.h.

◆ SetBackupVaultName() [2/3]

void Aws::Backup::Model::PutBackupVaultNotificationsRequest::SetBackupVaultName ( const Aws::String value)
inline

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

Definition at line 59 of file PutBackupVaultNotificationsRequest.h.

◆ SetBackupVaultName() [3/3]

void Aws::Backup::Model::PutBackupVaultNotificationsRequest::SetBackupVaultName ( const char *  value)
inline

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

Definition at line 75 of file PutBackupVaultNotificationsRequest.h.

◆ SetSNSTopicArn() [1/3]

void Aws::Backup::Model::PutBackupVaultNotificationsRequest::SetSNSTopicArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s events; for example, arn:aws:sns:us-west-2:111122223333:MyVaultTopic.

Definition at line 128 of file PutBackupVaultNotificationsRequest.h.

◆ SetSNSTopicArn() [2/3]

void Aws::Backup::Model::PutBackupVaultNotificationsRequest::SetSNSTopicArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s events; for example, arn:aws:sns:us-west-2:111122223333:MyVaultTopic.

Definition at line 121 of file PutBackupVaultNotificationsRequest.h.

◆ SetSNSTopicArn() [3/3]

void Aws::Backup::Model::PutBackupVaultNotificationsRequest::SetSNSTopicArn ( const char *  value)
inline

The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s events; for example, arn:aws:sns:us-west-2:111122223333:MyVaultTopic.

Definition at line 135 of file PutBackupVaultNotificationsRequest.h.

◆ SNSTopicArnHasBeenSet()

bool Aws::Backup::Model::PutBackupVaultNotificationsRequest::SNSTopicArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s events; for example, arn:aws:sns:us-west-2:111122223333:MyVaultTopic.

Definition at line 114 of file PutBackupVaultNotificationsRequest.h.

◆ WithBackupVaultEvents() [1/2]

PutBackupVaultNotificationsRequest& Aws::Backup::Model::PutBackupVaultNotificationsRequest::WithBackupVaultEvents ( Aws::Vector< BackupVaultEvent > &&  value)
inline

An array of events that indicate the status of jobs to back up resources to the backup vault.

The following events are supported:

BACKUP_JOB_STARTED, BACKUP_JOB_COMPLETED,

COPY_JOB_STARTED, COPY_JOB_SUCCESSFUL, COPY_JOB_FAILED,

RESTORE_JOB_STARTED, RESTORE_JOB_COMPLETED, and RECOVERY_POINT_MODIFIED.

To find failed backup jobs, use BACKUP_JOB_COMPLETED and filter using event metadata.

Other events in the following list are deprecated.

Definition at line 235 of file PutBackupVaultNotificationsRequest.h.

◆ WithBackupVaultEvents() [2/2]

PutBackupVaultNotificationsRequest& Aws::Backup::Model::PutBackupVaultNotificationsRequest::WithBackupVaultEvents ( const Aws::Vector< BackupVaultEvent > &  value)
inline

An array of events that indicate the status of jobs to back up resources to the backup vault.

The following events are supported:

BACKUP_JOB_STARTED, BACKUP_JOB_COMPLETED,

COPY_JOB_STARTED, COPY_JOB_SUCCESSFUL, COPY_JOB_FAILED,

RESTORE_JOB_STARTED, RESTORE_JOB_COMPLETED, and RECOVERY_POINT_MODIFIED.

To find failed backup jobs, use BACKUP_JOB_COMPLETED and filter using event metadata.

Other events in the following list are deprecated.

Definition at line 222 of file PutBackupVaultNotificationsRequest.h.

◆ WithBackupVaultName() [1/3]

PutBackupVaultNotificationsRequest& Aws::Backup::Model::PutBackupVaultNotificationsRequest::WithBackupVaultName ( Aws::String &&  value)
inline

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

Definition at line 91 of file PutBackupVaultNotificationsRequest.h.

◆ WithBackupVaultName() [2/3]

PutBackupVaultNotificationsRequest& Aws::Backup::Model::PutBackupVaultNotificationsRequest::WithBackupVaultName ( const Aws::String value)
inline

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

Definition at line 83 of file PutBackupVaultNotificationsRequest.h.

◆ WithBackupVaultName() [3/3]

PutBackupVaultNotificationsRequest& Aws::Backup::Model::PutBackupVaultNotificationsRequest::WithBackupVaultName ( const char *  value)
inline

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

Definition at line 99 of file PutBackupVaultNotificationsRequest.h.

◆ WithSNSTopicArn() [1/3]

PutBackupVaultNotificationsRequest& Aws::Backup::Model::PutBackupVaultNotificationsRequest::WithSNSTopicArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s events; for example, arn:aws:sns:us-west-2:111122223333:MyVaultTopic.

Definition at line 149 of file PutBackupVaultNotificationsRequest.h.

◆ WithSNSTopicArn() [2/3]

PutBackupVaultNotificationsRequest& Aws::Backup::Model::PutBackupVaultNotificationsRequest::WithSNSTopicArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s events; for example, arn:aws:sns:us-west-2:111122223333:MyVaultTopic.

Definition at line 142 of file PutBackupVaultNotificationsRequest.h.

◆ WithSNSTopicArn() [3/3]

PutBackupVaultNotificationsRequest& Aws::Backup::Model::PutBackupVaultNotificationsRequest::WithSNSTopicArn ( const char *  value)
inline

The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s events; for example, arn:aws:sns:us-west-2:111122223333:MyVaultTopic.

Definition at line 156 of file PutBackupVaultNotificationsRequest.h.


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