AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the StartRestoreJob operation. Recovers the saved resource identified by an Amazon Resource Name (ARN).

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Backup.AmazonBackupRequest
      Amazon.Backup.Model.StartRestoreJobRequest

Namespace: Amazon.Backup.Model
Assembly: AWSSDK.Backup.dll
Version: 3.x.y.z

Syntax

C# 
public class StartRestoreJobRequest : AmazonBackupRequest
         IAmazonWebServiceRequest

The StartRestoreJobRequest type exposes the following members

Constructors

NameDescription
Public Method StartRestoreJobRequest()

Properties

NameTypeDescription
Public Property CopySourceTagsToRestoredResource System.Boolean

Gets and sets the property CopySourceTagsToRestoredResource.

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.

Public Property IamRoleArn System.String

Gets and sets the property IamRoleArn.

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.

Public Property IdempotencyToken System.String

Gets and sets the property IdempotencyToken.

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.

Public Property Metadata System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property Metadata.

A set of metadata key-value pairs.

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.

For more information about the metadata for each resource, see the following:

Public Property RecoveryPointArn System.String

Gets and sets the property RecoveryPointArn.

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

Public Property ResourceType System.String

Gets and sets the property ResourceType.

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

  • Aurora - Amazon Aurora

  • DocumentDB - Amazon DocumentDB

  • CloudFormation - CloudFormation

  • DynamoDB - Amazon DynamoDB

  • EBS - Amazon Elastic Block Store

  • EC2 - Amazon Elastic Compute Cloud

  • EFS - Amazon Elastic File System

  • FSx - Amazon FSx

  • Neptune - Amazon Neptune

  • RDS - Amazon Relational Database Service

  • Redshift - Amazon Redshift

  • Storage Gateway - Storage Gateway

  • S3 - Amazon Simple Storage Service

  • Timestream - Amazon Timestream

  • VirtualMachine - Virtual machines

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5