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

#include <BackupJob.h>

Public Member Functions

 BackupJob ()
 
 BackupJob (Aws::Utils::Json::JsonView jsonValue)
 
BackupJoboperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetAccountId () const
 
bool AccountIdHasBeenSet () const
 
void SetAccountId (const Aws::String &value)
 
void SetAccountId (Aws::String &&value)
 
void SetAccountId (const char *value)
 
BackupJobWithAccountId (const Aws::String &value)
 
BackupJobWithAccountId (Aws::String &&value)
 
BackupJobWithAccountId (const char *value)
 
const Aws::StringGetBackupJobId () const
 
bool BackupJobIdHasBeenSet () const
 
void SetBackupJobId (const Aws::String &value)
 
void SetBackupJobId (Aws::String &&value)
 
void SetBackupJobId (const char *value)
 
BackupJobWithBackupJobId (const Aws::String &value)
 
BackupJobWithBackupJobId (Aws::String &&value)
 
BackupJobWithBackupJobId (const char *value)
 
const Aws::StringGetBackupVaultName () const
 
bool BackupVaultNameHasBeenSet () const
 
void SetBackupVaultName (const Aws::String &value)
 
void SetBackupVaultName (Aws::String &&value)
 
void SetBackupVaultName (const char *value)
 
BackupJobWithBackupVaultName (const Aws::String &value)
 
BackupJobWithBackupVaultName (Aws::String &&value)
 
BackupJobWithBackupVaultName (const char *value)
 
const Aws::StringGetBackupVaultArn () const
 
bool BackupVaultArnHasBeenSet () const
 
void SetBackupVaultArn (const Aws::String &value)
 
void SetBackupVaultArn (Aws::String &&value)
 
void SetBackupVaultArn (const char *value)
 
BackupJobWithBackupVaultArn (const Aws::String &value)
 
BackupJobWithBackupVaultArn (Aws::String &&value)
 
BackupJobWithBackupVaultArn (const char *value)
 
const Aws::StringGetRecoveryPointArn () const
 
bool RecoveryPointArnHasBeenSet () const
 
void SetRecoveryPointArn (const Aws::String &value)
 
void SetRecoveryPointArn (Aws::String &&value)
 
void SetRecoveryPointArn (const char *value)
 
BackupJobWithRecoveryPointArn (const Aws::String &value)
 
BackupJobWithRecoveryPointArn (Aws::String &&value)
 
BackupJobWithRecoveryPointArn (const char *value)
 
const Aws::StringGetResourceArn () const
 
bool ResourceArnHasBeenSet () const
 
void SetResourceArn (const Aws::String &value)
 
void SetResourceArn (Aws::String &&value)
 
void SetResourceArn (const char *value)
 
BackupJobWithResourceArn (const Aws::String &value)
 
BackupJobWithResourceArn (Aws::String &&value)
 
BackupJobWithResourceArn (const char *value)
 
const Aws::Utils::DateTimeGetCreationDate () const
 
bool CreationDateHasBeenSet () const
 
void SetCreationDate (const Aws::Utils::DateTime &value)
 
void SetCreationDate (Aws::Utils::DateTime &&value)
 
BackupJobWithCreationDate (const Aws::Utils::DateTime &value)
 
BackupJobWithCreationDate (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetCompletionDate () const
 
bool CompletionDateHasBeenSet () const
 
void SetCompletionDate (const Aws::Utils::DateTime &value)
 
void SetCompletionDate (Aws::Utils::DateTime &&value)
 
BackupJobWithCompletionDate (const Aws::Utils::DateTime &value)
 
BackupJobWithCompletionDate (Aws::Utils::DateTime &&value)
 
const BackupJobStateGetState () const
 
bool StateHasBeenSet () const
 
void SetState (const BackupJobState &value)
 
void SetState (BackupJobState &&value)
 
BackupJobWithState (const BackupJobState &value)
 
BackupJobWithState (BackupJobState &&value)
 
const Aws::StringGetStatusMessage () const
 
bool StatusMessageHasBeenSet () const
 
void SetStatusMessage (const Aws::String &value)
 
void SetStatusMessage (Aws::String &&value)
 
void SetStatusMessage (const char *value)
 
BackupJobWithStatusMessage (const Aws::String &value)
 
BackupJobWithStatusMessage (Aws::String &&value)
 
BackupJobWithStatusMessage (const char *value)
 
const Aws::StringGetPercentDone () const
 
bool PercentDoneHasBeenSet () const
 
void SetPercentDone (const Aws::String &value)
 
void SetPercentDone (Aws::String &&value)
 
void SetPercentDone (const char *value)
 
BackupJobWithPercentDone (const Aws::String &value)
 
BackupJobWithPercentDone (Aws::String &&value)
 
BackupJobWithPercentDone (const char *value)
 
long long GetBackupSizeInBytes () const
 
bool BackupSizeInBytesHasBeenSet () const
 
void SetBackupSizeInBytes (long long value)
 
BackupJobWithBackupSizeInBytes (long long value)
 
const Aws::StringGetIamRoleArn () const
 
bool IamRoleArnHasBeenSet () const
 
void SetIamRoleArn (const Aws::String &value)
 
void SetIamRoleArn (Aws::String &&value)
 
void SetIamRoleArn (const char *value)
 
BackupJobWithIamRoleArn (const Aws::String &value)
 
BackupJobWithIamRoleArn (Aws::String &&value)
 
BackupJobWithIamRoleArn (const char *value)
 
const RecoveryPointCreatorGetCreatedBy () const
 
bool CreatedByHasBeenSet () const
 
void SetCreatedBy (const RecoveryPointCreator &value)
 
void SetCreatedBy (RecoveryPointCreator &&value)
 
BackupJobWithCreatedBy (const RecoveryPointCreator &value)
 
BackupJobWithCreatedBy (RecoveryPointCreator &&value)
 
const Aws::Utils::DateTimeGetExpectedCompletionDate () const
 
bool ExpectedCompletionDateHasBeenSet () const
 
void SetExpectedCompletionDate (const Aws::Utils::DateTime &value)
 
void SetExpectedCompletionDate (Aws::Utils::DateTime &&value)
 
BackupJobWithExpectedCompletionDate (const Aws::Utils::DateTime &value)
 
BackupJobWithExpectedCompletionDate (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetStartBy () const
 
bool StartByHasBeenSet () const
 
void SetStartBy (const Aws::Utils::DateTime &value)
 
void SetStartBy (Aws::Utils::DateTime &&value)
 
BackupJobWithStartBy (const Aws::Utils::DateTime &value)
 
BackupJobWithStartBy (Aws::Utils::DateTime &&value)
 
const Aws::StringGetResourceType () const
 
bool ResourceTypeHasBeenSet () const
 
void SetResourceType (const Aws::String &value)
 
void SetResourceType (Aws::String &&value)
 
void SetResourceType (const char *value)
 
BackupJobWithResourceType (const Aws::String &value)
 
BackupJobWithResourceType (Aws::String &&value)
 
BackupJobWithResourceType (const char *value)
 
long long GetBytesTransferred () const
 
bool BytesTransferredHasBeenSet () const
 
void SetBytesTransferred (long long value)
 
BackupJobWithBytesTransferred (long long value)
 
const Aws::Map< Aws::String, Aws::String > & GetBackupOptions () const
 
bool BackupOptionsHasBeenSet () const
 
void SetBackupOptions (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetBackupOptions (Aws::Map< Aws::String, Aws::String > &&value)
 
BackupJobWithBackupOptions (const Aws::Map< Aws::String, Aws::String > &value)
 
BackupJobWithBackupOptions (Aws::Map< Aws::String, Aws::String > &&value)
 
BackupJobAddBackupOptions (const Aws::String &key, const Aws::String &value)
 
BackupJobAddBackupOptions (Aws::String &&key, const Aws::String &value)
 
BackupJobAddBackupOptions (const Aws::String &key, Aws::String &&value)
 
BackupJobAddBackupOptions (Aws::String &&key, Aws::String &&value)
 
BackupJobAddBackupOptions (const char *key, Aws::String &&value)
 
BackupJobAddBackupOptions (Aws::String &&key, const char *value)
 
BackupJobAddBackupOptions (const char *key, const char *value)
 
const Aws::StringGetBackupType () const
 
bool BackupTypeHasBeenSet () const
 
void SetBackupType (const Aws::String &value)
 
void SetBackupType (Aws::String &&value)
 
void SetBackupType (const char *value)
 
BackupJobWithBackupType (const Aws::String &value)
 
BackupJobWithBackupType (Aws::String &&value)
 
BackupJobWithBackupType (const char *value)
 

Detailed Description

Contains detailed information about a backup job.

See Also:

AWS API Reference

Definition at line 35 of file BackupJob.h.

Constructor & Destructor Documentation

◆ BackupJob() [1/2]

Aws::Backup::Model::BackupJob::BackupJob ( )

◆ BackupJob() [2/2]

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

Member Function Documentation

◆ AccountIdHasBeenSet()

bool Aws::Backup::Model::BackupJob::AccountIdHasBeenSet ( ) const
inline

The account ID that owns the backup job.

Definition at line 52 of file BackupJob.h.

◆ AddBackupOptions() [1/7]

BackupJob& Aws::Backup::Model::BackupJob::AddBackupOptions ( const Aws::String key,
const Aws::String value 
)
inline

Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.

Valid values: Set to "WindowsVSS”:“enabled" to enable WindowsVSS backup option and create a VSS Windows backup. Set to “WindowsVSS”:”disabled” to create a regular backup. If you specify an invalid option, you get an InvalidParameterValueException exception.

Definition at line 972 of file BackupJob.h.

◆ AddBackupOptions() [2/7]

BackupJob& Aws::Backup::Model::BackupJob::AddBackupOptions ( Aws::String &&  key,
const Aws::String value 
)
inline

Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.

Valid values: Set to "WindowsVSS”:“enabled" to enable WindowsVSS backup option and create a VSS Windows backup. Set to “WindowsVSS”:”disabled” to create a regular backup. If you specify an invalid option, you get an InvalidParameterValueException exception.

Definition at line 982 of file BackupJob.h.

◆ AddBackupOptions() [3/7]

BackupJob& Aws::Backup::Model::BackupJob::AddBackupOptions ( const Aws::String key,
Aws::String &&  value 
)
inline

Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.

Valid values: Set to "WindowsVSS”:“enabled" to enable WindowsVSS backup option and create a VSS Windows backup. Set to “WindowsVSS”:”disabled” to create a regular backup. If you specify an invalid option, you get an InvalidParameterValueException exception.

Definition at line 992 of file BackupJob.h.

◆ AddBackupOptions() [4/7]

BackupJob& Aws::Backup::Model::BackupJob::AddBackupOptions ( Aws::String &&  key,
Aws::String &&  value 
)
inline

Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.

Valid values: Set to "WindowsVSS”:“enabled" to enable WindowsVSS backup option and create a VSS Windows backup. Set to “WindowsVSS”:”disabled” to create a regular backup. If you specify an invalid option, you get an InvalidParameterValueException exception.

Definition at line 1002 of file BackupJob.h.

◆ AddBackupOptions() [5/7]

BackupJob& Aws::Backup::Model::BackupJob::AddBackupOptions ( const char *  key,
Aws::String &&  value 
)
inline

Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.

Valid values: Set to "WindowsVSS”:“enabled" to enable WindowsVSS backup option and create a VSS Windows backup. Set to “WindowsVSS”:”disabled” to create a regular backup. If you specify an invalid option, you get an InvalidParameterValueException exception.

Definition at line 1012 of file BackupJob.h.

◆ AddBackupOptions() [6/7]

BackupJob& Aws::Backup::Model::BackupJob::AddBackupOptions ( Aws::String &&  key,
const char *  value 
)
inline

Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.

Valid values: Set to "WindowsVSS”:“enabled" to enable WindowsVSS backup option and create a VSS Windows backup. Set to “WindowsVSS”:”disabled” to create a regular backup. If you specify an invalid option, you get an InvalidParameterValueException exception.

Definition at line 1022 of file BackupJob.h.

◆ AddBackupOptions() [7/7]

BackupJob& Aws::Backup::Model::BackupJob::AddBackupOptions ( const char *  key,
const char *  value 
)
inline

Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.

Valid values: Set to "WindowsVSS”:“enabled" to enable WindowsVSS backup option and create a VSS Windows backup. Set to “WindowsVSS”:”disabled” to create a regular backup. If you specify an invalid option, you get an InvalidParameterValueException exception.

Definition at line 1032 of file BackupJob.h.

◆ BackupJobIdHasBeenSet()

bool Aws::Backup::Model::BackupJob::BackupJobIdHasBeenSet ( ) const
inline

Uniquely identifies a request to AWS Backup to back up a resource.

Definition at line 93 of file BackupJob.h.

◆ BackupOptionsHasBeenSet()

bool Aws::Backup::Model::BackupJob::BackupOptionsHasBeenSet ( ) const
inline

Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.

Valid values: Set to "WindowsVSS”:“enabled" to enable WindowsVSS backup option and create a VSS Windows backup. Set to “WindowsVSS”:”disabled” to create a regular backup. If you specify an invalid option, you get an InvalidParameterValueException exception.

Definition at line 922 of file BackupJob.h.

◆ BackupSizeInBytesHasBeenSet()

bool Aws::Backup::Model::BackupJob::BackupSizeInBytesHasBeenSet ( ) const
inline

The size, in bytes, of a backup.

Definition at line 581 of file BackupJob.h.

◆ BackupTypeHasBeenSet()

bool Aws::Backup::Model::BackupJob::BackupTypeHasBeenSet ( ) const
inline

Represents the type of backup for a backup job.

Definition at line 1043 of file BackupJob.h.

◆ BackupVaultArnHasBeenSet()

bool Aws::Backup::Model::BackupJob::BackupVaultArnHasBeenSet ( ) const
inline

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

Definition at line 203 of file BackupJob.h.

◆ BackupVaultNameHasBeenSet()

bool Aws::Backup::Model::BackupJob::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 AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

Definition at line 140 of file BackupJob.h.

◆ BytesTransferredHasBeenSet()

bool Aws::Backup::Model::BackupJob::BytesTransferredHasBeenSet ( ) const
inline

The size in bytes transferred to a backup vault at the time that the job status was queried.

Definition at line 889 of file BackupJob.h.

◆ CompletionDateHasBeenSet()

bool Aws::Backup::Model::BackupJob::CompletionDateHasBeenSet ( ) const
inline

The date and time a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Definition at line 409 of file BackupJob.h.

◆ CreatedByHasBeenSet()

bool Aws::Backup::Model::BackupJob::CreatedByHasBeenSet ( ) const
inline

Contains identifying information about the creation of a backup job, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan used to create it.

Definition at line 657 of file BackupJob.h.

◆ CreationDateHasBeenSet()

bool Aws::Backup::Model::BackupJob::CreationDateHasBeenSet ( ) const
inline

The date and time a backup job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Definition at line 360 of file BackupJob.h.

◆ ExpectedCompletionDateHasBeenSet()

bool Aws::Backup::Model::BackupJob::ExpectedCompletionDateHasBeenSet ( ) const
inline

The date and time a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC). The value of ExpectedCompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Definition at line 708 of file BackupJob.h.

◆ GetAccountId()

const Aws::String& Aws::Backup::Model::BackupJob::GetAccountId ( ) const
inline

The account ID that owns the backup job.

Definition at line 47 of file BackupJob.h.

◆ GetBackupJobId()

const Aws::String& Aws::Backup::Model::BackupJob::GetBackupJobId ( ) const
inline

Uniquely identifies a request to AWS Backup to back up a resource.

Definition at line 88 of file BackupJob.h.

◆ GetBackupOptions()

const Aws::Map<Aws::String, Aws::String>& Aws::Backup::Model::BackupJob::GetBackupOptions ( ) const
inline

Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.

Valid values: Set to "WindowsVSS”:“enabled" to enable WindowsVSS backup option and create a VSS Windows backup. Set to “WindowsVSS”:”disabled” to create a regular backup. If you specify an invalid option, you get an InvalidParameterValueException exception.

Definition at line 912 of file BackupJob.h.

◆ GetBackupSizeInBytes()

long long Aws::Backup::Model::BackupJob::GetBackupSizeInBytes ( ) const
inline

The size, in bytes, of a backup.

Definition at line 576 of file BackupJob.h.

◆ GetBackupType()

const Aws::String& Aws::Backup::Model::BackupJob::GetBackupType ( ) const
inline

Represents the type of backup for a backup job.

Definition at line 1038 of file BackupJob.h.

◆ GetBackupVaultArn()

const Aws::String& Aws::Backup::Model::BackupJob::GetBackupVaultArn ( ) const
inline

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

Definition at line 196 of file BackupJob.h.

◆ GetBackupVaultName()

const Aws::String& Aws::Backup::Model::BackupJob::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 AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

Definition at line 132 of file BackupJob.h.

◆ GetBytesTransferred()

long long Aws::Backup::Model::BackupJob::GetBytesTransferred ( ) const
inline

The size in bytes transferred to a backup vault at the time that the job status was queried.

Definition at line 883 of file BackupJob.h.

◆ GetCompletionDate()

const Aws::Utils::DateTime& Aws::Backup::Model::BackupJob::GetCompletionDate ( ) const
inline

The date and time a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Definition at line 401 of file BackupJob.h.

◆ GetCreatedBy()

const RecoveryPointCreator& Aws::Backup::Model::BackupJob::GetCreatedBy ( ) const
inline

Contains identifying information about the creation of a backup job, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan used to create it.

Definition at line 649 of file BackupJob.h.

◆ GetCreationDate()

const Aws::Utils::DateTime& Aws::Backup::Model::BackupJob::GetCreationDate ( ) const
inline

The date and time a backup job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Definition at line 352 of file BackupJob.h.

◆ GetExpectedCompletionDate()

const Aws::Utils::DateTime& Aws::Backup::Model::BackupJob::GetExpectedCompletionDate ( ) const
inline

The date and time a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC). The value of ExpectedCompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Definition at line 699 of file BackupJob.h.

◆ GetIamRoleArn()

const Aws::String& Aws::Backup::Model::BackupJob::GetIamRoleArn ( ) const
inline

Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

Definition at line 598 of file BackupJob.h.

◆ GetPercentDone()

const Aws::String& Aws::Backup::Model::BackupJob::GetPercentDone ( ) const
inline

Contains an estimated percentage complete of a job at the time the job status was queried.

Definition at line 528 of file BackupJob.h.

◆ GetRecoveryPointArn()

const Aws::String& Aws::Backup::Model::BackupJob::GetRecoveryPointArn ( ) const
inline

An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

Definition at line 252 of file BackupJob.h.

◆ GetResourceArn()

const Aws::String& Aws::Backup::Model::BackupJob::GetResourceArn ( ) const
inline

An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.

Definition at line 301 of file BackupJob.h.

◆ GetResourceType()

const Aws::String& Aws::Backup::Model::BackupJob::GetResourceType ( ) const
inline

The type of AWS resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For VSS Windows backups, the only supported resource type is Amazon EC2.

Definition at line 820 of file BackupJob.h.

◆ GetStartBy()

const Aws::Utils::DateTime& Aws::Backup::Model::BackupJob::GetStartBy ( ) const
inline

Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled. The value is calculated by adding the start window to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2 hours, the StartBy time would be 8:00 PM on the date specified. The value of StartBy is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Definition at line 756 of file BackupJob.h.

◆ GetState()

const BackupJobState& Aws::Backup::Model::BackupJob::GetState ( ) const
inline

The current state of a resource recovery point.

Definition at line 447 of file BackupJob.h.

◆ GetStatusMessage()

const Aws::String& Aws::Backup::Model::BackupJob::GetStatusMessage ( ) const
inline

A detailed message explaining the status of the job to back up a resource.

Definition at line 479 of file BackupJob.h.

◆ IamRoleArnHasBeenSet()

bool Aws::Backup::Model::BackupJob::IamRoleArnHasBeenSet ( ) const
inline

Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

Definition at line 604 of file BackupJob.h.

◆ Jsonize()

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

◆ operator=()

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

◆ PercentDoneHasBeenSet()

bool Aws::Backup::Model::BackupJob::PercentDoneHasBeenSet ( ) const
inline

Contains an estimated percentage complete of a job at the time the job status was queried.

Definition at line 534 of file BackupJob.h.

◆ RecoveryPointArnHasBeenSet()

bool Aws::Backup::Model::BackupJob::RecoveryPointArnHasBeenSet ( ) const
inline

An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

Definition at line 258 of file BackupJob.h.

◆ ResourceArnHasBeenSet()

bool Aws::Backup::Model::BackupJob::ResourceArnHasBeenSet ( ) const
inline

An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.

Definition at line 307 of file BackupJob.h.

◆ ResourceTypeHasBeenSet()

bool Aws::Backup::Model::BackupJob::ResourceTypeHasBeenSet ( ) const
inline

The type of AWS resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For VSS Windows backups, the only supported resource type is Amazon EC2.

Definition at line 828 of file BackupJob.h.

◆ SetAccountId() [1/3]

void Aws::Backup::Model::BackupJob::SetAccountId ( const Aws::String value)
inline

The account ID that owns the backup job.

Definition at line 57 of file BackupJob.h.

◆ SetAccountId() [2/3]

void Aws::Backup::Model::BackupJob::SetAccountId ( Aws::String &&  value)
inline

The account ID that owns the backup job.

Definition at line 62 of file BackupJob.h.

◆ SetAccountId() [3/3]

void Aws::Backup::Model::BackupJob::SetAccountId ( const char *  value)
inline

The account ID that owns the backup job.

Definition at line 67 of file BackupJob.h.

◆ SetBackupJobId() [1/3]

void Aws::Backup::Model::BackupJob::SetBackupJobId ( const Aws::String value)
inline

Uniquely identifies a request to AWS Backup to back up a resource.

Definition at line 98 of file BackupJob.h.

◆ SetBackupJobId() [2/3]

void Aws::Backup::Model::BackupJob::SetBackupJobId ( Aws::String &&  value)
inline

Uniquely identifies a request to AWS Backup to back up a resource.

Definition at line 103 of file BackupJob.h.

◆ SetBackupJobId() [3/3]

void Aws::Backup::Model::BackupJob::SetBackupJobId ( const char *  value)
inline

Uniquely identifies a request to AWS Backup to back up a resource.

Definition at line 108 of file BackupJob.h.

◆ SetBackupOptions() [1/2]

void Aws::Backup::Model::BackupJob::SetBackupOptions ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.

Valid values: Set to "WindowsVSS”:“enabled" to enable WindowsVSS backup option and create a VSS Windows backup. Set to “WindowsVSS”:”disabled” to create a regular backup. If you specify an invalid option, you get an InvalidParameterValueException exception.

Definition at line 932 of file BackupJob.h.

◆ SetBackupOptions() [2/2]

void Aws::Backup::Model::BackupJob::SetBackupOptions ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.

Valid values: Set to "WindowsVSS”:“enabled" to enable WindowsVSS backup option and create a VSS Windows backup. Set to “WindowsVSS”:”disabled” to create a regular backup. If you specify an invalid option, you get an InvalidParameterValueException exception.

Definition at line 942 of file BackupJob.h.

◆ SetBackupSizeInBytes()

void Aws::Backup::Model::BackupJob::SetBackupSizeInBytes ( long long  value)
inline

The size, in bytes, of a backup.

Definition at line 586 of file BackupJob.h.

◆ SetBackupType() [1/3]

void Aws::Backup::Model::BackupJob::SetBackupType ( const Aws::String value)
inline

Represents the type of backup for a backup job.

Definition at line 1048 of file BackupJob.h.

◆ SetBackupType() [2/3]

void Aws::Backup::Model::BackupJob::SetBackupType ( Aws::String &&  value)
inline

Represents the type of backup for a backup job.

Definition at line 1053 of file BackupJob.h.

◆ SetBackupType() [3/3]

void Aws::Backup::Model::BackupJob::SetBackupType ( const char *  value)
inline

Represents the type of backup for a backup job.

Definition at line 1058 of file BackupJob.h.

◆ SetBackupVaultArn() [1/3]

void Aws::Backup::Model::BackupJob::SetBackupVaultArn ( const Aws::String value)
inline

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

Definition at line 210 of file BackupJob.h.

◆ SetBackupVaultArn() [2/3]

void Aws::Backup::Model::BackupJob::SetBackupVaultArn ( Aws::String &&  value)
inline

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

Definition at line 217 of file BackupJob.h.

◆ SetBackupVaultArn() [3/3]

void Aws::Backup::Model::BackupJob::SetBackupVaultArn ( const char *  value)
inline

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

Definition at line 224 of file BackupJob.h.

◆ SetBackupVaultName() [1/3]

void Aws::Backup::Model::BackupJob::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 AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

Definition at line 148 of file BackupJob.h.

◆ SetBackupVaultName() [2/3]

void Aws::Backup::Model::BackupJob::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 AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

Definition at line 156 of file BackupJob.h.

◆ SetBackupVaultName() [3/3]

void Aws::Backup::Model::BackupJob::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 AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

Definition at line 164 of file BackupJob.h.

◆ SetBytesTransferred()

void Aws::Backup::Model::BackupJob::SetBytesTransferred ( long long  value)
inline

The size in bytes transferred to a backup vault at the time that the job status was queried.

Definition at line 895 of file BackupJob.h.

◆ SetCompletionDate() [1/2]

void Aws::Backup::Model::BackupJob::SetCompletionDate ( const Aws::Utils::DateTime value)
inline

The date and time a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Definition at line 417 of file BackupJob.h.

◆ SetCompletionDate() [2/2]

void Aws::Backup::Model::BackupJob::SetCompletionDate ( Aws::Utils::DateTime &&  value)
inline

The date and time a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Definition at line 425 of file BackupJob.h.

◆ SetCreatedBy() [1/2]

void Aws::Backup::Model::BackupJob::SetCreatedBy ( const RecoveryPointCreator value)
inline

Contains identifying information about the creation of a backup job, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan used to create it.

Definition at line 665 of file BackupJob.h.

◆ SetCreatedBy() [2/2]

void Aws::Backup::Model::BackupJob::SetCreatedBy ( RecoveryPointCreator &&  value)
inline

Contains identifying information about the creation of a backup job, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan used to create it.

Definition at line 673 of file BackupJob.h.

◆ SetCreationDate() [1/2]

void Aws::Backup::Model::BackupJob::SetCreationDate ( const Aws::Utils::DateTime value)
inline

The date and time a backup job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Definition at line 368 of file BackupJob.h.

◆ SetCreationDate() [2/2]

void Aws::Backup::Model::BackupJob::SetCreationDate ( Aws::Utils::DateTime &&  value)
inline

The date and time a backup job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Definition at line 376 of file BackupJob.h.

◆ SetExpectedCompletionDate() [1/2]

void Aws::Backup::Model::BackupJob::SetExpectedCompletionDate ( const Aws::Utils::DateTime value)
inline

The date and time a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC). The value of ExpectedCompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Definition at line 717 of file BackupJob.h.

◆ SetExpectedCompletionDate() [2/2]

void Aws::Backup::Model::BackupJob::SetExpectedCompletionDate ( Aws::Utils::DateTime &&  value)
inline

The date and time a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC). The value of ExpectedCompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Definition at line 726 of file BackupJob.h.

◆ SetIamRoleArn() [1/3]

void Aws::Backup::Model::BackupJob::SetIamRoleArn ( const Aws::String value)
inline

Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

Definition at line 610 of file BackupJob.h.

◆ SetIamRoleArn() [2/3]

void Aws::Backup::Model::BackupJob::SetIamRoleArn ( Aws::String &&  value)
inline

Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

Definition at line 616 of file BackupJob.h.

◆ SetIamRoleArn() [3/3]

void Aws::Backup::Model::BackupJob::SetIamRoleArn ( const char *  value)
inline

Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

Definition at line 622 of file BackupJob.h.

◆ SetPercentDone() [1/3]

void Aws::Backup::Model::BackupJob::SetPercentDone ( const Aws::String value)
inline

Contains an estimated percentage complete of a job at the time the job status was queried.

Definition at line 540 of file BackupJob.h.

◆ SetPercentDone() [2/3]

void Aws::Backup::Model::BackupJob::SetPercentDone ( Aws::String &&  value)
inline

Contains an estimated percentage complete of a job at the time the job status was queried.

Definition at line 546 of file BackupJob.h.

◆ SetPercentDone() [3/3]

void Aws::Backup::Model::BackupJob::SetPercentDone ( const char *  value)
inline

Contains an estimated percentage complete of a job at the time the job status was queried.

Definition at line 552 of file BackupJob.h.

◆ SetRecoveryPointArn() [1/3]

void Aws::Backup::Model::BackupJob::SetRecoveryPointArn ( const Aws::String value)
inline

An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

Definition at line 264 of file BackupJob.h.

◆ SetRecoveryPointArn() [2/3]

void Aws::Backup::Model::BackupJob::SetRecoveryPointArn ( Aws::String &&  value)
inline

An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

Definition at line 270 of file BackupJob.h.

◆ SetRecoveryPointArn() [3/3]

void Aws::Backup::Model::BackupJob::SetRecoveryPointArn ( const char *  value)
inline

An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

Definition at line 276 of file BackupJob.h.

◆ SetResourceArn() [1/3]

void Aws::Backup::Model::BackupJob::SetResourceArn ( const Aws::String value)
inline

An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.

Definition at line 313 of file BackupJob.h.

◆ SetResourceArn() [2/3]

void Aws::Backup::Model::BackupJob::SetResourceArn ( Aws::String &&  value)
inline

An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.

Definition at line 319 of file BackupJob.h.

◆ SetResourceArn() [3/3]

void Aws::Backup::Model::BackupJob::SetResourceArn ( const char *  value)
inline

An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.

Definition at line 325 of file BackupJob.h.

◆ SetResourceType() [1/3]

void Aws::Backup::Model::BackupJob::SetResourceType ( const Aws::String value)
inline

The type of AWS resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For VSS Windows backups, the only supported resource type is Amazon EC2.

Definition at line 836 of file BackupJob.h.

◆ SetResourceType() [2/3]

void Aws::Backup::Model::BackupJob::SetResourceType ( Aws::String &&  value)
inline

The type of AWS resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For VSS Windows backups, the only supported resource type is Amazon EC2.

Definition at line 844 of file BackupJob.h.

◆ SetResourceType() [3/3]

void Aws::Backup::Model::BackupJob::SetResourceType ( const char *  value)
inline

The type of AWS resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For VSS Windows backups, the only supported resource type is Amazon EC2.

Definition at line 852 of file BackupJob.h.

◆ SetStartBy() [1/2]

void Aws::Backup::Model::BackupJob::SetStartBy ( const Aws::Utils::DateTime value)
inline

Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled. The value is calculated by adding the start window to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2 hours, the StartBy time would be 8:00 PM on the date specified. The value of StartBy is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Definition at line 778 of file BackupJob.h.

◆ SetStartBy() [2/2]

void Aws::Backup::Model::BackupJob::SetStartBy ( Aws::Utils::DateTime &&  value)
inline

Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled. The value is calculated by adding the start window to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2 hours, the StartBy time would be 8:00 PM on the date specified. The value of StartBy is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Definition at line 789 of file BackupJob.h.

◆ SetState() [1/2]

void Aws::Backup::Model::BackupJob::SetState ( const BackupJobState value)
inline

The current state of a resource recovery point.

Definition at line 457 of file BackupJob.h.

◆ SetState() [2/2]

void Aws::Backup::Model::BackupJob::SetState ( BackupJobState &&  value)
inline

The current state of a resource recovery point.

Definition at line 462 of file BackupJob.h.

◆ SetStatusMessage() [1/3]

void Aws::Backup::Model::BackupJob::SetStatusMessage ( const Aws::String value)
inline

A detailed message explaining the status of the job to back up a resource.

Definition at line 491 of file BackupJob.h.

◆ SetStatusMessage() [2/3]

void Aws::Backup::Model::BackupJob::SetStatusMessage ( Aws::String &&  value)
inline

A detailed message explaining the status of the job to back up a resource.

Definition at line 497 of file BackupJob.h.

◆ SetStatusMessage() [3/3]

void Aws::Backup::Model::BackupJob::SetStatusMessage ( const char *  value)
inline

A detailed message explaining the status of the job to back up a resource.

Definition at line 503 of file BackupJob.h.

◆ StartByHasBeenSet()

bool Aws::Backup::Model::BackupJob::StartByHasBeenSet ( ) const
inline

Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled. The value is calculated by adding the start window to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2 hours, the StartBy time would be 8:00 PM on the date specified. The value of StartBy is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Definition at line 767 of file BackupJob.h.

◆ StateHasBeenSet()

bool Aws::Backup::Model::BackupJob::StateHasBeenSet ( ) const
inline

The current state of a resource recovery point.

Definition at line 452 of file BackupJob.h.

◆ StatusMessageHasBeenSet()

bool Aws::Backup::Model::BackupJob::StatusMessageHasBeenSet ( ) const
inline

A detailed message explaining the status of the job to back up a resource.

Definition at line 485 of file BackupJob.h.

◆ WithAccountId() [1/3]

BackupJob& Aws::Backup::Model::BackupJob::WithAccountId ( const Aws::String value)
inline

The account ID that owns the backup job.

Definition at line 72 of file BackupJob.h.

◆ WithAccountId() [2/3]

BackupJob& Aws::Backup::Model::BackupJob::WithAccountId ( Aws::String &&  value)
inline

The account ID that owns the backup job.

Definition at line 77 of file BackupJob.h.

◆ WithAccountId() [3/3]

BackupJob& Aws::Backup::Model::BackupJob::WithAccountId ( const char *  value)
inline

The account ID that owns the backup job.

Definition at line 82 of file BackupJob.h.

◆ WithBackupJobId() [1/3]

BackupJob& Aws::Backup::Model::BackupJob::WithBackupJobId ( const Aws::String value)
inline

Uniquely identifies a request to AWS Backup to back up a resource.

Definition at line 113 of file BackupJob.h.

◆ WithBackupJobId() [2/3]

BackupJob& Aws::Backup::Model::BackupJob::WithBackupJobId ( Aws::String &&  value)
inline

Uniquely identifies a request to AWS Backup to back up a resource.

Definition at line 118 of file BackupJob.h.

◆ WithBackupJobId() [3/3]

BackupJob& Aws::Backup::Model::BackupJob::WithBackupJobId ( const char *  value)
inline

Uniquely identifies a request to AWS Backup to back up a resource.

Definition at line 123 of file BackupJob.h.

◆ WithBackupOptions() [1/2]

BackupJob& Aws::Backup::Model::BackupJob::WithBackupOptions ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.

Valid values: Set to "WindowsVSS”:“enabled" to enable WindowsVSS backup option and create a VSS Windows backup. Set to “WindowsVSS”:”disabled” to create a regular backup. If you specify an invalid option, you get an InvalidParameterValueException exception.

Definition at line 952 of file BackupJob.h.

◆ WithBackupOptions() [2/2]

BackupJob& Aws::Backup::Model::BackupJob::WithBackupOptions ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.

Valid values: Set to "WindowsVSS”:“enabled" to enable WindowsVSS backup option and create a VSS Windows backup. Set to “WindowsVSS”:”disabled” to create a regular backup. If you specify an invalid option, you get an InvalidParameterValueException exception.

Definition at line 962 of file BackupJob.h.

◆ WithBackupSizeInBytes()

BackupJob& Aws::Backup::Model::BackupJob::WithBackupSizeInBytes ( long long  value)
inline

The size, in bytes, of a backup.

Definition at line 591 of file BackupJob.h.

◆ WithBackupType() [1/3]

BackupJob& Aws::Backup::Model::BackupJob::WithBackupType ( const Aws::String value)
inline

Represents the type of backup for a backup job.

Definition at line 1063 of file BackupJob.h.

◆ WithBackupType() [2/3]

BackupJob& Aws::Backup::Model::BackupJob::WithBackupType ( Aws::String &&  value)
inline

Represents the type of backup for a backup job.

Definition at line 1068 of file BackupJob.h.

◆ WithBackupType() [3/3]

BackupJob& Aws::Backup::Model::BackupJob::WithBackupType ( const char *  value)
inline

Represents the type of backup for a backup job.

Definition at line 1073 of file BackupJob.h.

◆ WithBackupVaultArn() [1/3]

BackupJob& Aws::Backup::Model::BackupJob::WithBackupVaultArn ( const Aws::String value)
inline

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

Definition at line 231 of file BackupJob.h.

◆ WithBackupVaultArn() [2/3]

BackupJob& Aws::Backup::Model::BackupJob::WithBackupVaultArn ( Aws::String &&  value)
inline

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

Definition at line 238 of file BackupJob.h.

◆ WithBackupVaultArn() [3/3]

BackupJob& Aws::Backup::Model::BackupJob::WithBackupVaultArn ( const char *  value)
inline

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

Definition at line 245 of file BackupJob.h.

◆ WithBackupVaultName() [1/3]

BackupJob& Aws::Backup::Model::BackupJob::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 AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

Definition at line 172 of file BackupJob.h.

◆ WithBackupVaultName() [2/3]

BackupJob& Aws::Backup::Model::BackupJob::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 AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

Definition at line 180 of file BackupJob.h.

◆ WithBackupVaultName() [3/3]

BackupJob& Aws::Backup::Model::BackupJob::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 AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

Definition at line 188 of file BackupJob.h.

◆ WithBytesTransferred()

BackupJob& Aws::Backup::Model::BackupJob::WithBytesTransferred ( long long  value)
inline

The size in bytes transferred to a backup vault at the time that the job status was queried.

Definition at line 901 of file BackupJob.h.

◆ WithCompletionDate() [1/2]

BackupJob& Aws::Backup::Model::BackupJob::WithCompletionDate ( const Aws::Utils::DateTime value)
inline

The date and time a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Definition at line 433 of file BackupJob.h.

◆ WithCompletionDate() [2/2]

BackupJob& Aws::Backup::Model::BackupJob::WithCompletionDate ( Aws::Utils::DateTime &&  value)
inline

The date and time a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Definition at line 441 of file BackupJob.h.

◆ WithCreatedBy() [1/2]

BackupJob& Aws::Backup::Model::BackupJob::WithCreatedBy ( const RecoveryPointCreator value)
inline

Contains identifying information about the creation of a backup job, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan used to create it.

Definition at line 681 of file BackupJob.h.

◆ WithCreatedBy() [2/2]

BackupJob& Aws::Backup::Model::BackupJob::WithCreatedBy ( RecoveryPointCreator &&  value)
inline

Contains identifying information about the creation of a backup job, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan used to create it.

Definition at line 689 of file BackupJob.h.

◆ WithCreationDate() [1/2]

BackupJob& Aws::Backup::Model::BackupJob::WithCreationDate ( const Aws::Utils::DateTime value)
inline

The date and time a backup job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Definition at line 384 of file BackupJob.h.

◆ WithCreationDate() [2/2]

BackupJob& Aws::Backup::Model::BackupJob::WithCreationDate ( Aws::Utils::DateTime &&  value)
inline

The date and time a backup job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Definition at line 392 of file BackupJob.h.

◆ WithExpectedCompletionDate() [1/2]

BackupJob& Aws::Backup::Model::BackupJob::WithExpectedCompletionDate ( const Aws::Utils::DateTime value)
inline

The date and time a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC). The value of ExpectedCompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Definition at line 735 of file BackupJob.h.

◆ WithExpectedCompletionDate() [2/2]

BackupJob& Aws::Backup::Model::BackupJob::WithExpectedCompletionDate ( Aws::Utils::DateTime &&  value)
inline

The date and time a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC). The value of ExpectedCompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Definition at line 744 of file BackupJob.h.

◆ WithIamRoleArn() [1/3]

BackupJob& Aws::Backup::Model::BackupJob::WithIamRoleArn ( const Aws::String value)
inline

Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

Definition at line 628 of file BackupJob.h.

◆ WithIamRoleArn() [2/3]

BackupJob& Aws::Backup::Model::BackupJob::WithIamRoleArn ( Aws::String &&  value)
inline

Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

Definition at line 634 of file BackupJob.h.

◆ WithIamRoleArn() [3/3]

BackupJob& Aws::Backup::Model::BackupJob::WithIamRoleArn ( const char *  value)
inline

Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

Definition at line 640 of file BackupJob.h.

◆ WithPercentDone() [1/3]

BackupJob& Aws::Backup::Model::BackupJob::WithPercentDone ( const Aws::String value)
inline

Contains an estimated percentage complete of a job at the time the job status was queried.

Definition at line 558 of file BackupJob.h.

◆ WithPercentDone() [2/3]

BackupJob& Aws::Backup::Model::BackupJob::WithPercentDone ( Aws::String &&  value)
inline

Contains an estimated percentage complete of a job at the time the job status was queried.

Definition at line 564 of file BackupJob.h.

◆ WithPercentDone() [3/3]

BackupJob& Aws::Backup::Model::BackupJob::WithPercentDone ( const char *  value)
inline

Contains an estimated percentage complete of a job at the time the job status was queried.

Definition at line 570 of file BackupJob.h.

◆ WithRecoveryPointArn() [1/3]

BackupJob& Aws::Backup::Model::BackupJob::WithRecoveryPointArn ( const Aws::String value)
inline

An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

Definition at line 282 of file BackupJob.h.

◆ WithRecoveryPointArn() [2/3]

BackupJob& Aws::Backup::Model::BackupJob::WithRecoveryPointArn ( Aws::String &&  value)
inline

An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

Definition at line 288 of file BackupJob.h.

◆ WithRecoveryPointArn() [3/3]

BackupJob& Aws::Backup::Model::BackupJob::WithRecoveryPointArn ( const char *  value)
inline

An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

Definition at line 294 of file BackupJob.h.

◆ WithResourceArn() [1/3]

BackupJob& Aws::Backup::Model::BackupJob::WithResourceArn ( const Aws::String value)
inline

An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.

Definition at line 331 of file BackupJob.h.

◆ WithResourceArn() [2/3]

BackupJob& Aws::Backup::Model::BackupJob::WithResourceArn ( Aws::String &&  value)
inline

An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.

Definition at line 337 of file BackupJob.h.

◆ WithResourceArn() [3/3]

BackupJob& Aws::Backup::Model::BackupJob::WithResourceArn ( const char *  value)
inline

An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.

Definition at line 343 of file BackupJob.h.

◆ WithResourceType() [1/3]

BackupJob& Aws::Backup::Model::BackupJob::WithResourceType ( const Aws::String value)
inline

The type of AWS resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For VSS Windows backups, the only supported resource type is Amazon EC2.

Definition at line 860 of file BackupJob.h.

◆ WithResourceType() [2/3]

BackupJob& Aws::Backup::Model::BackupJob::WithResourceType ( Aws::String &&  value)
inline

The type of AWS resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For VSS Windows backups, the only supported resource type is Amazon EC2.

Definition at line 868 of file BackupJob.h.

◆ WithResourceType() [3/3]

BackupJob& Aws::Backup::Model::BackupJob::WithResourceType ( const char *  value)
inline

The type of AWS resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For VSS Windows backups, the only supported resource type is Amazon EC2.

Definition at line 876 of file BackupJob.h.

◆ WithStartBy() [1/2]

BackupJob& Aws::Backup::Model::BackupJob::WithStartBy ( const Aws::Utils::DateTime value)
inline

Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled. The value is calculated by adding the start window to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2 hours, the StartBy time would be 8:00 PM on the date specified. The value of StartBy is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Definition at line 800 of file BackupJob.h.

◆ WithStartBy() [2/2]

BackupJob& Aws::Backup::Model::BackupJob::WithStartBy ( Aws::Utils::DateTime &&  value)
inline

Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled. The value is calculated by adding the start window to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2 hours, the StartBy time would be 8:00 PM on the date specified. The value of StartBy is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Definition at line 811 of file BackupJob.h.

◆ WithState() [1/2]

BackupJob& Aws::Backup::Model::BackupJob::WithState ( const BackupJobState value)
inline

The current state of a resource recovery point.

Definition at line 467 of file BackupJob.h.

◆ WithState() [2/2]

BackupJob& Aws::Backup::Model::BackupJob::WithState ( BackupJobState &&  value)
inline

The current state of a resource recovery point.

Definition at line 472 of file BackupJob.h.

◆ WithStatusMessage() [1/3]

BackupJob& Aws::Backup::Model::BackupJob::WithStatusMessage ( const Aws::String value)
inline

A detailed message explaining the status of the job to back up a resource.

Definition at line 509 of file BackupJob.h.

◆ WithStatusMessage() [2/3]

BackupJob& Aws::Backup::Model::BackupJob::WithStatusMessage ( Aws::String &&  value)
inline

A detailed message explaining the status of the job to back up a resource.

Definition at line 515 of file BackupJob.h.

◆ WithStatusMessage() [3/3]

BackupJob& Aws::Backup::Model::BackupJob::WithStatusMessage ( const char *  value)
inline

A detailed message explaining the status of the job to back up a resource.

Definition at line 521 of file BackupJob.h.


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