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

#include <Backup.h>

Public Member Functions

 Backup ()
 
 Backup (Aws::Utils::Json::JsonView jsonValue)
 
Backupoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetBackupId () const
 
bool BackupIdHasBeenSet () const
 
void SetBackupId (const Aws::String &value)
 
void SetBackupId (Aws::String &&value)
 
void SetBackupId (const char *value)
 
BackupWithBackupId (const Aws::String &value)
 
BackupWithBackupId (Aws::String &&value)
 
BackupWithBackupId (const char *value)
 
const BackupStateGetBackupState () const
 
bool BackupStateHasBeenSet () const
 
void SetBackupState (const BackupState &value)
 
void SetBackupState (BackupState &&value)
 
BackupWithBackupState (const BackupState &value)
 
BackupWithBackupState (BackupState &&value)
 
const Aws::StringGetClusterId () const
 
bool ClusterIdHasBeenSet () const
 
void SetClusterId (const Aws::String &value)
 
void SetClusterId (Aws::String &&value)
 
void SetClusterId (const char *value)
 
BackupWithClusterId (const Aws::String &value)
 
BackupWithClusterId (Aws::String &&value)
 
BackupWithClusterId (const char *value)
 
const Aws::Utils::DateTimeGetCreateTimestamp () const
 
bool CreateTimestampHasBeenSet () const
 
void SetCreateTimestamp (const Aws::Utils::DateTime &value)
 
void SetCreateTimestamp (Aws::Utils::DateTime &&value)
 
BackupWithCreateTimestamp (const Aws::Utils::DateTime &value)
 
BackupWithCreateTimestamp (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetCopyTimestamp () const
 
bool CopyTimestampHasBeenSet () const
 
void SetCopyTimestamp (const Aws::Utils::DateTime &value)
 
void SetCopyTimestamp (Aws::Utils::DateTime &&value)
 
BackupWithCopyTimestamp (const Aws::Utils::DateTime &value)
 
BackupWithCopyTimestamp (Aws::Utils::DateTime &&value)
 
bool GetNeverExpires () const
 
bool NeverExpiresHasBeenSet () const
 
void SetNeverExpires (bool value)
 
BackupWithNeverExpires (bool value)
 
const Aws::StringGetSourceRegion () const
 
bool SourceRegionHasBeenSet () const
 
void SetSourceRegion (const Aws::String &value)
 
void SetSourceRegion (Aws::String &&value)
 
void SetSourceRegion (const char *value)
 
BackupWithSourceRegion (const Aws::String &value)
 
BackupWithSourceRegion (Aws::String &&value)
 
BackupWithSourceRegion (const char *value)
 
const Aws::StringGetSourceBackup () const
 
bool SourceBackupHasBeenSet () const
 
void SetSourceBackup (const Aws::String &value)
 
void SetSourceBackup (Aws::String &&value)
 
void SetSourceBackup (const char *value)
 
BackupWithSourceBackup (const Aws::String &value)
 
BackupWithSourceBackup (Aws::String &&value)
 
BackupWithSourceBackup (const char *value)
 
const Aws::StringGetSourceCluster () const
 
bool SourceClusterHasBeenSet () const
 
void SetSourceCluster (const Aws::String &value)
 
void SetSourceCluster (Aws::String &&value)
 
void SetSourceCluster (const char *value)
 
BackupWithSourceCluster (const Aws::String &value)
 
BackupWithSourceCluster (Aws::String &&value)
 
BackupWithSourceCluster (const char *value)
 
const Aws::Utils::DateTimeGetDeleteTimestamp () const
 
bool DeleteTimestampHasBeenSet () const
 
void SetDeleteTimestamp (const Aws::Utils::DateTime &value)
 
void SetDeleteTimestamp (Aws::Utils::DateTime &&value)
 
BackupWithDeleteTimestamp (const Aws::Utils::DateTime &value)
 
BackupWithDeleteTimestamp (Aws::Utils::DateTime &&value)
 
const Aws::Vector< Tag > & GetTagList () const
 
bool TagListHasBeenSet () const
 
void SetTagList (const Aws::Vector< Tag > &value)
 
void SetTagList (Aws::Vector< Tag > &&value)
 
BackupWithTagList (const Aws::Vector< Tag > &value)
 
BackupWithTagList (Aws::Vector< Tag > &&value)
 
BackupAddTagList (const Tag &value)
 
BackupAddTagList (Tag &&value)
 

Detailed Description

Contains information about a backup of an AWS CloudHSM cluster. All backup objects contain the BackupId, BackupState, ClusterId, and CreateTimestamp parameters. Backups that were copied into a destination region additionally contain the CopyTimestamp, SourceBackup, SourceCluster, and SourceRegion parameters. A backup that is pending deletion will include the DeleteTimestamp parameter.

See Also:

AWS API Reference

Definition at line 42 of file Backup.h.

Constructor & Destructor Documentation

◆ Backup() [1/2]

Aws::CloudHSMV2::Model::Backup::Backup ( )

◆ Backup() [2/2]

Aws::CloudHSMV2::Model::Backup::Backup ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddTagList() [1/2]

Backup& Aws::CloudHSMV2::Model::Backup::AddTagList ( const Tag value)
inline

The list of tags for the backup.

Definition at line 470 of file Backup.h.

◆ AddTagList() [2/2]

Backup& Aws::CloudHSMV2::Model::Backup::AddTagList ( Tag &&  value)
inline

The list of tags for the backup.

Definition at line 475 of file Backup.h.

◆ BackupIdHasBeenSet()

bool Aws::CloudHSMV2::Model::Backup::BackupIdHasBeenSet ( ) const
inline

The identifier (ID) of the backup.

Definition at line 59 of file Backup.h.

◆ BackupStateHasBeenSet()

bool Aws::CloudHSMV2::Model::Backup::BackupStateHasBeenSet ( ) const
inline

The state of the backup.

Definition at line 100 of file Backup.h.

◆ ClusterIdHasBeenSet()

bool Aws::CloudHSMV2::Model::Backup::ClusterIdHasBeenSet ( ) const
inline

The identifier (ID) of the cluster that was backed up.

Definition at line 131 of file Backup.h.

◆ CopyTimestampHasBeenSet()

bool Aws::CloudHSMV2::Model::Backup::CopyTimestampHasBeenSet ( ) const
inline

The date and time when the backup was copied from a source backup.

Definition at line 203 of file Backup.h.

◆ CreateTimestampHasBeenSet()

bool Aws::CloudHSMV2::Model::Backup::CreateTimestampHasBeenSet ( ) const
inline

The date and time when the backup was created.

Definition at line 172 of file Backup.h.

◆ DeleteTimestampHasBeenSet()

bool Aws::CloudHSMV2::Model::Backup::DeleteTimestampHasBeenSet ( ) const
inline

The date and time when the backup will be permanently deleted.

Definition at line 414 of file Backup.h.

◆ GetBackupId()

const Aws::String& Aws::CloudHSMV2::Model::Backup::GetBackupId ( ) const
inline

The identifier (ID) of the backup.

Definition at line 54 of file Backup.h.

◆ GetBackupState()

const BackupState& Aws::CloudHSMV2::Model::Backup::GetBackupState ( ) const
inline

The state of the backup.

Definition at line 95 of file Backup.h.

◆ GetClusterId()

const Aws::String& Aws::CloudHSMV2::Model::Backup::GetClusterId ( ) const
inline

The identifier (ID) of the cluster that was backed up.

Definition at line 126 of file Backup.h.

◆ GetCopyTimestamp()

const Aws::Utils::DateTime& Aws::CloudHSMV2::Model::Backup::GetCopyTimestamp ( ) const
inline

The date and time when the backup was copied from a source backup.

Definition at line 198 of file Backup.h.

◆ GetCreateTimestamp()

const Aws::Utils::DateTime& Aws::CloudHSMV2::Model::Backup::GetCreateTimestamp ( ) const
inline

The date and time when the backup was created.

Definition at line 167 of file Backup.h.

◆ GetDeleteTimestamp()

const Aws::Utils::DateTime& Aws::CloudHSMV2::Model::Backup::GetDeleteTimestamp ( ) const
inline

The date and time when the backup will be permanently deleted.

Definition at line 409 of file Backup.h.

◆ GetNeverExpires()

bool Aws::CloudHSMV2::Model::Backup::GetNeverExpires ( ) const
inline

Specifies whether the service should exempt a backup from the retention policy for the cluster. True exempts a backup from the retention policy. False means the service applies the backup retention policy defined at the cluster.

Definition at line 232 of file Backup.h.

◆ GetSourceBackup()

const Aws::String& Aws::CloudHSMV2::Model::Backup::GetSourceBackup ( ) const
inline

The identifier (ID) of the source backup from which the new backup was copied.

Definition at line 312 of file Backup.h.

◆ GetSourceCluster()

const Aws::String& Aws::CloudHSMV2::Model::Backup::GetSourceCluster ( ) const
inline

The identifier (ID) of the cluster containing the source backup from which the new backup was copied.

Definition at line 361 of file Backup.h.

◆ GetSourceRegion()

const Aws::String& Aws::CloudHSMV2::Model::Backup::GetSourceRegion ( ) const
inline

The AWS Region that contains the source backup from which the new backup was copied.

Definition at line 263 of file Backup.h.

◆ GetTagList()

const Aws::Vector<Tag>& Aws::CloudHSMV2::Model::Backup::GetTagList ( ) const
inline

The list of tags for the backup.

Definition at line 440 of file Backup.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::CloudHSMV2::Model::Backup::Jsonize ( ) const

◆ NeverExpiresHasBeenSet()

bool Aws::CloudHSMV2::Model::Backup::NeverExpiresHasBeenSet ( ) const
inline

Specifies whether the service should exempt a backup from the retention policy for the cluster. True exempts a backup from the retention policy. False means the service applies the backup retention policy defined at the cluster.

Definition at line 240 of file Backup.h.

◆ operator=()

Backup& Aws::CloudHSMV2::Model::Backup::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetBackupId() [1/3]

void Aws::CloudHSMV2::Model::Backup::SetBackupId ( Aws::String &&  value)
inline

The identifier (ID) of the backup.

Definition at line 69 of file Backup.h.

◆ SetBackupId() [2/3]

void Aws::CloudHSMV2::Model::Backup::SetBackupId ( const Aws::String value)
inline

The identifier (ID) of the backup.

Definition at line 64 of file Backup.h.

◆ SetBackupId() [3/3]

void Aws::CloudHSMV2::Model::Backup::SetBackupId ( const char *  value)
inline

The identifier (ID) of the backup.

Definition at line 74 of file Backup.h.

◆ SetBackupState() [1/2]

void Aws::CloudHSMV2::Model::Backup::SetBackupState ( BackupState &&  value)
inline

The state of the backup.

Definition at line 110 of file Backup.h.

◆ SetBackupState() [2/2]

void Aws::CloudHSMV2::Model::Backup::SetBackupState ( const BackupState value)
inline

The state of the backup.

Definition at line 105 of file Backup.h.

◆ SetClusterId() [1/3]

void Aws::CloudHSMV2::Model::Backup::SetClusterId ( Aws::String &&  value)
inline

The identifier (ID) of the cluster that was backed up.

Definition at line 141 of file Backup.h.

◆ SetClusterId() [2/3]

void Aws::CloudHSMV2::Model::Backup::SetClusterId ( const Aws::String value)
inline

The identifier (ID) of the cluster that was backed up.

Definition at line 136 of file Backup.h.

◆ SetClusterId() [3/3]

void Aws::CloudHSMV2::Model::Backup::SetClusterId ( const char *  value)
inline

The identifier (ID) of the cluster that was backed up.

Definition at line 146 of file Backup.h.

◆ SetCopyTimestamp() [1/2]

void Aws::CloudHSMV2::Model::Backup::SetCopyTimestamp ( Aws::Utils::DateTime &&  value)
inline

The date and time when the backup was copied from a source backup.

Definition at line 213 of file Backup.h.

◆ SetCopyTimestamp() [2/2]

void Aws::CloudHSMV2::Model::Backup::SetCopyTimestamp ( const Aws::Utils::DateTime value)
inline

The date and time when the backup was copied from a source backup.

Definition at line 208 of file Backup.h.

◆ SetCreateTimestamp() [1/2]

void Aws::CloudHSMV2::Model::Backup::SetCreateTimestamp ( Aws::Utils::DateTime &&  value)
inline

The date and time when the backup was created.

Definition at line 182 of file Backup.h.

◆ SetCreateTimestamp() [2/2]

void Aws::CloudHSMV2::Model::Backup::SetCreateTimestamp ( const Aws::Utils::DateTime value)
inline

The date and time when the backup was created.

Definition at line 177 of file Backup.h.

◆ SetDeleteTimestamp() [1/2]

void Aws::CloudHSMV2::Model::Backup::SetDeleteTimestamp ( Aws::Utils::DateTime &&  value)
inline

The date and time when the backup will be permanently deleted.

Definition at line 424 of file Backup.h.

◆ SetDeleteTimestamp() [2/2]

void Aws::CloudHSMV2::Model::Backup::SetDeleteTimestamp ( const Aws::Utils::DateTime value)
inline

The date and time when the backup will be permanently deleted.

Definition at line 419 of file Backup.h.

◆ SetNeverExpires()

void Aws::CloudHSMV2::Model::Backup::SetNeverExpires ( bool  value)
inline

Specifies whether the service should exempt a backup from the retention policy for the cluster. True exempts a backup from the retention policy. False means the service applies the backup retention policy defined at the cluster.

Definition at line 248 of file Backup.h.

◆ SetSourceBackup() [1/3]

void Aws::CloudHSMV2::Model::Backup::SetSourceBackup ( Aws::String &&  value)
inline

The identifier (ID) of the source backup from which the new backup was copied.

Definition at line 330 of file Backup.h.

◆ SetSourceBackup() [2/3]

void Aws::CloudHSMV2::Model::Backup::SetSourceBackup ( const Aws::String value)
inline

The identifier (ID) of the source backup from which the new backup was copied.

Definition at line 324 of file Backup.h.

◆ SetSourceBackup() [3/3]

void Aws::CloudHSMV2::Model::Backup::SetSourceBackup ( const char *  value)
inline

The identifier (ID) of the source backup from which the new backup was copied.

Definition at line 336 of file Backup.h.

◆ SetSourceCluster() [1/3]

void Aws::CloudHSMV2::Model::Backup::SetSourceCluster ( Aws::String &&  value)
inline

The identifier (ID) of the cluster containing the source backup from which the new backup was copied.

Definition at line 379 of file Backup.h.

◆ SetSourceCluster() [2/3]

void Aws::CloudHSMV2::Model::Backup::SetSourceCluster ( const Aws::String value)
inline

The identifier (ID) of the cluster containing the source backup from which the new backup was copied.

Definition at line 373 of file Backup.h.

◆ SetSourceCluster() [3/3]

void Aws::CloudHSMV2::Model::Backup::SetSourceCluster ( const char *  value)
inline

The identifier (ID) of the cluster containing the source backup from which the new backup was copied.

Definition at line 385 of file Backup.h.

◆ SetSourceRegion() [1/3]

void Aws::CloudHSMV2::Model::Backup::SetSourceRegion ( Aws::String &&  value)
inline

The AWS Region that contains the source backup from which the new backup was copied.

Definition at line 281 of file Backup.h.

◆ SetSourceRegion() [2/3]

void Aws::CloudHSMV2::Model::Backup::SetSourceRegion ( const Aws::String value)
inline

The AWS Region that contains the source backup from which the new backup was copied.

Definition at line 275 of file Backup.h.

◆ SetSourceRegion() [3/3]

void Aws::CloudHSMV2::Model::Backup::SetSourceRegion ( const char *  value)
inline

The AWS Region that contains the source backup from which the new backup was copied.

Definition at line 287 of file Backup.h.

◆ SetTagList() [1/2]

void Aws::CloudHSMV2::Model::Backup::SetTagList ( Aws::Vector< Tag > &&  value)
inline

The list of tags for the backup.

Definition at line 455 of file Backup.h.

◆ SetTagList() [2/2]

void Aws::CloudHSMV2::Model::Backup::SetTagList ( const Aws::Vector< Tag > &  value)
inline

The list of tags for the backup.

Definition at line 450 of file Backup.h.

◆ SourceBackupHasBeenSet()

bool Aws::CloudHSMV2::Model::Backup::SourceBackupHasBeenSet ( ) const
inline

The identifier (ID) of the source backup from which the new backup was copied.

Definition at line 318 of file Backup.h.

◆ SourceClusterHasBeenSet()

bool Aws::CloudHSMV2::Model::Backup::SourceClusterHasBeenSet ( ) const
inline

The identifier (ID) of the cluster containing the source backup from which the new backup was copied.

Definition at line 367 of file Backup.h.

◆ SourceRegionHasBeenSet()

bool Aws::CloudHSMV2::Model::Backup::SourceRegionHasBeenSet ( ) const
inline

The AWS Region that contains the source backup from which the new backup was copied.

Definition at line 269 of file Backup.h.

◆ TagListHasBeenSet()

bool Aws::CloudHSMV2::Model::Backup::TagListHasBeenSet ( ) const
inline

The list of tags for the backup.

Definition at line 445 of file Backup.h.

◆ WithBackupId() [1/3]

Backup& Aws::CloudHSMV2::Model::Backup::WithBackupId ( Aws::String &&  value)
inline

The identifier (ID) of the backup.

Definition at line 84 of file Backup.h.

◆ WithBackupId() [2/3]

Backup& Aws::CloudHSMV2::Model::Backup::WithBackupId ( const Aws::String value)
inline

The identifier (ID) of the backup.

Definition at line 79 of file Backup.h.

◆ WithBackupId() [3/3]

Backup& Aws::CloudHSMV2::Model::Backup::WithBackupId ( const char *  value)
inline

The identifier (ID) of the backup.

Definition at line 89 of file Backup.h.

◆ WithBackupState() [1/2]

Backup& Aws::CloudHSMV2::Model::Backup::WithBackupState ( BackupState &&  value)
inline

The state of the backup.

Definition at line 120 of file Backup.h.

◆ WithBackupState() [2/2]

Backup& Aws::CloudHSMV2::Model::Backup::WithBackupState ( const BackupState value)
inline

The state of the backup.

Definition at line 115 of file Backup.h.

◆ WithClusterId() [1/3]

Backup& Aws::CloudHSMV2::Model::Backup::WithClusterId ( Aws::String &&  value)
inline

The identifier (ID) of the cluster that was backed up.

Definition at line 156 of file Backup.h.

◆ WithClusterId() [2/3]

Backup& Aws::CloudHSMV2::Model::Backup::WithClusterId ( const Aws::String value)
inline

The identifier (ID) of the cluster that was backed up.

Definition at line 151 of file Backup.h.

◆ WithClusterId() [3/3]

Backup& Aws::CloudHSMV2::Model::Backup::WithClusterId ( const char *  value)
inline

The identifier (ID) of the cluster that was backed up.

Definition at line 161 of file Backup.h.

◆ WithCopyTimestamp() [1/2]

Backup& Aws::CloudHSMV2::Model::Backup::WithCopyTimestamp ( Aws::Utils::DateTime &&  value)
inline

The date and time when the backup was copied from a source backup.

Definition at line 223 of file Backup.h.

◆ WithCopyTimestamp() [2/2]

Backup& Aws::CloudHSMV2::Model::Backup::WithCopyTimestamp ( const Aws::Utils::DateTime value)
inline

The date and time when the backup was copied from a source backup.

Definition at line 218 of file Backup.h.

◆ WithCreateTimestamp() [1/2]

Backup& Aws::CloudHSMV2::Model::Backup::WithCreateTimestamp ( Aws::Utils::DateTime &&  value)
inline

The date and time when the backup was created.

Definition at line 192 of file Backup.h.

◆ WithCreateTimestamp() [2/2]

Backup& Aws::CloudHSMV2::Model::Backup::WithCreateTimestamp ( const Aws::Utils::DateTime value)
inline

The date and time when the backup was created.

Definition at line 187 of file Backup.h.

◆ WithDeleteTimestamp() [1/2]

Backup& Aws::CloudHSMV2::Model::Backup::WithDeleteTimestamp ( Aws::Utils::DateTime &&  value)
inline

The date and time when the backup will be permanently deleted.

Definition at line 434 of file Backup.h.

◆ WithDeleteTimestamp() [2/2]

Backup& Aws::CloudHSMV2::Model::Backup::WithDeleteTimestamp ( const Aws::Utils::DateTime value)
inline

The date and time when the backup will be permanently deleted.

Definition at line 429 of file Backup.h.

◆ WithNeverExpires()

Backup& Aws::CloudHSMV2::Model::Backup::WithNeverExpires ( bool  value)
inline

Specifies whether the service should exempt a backup from the retention policy for the cluster. True exempts a backup from the retention policy. False means the service applies the backup retention policy defined at the cluster.

Definition at line 256 of file Backup.h.

◆ WithSourceBackup() [1/3]

Backup& Aws::CloudHSMV2::Model::Backup::WithSourceBackup ( Aws::String &&  value)
inline

The identifier (ID) of the source backup from which the new backup was copied.

Definition at line 348 of file Backup.h.

◆ WithSourceBackup() [2/3]

Backup& Aws::CloudHSMV2::Model::Backup::WithSourceBackup ( const Aws::String value)
inline

The identifier (ID) of the source backup from which the new backup was copied.

Definition at line 342 of file Backup.h.

◆ WithSourceBackup() [3/3]

Backup& Aws::CloudHSMV2::Model::Backup::WithSourceBackup ( const char *  value)
inline

The identifier (ID) of the source backup from which the new backup was copied.

Definition at line 354 of file Backup.h.

◆ WithSourceCluster() [1/3]

Backup& Aws::CloudHSMV2::Model::Backup::WithSourceCluster ( Aws::String &&  value)
inline

The identifier (ID) of the cluster containing the source backup from which the new backup was copied.

Definition at line 397 of file Backup.h.

◆ WithSourceCluster() [2/3]

Backup& Aws::CloudHSMV2::Model::Backup::WithSourceCluster ( const Aws::String value)
inline

The identifier (ID) of the cluster containing the source backup from which the new backup was copied.

Definition at line 391 of file Backup.h.

◆ WithSourceCluster() [3/3]

Backup& Aws::CloudHSMV2::Model::Backup::WithSourceCluster ( const char *  value)
inline

The identifier (ID) of the cluster containing the source backup from which the new backup was copied.

Definition at line 403 of file Backup.h.

◆ WithSourceRegion() [1/3]

Backup& Aws::CloudHSMV2::Model::Backup::WithSourceRegion ( Aws::String &&  value)
inline

The AWS Region that contains the source backup from which the new backup was copied.

Definition at line 299 of file Backup.h.

◆ WithSourceRegion() [2/3]

Backup& Aws::CloudHSMV2::Model::Backup::WithSourceRegion ( const Aws::String value)
inline

The AWS Region that contains the source backup from which the new backup was copied.

Definition at line 293 of file Backup.h.

◆ WithSourceRegion() [3/3]

Backup& Aws::CloudHSMV2::Model::Backup::WithSourceRegion ( const char *  value)
inline

The AWS Region that contains the source backup from which the new backup was copied.

Definition at line 305 of file Backup.h.

◆ WithTagList() [1/2]

Backup& Aws::CloudHSMV2::Model::Backup::WithTagList ( Aws::Vector< Tag > &&  value)
inline

The list of tags for the backup.

Definition at line 465 of file Backup.h.

◆ WithTagList() [2/2]

Backup& Aws::CloudHSMV2::Model::Backup::WithTagList ( const Aws::Vector< Tag > &  value)
inline

The list of tags for the backup.

Definition at line 460 of file Backup.h.


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