1. Packages
  2. AWS Native
  3. API Docs
  4. gamelift
  5. getGameServerGroup

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.97.0 published on Wednesday, Feb 21, 2024 by Pulumi

aws-native.gamelift.getGameServerGroup

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.97.0 published on Wednesday, Feb 21, 2024 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)
    // 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.
    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.
    RoleArn string
    The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.
    AutoScalingGroupArn string
    A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.
    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.
    RoleArn string
    The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.
    autoScalingGroupArn String
    A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.
    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.
    roleArn String
    The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.
    autoScalingGroupArn string
    A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.
    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.
    roleArn string
    The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.
    auto_scaling_group_arn str
    A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.
    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.
    role_arn str
    The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.
    autoScalingGroupArn String
    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.
    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.
    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

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.97.0 published on Wednesday, Feb 21, 2024 by Pulumi