We recommend new projects start with resources from the AWS provider.
AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
aws-native.gamelift.getGameServerGroup
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
The AWS::GameLift::GameServerGroup resource creates an Amazon GameLift (GameLift) GameServerGroup.
Using getGameServerGroup
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getGameServerGroup(args: GetGameServerGroupArgs, opts?: InvokeOptions): Promise<GetGameServerGroupResult>
function getGameServerGroupOutput(args: GetGameServerGroupOutputArgs, opts?: InvokeOptions): Output<GetGameServerGroupResult>def get_game_server_group(game_server_group_arn: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetGameServerGroupResult
def get_game_server_group_output(game_server_group_arn: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetGameServerGroupResult]func LookupGameServerGroup(ctx *Context, args *LookupGameServerGroupArgs, opts ...InvokeOption) (*LookupGameServerGroupResult, error)
func LookupGameServerGroupOutput(ctx *Context, args *LookupGameServerGroupOutputArgs, opts ...InvokeOption) LookupGameServerGroupResultOutput> Note: This function is named LookupGameServerGroup in the Go SDK.
public static class GetGameServerGroup 
{
    public static Task<GetGameServerGroupResult> InvokeAsync(GetGameServerGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetGameServerGroupResult> Invoke(GetGameServerGroupInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetGameServerGroupResult> getGameServerGroup(GetGameServerGroupArgs args, InvokeOptions options)
public static Output<GetGameServerGroupResult> getGameServerGroup(GetGameServerGroupArgs args, InvokeOptions options)
fn::invoke:
  function: aws-native:gamelift:getGameServerGroup
  arguments:
    # arguments dictionaryThe following arguments are supported:
- GameServer stringGroup Arn 
- A generated unique ID for the game server group.
- GameServer stringGroup Arn 
- A generated unique ID for the game server group.
- gameServer StringGroup Arn 
- A generated unique ID for the game server group.
- gameServer stringGroup Arn 
- A generated unique ID for the game server group.
- game_server_ strgroup_ arn 
- A generated unique ID for the game server group.
- gameServer StringGroup Arn 
- A generated unique ID for the game server group.
getGameServerGroup Result
The following output properties are available:
- AutoScaling stringGroup Arn 
- A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.
- BalancingStrategy 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.
- GameServer stringGroup Arn 
- A generated unique ID for the game server group.
- GameServer stringGroup Name 
- An identifier for the new game server group.
- GameServer 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.
- InstanceDefinitions List<Pulumi.Aws Native. Game Lift. Outputs. Game Server Group Instance Definition> 
- A set of EC2 instance types to use when creating instances in the group.
- RoleArn string
- The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.
- AutoScaling stringGroup Arn 
- A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.
- BalancingStrategy 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.
- GameServer stringGroup Arn 
- A generated unique ID for the game server group.
- GameServer stringGroup Name 
- An identifier for the new game server group.
- GameServer GameProtection Policy Server Group Game Server Protection Policy 
- A flag that indicates whether instances in the game server group are protected from early termination.
- InstanceDefinitions []GameServer Group Instance Definition 
- A set of EC2 instance types to use when creating instances in the group.
- RoleArn string
- The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.
- autoScaling StringGroup Arn 
- A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.
- balancingStrategy 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.
- gameServer StringGroup Arn 
- A generated unique ID for the game server group.
- gameServer StringGroup Name 
- An identifier for the new game server group.
- gameServer GameProtection Policy Server Group Game Server Protection Policy 
- A flag that indicates whether instances in the game server group are protected from early termination.
- instanceDefinitions List<GameServer Group Instance Definition> 
- A set of EC2 instance types to use when creating instances in the group.
- roleArn String
- The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.
- autoScaling stringGroup Arn 
- A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.
- balancingStrategy 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.
- gameServer stringGroup Arn 
- A generated unique ID for the game server group.
- gameServer stringGroup Name 
- An identifier for the new game server group.
- gameServer GameProtection Policy Server Group Game Server Protection Policy 
- A flag that indicates whether instances in the game server group are protected from early termination.
- instanceDefinitions GameServer Group Instance Definition[] 
- A set of EC2 instance types to use when creating instances in the group.
- roleArn string
- The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.
- auto_scaling_ strgroup_ arn 
- A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.
- 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.
- game_server_ strgroup_ arn 
- A generated unique ID for the game server group.
- 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.
- instance_definitions Sequence[GameServer Group Instance Definition] 
- 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.
- autoScaling StringGroup Arn 
- A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.
- balancingStrategy "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.
- gameServer StringGroup Arn 
- A generated unique ID for the game server group.
- gameServer StringGroup Name 
- An identifier for the new game server group.
- gameServer "NO_PROTECTION" | "FULL_PROTECTION"Protection Policy 
- A flag that indicates whether instances in the game server group are protected from early termination.
- instanceDefinitions List<Property Map>
- A set of EC2 instance types to use when creating instances in the group.
- roleArn String
- The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.
Supporting Types
GameServerGroupBalancingStrategy    
GameServerGroupGameServerProtectionPolicy      
GameServerGroupInstanceDefinition    
- InstanceType string
- WeightedCapacity string
- InstanceType string
- WeightedCapacity string
- instanceType String
- weightedCapacity String
- instanceType string
- weightedCapacity string
- instance_type str
- weighted_capacity str
- instanceType String
- weightedCapacity String
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi