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 RestoreServer operation. Restores a backup to a server that is in a CONNECTION_LOST, HEALTHY, RUNNING, UNHEALTHY, or TERMINATED state. When you run RestoreServer, the server's EC2 instance is deleted, and a new EC2 instance is configured. RestoreServer maintains the existing server endpoint, so configuration management of the server's client devices (nodes) should continue to work.

This operation is asynchronous.

An InvalidStateException is thrown when the server is not in a valid state. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.

Inheritance Hierarchy


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


public class RestoreServerRequest : AmazonOpsWorksCMRequest

The RestoreServerRequest type exposes the following members


Public Method RestoreServerRequest()


Public Property BackupId System.String

Gets and sets the property BackupId.

The ID of the backup that you want to use to restore a server.

Public Property InstanceType System.String

Gets and sets the property InstanceType.

The type of the instance to create. Valid values must be specified in the following format: ^([cm][34]|t2).* For example, m4.large. Valid values are t2.medium, m4.large, and m4.2xlarge. If you do not specify this parameter, RestoreServer uses the instance type from the specified backup.

Public Property KeyPair System.String

Gets and sets the property KeyPair.

The name of the key pair to set on the new EC2 instance. This can be helpful if the administrator no longer has the SSH key.

Public Property ServerName System.String

Gets and sets the property ServerName.

The name of the server that you want to restore.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms