Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14198892.8 KB

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.

post/#X-Amz-Target=OpsWorksCM_V2016_11_01.RestoreServer

Headers

X-Amz-Target'OpsWorksCM_V2016_11_01.RestoreServer' required

Request body

BackupIdstring required

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

ServerNamestring required

The name of the server that you want to restore.

InstanceTypestring

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

KeyPairstring

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.

Response

Success