AWS SDK for C++  1.8.129
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)
 
FleetAttributes & operator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::String & GetFleetId () const
 
bool FleetIdHasBeenSet () const
 
void SetFleetId (const Aws::String &value)
 
void SetFleetId (Aws::String &&value)
 
void SetFleetId (const char *value)
 
FleetAttributes & WithFleetId (const Aws::String &value)
 
FleetAttributes & WithFleetId (Aws::String &&value)
 
FleetAttributes & WithFleetId (const char *value)
 
const Aws::String & GetFleetArn () const
 
bool FleetArnHasBeenSet () const
 
void SetFleetArn (const Aws::String &value)
 
void SetFleetArn (Aws::String &&value)
 
void SetFleetArn (const char *value)
 
FleetAttributes & WithFleetArn (const Aws::String &value)
 
FleetAttributes & WithFleetArn (Aws::String &&value)
 
FleetAttributes & WithFleetArn (const char *value)
 
const FleetType & GetFleetType () const
 
bool FleetTypeHasBeenSet () const
 
void SetFleetType (const FleetType &value)
 
void SetFleetType (FleetType &&value)
 
FleetAttributes & WithFleetType (const FleetType &value)
 
FleetAttributes & WithFleetType (FleetType &&value)
 
const EC2InstanceType & GetInstanceType () const
 
bool InstanceTypeHasBeenSet () const
 
void SetInstanceType (const EC2InstanceType &value)
 
void SetInstanceType (EC2InstanceType &&value)
 
FleetAttributes & WithInstanceType (const EC2InstanceType &value)
 
FleetAttributes & WithInstanceType (EC2InstanceType &&value)
 
const Aws::String & GetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
FleetAttributes & WithDescription (const Aws::String &value)
 
FleetAttributes & WithDescription (Aws::String &&value)
 
FleetAttributes & WithDescription (const char *value)
 
const Aws::String & GetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
FleetAttributes & WithName (const Aws::String &value)
 
FleetAttributes & WithName (Aws::String &&value)
 
FleetAttributes & WithName (const char *value)
 
const Aws::Utils::DateTime & GetCreationTime () const
 
bool CreationTimeHasBeenSet () const
 
void SetCreationTime (const Aws::Utils::DateTime &value)
 
void SetCreationTime (Aws::Utils::DateTime &&value)
 
FleetAttributes & WithCreationTime (const Aws::Utils::DateTime &value)
 
FleetAttributes & WithCreationTime (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTime & GetTerminationTime () const
 
bool TerminationTimeHasBeenSet () const
 
void SetTerminationTime (const Aws::Utils::DateTime &value)
 
void SetTerminationTime (Aws::Utils::DateTime &&value)
 
FleetAttributes & WithTerminationTime (const Aws::Utils::DateTime &value)
 
FleetAttributes & WithTerminationTime (Aws::Utils::DateTime &&value)
 
const FleetStatus & GetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const FleetStatus &value)
 
void SetStatus (FleetStatus &&value)
 
FleetAttributes & WithStatus (const FleetStatus &value)
 
FleetAttributes & WithStatus (FleetStatus &&value)
 
const Aws::String & GetBuildId () const
 
bool BuildIdHasBeenSet () const
 
void SetBuildId (const Aws::String &value)
 
void SetBuildId (Aws::String &&value)
 
void SetBuildId (const char *value)
 
FleetAttributes & WithBuildId (const Aws::String &value)
 
FleetAttributes & WithBuildId (Aws::String &&value)
 
FleetAttributes & WithBuildId (const char *value)
 
const Aws::String & GetBuildArn () const
 
bool BuildArnHasBeenSet () const
 
void SetBuildArn (const Aws::String &value)
 
void SetBuildArn (Aws::String &&value)
 
void SetBuildArn (const char *value)
 
FleetAttributes & WithBuildArn (const Aws::String &value)
 
FleetAttributes & WithBuildArn (Aws::String &&value)
 
FleetAttributes & WithBuildArn (const char *value)
 
const Aws::String & GetScriptId () const
 
bool ScriptIdHasBeenSet () const
 
void SetScriptId (const Aws::String &value)
 
void SetScriptId (Aws::String &&value)
 
void SetScriptId (const char *value)
 
FleetAttributes & WithScriptId (const Aws::String &value)
 
FleetAttributes & WithScriptId (Aws::String &&value)
 
FleetAttributes & WithScriptId (const char *value)
 
const Aws::String & GetScriptArn () const
 
bool ScriptArnHasBeenSet () const
 
void SetScriptArn (const Aws::String &value)
 
void SetScriptArn (Aws::String &&value)
 
void SetScriptArn (const char *value)
 
FleetAttributes & WithScriptArn (const Aws::String &value)
 
FleetAttributes & WithScriptArn (Aws::String &&value)
 
FleetAttributes & WithScriptArn (const char *value)
 
const Aws::String & GetServerLaunchPath () const
 
bool ServerLaunchPathHasBeenSet () const
 
void SetServerLaunchPath (const Aws::String &value)
 
void SetServerLaunchPath (Aws::String &&value)
 
void SetServerLaunchPath (const char *value)
 
FleetAttributes & WithServerLaunchPath (const Aws::String &value)
 
FleetAttributes & WithServerLaunchPath (Aws::String &&value)
 
FleetAttributes & WithServerLaunchPath (const char *value)
 
const Aws::String & GetServerLaunchParameters () const
 
bool ServerLaunchParametersHasBeenSet () const
 
void SetServerLaunchParameters (const Aws::String &value)
 
void SetServerLaunchParameters (Aws::String &&value)
 
void SetServerLaunchParameters (const char *value)
 
FleetAttributes & WithServerLaunchParameters (const Aws::String &value)
 
FleetAttributes & WithServerLaunchParameters (Aws::String &&value)
 
FleetAttributes & WithServerLaunchParameters (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)
 
FleetAttributes & WithLogPaths (const Aws::Vector< Aws::String > &value)
 
FleetAttributes & WithLogPaths (Aws::Vector< Aws::String > &&value)
 
FleetAttributes & AddLogPaths (const Aws::String &value)
 
FleetAttributes & AddLogPaths (Aws::String &&value)
 
FleetAttributes & AddLogPaths (const char *value)
 
const ProtectionPolicy & GetNewGameSessionProtectionPolicy () const
 
bool NewGameSessionProtectionPolicyHasBeenSet () const
 
void SetNewGameSessionProtectionPolicy (const ProtectionPolicy &value)
 
void SetNewGameSessionProtectionPolicy (ProtectionPolicy &&value)
 
FleetAttributes & WithNewGameSessionProtectionPolicy (const ProtectionPolicy &value)
 
FleetAttributes & WithNewGameSessionProtectionPolicy (ProtectionPolicy &&value)
 
const OperatingSystem & GetOperatingSystem () const
 
bool OperatingSystemHasBeenSet () const
 
void SetOperatingSystem (const OperatingSystem &value)
 
void SetOperatingSystem (OperatingSystem &&value)
 
FleetAttributes & WithOperatingSystem (const OperatingSystem &value)
 
FleetAttributes & WithOperatingSystem (OperatingSystem &&value)
 
const ResourceCreationLimitPolicy & GetResourceCreationLimitPolicy () const
 
bool ResourceCreationLimitPolicyHasBeenSet () const
 
void SetResourceCreationLimitPolicy (const ResourceCreationLimitPolicy &value)
 
void SetResourceCreationLimitPolicy (ResourceCreationLimitPolicy &&value)
 
FleetAttributes & WithResourceCreationLimitPolicy (const ResourceCreationLimitPolicy &value)
 
FleetAttributes & WithResourceCreationLimitPolicy (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)
 
FleetAttributes & WithMetricGroups (const Aws::Vector< Aws::String > &value)
 
FleetAttributes & WithMetricGroups (Aws::Vector< Aws::String > &&value)
 
FleetAttributes & AddMetricGroups (const Aws::String &value)
 
FleetAttributes & AddMetricGroups (Aws::String &&value)
 
FleetAttributes & AddMetricGroups (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)
 
FleetAttributes & WithStoppedActions (const Aws::Vector< FleetAction > &value)
 
FleetAttributes & WithStoppedActions (Aws::Vector< FleetAction > &&value)
 
FleetAttributes & AddStoppedActions (const FleetAction &value)
 
FleetAttributes & AddStoppedActions (FleetAction &&value)
 
const Aws::String & GetInstanceRoleArn () const
 
bool InstanceRoleArnHasBeenSet () const
 
void SetInstanceRoleArn (const Aws::String &value)
 
void SetInstanceRoleArn (Aws::String &&value)
 
void SetInstanceRoleArn (const char *value)
 
FleetAttributes & WithInstanceRoleArn (const Aws::String &value)
 
FleetAttributes & WithInstanceRoleArn (Aws::String &&value)
 
FleetAttributes & WithInstanceRoleArn (const char *value)
 
const CertificateConfiguration & GetCertificateConfiguration () const
 
bool CertificateConfigurationHasBeenSet () const
 
void SetCertificateConfiguration (const CertificateConfiguration &value)
 
void SetCertificateConfiguration (CertificateConfiguration &&value)
 
FleetAttributes & WithCertificateConfiguration (const CertificateConfiguration &value)
 
FleetAttributes & WithCertificateConfiguration (CertificateConfiguration &&value)
 

Detailed Description

General properties describing a fleet.

See Also:

AWS API Reference

Definition at line 45 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 ( 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:\game\logs (for Windows) or /local/game/logs (for Linux). Use the Amazon GameLift console to access stored logs.

Definition at line 953 of file FleetAttributes.h.

◆ AddLogPaths() [2/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:\game\logs (for Windows) or /local/game/logs (for Linux). Use the Amazon GameLift console to access stored logs.

Definition at line 941 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:\game\logs (for Windows) or /local/game/logs (for Linux). Use the Amazon GameLift console to access stored logs.

Definition at line 965 of file FleetAttributes.h.

◆ AddMetricGroups() [1/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 1165 of file FleetAttributes.h.

◆ AddMetricGroups() [2/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 1157 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 1173 of file FleetAttributes.h.

◆ AddStoppedActions() [1/2]

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

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

Definition at line 1216 of file FleetAttributes.h.

◆ AddStoppedActions() [2/2]

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

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

Definition at line 1222 of file FleetAttributes.h.

◆ BuildArnHasBeenSet()

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

The Amazon Resource Name (ARN) associated with the GameLift build resource that is deployed on instances in this fleet. In a GameLift build ARN, the resource ID matches the BuildId value.

Definition at line 566 of file FleetAttributes.h.

◆ BuildIdHasBeenSet()

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

A unique identifier for a build.

Definition at line 517 of file FleetAttributes.h.

◆ CertificateConfigurationHasBeenSet()

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

Indicates whether a TLS/SSL certificate was generated for the fleet.

Definition at line 1282 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 354 of file FleetAttributes.h.

◆ DescriptionHasBeenSet()

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

Human-readable description of the fleet.

Definition at line 262 of file FleetAttributes.h.

◆ FleetArnHasBeenSet()

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

The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift fleet ARN, the resource ID matches the FleetId value.

Definition at line 111 of file FleetAttributes.h.

◆ FleetIdHasBeenSet()

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

A unique identifier for a fleet.

Definition at line 62 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 178 of file FleetAttributes.h.

◆ GetBuildArn()

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

The Amazon Resource Name (ARN) associated with the GameLift build resource that is deployed on instances in this fleet. In a GameLift build ARN, the resource ID matches the BuildId value.

Definition at line 557 of file FleetAttributes.h.

◆ GetBuildId()

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

A unique identifier for a build.

Definition at line 512 of file FleetAttributes.h.

◆ GetCertificateConfiguration()

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

Indicates whether a TLS/SSL certificate was generated for the fleet.

Definition at line 1277 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 348 of file FleetAttributes.h.

◆ GetDescription()

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

Human-readable description of the fleet.

Definition at line 257 of file FleetAttributes.h.

◆ GetFleetArn()

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

The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift fleet ARN, the resource ID matches the FleetId value.

Definition at line 102 of file FleetAttributes.h.

◆ GetFleetId()

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

A unique identifier for a fleet.

Definition at line 57 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 172 of file FleetAttributes.h.

◆ GetInstanceRoleArn()

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

A unique identifier for an AWS IAM role that manages access to your AWS services.

Definition at line 1229 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 211 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:\game\logs (for Windows) or /local/game/logs (for Linux). Use the Amazon GameLift console to access stored logs.

Definition at line 869 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 1109 of file FleetAttributes.h.

◆ GetName()

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

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

Definition at line 299 of file FleetAttributes.h.

◆ GetNewGameSessionProtectionPolicy()

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

The 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 975 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 1028 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 1070 of file FleetAttributes.h.

◆ GetScriptArn()

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

The Amazon Resource Name (ARN) associated with the GameLift script resource that is deployed on instances in this fleet. In a GameLift script ARN, the resource ID matches the ScriptId value.

Definition at line 671 of file FleetAttributes.h.

◆ GetScriptId()

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

A unique identifier for a Realtime script.

Definition at line 626 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 807 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 743 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 436 of file FleetAttributes.h.

◆ GetStoppedActions()

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

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

Definition at line 1180 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 386 of file FleetAttributes.h.

◆ InstanceRoleArnHasBeenSet()

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

A unique identifier for an AWS IAM role that manages access to your AWS services.

Definition at line 1235 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 219 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:\game\logs (for Windows) or /local/game/logs (for Linux). Use the Amazon GameLift console to access stored logs.

Definition at line 881 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 1117 of file FleetAttributes.h.

◆ NameHasBeenSet()

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

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

Definition at line 305 of file FleetAttributes.h.

◆ NewGameSessionProtectionPolicyHasBeenSet()

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

The 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 984 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 1035 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 1076 of file FleetAttributes.h.

◆ ScriptArnHasBeenSet()

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

The Amazon Resource Name (ARN) associated with the GameLift script resource that is deployed on instances in this fleet. In a GameLift script ARN, the resource ID matches the ScriptId value.

Definition at line 680 of file FleetAttributes.h.

◆ ScriptIdHasBeenSet()

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

A unique identifier for a Realtime script.

Definition at line 631 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 814 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 751 of file FleetAttributes.h.

◆ SetBuildArn() [1/3]

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

The Amazon Resource Name (ARN) associated with the GameLift build resource that is deployed on instances in this fleet. In a GameLift build ARN, the resource ID matches the BuildId value.

Definition at line 584 of file FleetAttributes.h.

◆ SetBuildArn() [2/3]

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

The Amazon Resource Name (ARN) associated with the GameLift build resource that is deployed on instances in this fleet. In a GameLift build ARN, the resource ID matches the BuildId value.

Definition at line 575 of file FleetAttributes.h.

◆ SetBuildArn() [3/3]

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

The Amazon Resource Name (ARN) associated with the GameLift build resource that is deployed on instances in this fleet. In a GameLift build ARN, the resource ID matches the BuildId value.

Definition at line 593 of file FleetAttributes.h.

◆ SetBuildId() [1/3]

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

A unique identifier for a build.

Definition at line 527 of file FleetAttributes.h.

◆ SetBuildId() [2/3]

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

A unique identifier for a build.

Definition at line 522 of file FleetAttributes.h.

◆ SetBuildId() [3/3]

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

A unique identifier for a build.

Definition at line 532 of file FleetAttributes.h.

◆ SetCertificateConfiguration() [1/2]

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

Indicates whether a TLS/SSL certificate was generated for the fleet.

Definition at line 1292 of file FleetAttributes.h.

◆ SetCertificateConfiguration() [2/2]

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

Indicates whether a TLS/SSL certificate was generated for the fleet.

Definition at line 1287 of file FleetAttributes.h.

◆ SetCreationTime() [1/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 366 of file FleetAttributes.h.

◆ SetCreationTime() [2/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 360 of file FleetAttributes.h.

◆ SetDescription() [1/3]

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

Human-readable description of the fleet.

Definition at line 272 of file FleetAttributes.h.

◆ SetDescription() [2/3]

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

Human-readable description of the fleet.

Definition at line 267 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 277 of file FleetAttributes.h.

◆ SetFleetArn() [1/3]

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

The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift fleet ARN, the resource ID matches the FleetId value.

Definition at line 129 of file FleetAttributes.h.

◆ SetFleetArn() [2/3]

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

The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift fleet ARN, the resource ID matches the FleetId value.

Definition at line 120 of file FleetAttributes.h.

◆ SetFleetArn() [3/3]

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

The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift fleet ARN, the resource ID matches the FleetId value.

Definition at line 138 of file FleetAttributes.h.

◆ SetFleetId() [1/3]

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

A unique identifier for a fleet.

Definition at line 72 of file FleetAttributes.h.

◆ SetFleetId() [2/3]

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

A unique identifier for a fleet.

Definition at line 67 of file FleetAttributes.h.

◆ SetFleetId() [3/3]

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

A unique identifier for a fleet.

Definition at line 77 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 184 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 190 of file FleetAttributes.h.

◆ SetInstanceRoleArn() [1/3]

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

A unique identifier for an AWS IAM role that manages access to your AWS services.

Definition at line 1247 of file FleetAttributes.h.

◆ SetInstanceRoleArn() [2/3]

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

A unique identifier for an AWS IAM role that manages access to your AWS services.

Definition at line 1241 of file FleetAttributes.h.

◆ SetInstanceRoleArn() [3/3]

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

A unique identifier for an AWS IAM role that manages access to your AWS services.

Definition at line 1253 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 227 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 235 of file FleetAttributes.h.

◆ SetLogPaths() [1/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:\game\logs (for Windows) or /local/game/logs (for Linux). Use the Amazon GameLift console to access stored logs.

Definition at line 905 of file FleetAttributes.h.

◆ SetLogPaths() [2/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:\game\logs (for Windows) or /local/game/logs (for Linux). Use the Amazon GameLift console to access stored logs.

Definition at line 893 of file FleetAttributes.h.

◆ SetMetricGroups() [1/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 1133 of file FleetAttributes.h.

◆ SetMetricGroups() [2/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 1125 of file FleetAttributes.h.

◆ SetName() [1/3]

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

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

Definition at line 317 of file FleetAttributes.h.

◆ SetName() [2/3]

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

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

Definition at line 311 of file FleetAttributes.h.

◆ SetName() [3/3]

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

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

Definition at line 323 of file FleetAttributes.h.

◆ SetNewGameSessionProtectionPolicy() [1/2]

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

The 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 993 of file FleetAttributes.h.

◆ SetNewGameSessionProtectionPolicy() [2/2]

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

The 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 1002 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 1042 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 1049 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 1082 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 1088 of file FleetAttributes.h.

◆ SetScriptArn() [1/3]

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

The Amazon Resource Name (ARN) associated with the GameLift script resource that is deployed on instances in this fleet. In a GameLift script ARN, the resource ID matches the ScriptId value.

Definition at line 698 of file FleetAttributes.h.

◆ SetScriptArn() [2/3]

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

The Amazon Resource Name (ARN) associated with the GameLift script resource that is deployed on instances in this fleet. In a GameLift script ARN, the resource ID matches the ScriptId value.

Definition at line 689 of file FleetAttributes.h.

◆ SetScriptArn() [3/3]

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

The Amazon Resource Name (ARN) associated with the GameLift script resource that is deployed on instances in this fleet. In a GameLift script ARN, the resource ID matches the ScriptId value.

Definition at line 707 of file FleetAttributes.h.

◆ SetScriptId() [1/3]

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

A unique identifier for a Realtime script.

Definition at line 641 of file FleetAttributes.h.

◆ SetScriptId() [2/3]

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

A unique identifier for a Realtime script.

Definition at line 636 of file FleetAttributes.h.

◆ SetScriptId() [3/3]

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

A unique identifier for a Realtime script.

Definition at line 646 of file FleetAttributes.h.

◆ SetServerLaunchParameters() [1/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 828 of file FleetAttributes.h.

◆ SetServerLaunchParameters() [2/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 821 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 835 of file FleetAttributes.h.

◆ SetServerLaunchPath() [1/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 767 of file FleetAttributes.h.

◆ SetServerLaunchPath() [2/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 759 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 775 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 464 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 478 of file FleetAttributes.h.

◆ SetStoppedActions() [1/2]

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

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

Definition at line 1198 of file FleetAttributes.h.

◆ SetStoppedActions() [2/2]

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

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

Definition at line 1192 of file FleetAttributes.h.

◆ SetTerminationTime() [1/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 407 of file FleetAttributes.h.

◆ SetTerminationTime() [2/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 400 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 450 of file FleetAttributes.h.

◆ StoppedActionsHasBeenSet()

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

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

Definition at line 1186 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 393 of file FleetAttributes.h.

◆ WithBuildArn() [1/3]

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

The Amazon Resource Name (ARN) associated with the GameLift build resource that is deployed on instances in this fleet. In a GameLift build ARN, the resource ID matches the BuildId value.

Definition at line 611 of file FleetAttributes.h.

◆ WithBuildArn() [2/3]

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

The Amazon Resource Name (ARN) associated with the GameLift build resource that is deployed on instances in this fleet. In a GameLift build ARN, the resource ID matches the BuildId value.

Definition at line 602 of file FleetAttributes.h.

◆ WithBuildArn() [3/3]

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

The Amazon Resource Name (ARN) associated with the GameLift build resource that is deployed on instances in this fleet. In a GameLift build ARN, the resource ID matches the BuildId value.

Definition at line 620 of file FleetAttributes.h.

◆ WithBuildId() [1/3]

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

A unique identifier for a build.

Definition at line 542 of file FleetAttributes.h.

◆ WithBuildId() [2/3]

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

A unique identifier for a build.

Definition at line 537 of file FleetAttributes.h.

◆ WithBuildId() [3/3]

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

A unique identifier for a build.

Definition at line 547 of file FleetAttributes.h.

◆ WithCertificateConfiguration() [1/2]

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

Indicates whether a TLS/SSL certificate was generated for the fleet.

Definition at line 1302 of file FleetAttributes.h.

◆ WithCertificateConfiguration() [2/2]

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

Indicates whether a TLS/SSL certificate was generated for the fleet.

Definition at line 1297 of file FleetAttributes.h.

◆ WithCreationTime() [1/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 378 of file FleetAttributes.h.

◆ WithCreationTime() [2/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 372 of file FleetAttributes.h.

◆ WithDescription() [1/3]

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

Human-readable description of the fleet.

Definition at line 287 of file FleetAttributes.h.

◆ WithDescription() [2/3]

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

Human-readable description of the fleet.

Definition at line 282 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 292 of file FleetAttributes.h.

◆ WithFleetArn() [1/3]

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

The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift fleet ARN, the resource ID matches the FleetId value.

Definition at line 156 of file FleetAttributes.h.

◆ WithFleetArn() [2/3]

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

The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift fleet ARN, the resource ID matches the FleetId value.

Definition at line 147 of file FleetAttributes.h.

◆ WithFleetArn() [3/3]

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

The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift fleet ARN, the resource ID matches the FleetId value.

Definition at line 165 of file FleetAttributes.h.

◆ WithFleetId() [1/3]

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

A unique identifier for a fleet.

Definition at line 87 of file FleetAttributes.h.

◆ WithFleetId() [2/3]

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

A unique identifier for a fleet.

Definition at line 82 of file FleetAttributes.h.

◆ WithFleetId() [3/3]

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

A unique identifier for a fleet.

Definition at line 92 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 196 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 202 of file FleetAttributes.h.

◆ WithInstanceRoleArn() [1/3]

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

A unique identifier for an AWS IAM role that manages access to your AWS services.

Definition at line 1265 of file FleetAttributes.h.

◆ WithInstanceRoleArn() [2/3]

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

A unique identifier for an AWS IAM role that manages access to your AWS services.

Definition at line 1259 of file FleetAttributes.h.

◆ WithInstanceRoleArn() [3/3]

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

A unique identifier for an AWS IAM role that manages access to your AWS services.

Definition at line 1271 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 243 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 251 of file FleetAttributes.h.

◆ WithLogPaths() [1/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:\game\logs (for Windows) or /local/game/logs (for Linux). Use the Amazon GameLift console to access stored logs.

Definition at line 929 of file FleetAttributes.h.

◆ WithLogPaths() [2/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:\game\logs (for Windows) or /local/game/logs (for Linux). Use the Amazon GameLift console to access stored logs.

Definition at line 917 of file FleetAttributes.h.

◆ WithMetricGroups() [1/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 1149 of file FleetAttributes.h.

◆ WithMetricGroups() [2/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 1141 of file FleetAttributes.h.

◆ WithName() [1/3]

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

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

Definition at line 335 of file FleetAttributes.h.

◆ WithName() [2/3]

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

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

Definition at line 329 of file FleetAttributes.h.

◆ WithName() [3/3]

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

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

Definition at line 341 of file FleetAttributes.h.

◆ WithNewGameSessionProtectionPolicy() [1/2]

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

The 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 1011 of file FleetAttributes.h.

◆ WithNewGameSessionProtectionPolicy() [2/2]

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

The 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 1020 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 1056 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 1063 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 1094 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 1100 of file FleetAttributes.h.

◆ WithScriptArn() [1/3]

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

The Amazon Resource Name (ARN) associated with the GameLift script resource that is deployed on instances in this fleet. In a GameLift script ARN, the resource ID matches the ScriptId value.

Definition at line 725 of file FleetAttributes.h.

◆ WithScriptArn() [2/3]

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

The Amazon Resource Name (ARN) associated with the GameLift script resource that is deployed on instances in this fleet. In a GameLift script ARN, the resource ID matches the ScriptId value.

Definition at line 716 of file FleetAttributes.h.

◆ WithScriptArn() [3/3]

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

The Amazon Resource Name (ARN) associated with the GameLift script resource that is deployed on instances in this fleet. In a GameLift script ARN, the resource ID matches the ScriptId value.

Definition at line 734 of file FleetAttributes.h.

◆ WithScriptId() [1/3]

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

A unique identifier for a Realtime script.

Definition at line 656 of file FleetAttributes.h.

◆ WithScriptId() [2/3]

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

A unique identifier for a Realtime script.

Definition at line 651 of file FleetAttributes.h.

◆ WithScriptId() [3/3]

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

A unique identifier for a Realtime script.

Definition at line 661 of file FleetAttributes.h.

◆ WithServerLaunchParameters() [1/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 849 of file FleetAttributes.h.

◆ WithServerLaunchParameters() [2/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 842 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 856 of file FleetAttributes.h.

◆ WithServerLaunchPath() [1/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 791 of file FleetAttributes.h.

◆ WithServerLaunchPath() [2/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 783 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 799 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 492 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 506 of file FleetAttributes.h.

◆ WithStoppedActions() [1/2]

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

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

Definition at line 1210 of file FleetAttributes.h.

◆ WithStoppedActions() [2/2]

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

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

Definition at line 1204 of file FleetAttributes.h.

◆ WithTerminationTime() [1/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 421 of file FleetAttributes.h.

◆ WithTerminationTime() [2/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 414 of file FleetAttributes.h.

The documentation for this class was generated from the following file:
Generated by doxygen 1.8.19
Privacy | Site terms | Cookie preferences