AWS SDK for C++  1.9.16
AWS SDK for C++
Public Member Functions | List of all members
Aws::Lightsail::Model::InstanceEntry Class Reference

#include <InstanceEntry.h>

Public Member Functions

 InstanceEntry ()
 
 InstanceEntry (Aws::Utils::Json::JsonView jsonValue)
 
InstanceEntryoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetSourceName () const
 
bool SourceNameHasBeenSet () const
 
void SetSourceName (const Aws::String &value)
 
void SetSourceName (Aws::String &&value)
 
void SetSourceName (const char *value)
 
InstanceEntryWithSourceName (const Aws::String &value)
 
InstanceEntryWithSourceName (Aws::String &&value)
 
InstanceEntryWithSourceName (const char *value)
 
const Aws::StringGetInstanceType () const
 
bool InstanceTypeHasBeenSet () const
 
void SetInstanceType (const Aws::String &value)
 
void SetInstanceType (Aws::String &&value)
 
void SetInstanceType (const char *value)
 
InstanceEntryWithInstanceType (const Aws::String &value)
 
InstanceEntryWithInstanceType (Aws::String &&value)
 
InstanceEntryWithInstanceType (const char *value)
 
const PortInfoSourceTypeGetPortInfoSource () const
 
bool PortInfoSourceHasBeenSet () const
 
void SetPortInfoSource (const PortInfoSourceType &value)
 
void SetPortInfoSource (PortInfoSourceType &&value)
 
InstanceEntryWithPortInfoSource (const PortInfoSourceType &value)
 
InstanceEntryWithPortInfoSource (PortInfoSourceType &&value)
 
const Aws::StringGetUserData () const
 
bool UserDataHasBeenSet () const
 
void SetUserData (const Aws::String &value)
 
void SetUserData (Aws::String &&value)
 
void SetUserData (const char *value)
 
InstanceEntryWithUserData (const Aws::String &value)
 
InstanceEntryWithUserData (Aws::String &&value)
 
InstanceEntryWithUserData (const char *value)
 
const Aws::StringGetAvailabilityZone () const
 
bool AvailabilityZoneHasBeenSet () const
 
void SetAvailabilityZone (const Aws::String &value)
 
void SetAvailabilityZone (Aws::String &&value)
 
void SetAvailabilityZone (const char *value)
 
InstanceEntryWithAvailabilityZone (const Aws::String &value)
 
InstanceEntryWithAvailabilityZone (Aws::String &&value)
 
InstanceEntryWithAvailabilityZone (const char *value)
 

Detailed Description

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

See Also:

AWS API Reference

Definition at line 34 of file InstanceEntry.h.

Constructor & Destructor Documentation

◆ InstanceEntry() [1/2]

Aws::Lightsail::Model::InstanceEntry::InstanceEntry ( )

◆ InstanceEntry() [2/2]

Aws::Lightsail::Model::InstanceEntry::InstanceEntry ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AvailabilityZoneHasBeenSet()

bool Aws::Lightsail::Model::InstanceEntry::AvailabilityZoneHasBeenSet ( ) const
inline

The Availability Zone for the new Amazon EC2 instance.

Definition at line 405 of file InstanceEntry.h.

◆ GetAvailabilityZone()

const Aws::String& Aws::Lightsail::Model::InstanceEntry::GetAvailabilityZone ( ) const
inline

The Availability Zone for the new Amazon EC2 instance.

Definition at line 400 of file InstanceEntry.h.

◆ GetInstanceType()

const Aws::String& Aws::Lightsail::Model::InstanceEntry::GetInstanceType ( ) const
inline

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

Definition at line 120 of file InstanceEntry.h.

◆ GetPortInfoSource()

const PortInfoSourceType& Aws::Lightsail::Model::InstanceEntry::GetPortInfoSource ( ) const
inline

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.

Definition at line 188 of file InstanceEntry.h.

◆ GetSourceName()

const Aws::String& Aws::Lightsail::Model::InstanceEntry::GetSourceName ( ) const
inline

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.

Definition at line 50 of file InstanceEntry.h.

◆ GetUserData()

const Aws::String& Aws::Lightsail::Model::InstanceEntry::GetUserData ( ) const
inline

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.

Definition at line 324 of file InstanceEntry.h.

◆ InstanceTypeHasBeenSet()

bool Aws::Lightsail::Model::InstanceEntry::InstanceTypeHasBeenSet ( ) const
inline

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

Definition at line 126 of file InstanceEntry.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Lightsail::Model::InstanceEntry::Jsonize ( ) const

◆ operator=()

InstanceEntry& Aws::Lightsail::Model::InstanceEntry::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ PortInfoSourceHasBeenSet()

bool Aws::Lightsail::Model::InstanceEntry::PortInfoSourceHasBeenSet ( ) const
inline

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.

Definition at line 213 of file InstanceEntry.h.

◆ SetAvailabilityZone() [1/3]

void Aws::Lightsail::Model::InstanceEntry::SetAvailabilityZone ( Aws::String &&  value)
inline

The Availability Zone for the new Amazon EC2 instance.

Definition at line 415 of file InstanceEntry.h.

◆ SetAvailabilityZone() [2/3]

void Aws::Lightsail::Model::InstanceEntry::SetAvailabilityZone ( const Aws::String value)
inline

The Availability Zone for the new Amazon EC2 instance.

Definition at line 410 of file InstanceEntry.h.

◆ SetAvailabilityZone() [3/3]

void Aws::Lightsail::Model::InstanceEntry::SetAvailabilityZone ( const char *  value)
inline

The Availability Zone for the new Amazon EC2 instance.

Definition at line 420 of file InstanceEntry.h.

◆ SetInstanceType() [1/3]

void Aws::Lightsail::Model::InstanceEntry::SetInstanceType ( Aws::String &&  value)
inline

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

Definition at line 138 of file InstanceEntry.h.

◆ SetInstanceType() [2/3]

void Aws::Lightsail::Model::InstanceEntry::SetInstanceType ( const Aws::String value)
inline

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

Definition at line 132 of file InstanceEntry.h.

◆ SetInstanceType() [3/3]

void Aws::Lightsail::Model::InstanceEntry::SetInstanceType ( const char *  value)
inline

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

Definition at line 144 of file InstanceEntry.h.

◆ SetPortInfoSource() [1/2]

void Aws::Lightsail::Model::InstanceEntry::SetPortInfoSource ( const PortInfoSourceType value)
inline

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.

Definition at line 238 of file InstanceEntry.h.

◆ SetPortInfoSource() [2/2]

void Aws::Lightsail::Model::InstanceEntry::SetPortInfoSource ( PortInfoSourceType &&  value)
inline

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.

Definition at line 263 of file InstanceEntry.h.

◆ SetSourceName() [1/3]

void Aws::Lightsail::Model::InstanceEntry::SetSourceName ( Aws::String &&  value)
inline

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.

Definition at line 77 of file InstanceEntry.h.

◆ SetSourceName() [2/3]

void Aws::Lightsail::Model::InstanceEntry::SetSourceName ( const Aws::String value)
inline

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.

Definition at line 68 of file InstanceEntry.h.

◆ SetSourceName() [3/3]

void Aws::Lightsail::Model::InstanceEntry::SetSourceName ( const char *  value)
inline

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.

Definition at line 86 of file InstanceEntry.h.

◆ SetUserData() [1/3]

void Aws::Lightsail::Model::InstanceEntry::SetUserData ( Aws::String &&  value)
inline

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.

Definition at line 354 of file InstanceEntry.h.

◆ SetUserData() [2/3]

void Aws::Lightsail::Model::InstanceEntry::SetUserData ( const Aws::String value)
inline

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.

Definition at line 344 of file InstanceEntry.h.

◆ SetUserData() [3/3]

void Aws::Lightsail::Model::InstanceEntry::SetUserData ( const char *  value)
inline

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.

Definition at line 364 of file InstanceEntry.h.

◆ SourceNameHasBeenSet()

bool Aws::Lightsail::Model::InstanceEntry::SourceNameHasBeenSet ( ) const
inline

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.

Definition at line 59 of file InstanceEntry.h.

◆ UserDataHasBeenSet()

bool Aws::Lightsail::Model::InstanceEntry::UserDataHasBeenSet ( ) const
inline

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.

Definition at line 334 of file InstanceEntry.h.

◆ WithAvailabilityZone() [1/3]

InstanceEntry& Aws::Lightsail::Model::InstanceEntry::WithAvailabilityZone ( Aws::String &&  value)
inline

The Availability Zone for the new Amazon EC2 instance.

Definition at line 430 of file InstanceEntry.h.

◆ WithAvailabilityZone() [2/3]

InstanceEntry& Aws::Lightsail::Model::InstanceEntry::WithAvailabilityZone ( const Aws::String value)
inline

The Availability Zone for the new Amazon EC2 instance.

Definition at line 425 of file InstanceEntry.h.

◆ WithAvailabilityZone() [3/3]

InstanceEntry& Aws::Lightsail::Model::InstanceEntry::WithAvailabilityZone ( const char *  value)
inline

The Availability Zone for the new Amazon EC2 instance.

Definition at line 435 of file InstanceEntry.h.

◆ WithInstanceType() [1/3]

InstanceEntry& Aws::Lightsail::Model::InstanceEntry::WithInstanceType ( Aws::String &&  value)
inline

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

Definition at line 156 of file InstanceEntry.h.

◆ WithInstanceType() [2/3]

InstanceEntry& Aws::Lightsail::Model::InstanceEntry::WithInstanceType ( const Aws::String value)
inline

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

Definition at line 150 of file InstanceEntry.h.

◆ WithInstanceType() [3/3]

InstanceEntry& Aws::Lightsail::Model::InstanceEntry::WithInstanceType ( const char *  value)
inline

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

Definition at line 162 of file InstanceEntry.h.

◆ WithPortInfoSource() [1/2]

InstanceEntry& Aws::Lightsail::Model::InstanceEntry::WithPortInfoSource ( const PortInfoSourceType value)
inline

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.

Definition at line 288 of file InstanceEntry.h.

◆ WithPortInfoSource() [2/2]

InstanceEntry& Aws::Lightsail::Model::InstanceEntry::WithPortInfoSource ( PortInfoSourceType &&  value)
inline

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.

Definition at line 313 of file InstanceEntry.h.

◆ WithSourceName() [1/3]

InstanceEntry& Aws::Lightsail::Model::InstanceEntry::WithSourceName ( Aws::String &&  value)
inline

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.

Definition at line 104 of file InstanceEntry.h.

◆ WithSourceName() [2/3]

InstanceEntry& Aws::Lightsail::Model::InstanceEntry::WithSourceName ( const Aws::String value)
inline

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.

Definition at line 95 of file InstanceEntry.h.

◆ WithSourceName() [3/3]

InstanceEntry& Aws::Lightsail::Model::InstanceEntry::WithSourceName ( const char *  value)
inline

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.

Definition at line 113 of file InstanceEntry.h.

◆ WithUserData() [1/3]

InstanceEntry& Aws::Lightsail::Model::InstanceEntry::WithUserData ( Aws::String &&  value)
inline

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.

Definition at line 384 of file InstanceEntry.h.

◆ WithUserData() [2/3]

InstanceEntry& Aws::Lightsail::Model::InstanceEntry::WithUserData ( const Aws::String value)
inline

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.

Definition at line 374 of file InstanceEntry.h.

◆ WithUserData() [3/3]

InstanceEntry& Aws::Lightsail::Model::InstanceEntry::WithUserData ( const char *  value)
inline

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.

Definition at line 394 of file InstanceEntry.h.


The documentation for this class was generated from the following file: