AWS Native v0.55.0, Mar 28 23

aws-native.gamelift.getGameServerGroup

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)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: aws-native:gamelift:getGameServerGroup
  arguments:
    # arguments dictionary

The following arguments are supported:

GameServerGroupArn string: A generated unique ID for the game server group.

GameServerGroupArn string: A generated unique ID for the game server group.

gameServerGroupArn String: A generated unique ID for the game server group.

gameServerGroupArn string: A generated unique ID for the game server group.

game_server_group_arn str: A generated unique ID for the game server group.

gameServerGroupArn String: A generated unique ID for the game server group.

getGameServerGroup Result

The following output properties are available:

AutoScalingGroupArn string: A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.
AutoScalingPolicy Pulumi.AwsNative.GameLift.Outputs.GameServerGroupAutoScalingPolicy: Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting
BalancingStrategy Pulumi.AwsNative.GameLift.GameServerGroupBalancingStrategy: 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.
GameServerGroupArn string: A generated unique ID for the game server group.
GameServerGroupName string: An identifier for the new game server group.
GameServerProtectionPolicy Pulumi.AwsNative.GameLift.GameServerGroupGameServerProtectionPolicy: A flag that indicates whether instances in the game server group are protected from early termination.
InstanceDefinitions List<Pulumi.AwsNative.GameLift.Outputs.GameServerGroupInstanceDefinition>: A set of EC2 instance types to use when creating instances in the group.
LaunchTemplate Pulumi.AwsNative.GameLift.Outputs.GameServerGroupLaunchTemplate: The EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group.
MaxSize double: The maximum number of instances allowed in the EC2 Auto Scaling group.
MinSize double: The minimum number of instances allowed in the EC2 Auto Scaling group.
RoleArn string: The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.
Tags List<Pulumi.AwsNative.GameLift.Outputs.GameServerGroupTag>: A list of labels to assign to the new game server group resource.
VpcSubnets List<string>: A list of virtual private cloud (VPC) subnets to use with instances in the game server group.

AutoScalingGroupArn string: A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.
AutoScalingPolicy GameServerGroupAutoScalingPolicy: Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting
BalancingStrategy GameServerGroupBalancingStrategy: 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.
GameServerGroupArn string: A generated unique ID for the game server group.
GameServerGroupName string: An identifier for the new game server group.
GameServerProtectionPolicy GameServerGroupGameServerProtectionPolicy: A flag that indicates whether instances in the game server group are protected from early termination.
InstanceDefinitions []GameServerGroupInstanceDefinition: A set of EC2 instance types to use when creating instances in the group.
LaunchTemplate GameServerGroupLaunchTemplate: The EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group.
MaxSize float64: The maximum number of instances allowed in the EC2 Auto Scaling group.
MinSize float64: The minimum number of instances allowed in the EC2 Auto Scaling group.
RoleArn string: The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.
Tags []GameServerGroupTag: A list of labels to assign to the new game server group resource.
VpcSubnets []string: A list of virtual private cloud (VPC) subnets to use with instances in the game server group.

autoScalingGroupArn String: A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.
autoScalingPolicy GameServerGroupAutoScalingPolicy: Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting
balancingStrategy GameServerGroupBalancingStrategy: 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.
gameServerGroupArn String: A generated unique ID for the game server group.
gameServerGroupName String: An identifier for the new game server group.
gameServerProtectionPolicy GameServerGroupGameServerProtectionPolicy: A flag that indicates whether instances in the game server group are protected from early termination.
instanceDefinitions List<GameServerGroupInstanceDefinition>: A set of EC2 instance types to use when creating instances in the group.
launchTemplate GameServerGroupLaunchTemplate: The EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group.
maxSize Double: The maximum number of instances allowed in the EC2 Auto Scaling group.
minSize Double: The minimum number of instances allowed in the EC2 Auto Scaling group.
roleArn String: The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.
tags List<GameServerGroupTag>: A list of labels to assign to the new game server group resource.
vpcSubnets List<String>: A list of virtual private cloud (VPC) subnets to use with instances in the game server group.

autoScalingGroupArn string: A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.
autoScalingPolicy GameServerGroupAutoScalingPolicy: Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting
balancingStrategy GameServerGroupBalancingStrategy: 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.
gameServerGroupArn string: A generated unique ID for the game server group.
gameServerGroupName string: An identifier for the new game server group.
gameServerProtectionPolicy GameServerGroupGameServerProtectionPolicy: A flag that indicates whether instances in the game server group are protected from early termination.
instanceDefinitions GameServerGroupInstanceDefinition[]: A set of EC2 instance types to use when creating instances in the group.
launchTemplate GameServerGroupLaunchTemplate: The EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group.
maxSize number: The maximum number of instances allowed in the EC2 Auto Scaling group.
minSize number: The minimum number of instances allowed in the EC2 Auto Scaling group.
roleArn string: The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.
tags GameServerGroupTag[]: A list of labels to assign to the new game server group resource.
vpcSubnets string[]: A list of virtual private cloud (VPC) subnets to use with instances in the game server group.

auto_scaling_group_arn str: A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.
auto_scaling_policy GameServerGroupAutoScalingPolicy: Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting
balancing_strategy GameServerGroupBalancingStrategy: 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_group_arn str: A generated unique ID for the game server group.
game_server_group_name str: An identifier for the new game server group.
game_server_protection_policy GameServerGroupGameServerProtectionPolicy: A flag that indicates whether instances in the game server group are protected from early termination.
instance_definitions Sequence[GameServerGroupInstanceDefinition]: A set of EC2 instance types to use when creating instances in the group.
launch_template GameServerGroupLaunchTemplate: 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.
role_arn str: The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.
tags Sequence[GameServerGroupTag]: 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.

autoScalingGroupArn String: A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.
autoScalingPolicy Property Map: Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting
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.
gameServerGroupArn String: A generated unique ID for the game server group.
gameServerGroupName String: An identifier for the new game server group.
gameServerProtectionPolicy "NO_PROTECTION" | "FULL_PROTECTION": 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.
launchTemplate 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.
maxSize Number: The maximum number of instances allowed in the EC2 Auto Scaling group.
minSize Number: The minimum number of instances allowed in the EC2 Auto Scaling group.
roleArn String: The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.
tags List<Property Map>: A list of labels to assign to the new game server group resource.
vpcSubnets List<String>: A list of virtual private cloud (VPC) subnets to use with instances in the game server group.

Supporting Types

GameServerGroupAutoScalingPolicy

TargetTrackingConfiguration Pulumi.AwsNative.GameLift.Inputs.GameServerGroupTargetTrackingConfiguration
EstimatedInstanceWarmup double

TargetTrackingConfiguration GameServerGroupTargetTrackingConfiguration
EstimatedInstanceWarmup float64

targetTrackingConfiguration GameServerGroupTargetTrackingConfiguration
estimatedInstanceWarmup Double

targetTrackingConfiguration GameServerGroupTargetTrackingConfiguration
estimatedInstanceWarmup number

target_tracking_configuration GameServerGroupTargetTrackingConfiguration
estimated_instance_warmup float

targetTrackingConfiguration Property Map
estimatedInstanceWarmup Number

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

GameServerGroupLaunchTemplate

LaunchTemplateId string
LaunchTemplateName string
Version string

LaunchTemplateId string
LaunchTemplateName string
Version string

launchTemplateId String
launchTemplateName String
version String

launchTemplateId string
launchTemplateName string
version string

launch_template_id str
launch_template_name str
version str

launchTemplateId String
launchTemplateName String
version String

GameServerGroupTag

Key string: The key for a developer-defined key:value pair for tagging an AWS resource.
Value string: The value for a developer-defined key:value pair for tagging an AWS resource.

Key string: The key for a developer-defined key:value pair for tagging an AWS resource.
Value string: The value for a developer-defined key:value pair for tagging an AWS resource.

key String: The key for a developer-defined key:value pair for tagging an AWS resource.
value String: The value for a developer-defined key:value pair for tagging an AWS resource.

key string: The key for a developer-defined key:value pair for tagging an AWS resource.
value string: The value for a developer-defined key:value pair for tagging an AWS resource.

key str: The key for a developer-defined key:value pair for tagging an AWS resource.
value str: The value for a developer-defined key:value pair for tagging an AWS resource.

key String: The key for a developer-defined key:value pair for tagging an AWS resource.
value String: The value for a developer-defined key:value pair for tagging an AWS resource.