You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::OpsWorksCM::Types::RestoreServerRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb

Overview

Note:

When making an API call, you may pass RestoreServerRequest data as a hash:

{
  backup_id: "BackupId", # required
  server_name: "ServerName", # required
  instance_type: "String",
  key_pair: "KeyPair",
}

Instance Attribute Summary collapse

Instance Attribute Details

#backup_idString

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

Returns:

  • (String)


931
932
933
934
935
936
937
# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 931

class RestoreServerRequest < Struct.new(
  :backup_id,
  :server_name,
  :instance_type,
  :key_pair)
  include Aws::Structure
end

#instance_typeString

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.

Returns:

  • (String)


931
932
933
934
935
936
937
# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 931

class RestoreServerRequest < Struct.new(
  :backup_id,
  :server_name,
  :instance_type,
  :key_pair)
  include Aws::Structure
end

#key_pairString

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.

Returns:

  • (String)


931
932
933
934
935
936
937
# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 931

class RestoreServerRequest < Struct.new(
  :backup_id,
  :server_name,
  :instance_type,
  :key_pair)
  include Aws::Structure
end

#server_nameString

The name of the server that you want to restore.

Returns:

  • (String)


931
932
933
934
935
936
937
# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 931

class RestoreServerRequest < Struct.new(
  :backup_id,
  :server_name,
  :instance_type,
  :key_pair)
  include Aws::Structure
end