Class: Aws::Lightsail::Types::CreateInstancesRequest

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 CreateInstancesRequest data as a 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",
      },
    },
  ],
  ip_address_type: "dualstack", # accepts dualstack, ipv4
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#add_onsArray<Types::AddOnRequest>

An array of objects representing the add-ons to enable for the new instance.

Returns:



4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 4279

class CreateInstancesRequest < Struct.new(
  :instance_names,
  :availability_zone,
  :custom_image_name,
  :blueprint_id,
  :bundle_id,
  :user_data,
  :key_pair_name,
  :tags,
  :add_ons,
  :ip_address_type)
  SENSITIVE = []
  include Aws::Structure
end

#availability_zoneString

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.

Returns:

  • (String)


4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 4279

class CreateInstancesRequest < Struct.new(
  :instance_names,
  :availability_zone,
  :custom_image_name,
  :blueprint_id,
  :bundle_id,
  :user_data,
  :key_pair_name,
  :tags,
  :add_ons,
  :ip_address_type)
  SENSITIVE = []
  include Aws::Structure
end

#blueprint_idString

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).

Use active blueprints when creating new instances. Inactive blueprints are listed to support customers with existing instances and are not necessarily available to create new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases.

Returns:

  • (String)


4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 4279

class CreateInstancesRequest < Struct.new(
  :instance_names,
  :availability_zone,
  :custom_image_name,
  :blueprint_id,
  :bundle_id,
  :user_data,
  :key_pair_name,
  :tags,
  :add_ons,
  :ip_address_type)
  SENSITIVE = []
  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)


4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 4279

class CreateInstancesRequest < Struct.new(
  :instance_names,
  :availability_zone,
  :custom_image_name,
  :blueprint_id,
  :bundle_id,
  :user_data,
  :key_pair_name,
  :tags,
  :add_ons,
  :ip_address_type)
  SENSITIVE = []
  include Aws::Structure
end

#custom_image_nameString

(Deprecated) The name for your custom image.

In releases prior to June 12, 2017, this parameter was ignored by the API. It is now deprecated.

Returns:

  • (String)


4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 4279

class CreateInstancesRequest < Struct.new(
  :instance_names,
  :availability_zone,
  :custom_image_name,
  :blueprint_id,
  :bundle_id,
  :user_data,
  :key_pair_name,
  :tags,
  :add_ons,
  :ip_address_type)
  SENSITIVE = []
  include Aws::Structure
end

#instance_namesArray<String>

The names to use for your new Lightsail instances. Separate multiple values using quotation marks and commas, for example: ["MyFirstInstance","MySecondInstance"]

Returns:

  • (Array<String>)


4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 4279

class CreateInstancesRequest < Struct.new(
  :instance_names,
  :availability_zone,
  :custom_image_name,
  :blueprint_id,
  :bundle_id,
  :user_data,
  :key_pair_name,
  :tags,
  :add_ons,
  :ip_address_type)
  SENSITIVE = []
  include Aws::Structure
end

#ip_address_typeString

The IP address type for the instance.

The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.

The default value is dualstack.

Returns:

  • (String)


4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 4279

class CreateInstancesRequest < Struct.new(
  :instance_names,
  :availability_zone,
  :custom_image_name,
  :blueprint_id,
  :bundle_id,
  :user_data,
  :key_pair_name,
  :tags,
  :add_ons,
  :ip_address_type)
  SENSITIVE = []
  include Aws::Structure
end

#key_pair_nameString

The name of your key pair.

Returns:

  • (String)


4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 4279

class CreateInstancesRequest < Struct.new(
  :instance_names,
  :availability_zone,
  :custom_image_name,
  :blueprint_id,
  :bundle_id,
  :user_data,
  :key_pair_name,
  :tags,
  :add_ons,
  :ip_address_type)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<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.

Returns:



4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 4279

class CreateInstancesRequest < Struct.new(
  :instance_names,
  :availability_zone,
  :custom_image_name,
  :blueprint_id,
  :bundle_id,
  :user_data,
  :key_pair_name,
  :tags,
  :add_ons,
  :ip_address_type)
  SENSITIVE = []
  include Aws::Structure
end

#user_dataString

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.

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 Amazon Lightsail Developer Guide.

Returns:

  • (String)


4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 4279

class CreateInstancesRequest < Struct.new(
  :instance_names,
  :availability_zone,
  :custom_image_name,
  :blueprint_id,
  :bundle_id,
  :user_data,
  :key_pair_name,
  :tags,
  :add_ons,
  :ip_address_type)
  SENSITIVE = []
  include Aws::Structure
end