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

#include <UpdateGameServerGroupRequest.h>

+ Inheritance diagram for Aws::GameLift::Model::UpdateGameServerGroupRequest:

Public Member Functions

 UpdateGameServerGroupRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetGameServerGroupName () const
 
bool GameServerGroupNameHasBeenSet () const
 
void SetGameServerGroupName (const Aws::String &value)
 
void SetGameServerGroupName (Aws::String &&value)
 
void SetGameServerGroupName (const char *value)
 
UpdateGameServerGroupRequestWithGameServerGroupName (const Aws::String &value)
 
UpdateGameServerGroupRequestWithGameServerGroupName (Aws::String &&value)
 
UpdateGameServerGroupRequestWithGameServerGroupName (const char *value)
 
const Aws::StringGetRoleArn () const
 
bool RoleArnHasBeenSet () const
 
void SetRoleArn (const Aws::String &value)
 
void SetRoleArn (Aws::String &&value)
 
void SetRoleArn (const char *value)
 
UpdateGameServerGroupRequestWithRoleArn (const Aws::String &value)
 
UpdateGameServerGroupRequestWithRoleArn (Aws::String &&value)
 
UpdateGameServerGroupRequestWithRoleArn (const char *value)
 
const Aws::Vector< InstanceDefinition > & GetInstanceDefinitions () const
 
bool InstanceDefinitionsHasBeenSet () const
 
void SetInstanceDefinitions (const Aws::Vector< InstanceDefinition > &value)
 
void SetInstanceDefinitions (Aws::Vector< InstanceDefinition > &&value)
 
UpdateGameServerGroupRequestWithInstanceDefinitions (const Aws::Vector< InstanceDefinition > &value)
 
UpdateGameServerGroupRequestWithInstanceDefinitions (Aws::Vector< InstanceDefinition > &&value)
 
UpdateGameServerGroupRequestAddInstanceDefinitions (const InstanceDefinition &value)
 
UpdateGameServerGroupRequestAddInstanceDefinitions (InstanceDefinition &&value)
 
const GameServerProtectionPolicyGetGameServerProtectionPolicy () const
 
bool GameServerProtectionPolicyHasBeenSet () const
 
void SetGameServerProtectionPolicy (const GameServerProtectionPolicy &value)
 
void SetGameServerProtectionPolicy (GameServerProtectionPolicy &&value)
 
UpdateGameServerGroupRequestWithGameServerProtectionPolicy (const GameServerProtectionPolicy &value)
 
UpdateGameServerGroupRequestWithGameServerProtectionPolicy (GameServerProtectionPolicy &&value)
 
const BalancingStrategyGetBalancingStrategy () const
 
bool BalancingStrategyHasBeenSet () const
 
void SetBalancingStrategy (const BalancingStrategy &value)
 
void SetBalancingStrategy (BalancingStrategy &&value)
 
UpdateGameServerGroupRequestWithBalancingStrategy (const BalancingStrategy &value)
 
UpdateGameServerGroupRequestWithBalancingStrategy (BalancingStrategy &&value)
 
- Public Member Functions inherited from Aws::GameLift::GameLiftRequest
virtual ~GameLiftRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 25 of file UpdateGameServerGroupRequest.h.

Constructor & Destructor Documentation

◆ UpdateGameServerGroupRequest()

Aws::GameLift::Model::UpdateGameServerGroupRequest::UpdateGameServerGroupRequest ( )

Member Function Documentation

◆ AddInstanceDefinitions() [1/2]

UpdateGameServerGroupRequest& Aws::GameLift::Model::UpdateGameServerGroupRequest::AddInstanceDefinitions ( const InstanceDefinition value)
inline

An updated list of EC2 instance types to use in the Auto Scaling group. The instance definitions must specify at least two different instance types that are supported by GameLift FleetIQ. This updated list replaces the entire current list of instance definitions for the game server group. For more information on instance types, see EC2 Instance Types in the Amazon EC2 User Guide. You can optionally specify capacity weighting for each instance type. If no weight value is specified for an instance type, it is set to the default value "1". For more information about capacity weighting, see Instance Weighting for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

Definition at line 272 of file UpdateGameServerGroupRequest.h.

◆ AddInstanceDefinitions() [2/2]

UpdateGameServerGroupRequest& Aws::GameLift::Model::UpdateGameServerGroupRequest::AddInstanceDefinitions ( InstanceDefinition &&  value)
inline

An updated list of EC2 instance types to use in the Auto Scaling group. The instance definitions must specify at least two different instance types that are supported by GameLift FleetIQ. This updated list replaces the entire current list of instance definitions for the game server group. For more information on instance types, see EC2 Instance Types in the Amazon EC2 User Guide. You can optionally specify capacity weighting for each instance type. If no weight value is specified for an instance type, it is set to the default value "1". For more information about capacity weighting, see Instance Weighting for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

Definition at line 289 of file UpdateGameServerGroupRequest.h.

◆ BalancingStrategyHasBeenSet()

bool Aws::GameLift::Model::UpdateGameServerGroupRequest::BalancingStrategyHasBeenSet ( ) const
inline

Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group. Method options include the following:

  • SPOT_ONLY - Only Spot Instances are used in the game server group. If Spot Instances are unavailable or not viable for game hosting, the game server group provides no hosting capacity until Spot Instances can again be used. Until then, no new instances are started, and the existing nonviable Spot Instances are terminated (after current gameplay ends) and are not replaced.

  • SPOT_PREFERRED - (default value) Spot Instances are used whenever available in the game server group. If Spot Instances are unavailable, the game server group continues to provide hosting capacity by falling back to On-Demand Instances. Existing nonviable Spot Instances are terminated (after current gameplay ends) and are replaced with new On-Demand Instances.

  • ON_DEMAND_ONLY - Only On-Demand Instances are used in the game server group. No Spot Instances are used, even when available, while this balancing strategy is in force.

Definition at line 403 of file UpdateGameServerGroupRequest.h.

◆ GameServerGroupNameHasBeenSet()

bool Aws::GameLift::Model::UpdateGameServerGroupRequest::GameServerGroupNameHasBeenSet ( ) const
inline

A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.

Definition at line 51 of file UpdateGameServerGroupRequest.h.

◆ GameServerProtectionPolicyHasBeenSet()

bool Aws::GameLift::Model::UpdateGameServerGroupRequest::GameServerProtectionPolicyHasBeenSet ( ) const
inline

A flag that indicates whether instances in the game server group are protected from early termination. Unprotected instances that have active game servers running might be terminated during a scale-down event, causing players to be dropped from the game. Protected instances cannot be terminated while there are active game servers running except in the event of a forced game server group deletion (see ). An exception to this is with Spot Instances, which can be terminated by AWS regardless of protection status. This property is set to NO_PROTECTION by default.

Definition at line 314 of file UpdateGameServerGroupRequest.h.

◆ GetBalancingStrategy()

const BalancingStrategy& Aws::GameLift::Model::UpdateGameServerGroupRequest::GetBalancingStrategy ( ) const
inline

Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group. Method options include the following:

  • SPOT_ONLY - Only Spot Instances are used in the game server group. If Spot Instances are unavailable or not viable for game hosting, the game server group provides no hosting capacity until Spot Instances can again be used. Until then, no new instances are started, and the existing nonviable Spot Instances are terminated (after current gameplay ends) and are not replaced.

  • SPOT_PREFERRED - (default value) Spot Instances are used whenever available in the game server group. If Spot Instances are unavailable, the game server group continues to provide hosting capacity by falling back to On-Demand Instances. Existing nonviable Spot Instances are terminated (after current gameplay ends) and are replaced with new On-Demand Instances.

  • ON_DEMAND_ONLY - Only On-Demand Instances are used in the game server group. No Spot Instances are used, even when available, while this balancing strategy is in force.

Definition at line 383 of file UpdateGameServerGroupRequest.h.

◆ GetGameServerGroupName()

const Aws::String& Aws::GameLift::Model::UpdateGameServerGroupRequest::GetGameServerGroupName ( ) const
inline

A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.

Definition at line 45 of file UpdateGameServerGroupRequest.h.

◆ GetGameServerProtectionPolicy()

const GameServerProtectionPolicy& Aws::GameLift::Model::UpdateGameServerGroupRequest::GetGameServerProtectionPolicy ( ) const
inline

A flag that indicates whether instances in the game server group are protected from early termination. Unprotected instances that have active game servers running might be terminated during a scale-down event, causing players to be dropped from the game. Protected instances cannot be terminated while there are active game servers running except in the event of a forced game server group deletion (see ). An exception to this is with Spot Instances, which can be terminated by AWS regardless of protection status. This property is set to NO_PROTECTION by default.

Definition at line 302 of file UpdateGameServerGroupRequest.h.

◆ GetInstanceDefinitions()

const Aws::Vector<InstanceDefinition>& Aws::GameLift::Model::UpdateGameServerGroupRequest::GetInstanceDefinitions ( ) const
inline

An updated list of EC2 instance types to use in the Auto Scaling group. The instance definitions must specify at least two different instance types that are supported by GameLift FleetIQ. This updated list replaces the entire current list of instance definitions for the game server group. For more information on instance types, see EC2 Instance Types in the Amazon EC2 User Guide. You can optionally specify capacity weighting for each instance type. If no weight value is specified for an instance type, it is set to the default value "1". For more information about capacity weighting, see Instance Weighting for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

Definition at line 170 of file UpdateGameServerGroupRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::GameLift::Model::UpdateGameServerGroupRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::GameLift::GameLiftRequest.

◆ GetRoleArn()

const Aws::String& Aws::GameLift::Model::UpdateGameServerGroupRequest::GetRoleArn ( ) const
inline

The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.

Definition at line 96 of file UpdateGameServerGroupRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::GameLift::Model::UpdateGameServerGroupRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file UpdateGameServerGroupRequest.h.

◆ InstanceDefinitionsHasBeenSet()

bool Aws::GameLift::Model::UpdateGameServerGroupRequest::InstanceDefinitionsHasBeenSet ( ) const
inline

An updated list of EC2 instance types to use in the Auto Scaling group. The instance definitions must specify at least two different instance types that are supported by GameLift FleetIQ. This updated list replaces the entire current list of instance definitions for the game server group. For more information on instance types, see EC2 Instance Types in the Amazon EC2 User Guide. You can optionally specify capacity weighting for each instance type. If no weight value is specified for an instance type, it is set to the default value "1". For more information about capacity weighting, see Instance Weighting for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

Definition at line 187 of file UpdateGameServerGroupRequest.h.

◆ RoleArnHasBeenSet()

bool Aws::GameLift::Model::UpdateGameServerGroupRequest::RoleArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.

Definition at line 104 of file UpdateGameServerGroupRequest.h.

◆ SerializePayload()

Aws::String Aws::GameLift::Model::UpdateGameServerGroupRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetBalancingStrategy() [1/2]

void Aws::GameLift::Model::UpdateGameServerGroupRequest::SetBalancingStrategy ( const BalancingStrategy value)
inline

Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group. Method options include the following:

  • SPOT_ONLY - Only Spot Instances are used in the game server group. If Spot Instances are unavailable or not viable for game hosting, the game server group provides no hosting capacity until Spot Instances can again be used. Until then, no new instances are started, and the existing nonviable Spot Instances are terminated (after current gameplay ends) and are not replaced.

  • SPOT_PREFERRED - (default value) Spot Instances are used whenever available in the game server group. If Spot Instances are unavailable, the game server group continues to provide hosting capacity by falling back to On-Demand Instances. Existing nonviable Spot Instances are terminated (after current gameplay ends) and are replaced with new On-Demand Instances.

  • ON_DEMAND_ONLY - Only On-Demand Instances are used in the game server group. No Spot Instances are used, even when available, while this balancing strategy is in force.

Definition at line 423 of file UpdateGameServerGroupRequest.h.

◆ SetBalancingStrategy() [2/2]

void Aws::GameLift::Model::UpdateGameServerGroupRequest::SetBalancingStrategy ( BalancingStrategy &&  value)
inline

Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group. Method options include the following:

  • SPOT_ONLY - Only Spot Instances are used in the game server group. If Spot Instances are unavailable or not viable for game hosting, the game server group provides no hosting capacity until Spot Instances can again be used. Until then, no new instances are started, and the existing nonviable Spot Instances are terminated (after current gameplay ends) and are not replaced.

  • SPOT_PREFERRED - (default value) Spot Instances are used whenever available in the game server group. If Spot Instances are unavailable, the game server group continues to provide hosting capacity by falling back to On-Demand Instances. Existing nonviable Spot Instances are terminated (after current gameplay ends) and are replaced with new On-Demand Instances.

  • ON_DEMAND_ONLY - Only On-Demand Instances are used in the game server group. No Spot Instances are used, even when available, while this balancing strategy is in force.

Definition at line 443 of file UpdateGameServerGroupRequest.h.

◆ SetGameServerGroupName() [1/3]

void Aws::GameLift::Model::UpdateGameServerGroupRequest::SetGameServerGroupName ( const Aws::String value)
inline

A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.

Definition at line 57 of file UpdateGameServerGroupRequest.h.

◆ SetGameServerGroupName() [2/3]

void Aws::GameLift::Model::UpdateGameServerGroupRequest::SetGameServerGroupName ( Aws::String &&  value)
inline

A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.

Definition at line 63 of file UpdateGameServerGroupRequest.h.

◆ SetGameServerGroupName() [3/3]

void Aws::GameLift::Model::UpdateGameServerGroupRequest::SetGameServerGroupName ( const char *  value)
inline

A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.

Definition at line 69 of file UpdateGameServerGroupRequest.h.

◆ SetGameServerProtectionPolicy() [1/2]

void Aws::GameLift::Model::UpdateGameServerGroupRequest::SetGameServerProtectionPolicy ( const GameServerProtectionPolicy value)
inline

A flag that indicates whether instances in the game server group are protected from early termination. Unprotected instances that have active game servers running might be terminated during a scale-down event, causing players to be dropped from the game. Protected instances cannot be terminated while there are active game servers running except in the event of a forced game server group deletion (see ). An exception to this is with Spot Instances, which can be terminated by AWS regardless of protection status. This property is set to NO_PROTECTION by default.

Definition at line 326 of file UpdateGameServerGroupRequest.h.

◆ SetGameServerProtectionPolicy() [2/2]

void Aws::GameLift::Model::UpdateGameServerGroupRequest::SetGameServerProtectionPolicy ( GameServerProtectionPolicy &&  value)
inline

A flag that indicates whether instances in the game server group are protected from early termination. Unprotected instances that have active game servers running might be terminated during a scale-down event, causing players to be dropped from the game. Protected instances cannot be terminated while there are active game servers running except in the event of a forced game server group deletion (see ). An exception to this is with Spot Instances, which can be terminated by AWS regardless of protection status. This property is set to NO_PROTECTION by default.

Definition at line 338 of file UpdateGameServerGroupRequest.h.

◆ SetInstanceDefinitions() [1/2]

void Aws::GameLift::Model::UpdateGameServerGroupRequest::SetInstanceDefinitions ( const Aws::Vector< InstanceDefinition > &  value)
inline

An updated list of EC2 instance types to use in the Auto Scaling group. The instance definitions must specify at least two different instance types that are supported by GameLift FleetIQ. This updated list replaces the entire current list of instance definitions for the game server group. For more information on instance types, see EC2 Instance Types in the Amazon EC2 User Guide. You can optionally specify capacity weighting for each instance type. If no weight value is specified for an instance type, it is set to the default value "1". For more information about capacity weighting, see Instance Weighting for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

Definition at line 204 of file UpdateGameServerGroupRequest.h.

◆ SetInstanceDefinitions() [2/2]

void Aws::GameLift::Model::UpdateGameServerGroupRequest::SetInstanceDefinitions ( Aws::Vector< InstanceDefinition > &&  value)
inline

An updated list of EC2 instance types to use in the Auto Scaling group. The instance definitions must specify at least two different instance types that are supported by GameLift FleetIQ. This updated list replaces the entire current list of instance definitions for the game server group. For more information on instance types, see EC2 Instance Types in the Amazon EC2 User Guide. You can optionally specify capacity weighting for each instance type. If no weight value is specified for an instance type, it is set to the default value "1". For more information about capacity weighting, see Instance Weighting for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

Definition at line 221 of file UpdateGameServerGroupRequest.h.

◆ SetRoleArn() [1/3]

void Aws::GameLift::Model::UpdateGameServerGroupRequest::SetRoleArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.

Definition at line 112 of file UpdateGameServerGroupRequest.h.

◆ SetRoleArn() [2/3]

void Aws::GameLift::Model::UpdateGameServerGroupRequest::SetRoleArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.

Definition at line 120 of file UpdateGameServerGroupRequest.h.

◆ SetRoleArn() [3/3]

void Aws::GameLift::Model::UpdateGameServerGroupRequest::SetRoleArn ( const char *  value)
inline

The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.

Definition at line 128 of file UpdateGameServerGroupRequest.h.

◆ WithBalancingStrategy() [1/2]

UpdateGameServerGroupRequest& Aws::GameLift::Model::UpdateGameServerGroupRequest::WithBalancingStrategy ( const BalancingStrategy value)
inline

Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group. Method options include the following:

  • SPOT_ONLY - Only Spot Instances are used in the game server group. If Spot Instances are unavailable or not viable for game hosting, the game server group provides no hosting capacity until Spot Instances can again be used. Until then, no new instances are started, and the existing nonviable Spot Instances are terminated (after current gameplay ends) and are not replaced.

  • SPOT_PREFERRED - (default value) Spot Instances are used whenever available in the game server group. If Spot Instances are unavailable, the game server group continues to provide hosting capacity by falling back to On-Demand Instances. Existing nonviable Spot Instances are terminated (after current gameplay ends) and are replaced with new On-Demand Instances.

  • ON_DEMAND_ONLY - Only On-Demand Instances are used in the game server group. No Spot Instances are used, even when available, while this balancing strategy is in force.

Definition at line 463 of file UpdateGameServerGroupRequest.h.

◆ WithBalancingStrategy() [2/2]

UpdateGameServerGroupRequest& Aws::GameLift::Model::UpdateGameServerGroupRequest::WithBalancingStrategy ( BalancingStrategy &&  value)
inline

Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group. Method options include the following:

  • SPOT_ONLY - Only Spot Instances are used in the game server group. If Spot Instances are unavailable or not viable for game hosting, the game server group provides no hosting capacity until Spot Instances can again be used. Until then, no new instances are started, and the existing nonviable Spot Instances are terminated (after current gameplay ends) and are not replaced.

  • SPOT_PREFERRED - (default value) Spot Instances are used whenever available in the game server group. If Spot Instances are unavailable, the game server group continues to provide hosting capacity by falling back to On-Demand Instances. Existing nonviable Spot Instances are terminated (after current gameplay ends) and are replaced with new On-Demand Instances.

  • ON_DEMAND_ONLY - Only On-Demand Instances are used in the game server group. No Spot Instances are used, even when available, while this balancing strategy is in force.

Definition at line 483 of file UpdateGameServerGroupRequest.h.

◆ WithGameServerGroupName() [1/3]

UpdateGameServerGroupRequest& Aws::GameLift::Model::UpdateGameServerGroupRequest::WithGameServerGroupName ( const Aws::String value)
inline

A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.

Definition at line 75 of file UpdateGameServerGroupRequest.h.

◆ WithGameServerGroupName() [2/3]

UpdateGameServerGroupRequest& Aws::GameLift::Model::UpdateGameServerGroupRequest::WithGameServerGroupName ( Aws::String &&  value)
inline

A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.

Definition at line 81 of file UpdateGameServerGroupRequest.h.

◆ WithGameServerGroupName() [3/3]

UpdateGameServerGroupRequest& Aws::GameLift::Model::UpdateGameServerGroupRequest::WithGameServerGroupName ( const char *  value)
inline

A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.

Definition at line 87 of file UpdateGameServerGroupRequest.h.

◆ WithGameServerProtectionPolicy() [1/2]

UpdateGameServerGroupRequest& Aws::GameLift::Model::UpdateGameServerGroupRequest::WithGameServerProtectionPolicy ( const GameServerProtectionPolicy value)
inline

A flag that indicates whether instances in the game server group are protected from early termination. Unprotected instances that have active game servers running might be terminated during a scale-down event, causing players to be dropped from the game. Protected instances cannot be terminated while there are active game servers running except in the event of a forced game server group deletion (see ). An exception to this is with Spot Instances, which can be terminated by AWS regardless of protection status. This property is set to NO_PROTECTION by default.

Definition at line 350 of file UpdateGameServerGroupRequest.h.

◆ WithGameServerProtectionPolicy() [2/2]

UpdateGameServerGroupRequest& Aws::GameLift::Model::UpdateGameServerGroupRequest::WithGameServerProtectionPolicy ( GameServerProtectionPolicy &&  value)
inline

A flag that indicates whether instances in the game server group are protected from early termination. Unprotected instances that have active game servers running might be terminated during a scale-down event, causing players to be dropped from the game. Protected instances cannot be terminated while there are active game servers running except in the event of a forced game server group deletion (see ). An exception to this is with Spot Instances, which can be terminated by AWS regardless of protection status. This property is set to NO_PROTECTION by default.

Definition at line 362 of file UpdateGameServerGroupRequest.h.

◆ WithInstanceDefinitions() [1/2]

UpdateGameServerGroupRequest& Aws::GameLift::Model::UpdateGameServerGroupRequest::WithInstanceDefinitions ( const Aws::Vector< InstanceDefinition > &  value)
inline

An updated list of EC2 instance types to use in the Auto Scaling group. The instance definitions must specify at least two different instance types that are supported by GameLift FleetIQ. This updated list replaces the entire current list of instance definitions for the game server group. For more information on instance types, see EC2 Instance Types in the Amazon EC2 User Guide. You can optionally specify capacity weighting for each instance type. If no weight value is specified for an instance type, it is set to the default value "1". For more information about capacity weighting, see Instance Weighting for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

Definition at line 238 of file UpdateGameServerGroupRequest.h.

◆ WithInstanceDefinitions() [2/2]

UpdateGameServerGroupRequest& Aws::GameLift::Model::UpdateGameServerGroupRequest::WithInstanceDefinitions ( Aws::Vector< InstanceDefinition > &&  value)
inline

An updated list of EC2 instance types to use in the Auto Scaling group. The instance definitions must specify at least two different instance types that are supported by GameLift FleetIQ. This updated list replaces the entire current list of instance definitions for the game server group. For more information on instance types, see EC2 Instance Types in the Amazon EC2 User Guide. You can optionally specify capacity weighting for each instance type. If no weight value is specified for an instance type, it is set to the default value "1". For more information about capacity weighting, see Instance Weighting for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

Definition at line 255 of file UpdateGameServerGroupRequest.h.

◆ WithRoleArn() [1/3]

UpdateGameServerGroupRequest& Aws::GameLift::Model::UpdateGameServerGroupRequest::WithRoleArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.

Definition at line 136 of file UpdateGameServerGroupRequest.h.

◆ WithRoleArn() [2/3]

UpdateGameServerGroupRequest& Aws::GameLift::Model::UpdateGameServerGroupRequest::WithRoleArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.

Definition at line 144 of file UpdateGameServerGroupRequest.h.

◆ WithRoleArn() [3/3]

UpdateGameServerGroupRequest& Aws::GameLift::Model::UpdateGameServerGroupRequest::WithRoleArn ( const char *  value)
inline

The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.

Definition at line 152 of file UpdateGameServerGroupRequest.h.


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