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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#availability_zoneString

The Availability Zone for the new Amazon EC2 instance.

Returns:

  • (String)


9879
9880
9881
9882
9883
9884
9885
9886
9887
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 9879

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

#instance_typeString

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

Returns:

  • (String)


9879
9880
9881
9882
9883
9884
9885
9886
9887
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 9879

class InstanceEntry < Struct.new(
  :source_name,
  :instance_type,
  :port_info_source,
  :user_data,
  :availability_zone)
  SENSITIVE = []
  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 Lightsail instance blueprint. If this is specified, then IPv4 and IPv6 will be configured for the new instance that is created in Amazon EC2.

  • INSTANCE - Use the configured firewall settings from the source Lightsail instance. If this is specified, the new instance that is created in Amazon EC2 will be configured to match the configuration of the source Lightsail instance. For example, if the source instance is configured for dual-stack (IPv4 and IPv6), then IPv4 and IPv6 will be configured for the new instance that is created in Amazon EC2. If the source instance is configured for IPv4 only, then only IPv4 will be configured for the new instance that is created in Amazon EC2.

  • NONE - Use the default Amazon EC2 security group. If this is specified, then only IPv4 will be configured for the new instance that is created in Amazon EC2.

  • CLOSED - All ports closed. If this is specified, then only IPv4 will be configured for the new instance that is created in Amazon EC2.

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.

Returns:

  • (String)


9879
9880
9881
9882
9883
9884
9885
9886
9887
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 9879

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


9879
9880
9881
9882
9883
9884
9885
9886
9887
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 9879

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

Returns:

  • (String)


9879
9880
9881
9882
9883
9884
9885
9886
9887
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 9879

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