GameServerGroupState class
Input properties used for looking up and filtering GameServerGroup resources.
Constructors
-
GameServerGroupState({Input<
String?> ? arn, Input<String?> ? autoScalingGroupArn, Input<GameServerGroupAutoScalingPolicy?> ? autoScalingPolicy, Input<String?> ? balancingStrategy, Input<String?> ? gameServerGroupName, Input<String?> ? gameServerProtectionPolicy, Input<List< ? instanceDefinitions, Input<GameServerGroupInstanceDefinition> ?>GameServerGroupLaunchTemplate?> ? launchTemplate, Input<int?> ? maxSize, Input<int?> ? minSize, Input<String?> ? region, Input<String?> ? roleArn, Input<Map< ? tags, Input<String, String> ?>Map< ? tagsAll, Input<String, String> ?>List< ? vpcSubnets})String> ?> -
Creates a new GameServerGroupState.
arnThe ARN of the GameLift Game Server Group.autoScalingGroupArnThe ARN of the created EC2 Auto Scaling group.autoScalingPolicyOptional.balancingStrategyIndicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances.gameServerGroupNameName of the game server group.gameServerProtectionPolicyIndicates whether instances in the game server group are protected from early termination.instanceDefinitionsOptional.launchTemplateOptional.maxSizeThe maximum number of instances allowed in the EC2 Auto Scaling group.minSizeThe minimum number of instances allowed in the EC2 Auto Scaling group.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.roleArnARN for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.tagsKey-value map of resource tagstagsAllOptional.vpcSubnetsA list of VPC subnets to use with instances in the game server group.const -
GameServerGroupState.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
arn
→ Input<
String?> ? -
The ARN of the GameLift Game Server Group.
final
-
autoScalingGroupArn
→ Input<
String?> ? -
The ARN of the created EC2 Auto Scaling group.
final
-
autoScalingPolicy
→ Input<
GameServerGroupAutoScalingPolicy?> ? -
final
-
balancingStrategy
→ Input<
String?> ? -
Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances.
Valid values:
SPOT_ONLY,SPOT_PREFERRED,ON_DEMAND_ONLY. Defaults toSPOT_PREFERRED.final -
gameServerGroupName
→ Input<
String?> ? -
Name of the 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.
final
-
gameServerProtectionPolicy
→ Input<
String?> ? -
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.
Valid values:
NO_PROTECTION,FULL_PROTECTION. Defaults toNO_PROTECTION.final - hashCode → int
-
The hash code for this object.
no setterinherited
-
instanceDefinitions
→ Input<
List< ?GameServerGroupInstanceDefinition> ?> -
final
-
launchTemplate
→ Input<
GameServerGroupLaunchTemplate?> ? -
final
-
maxSize
→ Input<
int?> ? -
The maximum number of instances allowed in the EC2 Auto Scaling group.
During automatic scaling events, GameLift FleetIQ and EC2 do not scale up the group above this maximum.
final
-
minSize
→ Input<
int?> ? -
The minimum number of instances allowed in the EC2 Auto Scaling group.
During automatic scaling events, GameLift FleetIQ and EC2 do not scale down the group below this minimum.
final
-
region
→ Input<
String?> ? -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
-
roleArn
→ Input<
String?> ? -
ARN for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
Key-value map of resource tags
final
-
final
-
vpcSubnets
→ Input<
List< ?String> ?> -
A list of VPC subnets to use with instances in the game server group.
By default, all GameLift FleetIQ-supported Availability Zones are used.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited