OpsWorksCM / Client / restore_server

restore_server#

OpsWorksCM.Client.restore_server(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.restore_server(
    BackupId='string',
    ServerName='string',
    InstanceType='string',
    KeyPair='string'
)
Parameters:

  • BackupId (string) –

    [REQUIRED]

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

  • ServerName (string) –

    [REQUIRED]

    The name of the server that you want to restore.

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

  • KeyPair (string) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'Server': {
        'AssociatePublicIpAddress': True|False,
        'BackupRetentionCount': 123,
        'ServerName': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'CloudFormationStackArn': 'string',
        'CustomDomain': 'string',
        'DisableAutomatedBackup': True|False,
        'Endpoint': 'string',
        'Engine': 'string',
        'EngineModel': 'string',
        'EngineAttributes': [
            {
                'Name': 'string',
                'Value': 'string'
            },
        ],
        'EngineVersion': 'string',
        'InstanceProfileArn': 'string',
        'InstanceType': 'string',
        'KeyPair': 'string',
        'MaintenanceStatus': 'SUCCESS'|'FAILED',
        'PreferredMaintenanceWindow': 'string',
        'PreferredBackupWindow': 'string',
        'SecurityGroupIds': [
            'string',
        ],
        'ServiceRoleArn': 'string',
        'Status': 'BACKING_UP'|'CONNECTION_LOST'|'CREATING'|'DELETING'|'MODIFYING'|'FAILED'|'HEALTHY'|'RUNNING'|'RESTORING'|'SETUP'|'UNDER_MAINTENANCE'|'UNHEALTHY'|'TERMINATED',
        'StatusReason': 'string',
        'SubnetIds': [
            'string',
        ],
        'ServerArn': 'string'
    }
}

Response Structure

  • (dict) –

    • Server (dict) –

      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 (datetime) –

        Time stamp of server creation. Example 2016-07-29T13:38:47.520Z

      • 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 Endpoint value if the server has a CustomDomain specified.

      • 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 Endpoint value if the server has a CustomDomain specified.

      • Engine (string) –

        The engine type of the server. Valid values in this release include ChefAutomate and Puppet.

      • EngineModel (string) –

        The engine model of the server. Valid values in this release include Monolithic for Puppet and Single for Chef.

      • 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.

        • (dict) –

          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 2019 or 2017.

      • 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 SUCCESS or FAILED.

      • 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.

        • (string) –

      • 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.

        • (string) –

      • ServerArn (string) –

        The ARN of the server.

Exceptions