AWS SDK for C++  1.7.266
AWS SDK for C++
Public Member Functions | List of all members
Aws::GameLift::Model::Instance Class Reference

#include <Instance.h>

Public Member Functions

 Instance ()
 
 Instance (Aws::Utils::Json::JsonView jsonValue)
 
Instanceoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetFleetId () const
 
bool FleetIdHasBeenSet () const
 
void SetFleetId (const Aws::String &value)
 
void SetFleetId (Aws::String &&value)
 
void SetFleetId (const char *value)
 
InstanceWithFleetId (const Aws::String &value)
 
InstanceWithFleetId (Aws::String &&value)
 
InstanceWithFleetId (const char *value)
 
const Aws::StringGetInstanceId () const
 
bool InstanceIdHasBeenSet () const
 
void SetInstanceId (const Aws::String &value)
 
void SetInstanceId (Aws::String &&value)
 
void SetInstanceId (const char *value)
 
InstanceWithInstanceId (const Aws::String &value)
 
InstanceWithInstanceId (Aws::String &&value)
 
InstanceWithInstanceId (const char *value)
 
const Aws::StringGetIpAddress () const
 
bool IpAddressHasBeenSet () const
 
void SetIpAddress (const Aws::String &value)
 
void SetIpAddress (Aws::String &&value)
 
void SetIpAddress (const char *value)
 
InstanceWithIpAddress (const Aws::String &value)
 
InstanceWithIpAddress (Aws::String &&value)
 
InstanceWithIpAddress (const char *value)
 
const Aws::StringGetDnsName () const
 
bool DnsNameHasBeenSet () const
 
void SetDnsName (const Aws::String &value)
 
void SetDnsName (Aws::String &&value)
 
void SetDnsName (const char *value)
 
InstanceWithDnsName (const Aws::String &value)
 
InstanceWithDnsName (Aws::String &&value)
 
InstanceWithDnsName (const char *value)
 
const OperatingSystemGetOperatingSystem () const
 
bool OperatingSystemHasBeenSet () const
 
void SetOperatingSystem (const OperatingSystem &value)
 
void SetOperatingSystem (OperatingSystem &&value)
 
InstanceWithOperatingSystem (const OperatingSystem &value)
 
InstanceWithOperatingSystem (OperatingSystem &&value)
 
const EC2InstanceTypeGetType () const
 
bool TypeHasBeenSet () const
 
void SetType (const EC2InstanceType &value)
 
void SetType (EC2InstanceType &&value)
 
InstanceWithType (const EC2InstanceType &value)
 
InstanceWithType (EC2InstanceType &&value)
 
const InstanceStatusGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const InstanceStatus &value)
 
void SetStatus (InstanceStatus &&value)
 
InstanceWithStatus (const InstanceStatus &value)
 
InstanceWithStatus (InstanceStatus &&value)
 
const Aws::Utils::DateTimeGetCreationTime () const
 
bool CreationTimeHasBeenSet () const
 
void SetCreationTime (const Aws::Utils::DateTime &value)
 
void SetCreationTime (Aws::Utils::DateTime &&value)
 
InstanceWithCreationTime (const Aws::Utils::DateTime &value)
 
InstanceWithCreationTime (Aws::Utils::DateTime &&value)
 

Detailed Description

Properties that describe an instance of a virtual computing resource that hosts one or more game servers. A fleet may contain zero or more instances.

See Also:

AWS API Reference

Definition at line 47 of file Instance.h.

Constructor & Destructor Documentation

◆ Instance() [1/2]

Aws::GameLift::Model::Instance::Instance ( )

◆ Instance() [2/2]

Aws::GameLift::Model::Instance::Instance ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ CreationTimeHasBeenSet()

bool Aws::GameLift::Model::Instance::CreationTimeHasBeenSet ( ) const
inline

Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Definition at line 449 of file Instance.h.

◆ DnsNameHasBeenSet()

bool Aws::GameLift::Model::Instance::DnsNameHasBeenSet ( ) const
inline

DNS identifier assigned to the instance that is running the game session. Values have the following format:

  • TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.

  • Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)

When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

Definition at line 205 of file Instance.h.

◆ FleetIdHasBeenSet()

bool Aws::GameLift::Model::Instance::FleetIdHasBeenSet ( ) const
inline

A unique identifier for a fleet that the instance is in.

Definition at line 64 of file Instance.h.

◆ GetCreationTime()

const Aws::Utils::DateTime& Aws::GameLift::Model::Instance::GetCreationTime ( ) const
inline

Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Definition at line 443 of file Instance.h.

◆ GetDnsName()

const Aws::String& Aws::GameLift::Model::Instance::GetDnsName ( ) const
inline

DNS identifier assigned to the instance that is running the game session. Values have the following format:

  • TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.

  • Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)

When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

Definition at line 191 of file Instance.h.

◆ GetFleetId()

const Aws::String& Aws::GameLift::Model::Instance::GetFleetId ( ) const
inline

A unique identifier for a fleet that the instance is in.

Definition at line 59 of file Instance.h.

◆ GetInstanceId()

const Aws::String& Aws::GameLift::Model::Instance::GetInstanceId ( ) const
inline

A unique identifier for an instance.

Definition at line 100 of file Instance.h.

◆ GetIpAddress()

const Aws::String& Aws::GameLift::Model::Instance::GetIpAddress ( ) const
inline

IP address that is assigned to the instance.

Definition at line 141 of file Instance.h.

◆ GetOperatingSystem()

const OperatingSystem& Aws::GameLift::Model::Instance::GetOperatingSystem ( ) const
inline

Operating system that is running on this instance.

Definition at line 295 of file Instance.h.

◆ GetStatus()

const InstanceStatus& Aws::GameLift::Model::Instance::GetStatus ( ) const
inline

Current status of the instance. Possible statuses include the following:

  • PENDING – The instance is in the process of being created and launching server processes as defined in the fleet's run-time configuration.

  • ACTIVE – The instance has been successfully created and at least one server process has successfully launched and reported back to Amazon GameLift that it is ready to host a game session. The instance is now considered ready to host game sessions.

  • TERMINATING – The instance is in the process of shutting down. This may happen to reduce capacity during a scaling down event or to recycle resources in the event of a problem.

Definition at line 366 of file Instance.h.

◆ GetType()

const EC2InstanceType& Aws::GameLift::Model::Instance::GetType ( ) const
inline

EC2 instance type that defines the computing resources of this instance.

Definition at line 326 of file Instance.h.

◆ InstanceIdHasBeenSet()

bool Aws::GameLift::Model::Instance::InstanceIdHasBeenSet ( ) const
inline

A unique identifier for an instance.

Definition at line 105 of file Instance.h.

◆ IpAddressHasBeenSet()

bool Aws::GameLift::Model::Instance::IpAddressHasBeenSet ( ) const
inline

IP address that is assigned to the instance.

Definition at line 146 of file Instance.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::GameLift::Model::Instance::Jsonize ( ) const

◆ OperatingSystemHasBeenSet()

bool Aws::GameLift::Model::Instance::OperatingSystemHasBeenSet ( ) const
inline

Operating system that is running on this instance.

Definition at line 300 of file Instance.h.

◆ operator=()

Instance& Aws::GameLift::Model::Instance::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetCreationTime() [1/2]

void Aws::GameLift::Model::Instance::SetCreationTime ( const Aws::Utils::DateTime value)
inline

Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Definition at line 455 of file Instance.h.

◆ SetCreationTime() [2/2]

void Aws::GameLift::Model::Instance::SetCreationTime ( Aws::Utils::DateTime &&  value)
inline

Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Definition at line 461 of file Instance.h.

◆ SetDnsName() [1/3]

void Aws::GameLift::Model::Instance::SetDnsName ( const Aws::String value)
inline

DNS identifier assigned to the instance that is running the game session. Values have the following format:

  • TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.

  • Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)

When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

Definition at line 219 of file Instance.h.

◆ SetDnsName() [2/3]

void Aws::GameLift::Model::Instance::SetDnsName ( Aws::String &&  value)
inline

DNS identifier assigned to the instance that is running the game session. Values have the following format:

  • TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.

  • Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)

When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

Definition at line 233 of file Instance.h.

◆ SetDnsName() [3/3]

void Aws::GameLift::Model::Instance::SetDnsName ( const char *  value)
inline

DNS identifier assigned to the instance that is running the game session. Values have the following format:

  • TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.

  • Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)

When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

Definition at line 247 of file Instance.h.

◆ SetFleetId() [1/3]

void Aws::GameLift::Model::Instance::SetFleetId ( const Aws::String value)
inline

A unique identifier for a fleet that the instance is in.

Definition at line 69 of file Instance.h.

◆ SetFleetId() [2/3]

void Aws::GameLift::Model::Instance::SetFleetId ( Aws::String &&  value)
inline

A unique identifier for a fleet that the instance is in.

Definition at line 74 of file Instance.h.

◆ SetFleetId() [3/3]

void Aws::GameLift::Model::Instance::SetFleetId ( const char *  value)
inline

A unique identifier for a fleet that the instance is in.

Definition at line 79 of file Instance.h.

◆ SetInstanceId() [1/3]

void Aws::GameLift::Model::Instance::SetInstanceId ( const Aws::String value)
inline

A unique identifier for an instance.

Definition at line 110 of file Instance.h.

◆ SetInstanceId() [2/3]

void Aws::GameLift::Model::Instance::SetInstanceId ( Aws::String &&  value)
inline

A unique identifier for an instance.

Definition at line 115 of file Instance.h.

◆ SetInstanceId() [3/3]

void Aws::GameLift::Model::Instance::SetInstanceId ( const char *  value)
inline

A unique identifier for an instance.

Definition at line 120 of file Instance.h.

◆ SetIpAddress() [1/3]

void Aws::GameLift::Model::Instance::SetIpAddress ( const Aws::String value)
inline

IP address that is assigned to the instance.

Definition at line 151 of file Instance.h.

◆ SetIpAddress() [2/3]

void Aws::GameLift::Model::Instance::SetIpAddress ( Aws::String &&  value)
inline

IP address that is assigned to the instance.

Definition at line 156 of file Instance.h.

◆ SetIpAddress() [3/3]

void Aws::GameLift::Model::Instance::SetIpAddress ( const char *  value)
inline

IP address that is assigned to the instance.

Definition at line 161 of file Instance.h.

◆ SetOperatingSystem() [1/2]

void Aws::GameLift::Model::Instance::SetOperatingSystem ( const OperatingSystem value)
inline

Operating system that is running on this instance.

Definition at line 305 of file Instance.h.

◆ SetOperatingSystem() [2/2]

void Aws::GameLift::Model::Instance::SetOperatingSystem ( OperatingSystem &&  value)
inline

Operating system that is running on this instance.

Definition at line 310 of file Instance.h.

◆ SetStatus() [1/2]

void Aws::GameLift::Model::Instance::SetStatus ( const InstanceStatus value)
inline

Current status of the instance. Possible statuses include the following:

  • PENDING – The instance is in the process of being created and launching server processes as defined in the fleet's run-time configuration.

  • ACTIVE – The instance has been successfully created and at least one server process has successfully launched and reported back to Amazon GameLift that it is ready to host a game session. The instance is now considered ready to host game sessions.

  • TERMINATING – The instance is in the process of shutting down. This may happen to reduce capacity during a scaling down event or to recycle resources in the event of a problem.

Definition at line 394 of file Instance.h.

◆ SetStatus() [2/2]

void Aws::GameLift::Model::Instance::SetStatus ( InstanceStatus &&  value)
inline

Current status of the instance. Possible statuses include the following:

  • PENDING – The instance is in the process of being created and launching server processes as defined in the fleet's run-time configuration.

  • ACTIVE – The instance has been successfully created and at least one server process has successfully launched and reported back to Amazon GameLift that it is ready to host a game session. The instance is now considered ready to host game sessions.

  • TERMINATING – The instance is in the process of shutting down. This may happen to reduce capacity during a scaling down event or to recycle resources in the event of a problem.

Definition at line 408 of file Instance.h.

◆ SetType() [1/2]

void Aws::GameLift::Model::Instance::SetType ( const EC2InstanceType value)
inline

EC2 instance type that defines the computing resources of this instance.

Definition at line 336 of file Instance.h.

◆ SetType() [2/2]

void Aws::GameLift::Model::Instance::SetType ( EC2InstanceType &&  value)
inline

EC2 instance type that defines the computing resources of this instance.

Definition at line 341 of file Instance.h.

◆ StatusHasBeenSet()

bool Aws::GameLift::Model::Instance::StatusHasBeenSet ( ) const
inline

Current status of the instance. Possible statuses include the following:

  • PENDING – The instance is in the process of being created and launching server processes as defined in the fleet's run-time configuration.

  • ACTIVE – The instance has been successfully created and at least one server process has successfully launched and reported back to Amazon GameLift that it is ready to host a game session. The instance is now considered ready to host game sessions.

  • TERMINATING – The instance is in the process of shutting down. This may happen to reduce capacity during a scaling down event or to recycle resources in the event of a problem.

Definition at line 380 of file Instance.h.

◆ TypeHasBeenSet()

bool Aws::GameLift::Model::Instance::TypeHasBeenSet ( ) const
inline

EC2 instance type that defines the computing resources of this instance.

Definition at line 331 of file Instance.h.

◆ WithCreationTime() [1/2]

Instance& Aws::GameLift::Model::Instance::WithCreationTime ( const Aws::Utils::DateTime value)
inline

Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Definition at line 467 of file Instance.h.

◆ WithCreationTime() [2/2]

Instance& Aws::GameLift::Model::Instance::WithCreationTime ( Aws::Utils::DateTime &&  value)
inline

Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Definition at line 473 of file Instance.h.

◆ WithDnsName() [1/3]

Instance& Aws::GameLift::Model::Instance::WithDnsName ( const Aws::String value)
inline

DNS identifier assigned to the instance that is running the game session. Values have the following format:

  • TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.

  • Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)

When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

Definition at line 261 of file Instance.h.

◆ WithDnsName() [2/3]

Instance& Aws::GameLift::Model::Instance::WithDnsName ( Aws::String &&  value)
inline

DNS identifier assigned to the instance that is running the game session. Values have the following format:

  • TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.

  • Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)

When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

Definition at line 275 of file Instance.h.

◆ WithDnsName() [3/3]

Instance& Aws::GameLift::Model::Instance::WithDnsName ( const char *  value)
inline

DNS identifier assigned to the instance that is running the game session. Values have the following format:

  • TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.

  • Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)

When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

Definition at line 289 of file Instance.h.

◆ WithFleetId() [1/3]

Instance& Aws::GameLift::Model::Instance::WithFleetId ( const Aws::String value)
inline

A unique identifier for a fleet that the instance is in.

Definition at line 84 of file Instance.h.

◆ WithFleetId() [2/3]

Instance& Aws::GameLift::Model::Instance::WithFleetId ( Aws::String &&  value)
inline

A unique identifier for a fleet that the instance is in.

Definition at line 89 of file Instance.h.

◆ WithFleetId() [3/3]

Instance& Aws::GameLift::Model::Instance::WithFleetId ( const char *  value)
inline

A unique identifier for a fleet that the instance is in.

Definition at line 94 of file Instance.h.

◆ WithInstanceId() [1/3]

Instance& Aws::GameLift::Model::Instance::WithInstanceId ( const Aws::String value)
inline

A unique identifier for an instance.

Definition at line 125 of file Instance.h.

◆ WithInstanceId() [2/3]

Instance& Aws::GameLift::Model::Instance::WithInstanceId ( Aws::String &&  value)
inline

A unique identifier for an instance.

Definition at line 130 of file Instance.h.

◆ WithInstanceId() [3/3]

Instance& Aws::GameLift::Model::Instance::WithInstanceId ( const char *  value)
inline

A unique identifier for an instance.

Definition at line 135 of file Instance.h.

◆ WithIpAddress() [1/3]

Instance& Aws::GameLift::Model::Instance::WithIpAddress ( const Aws::String value)
inline

IP address that is assigned to the instance.

Definition at line 166 of file Instance.h.

◆ WithIpAddress() [2/3]

Instance& Aws::GameLift::Model::Instance::WithIpAddress ( Aws::String &&  value)
inline

IP address that is assigned to the instance.

Definition at line 171 of file Instance.h.

◆ WithIpAddress() [3/3]

Instance& Aws::GameLift::Model::Instance::WithIpAddress ( const char *  value)
inline

IP address that is assigned to the instance.

Definition at line 176 of file Instance.h.

◆ WithOperatingSystem() [1/2]

Instance& Aws::GameLift::Model::Instance::WithOperatingSystem ( const OperatingSystem value)
inline

Operating system that is running on this instance.

Definition at line 315 of file Instance.h.

◆ WithOperatingSystem() [2/2]

Instance& Aws::GameLift::Model::Instance::WithOperatingSystem ( OperatingSystem &&  value)
inline

Operating system that is running on this instance.

Definition at line 320 of file Instance.h.

◆ WithStatus() [1/2]

Instance& Aws::GameLift::Model::Instance::WithStatus ( const InstanceStatus value)
inline

Current status of the instance. Possible statuses include the following:

  • PENDING – The instance is in the process of being created and launching server processes as defined in the fleet's run-time configuration.

  • ACTIVE – The instance has been successfully created and at least one server process has successfully launched and reported back to Amazon GameLift that it is ready to host a game session. The instance is now considered ready to host game sessions.

  • TERMINATING – The instance is in the process of shutting down. This may happen to reduce capacity during a scaling down event or to recycle resources in the event of a problem.

Definition at line 422 of file Instance.h.

◆ WithStatus() [2/2]

Instance& Aws::GameLift::Model::Instance::WithStatus ( InstanceStatus &&  value)
inline

Current status of the instance. Possible statuses include the following:

  • PENDING – The instance is in the process of being created and launching server processes as defined in the fleet's run-time configuration.

  • ACTIVE – The instance has been successfully created and at least one server process has successfully launched and reported back to Amazon GameLift that it is ready to host a game session. The instance is now considered ready to host game sessions.

  • TERMINATING – The instance is in the process of shutting down. This may happen to reduce capacity during a scaling down event or to recycle resources in the event of a problem.

Definition at line 436 of file Instance.h.

◆ WithType() [1/2]

Instance& Aws::GameLift::Model::Instance::WithType ( const EC2InstanceType value)
inline

EC2 instance type that defines the computing resources of this instance.

Definition at line 346 of file Instance.h.

◆ WithType() [2/2]

Instance& Aws::GameLift::Model::Instance::WithType ( EC2InstanceType &&  value)
inline

EC2 instance type that defines the computing resources of this instance.

Definition at line 351 of file Instance.h.


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