Restores a backup to a server that is in a
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
Stopped state, but is eventually terminated.
This operation is asynchronous.
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.
See also: AWS API Documentation
restore-server --backup-id <value> --server-name <value> [--instance-type <value>] [--key-pair <value>] [--cli-input-json | --cli-input-yaml] [--generate-cli-skeleton <value>] [--debug] [--endpoint-url <value>] [--no-verify-ssl] [--no-paginate] [--output <value>] [--query <value>] [--profile <value>] [--region <value>] [--version <value>] [--color <value>] [--no-sign-request] [--ca-bundle <value>] [--cli-read-timeout <value>] [--cli-connect-timeout <value>] [--cli-binary-format <value>] [--no-cli-pager] [--cli-auto-prompt] [--no-cli-auto-prompt]
The ID of the backup that you want to use to restore a server.
The name of the server that you want to restore.
The type of instance to restore. Valid values must be specified in the following format:
m5.large. Valid values are
r5.2xlarge. If you do not specify this parameter, RestoreServer uses the instance type from the specified backup.
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.
Reads arguments from the JSON string provided. The JSON string follows the format provided by
--generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value
input, prints a sample input JSON that can be used as an argument for
--cli-input-json. Similarly, if provided
yaml-input it will print a sample input YAML that can be used with
--cli-input-yaml. If provided with the value
output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
Turn on debug logging.
Override command’s default URL with the given URL.
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
Disable automatic pagination.
The formatting style for command output.
A JMESPath query to use in filtering the response data.
Use a specific profile from your credential file.
The region to use. Overrides config/env settings.
Display the version of this tool.
Turn on/off color output.
Do not sign requests. Credentials will not be loaded if this argument is provided.
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob
fileb:// will always be treated as binary and use the file contents directly regardless of the
cli-binary-format setting. When using
file:// the file contents will need to properly formatted for the configured
Disable cli pager for output.
Automatically prompt for CLI input parameters.
Disable automatically prompt for CLI input parameters.
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To restore a server
restore-server command performs an in-place restoration of a
Chef Automate server named
automate-06 in your default region from a backup
with an ID of
automate-06-2016-11-22T16:13:27.998Z. Restoring a server restores
connections to the nodes that the Chef Automate server was managing at the time
that the specified backup was performed.
aws opsworks-cm restore-server –backup-id “automate-06-2016-11-22T16:13:27.998Z” –server-name “automate-06”
The output is the command ID only. Output:
For more information, see Restore a Failed AWS OpsWorks for Chef Automate Server in the AWS OpsWorks User Guide.
Server -> (structure)
Describes a configuration management server.
AssociatePublicIpAddress -> (boolean)Associate a public IP address with a server that you are launching.
BackupRetentionCount -> (integer)The number of automated backups to keep.
ServerName -> (string)The name of the server.
CreatedAt -> (timestamp)Time stamp of server creation. Example
CloudFormationStackArn -> (string)The ARN of the CloudFormation stack that was used to create the server.
CustomDomain -> (string)An optional public endpoint of a server, such as
https://aws.my-company.com. You cannot access the server by using the
Endpointvalue if the server has a
DisableAutomatedBackup -> (boolean)Disables automated backups. The number of stored backups is dependent on the value of PreferredBackupCount.
Endpoint -> (string)A DNS name that can be used to access the engine. Example:
myserver-asdfghjkl.us-east-1.opsworks.io. You cannot access the server by using the
Endpointvalue if the server has a
Engine -> (string)The engine type of the server. Valid values in this release include
EngineModel -> (string)The engine model of the server. Valid values in this release include
Monolithicfor Puppet and
EngineAttributes -> (list)
The response of a createServer() request returns the master credential to access the server in EngineAttributes. These credentials are not stored by AWS OpsWorks CM; they are returned only as part of the result of createServer().Attributes returned in a createServer response for Chef
CHEF_AUTOMATE_PIVOTAL_KEY: A base64-encoded RSA private key that is generated by AWS OpsWorks for Chef Automate. This private key is required to access the Chef API.
CHEF_STARTER_KIT: A base64-encoded ZIP file. The ZIP file contains a Chef starter kit, which includes a README, a configuration file, and the required RSA private key. Save this file, unzip it, and then change to the directory where you’ve unzipped the file contents. From this directory, you can run Knife commands.Attributes returned in a createServer response for Puppet
PUPPET_STARTER_KIT: A base64-encoded ZIP file. The ZIP file contains a Puppet starter kit, including a README and a required private key. Save this file, unzip it, and then change to the directory where you’ve unzipped the file contents.
PUPPET_ADMIN_PASSWORD: An administrator password that you can use to sign in to the Puppet Enterprise console after the server is online.
A name and value pair that is specific to the engine of the server.
Name -> (string)The name of the engine attribute.
Value -> (string)The value of the engine attribute.
EngineVersion -> (string)The engine version of the server. For a Chef server, the valid value for EngineVersion is currently
2. For a Puppet server, specify either
InstanceProfileArn -> (string)The instance profile ARN of the server.
InstanceType -> (string)The instance type for the server, as specified in the CloudFormation stack. This might not be the same instance type that is shown in the EC2 console.
KeyPair -> (string)The key pair associated with the server.
MaintenanceStatus -> (string)The status of the most recent server maintenance run. Shows
PreferredMaintenanceWindow -> (string)The preferred maintenance period specified for the server.
PreferredBackupWindow -> (string)The preferred backup period specified for the server.
SecurityGroupIds -> (list)
The security group IDs for the server, as specified in the CloudFormation stack. These might not be the same security groups that are shown in the EC2 console.
ServiceRoleArn -> (string)The service role ARN used to create the server.
Status -> (string)The server’s status. This field displays the states of actions in progress, such as creating, running, or backing up the server, as well as the server’s health state.
StatusReason -> (string)Depending on the server status, this field has either a human-readable message (such as a create or backup error), or an escaped block of JSON (used for health check results).
SubnetIds -> (list)
The subnet IDs specified in a CreateServer request.
ServerArn -> (string)The ARN of the server.