Method: Aws::Lightsail::Client#create_instances

Defined in:

lib/aws-sdk-lightsail/client.rb

#create_instances(params = {}) ⇒ Types::CreateInstancesResult

Creates one or more Amazon Lightsail instances.

The ‘create instances` operation supports tag-based access control via request tags. For more information, see the [Lightsail Developer Guide].

[1]: docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags

Examples:

Request syntax with placeholder values

resp = client.create_instances({
  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, StopInstanceOnIdle
      auto_snapshot_add_on_request: {
        snapshot_time_of_day: "TimeOfDay",
      },
      stop_instance_on_idle_request: {
        threshold: "string",
        duration: "string",
      },
    },
  ],
  ip_address_type: "dualstack", # accepts dualstack, ipv4, ipv6
})

Response structure

resp.operations #=> Array
resp.operations[0].id #=> String
resp.operations[0].resource_name #=> String
resp.operations[0].resource_type #=> String, one of "ContainerService", "Instance", "StaticIp", "KeyPair", "InstanceSnapshot", "Domain", "PeeredVpc", "LoadBalancer", "LoadBalancerTlsCertificate", "Disk", "DiskSnapshot", "RelationalDatabase", "RelationalDatabaseSnapshot", "ExportSnapshotRecord", "CloudFormationStackRecord", "Alarm", "ContactMethod", "Distribution", "Certificate", "Bucket"
resp.operations[0].created_at #=> Time
resp.operations[0].location.availability_zone #=> String
resp.operations[0].location.region_name #=> String, one of "us-east-1", "us-east-2", "us-west-1", "us-west-2", "eu-west-1", "eu-west-2", "eu-west-3", "eu-central-1", "ca-central-1", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "ap-northeast-2", "eu-north-1"
resp.operations[0].is_terminal #=> Boolean
resp.operations[0].operation_details #=> String
resp.operations[0].operation_type #=> String, one of "DeleteKnownHostKeys", "DeleteInstance", "CreateInstance", "StopInstance", "StartInstance", "RebootInstance", "OpenInstancePublicPorts", "PutInstancePublicPorts", "CloseInstancePublicPorts", "AllocateStaticIp", "ReleaseStaticIp", "AttachStaticIp", "DetachStaticIp", "UpdateDomainEntry", "DeleteDomainEntry", "CreateDomain", "DeleteDomain", "CreateInstanceSnapshot", "DeleteInstanceSnapshot", "CreateInstancesFromSnapshot", "CreateLoadBalancer", "DeleteLoadBalancer", "AttachInstancesToLoadBalancer", "DetachInstancesFromLoadBalancer", "UpdateLoadBalancerAttribute", "CreateLoadBalancerTlsCertificate", "DeleteLoadBalancerTlsCertificate", "AttachLoadBalancerTlsCertificate", "CreateDisk", "DeleteDisk", "AttachDisk", "DetachDisk", "CreateDiskSnapshot", "DeleteDiskSnapshot", "CreateDiskFromSnapshot", "CreateRelationalDatabase", "UpdateRelationalDatabase", "DeleteRelationalDatabase", "CreateRelationalDatabaseFromSnapshot", "CreateRelationalDatabaseSnapshot", "DeleteRelationalDatabaseSnapshot", "UpdateRelationalDatabaseParameters", "StartRelationalDatabase", "RebootRelationalDatabase", "StopRelationalDatabase", "EnableAddOn", "DisableAddOn", "PutAlarm", "GetAlarms", "DeleteAlarm", "TestAlarm", "CreateContactMethod", "GetContactMethods", "SendContactMethodVerification", "DeleteContactMethod", "CreateDistribution", "UpdateDistribution", "DeleteDistribution", "ResetDistributionCache", "AttachCertificateToDistribution", "DetachCertificateFromDistribution", "UpdateDistributionBundle", "SetIpAddressType", "CreateCertificate", "DeleteCertificate", "CreateContainerService", "UpdateContainerService", "DeleteContainerService", "CreateContainerServiceDeployment", "CreateContainerServiceRegistryLogin", "RegisterContainerImage", "DeleteContainerImage", "CreateBucket", "DeleteBucket", "CreateBucketAccessKey", "DeleteBucketAccessKey", "UpdateBucketBundle", "UpdateBucket", "SetResourceAccessForBucket", "UpdateInstanceMetadataOptions", "StartGUISession", "StopGUISession", "SetupInstanceHttps"
resp.operations[0].status #=> String, one of "NotStarted", "Started", "Failed", "Completed", "Succeeded"
resp.operations[0].status_changed_at #=> Time
resp.operations[0].error_code #=> String
resp.operations[0].error_details #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :instance_names (required, Array<String>) —

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

• :availability_zone (required, 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

• :custom_image_name (String) — default: 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>
  

• :blueprint_id (required, 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>
  

• :bundle_id (required, String) —

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

• :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

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

• :add_ons (Array<Types::AddOnRequest>) —

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

• :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:

• (Types::CreateInstancesResult) —

  Returns a response object which responds to the following methods:

  • #operations => Array&lt;Types::Operation&gt;

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-lightsail/client.rb', line 2875

def create_instances(params = {}, options = {})
  req = build_request(:create_instances, params)
  req.send_request(options)
end