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

Inherits:

Struct

• Object
• Struct
• Aws::Lightsail::Types::CreateInstancesRequest

Includes:

Structure

Defined in:

lib/aws-sdk-lightsail/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #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 (‘app_wordpress_x_x` or `app_lamp_x_x`).

• #bundle_id ⇒ String

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

• #custom_image_name ⇒ String

  (Discontinued) The name for your custom image.

• #instance_names ⇒ Array<String>

  The names to use for your new Lightsail instances.

• #ip_address_type ⇒ String

  The IP address type for the instance.

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

Returns:

• (Array<Types::AddOnRequest>)

# File 'lib/aws-sdk-lightsail/types.rb', line 4188

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

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

Returns:

• (String)

# File 'lib/aws-sdk-lightsail/types.rb', line 4188

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_id ⇒ String

The ID for a virtual private server image (‘app_wordpress_x_x` or `app_lamp_x_x`). Use the `get blueprints` operation to return a list of available images (or blueprints).

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

</note>

Returns:

• (String)

# File 'lib/aws-sdk-lightsail/types.rb', line 4188

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_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-lightsail/types.rb', line 4188

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_name ⇒ String

(Discontinued) The name for your custom image.

<note markdown=“1”> In releases prior to June 12, 2017, this parameter was ignored by the API. It is now discontinued.

</note>

Returns:

• (String)

# File 'lib/aws-sdk-lightsail/types.rb', line 4188

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_names ⇒ Array<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>)

# File 'lib/aws-sdk-lightsail/types.rb', line 4188

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_type ⇒ String

The IP address type for the instance.

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

The default value is ‘dualstack`.

Returns:

• (String)

# File 'lib/aws-sdk-lightsail/types.rb', line 4188

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_name ⇒ String

The name of your key pair.

Returns:

• (String)

# File 'lib/aws-sdk-lightsail/types.rb', line 4188

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

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

Returns:

• (Array<Types::Tag>)

# File 'lib/aws-sdk-lightsail/types.rb', line 4188

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_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`.

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

</note>

[1]: docs.aws.amazon.com/lightsail/latest/userguide/compare-options-choose-lightsail-instance-image

Returns:

• (String)

# File 'lib/aws-sdk-lightsail/types.rb', line 4188

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