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.

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.

Restoring from a backup is performed by creating a new EC2 instance. If restoration is successful, and the server is in a HEALTHY state, AWS OpsWorks CM switches traffic over to the new instance. After restoration is finished, the old EC2 instance is maintained in a Running or Stopped state, but is eventually terminated.

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.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to RestoreServerAsync.

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

Syntax

C#
public abstract RestoreServerResponse RestoreServer(
         RestoreServerRequest request
)

Parameters

request
Type: Amazon.OpsWorksCM.Model.RestoreServerRequest

Container for the necessary parameters to execute the RestoreServer service method.

Return Value


The response from the RestoreServer service method, as returned by OpsWorksCM.

Exceptions

ExceptionCondition
InvalidStateException The resource is in a state that does not allow you to perform a specified action.
ResourceNotFoundException The requested resource does not exist, or access was denied.
ValidationException One or more of the provided request parameters are not valid.

Version Information

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

See Also