You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Lightsail::Types::InstanceEntry

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing InstanceEntry as input to an Aws::Client method, you can use a vanilla Hash:

{
  source_name: "ResourceName", # required
  instance_type: "NonEmptyString", # required
  port_info_source: "DEFAULT", # required, accepts DEFAULT, INSTANCE, NONE, CLOSED
  user_data: "string",
  availability_zone: "string", # required
}

Describes the Amazon Elastic Compute Cloud instance and related resources to be created using the create cloud formation stack operation.

Instance Attribute Summary collapse

Instance Attribute Details

#availability_zoneString

The Availability Zone for the new Amazon EC2 instance.

Returns:

  • (String)

    The Availability Zone for the new Amazon EC2 instance.

#instance_typeString

The instance type (e.g., t2.micro) to use for the new Amazon EC2 instance.

Returns:

  • (String)

    The instance type (e.g., t2.micro) to use for the new Amazon EC2 instance.

#port_info_sourceString

The port configuration to use for the new Amazon EC2 instance.

The following configuration options are available:

  • DEFAULT - Use the default firewall settings from the Lightsail instance blueprint.

  • INSTANCE - Use the configured firewall settings from the source Lightsail instance.

  • NONE - Use the default Amazon EC2 security group.

  • CLOSED - All ports closed.

If you configured lightsail-connect as a cidrListAliases on your instance, or if you chose to allow the Lightsail browser-based SSH or RDP clients to connect to your instance, that configuration is not carried over to your new Amazon EC2 instance.

Possible values:

  • DEFAULT
  • INSTANCE
  • NONE
  • CLOSED

Returns:

  • (String)

    The port configuration to use for the new Amazon EC2 instance.

#source_nameString

The name of the export snapshot record, which contains the exported Lightsail instance snapshot that will be used as the source of the new Amazon EC2 instance.

Use the get export snapshot records operation to get a list of export snapshot records that you can use to create a CloudFormation stack.

Returns:

  • (String)

    The name of the export snapshot record, which contains the exported Lightsail instance snapshot that will be used as the source of the new Amazon EC2 instance.

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

Returns:

  • (String)

    A launch script you can create that configures a server with additional user data.