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

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

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 InstanceEntry data as a 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)


5203
5204
5205
5206
5207
5208
5209
5210
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 5203

class InstanceEntry < Struct.new(
  :source_name,
  :instance_type,
  :port_info_source,
  :user_data,
  :availability_zone)
  include Aws::Structure
end

#instance_typeString

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

Returns:

  • (String)


5203
5204
5205
5206
5207
5208
5209
5210
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 5203

class InstanceEntry < Struct.new(
  :source_name,
  :instance_type,
  :port_info_source,
  :user_data,
  :availability_zone)
  include Aws::Structure
end

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

  • INSTANCE — Use the firewall settings from the source Lightsail instance.

  • NONE — Default to Amazon EC2.

  • CLOSED — All ports closed.

Returns:

  • (String)


5203
5204
5205
5206
5207
5208
5209
5210
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 5203

class InstanceEntry < Struct.new(
  :source_name,
  :instance_type,
  :port_info_source,
  :user_data,
  :availability_zone)
  include Aws::Structure
end

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


5203
5204
5205
5206
5207
5208
5209
5210
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 5203

class InstanceEntry < Struct.new(
  :source_name,
  :instance_type,
  :port_info_source,
  :user_data,
  :availability_zone)
  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.

Returns:

  • (String)


5203
5204
5205
5206
5207
5208
5209
5210
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 5203

class InstanceEntry < Struct.new(
  :source_name,
  :instance_type,
  :port_info_source,
  :user_data,
  :availability_zone)
  include Aws::Structure
end