pub struct StartRestoreJobFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to StartRestoreJob
.
Recovers the saved resource identified by an Amazon Resource Name (ARN).
Implementations§
source§impl StartRestoreJobFluentBuilder
impl StartRestoreJobFluentBuilder
sourcepub fn as_input(&self) -> &StartRestoreJobInputBuilder
pub fn as_input(&self) -> &StartRestoreJobInputBuilder
Access the StartRestoreJob as a reference.
sourcepub async fn send(
self
) -> Result<StartRestoreJobOutput, SdkError<StartRestoreJobError, HttpResponse>>
pub async fn send( self ) -> Result<StartRestoreJobOutput, SdkError<StartRestoreJobError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub fn customize(
self
) -> CustomizableOperation<StartRestoreJobOutput, StartRestoreJobError, Self>
pub fn customize( self ) -> CustomizableOperation<StartRestoreJobOutput, StartRestoreJobError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn recovery_point_arn(self, input: impl Into<String>) -> Self
pub fn recovery_point_arn(self, input: impl Into<String>) -> Self
An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45
.
sourcepub fn set_recovery_point_arn(self, input: Option<String>) -> Self
pub fn set_recovery_point_arn(self, input: Option<String>) -> Self
An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45
.
sourcepub fn get_recovery_point_arn(&self) -> &Option<String>
pub fn get_recovery_point_arn(&self) -> &Option<String>
An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45
.
sourcepub fn metadata(self, k: impl Into<String>, v: impl Into<String>) -> Self
pub fn metadata(self, k: impl Into<String>, v: impl Into<String>) -> Self
Adds a key-value pair to Metadata
.
To override the contents of this collection use set_metadata
.
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 Backup. Returned inGetRecoveryPointRestoreMetadata
. -
Encrypted
: A Boolean value that, if true, specifies that the file system is encrypted. IfKmsKeyId
is specified,Encrypted
must be set totrue
. -
KmsKeyId
: Specifies the Amazon Web Services KMS key that is used to encrypt the restored file system. You can specify a key from another Amazon Web Services account provided that key it is properly shared with your account via Amazon Web Services 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
: An array of one to five strings where each string is a file path. UseItemsToRestore
to restore specific files or directories rather than the entire file system. This parameter is optional. For example,"itemsToRestore":"[\"/my.test\"]"
.
sourcepub fn set_metadata(self, input: Option<HashMap<String, String>>) -> Self
pub fn set_metadata(self, input: Option<HashMap<String, String>>) -> Self
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 Backup. Returned inGetRecoveryPointRestoreMetadata
. -
Encrypted
: A Boolean value that, if true, specifies that the file system is encrypted. IfKmsKeyId
is specified,Encrypted
must be set totrue
. -
KmsKeyId
: Specifies the Amazon Web Services KMS key that is used to encrypt the restored file system. You can specify a key from another Amazon Web Services account provided that key it is properly shared with your account via Amazon Web Services 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
: An array of one to five strings where each string is a file path. UseItemsToRestore
to restore specific files or directories rather than the entire file system. This parameter is optional. For example,"itemsToRestore":"[\"/my.test\"]"
.
sourcepub fn get_metadata(&self) -> &Option<HashMap<String, String>>
pub fn get_metadata(&self) -> &Option<HashMap<String, String>>
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 Backup. Returned inGetRecoveryPointRestoreMetadata
. -
Encrypted
: A Boolean value that, if true, specifies that the file system is encrypted. IfKmsKeyId
is specified,Encrypted
must be set totrue
. -
KmsKeyId
: Specifies the Amazon Web Services KMS key that is used to encrypt the restored file system. You can specify a key from another Amazon Web Services account provided that key it is properly shared with your account via Amazon Web Services 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
: An array of one to five strings where each string is a file path. UseItemsToRestore
to restore specific files or directories rather than the entire file system. This parameter is optional. For example,"itemsToRestore":"[\"/my.test\"]"
.
sourcepub fn iam_role_arn(self, input: impl Into<String>) -> Self
pub fn iam_role_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the target resource; for example: arn:aws:iam::123456789012:role/S3Access
.
sourcepub fn set_iam_role_arn(self, input: Option<String>) -> Self
pub fn set_iam_role_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the target resource; for example: arn:aws:iam::123456789012:role/S3Access
.
sourcepub fn get_iam_role_arn(&self) -> &Option<String>
pub fn get_iam_role_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the target resource; for example: arn:aws:iam::123456789012:role/S3Access
.
sourcepub fn idempotency_token(self, input: impl Into<String>) -> Self
pub fn idempotency_token(self, input: impl Into<String>) -> Self
A customer-chosen string that you can use to distinguish between otherwise identical calls to StartRestoreJob
. Retrying a successful request with the same idempotency token results in a success message with no action taken.
sourcepub fn set_idempotency_token(self, input: Option<String>) -> Self
pub fn set_idempotency_token(self, input: Option<String>) -> Self
A customer-chosen string that you can use to distinguish between otherwise identical calls to StartRestoreJob
. Retrying a successful request with the same idempotency token results in a success message with no action taken.
sourcepub fn get_idempotency_token(&self) -> &Option<String>
pub fn get_idempotency_token(&self) -> &Option<String>
A customer-chosen string that you can use to distinguish between otherwise identical calls to StartRestoreJob
. Retrying a successful request with the same idempotency token results in a success message with no action taken.
sourcepub fn resource_type(self, input: impl Into<String>) -> Self
pub fn resource_type(self, input: impl Into<String>) -> Self
Starts a job to restore a recovery point for one of the following resources:
-
Aurora
for Amazon Aurora -
DocumentDB
for Amazon DocumentDB (with MongoDB compatibility) -
CloudFormation
for CloudFormation -
DynamoDB
for Amazon DynamoDB -
EBS
for Amazon Elastic Block Store -
EC2
for Amazon Elastic Compute Cloud -
EFS
for Amazon Elastic File System -
FSx
for Amazon FSx -
Neptune
for Amazon Neptune -
RDS
for Amazon Relational Database Service -
Redshift
for Amazon Redshift -
Storage Gateway
for Storage Gateway -
S3
for Amazon S3 -
Timestream
for Amazon Timestream -
VirtualMachine
for virtual machines
sourcepub fn set_resource_type(self, input: Option<String>) -> Self
pub fn set_resource_type(self, input: Option<String>) -> Self
Starts a job to restore a recovery point for one of the following resources:
-
Aurora
for Amazon Aurora -
DocumentDB
for Amazon DocumentDB (with MongoDB compatibility) -
CloudFormation
for CloudFormation -
DynamoDB
for Amazon DynamoDB -
EBS
for Amazon Elastic Block Store -
EC2
for Amazon Elastic Compute Cloud -
EFS
for Amazon Elastic File System -
FSx
for Amazon FSx -
Neptune
for Amazon Neptune -
RDS
for Amazon Relational Database Service -
Redshift
for Amazon Redshift -
Storage Gateway
for Storage Gateway -
S3
for Amazon S3 -
Timestream
for Amazon Timestream -
VirtualMachine
for virtual machines
sourcepub fn get_resource_type(&self) -> &Option<String>
pub fn get_resource_type(&self) -> &Option<String>
Starts a job to restore a recovery point for one of the following resources:
-
Aurora
for Amazon Aurora -
DocumentDB
for Amazon DocumentDB (with MongoDB compatibility) -
CloudFormation
for CloudFormation -
DynamoDB
for Amazon DynamoDB -
EBS
for Amazon Elastic Block Store -
EC2
for Amazon Elastic Compute Cloud -
EFS
for Amazon Elastic File System -
FSx
for Amazon FSx -
Neptune
for Amazon Neptune -
RDS
for Amazon Relational Database Service -
Redshift
for Amazon Redshift -
Storage Gateway
for Storage Gateway -
S3
for Amazon S3 -
Timestream
for Amazon Timestream -
VirtualMachine
for virtual machines
This is an optional parameter. If this equals True
, tags included in the backup will be copied to the restored resource.
This can only be applied to backups created through Backup.
This is an optional parameter. If this equals True
, tags included in the backup will be copied to the restored resource.
This can only be applied to backups created through Backup.
This is an optional parameter. If this equals True
, tags included in the backup will be copied to the restored resource.
This can only be applied to backups created through Backup.
Trait Implementations§
source§impl Clone for StartRestoreJobFluentBuilder
impl Clone for StartRestoreJobFluentBuilder
source§fn clone(&self) -> StartRestoreJobFluentBuilder
fn clone(&self) -> StartRestoreJobFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for StartRestoreJobFluentBuilder
impl !RefUnwindSafe for StartRestoreJobFluentBuilder
impl Send for StartRestoreJobFluentBuilder
impl Sync for StartRestoreJobFluentBuilder
impl Unpin for StartRestoreJobFluentBuilder
impl !UnwindSafe for StartRestoreJobFluentBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more