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

Class: Aws::Lightsail::Types::CreateInstancesFromSnapshotRequest

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

Overview

Note:

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

{
  instance_names: ["string"], # required
  availability_zone: "string", # required
  instance_snapshot_name: "ResourceName", # required
  bundle_id: "NonEmptyString", # required
  user_data: "string",
  key_pair_name: "ResourceName",
}

Instance Attribute Summary collapse

Instance Attribute Details

#availability_zoneString

The Availability Zone where you want to create your instances. Use the following formatting: us-east-1a (case sensitive). You can get a list of availability zones by using the get regions operation. Be sure to add the include availability zones parameter to your request.

Returns:

  • (String)


467
468
469
470
471
472
473
474
475
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 467

class CreateInstancesFromSnapshotRequest < Struct.new(
  :instance_names,
  :availability_zone,
  :instance_snapshot_name,
  :bundle_id,
  :user_data,
  :key_pair_name)
  include Aws::Structure
end

#bundle_idString

The bundle of specification information for your virtual private server (or instance), including the pricing plan (e.g., micro_1_0).

Returns:

  • (String)


467
468
469
470
471
472
473
474
475
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 467

class CreateInstancesFromSnapshotRequest < Struct.new(
  :instance_names,
  :availability_zone,
  :instance_snapshot_name,
  :bundle_id,
  :user_data,
  :key_pair_name)
  include Aws::Structure
end

#instance_namesArray<String>

The names for your new instances.

Returns:

  • (Array<String>)


467
468
469
470
471
472
473
474
475
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 467

class CreateInstancesFromSnapshotRequest < Struct.new(
  :instance_names,
  :availability_zone,
  :instance_snapshot_name,
  :bundle_id,
  :user_data,
  :key_pair_name)
  include Aws::Structure
end

#instance_snapshot_nameString

The name of the instance snapshot on which you are basing your new instances. Use the get instance snapshots operation to return information about your existing snapshots.

Returns:

  • (String)


467
468
469
470
471
472
473
474
475
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 467

class CreateInstancesFromSnapshotRequest < Struct.new(
  :instance_names,
  :availability_zone,
  :instance_snapshot_name,
  :bundle_id,
  :user_data,
  :key_pair_name)
  include Aws::Structure
end

#key_pair_nameString

The name for your key pair.

Returns:

  • (String)


467
468
469
470
471
472
473
474
475
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 467

class CreateInstancesFromSnapshotRequest < Struct.new(
  :instance_names,
  :availability_zone,
  :instance_snapshot_name,
  :bundle_id,
  :user_data,
  :key_pair_name)
  include Aws::Structure
end

#user_dataString

You can create a launch script that configures a server with additional user data. For example, apt-get –y update.

Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS use yum, Debian and Ubuntu use apt-get, and FreeBSD uses pkg. For a complete list, see the Dev Guide.

Returns:

  • (String)


467
468
469
470
471
472
473
474
475
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 467

class CreateInstancesFromSnapshotRequest < Struct.new(
  :instance_names,
  :availability_zone,
  :instance_snapshot_name,
  :bundle_id,
  :user_data,
  :key_pair_name)
  include Aws::Structure
end