AWS Native is in preview. AWS Classic is fully supported.
aws-native.gamelift.GameServerGroup
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
The AWS::GameLift::GameServerGroup resource creates an Amazon GameLift (GameLift) GameServerGroup.
Create GameServerGroup Resource
new GameServerGroup(name: string, args: GameServerGroupArgs, opts?: CustomResourceOptions);
@overload
def GameServerGroup(resource_name: str,
opts: Optional[ResourceOptions] = None,
auto_scaling_policy: Optional[GameServerGroupAutoScalingPolicyArgs] = None,
balancing_strategy: Optional[GameServerGroupBalancingStrategy] = None,
delete_option: Optional[GameServerGroupDeleteOption] = None,
game_server_group_name: Optional[str] = None,
game_server_protection_policy: Optional[GameServerGroupGameServerProtectionPolicy] = None,
instance_definitions: Optional[Sequence[GameServerGroupInstanceDefinitionArgs]] = None,
launch_template: Optional[GameServerGroupLaunchTemplateArgs] = None,
max_size: Optional[float] = None,
min_size: Optional[float] = None,
role_arn: Optional[str] = None,
tags: Optional[Sequence[GameServerGroupTagArgs]] = None,
vpc_subnets: Optional[Sequence[str]] = None)
@overload
def GameServerGroup(resource_name: str,
args: GameServerGroupArgs,
opts: Optional[ResourceOptions] = None)
func NewGameServerGroup(ctx *Context, name string, args GameServerGroupArgs, opts ...ResourceOption) (*GameServerGroup, error)
public GameServerGroup(string name, GameServerGroupArgs args, CustomResourceOptions? opts = null)
public GameServerGroup(String name, GameServerGroupArgs args)
public GameServerGroup(String name, GameServerGroupArgs args, CustomResourceOptions options)
type: aws-native:gamelift:GameServerGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GameServerGroupArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args GameServerGroupArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args GameServerGroupArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GameServerGroupArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args GameServerGroupArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
GameServerGroup Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The GameServerGroup resource accepts the following input properties:
- Instance
Definitions List<Pulumi.Aws Native. Game Lift. Inputs. Game Server Group Instance Definition> A set of EC2 instance types to use when creating instances in the group.
- Role
Arn string The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.
- Auto
Scaling Pulumi.Policy Aws Native. Game Lift. Inputs. Game Server Group Auto Scaling Policy Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting
- Balancing
Strategy Pulumi.Aws Native. Game Lift. Game Server Group Balancing Strategy 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.
- Delete
Option Pulumi.Aws Native. Game Lift. Game Server Group Delete Option The type of delete to perform.
- Game
Server stringGroup Name An identifier for the new game server group.
- Game
Server Pulumi.Protection Policy Aws Native. Game Lift. Game Server Group Game Server Protection Policy A flag that indicates whether instances in the game server group are protected from early termination.
- Launch
Template Pulumi.Aws Native. Game Lift. Inputs. Game Server Group Launch Template The EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group.
- Max
Size double The maximum number of instances allowed in the EC2 Auto Scaling group.
- Min
Size double The minimum number of instances allowed in the EC2 Auto Scaling group.
- List<Pulumi.
Aws Native. Game Lift. Inputs. Game Server Group Tag> A list of labels to assign to the new game server group resource.
- Vpc
Subnets List<string> A list of virtual private cloud (VPC) subnets to use with instances in the game server group.
- Instance
Definitions []GameServer Group Instance Definition Args A set of EC2 instance types to use when creating instances in the group.
- Role
Arn string The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.
- Auto
Scaling GamePolicy Server Group Auto Scaling Policy Args Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting
- Balancing
Strategy GameServer Group Balancing Strategy 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.
- Delete
Option GameServer Group Delete Option The type of delete to perform.
- Game
Server stringGroup Name An identifier for the new game server group.
- Game
Server GameProtection Policy Server Group Game Server Protection Policy A flag that indicates whether instances in the game server group are protected from early termination.
- Launch
Template GameServer Group Launch Template Args The EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group.
- Max
Size float64 The maximum number of instances allowed in the EC2 Auto Scaling group.
- Min
Size float64 The minimum number of instances allowed in the EC2 Auto Scaling group.
- []Game
Server Group Tag Args A list of labels to assign to the new game server group resource.
- Vpc
Subnets []string A list of virtual private cloud (VPC) subnets to use with instances in the game server group.
- instance
Definitions List<GameServer Group Instance Definition> A set of EC2 instance types to use when creating instances in the group.
- role
Arn String The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.
- auto
Scaling GamePolicy Server Group Auto Scaling Policy Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting
- balancing
Strategy GameServer Group Balancing Strategy 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.
- delete
Option GameServer Group Delete Option The type of delete to perform.
- game
Server StringGroup Name An identifier for the new game server group.
- game
Server GameProtection Policy Server Group Game Server Protection Policy A flag that indicates whether instances in the game server group are protected from early termination.
- launch
Template GameServer Group Launch Template The EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group.
- max
Size Double The maximum number of instances allowed in the EC2 Auto Scaling group.
- min
Size Double The minimum number of instances allowed in the EC2 Auto Scaling group.
- List<Game
Server Group Tag> A list of labels to assign to the new game server group resource.
- vpc
Subnets List<String> A list of virtual private cloud (VPC) subnets to use with instances in the game server group.
- instance
Definitions GameServer Group Instance Definition[] A set of EC2 instance types to use when creating instances in the group.
- role
Arn string The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.
- auto
Scaling GamePolicy Server Group Auto Scaling Policy Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting
- balancing
Strategy GameServer Group Balancing Strategy 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.
- delete
Option GameServer Group Delete Option The type of delete to perform.
- game
Server stringGroup Name An identifier for the new game server group.
- game
Server GameProtection Policy Server Group Game Server Protection Policy A flag that indicates whether instances in the game server group are protected from early termination.
- launch
Template GameServer Group Launch Template The EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group.
- max
Size number The maximum number of instances allowed in the EC2 Auto Scaling group.
- min
Size number The minimum number of instances allowed in the EC2 Auto Scaling group.
- Game
Server Group Tag[] A list of labels to assign to the new game server group resource.
- vpc
Subnets string[] A list of virtual private cloud (VPC) subnets to use with instances in the game server group.
- instance_
definitions Sequence[GameServer Group Instance Definition Args] A set of EC2 instance types to use when creating instances in the group.
- role_
arn str The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.
- auto_
scaling_ Gamepolicy Server Group Auto Scaling Policy Args Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting
- balancing_
strategy GameServer Group Balancing Strategy 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.
- delete_
option GameServer Group Delete Option The type of delete to perform.
- game_
server_ strgroup_ name An identifier for the new game server group.
- game_
server_ Gameprotection_ policy Server Group Game Server Protection Policy A flag that indicates whether instances in the game server group are protected from early termination.
- launch_
template GameServer Group Launch Template Args The EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group.
- max_
size float The maximum number of instances allowed in the EC2 Auto Scaling group.
- min_
size float The minimum number of instances allowed in the EC2 Auto Scaling group.
- Sequence[Game
Server Group Tag Args] A list of labels to assign to the new game server group resource.
- vpc_
subnets Sequence[str] A list of virtual private cloud (VPC) subnets to use with instances in the game server group.
- instance
Definitions List<Property Map> A set of EC2 instance types to use when creating instances in the group.
- role
Arn String The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.
- auto
Scaling Property MapPolicy Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting
- balancing
Strategy "SPOT_ONLY" | "SPOT_PREFERRED" | "ON_DEMAND_ONLY" 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.
- delete
Option "SAFE_DELETE" | "FORCE_DELETE" | "RETAIN" The type of delete to perform.
- game
Server StringGroup Name An identifier for the new game server group.
- game
Server "NO_PROTECTION" | "FULL_PROTECTION"Protection Policy A flag that indicates whether instances in the game server group are protected from early termination.
- launch
Template Property Map The EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group.
- max
Size Number The maximum number of instances allowed in the EC2 Auto Scaling group.
- min
Size Number The minimum number of instances allowed in the EC2 Auto Scaling group.
- List<Property Map>
A list of labels to assign to the new game server group resource.
- vpc
Subnets List<String> A list of virtual private cloud (VPC) subnets to use with instances in the game server group.
Outputs
All input properties are implicitly available as output properties. Additionally, the GameServerGroup resource produces the following output properties:
- Auto
Scaling stringGroup Arn A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.
- Game
Server stringGroup Arn A generated unique ID for the game server group.
- Id string
The provider-assigned unique ID for this managed resource.
- Auto
Scaling stringGroup Arn A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.
- Game
Server stringGroup Arn A generated unique ID for the game server group.
- Id string
The provider-assigned unique ID for this managed resource.
- auto
Scaling StringGroup Arn A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.
- game
Server StringGroup Arn A generated unique ID for the game server group.
- id String
The provider-assigned unique ID for this managed resource.
- auto
Scaling stringGroup Arn A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.
- game
Server stringGroup Arn A generated unique ID for the game server group.
- id string
The provider-assigned unique ID for this managed resource.
- auto_
scaling_ strgroup_ arn A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.
- game_
server_ strgroup_ arn A generated unique ID for the game server group.
- id str
The provider-assigned unique ID for this managed resource.
- auto
Scaling StringGroup Arn A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.
- game
Server StringGroup Arn A generated unique ID for the game server group.
- id String
The provider-assigned unique ID for this managed resource.
Supporting Types
GameServerGroupAutoScalingPolicy, GameServerGroupAutoScalingPolicyArgs
GameServerGroupBalancingStrategy, GameServerGroupBalancingStrategyArgs
- Spot
Only - SPOT_ONLY
- Spot
Preferred - SPOT_PREFERRED
- On
Demand Only - ON_DEMAND_ONLY
- Game
Server Group Balancing Strategy Spot Only - SPOT_ONLY
- Game
Server Group Balancing Strategy Spot Preferred - SPOT_PREFERRED
- Game
Server Group Balancing Strategy On Demand Only - ON_DEMAND_ONLY
- Spot
Only - SPOT_ONLY
- Spot
Preferred - SPOT_PREFERRED
- On
Demand Only - ON_DEMAND_ONLY
- Spot
Only - SPOT_ONLY
- Spot
Preferred - SPOT_PREFERRED
- On
Demand Only - ON_DEMAND_ONLY
- SPOT_ONLY
- SPOT_ONLY
- SPOT_PREFERRED
- SPOT_PREFERRED
- ON_DEMAND_ONLY
- ON_DEMAND_ONLY
- "SPOT_ONLY"
- SPOT_ONLY
- "SPOT_PREFERRED"
- SPOT_PREFERRED
- "ON_DEMAND_ONLY"
- ON_DEMAND_ONLY
GameServerGroupDeleteOption, GameServerGroupDeleteOptionArgs
- Safe
Delete - SAFE_DELETE
- Force
Delete - FORCE_DELETE
- Retain
- RETAIN
- Game
Server Group Delete Option Safe Delete - SAFE_DELETE
- Game
Server Group Delete Option Force Delete - FORCE_DELETE
- Game
Server Group Delete Option Retain - RETAIN
- Safe
Delete - SAFE_DELETE
- Force
Delete - FORCE_DELETE
- Retain
- RETAIN
- Safe
Delete - SAFE_DELETE
- Force
Delete - FORCE_DELETE
- Retain
- RETAIN
- SAFE_DELETE
- SAFE_DELETE
- FORCE_DELETE
- FORCE_DELETE
- RETAIN
- RETAIN
- "SAFE_DELETE"
- SAFE_DELETE
- "FORCE_DELETE"
- FORCE_DELETE
- "RETAIN"
- RETAIN
GameServerGroupGameServerProtectionPolicy, GameServerGroupGameServerProtectionPolicyArgs
- No
Protection - NO_PROTECTION
- Full
Protection - FULL_PROTECTION
- Game
Server Group Game Server Protection Policy No Protection - NO_PROTECTION
- Game
Server Group Game Server Protection Policy Full Protection - FULL_PROTECTION
- No
Protection - NO_PROTECTION
- Full
Protection - FULL_PROTECTION
- No
Protection - NO_PROTECTION
- Full
Protection - FULL_PROTECTION
- NO_PROTECTION
- NO_PROTECTION
- FULL_PROTECTION
- FULL_PROTECTION
- "NO_PROTECTION"
- NO_PROTECTION
- "FULL_PROTECTION"
- FULL_PROTECTION
GameServerGroupInstanceDefinition, GameServerGroupInstanceDefinitionArgs
- Instance
Type string - Weighted
Capacity string
- Instance
Type string - Weighted
Capacity string
- instance
Type String - weighted
Capacity String
- instance
Type string - weighted
Capacity string
- instance_
type str - weighted_
capacity str
- instance
Type String - weighted
Capacity String
GameServerGroupLaunchTemplate, GameServerGroupLaunchTemplateArgs
- Launch
Template stringId - Launch
Template stringName - Version string
- Launch
Template stringId - Launch
Template stringName - Version string
- launch
Template StringId - launch
Template StringName - version String
- launch
Template stringId - launch
Template stringName - version string
- launch_
template_ strid - launch_
template_ strname - version str
- launch
Template StringId - launch
Template StringName - version String
GameServerGroupTag, GameServerGroupTagArgs
GameServerGroupTargetTrackingConfiguration, GameServerGroupTargetTrackingConfigurationArgs
- Target
Value double
- Target
Value float64
- target
Value Double
- target
Value number
- target_
value float
- target
Value Number
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.