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

#include <CreateGameServerGroupRequest.h>

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

Public Member Functions

 CreateGameServerGroupRequest ()
 
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)
 
CreateGameServerGroupRequestWithGameServerGroupName (const Aws::String &value)
 
CreateGameServerGroupRequestWithGameServerGroupName (Aws::String &&value)
 
CreateGameServerGroupRequestWithGameServerGroupName (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)
 
CreateGameServerGroupRequestWithRoleArn (const Aws::String &value)
 
CreateGameServerGroupRequestWithRoleArn (Aws::String &&value)
 
CreateGameServerGroupRequestWithRoleArn (const char *value)
 
int GetMinSize () const
 
bool MinSizeHasBeenSet () const
 
void SetMinSize (int value)
 
CreateGameServerGroupRequestWithMinSize (int value)
 
int GetMaxSize () const
 
bool MaxSizeHasBeenSet () const
 
void SetMaxSize (int value)
 
CreateGameServerGroupRequestWithMaxSize (int value)
 
const LaunchTemplateSpecificationGetLaunchTemplate () const
 
bool LaunchTemplateHasBeenSet () const
 
void SetLaunchTemplate (const LaunchTemplateSpecification &value)
 
void SetLaunchTemplate (LaunchTemplateSpecification &&value)
 
CreateGameServerGroupRequestWithLaunchTemplate (const LaunchTemplateSpecification &value)
 
CreateGameServerGroupRequestWithLaunchTemplate (LaunchTemplateSpecification &&value)
 
const Aws::Vector< InstanceDefinition > & GetInstanceDefinitions () const
 
bool InstanceDefinitionsHasBeenSet () const
 
void SetInstanceDefinitions (const Aws::Vector< InstanceDefinition > &value)
 
void SetInstanceDefinitions (Aws::Vector< InstanceDefinition > &&value)
 
CreateGameServerGroupRequestWithInstanceDefinitions (const Aws::Vector< InstanceDefinition > &value)
 
CreateGameServerGroupRequestWithInstanceDefinitions (Aws::Vector< InstanceDefinition > &&value)
 
CreateGameServerGroupRequestAddInstanceDefinitions (const InstanceDefinition &value)
 
CreateGameServerGroupRequestAddInstanceDefinitions (InstanceDefinition &&value)
 
const GameServerGroupAutoScalingPolicyGetAutoScalingPolicy () const
 
bool AutoScalingPolicyHasBeenSet () const
 
void SetAutoScalingPolicy (const GameServerGroupAutoScalingPolicy &value)
 
void SetAutoScalingPolicy (GameServerGroupAutoScalingPolicy &&value)
 
CreateGameServerGroupRequestWithAutoScalingPolicy (const GameServerGroupAutoScalingPolicy &value)
 
CreateGameServerGroupRequestWithAutoScalingPolicy (GameServerGroupAutoScalingPolicy &&value)
 
const BalancingStrategyGetBalancingStrategy () const
 
bool BalancingStrategyHasBeenSet () const
 
void SetBalancingStrategy (const BalancingStrategy &value)
 
void SetBalancingStrategy (BalancingStrategy &&value)
 
CreateGameServerGroupRequestWithBalancingStrategy (const BalancingStrategy &value)
 
CreateGameServerGroupRequestWithBalancingStrategy (BalancingStrategy &&value)
 
const GameServerProtectionPolicyGetGameServerProtectionPolicy () const
 
bool GameServerProtectionPolicyHasBeenSet () const
 
void SetGameServerProtectionPolicy (const GameServerProtectionPolicy &value)
 
void SetGameServerProtectionPolicy (GameServerProtectionPolicy &&value)
 
CreateGameServerGroupRequestWithGameServerProtectionPolicy (const GameServerProtectionPolicy &value)
 
CreateGameServerGroupRequestWithGameServerProtectionPolicy (GameServerProtectionPolicy &&value)
 
const Aws::Vector< Aws::String > & GetVpcSubnets () const
 
bool VpcSubnetsHasBeenSet () const
 
void SetVpcSubnets (const Aws::Vector< Aws::String > &value)
 
void SetVpcSubnets (Aws::Vector< Aws::String > &&value)
 
CreateGameServerGroupRequestWithVpcSubnets (const Aws::Vector< Aws::String > &value)
 
CreateGameServerGroupRequestWithVpcSubnets (Aws::Vector< Aws::String > &&value)
 
CreateGameServerGroupRequestAddVpcSubnets (const Aws::String &value)
 
CreateGameServerGroupRequestAddVpcSubnets (Aws::String &&value)
 
CreateGameServerGroupRequestAddVpcSubnets (const char *value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
CreateGameServerGroupRequestWithTags (const Aws::Vector< Tag > &value)
 
CreateGameServerGroupRequestWithTags (Aws::Vector< Tag > &&value)
 
CreateGameServerGroupRequestAddTags (const Tag &value)
 
CreateGameServerGroupRequestAddTags (Tag &&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 28 of file CreateGameServerGroupRequest.h.

Constructor & Destructor Documentation

◆ CreateGameServerGroupRequest()

Aws::GameLift::Model::CreateGameServerGroupRequest::CreateGameServerGroupRequest ( )

Member Function Documentation

◆ AddInstanceDefinitions() [1/2]

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

A set of EC2 instance types to use when creating instances in the group. The instance definitions must specify at least two different instance types that are supported by GameLift FleetIQ. For more information on instance types, see EC2 Instance Types in the Amazon EC2 User Guide.

Definition at line 360 of file CreateGameServerGroupRequest.h.

◆ AddInstanceDefinitions() [2/2]

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

A set of EC2 instance types to use when creating instances in the group. The instance definitions must specify at least two different instance types that are supported by GameLift FleetIQ. For more information on instance types, see EC2 Instance Types in the Amazon EC2 User Guide.

Definition at line 369 of file CreateGameServerGroupRequest.h.

◆ AddTags() [1/2]

CreateGameServerGroupRequest& Aws::GameLift::Model::CreateGameServerGroupRequest::AddTags ( const Tag value)
inline

A list of labels to assign to the new game server group resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management, and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

Definition at line 744 of file CreateGameServerGroupRequest.h.

◆ AddTags() [2/2]

CreateGameServerGroupRequest& Aws::GameLift::Model::CreateGameServerGroupRequest::AddTags ( Tag &&  value)
inline

A list of labels to assign to the new game server group resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management, and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

Definition at line 757 of file CreateGameServerGroupRequest.h.

◆ AddVpcSubnets() [1/3]

CreateGameServerGroupRequest& Aws::GameLift::Model::CreateGameServerGroupRequest::AddVpcSubnets ( const Aws::String value)
inline

A list of virtual private cloud (VPC) subnets to use with instances in the game server group. By default, all GameLift FleetIQ-supported availability zones are used; this parameter allows you to specify VPCs that you've set up.

Definition at line 638 of file CreateGameServerGroupRequest.h.

◆ AddVpcSubnets() [2/3]

CreateGameServerGroupRequest& Aws::GameLift::Model::CreateGameServerGroupRequest::AddVpcSubnets ( Aws::String &&  value)
inline

A list of virtual private cloud (VPC) subnets to use with instances in the game server group. By default, all GameLift FleetIQ-supported availability zones are used; this parameter allows you to specify VPCs that you've set up.

Definition at line 645 of file CreateGameServerGroupRequest.h.

◆ AddVpcSubnets() [3/3]

CreateGameServerGroupRequest& Aws::GameLift::Model::CreateGameServerGroupRequest::AddVpcSubnets ( const char *  value)
inline

A list of virtual private cloud (VPC) subnets to use with instances in the game server group. By default, all GameLift FleetIQ-supported availability zones are used; this parameter allows you to specify VPCs that you've set up.

Definition at line 652 of file CreateGameServerGroupRequest.h.

◆ AutoScalingPolicyHasBeenSet()

bool Aws::GameLift::Model::CreateGameServerGroupRequest::AutoScalingPolicyHasBeenSet ( ) const
inline

Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting. The scaling policy uses the metric "PercentUtilizedGameServers" to maintain a buffer of idle game servers that can immediately accommodate new games and players. Once the game server and Auto Scaling groups are created, you can update the scaling policy settings directly in Auto Scaling Groups.

Definition at line 390 of file CreateGameServerGroupRequest.h.

◆ BalancingStrategyHasBeenSet()

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

The fallback balancing method to use for the game server group when Spot instances in a Region become unavailable or are not viable for game hosting. Once triggered, this method remains active until Spot instances can once again be used. Method options include:

  • SPOT_ONLY – If Spot instances are unavailable, the game server group provides no hosting capacity. No new instances are started, and the existing nonviable Spot instances are terminated (once current gameplay ends) and not replaced.

  • SPOT_PREFERRED – If Spot instances are unavailable, the game server group continues to provide hosting capacity by using On-Demand instances. Existing nonviable Spot instances are terminated (once current gameplay ends) and replaced with new On-Demand instances.

Definition at line 461 of file CreateGameServerGroupRequest.h.

◆ GameServerGroupNameHasBeenSet()

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

An identifier for the new game server group. This value is used to generate unique ARN identifiers for the EC2 Auto Scaling group and the GameLift FleetIQ game server group. The name must be unique per Region per AWS account.

Definition at line 56 of file CreateGameServerGroupRequest.h.

◆ GameServerProtectionPolicyHasBeenSet()

bool Aws::GameLift::Model::CreateGameServerGroupRequest::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 may by 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. An exception to this is Spot Instances, which may be terminated by AWS regardless of protection status. This property is set to NO_PROTECTION by default.

Definition at line 544 of file CreateGameServerGroupRequest.h.

◆ GetAutoScalingPolicy()

const GameServerGroupAutoScalingPolicy& Aws::GameLift::Model::CreateGameServerGroupRequest::GetAutoScalingPolicy ( ) const
inline

Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting. The scaling policy uses the metric "PercentUtilizedGameServers" to maintain a buffer of idle game servers that can immediately accommodate new games and players. Once the game server and Auto Scaling groups are created, you can update the scaling policy settings directly in Auto Scaling Groups.

Definition at line 380 of file CreateGameServerGroupRequest.h.

◆ GetBalancingStrategy()

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

The fallback balancing method to use for the game server group when Spot instances in a Region become unavailable or are not viable for game hosting. Once triggered, this method remains active until Spot instances can once again be used. Method options include:

  • SPOT_ONLY – If Spot instances are unavailable, the game server group provides no hosting capacity. No new instances are started, and the existing nonviable Spot instances are terminated (once current gameplay ends) and not replaced.

  • SPOT_PREFERRED – If Spot instances are unavailable, the game server group continues to provide hosting capacity by using On-Demand instances. Existing nonviable Spot instances are terminated (once current gameplay ends) and replaced with new On-Demand instances.

Definition at line 446 of file CreateGameServerGroupRequest.h.

◆ GetGameServerGroupName()

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

An identifier for the new game server group. This value is used to generate unique ARN identifiers for the EC2 Auto Scaling group and the GameLift FleetIQ game server group. The name must be unique per Region per AWS account.

Definition at line 49 of file CreateGameServerGroupRequest.h.

◆ GetGameServerProtectionPolicy()

const GameServerProtectionPolicy& Aws::GameLift::Model::CreateGameServerGroupRequest::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 may by 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. An exception to this is Spot Instances, which may be terminated by AWS regardless of protection status. This property is set to NO_PROTECTION by default.

Definition at line 533 of file CreateGameServerGroupRequest.h.

◆ GetInstanceDefinitions()

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

A set of EC2 instance types to use when creating instances in the group. The instance definitions must specify at least two different instance types that are supported by GameLift FleetIQ. For more information on instance types, see EC2 Instance Types in the Amazon EC2 User Guide.

Definition at line 306 of file CreateGameServerGroupRequest.h.

◆ GetLaunchTemplate()

const LaunchTemplateSpecification& Aws::GameLift::Model::CreateGameServerGroupRequest::GetLaunchTemplate ( ) const
inline

The EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group. You can specify the template using either the template name or ID. For help with creating a launch template, see Creating a Launch Template for an Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

Definition at line 241 of file CreateGameServerGroupRequest.h.

◆ GetMaxSize()

int Aws::GameLift::Model::CreateGameServerGroupRequest::GetMaxSize ( ) const
inline

The maximum number of instances allowed in the EC2 Auto Scaling group. During autoscaling events, GameLift FleetIQ and EC2 do not scale up the group above this maximum.

Definition at line 208 of file CreateGameServerGroupRequest.h.

◆ GetMinSize()

int Aws::GameLift::Model::CreateGameServerGroupRequest::GetMinSize ( ) const
inline

The minimum number of instances allowed in the EC2 Auto Scaling group. During autoscaling events, GameLift FleetIQ and EC2 do not scale down the group below this minimum. In production, this value should be set to at least 1.

Definition at line 179 of file CreateGameServerGroupRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::GameLift::GameLiftRequest.

◆ GetRoleArn()

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

The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups. The submitted role is validated to ensure that it contains the necessary permissions for game server groups.

Definition at line 108 of file CreateGameServerGroupRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 37 of file CreateGameServerGroupRequest.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::GameLift::Model::CreateGameServerGroupRequest::GetTags ( ) const
inline

A list of labels to assign to the new game server group resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management, and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

Definition at line 666 of file CreateGameServerGroupRequest.h.

◆ GetVpcSubnets()

const Aws::Vector<Aws::String>& Aws::GameLift::Model::CreateGameServerGroupRequest::GetVpcSubnets ( ) const
inline

A list of virtual private cloud (VPC) subnets to use with instances in the game server group. By default, all GameLift FleetIQ-supported availability zones are used; this parameter allows you to specify VPCs that you've set up.

Definition at line 596 of file CreateGameServerGroupRequest.h.

◆ InstanceDefinitionsHasBeenSet()

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

A set of EC2 instance types to use when creating instances in the group. The instance definitions must specify at least two different instance types that are supported by GameLift FleetIQ. For more information on instance types, see EC2 Instance Types in the Amazon EC2 User Guide.

Definition at line 315 of file CreateGameServerGroupRequest.h.

◆ LaunchTemplateHasBeenSet()

bool Aws::GameLift::Model::CreateGameServerGroupRequest::LaunchTemplateHasBeenSet ( ) const
inline

The EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group. You can specify the template using either the template name or ID. For help with creating a launch template, see Creating a Launch Template for an Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

Definition at line 252 of file CreateGameServerGroupRequest.h.

◆ MaxSizeHasBeenSet()

bool Aws::GameLift::Model::CreateGameServerGroupRequest::MaxSizeHasBeenSet ( ) const
inline

The maximum number of instances allowed in the EC2 Auto Scaling group. During autoscaling events, GameLift FleetIQ and EC2 do not scale up the group above this maximum.

Definition at line 215 of file CreateGameServerGroupRequest.h.

◆ MinSizeHasBeenSet()

bool Aws::GameLift::Model::CreateGameServerGroupRequest::MinSizeHasBeenSet ( ) const
inline

The minimum number of instances allowed in the EC2 Auto Scaling group. During autoscaling events, GameLift FleetIQ and EC2 do not scale down the group below this minimum. In production, this value should be set to at least 1.

Definition at line 186 of file CreateGameServerGroupRequest.h.

◆ RoleArnHasBeenSet()

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

The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups. The submitted role is validated to ensure that it contains the necessary permissions for game server groups.

Definition at line 117 of file CreateGameServerGroupRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAutoScalingPolicy() [1/2]

void Aws::GameLift::Model::CreateGameServerGroupRequest::SetAutoScalingPolicy ( const GameServerGroupAutoScalingPolicy value)
inline

Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting. The scaling policy uses the metric "PercentUtilizedGameServers" to maintain a buffer of idle game servers that can immediately accommodate new games and players. Once the game server and Auto Scaling groups are created, you can update the scaling policy settings directly in Auto Scaling Groups.

Definition at line 400 of file CreateGameServerGroupRequest.h.

◆ SetAutoScalingPolicy() [2/2]

void Aws::GameLift::Model::CreateGameServerGroupRequest::SetAutoScalingPolicy ( GameServerGroupAutoScalingPolicy &&  value)
inline

Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting. The scaling policy uses the metric "PercentUtilizedGameServers" to maintain a buffer of idle game servers that can immediately accommodate new games and players. Once the game server and Auto Scaling groups are created, you can update the scaling policy settings directly in Auto Scaling Groups.

Definition at line 410 of file CreateGameServerGroupRequest.h.

◆ SetBalancingStrategy() [1/2]

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

The fallback balancing method to use for the game server group when Spot instances in a Region become unavailable or are not viable for game hosting. Once triggered, this method remains active until Spot instances can once again be used. Method options include:

  • SPOT_ONLY – If Spot instances are unavailable, the game server group provides no hosting capacity. No new instances are started, and the existing nonviable Spot instances are terminated (once current gameplay ends) and not replaced.

  • SPOT_PREFERRED – If Spot instances are unavailable, the game server group continues to provide hosting capacity by using On-Demand instances. Existing nonviable Spot instances are terminated (once current gameplay ends) and replaced with new On-Demand instances.

Definition at line 476 of file CreateGameServerGroupRequest.h.

◆ SetBalancingStrategy() [2/2]

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

The fallback balancing method to use for the game server group when Spot instances in a Region become unavailable or are not viable for game hosting. Once triggered, this method remains active until Spot instances can once again be used. Method options include:

  • SPOT_ONLY – If Spot instances are unavailable, the game server group provides no hosting capacity. No new instances are started, and the existing nonviable Spot instances are terminated (once current gameplay ends) and not replaced.

  • SPOT_PREFERRED – If Spot instances are unavailable, the game server group continues to provide hosting capacity by using On-Demand instances. Existing nonviable Spot instances are terminated (once current gameplay ends) and replaced with new On-Demand instances.

Definition at line 491 of file CreateGameServerGroupRequest.h.

◆ SetGameServerGroupName() [1/3]

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

An identifier for the new game server group. This value is used to generate unique ARN identifiers for the EC2 Auto Scaling group and the GameLift FleetIQ game server group. The name must be unique per Region per AWS account.

Definition at line 63 of file CreateGameServerGroupRequest.h.

◆ SetGameServerGroupName() [2/3]

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

An identifier for the new game server group. This value is used to generate unique ARN identifiers for the EC2 Auto Scaling group and the GameLift FleetIQ game server group. The name must be unique per Region per AWS account.

Definition at line 70 of file CreateGameServerGroupRequest.h.

◆ SetGameServerGroupName() [3/3]

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

An identifier for the new game server group. This value is used to generate unique ARN identifiers for the EC2 Auto Scaling group and the GameLift FleetIQ game server group. The name must be unique per Region per AWS account.

Definition at line 77 of file CreateGameServerGroupRequest.h.

◆ SetGameServerProtectionPolicy() [1/2]

void Aws::GameLift::Model::CreateGameServerGroupRequest::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 may by 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. An exception to this is Spot Instances, which may be terminated by AWS regardless of protection status. This property is set to NO_PROTECTION by default.

Definition at line 555 of file CreateGameServerGroupRequest.h.

◆ SetGameServerProtectionPolicy() [2/2]

void Aws::GameLift::Model::CreateGameServerGroupRequest::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 may by 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. An exception to this is Spot Instances, which may be terminated by AWS regardless of protection status. This property is set to NO_PROTECTION by default.

Definition at line 566 of file CreateGameServerGroupRequest.h.

◆ SetInstanceDefinitions() [1/2]

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

A set of EC2 instance types to use when creating instances in the group. The instance definitions must specify at least two different instance types that are supported by GameLift FleetIQ. For more information on instance types, see EC2 Instance Types in the Amazon EC2 User Guide.

Definition at line 324 of file CreateGameServerGroupRequest.h.

◆ SetInstanceDefinitions() [2/2]

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

A set of EC2 instance types to use when creating instances in the group. The instance definitions must specify at least two different instance types that are supported by GameLift FleetIQ. For more information on instance types, see EC2 Instance Types in the Amazon EC2 User Guide.

Definition at line 333 of file CreateGameServerGroupRequest.h.

◆ SetLaunchTemplate() [1/2]

void Aws::GameLift::Model::CreateGameServerGroupRequest::SetLaunchTemplate ( const LaunchTemplateSpecification value)
inline

The EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group. You can specify the template using either the template name or ID. For help with creating a launch template, see Creating a Launch Template for an Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

Definition at line 263 of file CreateGameServerGroupRequest.h.

◆ SetLaunchTemplate() [2/2]

void Aws::GameLift::Model::CreateGameServerGroupRequest::SetLaunchTemplate ( LaunchTemplateSpecification &&  value)
inline

The EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group. You can specify the template using either the template name or ID. For help with creating a launch template, see Creating a Launch Template for an Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

Definition at line 274 of file CreateGameServerGroupRequest.h.

◆ SetMaxSize()

void Aws::GameLift::Model::CreateGameServerGroupRequest::SetMaxSize ( int  value)
inline

The maximum number of instances allowed in the EC2 Auto Scaling group. During autoscaling events, GameLift FleetIQ and EC2 do not scale up the group above this maximum.

Definition at line 222 of file CreateGameServerGroupRequest.h.

◆ SetMinSize()

void Aws::GameLift::Model::CreateGameServerGroupRequest::SetMinSize ( int  value)
inline

The minimum number of instances allowed in the EC2 Auto Scaling group. During autoscaling events, GameLift FleetIQ and EC2 do not scale down the group below this minimum. In production, this value should be set to at least 1.

Definition at line 193 of file CreateGameServerGroupRequest.h.

◆ SetRoleArn() [1/3]

void Aws::GameLift::Model::CreateGameServerGroupRequest::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. The submitted role is validated to ensure that it contains the necessary permissions for game server groups.

Definition at line 126 of file CreateGameServerGroupRequest.h.

◆ SetRoleArn() [2/3]

void Aws::GameLift::Model::CreateGameServerGroupRequest::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. The submitted role is validated to ensure that it contains the necessary permissions for game server groups.

Definition at line 135 of file CreateGameServerGroupRequest.h.

◆ SetRoleArn() [3/3]

void Aws::GameLift::Model::CreateGameServerGroupRequest::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. The submitted role is validated to ensure that it contains the necessary permissions for game server groups.

Definition at line 144 of file CreateGameServerGroupRequest.h.

◆ SetTags() [1/2]

void Aws::GameLift::Model::CreateGameServerGroupRequest::SetTags ( const Aws::Vector< Tag > &  value)
inline

A list of labels to assign to the new game server group resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management, and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

Definition at line 692 of file CreateGameServerGroupRequest.h.

◆ SetTags() [2/2]

void Aws::GameLift::Model::CreateGameServerGroupRequest::SetTags ( Aws::Vector< Tag > &&  value)
inline

A list of labels to assign to the new game server group resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management, and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

Definition at line 705 of file CreateGameServerGroupRequest.h.

◆ SetVpcSubnets() [1/2]

void Aws::GameLift::Model::CreateGameServerGroupRequest::SetVpcSubnets ( const Aws::Vector< Aws::String > &  value)
inline

A list of virtual private cloud (VPC) subnets to use with instances in the game server group. By default, all GameLift FleetIQ-supported availability zones are used; this parameter allows you to specify VPCs that you've set up.

Definition at line 610 of file CreateGameServerGroupRequest.h.

◆ SetVpcSubnets() [2/2]

void Aws::GameLift::Model::CreateGameServerGroupRequest::SetVpcSubnets ( Aws::Vector< Aws::String > &&  value)
inline

A list of virtual private cloud (VPC) subnets to use with instances in the game server group. By default, all GameLift FleetIQ-supported availability zones are used; this parameter allows you to specify VPCs that you've set up.

Definition at line 617 of file CreateGameServerGroupRequest.h.

◆ TagsHasBeenSet()

bool Aws::GameLift::Model::CreateGameServerGroupRequest::TagsHasBeenSet ( ) const
inline

A list of labels to assign to the new game server group resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management, and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

Definition at line 679 of file CreateGameServerGroupRequest.h.

◆ VpcSubnetsHasBeenSet()

bool Aws::GameLift::Model::CreateGameServerGroupRequest::VpcSubnetsHasBeenSet ( ) const
inline

A list of virtual private cloud (VPC) subnets to use with instances in the game server group. By default, all GameLift FleetIQ-supported availability zones are used; this parameter allows you to specify VPCs that you've set up.

Definition at line 603 of file CreateGameServerGroupRequest.h.

◆ WithAutoScalingPolicy() [1/2]

CreateGameServerGroupRequest& Aws::GameLift::Model::CreateGameServerGroupRequest::WithAutoScalingPolicy ( const GameServerGroupAutoScalingPolicy value)
inline

Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting. The scaling policy uses the metric "PercentUtilizedGameServers" to maintain a buffer of idle game servers that can immediately accommodate new games and players. Once the game server and Auto Scaling groups are created, you can update the scaling policy settings directly in Auto Scaling Groups.

Definition at line 420 of file CreateGameServerGroupRequest.h.

◆ WithAutoScalingPolicy() [2/2]

CreateGameServerGroupRequest& Aws::GameLift::Model::CreateGameServerGroupRequest::WithAutoScalingPolicy ( GameServerGroupAutoScalingPolicy &&  value)
inline

Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting. The scaling policy uses the metric "PercentUtilizedGameServers" to maintain a buffer of idle game servers that can immediately accommodate new games and players. Once the game server and Auto Scaling groups are created, you can update the scaling policy settings directly in Auto Scaling Groups.

Definition at line 430 of file CreateGameServerGroupRequest.h.

◆ WithBalancingStrategy() [1/2]

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

The fallback balancing method to use for the game server group when Spot instances in a Region become unavailable or are not viable for game hosting. Once triggered, this method remains active until Spot instances can once again be used. Method options include:

  • SPOT_ONLY – If Spot instances are unavailable, the game server group provides no hosting capacity. No new instances are started, and the existing nonviable Spot instances are terminated (once current gameplay ends) and not replaced.

  • SPOT_PREFERRED – If Spot instances are unavailable, the game server group continues to provide hosting capacity by using On-Demand instances. Existing nonviable Spot instances are terminated (once current gameplay ends) and replaced with new On-Demand instances.

Definition at line 506 of file CreateGameServerGroupRequest.h.

◆ WithBalancingStrategy() [2/2]

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

The fallback balancing method to use for the game server group when Spot instances in a Region become unavailable or are not viable for game hosting. Once triggered, this method remains active until Spot instances can once again be used. Method options include:

  • SPOT_ONLY – If Spot instances are unavailable, the game server group provides no hosting capacity. No new instances are started, and the existing nonviable Spot instances are terminated (once current gameplay ends) and not replaced.

  • SPOT_PREFERRED – If Spot instances are unavailable, the game server group continues to provide hosting capacity by using On-Demand instances. Existing nonviable Spot instances are terminated (once current gameplay ends) and replaced with new On-Demand instances.

Definition at line 521 of file CreateGameServerGroupRequest.h.

◆ WithGameServerGroupName() [1/3]

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

An identifier for the new game server group. This value is used to generate unique ARN identifiers for the EC2 Auto Scaling group and the GameLift FleetIQ game server group. The name must be unique per Region per AWS account.

Definition at line 84 of file CreateGameServerGroupRequest.h.

◆ WithGameServerGroupName() [2/3]

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

An identifier for the new game server group. This value is used to generate unique ARN identifiers for the EC2 Auto Scaling group and the GameLift FleetIQ game server group. The name must be unique per Region per AWS account.

Definition at line 91 of file CreateGameServerGroupRequest.h.

◆ WithGameServerGroupName() [3/3]

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

An identifier for the new game server group. This value is used to generate unique ARN identifiers for the EC2 Auto Scaling group and the GameLift FleetIQ game server group. The name must be unique per Region per AWS account.

Definition at line 98 of file CreateGameServerGroupRequest.h.

◆ WithGameServerProtectionPolicy() [1/2]

CreateGameServerGroupRequest& Aws::GameLift::Model::CreateGameServerGroupRequest::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 may by 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. An exception to this is Spot Instances, which may be terminated by AWS regardless of protection status. This property is set to NO_PROTECTION by default.

Definition at line 577 of file CreateGameServerGroupRequest.h.

◆ WithGameServerProtectionPolicy() [2/2]

CreateGameServerGroupRequest& Aws::GameLift::Model::CreateGameServerGroupRequest::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 may by 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. An exception to this is Spot Instances, which may be terminated by AWS regardless of protection status. This property is set to NO_PROTECTION by default.

Definition at line 588 of file CreateGameServerGroupRequest.h.

◆ WithInstanceDefinitions() [1/2]

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

A set of EC2 instance types to use when creating instances in the group. The instance definitions must specify at least two different instance types that are supported by GameLift FleetIQ. For more information on instance types, see EC2 Instance Types in the Amazon EC2 User Guide.

Definition at line 342 of file CreateGameServerGroupRequest.h.

◆ WithInstanceDefinitions() [2/2]

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

A set of EC2 instance types to use when creating instances in the group. The instance definitions must specify at least two different instance types that are supported by GameLift FleetIQ. For more information on instance types, see EC2 Instance Types in the Amazon EC2 User Guide.

Definition at line 351 of file CreateGameServerGroupRequest.h.

◆ WithLaunchTemplate() [1/2]

CreateGameServerGroupRequest& Aws::GameLift::Model::CreateGameServerGroupRequest::WithLaunchTemplate ( const LaunchTemplateSpecification value)
inline

The EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group. You can specify the template using either the template name or ID. For help with creating a launch template, see Creating a Launch Template for an Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

Definition at line 285 of file CreateGameServerGroupRequest.h.

◆ WithLaunchTemplate() [2/2]

CreateGameServerGroupRequest& Aws::GameLift::Model::CreateGameServerGroupRequest::WithLaunchTemplate ( LaunchTemplateSpecification &&  value)
inline

The EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group. You can specify the template using either the template name or ID. For help with creating a launch template, see Creating a Launch Template for an Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

Definition at line 296 of file CreateGameServerGroupRequest.h.

◆ WithMaxSize()

CreateGameServerGroupRequest& Aws::GameLift::Model::CreateGameServerGroupRequest::WithMaxSize ( int  value)
inline

The maximum number of instances allowed in the EC2 Auto Scaling group. During autoscaling events, GameLift FleetIQ and EC2 do not scale up the group above this maximum.

Definition at line 229 of file CreateGameServerGroupRequest.h.

◆ WithMinSize()

CreateGameServerGroupRequest& Aws::GameLift::Model::CreateGameServerGroupRequest::WithMinSize ( int  value)
inline

The minimum number of instances allowed in the EC2 Auto Scaling group. During autoscaling events, GameLift FleetIQ and EC2 do not scale down the group below this minimum. In production, this value should be set to at least 1.

Definition at line 200 of file CreateGameServerGroupRequest.h.

◆ WithRoleArn() [1/3]

CreateGameServerGroupRequest& Aws::GameLift::Model::CreateGameServerGroupRequest::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. The submitted role is validated to ensure that it contains the necessary permissions for game server groups.

Definition at line 153 of file CreateGameServerGroupRequest.h.

◆ WithRoleArn() [2/3]

CreateGameServerGroupRequest& Aws::GameLift::Model::CreateGameServerGroupRequest::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. The submitted role is validated to ensure that it contains the necessary permissions for game server groups.

Definition at line 162 of file CreateGameServerGroupRequest.h.

◆ WithRoleArn() [3/3]

CreateGameServerGroupRequest& Aws::GameLift::Model::CreateGameServerGroupRequest::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. The submitted role is validated to ensure that it contains the necessary permissions for game server groups.

Definition at line 171 of file CreateGameServerGroupRequest.h.

◆ WithTags() [1/2]

CreateGameServerGroupRequest& Aws::GameLift::Model::CreateGameServerGroupRequest::WithTags ( const Aws::Vector< Tag > &  value)
inline

A list of labels to assign to the new game server group resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management, and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

Definition at line 718 of file CreateGameServerGroupRequest.h.

◆ WithTags() [2/2]

CreateGameServerGroupRequest& Aws::GameLift::Model::CreateGameServerGroupRequest::WithTags ( Aws::Vector< Tag > &&  value)
inline

A list of labels to assign to the new game server group resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management, and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

Definition at line 731 of file CreateGameServerGroupRequest.h.

◆ WithVpcSubnets() [1/2]

CreateGameServerGroupRequest& Aws::GameLift::Model::CreateGameServerGroupRequest::WithVpcSubnets ( const Aws::Vector< Aws::String > &  value)
inline

A list of virtual private cloud (VPC) subnets to use with instances in the game server group. By default, all GameLift FleetIQ-supported availability zones are used; this parameter allows you to specify VPCs that you've set up.

Definition at line 624 of file CreateGameServerGroupRequest.h.

◆ WithVpcSubnets() [2/2]

CreateGameServerGroupRequest& Aws::GameLift::Model::CreateGameServerGroupRequest::WithVpcSubnets ( Aws::Vector< Aws::String > &&  value)
inline

A list of virtual private cloud (VPC) subnets to use with instances in the game server group. By default, all GameLift FleetIQ-supported availability zones are used; this parameter allows you to specify VPCs that you've set up.

Definition at line 631 of file CreateGameServerGroupRequest.h.


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