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

#include <StartRestoreJobRequest.h>

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

Public Member Functions

 StartRestoreJobRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetRecoveryPointArn () const
 
bool RecoveryPointArnHasBeenSet () const
 
void SetRecoveryPointArn (const Aws::String &value)
 
void SetRecoveryPointArn (Aws::String &&value)
 
void SetRecoveryPointArn (const char *value)
 
StartRestoreJobRequestWithRecoveryPointArn (const Aws::String &value)
 
StartRestoreJobRequestWithRecoveryPointArn (Aws::String &&value)
 
StartRestoreJobRequestWithRecoveryPointArn (const char *value)
 
const Aws::Map< Aws::String, Aws::String > & GetMetadata () const
 
bool MetadataHasBeenSet () const
 
void SetMetadata (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetMetadata (Aws::Map< Aws::String, Aws::String > &&value)
 
StartRestoreJobRequestWithMetadata (const Aws::Map< Aws::String, Aws::String > &value)
 
StartRestoreJobRequestWithMetadata (Aws::Map< Aws::String, Aws::String > &&value)
 
StartRestoreJobRequestAddMetadata (const Aws::String &key, const Aws::String &value)
 
StartRestoreJobRequestAddMetadata (Aws::String &&key, const Aws::String &value)
 
StartRestoreJobRequestAddMetadata (const Aws::String &key, Aws::String &&value)
 
StartRestoreJobRequestAddMetadata (Aws::String &&key, Aws::String &&value)
 
StartRestoreJobRequestAddMetadata (const char *key, Aws::String &&value)
 
StartRestoreJobRequestAddMetadata (Aws::String &&key, const char *value)
 
StartRestoreJobRequestAddMetadata (const char *key, 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)
 
StartRestoreJobRequestWithIamRoleArn (const Aws::String &value)
 
StartRestoreJobRequestWithIamRoleArn (Aws::String &&value)
 
StartRestoreJobRequestWithIamRoleArn (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)
 
StartRestoreJobRequestWithIdempotencyToken (const Aws::String &value)
 
StartRestoreJobRequestWithIdempotencyToken (Aws::String &&value)
 
StartRestoreJobRequestWithIdempotencyToken (const char *value)
 
const Aws::StringGetResourceType () const
 
bool ResourceTypeHasBeenSet () const
 
void SetResourceType (const Aws::String &value)
 
void SetResourceType (Aws::String &&value)
 
void SetResourceType (const char *value)
 
StartRestoreJobRequestWithResourceType (const Aws::String &value)
 
StartRestoreJobRequestWithResourceType (Aws::String &&value)
 
StartRestoreJobRequestWithResourceType (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 22 of file StartRestoreJobRequest.h.

Constructor & Destructor Documentation

◆ StartRestoreJobRequest()

Aws::Backup::Model::StartRestoreJobRequest::StartRestoreJobRequest ( )

Member Function Documentation

◆ AddMetadata() [1/7]

StartRestoreJobRequest& Aws::Backup::Model::StartRestoreJobRequest::AddMetadata ( const Aws::String key,
const Aws::String value 
)
inline

A set of metadata key-value pairs. Contains information, such as a resource name, required to restore a recovery point.

You can get configuration metadata about a resource at the time it was backed up by calling GetRecoveryPointRestoreMetadata. However, values in addition to those provided by GetRecoveryPointRestoreMetadata might be required to restore a resource. For example, you might need to provide a new resource name if the original already exists.

You need to specify specific metadata to restore an Amazon Elastic File System (Amazon EFS) instance:

  • file-system-id: The ID of the Amazon EFS file system that is backed up by AWS Backup. Returned in GetRecoveryPointRestoreMetadata.

  • Encrypted: A Boolean value that, if true, specifies that the file system is encrypted. If KmsKeyId is specified, Encrypted must be set to true.

  • KmsKeyId: Specifies the AWS KMS key that is used to encrypt the restored file system. You can specify a key from another AWS account provided that key it is properly shared with your account via AWS KMS.

  • PerformanceMode: Specifies the throughput mode of the file system.

  • CreationToken: A user-supplied value that ensures the uniqueness (idempotency) of the request.

  • newFileSystem: A Boolean value that, if true, specifies that the recovery point is restored to a new Amazon EFS file system.

  • ItemsToRestore : A serialized list of up to five strings where each string is a file path. Use ItemsToRestore to restore specific files or directories rather than the entire file system. This parameter is optional.

Definition at line 293 of file StartRestoreJobRequest.h.

◆ AddMetadata() [2/7]

StartRestoreJobRequest& Aws::Backup::Model::StartRestoreJobRequest::AddMetadata ( Aws::String &&  key,
const Aws::String value 
)
inline

A set of metadata key-value pairs. Contains information, such as a resource name, required to restore a recovery point.

You can get configuration metadata about a resource at the time it was backed up by calling GetRecoveryPointRestoreMetadata. However, values in addition to those provided by GetRecoveryPointRestoreMetadata might be required to restore a resource. For example, you might need to provide a new resource name if the original already exists.

You need to specify specific metadata to restore an Amazon Elastic File System (Amazon EFS) instance:

  • file-system-id: The ID of the Amazon EFS file system that is backed up by AWS Backup. Returned in GetRecoveryPointRestoreMetadata.

  • Encrypted: A Boolean value that, if true, specifies that the file system is encrypted. If KmsKeyId is specified, Encrypted must be set to true.

  • KmsKeyId: Specifies the AWS KMS key that is used to encrypt the restored file system. You can specify a key from another AWS account provided that key it is properly shared with your account via AWS KMS.

  • PerformanceMode: Specifies the throughput mode of the file system.

  • CreationToken: A user-supplied value that ensures the uniqueness (idempotency) of the request.

  • newFileSystem: A Boolean value that, if true, specifies that the recovery point is restored to a new Amazon EFS file system.

  • ItemsToRestore : A serialized list of up to five strings where each string is a file path. Use ItemsToRestore to restore specific files or directories rather than the entire file system. This parameter is optional.

Definition at line 323 of file StartRestoreJobRequest.h.

◆ AddMetadata() [3/7]

StartRestoreJobRequest& Aws::Backup::Model::StartRestoreJobRequest::AddMetadata ( const Aws::String key,
Aws::String &&  value 
)
inline

A set of metadata key-value pairs. Contains information, such as a resource name, required to restore a recovery point.

You can get configuration metadata about a resource at the time it was backed up by calling GetRecoveryPointRestoreMetadata. However, values in addition to those provided by GetRecoveryPointRestoreMetadata might be required to restore a resource. For example, you might need to provide a new resource name if the original already exists.

You need to specify specific metadata to restore an Amazon Elastic File System (Amazon EFS) instance:

  • file-system-id: The ID of the Amazon EFS file system that is backed up by AWS Backup. Returned in GetRecoveryPointRestoreMetadata.

  • Encrypted: A Boolean value that, if true, specifies that the file system is encrypted. If KmsKeyId is specified, Encrypted must be set to true.

  • KmsKeyId: Specifies the AWS KMS key that is used to encrypt the restored file system. You can specify a key from another AWS account provided that key it is properly shared with your account via AWS KMS.

  • PerformanceMode: Specifies the throughput mode of the file system.

  • CreationToken: A user-supplied value that ensures the uniqueness (idempotency) of the request.

  • newFileSystem: A Boolean value that, if true, specifies that the recovery point is restored to a new Amazon EFS file system.

  • ItemsToRestore : A serialized list of up to five strings where each string is a file path. Use ItemsToRestore to restore specific files or directories rather than the entire file system. This parameter is optional.

Definition at line 353 of file StartRestoreJobRequest.h.

◆ AddMetadata() [4/7]

StartRestoreJobRequest& Aws::Backup::Model::StartRestoreJobRequest::AddMetadata ( Aws::String &&  key,
Aws::String &&  value 
)
inline

A set of metadata key-value pairs. Contains information, such as a resource name, required to restore a recovery point.

You can get configuration metadata about a resource at the time it was backed up by calling GetRecoveryPointRestoreMetadata. However, values in addition to those provided by GetRecoveryPointRestoreMetadata might be required to restore a resource. For example, you might need to provide a new resource name if the original already exists.

You need to specify specific metadata to restore an Amazon Elastic File System (Amazon EFS) instance:

  • file-system-id: The ID of the Amazon EFS file system that is backed up by AWS Backup. Returned in GetRecoveryPointRestoreMetadata.

  • Encrypted: A Boolean value that, if true, specifies that the file system is encrypted. If KmsKeyId is specified, Encrypted must be set to true.

  • KmsKeyId: Specifies the AWS KMS key that is used to encrypt the restored file system. You can specify a key from another AWS account provided that key it is properly shared with your account via AWS KMS.

  • PerformanceMode: Specifies the throughput mode of the file system.

  • CreationToken: A user-supplied value that ensures the uniqueness (idempotency) of the request.

  • newFileSystem: A Boolean value that, if true, specifies that the recovery point is restored to a new Amazon EFS file system.

  • ItemsToRestore : A serialized list of up to five strings where each string is a file path. Use ItemsToRestore to restore specific files or directories rather than the entire file system. This parameter is optional.

Definition at line 383 of file StartRestoreJobRequest.h.

◆ AddMetadata() [5/7]

StartRestoreJobRequest& Aws::Backup::Model::StartRestoreJobRequest::AddMetadata ( const char *  key,
Aws::String &&  value 
)
inline

A set of metadata key-value pairs. Contains information, such as a resource name, required to restore a recovery point.

You can get configuration metadata about a resource at the time it was backed up by calling GetRecoveryPointRestoreMetadata. However, values in addition to those provided by GetRecoveryPointRestoreMetadata might be required to restore a resource. For example, you might need to provide a new resource name if the original already exists.

You need to specify specific metadata to restore an Amazon Elastic File System (Amazon EFS) instance:

  • file-system-id: The ID of the Amazon EFS file system that is backed up by AWS Backup. Returned in GetRecoveryPointRestoreMetadata.

  • Encrypted: A Boolean value that, if true, specifies that the file system is encrypted. If KmsKeyId is specified, Encrypted must be set to true.

  • KmsKeyId: Specifies the AWS KMS key that is used to encrypt the restored file system. You can specify a key from another AWS account provided that key it is properly shared with your account via AWS KMS.

  • PerformanceMode: Specifies the throughput mode of the file system.

  • CreationToken: A user-supplied value that ensures the uniqueness (idempotency) of the request.

  • newFileSystem: A Boolean value that, if true, specifies that the recovery point is restored to a new Amazon EFS file system.

  • ItemsToRestore : A serialized list of up to five strings where each string is a file path. Use ItemsToRestore to restore specific files or directories rather than the entire file system. This parameter is optional.

Definition at line 413 of file StartRestoreJobRequest.h.

◆ AddMetadata() [6/7]

StartRestoreJobRequest& Aws::Backup::Model::StartRestoreJobRequest::AddMetadata ( Aws::String &&  key,
const char *  value 
)
inline

A set of metadata key-value pairs. Contains information, such as a resource name, required to restore a recovery point.

You can get configuration metadata about a resource at the time it was backed up by calling GetRecoveryPointRestoreMetadata. However, values in addition to those provided by GetRecoveryPointRestoreMetadata might be required to restore a resource. For example, you might need to provide a new resource name if the original already exists.

You need to specify specific metadata to restore an Amazon Elastic File System (Amazon EFS) instance:

  • file-system-id: The ID of the Amazon EFS file system that is backed up by AWS Backup. Returned in GetRecoveryPointRestoreMetadata.

  • Encrypted: A Boolean value that, if true, specifies that the file system is encrypted. If KmsKeyId is specified, Encrypted must be set to true.

  • KmsKeyId: Specifies the AWS KMS key that is used to encrypt the restored file system. You can specify a key from another AWS account provided that key it is properly shared with your account via AWS KMS.

  • PerformanceMode: Specifies the throughput mode of the file system.

  • CreationToken: A user-supplied value that ensures the uniqueness (idempotency) of the request.

  • newFileSystem: A Boolean value that, if true, specifies that the recovery point is restored to a new Amazon EFS file system.

  • ItemsToRestore : A serialized list of up to five strings where each string is a file path. Use ItemsToRestore to restore specific files or directories rather than the entire file system. This parameter is optional.

Definition at line 443 of file StartRestoreJobRequest.h.

◆ AddMetadata() [7/7]

StartRestoreJobRequest& Aws::Backup::Model::StartRestoreJobRequest::AddMetadata ( const char *  key,
const char *  value 
)
inline

A set of metadata key-value pairs. Contains information, such as a resource name, required to restore a recovery point.

You can get configuration metadata about a resource at the time it was backed up by calling GetRecoveryPointRestoreMetadata. However, values in addition to those provided by GetRecoveryPointRestoreMetadata might be required to restore a resource. For example, you might need to provide a new resource name if the original already exists.

You need to specify specific metadata to restore an Amazon Elastic File System (Amazon EFS) instance:

  • file-system-id: The ID of the Amazon EFS file system that is backed up by AWS Backup. Returned in GetRecoveryPointRestoreMetadata.

  • Encrypted: A Boolean value that, if true, specifies that the file system is encrypted. If KmsKeyId is specified, Encrypted must be set to true.

  • KmsKeyId: Specifies the AWS KMS key that is used to encrypt the restored file system. You can specify a key from another AWS account provided that key it is properly shared with your account via AWS KMS.

  • PerformanceMode: Specifies the throughput mode of the file system.

  • CreationToken: A user-supplied value that ensures the uniqueness (idempotency) of the request.

  • newFileSystem: A Boolean value that, if true, specifies that the recovery point is restored to a new Amazon EFS file system.

  • ItemsToRestore : A serialized list of up to five strings where each string is a file path. Use ItemsToRestore to restore specific files or directories rather than the entire file system. This parameter is optional.

Definition at line 473 of file StartRestoreJobRequest.h.

◆ GetIamRoleArn()

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

The Amazon Resource Name (ARN) of the IAM role that AWS Backup uses to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

Definition at line 481 of file StartRestoreJobRequest.h.

◆ GetIdempotencyToken()

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

A customer chosen string that can be used to distinguish between calls to StartRestoreJob.

Definition at line 537 of file StartRestoreJobRequest.h.

◆ GetMetadata()

const Aws::Map<Aws::String, Aws::String>& Aws::Backup::Model::StartRestoreJobRequest::GetMetadata ( ) const
inline

A set of metadata key-value pairs. Contains information, such as a resource name, required to restore a recovery point.

You can get configuration metadata about a resource at the time it was backed up by calling GetRecoveryPointRestoreMetadata. However, values in addition to those provided by GetRecoveryPointRestoreMetadata might be required to restore a resource. For example, you might need to provide a new resource name if the original already exists.

You need to specify specific metadata to restore an Amazon Elastic File System (Amazon EFS) instance:

  • file-system-id: The ID of the Amazon EFS file system that is backed up by AWS Backup. Returned in GetRecoveryPointRestoreMetadata.

  • Encrypted: A Boolean value that, if true, specifies that the file system is encrypted. If KmsKeyId is specified, Encrypted must be set to true.

  • KmsKeyId: Specifies the AWS KMS key that is used to encrypt the restored file system. You can specify a key from another AWS account provided that key it is properly shared with your account via AWS KMS.

  • PerformanceMode: Specifies the throughput mode of the file system.

  • CreationToken: A user-supplied value that ensures the uniqueness (idempotency) of the request.

  • newFileSystem: A Boolean value that, if true, specifies that the recovery point is restored to a new Amazon EFS file system.

  • ItemsToRestore : A serialized list of up to five strings where each string is a file path. Use ItemsToRestore to restore specific files or directories rather than the entire file system. This parameter is optional.

Definition at line 113 of file StartRestoreJobRequest.h.

◆ GetRecoveryPointArn()

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

◆ GetResourceType()

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

Starts a job to restore a recovery point for one of the following resources:

  • DynamoDB for Amazon DynamoDB

  • EBS for Amazon Elastic Block Store

  • EC2 for Amazon Elastic Compute Cloud

  • EFS for Amazon Elastic File System

  • RDS for Amazon Relational Database Service

  • Storage Gateway for AWS Storage Gateway

Definition at line 591 of file StartRestoreJobRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 31 of file StartRestoreJobRequest.h.

◆ IamRoleArnHasBeenSet()

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

The Amazon Resource Name (ARN) of the IAM role that AWS Backup uses to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

Definition at line 488 of file StartRestoreJobRequest.h.

◆ IdempotencyTokenHasBeenSet()

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

A customer chosen string that can be used to distinguish between calls to StartRestoreJob.

Definition at line 543 of file StartRestoreJobRequest.h.

◆ MetadataHasBeenSet()

bool Aws::Backup::Model::StartRestoreJobRequest::MetadataHasBeenSet ( ) const
inline

A set of metadata key-value pairs. Contains information, such as a resource name, required to restore a recovery point.

You can get configuration metadata about a resource at the time it was backed up by calling GetRecoveryPointRestoreMetadata. However, values in addition to those provided by GetRecoveryPointRestoreMetadata might be required to restore a resource. For example, you might need to provide a new resource name if the original already exists.

You need to specify specific metadata to restore an Amazon Elastic File System (Amazon EFS) instance:

  • file-system-id: The ID of the Amazon EFS file system that is backed up by AWS Backup. Returned in GetRecoveryPointRestoreMetadata.

  • Encrypted: A Boolean value that, if true, specifies that the file system is encrypted. If KmsKeyId is specified, Encrypted must be set to true.

  • KmsKeyId: Specifies the AWS KMS key that is used to encrypt the restored file system. You can specify a key from another AWS account provided that key it is properly shared with your account via AWS KMS.

  • PerformanceMode: Specifies the throughput mode of the file system.

  • CreationToken: A user-supplied value that ensures the uniqueness (idempotency) of the request.

  • newFileSystem: A Boolean value that, if true, specifies that the recovery point is restored to a new Amazon EFS file system.

  • ItemsToRestore : A serialized list of up to five strings where each string is a file path. Use ItemsToRestore to restore specific files or directories rather than the entire file system. This parameter is optional.

Definition at line 143 of file StartRestoreJobRequest.h.

◆ RecoveryPointArnHasBeenSet()

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

◆ ResourceTypeHasBeenSet()

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

Starts a job to restore a recovery point for one of the following resources:

  • DynamoDB for Amazon DynamoDB

  • EBS for Amazon Elastic Block Store

  • EC2 for Amazon Elastic Compute Cloud

  • EFS for Amazon Elastic File System

  • RDS for Amazon Relational Database Service

  • Storage Gateway for AWS Storage Gateway

Definition at line 602 of file StartRestoreJobRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetIamRoleArn() [1/3]

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

The Amazon Resource Name (ARN) of the IAM role that AWS Backup uses to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

Definition at line 495 of file StartRestoreJobRequest.h.

◆ SetIamRoleArn() [2/3]

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

The Amazon Resource Name (ARN) of the IAM role that AWS Backup uses to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

Definition at line 502 of file StartRestoreJobRequest.h.

◆ SetIamRoleArn() [3/3]

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

The Amazon Resource Name (ARN) of the IAM role that AWS Backup uses to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

Definition at line 509 of file StartRestoreJobRequest.h.

◆ SetIdempotencyToken() [1/3]

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

A customer chosen string that can be used to distinguish between calls to StartRestoreJob.

Definition at line 549 of file StartRestoreJobRequest.h.

◆ SetIdempotencyToken() [2/3]

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

A customer chosen string that can be used to distinguish between calls to StartRestoreJob.

Definition at line 555 of file StartRestoreJobRequest.h.

◆ SetIdempotencyToken() [3/3]

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

A customer chosen string that can be used to distinguish between calls to StartRestoreJob.

Definition at line 561 of file StartRestoreJobRequest.h.

◆ SetMetadata() [1/2]

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

A set of metadata key-value pairs. Contains information, such as a resource name, required to restore a recovery point.

You can get configuration metadata about a resource at the time it was backed up by calling GetRecoveryPointRestoreMetadata. However, values in addition to those provided by GetRecoveryPointRestoreMetadata might be required to restore a resource. For example, you might need to provide a new resource name if the original already exists.

You need to specify specific metadata to restore an Amazon Elastic File System (Amazon EFS) instance:

  • file-system-id: The ID of the Amazon EFS file system that is backed up by AWS Backup. Returned in GetRecoveryPointRestoreMetadata.

  • Encrypted: A Boolean value that, if true, specifies that the file system is encrypted. If KmsKeyId is specified, Encrypted must be set to true.

  • KmsKeyId: Specifies the AWS KMS key that is used to encrypt the restored file system. You can specify a key from another AWS account provided that key it is properly shared with your account via AWS KMS.

  • PerformanceMode: Specifies the throughput mode of the file system.

  • CreationToken: A user-supplied value that ensures the uniqueness (idempotency) of the request.

  • newFileSystem: A Boolean value that, if true, specifies that the recovery point is restored to a new Amazon EFS file system.

  • ItemsToRestore : A serialized list of up to five strings where each string is a file path. Use ItemsToRestore to restore specific files or directories rather than the entire file system. This parameter is optional.

Definition at line 173 of file StartRestoreJobRequest.h.

◆ SetMetadata() [2/2]

void Aws::Backup::Model::StartRestoreJobRequest::SetMetadata ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

A set of metadata key-value pairs. Contains information, such as a resource name, required to restore a recovery point.

You can get configuration metadata about a resource at the time it was backed up by calling GetRecoveryPointRestoreMetadata. However, values in addition to those provided by GetRecoveryPointRestoreMetadata might be required to restore a resource. For example, you might need to provide a new resource name if the original already exists.

You need to specify specific metadata to restore an Amazon Elastic File System (Amazon EFS) instance:

  • file-system-id: The ID of the Amazon EFS file system that is backed up by AWS Backup. Returned in GetRecoveryPointRestoreMetadata.

  • Encrypted: A Boolean value that, if true, specifies that the file system is encrypted. If KmsKeyId is specified, Encrypted must be set to true.

  • KmsKeyId: Specifies the AWS KMS key that is used to encrypt the restored file system. You can specify a key from another AWS account provided that key it is properly shared with your account via AWS KMS.

  • PerformanceMode: Specifies the throughput mode of the file system.

  • CreationToken: A user-supplied value that ensures the uniqueness (idempotency) of the request.

  • newFileSystem: A Boolean value that, if true, specifies that the recovery point is restored to a new Amazon EFS file system.

  • ItemsToRestore : A serialized list of up to five strings where each string is a file path. Use ItemsToRestore to restore specific files or directories rather than the entire file system. This parameter is optional.

Definition at line 203 of file StartRestoreJobRequest.h.

◆ SetRecoveryPointArn() [1/3]

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

◆ SetRecoveryPointArn() [2/3]

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

◆ SetRecoveryPointArn() [3/3]

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

◆ SetResourceType() [1/3]

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

Starts a job to restore a recovery point for one of the following resources:

  • DynamoDB for Amazon DynamoDB

  • EBS for Amazon Elastic Block Store

  • EC2 for Amazon Elastic Compute Cloud

  • EFS for Amazon Elastic File System

  • RDS for Amazon Relational Database Service

  • Storage Gateway for AWS Storage Gateway

Definition at line 613 of file StartRestoreJobRequest.h.

◆ SetResourceType() [2/3]

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

Starts a job to restore a recovery point for one of the following resources:

  • DynamoDB for Amazon DynamoDB

  • EBS for Amazon Elastic Block Store

  • EC2 for Amazon Elastic Compute Cloud

  • EFS for Amazon Elastic File System

  • RDS for Amazon Relational Database Service

  • Storage Gateway for AWS Storage Gateway

Definition at line 624 of file StartRestoreJobRequest.h.

◆ SetResourceType() [3/3]

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

Starts a job to restore a recovery point for one of the following resources:

  • DynamoDB for Amazon DynamoDB

  • EBS for Amazon Elastic Block Store

  • EC2 for Amazon Elastic Compute Cloud

  • EFS for Amazon Elastic File System

  • RDS for Amazon Relational Database Service

  • Storage Gateway for AWS Storage Gateway

Definition at line 635 of file StartRestoreJobRequest.h.

◆ WithIamRoleArn() [1/3]

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

The Amazon Resource Name (ARN) of the IAM role that AWS Backup uses to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

Definition at line 516 of file StartRestoreJobRequest.h.

◆ WithIamRoleArn() [2/3]

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

The Amazon Resource Name (ARN) of the IAM role that AWS Backup uses to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

Definition at line 523 of file StartRestoreJobRequest.h.

◆ WithIamRoleArn() [3/3]

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

The Amazon Resource Name (ARN) of the IAM role that AWS Backup uses to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

Definition at line 530 of file StartRestoreJobRequest.h.

◆ WithIdempotencyToken() [1/3]

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

A customer chosen string that can be used to distinguish between calls to StartRestoreJob.

Definition at line 567 of file StartRestoreJobRequest.h.

◆ WithIdempotencyToken() [2/3]

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

A customer chosen string that can be used to distinguish between calls to StartRestoreJob.

Definition at line 573 of file StartRestoreJobRequest.h.

◆ WithIdempotencyToken() [3/3]

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

A customer chosen string that can be used to distinguish between calls to StartRestoreJob.

Definition at line 579 of file StartRestoreJobRequest.h.

◆ WithMetadata() [1/2]

StartRestoreJobRequest& Aws::Backup::Model::StartRestoreJobRequest::WithMetadata ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

A set of metadata key-value pairs. Contains information, such as a resource name, required to restore a recovery point.

You can get configuration metadata about a resource at the time it was backed up by calling GetRecoveryPointRestoreMetadata. However, values in addition to those provided by GetRecoveryPointRestoreMetadata might be required to restore a resource. For example, you might need to provide a new resource name if the original already exists.

You need to specify specific metadata to restore an Amazon Elastic File System (Amazon EFS) instance:

  • file-system-id: The ID of the Amazon EFS file system that is backed up by AWS Backup. Returned in GetRecoveryPointRestoreMetadata.

  • Encrypted: A Boolean value that, if true, specifies that the file system is encrypted. If KmsKeyId is specified, Encrypted must be set to true.

  • KmsKeyId: Specifies the AWS KMS key that is used to encrypt the restored file system. You can specify a key from another AWS account provided that key it is properly shared with your account via AWS KMS.

  • PerformanceMode: Specifies the throughput mode of the file system.

  • CreationToken: A user-supplied value that ensures the uniqueness (idempotency) of the request.

  • newFileSystem: A Boolean value that, if true, specifies that the recovery point is restored to a new Amazon EFS file system.

  • ItemsToRestore : A serialized list of up to five strings where each string is a file path. Use ItemsToRestore to restore specific files or directories rather than the entire file system. This parameter is optional.

Definition at line 233 of file StartRestoreJobRequest.h.

◆ WithMetadata() [2/2]

StartRestoreJobRequest& Aws::Backup::Model::StartRestoreJobRequest::WithMetadata ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

A set of metadata key-value pairs. Contains information, such as a resource name, required to restore a recovery point.

You can get configuration metadata about a resource at the time it was backed up by calling GetRecoveryPointRestoreMetadata. However, values in addition to those provided by GetRecoveryPointRestoreMetadata might be required to restore a resource. For example, you might need to provide a new resource name if the original already exists.

You need to specify specific metadata to restore an Amazon Elastic File System (Amazon EFS) instance:

  • file-system-id: The ID of the Amazon EFS file system that is backed up by AWS Backup. Returned in GetRecoveryPointRestoreMetadata.

  • Encrypted: A Boolean value that, if true, specifies that the file system is encrypted. If KmsKeyId is specified, Encrypted must be set to true.

  • KmsKeyId: Specifies the AWS KMS key that is used to encrypt the restored file system. You can specify a key from another AWS account provided that key it is properly shared with your account via AWS KMS.

  • PerformanceMode: Specifies the throughput mode of the file system.

  • CreationToken: A user-supplied value that ensures the uniqueness (idempotency) of the request.

  • newFileSystem: A Boolean value that, if true, specifies that the recovery point is restored to a new Amazon EFS file system.

  • ItemsToRestore : A serialized list of up to five strings where each string is a file path. Use ItemsToRestore to restore specific files or directories rather than the entire file system. This parameter is optional.

Definition at line 263 of file StartRestoreJobRequest.h.

◆ WithRecoveryPointArn() [1/3]

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

◆ WithRecoveryPointArn() [2/3]

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

◆ WithRecoveryPointArn() [3/3]

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

◆ WithResourceType() [1/3]

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

Starts a job to restore a recovery point for one of the following resources:

  • DynamoDB for Amazon DynamoDB

  • EBS for Amazon Elastic Block Store

  • EC2 for Amazon Elastic Compute Cloud

  • EFS for Amazon Elastic File System

  • RDS for Amazon Relational Database Service

  • Storage Gateway for AWS Storage Gateway

Definition at line 646 of file StartRestoreJobRequest.h.

◆ WithResourceType() [2/3]

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

Starts a job to restore a recovery point for one of the following resources:

  • DynamoDB for Amazon DynamoDB

  • EBS for Amazon Elastic Block Store

  • EC2 for Amazon Elastic Compute Cloud

  • EFS for Amazon Elastic File System

  • RDS for Amazon Relational Database Service

  • Storage Gateway for AWS Storage Gateway

Definition at line 657 of file StartRestoreJobRequest.h.

◆ WithResourceType() [3/3]

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

Starts a job to restore a recovery point for one of the following resources:

  • DynamoDB for Amazon DynamoDB

  • EBS for Amazon Elastic Block Store

  • EC2 for Amazon Elastic Compute Cloud

  • EFS for Amazon Elastic File System

  • RDS for Amazon Relational Database Service

  • Storage Gateway for AWS Storage Gateway

Definition at line 668 of file StartRestoreJobRequest.h.


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