/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace GameLift { namespace Model { /** *

Represents a virtual computing instance that runs game server processes and * hosts game sessions. In Amazon GameLift, one or more instances make up a managed * EC2 fleet.

See Also:

AWS * API Reference

*/ class Instance { public: AWS_GAMELIFT_API Instance(); AWS_GAMELIFT_API Instance(Aws::Utils::Json::JsonView jsonValue); AWS_GAMELIFT_API Instance& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_GAMELIFT_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ /** *

A unique identifier for the fleet that the instance belongs to.

*/ inline const Aws::String& GetFleetId() const{ return m_fleetId; } inline bool FleetIdHasBeenSet() const { return m_fleetIdHasBeenSet; } inline void SetFleetId(const Aws::String& value) { m_fleetIdHasBeenSet = true; m_fleetId = value; } inline void SetFleetId(Aws::String&& value) { m_fleetIdHasBeenSet = true; m_fleetId = std::move(value); } inline void SetFleetId(const char* value) { m_fleetIdHasBeenSet = true; m_fleetId.assign(value); } inline Instance& WithFleetId(const Aws::String& value) { SetFleetId(value); return *this;} inline Instance& WithFleetId(Aws::String&& value) { SetFleetId(std::move(value)); return *this;} inline Instance& WithFleetId(const char* value) { SetFleetId(value); return *this;} ///@} ///@{ /** *

The Amazon Resource Name (ARN) * that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. * ARNs are unique across all Regions. Format is * arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

*/ inline const Aws::String& GetFleetArn() const{ return m_fleetArn; } inline bool FleetArnHasBeenSet() const { return m_fleetArnHasBeenSet; } inline void SetFleetArn(const Aws::String& value) { m_fleetArnHasBeenSet = true; m_fleetArn = value; } inline void SetFleetArn(Aws::String&& value) { m_fleetArnHasBeenSet = true; m_fleetArn = std::move(value); } inline void SetFleetArn(const char* value) { m_fleetArnHasBeenSet = true; m_fleetArn.assign(value); } inline Instance& WithFleetArn(const Aws::String& value) { SetFleetArn(value); return *this;} inline Instance& WithFleetArn(Aws::String&& value) { SetFleetArn(std::move(value)); return *this;} inline Instance& WithFleetArn(const char* value) { SetFleetArn(value); return *this;} ///@} ///@{ /** *

A unique identifier for the instance.

*/ inline const Aws::String& GetInstanceId() const{ return m_instanceId; } inline bool InstanceIdHasBeenSet() const { return m_instanceIdHasBeenSet; } inline void SetInstanceId(const Aws::String& value) { m_instanceIdHasBeenSet = true; m_instanceId = value; } inline void SetInstanceId(Aws::String&& value) { m_instanceIdHasBeenSet = true; m_instanceId = std::move(value); } inline void SetInstanceId(const char* value) { m_instanceIdHasBeenSet = true; m_instanceId.assign(value); } inline Instance& WithInstanceId(const Aws::String& value) { SetInstanceId(value); return *this;} inline Instance& WithInstanceId(Aws::String&& value) { SetInstanceId(std::move(value)); return *this;} inline Instance& WithInstanceId(const char* value) { SetInstanceId(value); return *this;} ///@} ///@{ /** *

IP address that is assigned to the instance.

*/ inline const Aws::String& GetIpAddress() const{ return m_ipAddress; } inline bool IpAddressHasBeenSet() const { return m_ipAddressHasBeenSet; } inline void SetIpAddress(const Aws::String& value) { m_ipAddressHasBeenSet = true; m_ipAddress = value; } inline void SetIpAddress(Aws::String&& value) { m_ipAddressHasBeenSet = true; m_ipAddress = std::move(value); } inline void SetIpAddress(const char* value) { m_ipAddressHasBeenSet = true; m_ipAddress.assign(value); } inline Instance& WithIpAddress(const Aws::String& value) { SetIpAddress(value); return *this;} inline Instance& WithIpAddress(Aws::String&& value) { SetIpAddress(std::move(value)); return *this;} inline Instance& WithIpAddress(const char* value) { SetIpAddress(value); return *this;} ///@} ///@{ /** *

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

*/ inline const Aws::String& GetDnsName() const{ return m_dnsName; } inline bool DnsNameHasBeenSet() const { return m_dnsNameHasBeenSet; } inline void SetDnsName(const Aws::String& value) { m_dnsNameHasBeenSet = true; m_dnsName = value; } inline void SetDnsName(Aws::String&& value) { m_dnsNameHasBeenSet = true; m_dnsName = std::move(value); } inline void SetDnsName(const char* value) { m_dnsNameHasBeenSet = true; m_dnsName.assign(value); } inline Instance& WithDnsName(const Aws::String& value) { SetDnsName(value); return *this;} inline Instance& WithDnsName(Aws::String&& value) { SetDnsName(std::move(value)); return *this;} inline Instance& WithDnsName(const char* value) { SetDnsName(value); return *this;} ///@} ///@{ /** *

Operating system that is running on this EC2 instance.

Amazon * Linux 2 (AL2) will reach end of support on 6/30/2025. See more details in the Amazon Linux 2 FAQs. For * game servers that are hosted on AL2 and use Amazon GameLift server SDK 4.x., * first update the game server build to server SDK 5.x, and then deploy to AL2023 * instances. See * Migrate to Amazon GameLift server SDK version 5.

*/ inline const OperatingSystem& GetOperatingSystem() const{ return m_operatingSystem; } inline bool OperatingSystemHasBeenSet() const { return m_operatingSystemHasBeenSet; } inline void SetOperatingSystem(const OperatingSystem& value) { m_operatingSystemHasBeenSet = true; m_operatingSystem = value; } inline void SetOperatingSystem(OperatingSystem&& value) { m_operatingSystemHasBeenSet = true; m_operatingSystem = std::move(value); } inline Instance& WithOperatingSystem(const OperatingSystem& value) { SetOperatingSystem(value); return *this;} inline Instance& WithOperatingSystem(OperatingSystem&& value) { SetOperatingSystem(std::move(value)); return *this;} ///@} ///@{ /** *

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

*/ inline const EC2InstanceType& GetType() const{ return m_type; } inline bool TypeHasBeenSet() const { return m_typeHasBeenSet; } inline void SetType(const EC2InstanceType& value) { m_typeHasBeenSet = true; m_type = value; } inline void SetType(EC2InstanceType&& value) { m_typeHasBeenSet = true; m_type = std::move(value); } inline Instance& WithType(const EC2InstanceType& value) { SetType(value); return *this;} inline Instance& WithType(EC2InstanceType&& value) { SetType(std::move(value)); return *this;} ///@} ///@{ /** *

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.

*/ inline const InstanceStatus& GetStatus() const{ return m_status; } inline bool StatusHasBeenSet() const { return m_statusHasBeenSet; } inline void SetStatus(const InstanceStatus& value) { m_statusHasBeenSet = true; m_status = value; } inline void SetStatus(InstanceStatus&& value) { m_statusHasBeenSet = true; m_status = std::move(value); } inline Instance& WithStatus(const InstanceStatus& value) { SetStatus(value); return *this;} inline Instance& WithStatus(InstanceStatus&& value) { SetStatus(std::move(value)); return *this;} ///@} ///@{ /** *

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

*/ inline const Aws::Utils::DateTime& GetCreationTime() const{ return m_creationTime; } inline bool CreationTimeHasBeenSet() const { return m_creationTimeHasBeenSet; } inline void SetCreationTime(const Aws::Utils::DateTime& value) { m_creationTimeHasBeenSet = true; m_creationTime = value; } inline void SetCreationTime(Aws::Utils::DateTime&& value) { m_creationTimeHasBeenSet = true; m_creationTime = std::move(value); } inline Instance& WithCreationTime(const Aws::Utils::DateTime& value) { SetCreationTime(value); return *this;} inline Instance& WithCreationTime(Aws::Utils::DateTime&& value) { SetCreationTime(std::move(value)); return *this;} ///@} ///@{ /** *

The fleet location of the instance, expressed as an Amazon Web Services * Region code, such as us-west-2.

*/ inline const Aws::String& GetLocation() const{ return m_location; } inline bool LocationHasBeenSet() const { return m_locationHasBeenSet; } inline void SetLocation(const Aws::String& value) { m_locationHasBeenSet = true; m_location = value; } inline void SetLocation(Aws::String&& value) { m_locationHasBeenSet = true; m_location = std::move(value); } inline void SetLocation(const char* value) { m_locationHasBeenSet = true; m_location.assign(value); } inline Instance& WithLocation(const Aws::String& value) { SetLocation(value); return *this;} inline Instance& WithLocation(Aws::String&& value) { SetLocation(std::move(value)); return *this;} inline Instance& WithLocation(const char* value) { SetLocation(value); return *this;} ///@} private: Aws::String m_fleetId; bool m_fleetIdHasBeenSet = false; Aws::String m_fleetArn; bool m_fleetArnHasBeenSet = false; Aws::String m_instanceId; bool m_instanceIdHasBeenSet = false; Aws::String m_ipAddress; bool m_ipAddressHasBeenSet = false; Aws::String m_dnsName; bool m_dnsNameHasBeenSet = false; OperatingSystem m_operatingSystem; bool m_operatingSystemHasBeenSet = false; EC2InstanceType m_type; bool m_typeHasBeenSet = false; InstanceStatus m_status; bool m_statusHasBeenSet = false; Aws::Utils::DateTime m_creationTime; bool m_creationTimeHasBeenSet = false; Aws::String m_location; bool m_locationHasBeenSet = false; }; } // namespace Model } // namespace GameLift } // namespace Aws