aws_sdk_backup/client/

start_restore_job.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`StartRestoreJob`](crate::operation::start_restore_job::builders::StartRestoreJobFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`recovery_point_arn(impl Into<String>)`](crate::operation::start_restore_job::builders::StartRestoreJobFluentBuilder::recovery_point_arn) / [`set_recovery_point_arn(Option<String>)`](crate::operation::start_restore_job::builders::StartRestoreJobFluentBuilder::set_recovery_point_arn):<br>required: **true**<br><p>An ARN that uniquely identifies a recovery point; for example, <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p><br>
    ///   - [`metadata(impl Into<String>, impl Into<String>)`](crate::operation::start_restore_job::builders::StartRestoreJobFluentBuilder::metadata) / [`set_metadata(Option<HashMap::<String, String>>)`](crate::operation::start_restore_job::builders::StartRestoreJobFluentBuilder::set_metadata):<br>required: **true**<br><p>A set of metadata key-value pairs.</p> <p>You can get configuration metadata about a resource at the time it was backed up by calling <code>GetRecoveryPointRestoreMetadata</code>. However, values in addition to those provided by <code>GetRecoveryPointRestoreMetadata</code> might be required to restore a resource. For example, you might need to provide a new resource name if the original already exists.</p> <p>For more information about the metadata for each resource, see the following:</p> <ul>  <li>   <p><a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-aur.html#aur-restore-cli">Metadata for Amazon Aurora</a></p></li>  <li>   <p><a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-docdb.html#docdb-restore-cli">Metadata for Amazon DocumentDB</a></p></li>  <li>   <p><a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/restore-application-stacks.html#restoring-cfn-cli">Metadata for CloudFormation</a></p></li>  <li>   <p><a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-dynamodb.html#ddb-restore-cli">Metadata for Amazon DynamoDB</a></p></li>  <li>   <p><a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-ebs.html#ebs-restore-cli"> Metadata for Amazon EBS</a></p></li>  <li>   <p><a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-ec2.html#restoring-ec2-cli">Metadata for Amazon EC2</a></p></li>  <li>   <p><a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-efs.html#efs-restore-cli">Metadata for Amazon EFS</a></p></li>  <li>   <p><a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-fsx.html#fsx-restore-cli">Metadata for Amazon FSx</a></p></li>  <li>   <p><a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-nep.html#nep-restore-cli">Metadata for Amazon Neptune</a></p></li>  <li>   <p><a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-rds.html#rds-restore-cli">Metadata for Amazon RDS</a></p></li>  <li>   <p><a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/redshift-restores.html#redshift-restore-api">Metadata for Amazon Redshift</a></p></li>  <li>   <p><a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-storage-gateway.html#restoring-sgw-cli">Metadata for Storage Gateway</a></p></li>  <li>   <p><a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-s3.html#s3-restore-cli">Metadata for Amazon S3</a></p></li>  <li>   <p><a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/timestream-restore.html#timestream-restore-api">Metadata for Amazon Timestream</a></p></li>  <li>   <p><a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-vm.html#vm-restore-cli">Metadata for virtual machines</a></p></li> </ul><br>
    ///   - [`iam_role_arn(impl Into<String>)`](crate::operation::start_restore_job::builders::StartRestoreJobFluentBuilder::iam_role_arn) / [`set_iam_role_arn(Option<String>)`](crate::operation::start_restore_job::builders::StartRestoreJobFluentBuilder::set_iam_role_arn):<br>required: **false**<br><p>The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the target resource; for example: <code>arn:aws:iam::123456789012:role/S3Access</code>.</p><br>
    ///   - [`idempotency_token(impl Into<String>)`](crate::operation::start_restore_job::builders::StartRestoreJobFluentBuilder::idempotency_token) / [`set_idempotency_token(Option<String>)`](crate::operation::start_restore_job::builders::StartRestoreJobFluentBuilder::set_idempotency_token):<br>required: **false**<br><p>A customer-chosen string that you can use to distinguish between otherwise identical calls to <code>StartRestoreJob</code>. Retrying a successful request with the same idempotency token results in a success message with no action taken.</p><br>
    ///   - [`resource_type(impl Into<String>)`](crate::operation::start_restore_job::builders::StartRestoreJobFluentBuilder::resource_type) / [`set_resource_type(Option<String>)`](crate::operation::start_restore_job::builders::StartRestoreJobFluentBuilder::set_resource_type):<br>required: **false**<br><p>Starts a job to restore a recovery point for one of the following resources:</p> <ul>  <li>   <p><code>Aurora</code> - Amazon Aurora</p></li>  <li>   <p><code>DocumentDB</code> - Amazon DocumentDB</p></li>  <li>   <p><code>CloudFormation</code> - CloudFormation</p></li>  <li>   <p><code>DynamoDB</code> - Amazon DynamoDB</p></li>  <li>   <p><code>EBS</code> - Amazon Elastic Block Store</p></li>  <li>   <p><code>EC2</code> - Amazon Elastic Compute Cloud</p></li>  <li>   <p><code>EFS</code> - Amazon Elastic File System</p></li>  <li>   <p><code>FSx</code> - Amazon FSx</p></li>  <li>   <p><code>Neptune</code> - Amazon Neptune</p></li>  <li>   <p><code>RDS</code> - Amazon Relational Database Service</p></li>  <li>   <p><code>Redshift</code> - Amazon Redshift</p></li>  <li>   <p><code>Storage Gateway</code> - Storage Gateway</p></li>  <li>   <p><code>S3</code> - Amazon Simple Storage Service</p></li>  <li>   <p><code>Timestream</code> - Amazon Timestream</p></li>  <li>   <p><code>VirtualMachine</code> - Virtual machines</p></li> </ul><br>
    ///   - [`copy_source_tags_to_restored_resource(bool)`](crate::operation::start_restore_job::builders::StartRestoreJobFluentBuilder::copy_source_tags_to_restored_resource) / [`set_copy_source_tags_to_restored_resource(Option<bool>)`](crate::operation::start_restore_job::builders::StartRestoreJobFluentBuilder::set_copy_source_tags_to_restored_resource):<br>required: **false**<br><p>This is an optional parameter. If this equals <code>True</code>, tags included in the backup will be copied to the restored resource.</p> <p>This can only be applied to backups created through Backup.</p><br>
    /// - On success, responds with [`StartRestoreJobOutput`](crate::operation::start_restore_job::StartRestoreJobOutput) with field(s):
    ///   - [`restore_job_id(Option<String>)`](crate::operation::start_restore_job::StartRestoreJobOutput::restore_job_id): <p>Uniquely identifies the job that restores a recovery point.</p>
    /// - On failure, responds with [`SdkError<StartRestoreJobError>`](crate::operation::start_restore_job::StartRestoreJobError)
    pub fn start_restore_job(&self) -> crate::operation::start_restore_job::builders::StartRestoreJobFluentBuilder {
        crate::operation::start_restore_job::builders::StartRestoreJobFluentBuilder::new(self.handle.clone())
    }
}