You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::Lightsail::Types::CreateInstancesFromSnapshotRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Lightsail::Types::CreateInstancesFromSnapshotRequest
- Defined in:
- (unknown)
Overview
When passing CreateInstancesFromSnapshotRequest as input to an Aws::Client method, you can use a vanilla 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",
bundle_id: "NonEmptyString", # required
user_data: "string",
key_pair_name: "ResourceName",
tags: [
{
key: "TagKey",
value: "TagValue",
},
],
add_ons: [
{
add_on_type: "AutoSnapshot", # required, accepts AutoSnapshot
auto_snapshot_add_on_request: {
snapshot_time_of_day: "TimeOfDay",
},
},
],
source_instance_name: "string",
restore_date: "string",
use_latest_restorable_auto_snapshot: false,
}
Instance Attribute Summary collapse
-
#add_ons ⇒ Array<Types::AddOnRequest>
An array of objects representing the add-ons to enable for the new instance.
-
#attached_disk_mapping ⇒ Hash<String,Array<Types::DiskMap>>
An object containing information about one or more disk mappings.
-
#availability_zone ⇒ String
The Availability Zone where you want to create your instances.
-
#bundle_id ⇒ String
The bundle of specification information for your virtual private server (or instance), including the pricing plan (e.g.,
micro_1_0
). -
#instance_names ⇒ Array<String>
The names for your new instances.
-
#instance_snapshot_name ⇒ String
The name of the instance snapshot on which you are basing your new instances.
-
#key_pair_name ⇒ String
The name for your key pair.
-
#restore_date ⇒ String
The date of the automatic snapshot to use for the new instance.
-
#source_instance_name ⇒ String
The name of the source instance from which the source automatic snapshot was created.
-
#tags ⇒ Array<Types::Tag>
The tag keys and optional values to add to the resource during create.
-
#use_latest_restorable_auto_snapshot ⇒ Boolean
A Boolean value to indicate whether to use the latest available automatic snapshot.
-
#user_data ⇒ String
You can create a launch script that configures a server with additional user data.
Instance Attribute Details
#add_ons ⇒ Array<Types::AddOnRequest>
An array of objects representing the add-ons to enable for the new instance.
#attached_disk_mapping ⇒ Hash<String,Array<Types::DiskMap>>
An object containing information about one or more disk mappings.
#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.
#bundle_id ⇒ String
The bundle of specification information for your virtual private server
(or instance), including the pricing plan (e.g., micro_1_0
).
#instance_names ⇒ Array<String>
The names for your new instances.
#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.
Constraint:
- This parameter cannot be defined together with the
source instance name
parameter. Theinstance snapshot name
andsource instance name
parameters are mutually exclusive.
^
#key_pair_name ⇒ String
The name for your key pair.
#restore_date ⇒ String
The date of the automatic snapshot to use for the new instance. Use the
get auto snapshots
operation to identify the dates of the available
automatic snapshots.
Constraints:
Must be specified in
YYYY-MM-DD
format.This parameter cannot be defined together with the
use latest restorable auto snapshot
parameter. Therestore date
anduse latest restorable auto snapshot
parameters are mutually exclusive.Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the Lightsail Dev Guide.
#source_instance_name ⇒ String
The name of the source instance from which the source automatic snapshot was created.
Constraints:
This parameter cannot be defined together with the
instance snapshot name
parameter. Thesource instance name
andinstance snapshot name
parameters are mutually exclusive.Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the Lightsail Dev Guide.
#tags ⇒ Array<Types::Tag>
The tag keys and optional values to add to the resource during create.
Use the TagResource
action to tag a resource after it\'s created.
#use_latest_restorable_auto_snapshot ⇒ Boolean
A Boolean value to indicate whether to use the latest available automatic snapshot.
Constraints:
This parameter cannot be defined together with the
restore date
parameter. Theuse latest restorable auto snapshot
andrestore date
parameters are mutually exclusive.Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the Lightsail Dev Guide.
#user_data ⇒ String
You can create a launch script that configures a server with additional
user data. For example, apt-get -y update
.
yum
, Debian and
Ubuntu use apt-get
, and FreeBSD uses pkg
. For a complete list, see
the Dev Guide.