paws.management (version 0.1.0)

opsworkscm_restore_server: Restores a backup to a server that is in a CONNECTION_LOST, HEALTHY, RUNNING, UNHEALTHY, or TERMINATED state

Description

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.

Usage

opsworkscm_restore_server(BackupId, ServerName, InstanceType, KeyPair)

Arguments

BackupId

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

ServerName

[required] The name of the server that you want to restore.

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.

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.

Request syntax

svc$restore_server(
  BackupId = "string",
  ServerName = "string",
  InstanceType = "string",
  KeyPair = "string"
)

Details

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.