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

#include <StartBackupJobRequest.h>

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

Public Member Functions

 StartBackupJobRequest ()
 
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)
 
StartBackupJobRequestWithBackupVaultName (const Aws::String &value)
 
StartBackupJobRequestWithBackupVaultName (Aws::String &&value)
 
StartBackupJobRequestWithBackupVaultName (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)
 
StartBackupJobRequestWithResourceArn (const Aws::String &value)
 
StartBackupJobRequestWithResourceArn (Aws::String &&value)
 
StartBackupJobRequestWithResourceArn (const char *value)
 
const Aws::StringGetIamRoleArn () const
 
bool IamRoleArnHasBeenSet () const
 
void SetIamRoleArn (const Aws::String &value)
 
void SetIamRoleArn (Aws::String &&value)
 
void SetIamRoleArn (const char *value)
 
StartBackupJobRequestWithIamRoleArn (const Aws::String &value)
 
StartBackupJobRequestWithIamRoleArn (Aws::String &&value)
 
StartBackupJobRequestWithIamRoleArn (const char *value)
 
const Aws::StringGetIdempotencyToken () const
 
bool IdempotencyTokenHasBeenSet () const
 
void SetIdempotencyToken (const Aws::String &value)
 
void SetIdempotencyToken (Aws::String &&value)
 
void SetIdempotencyToken (const char *value)
 
StartBackupJobRequestWithIdempotencyToken (const Aws::String &value)
 
StartBackupJobRequestWithIdempotencyToken (Aws::String &&value)
 
StartBackupJobRequestWithIdempotencyToken (const char *value)
 
long long GetStartWindowMinutes () const
 
bool StartWindowMinutesHasBeenSet () const
 
void SetStartWindowMinutes (long long value)
 
StartBackupJobRequestWithStartWindowMinutes (long long value)
 
long long GetCompleteWindowMinutes () const
 
bool CompleteWindowMinutesHasBeenSet () const
 
void SetCompleteWindowMinutes (long long value)
 
StartBackupJobRequestWithCompleteWindowMinutes (long long value)
 
const LifecycleGetLifecycle () const
 
bool LifecycleHasBeenSet () const
 
void SetLifecycle (const Lifecycle &value)
 
void SetLifecycle (Lifecycle &&value)
 
StartBackupJobRequestWithLifecycle (const Lifecycle &value)
 
StartBackupJobRequestWithLifecycle (Lifecycle &&value)
 
const Aws::Map< Aws::String, Aws::String > & GetRecoveryPointTags () const
 
bool RecoveryPointTagsHasBeenSet () const
 
void SetRecoveryPointTags (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetRecoveryPointTags (Aws::Map< Aws::String, Aws::String > &&value)
 
StartBackupJobRequestWithRecoveryPointTags (const Aws::Map< Aws::String, Aws::String > &value)
 
StartBackupJobRequestWithRecoveryPointTags (Aws::Map< Aws::String, Aws::String > &&value)
 
StartBackupJobRequestAddRecoveryPointTags (const Aws::String &key, const Aws::String &value)
 
StartBackupJobRequestAddRecoveryPointTags (Aws::String &&key, const Aws::String &value)
 
StartBackupJobRequestAddRecoveryPointTags (const Aws::String &key, Aws::String &&value)
 
StartBackupJobRequestAddRecoveryPointTags (Aws::String &&key, Aws::String &&value)
 
StartBackupJobRequestAddRecoveryPointTags (const char *key, Aws::String &&value)
 
StartBackupJobRequestAddRecoveryPointTags (Aws::String &&key, const char *value)
 
StartBackupJobRequestAddRecoveryPointTags (const char *key, const char *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)
 
StartBackupJobRequestWithBackupOptions (const Aws::Map< Aws::String, Aws::String > &value)
 
StartBackupJobRequestWithBackupOptions (Aws::Map< Aws::String, Aws::String > &&value)
 
StartBackupJobRequestAddBackupOptions (const Aws::String &key, const Aws::String &value)
 
StartBackupJobRequestAddBackupOptions (Aws::String &&key, const Aws::String &value)
 
StartBackupJobRequestAddBackupOptions (const Aws::String &key, Aws::String &&value)
 
StartBackupJobRequestAddBackupOptions (Aws::String &&key, Aws::String &&value)
 
StartBackupJobRequestAddBackupOptions (const char *key, Aws::String &&value)
 
StartBackupJobRequestAddBackupOptions (Aws::String &&key, const char *value)
 
StartBackupJobRequestAddBackupOptions (const char *key, const char *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 StartBackupJobRequest.h.

Constructor & Destructor Documentation

◆ StartBackupJobRequest()

Aws::Backup::Model::StartBackupJobRequest::StartBackupJobRequest ( )

Member Function Documentation

◆ AddBackupOptions() [1/7]

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

Specifies the backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.

Valid values: Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup. Set to "WindowsVSS""disabled" to create a regular backup. The WindowsVSS option is not enabled by default.

Definition at line 581 of file StartBackupJobRequest.h.

◆ AddBackupOptions() [2/7]

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

Specifies the backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.

Valid values: Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup. Set to "WindowsVSS""disabled" to create a regular backup. The WindowsVSS option is not enabled by default.

Definition at line 561 of file StartBackupJobRequest.h.

◆ AddBackupOptions() [3/7]

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

Specifies the backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.

Valid values: Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup. Set to "WindowsVSS""disabled" to create a regular backup. The WindowsVSS option is not enabled by default.

Definition at line 601 of file StartBackupJobRequest.h.

◆ AddBackupOptions() [4/7]

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

Specifies the backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.

Valid values: Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup. Set to "WindowsVSS""disabled" to create a regular backup. The WindowsVSS option is not enabled by default.

Definition at line 571 of file StartBackupJobRequest.h.

◆ AddBackupOptions() [5/7]

StartBackupJobRequest& Aws::Backup::Model::StartBackupJobRequest::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 Volume Shadow Copy Service (VSS) backup jobs.

Valid values: Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup. Set to "WindowsVSS""disabled" to create a regular backup. The WindowsVSS option is not enabled by default.

Definition at line 551 of file StartBackupJobRequest.h.

◆ AddBackupOptions() [6/7]

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

Specifies the backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.

Valid values: Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup. Set to "WindowsVSS""disabled" to create a regular backup. The WindowsVSS option is not enabled by default.

Definition at line 591 of file StartBackupJobRequest.h.

◆ AddBackupOptions() [7/7]

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

Specifies the backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.

Valid values: Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup. Set to "WindowsVSS""disabled" to create a regular backup. The WindowsVSS option is not enabled by default.

Definition at line 611 of file StartBackupJobRequest.h.

◆ AddRecoveryPointTags() [1/7]

StartBackupJobRequest& Aws::Backup::Model::StartBackupJobRequest::AddRecoveryPointTags ( Aws::String &&  key,
Aws::String &&  value 
)
inline

To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.

Definition at line 462 of file StartBackupJobRequest.h.

◆ AddRecoveryPointTags() [2/7]

StartBackupJobRequest& Aws::Backup::Model::StartBackupJobRequest::AddRecoveryPointTags ( Aws::String &&  key,
const Aws::String value 
)
inline

To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.

Definition at line 450 of file StartBackupJobRequest.h.

◆ AddRecoveryPointTags() [3/7]

StartBackupJobRequest& Aws::Backup::Model::StartBackupJobRequest::AddRecoveryPointTags ( Aws::String &&  key,
const char *  value 
)
inline

To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.

Definition at line 474 of file StartBackupJobRequest.h.

◆ AddRecoveryPointTags() [4/7]

StartBackupJobRequest& Aws::Backup::Model::StartBackupJobRequest::AddRecoveryPointTags ( const Aws::String key,
Aws::String &&  value 
)
inline

To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.

Definition at line 456 of file StartBackupJobRequest.h.

◆ AddRecoveryPointTags() [5/7]

StartBackupJobRequest& Aws::Backup::Model::StartBackupJobRequest::AddRecoveryPointTags ( const Aws::String key,
const Aws::String value 
)
inline

To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.

Definition at line 444 of file StartBackupJobRequest.h.

◆ AddRecoveryPointTags() [6/7]

StartBackupJobRequest& Aws::Backup::Model::StartBackupJobRequest::AddRecoveryPointTags ( const char *  key,
Aws::String &&  value 
)
inline

To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.

Definition at line 468 of file StartBackupJobRequest.h.

◆ AddRecoveryPointTags() [7/7]

StartBackupJobRequest& Aws::Backup::Model::StartBackupJobRequest::AddRecoveryPointTags ( const char *  key,
const char *  value 
)
inline

To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.

Definition at line 480 of file StartBackupJobRequest.h.

◆ BackupOptionsHasBeenSet()

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

Specifies the backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.

Valid values: Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup. Set to "WindowsVSS""disabled" to create a regular backup. The WindowsVSS option is not enabled by default.

Definition at line 501 of file StartBackupJobRequest.h.

◆ BackupVaultNameHasBeenSet()

bool Aws::Backup::Model::StartBackupJobRequest::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 StartBackupJobRequest.h.

◆ CompleteWindowMinutesHasBeenSet()

bool Aws::Backup::Model::StartBackupJobRequest::CompleteWindowMinutesHasBeenSet ( ) const
inline

A value in minutes during which a successfully started backup must complete, or else AWS Backup will cancel the job. This value is optional. This value begins counting down from when the backup was scheduled. It does not add additional time for StartWindowMinutes, or if the backup started later than scheduled.

Definition at line 310 of file StartBackupJobRequest.h.

◆ GetBackupOptions()

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

Specifies the backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.

Valid values: Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup. Set to "WindowsVSS""disabled" to create a regular backup. The WindowsVSS option is not enabled by default.

Definition at line 491 of file StartBackupJobRequest.h.

◆ GetBackupVaultName()

const Aws::String& Aws::Backup::Model::StartBackupJobRequest::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 StartBackupJobRequest.h.

◆ GetCompleteWindowMinutes()

long long Aws::Backup::Model::StartBackupJobRequest::GetCompleteWindowMinutes ( ) const
inline

A value in minutes during which a successfully started backup must complete, or else AWS Backup will cancel the job. This value is optional. This value begins counting down from when the backup was scheduled. It does not add additional time for StartWindowMinutes, or if the backup started later than scheduled.

Definition at line 301 of file StartBackupJobRequest.h.

◆ GetIamRoleArn()

const Aws::String& Aws::Backup::Model::StartBackupJobRequest::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 155 of file StartBackupJobRequest.h.

◆ GetIdempotencyToken()

const Aws::String& Aws::Backup::Model::StartBackupJobRequest::GetIdempotencyToken ( ) const
inline

A customer-chosen string that you can use to distinguish between otherwise identical calls to StartBackupJob. Retrying a successful request with the same idempotency token results in a success message with no action taken.

Definition at line 206 of file StartBackupJobRequest.h.

◆ GetLifecycle()

const Lifecycle& Aws::Backup::Model::StartBackupJobRequest::GetLifecycle ( ) const
inline

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup will transition and expire backups automatically according to the lifecycle that you define.

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

Only Amazon EFS file system backups can be transitioned to cold storage.

Definition at line 341 of file StartBackupJobRequest.h.

◆ GetRecoveryPointTags()

const Aws::Map<Aws::String, Aws::String>& Aws::Backup::Model::StartBackupJobRequest::GetRecoveryPointTags ( ) const
inline

To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.

Definition at line 408 of file StartBackupJobRequest.h.

◆ GetResourceArn()

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

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

Definition at line 106 of file StartBackupJobRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file StartBackupJobRequest.h.

◆ GetStartWindowMinutes()

long long Aws::Backup::Model::StartBackupJobRequest::GetStartWindowMinutes ( ) const
inline

A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional, and the default is 8 hours.

Definition at line 270 of file StartBackupJobRequest.h.

◆ IamRoleArnHasBeenSet()

bool Aws::Backup::Model::StartBackupJobRequest::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 161 of file StartBackupJobRequest.h.

◆ IdempotencyTokenHasBeenSet()

bool Aws::Backup::Model::StartBackupJobRequest::IdempotencyTokenHasBeenSet ( ) const
inline

A customer-chosen string that you can use to distinguish between otherwise identical calls to StartBackupJob. Retrying a successful request with the same idempotency token results in a success message with no action taken.

Definition at line 214 of file StartBackupJobRequest.h.

◆ LifecycleHasBeenSet()

bool Aws::Backup::Model::StartBackupJobRequest::LifecycleHasBeenSet ( ) const
inline

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup will transition and expire backups automatically according to the lifecycle that you define.

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

Only Amazon EFS file system backups can be transitioned to cold storage.

Definition at line 353 of file StartBackupJobRequest.h.

◆ RecoveryPointTagsHasBeenSet()

bool Aws::Backup::Model::StartBackupJobRequest::RecoveryPointTagsHasBeenSet ( ) const
inline

To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.

Definition at line 414 of file StartBackupJobRequest.h.

◆ ResourceArnHasBeenSet()

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

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

Definition at line 112 of file StartBackupJobRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetBackupOptions() [1/2]

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

Specifies the backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.

Valid values: Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup. Set to "WindowsVSS""disabled" to create a regular backup. The WindowsVSS option is not enabled by default.

Definition at line 521 of file StartBackupJobRequest.h.

◆ SetBackupOptions() [2/2]

void Aws::Backup::Model::StartBackupJobRequest::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 Volume Shadow Copy Service (VSS) backup jobs.

Valid values: Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup. Set to "WindowsVSS""disabled" to create a regular backup. The WindowsVSS option is not enabled by default.

Definition at line 511 of file StartBackupJobRequest.h.

◆ SetBackupVaultName() [1/3]

void Aws::Backup::Model::StartBackupJobRequest::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 StartBackupJobRequest.h.

◆ SetBackupVaultName() [2/3]

void Aws::Backup::Model::StartBackupJobRequest::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 StartBackupJobRequest.h.

◆ SetBackupVaultName() [3/3]

void Aws::Backup::Model::StartBackupJobRequest::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 StartBackupJobRequest.h.

◆ SetCompleteWindowMinutes()

void Aws::Backup::Model::StartBackupJobRequest::SetCompleteWindowMinutes ( long long  value)
inline

A value in minutes during which a successfully started backup must complete, or else AWS Backup will cancel the job. This value is optional. This value begins counting down from when the backup was scheduled. It does not add additional time for StartWindowMinutes, or if the backup started later than scheduled.

Definition at line 319 of file StartBackupJobRequest.h.

◆ SetIamRoleArn() [1/3]

void Aws::Backup::Model::StartBackupJobRequest::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 173 of file StartBackupJobRequest.h.

◆ SetIamRoleArn() [2/3]

void Aws::Backup::Model::StartBackupJobRequest::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 167 of file StartBackupJobRequest.h.

◆ SetIamRoleArn() [3/3]

void Aws::Backup::Model::StartBackupJobRequest::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 179 of file StartBackupJobRequest.h.

◆ SetIdempotencyToken() [1/3]

void Aws::Backup::Model::StartBackupJobRequest::SetIdempotencyToken ( Aws::String &&  value)
inline

A customer-chosen string that you can use to distinguish between otherwise identical calls to StartBackupJob. Retrying a successful request with the same idempotency token results in a success message with no action taken.

Definition at line 230 of file StartBackupJobRequest.h.

◆ SetIdempotencyToken() [2/3]

void Aws::Backup::Model::StartBackupJobRequest::SetIdempotencyToken ( const Aws::String value)
inline

A customer-chosen string that you can use to distinguish between otherwise identical calls to StartBackupJob. Retrying a successful request with the same idempotency token results in a success message with no action taken.

Definition at line 222 of file StartBackupJobRequest.h.

◆ SetIdempotencyToken() [3/3]

void Aws::Backup::Model::StartBackupJobRequest::SetIdempotencyToken ( const char *  value)
inline

A customer-chosen string that you can use to distinguish between otherwise identical calls to StartBackupJob. Retrying a successful request with the same idempotency token results in a success message with no action taken.

Definition at line 238 of file StartBackupJobRequest.h.

◆ SetLifecycle() [1/2]

void Aws::Backup::Model::StartBackupJobRequest::SetLifecycle ( const Lifecycle value)
inline

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup will transition and expire backups automatically according to the lifecycle that you define.

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

Only Amazon EFS file system backups can be transitioned to cold storage.

Definition at line 365 of file StartBackupJobRequest.h.

◆ SetLifecycle() [2/2]

void Aws::Backup::Model::StartBackupJobRequest::SetLifecycle ( Lifecycle &&  value)
inline

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup will transition and expire backups automatically according to the lifecycle that you define.

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

Only Amazon EFS file system backups can be transitioned to cold storage.

Definition at line 377 of file StartBackupJobRequest.h.

◆ SetRecoveryPointTags() [1/2]

void Aws::Backup::Model::StartBackupJobRequest::SetRecoveryPointTags ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.

Definition at line 426 of file StartBackupJobRequest.h.

◆ SetRecoveryPointTags() [2/2]

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

To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.

Definition at line 420 of file StartBackupJobRequest.h.

◆ SetResourceArn() [1/3]

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

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

Definition at line 124 of file StartBackupJobRequest.h.

◆ SetResourceArn() [2/3]

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

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

Definition at line 118 of file StartBackupJobRequest.h.

◆ SetResourceArn() [3/3]

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

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

Definition at line 130 of file StartBackupJobRequest.h.

◆ SetStartWindowMinutes()

void Aws::Backup::Model::StartBackupJobRequest::SetStartWindowMinutes ( long long  value)
inline

A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional, and the default is 8 hours.

Definition at line 284 of file StartBackupJobRequest.h.

◆ StartWindowMinutesHasBeenSet()

bool Aws::Backup::Model::StartBackupJobRequest::StartWindowMinutesHasBeenSet ( ) const
inline

A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional, and the default is 8 hours.

Definition at line 277 of file StartBackupJobRequest.h.

◆ WithBackupOptions() [1/2]

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

Specifies the backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.

Valid values: Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup. Set to "WindowsVSS""disabled" to create a regular backup. The WindowsVSS option is not enabled by default.

Definition at line 541 of file StartBackupJobRequest.h.

◆ WithBackupOptions() [2/2]

StartBackupJobRequest& Aws::Backup::Model::StartBackupJobRequest::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 Volume Shadow Copy Service (VSS) backup jobs.

Valid values: Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup. Set to "WindowsVSS""disabled" to create a regular backup. The WindowsVSS option is not enabled by default.

Definition at line 531 of file StartBackupJobRequest.h.

◆ WithBackupVaultName() [1/3]

StartBackupJobRequest& Aws::Backup::Model::StartBackupJobRequest::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 StartBackupJobRequest.h.

◆ WithBackupVaultName() [2/3]

StartBackupJobRequest& Aws::Backup::Model::StartBackupJobRequest::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 StartBackupJobRequest.h.

◆ WithBackupVaultName() [3/3]

StartBackupJobRequest& Aws::Backup::Model::StartBackupJobRequest::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 StartBackupJobRequest.h.

◆ WithCompleteWindowMinutes()

StartBackupJobRequest& Aws::Backup::Model::StartBackupJobRequest::WithCompleteWindowMinutes ( long long  value)
inline

A value in minutes during which a successfully started backup must complete, or else AWS Backup will cancel the job. This value is optional. This value begins counting down from when the backup was scheduled. It does not add additional time for StartWindowMinutes, or if the backup started later than scheduled.

Definition at line 328 of file StartBackupJobRequest.h.

◆ WithIamRoleArn() [1/3]

StartBackupJobRequest& Aws::Backup::Model::StartBackupJobRequest::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 191 of file StartBackupJobRequest.h.

◆ WithIamRoleArn() [2/3]

StartBackupJobRequest& Aws::Backup::Model::StartBackupJobRequest::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 185 of file StartBackupJobRequest.h.

◆ WithIamRoleArn() [3/3]

StartBackupJobRequest& Aws::Backup::Model::StartBackupJobRequest::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 197 of file StartBackupJobRequest.h.

◆ WithIdempotencyToken() [1/3]

StartBackupJobRequest& Aws::Backup::Model::StartBackupJobRequest::WithIdempotencyToken ( Aws::String &&  value)
inline

A customer-chosen string that you can use to distinguish between otherwise identical calls to StartBackupJob. Retrying a successful request with the same idempotency token results in a success message with no action taken.

Definition at line 254 of file StartBackupJobRequest.h.

◆ WithIdempotencyToken() [2/3]

StartBackupJobRequest& Aws::Backup::Model::StartBackupJobRequest::WithIdempotencyToken ( const Aws::String value)
inline

A customer-chosen string that you can use to distinguish between otherwise identical calls to StartBackupJob. Retrying a successful request with the same idempotency token results in a success message with no action taken.

Definition at line 246 of file StartBackupJobRequest.h.

◆ WithIdempotencyToken() [3/3]

StartBackupJobRequest& Aws::Backup::Model::StartBackupJobRequest::WithIdempotencyToken ( const char *  value)
inline

A customer-chosen string that you can use to distinguish between otherwise identical calls to StartBackupJob. Retrying a successful request with the same idempotency token results in a success message with no action taken.

Definition at line 262 of file StartBackupJobRequest.h.

◆ WithLifecycle() [1/2]

StartBackupJobRequest& Aws::Backup::Model::StartBackupJobRequest::WithLifecycle ( const Lifecycle value)
inline

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup will transition and expire backups automatically according to the lifecycle that you define.

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

Only Amazon EFS file system backups can be transitioned to cold storage.

Definition at line 389 of file StartBackupJobRequest.h.

◆ WithLifecycle() [2/2]

StartBackupJobRequest& Aws::Backup::Model::StartBackupJobRequest::WithLifecycle ( Lifecycle &&  value)
inline

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup will transition and expire backups automatically according to the lifecycle that you define.

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

Only Amazon EFS file system backups can be transitioned to cold storage.

Definition at line 401 of file StartBackupJobRequest.h.

◆ WithRecoveryPointTags() [1/2]

StartBackupJobRequest& Aws::Backup::Model::StartBackupJobRequest::WithRecoveryPointTags ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.

Definition at line 438 of file StartBackupJobRequest.h.

◆ WithRecoveryPointTags() [2/2]

StartBackupJobRequest& Aws::Backup::Model::StartBackupJobRequest::WithRecoveryPointTags ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.

Definition at line 432 of file StartBackupJobRequest.h.

◆ WithResourceArn() [1/3]

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

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

Definition at line 142 of file StartBackupJobRequest.h.

◆ WithResourceArn() [2/3]

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

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

Definition at line 136 of file StartBackupJobRequest.h.

◆ WithResourceArn() [3/3]

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

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

Definition at line 148 of file StartBackupJobRequest.h.

◆ WithStartWindowMinutes()

StartBackupJobRequest& Aws::Backup::Model::StartBackupJobRequest::WithStartWindowMinutes ( long long  value)
inline

A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional, and the default is 8 hours.

Definition at line 291 of file StartBackupJobRequest.h.


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