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

#include <FleetAttributes.h>

Public Member Functions

 FleetAttributes ()
 
 FleetAttributes (Aws::Utils::Json::JsonView jsonValue)
 
FleetAttributesoperator= (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)
 
FleetAttributesWithFleetId (const Aws::String &value)
 
FleetAttributesWithFleetId (Aws::String &&value)
 
FleetAttributesWithFleetId (const char *value)
 
const Aws::StringGetFleetArn () const
 
bool FleetArnHasBeenSet () const
 
void SetFleetArn (const Aws::String &value)
 
void SetFleetArn (Aws::String &&value)
 
void SetFleetArn (const char *value)
 
FleetAttributesWithFleetArn (const Aws::String &value)
 
FleetAttributesWithFleetArn (Aws::String &&value)
 
FleetAttributesWithFleetArn (const char *value)
 
const FleetTypeGetFleetType () const
 
bool FleetTypeHasBeenSet () const
 
void SetFleetType (const FleetType &value)
 
void SetFleetType (FleetType &&value)
 
FleetAttributesWithFleetType (const FleetType &value)
 
FleetAttributesWithFleetType (FleetType &&value)
 
const EC2InstanceTypeGetInstanceType () const
 
bool InstanceTypeHasBeenSet () const
 
void SetInstanceType (const EC2InstanceType &value)
 
void SetInstanceType (EC2InstanceType &&value)
 
FleetAttributesWithInstanceType (const EC2InstanceType &value)
 
FleetAttributesWithInstanceType (EC2InstanceType &&value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
FleetAttributesWithDescription (const Aws::String &value)
 
FleetAttributesWithDescription (Aws::String &&value)
 
FleetAttributesWithDescription (const char *value)
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
FleetAttributesWithName (const Aws::String &value)
 
FleetAttributesWithName (Aws::String &&value)
 
FleetAttributesWithName (const char *value)
 
const Aws::Utils::DateTimeGetCreationTime () const
 
bool CreationTimeHasBeenSet () const
 
void SetCreationTime (const Aws::Utils::DateTime &value)
 
void SetCreationTime (Aws::Utils::DateTime &&value)
 
FleetAttributesWithCreationTime (const Aws::Utils::DateTime &value)
 
FleetAttributesWithCreationTime (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetTerminationTime () const
 
bool TerminationTimeHasBeenSet () const
 
void SetTerminationTime (const Aws::Utils::DateTime &value)
 
void SetTerminationTime (Aws::Utils::DateTime &&value)
 
FleetAttributesWithTerminationTime (const Aws::Utils::DateTime &value)
 
FleetAttributesWithTerminationTime (Aws::Utils::DateTime &&value)
 
const FleetStatusGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const FleetStatus &value)
 
void SetStatus (FleetStatus &&value)
 
FleetAttributesWithStatus (const FleetStatus &value)
 
FleetAttributesWithStatus (FleetStatus &&value)
 
const Aws::StringGetBuildId () const
 
bool BuildIdHasBeenSet () const
 
void SetBuildId (const Aws::String &value)
 
void SetBuildId (Aws::String &&value)
 
void SetBuildId (const char *value)
 
FleetAttributesWithBuildId (const Aws::String &value)
 
FleetAttributesWithBuildId (Aws::String &&value)
 
FleetAttributesWithBuildId (const char *value)
 
const Aws::StringGetScriptId () const
 
bool ScriptIdHasBeenSet () const
 
void SetScriptId (const Aws::String &value)
 
void SetScriptId (Aws::String &&value)
 
void SetScriptId (const char *value)
 
FleetAttributesWithScriptId (const Aws::String &value)
 
FleetAttributesWithScriptId (Aws::String &&value)
 
FleetAttributesWithScriptId (const char *value)
 
const Aws::StringGetServerLaunchPath () const
 
bool ServerLaunchPathHasBeenSet () const
 
void SetServerLaunchPath (const Aws::String &value)
 
void SetServerLaunchPath (Aws::String &&value)
 
void SetServerLaunchPath (const char *value)
 
FleetAttributesWithServerLaunchPath (const Aws::String &value)
 
FleetAttributesWithServerLaunchPath (Aws::String &&value)
 
FleetAttributesWithServerLaunchPath (const char *value)
 
const Aws::StringGetServerLaunchParameters () const
 
bool ServerLaunchParametersHasBeenSet () const
 
void SetServerLaunchParameters (const Aws::String &value)
 
void SetServerLaunchParameters (Aws::String &&value)
 
void SetServerLaunchParameters (const char *value)
 
FleetAttributesWithServerLaunchParameters (const Aws::String &value)
 
FleetAttributesWithServerLaunchParameters (Aws::String &&value)
 
FleetAttributesWithServerLaunchParameters (const char *value)
 
const Aws::Vector< Aws::String > & GetLogPaths () const
 
bool LogPathsHasBeenSet () const
 
void SetLogPaths (const Aws::Vector< Aws::String > &value)
 
void SetLogPaths (Aws::Vector< Aws::String > &&value)
 
FleetAttributesWithLogPaths (const Aws::Vector< Aws::String > &value)
 
FleetAttributesWithLogPaths (Aws::Vector< Aws::String > &&value)
 
FleetAttributesAddLogPaths (const Aws::String &value)
 
FleetAttributesAddLogPaths (Aws::String &&value)
 
FleetAttributesAddLogPaths (const char *value)
 
const ProtectionPolicyGetNewGameSessionProtectionPolicy () const
 
bool NewGameSessionProtectionPolicyHasBeenSet () const
 
void SetNewGameSessionProtectionPolicy (const ProtectionPolicy &value)
 
void SetNewGameSessionProtectionPolicy (ProtectionPolicy &&value)
 
FleetAttributesWithNewGameSessionProtectionPolicy (const ProtectionPolicy &value)
 
FleetAttributesWithNewGameSessionProtectionPolicy (ProtectionPolicy &&value)
 
const OperatingSystemGetOperatingSystem () const
 
bool OperatingSystemHasBeenSet () const
 
void SetOperatingSystem (const OperatingSystem &value)
 
void SetOperatingSystem (OperatingSystem &&value)
 
FleetAttributesWithOperatingSystem (const OperatingSystem &value)
 
FleetAttributesWithOperatingSystem (OperatingSystem &&value)
 
const ResourceCreationLimitPolicyGetResourceCreationLimitPolicy () const
 
bool ResourceCreationLimitPolicyHasBeenSet () const
 
void SetResourceCreationLimitPolicy (const ResourceCreationLimitPolicy &value)
 
void SetResourceCreationLimitPolicy (ResourceCreationLimitPolicy &&value)
 
FleetAttributesWithResourceCreationLimitPolicy (const ResourceCreationLimitPolicy &value)
 
FleetAttributesWithResourceCreationLimitPolicy (ResourceCreationLimitPolicy &&value)
 
const Aws::Vector< Aws::String > & GetMetricGroups () const
 
bool MetricGroupsHasBeenSet () const
 
void SetMetricGroups (const Aws::Vector< Aws::String > &value)
 
void SetMetricGroups (Aws::Vector< Aws::String > &&value)
 
FleetAttributesWithMetricGroups (const Aws::Vector< Aws::String > &value)
 
FleetAttributesWithMetricGroups (Aws::Vector< Aws::String > &&value)
 
FleetAttributesAddMetricGroups (const Aws::String &value)
 
FleetAttributesAddMetricGroups (Aws::String &&value)
 
FleetAttributesAddMetricGroups (const char *value)
 
const Aws::Vector< FleetAction > & GetStoppedActions () const
 
bool StoppedActionsHasBeenSet () const
 
void SetStoppedActions (const Aws::Vector< FleetAction > &value)
 
void SetStoppedActions (Aws::Vector< FleetAction > &&value)
 
FleetAttributesWithStoppedActions (const Aws::Vector< FleetAction > &value)
 
FleetAttributesWithStoppedActions (Aws::Vector< FleetAction > &&value)
 
FleetAttributesAddStoppedActions (const FleetAction &value)
 
FleetAttributesAddStoppedActions (FleetAction &&value)
 
const Aws::StringGetInstanceRoleArn () const
 
bool InstanceRoleArnHasBeenSet () const
 
void SetInstanceRoleArn (const Aws::String &value)
 
void SetInstanceRoleArn (Aws::String &&value)
 
void SetInstanceRoleArn (const char *value)
 
FleetAttributesWithInstanceRoleArn (const Aws::String &value)
 
FleetAttributesWithInstanceRoleArn (Aws::String &&value)
 
FleetAttributesWithInstanceRoleArn (const char *value)
 
const CertificateConfigurationGetCertificateConfiguration () const
 
bool CertificateConfigurationHasBeenSet () const
 
void SetCertificateConfiguration (const CertificateConfiguration &value)
 
void SetCertificateConfiguration (CertificateConfiguration &&value)
 
FleetAttributesWithCertificateConfiguration (const CertificateConfiguration &value)
 
FleetAttributesWithCertificateConfiguration (CertificateConfiguration &&value)
 

Detailed Description

General properties describing a fleet.

See Also:

AWS API Reference

Definition at line 64 of file FleetAttributes.h.

Constructor & Destructor Documentation

◆ FleetAttributes() [1/2]

Aws::GameLift::Model::FleetAttributes::FleetAttributes ( )

◆ FleetAttributes() [2/2]

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

Member Function Documentation

◆ AddLogPaths() [1/3]

FleetAttributes& Aws::GameLift::Model::FleetAttributes::AddLogPaths ( const Aws::String value)
inline

Location of default log files. When a server process is shut down, Amazon GameLift captures and stores any log files in this location. These logs are in addition to game session logs; see more on game session logs in the Amazon GameLift Developer Guide. If no default log path for a fleet is specified, Amazon GameLift automatically uploads logs that are stored on each instance at C: (for Windows) or /local/game/logs (for Linux). Use the Amazon GameLift console to access stored logs.

Definition at line 782 of file FleetAttributes.h.

◆ AddLogPaths() [2/3]

FleetAttributes& Aws::GameLift::Model::FleetAttributes::AddLogPaths ( Aws::String &&  value)
inline

Location of default log files. When a server process is shut down, Amazon GameLift captures and stores any log files in this location. These logs are in addition to game session logs; see more on game session logs in the Amazon GameLift Developer Guide. If no default log path for a fleet is specified, Amazon GameLift automatically uploads logs that are stored on each instance at C: (for Windows) or /local/game/logs (for Linux). Use the Amazon GameLift console to access stored logs.

Definition at line 794 of file FleetAttributes.h.

◆ AddLogPaths() [3/3]

FleetAttributes& Aws::GameLift::Model::FleetAttributes::AddLogPaths ( const char *  value)
inline

Location of default log files. When a server process is shut down, Amazon GameLift captures and stores any log files in this location. These logs are in addition to game session logs; see more on game session logs in the Amazon GameLift Developer Guide. If no default log path for a fleet is specified, Amazon GameLift automatically uploads logs that are stored on each instance at C: (for Windows) or /local/game/logs (for Linux). Use the Amazon GameLift console to access stored logs.

Definition at line 806 of file FleetAttributes.h.

◆ AddMetricGroups() [1/3]

FleetAttributes& Aws::GameLift::Model::FleetAttributes::AddMetricGroups ( const Aws::String value)
inline

Names of metric groups that this fleet is included in. In Amazon CloudWatch, you can view metrics for an individual fleet or aggregated metrics for fleets that are in a fleet metric group. A fleet can be included in only one metric group at a time.

Definition at line 998 of file FleetAttributes.h.

◆ AddMetricGroups() [2/3]

FleetAttributes& Aws::GameLift::Model::FleetAttributes::AddMetricGroups ( Aws::String &&  value)
inline

Names of metric groups that this fleet is included in. In Amazon CloudWatch, you can view metrics for an individual fleet or aggregated metrics for fleets that are in a fleet metric group. A fleet can be included in only one metric group at a time.

Definition at line 1006 of file FleetAttributes.h.

◆ AddMetricGroups() [3/3]

FleetAttributes& Aws::GameLift::Model::FleetAttributes::AddMetricGroups ( const char *  value)
inline

Names of metric groups that this fleet is included in. In Amazon CloudWatch, you can view metrics for an individual fleet or aggregated metrics for fleets that are in a fleet metric group. A fleet can be included in only one metric group at a time.

Definition at line 1014 of file FleetAttributes.h.

◆ AddStoppedActions() [1/2]

FleetAttributes& Aws::GameLift::Model::FleetAttributes::AddStoppedActions ( const FleetAction value)
inline

List of fleet actions that have been suspended using StopFleetActions. This includes auto-scaling.

Definition at line 1057 of file FleetAttributes.h.

◆ AddStoppedActions() [2/2]

FleetAttributes& Aws::GameLift::Model::FleetAttributes::AddStoppedActions ( FleetAction &&  value)
inline

List of fleet actions that have been suspended using StopFleetActions. This includes auto-scaling.

Definition at line 1063 of file FleetAttributes.h.

◆ BuildIdHasBeenSet()

bool Aws::GameLift::Model::FleetAttributes::BuildIdHasBeenSet ( ) const
inline

Unique identifier for a build.

Definition at line 504 of file FleetAttributes.h.

◆ CertificateConfigurationHasBeenSet()

bool Aws::GameLift::Model::FleetAttributes::CertificateConfigurationHasBeenSet ( ) const
inline

Definition at line 1175 of file FleetAttributes.h.

◆ CreationTimeHasBeenSet()

bool Aws::GameLift::Model::FleetAttributes::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 341 of file FleetAttributes.h.

◆ DescriptionHasBeenSet()

bool Aws::GameLift::Model::FleetAttributes::DescriptionHasBeenSet ( ) const
inline

Human-readable description of the fleet.

Definition at line 249 of file FleetAttributes.h.

◆ FleetArnHasBeenSet()

bool Aws::GameLift::Model::FleetAttributes::FleetArnHasBeenSet ( ) const
inline

Identifier for a fleet that is unique across all regions.

Definition at line 122 of file FleetAttributes.h.

◆ FleetIdHasBeenSet()

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

Unique identifier for a fleet.

Definition at line 81 of file FleetAttributes.h.

◆ FleetTypeHasBeenSet()

bool Aws::GameLift::Model::FleetAttributes::FleetTypeHasBeenSet ( ) const
inline

Indicates whether the fleet uses on-demand or spot instances. A spot instance in use may be interrupted with a two-minute notification.

Definition at line 165 of file FleetAttributes.h.

◆ GetBuildId()

const Aws::String& Aws::GameLift::Model::FleetAttributes::GetBuildId ( ) const
inline

Unique identifier for a build.

Definition at line 499 of file FleetAttributes.h.

◆ GetCertificateConfiguration()

const CertificateConfiguration& Aws::GameLift::Model::FleetAttributes::GetCertificateConfiguration ( ) const
inline

Definition at line 1172 of file FleetAttributes.h.

◆ GetCreationTime()

const Aws::Utils::DateTime& Aws::GameLift::Model::FleetAttributes::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 335 of file FleetAttributes.h.

◆ GetDescription()

const Aws::String& Aws::GameLift::Model::FleetAttributes::GetDescription ( ) const
inline

Human-readable description of the fleet.

Definition at line 244 of file FleetAttributes.h.

◆ GetFleetArn()

const Aws::String& Aws::GameLift::Model::FleetAttributes::GetFleetArn ( ) const
inline

Identifier for a fleet that is unique across all regions.

Definition at line 117 of file FleetAttributes.h.

◆ GetFleetId()

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

Unique identifier for a fleet.

Definition at line 76 of file FleetAttributes.h.

◆ GetFleetType()

const FleetType& Aws::GameLift::Model::FleetAttributes::GetFleetType ( ) const
inline

Indicates whether the fleet uses on-demand or spot instances. A spot instance in use may be interrupted with a two-minute notification.

Definition at line 159 of file FleetAttributes.h.

◆ GetInstanceRoleArn()

const Aws::String& Aws::GameLift::Model::FleetAttributes::GetInstanceRoleArn ( ) const
inline

Unique identifier for an AWS IAM role that manages access to your AWS services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, daemons (background processes). Create a role or look up a role's ARN using the IAM dashboard in the AWS Management Console. Learn more about using on-box credentials for your game servers at Access external resources from a game server.

Definition at line 1077 of file FleetAttributes.h.

◆ GetInstanceType()

const EC2InstanceType& Aws::GameLift::Model::FleetAttributes::GetInstanceType ( ) const
inline

EC2 instance type indicating the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. See Amazon EC2 Instance Types for detailed descriptions.

Definition at line 198 of file FleetAttributes.h.

◆ GetLogPaths()

const Aws::Vector<Aws::String>& Aws::GameLift::Model::FleetAttributes::GetLogPaths ( ) const
inline

Location of default log files. When a server process is shut down, Amazon GameLift captures and stores any log files in this location. These logs are in addition to game session logs; see more on game session logs in the Amazon GameLift Developer Guide. If no default log path for a fleet is specified, Amazon GameLift automatically uploads logs that are stored on each instance at C: (for Windows) or /local/game/logs (for Linux). Use the Amazon GameLift console to access stored logs.

Definition at line 710 of file FleetAttributes.h.

◆ GetMetricGroups()

const Aws::Vector<Aws::String>& Aws::GameLift::Model::FleetAttributes::GetMetricGroups ( ) const
inline

Names of metric groups that this fleet is included in. In Amazon CloudWatch, you can view metrics for an individual fleet or aggregated metrics for fleets that are in a fleet metric group. A fleet can be included in only one metric group at a time.

Definition at line 950 of file FleetAttributes.h.

◆ GetName()

const Aws::String& Aws::GameLift::Model::FleetAttributes::GetName ( ) const
inline

Descriptive label that is associated with a fleet. Fleet names do not need to be unique.

Definition at line 286 of file FleetAttributes.h.

◆ GetNewGameSessionProtectionPolicy()

const ProtectionPolicy& Aws::GameLift::Model::FleetAttributes::GetNewGameSessionProtectionPolicy ( ) const
inline

Type of game session protection to set for all new instances started in the fleet.

  • NoProtection – The game session can be terminated during a scale-down event.

  • FullProtection – If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

Definition at line 816 of file FleetAttributes.h.

◆ GetOperatingSystem()

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

Operating system of the fleet's computing resources. A fleet's operating system depends on the OS specified for the build that is deployed on this fleet.

Definition at line 869 of file FleetAttributes.h.

◆ GetResourceCreationLimitPolicy()

const ResourceCreationLimitPolicy& Aws::GameLift::Model::FleetAttributes::GetResourceCreationLimitPolicy ( ) const
inline

Fleet policy to limit the number of game sessions an individual player can create over a span of time.

Definition at line 911 of file FleetAttributes.h.

◆ GetScriptId()

const Aws::String& Aws::GameLift::Model::FleetAttributes::GetScriptId ( ) const
inline

Unique identifier for a Realtime script.

Definition at line 540 of file FleetAttributes.h.

◆ GetServerLaunchParameters()

const Aws::String& Aws::GameLift::Model::FleetAttributes::GetServerLaunchParameters ( ) const
inline

Game server launch parameters specified for fleets created before 2016-08-04 (or AWS SDK v. 0.12.16). Server launch parameters for fleets created after this date are specified in the fleet's RuntimeConfiguration.

Definition at line 648 of file FleetAttributes.h.

◆ GetServerLaunchPath()

const Aws::String& Aws::GameLift::Model::FleetAttributes::GetServerLaunchPath ( ) const
inline

Path to a game server executable in the fleet's build, specified for fleets created before 2016-08-04 (or AWS SDK v. 0.12.16). Server launch paths for fleets created after this date are specified in the fleet's RuntimeConfiguration.

Definition at line 584 of file FleetAttributes.h.

◆ GetStatus()

const FleetStatus& Aws::GameLift::Model::FleetAttributes::GetStatus ( ) const
inline

Current status of the fleet.

Possible fleet statuses include the following:

  • NEW – A new fleet has been defined and desired instances is set to 1.

  • DOWNLOADING/VALIDATING/BUILDING/ACTIVATING – Amazon GameLift is setting up the new fleet, creating new instances with the game build or Realtime script and starting server processes.

  • ACTIVE – Hosts can now accept game sessions.

  • ERROR – An error occurred when downloading, validating, building, or activating the fleet.

  • DELETING – Hosts are responding to a delete fleet request.

  • TERMINATED – The fleet no longer exists.

Definition at line 423 of file FleetAttributes.h.

◆ GetStoppedActions()

const Aws::Vector<FleetAction>& Aws::GameLift::Model::FleetAttributes::GetStoppedActions ( ) const
inline

List of fleet actions that have been suspended using StopFleetActions. This includes auto-scaling.

Definition at line 1021 of file FleetAttributes.h.

◆ GetTerminationTime()

const Aws::Utils::DateTime& Aws::GameLift::Model::FleetAttributes::GetTerminationTime ( ) const
inline

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

Definition at line 373 of file FleetAttributes.h.

◆ InstanceRoleArnHasBeenSet()

bool Aws::GameLift::Model::FleetAttributes::InstanceRoleArnHasBeenSet ( ) const
inline

Unique identifier for an AWS IAM role that manages access to your AWS services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, daemons (background processes). Create a role or look up a role's ARN using the IAM dashboard in the AWS Management Console. Learn more about using on-box credentials for your game servers at Access external resources from a game server.

Definition at line 1090 of file FleetAttributes.h.

◆ InstanceTypeHasBeenSet()

bool Aws::GameLift::Model::FleetAttributes::InstanceTypeHasBeenSet ( ) const
inline

EC2 instance type indicating the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. See Amazon EC2 Instance Types for detailed descriptions.

Definition at line 206 of file FleetAttributes.h.

◆ Jsonize()

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

◆ LogPathsHasBeenSet()

bool Aws::GameLift::Model::FleetAttributes::LogPathsHasBeenSet ( ) const
inline

Location of default log files. When a server process is shut down, Amazon GameLift captures and stores any log files in this location. These logs are in addition to game session logs; see more on game session logs in the Amazon GameLift Developer Guide. If no default log path for a fleet is specified, Amazon GameLift automatically uploads logs that are stored on each instance at C: (for Windows) or /local/game/logs (for Linux). Use the Amazon GameLift console to access stored logs.

Definition at line 722 of file FleetAttributes.h.

◆ MetricGroupsHasBeenSet()

bool Aws::GameLift::Model::FleetAttributes::MetricGroupsHasBeenSet ( ) const
inline

Names of metric groups that this fleet is included in. In Amazon CloudWatch, you can view metrics for an individual fleet or aggregated metrics for fleets that are in a fleet metric group. A fleet can be included in only one metric group at a time.

Definition at line 958 of file FleetAttributes.h.

◆ NameHasBeenSet()

bool Aws::GameLift::Model::FleetAttributes::NameHasBeenSet ( ) const
inline

Descriptive label that is associated with a fleet. Fleet names do not need to be unique.

Definition at line 292 of file FleetAttributes.h.

◆ NewGameSessionProtectionPolicyHasBeenSet()

bool Aws::GameLift::Model::FleetAttributes::NewGameSessionProtectionPolicyHasBeenSet ( ) const
inline

Type of game session protection to set for all new instances started in the fleet.

  • NoProtection – The game session can be terminated during a scale-down event.

  • FullProtection – If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

Definition at line 825 of file FleetAttributes.h.

◆ OperatingSystemHasBeenSet()

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

Operating system of the fleet's computing resources. A fleet's operating system depends on the OS specified for the build that is deployed on this fleet.

Definition at line 876 of file FleetAttributes.h.

◆ operator=()

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

◆ ResourceCreationLimitPolicyHasBeenSet()

bool Aws::GameLift::Model::FleetAttributes::ResourceCreationLimitPolicyHasBeenSet ( ) const
inline

Fleet policy to limit the number of game sessions an individual player can create over a span of time.

Definition at line 917 of file FleetAttributes.h.

◆ ScriptIdHasBeenSet()

bool Aws::GameLift::Model::FleetAttributes::ScriptIdHasBeenSet ( ) const
inline

Unique identifier for a Realtime script.

Definition at line 545 of file FleetAttributes.h.

◆ ServerLaunchParametersHasBeenSet()

bool Aws::GameLift::Model::FleetAttributes::ServerLaunchParametersHasBeenSet ( ) const
inline

Game server launch parameters specified for fleets created before 2016-08-04 (or AWS SDK v. 0.12.16). Server launch parameters for fleets created after this date are specified in the fleet's RuntimeConfiguration.

Definition at line 655 of file FleetAttributes.h.

◆ ServerLaunchPathHasBeenSet()

bool Aws::GameLift::Model::FleetAttributes::ServerLaunchPathHasBeenSet ( ) const
inline

Path to a game server executable in the fleet's build, specified for fleets created before 2016-08-04 (or AWS SDK v. 0.12.16). Server launch paths for fleets created after this date are specified in the fleet's RuntimeConfiguration.

Definition at line 592 of file FleetAttributes.h.

◆ SetBuildId() [1/3]

void Aws::GameLift::Model::FleetAttributes::SetBuildId ( const Aws::String value)
inline

Unique identifier for a build.

Definition at line 509 of file FleetAttributes.h.

◆ SetBuildId() [2/3]

void Aws::GameLift::Model::FleetAttributes::SetBuildId ( Aws::String &&  value)
inline

Unique identifier for a build.

Definition at line 514 of file FleetAttributes.h.

◆ SetBuildId() [3/3]

void Aws::GameLift::Model::FleetAttributes::SetBuildId ( const char *  value)
inline

Unique identifier for a build.

Definition at line 519 of file FleetAttributes.h.

◆ SetCertificateConfiguration() [1/2]

void Aws::GameLift::Model::FleetAttributes::SetCertificateConfiguration ( const CertificateConfiguration value)
inline

Definition at line 1178 of file FleetAttributes.h.

◆ SetCertificateConfiguration() [2/2]

void Aws::GameLift::Model::FleetAttributes::SetCertificateConfiguration ( CertificateConfiguration &&  value)
inline

Definition at line 1181 of file FleetAttributes.h.

◆ SetCreationTime() [1/2]

void Aws::GameLift::Model::FleetAttributes::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 347 of file FleetAttributes.h.

◆ SetCreationTime() [2/2]

void Aws::GameLift::Model::FleetAttributes::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 353 of file FleetAttributes.h.

◆ SetDescription() [1/3]

void Aws::GameLift::Model::FleetAttributes::SetDescription ( const Aws::String value)
inline

Human-readable description of the fleet.

Definition at line 254 of file FleetAttributes.h.

◆ SetDescription() [2/3]

void Aws::GameLift::Model::FleetAttributes::SetDescription ( Aws::String &&  value)
inline

Human-readable description of the fleet.

Definition at line 259 of file FleetAttributes.h.

◆ SetDescription() [3/3]

void Aws::GameLift::Model::FleetAttributes::SetDescription ( const char *  value)
inline

Human-readable description of the fleet.

Definition at line 264 of file FleetAttributes.h.

◆ SetFleetArn() [1/3]

void Aws::GameLift::Model::FleetAttributes::SetFleetArn ( const Aws::String value)
inline

Identifier for a fleet that is unique across all regions.

Definition at line 127 of file FleetAttributes.h.

◆ SetFleetArn() [2/3]

void Aws::GameLift::Model::FleetAttributes::SetFleetArn ( Aws::String &&  value)
inline

Identifier for a fleet that is unique across all regions.

Definition at line 132 of file FleetAttributes.h.

◆ SetFleetArn() [3/3]

void Aws::GameLift::Model::FleetAttributes::SetFleetArn ( const char *  value)
inline

Identifier for a fleet that is unique across all regions.

Definition at line 137 of file FleetAttributes.h.

◆ SetFleetId() [1/3]

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

Unique identifier for a fleet.

Definition at line 86 of file FleetAttributes.h.

◆ SetFleetId() [2/3]

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

Unique identifier for a fleet.

Definition at line 91 of file FleetAttributes.h.

◆ SetFleetId() [3/3]

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

Unique identifier for a fleet.

Definition at line 96 of file FleetAttributes.h.

◆ SetFleetType() [1/2]

void Aws::GameLift::Model::FleetAttributes::SetFleetType ( const FleetType value)
inline

Indicates whether the fleet uses on-demand or spot instances. A spot instance in use may be interrupted with a two-minute notification.

Definition at line 171 of file FleetAttributes.h.

◆ SetFleetType() [2/2]

void Aws::GameLift::Model::FleetAttributes::SetFleetType ( FleetType &&  value)
inline

Indicates whether the fleet uses on-demand or spot instances. A spot instance in use may be interrupted with a two-minute notification.

Definition at line 177 of file FleetAttributes.h.

◆ SetInstanceRoleArn() [1/3]

void Aws::GameLift::Model::FleetAttributes::SetInstanceRoleArn ( const Aws::String value)
inline

Unique identifier for an AWS IAM role that manages access to your AWS services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, daemons (background processes). Create a role or look up a role's ARN using the IAM dashboard in the AWS Management Console. Learn more about using on-box credentials for your game servers at Access external resources from a game server.

Definition at line 1103 of file FleetAttributes.h.

◆ SetInstanceRoleArn() [2/3]

void Aws::GameLift::Model::FleetAttributes::SetInstanceRoleArn ( Aws::String &&  value)
inline

Unique identifier for an AWS IAM role that manages access to your AWS services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, daemons (background processes). Create a role or look up a role's ARN using the IAM dashboard in the AWS Management Console. Learn more about using on-box credentials for your game servers at Access external resources from a game server.

Definition at line 1116 of file FleetAttributes.h.

◆ SetInstanceRoleArn() [3/3]

void Aws::GameLift::Model::FleetAttributes::SetInstanceRoleArn ( const char *  value)
inline

Unique identifier for an AWS IAM role that manages access to your AWS services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, daemons (background processes). Create a role or look up a role's ARN using the IAM dashboard in the AWS Management Console. Learn more about using on-box credentials for your game servers at Access external resources from a game server.

Definition at line 1129 of file FleetAttributes.h.

◆ SetInstanceType() [1/2]

void Aws::GameLift::Model::FleetAttributes::SetInstanceType ( const EC2InstanceType value)
inline

EC2 instance type indicating the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. See Amazon EC2 Instance Types for detailed descriptions.

Definition at line 214 of file FleetAttributes.h.

◆ SetInstanceType() [2/2]

void Aws::GameLift::Model::FleetAttributes::SetInstanceType ( EC2InstanceType &&  value)
inline

EC2 instance type indicating the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. See Amazon EC2 Instance Types for detailed descriptions.

Definition at line 222 of file FleetAttributes.h.

◆ SetLogPaths() [1/2]

void Aws::GameLift::Model::FleetAttributes::SetLogPaths ( const Aws::Vector< Aws::String > &  value)
inline

Location of default log files. When a server process is shut down, Amazon GameLift captures and stores any log files in this location. These logs are in addition to game session logs; see more on game session logs in the Amazon GameLift Developer Guide. If no default log path for a fleet is specified, Amazon GameLift automatically uploads logs that are stored on each instance at C: (for Windows) or /local/game/logs (for Linux). Use the Amazon GameLift console to access stored logs.

Definition at line 734 of file FleetAttributes.h.

◆ SetLogPaths() [2/2]

void Aws::GameLift::Model::FleetAttributes::SetLogPaths ( Aws::Vector< Aws::String > &&  value)
inline

Location of default log files. When a server process is shut down, Amazon GameLift captures and stores any log files in this location. These logs are in addition to game session logs; see more on game session logs in the Amazon GameLift Developer Guide. If no default log path for a fleet is specified, Amazon GameLift automatically uploads logs that are stored on each instance at C: (for Windows) or /local/game/logs (for Linux). Use the Amazon GameLift console to access stored logs.

Definition at line 746 of file FleetAttributes.h.

◆ SetMetricGroups() [1/2]

void Aws::GameLift::Model::FleetAttributes::SetMetricGroups ( const Aws::Vector< Aws::String > &  value)
inline

Names of metric groups that this fleet is included in. In Amazon CloudWatch, you can view metrics for an individual fleet or aggregated metrics for fleets that are in a fleet metric group. A fleet can be included in only one metric group at a time.

Definition at line 966 of file FleetAttributes.h.

◆ SetMetricGroups() [2/2]

void Aws::GameLift::Model::FleetAttributes::SetMetricGroups ( Aws::Vector< Aws::String > &&  value)
inline

Names of metric groups that this fleet is included in. In Amazon CloudWatch, you can view metrics for an individual fleet or aggregated metrics for fleets that are in a fleet metric group. A fleet can be included in only one metric group at a time.

Definition at line 974 of file FleetAttributes.h.

◆ SetName() [1/3]

void Aws::GameLift::Model::FleetAttributes::SetName ( const Aws::String value)
inline

Descriptive label that is associated with a fleet. Fleet names do not need to be unique.

Definition at line 298 of file FleetAttributes.h.

◆ SetName() [2/3]

void Aws::GameLift::Model::FleetAttributes::SetName ( Aws::String &&  value)
inline

Descriptive label that is associated with a fleet. Fleet names do not need to be unique.

Definition at line 304 of file FleetAttributes.h.

◆ SetName() [3/3]

void Aws::GameLift::Model::FleetAttributes::SetName ( const char *  value)
inline

Descriptive label that is associated with a fleet. Fleet names do not need to be unique.

Definition at line 310 of file FleetAttributes.h.

◆ SetNewGameSessionProtectionPolicy() [1/2]

void Aws::GameLift::Model::FleetAttributes::SetNewGameSessionProtectionPolicy ( const ProtectionPolicy value)
inline

Type of game session protection to set for all new instances started in the fleet.

  • NoProtection – The game session can be terminated during a scale-down event.

  • FullProtection – If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

Definition at line 834 of file FleetAttributes.h.

◆ SetNewGameSessionProtectionPolicy() [2/2]

void Aws::GameLift::Model::FleetAttributes::SetNewGameSessionProtectionPolicy ( ProtectionPolicy &&  value)
inline

Type of game session protection to set for all new instances started in the fleet.

  • NoProtection – The game session can be terminated during a scale-down event.

  • FullProtection – If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

Definition at line 843 of file FleetAttributes.h.

◆ SetOperatingSystem() [1/2]

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

Operating system of the fleet's computing resources. A fleet's operating system depends on the OS specified for the build that is deployed on this fleet.

Definition at line 883 of file FleetAttributes.h.

◆ SetOperatingSystem() [2/2]

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

Operating system of the fleet's computing resources. A fleet's operating system depends on the OS specified for the build that is deployed on this fleet.

Definition at line 890 of file FleetAttributes.h.

◆ SetResourceCreationLimitPolicy() [1/2]

void Aws::GameLift::Model::FleetAttributes::SetResourceCreationLimitPolicy ( const ResourceCreationLimitPolicy value)
inline

Fleet policy to limit the number of game sessions an individual player can create over a span of time.

Definition at line 923 of file FleetAttributes.h.

◆ SetResourceCreationLimitPolicy() [2/2]

void Aws::GameLift::Model::FleetAttributes::SetResourceCreationLimitPolicy ( ResourceCreationLimitPolicy &&  value)
inline

Fleet policy to limit the number of game sessions an individual player can create over a span of time.

Definition at line 929 of file FleetAttributes.h.

◆ SetScriptId() [1/3]

void Aws::GameLift::Model::FleetAttributes::SetScriptId ( const Aws::String value)
inline

Unique identifier for a Realtime script.

Definition at line 550 of file FleetAttributes.h.

◆ SetScriptId() [2/3]

void Aws::GameLift::Model::FleetAttributes::SetScriptId ( Aws::String &&  value)
inline

Unique identifier for a Realtime script.

Definition at line 555 of file FleetAttributes.h.

◆ SetScriptId() [3/3]

void Aws::GameLift::Model::FleetAttributes::SetScriptId ( const char *  value)
inline

Unique identifier for a Realtime script.

Definition at line 560 of file FleetAttributes.h.

◆ SetServerLaunchParameters() [1/3]

void Aws::GameLift::Model::FleetAttributes::SetServerLaunchParameters ( const Aws::String value)
inline

Game server launch parameters specified for fleets created before 2016-08-04 (or AWS SDK v. 0.12.16). Server launch parameters for fleets created after this date are specified in the fleet's RuntimeConfiguration.

Definition at line 662 of file FleetAttributes.h.

◆ SetServerLaunchParameters() [2/3]

void Aws::GameLift::Model::FleetAttributes::SetServerLaunchParameters ( Aws::String &&  value)
inline

Game server launch parameters specified for fleets created before 2016-08-04 (or AWS SDK v. 0.12.16). Server launch parameters for fleets created after this date are specified in the fleet's RuntimeConfiguration.

Definition at line 669 of file FleetAttributes.h.

◆ SetServerLaunchParameters() [3/3]

void Aws::GameLift::Model::FleetAttributes::SetServerLaunchParameters ( const char *  value)
inline

Game server launch parameters specified for fleets created before 2016-08-04 (or AWS SDK v. 0.12.16). Server launch parameters for fleets created after this date are specified in the fleet's RuntimeConfiguration.

Definition at line 676 of file FleetAttributes.h.

◆ SetServerLaunchPath() [1/3]

void Aws::GameLift::Model::FleetAttributes::SetServerLaunchPath ( const Aws::String value)
inline

Path to a game server executable in the fleet's build, specified for fleets created before 2016-08-04 (or AWS SDK v. 0.12.16). Server launch paths for fleets created after this date are specified in the fleet's RuntimeConfiguration.

Definition at line 600 of file FleetAttributes.h.

◆ SetServerLaunchPath() [2/3]

void Aws::GameLift::Model::FleetAttributes::SetServerLaunchPath ( Aws::String &&  value)
inline

Path to a game server executable in the fleet's build, specified for fleets created before 2016-08-04 (or AWS SDK v. 0.12.16). Server launch paths for fleets created after this date are specified in the fleet's RuntimeConfiguration.

Definition at line 608 of file FleetAttributes.h.

◆ SetServerLaunchPath() [3/3]

void Aws::GameLift::Model::FleetAttributes::SetServerLaunchPath ( const char *  value)
inline

Path to a game server executable in the fleet's build, specified for fleets created before 2016-08-04 (or AWS SDK v. 0.12.16). Server launch paths for fleets created after this date are specified in the fleet's RuntimeConfiguration.

Definition at line 616 of file FleetAttributes.h.

◆ SetStatus() [1/2]

void Aws::GameLift::Model::FleetAttributes::SetStatus ( const FleetStatus value)
inline

Current status of the fleet.

Possible fleet statuses include the following:

  • NEW – A new fleet has been defined and desired instances is set to 1.

  • DOWNLOADING/VALIDATING/BUILDING/ACTIVATING – Amazon GameLift is setting up the new fleet, creating new instances with the game build or Realtime script and starting server processes.

  • ACTIVE – Hosts can now accept game sessions.

  • ERROR – An error occurred when downloading, validating, building, or activating the fleet.

  • DELETING – Hosts are responding to a delete fleet request.

  • TERMINATED – The fleet no longer exists.

Definition at line 451 of file FleetAttributes.h.

◆ SetStatus() [2/2]

void Aws::GameLift::Model::FleetAttributes::SetStatus ( FleetStatus &&  value)
inline

Current status of the fleet.

Possible fleet statuses include the following:

  • NEW – A new fleet has been defined and desired instances is set to 1.

  • DOWNLOADING/VALIDATING/BUILDING/ACTIVATING – Amazon GameLift is setting up the new fleet, creating new instances with the game build or Realtime script and starting server processes.

  • ACTIVE – Hosts can now accept game sessions.

  • ERROR – An error occurred when downloading, validating, building, or activating the fleet.

  • DELETING – Hosts are responding to a delete fleet request.

  • TERMINATED – The fleet no longer exists.

Definition at line 465 of file FleetAttributes.h.

◆ SetStoppedActions() [1/2]

void Aws::GameLift::Model::FleetAttributes::SetStoppedActions ( const Aws::Vector< FleetAction > &  value)
inline

List of fleet actions that have been suspended using StopFleetActions. This includes auto-scaling.

Definition at line 1033 of file FleetAttributes.h.

◆ SetStoppedActions() [2/2]

void Aws::GameLift::Model::FleetAttributes::SetStoppedActions ( Aws::Vector< FleetAction > &&  value)
inline

List of fleet actions that have been suspended using StopFleetActions. This includes auto-scaling.

Definition at line 1039 of file FleetAttributes.h.

◆ SetTerminationTime() [1/2]

void Aws::GameLift::Model::FleetAttributes::SetTerminationTime ( const Aws::Utils::DateTime value)
inline

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

Definition at line 387 of file FleetAttributes.h.

◆ SetTerminationTime() [2/2]

void Aws::GameLift::Model::FleetAttributes::SetTerminationTime ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 394 of file FleetAttributes.h.

◆ StatusHasBeenSet()

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

Current status of the fleet.

Possible fleet statuses include the following:

  • NEW – A new fleet has been defined and desired instances is set to 1.

  • DOWNLOADING/VALIDATING/BUILDING/ACTIVATING – Amazon GameLift is setting up the new fleet, creating new instances with the game build or Realtime script and starting server processes.

  • ACTIVE – Hosts can now accept game sessions.

  • ERROR – An error occurred when downloading, validating, building, or activating the fleet.

  • DELETING – Hosts are responding to a delete fleet request.

  • TERMINATED – The fleet no longer exists.

Definition at line 437 of file FleetAttributes.h.

◆ StoppedActionsHasBeenSet()

bool Aws::GameLift::Model::FleetAttributes::StoppedActionsHasBeenSet ( ) const
inline

List of fleet actions that have been suspended using StopFleetActions. This includes auto-scaling.

Definition at line 1027 of file FleetAttributes.h.

◆ TerminationTimeHasBeenSet()

bool Aws::GameLift::Model::FleetAttributes::TerminationTimeHasBeenSet ( ) const
inline

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

Definition at line 380 of file FleetAttributes.h.

◆ WithBuildId() [1/3]

FleetAttributes& Aws::GameLift::Model::FleetAttributes::WithBuildId ( const Aws::String value)
inline

Unique identifier for a build.

Definition at line 524 of file FleetAttributes.h.

◆ WithBuildId() [2/3]

FleetAttributes& Aws::GameLift::Model::FleetAttributes::WithBuildId ( Aws::String &&  value)
inline

Unique identifier for a build.

Definition at line 529 of file FleetAttributes.h.

◆ WithBuildId() [3/3]

FleetAttributes& Aws::GameLift::Model::FleetAttributes::WithBuildId ( const char *  value)
inline

Unique identifier for a build.

Definition at line 534 of file FleetAttributes.h.

◆ WithCertificateConfiguration() [1/2]

FleetAttributes& Aws::GameLift::Model::FleetAttributes::WithCertificateConfiguration ( const CertificateConfiguration value)
inline

Definition at line 1184 of file FleetAttributes.h.

◆ WithCertificateConfiguration() [2/2]

FleetAttributes& Aws::GameLift::Model::FleetAttributes::WithCertificateConfiguration ( CertificateConfiguration &&  value)
inline

Definition at line 1187 of file FleetAttributes.h.

◆ WithCreationTime() [1/2]

FleetAttributes& Aws::GameLift::Model::FleetAttributes::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 359 of file FleetAttributes.h.

◆ WithCreationTime() [2/2]

FleetAttributes& Aws::GameLift::Model::FleetAttributes::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 365 of file FleetAttributes.h.

◆ WithDescription() [1/3]

FleetAttributes& Aws::GameLift::Model::FleetAttributes::WithDescription ( const Aws::String value)
inline

Human-readable description of the fleet.

Definition at line 269 of file FleetAttributes.h.

◆ WithDescription() [2/3]

FleetAttributes& Aws::GameLift::Model::FleetAttributes::WithDescription ( Aws::String &&  value)
inline

Human-readable description of the fleet.

Definition at line 274 of file FleetAttributes.h.

◆ WithDescription() [3/3]

FleetAttributes& Aws::GameLift::Model::FleetAttributes::WithDescription ( const char *  value)
inline

Human-readable description of the fleet.

Definition at line 279 of file FleetAttributes.h.

◆ WithFleetArn() [1/3]

FleetAttributes& Aws::GameLift::Model::FleetAttributes::WithFleetArn ( const Aws::String value)
inline

Identifier for a fleet that is unique across all regions.

Definition at line 142 of file FleetAttributes.h.

◆ WithFleetArn() [2/3]

FleetAttributes& Aws::GameLift::Model::FleetAttributes::WithFleetArn ( Aws::String &&  value)
inline

Identifier for a fleet that is unique across all regions.

Definition at line 147 of file FleetAttributes.h.

◆ WithFleetArn() [3/3]

FleetAttributes& Aws::GameLift::Model::FleetAttributes::WithFleetArn ( const char *  value)
inline

Identifier for a fleet that is unique across all regions.

Definition at line 152 of file FleetAttributes.h.

◆ WithFleetId() [1/3]

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

Unique identifier for a fleet.

Definition at line 101 of file FleetAttributes.h.

◆ WithFleetId() [2/3]

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

Unique identifier for a fleet.

Definition at line 106 of file FleetAttributes.h.

◆ WithFleetId() [3/3]

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

Unique identifier for a fleet.

Definition at line 111 of file FleetAttributes.h.

◆ WithFleetType() [1/2]

FleetAttributes& Aws::GameLift::Model::FleetAttributes::WithFleetType ( const FleetType value)
inline

Indicates whether the fleet uses on-demand or spot instances. A spot instance in use may be interrupted with a two-minute notification.

Definition at line 183 of file FleetAttributes.h.

◆ WithFleetType() [2/2]

FleetAttributes& Aws::GameLift::Model::FleetAttributes::WithFleetType ( FleetType &&  value)
inline

Indicates whether the fleet uses on-demand or spot instances. A spot instance in use may be interrupted with a two-minute notification.

Definition at line 189 of file FleetAttributes.h.

◆ WithInstanceRoleArn() [1/3]

FleetAttributes& Aws::GameLift::Model::FleetAttributes::WithInstanceRoleArn ( const Aws::String value)
inline

Unique identifier for an AWS IAM role that manages access to your AWS services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, daemons (background processes). Create a role or look up a role's ARN using the IAM dashboard in the AWS Management Console. Learn more about using on-box credentials for your game servers at Access external resources from a game server.

Definition at line 1142 of file FleetAttributes.h.

◆ WithInstanceRoleArn() [2/3]

FleetAttributes& Aws::GameLift::Model::FleetAttributes::WithInstanceRoleArn ( Aws::String &&  value)
inline

Unique identifier for an AWS IAM role that manages access to your AWS services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, daemons (background processes). Create a role or look up a role's ARN using the IAM dashboard in the AWS Management Console. Learn more about using on-box credentials for your game servers at Access external resources from a game server.

Definition at line 1155 of file FleetAttributes.h.

◆ WithInstanceRoleArn() [3/3]

FleetAttributes& Aws::GameLift::Model::FleetAttributes::WithInstanceRoleArn ( const char *  value)
inline

Unique identifier for an AWS IAM role that manages access to your AWS services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, daemons (background processes). Create a role or look up a role's ARN using the IAM dashboard in the AWS Management Console. Learn more about using on-box credentials for your game servers at Access external resources from a game server.

Definition at line 1168 of file FleetAttributes.h.

◆ WithInstanceType() [1/2]

FleetAttributes& Aws::GameLift::Model::FleetAttributes::WithInstanceType ( const EC2InstanceType value)
inline

EC2 instance type indicating the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. See Amazon EC2 Instance Types for detailed descriptions.

Definition at line 230 of file FleetAttributes.h.

◆ WithInstanceType() [2/2]

FleetAttributes& Aws::GameLift::Model::FleetAttributes::WithInstanceType ( EC2InstanceType &&  value)
inline

EC2 instance type indicating the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. See Amazon EC2 Instance Types for detailed descriptions.

Definition at line 238 of file FleetAttributes.h.

◆ WithLogPaths() [1/2]

FleetAttributes& Aws::GameLift::Model::FleetAttributes::WithLogPaths ( const Aws::Vector< Aws::String > &  value)
inline

Location of default log files. When a server process is shut down, Amazon GameLift captures and stores any log files in this location. These logs are in addition to game session logs; see more on game session logs in the Amazon GameLift Developer Guide. If no default log path for a fleet is specified, Amazon GameLift automatically uploads logs that are stored on each instance at C: (for Windows) or /local/game/logs (for Linux). Use the Amazon GameLift console to access stored logs.

Definition at line 758 of file FleetAttributes.h.

◆ WithLogPaths() [2/2]

FleetAttributes& Aws::GameLift::Model::FleetAttributes::WithLogPaths ( Aws::Vector< Aws::String > &&  value)
inline

Location of default log files. When a server process is shut down, Amazon GameLift captures and stores any log files in this location. These logs are in addition to game session logs; see more on game session logs in the Amazon GameLift Developer Guide. If no default log path for a fleet is specified, Amazon GameLift automatically uploads logs that are stored on each instance at C: (for Windows) or /local/game/logs (for Linux). Use the Amazon GameLift console to access stored logs.

Definition at line 770 of file FleetAttributes.h.

◆ WithMetricGroups() [1/2]

FleetAttributes& Aws::GameLift::Model::FleetAttributes::WithMetricGroups ( const Aws::Vector< Aws::String > &  value)
inline

Names of metric groups that this fleet is included in. In Amazon CloudWatch, you can view metrics for an individual fleet or aggregated metrics for fleets that are in a fleet metric group. A fleet can be included in only one metric group at a time.

Definition at line 982 of file FleetAttributes.h.

◆ WithMetricGroups() [2/2]

FleetAttributes& Aws::GameLift::Model::FleetAttributes::WithMetricGroups ( Aws::Vector< Aws::String > &&  value)
inline

Names of metric groups that this fleet is included in. In Amazon CloudWatch, you can view metrics for an individual fleet or aggregated metrics for fleets that are in a fleet metric group. A fleet can be included in only one metric group at a time.

Definition at line 990 of file FleetAttributes.h.

◆ WithName() [1/3]

FleetAttributes& Aws::GameLift::Model::FleetAttributes::WithName ( const Aws::String value)
inline

Descriptive label that is associated with a fleet. Fleet names do not need to be unique.

Definition at line 316 of file FleetAttributes.h.

◆ WithName() [2/3]

FleetAttributes& Aws::GameLift::Model::FleetAttributes::WithName ( Aws::String &&  value)
inline

Descriptive label that is associated with a fleet. Fleet names do not need to be unique.

Definition at line 322 of file FleetAttributes.h.

◆ WithName() [3/3]

FleetAttributes& Aws::GameLift::Model::FleetAttributes::WithName ( const char *  value)
inline

Descriptive label that is associated with a fleet. Fleet names do not need to be unique.

Definition at line 328 of file FleetAttributes.h.

◆ WithNewGameSessionProtectionPolicy() [1/2]

FleetAttributes& Aws::GameLift::Model::FleetAttributes::WithNewGameSessionProtectionPolicy ( const ProtectionPolicy value)
inline

Type of game session protection to set for all new instances started in the fleet.

  • NoProtection – The game session can be terminated during a scale-down event.

  • FullProtection – If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

Definition at line 852 of file FleetAttributes.h.

◆ WithNewGameSessionProtectionPolicy() [2/2]

FleetAttributes& Aws::GameLift::Model::FleetAttributes::WithNewGameSessionProtectionPolicy ( ProtectionPolicy &&  value)
inline

Type of game session protection to set for all new instances started in the fleet.

  • NoProtection – The game session can be terminated during a scale-down event.

  • FullProtection – If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

Definition at line 861 of file FleetAttributes.h.

◆ WithOperatingSystem() [1/2]

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

Operating system of the fleet's computing resources. A fleet's operating system depends on the OS specified for the build that is deployed on this fleet.

Definition at line 897 of file FleetAttributes.h.

◆ WithOperatingSystem() [2/2]

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

Operating system of the fleet's computing resources. A fleet's operating system depends on the OS specified for the build that is deployed on this fleet.

Definition at line 904 of file FleetAttributes.h.

◆ WithResourceCreationLimitPolicy() [1/2]

FleetAttributes& Aws::GameLift::Model::FleetAttributes::WithResourceCreationLimitPolicy ( const ResourceCreationLimitPolicy value)
inline

Fleet policy to limit the number of game sessions an individual player can create over a span of time.

Definition at line 935 of file FleetAttributes.h.

◆ WithResourceCreationLimitPolicy() [2/2]

FleetAttributes& Aws::GameLift::Model::FleetAttributes::WithResourceCreationLimitPolicy ( ResourceCreationLimitPolicy &&  value)
inline

Fleet policy to limit the number of game sessions an individual player can create over a span of time.

Definition at line 941 of file FleetAttributes.h.

◆ WithScriptId() [1/3]

FleetAttributes& Aws::GameLift::Model::FleetAttributes::WithScriptId ( const Aws::String value)
inline

Unique identifier for a Realtime script.

Definition at line 565 of file FleetAttributes.h.

◆ WithScriptId() [2/3]

FleetAttributes& Aws::GameLift::Model::FleetAttributes::WithScriptId ( Aws::String &&  value)
inline

Unique identifier for a Realtime script.

Definition at line 570 of file FleetAttributes.h.

◆ WithScriptId() [3/3]

FleetAttributes& Aws::GameLift::Model::FleetAttributes::WithScriptId ( const char *  value)
inline

Unique identifier for a Realtime script.

Definition at line 575 of file FleetAttributes.h.

◆ WithServerLaunchParameters() [1/3]

FleetAttributes& Aws::GameLift::Model::FleetAttributes::WithServerLaunchParameters ( const Aws::String value)
inline

Game server launch parameters specified for fleets created before 2016-08-04 (or AWS SDK v. 0.12.16). Server launch parameters for fleets created after this date are specified in the fleet's RuntimeConfiguration.

Definition at line 683 of file FleetAttributes.h.

◆ WithServerLaunchParameters() [2/3]

FleetAttributes& Aws::GameLift::Model::FleetAttributes::WithServerLaunchParameters ( Aws::String &&  value)
inline

Game server launch parameters specified for fleets created before 2016-08-04 (or AWS SDK v. 0.12.16). Server launch parameters for fleets created after this date are specified in the fleet's RuntimeConfiguration.

Definition at line 690 of file FleetAttributes.h.

◆ WithServerLaunchParameters() [3/3]

FleetAttributes& Aws::GameLift::Model::FleetAttributes::WithServerLaunchParameters ( const char *  value)
inline

Game server launch parameters specified for fleets created before 2016-08-04 (or AWS SDK v. 0.12.16). Server launch parameters for fleets created after this date are specified in the fleet's RuntimeConfiguration.

Definition at line 697 of file FleetAttributes.h.

◆ WithServerLaunchPath() [1/3]

FleetAttributes& Aws::GameLift::Model::FleetAttributes::WithServerLaunchPath ( const Aws::String value)
inline

Path to a game server executable in the fleet's build, specified for fleets created before 2016-08-04 (or AWS SDK v. 0.12.16). Server launch paths for fleets created after this date are specified in the fleet's RuntimeConfiguration.

Definition at line 624 of file FleetAttributes.h.

◆ WithServerLaunchPath() [2/3]

FleetAttributes& Aws::GameLift::Model::FleetAttributes::WithServerLaunchPath ( Aws::String &&  value)
inline

Path to a game server executable in the fleet's build, specified for fleets created before 2016-08-04 (or AWS SDK v. 0.12.16). Server launch paths for fleets created after this date are specified in the fleet's RuntimeConfiguration.

Definition at line 632 of file FleetAttributes.h.

◆ WithServerLaunchPath() [3/3]

FleetAttributes& Aws::GameLift::Model::FleetAttributes::WithServerLaunchPath ( const char *  value)
inline

Path to a game server executable in the fleet's build, specified for fleets created before 2016-08-04 (or AWS SDK v. 0.12.16). Server launch paths for fleets created after this date are specified in the fleet's RuntimeConfiguration.

Definition at line 640 of file FleetAttributes.h.

◆ WithStatus() [1/2]

FleetAttributes& Aws::GameLift::Model::FleetAttributes::WithStatus ( const FleetStatus value)
inline

Current status of the fleet.

Possible fleet statuses include the following:

  • NEW – A new fleet has been defined and desired instances is set to 1.

  • DOWNLOADING/VALIDATING/BUILDING/ACTIVATING – Amazon GameLift is setting up the new fleet, creating new instances with the game build or Realtime script and starting server processes.

  • ACTIVE – Hosts can now accept game sessions.

  • ERROR – An error occurred when downloading, validating, building, or activating the fleet.

  • DELETING – Hosts are responding to a delete fleet request.

  • TERMINATED – The fleet no longer exists.

Definition at line 479 of file FleetAttributes.h.

◆ WithStatus() [2/2]

FleetAttributes& Aws::GameLift::Model::FleetAttributes::WithStatus ( FleetStatus &&  value)
inline

Current status of the fleet.

Possible fleet statuses include the following:

  • NEW – A new fleet has been defined and desired instances is set to 1.

  • DOWNLOADING/VALIDATING/BUILDING/ACTIVATING – Amazon GameLift is setting up the new fleet, creating new instances with the game build or Realtime script and starting server processes.

  • ACTIVE – Hosts can now accept game sessions.

  • ERROR – An error occurred when downloading, validating, building, or activating the fleet.

  • DELETING – Hosts are responding to a delete fleet request.

  • TERMINATED – The fleet no longer exists.

Definition at line 493 of file FleetAttributes.h.

◆ WithStoppedActions() [1/2]

FleetAttributes& Aws::GameLift::Model::FleetAttributes::WithStoppedActions ( const Aws::Vector< FleetAction > &  value)
inline

List of fleet actions that have been suspended using StopFleetActions. This includes auto-scaling.

Definition at line 1045 of file FleetAttributes.h.

◆ WithStoppedActions() [2/2]

FleetAttributes& Aws::GameLift::Model::FleetAttributes::WithStoppedActions ( Aws::Vector< FleetAction > &&  value)
inline

List of fleet actions that have been suspended using StopFleetActions. This includes auto-scaling.

Definition at line 1051 of file FleetAttributes.h.

◆ WithTerminationTime() [1/2]

FleetAttributes& Aws::GameLift::Model::FleetAttributes::WithTerminationTime ( const Aws::Utils::DateTime value)
inline

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

Definition at line 401 of file FleetAttributes.h.

◆ WithTerminationTime() [2/2]

FleetAttributes& Aws::GameLift::Model::FleetAttributes::WithTerminationTime ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 408 of file FleetAttributes.h.


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