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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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
  attached_disk_mapping: {
    "ResourceName" => [
      {
        original_disk_path: "NonEmptyString",
        new_disk_name: "ResourceName",
      },
    ],
  },
  availability_zone: "string", # required
  instance_snapshot_name: "ResourceName", # required
  bundle_id: "NonEmptyString", # required
  user_data: "string",
  key_pair_name: "ResourceName",
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#attached_disk_mapping ⇒ Hash<String,Array<Types::DiskMap>>

An object containing information about one or more disk mappings.

Returns:



1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
 
# File 'lib/aws-sdk-lightsail/types.rb', line 1015

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

#availability_zone ⇒ String

The Availability Zone where you want to create your instances. Use the following formatting: ‘us-east-2a` (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.

[1]: docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetRegions.html

Returns:

  • (String) 


1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
 
# File 'lib/aws-sdk-lightsail/types.rb', line 1015

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

#bundle_id ⇒ String

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

Returns:

  • (String) 


1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
 
# File 'lib/aws-sdk-lightsail/types.rb', line 1015

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

#instance_names ⇒ Array<String>

The names for your new instances.

Returns:

  • (Array<String>) 


1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
 
# File 'lib/aws-sdk-lightsail/types.rb', line 1015

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

#instance_snapshot_name ⇒ String

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) 


1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
 
# File 'lib/aws-sdk-lightsail/types.rb', line 1015

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

#key_pair_name ⇒ String

The name for your key pair.

Returns:

  • (String) 


1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
 
# File 'lib/aws-sdk-lightsail/types.rb', line 1015

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

#tags ⇒ Array<Types::Tag>

The tag keys and optional values to add to the resource during create.

To tag a resource after it has been created, see the ‘tag resource` operation.

Returns:



1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
 
# File 'lib/aws-sdk-lightsail/types.rb', line 1015

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

#user_data ⇒ String

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

<note markdown=“1”> 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].

</note>

[1]: lightsail.aws.amazon.com/ls/docs/getting-started/article/compare-options-choose-lightsail-instance-image

Returns:

  • (String) 


1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
 
# File 'lib/aws-sdk-lightsail/types.rb', line 1015

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