You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::Lightsail::Types::CreateInstancesRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Lightsail::Types::CreateInstancesRequest
- Defined in:
- (unknown)
Overview
When passing CreateInstancesRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
instance_names: ["string"], # required
availability_zone: "string", # required
custom_image_name: "ResourceName",
blueprint_id: "NonEmptyString", # required
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",
},
},
],
}
Instance Attribute Summary collapse
-
#add_ons ⇒ Array<Types::AddOnRequest>
An array of objects representing the add-ons to enable for the new instance.
-
#availability_zone ⇒ String
The Availability Zone in which to create your instance.
-
#blueprint_id ⇒ String
The ID for a virtual private server image (e.g.,
app_wordpress_4_4
orapp_lamp_7_0
). -
#bundle_id ⇒ String
The bundle of specification information for your virtual private server (or instance), including the pricing plan (e.g.,
micro_1_0
). -
#custom_image_name ⇒ String
(Deprecated) The name for your custom image.
-
#instance_names ⇒ Array<String>
The names to use for your new Lightsail instances.
-
#key_pair_name ⇒ String
The name of your key pair.
-
#tags ⇒ Array<Types::Tag>
The tag keys and optional values to add to the resource during create.
-
#user_data ⇒ String
A launch script you can create 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.
#availability_zone ⇒ String
The Availability Zone in which to create your instance. Use the
following format: 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.
#blueprint_id ⇒ String
The ID for a virtual private server image (e.g., app_wordpress_4_4
or
app_lamp_7_0
). Use the get blueprints
operation to return a list of
available images (or blueprints).
#bundle_id ⇒ String
The bundle of specification information for your virtual private server
(or instance), including the pricing plan (e.g., micro_1_0
).
#custom_image_name ⇒ String
(Deprecated) The name for your custom image.
#instance_names ⇒ Array<String>
The names to use for your new Lightsail instances. Separate multiple
values using quotation marks and commas, for example:
["MyFirstInstance","MySecondInstance"]
#key_pair_name ⇒ String
The name of your key pair.
#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.
#user_data ⇒ String
A launch script you can create that configures a server with additional
user data. For example, you might want to run apt-get -y update
.
yum
, Debian and
Ubuntu use apt-get
, and FreeBSD uses pkg
. For a complete list, see
the Dev Guide.