Package software.amazon.awscdk.services.gamelift.alpha

Class GameServerGroup.Builder

java.lang.Object
software.amazon.awscdk.services.gamelift.alpha.GameServerGroup.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<GameServerGroup>
Enclosing class:
GameServerGroup
@Stability(Experimental) public static final class GameServerGroup.Builder extends Object implements software.amazon.jsii.Builder<GameServerGroup>
(experimental) A fluent builder for GameServerGroup.

  • Method Details

    • create

      @Stability(Experimental) public static GameServerGroup.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      Returns:
      a new instance of GameServerGroup.Builder.

    • gameServerGroupName

      @Stability(Experimental) public GameServerGroup.Builder gameServerGroupName(String gameServerGroupName)
      (experimental) A developer-defined identifier for the game server group.

      The name is unique for each Region in each AWS account.

      Parameters:
      gameServerGroupName - A developer-defined identifier for the game server group. This parameter is required.
      Returns:
      this

    • instanceDefinitions

      @Stability(Experimental) public GameServerGroup.Builder instanceDefinitions(List<? extends InstanceDefinition> instanceDefinitions)
      (experimental) The set of Amazon EC2 instance types that GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.

      Parameters:
      instanceDefinitions - The set of Amazon EC2 instance types that GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group. This parameter is required.
      Returns:
      this

    • launchTemplate

      @Stability(Experimental) public GameServerGroup.Builder launchTemplate(ILaunchTemplate launchTemplate)
      (experimental) The Amazon EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group.

      After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs.

      NOTE: If you specify network interfaces in your launch template, you must explicitly set the property AssociatePublicIpAddress to true. If no network interface is specified in the launch template, GameLift FleetIQ uses your account's default VPC.

      Parameters:
      launchTemplate - The Amazon EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group. This parameter is required.
      Returns:
      this
      See Also:

    • vpc

      @Stability(Experimental) public GameServerGroup.Builder vpc(IVpc vpc)
      (experimental) The VPC network to place the game server group in.

      By default, all GameLift FleetIQ-supported Availability Zones are used.

      You can use this parameter to specify VPCs that you've set up.

      This property cannot be updated after the game server group is created, and the corresponding Auto Scaling group will always use the property value that is set with this request, even if the Auto Scaling group is updated directly.

      Parameters:
      vpc - The VPC network to place the game server group in. This parameter is required.
      Returns:
      this

    • autoScalingPolicy

      @Stability(Experimental) public GameServerGroup.Builder autoScalingPolicy(AutoScalingPolicy autoScalingPolicy)
      (experimental) Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting.

      The scaling policy uses the metric PercentUtilizedGameServers to maintain a buffer of idle game servers that can immediately accommodate new games and players.

      After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs.

      Default: no autoscaling policy settled

      Parameters:
      autoScalingPolicy - Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting. This parameter is required.
      Returns:
      this

    • balancingStrategy

      @Stability(Experimental) public GameServerGroup.Builder balancingStrategy(BalancingStrategy balancingStrategy)
      (experimental) Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group.

      Default: SPOT_PREFERRED

      Parameters:
      balancingStrategy - Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group. This parameter is required.
      Returns:
      this

    • deleteOption

      @Stability(Experimental) public GameServerGroup.Builder deleteOption(DeleteOption deleteOption)
      (experimental) The type of delete to perform.

      To delete a game server group, specify the DeleteOption

      Default: SAFE_DELETE

      Parameters:
      deleteOption - The type of delete to perform. This parameter is required.
      Returns:
      this

    • maxSize

      @Stability(Experimental) public GameServerGroup.Builder maxSize(Number maxSize)
      (experimental) The maximum number of instances allowed in the Amazon EC2 Auto Scaling group.

      During automatic scaling events, GameLift FleetIQ and EC2 do not scale up the group above this maximum.

      After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs.

      Default: the default is 1

      Parameters:
      maxSize - The maximum number of instances allowed in the Amazon EC2 Auto Scaling group. This parameter is required.
      Returns:
      this

    • minSize

      @Stability(Experimental) public GameServerGroup.Builder minSize(Number minSize)
      (experimental) The minimum number of instances allowed in the Amazon EC2 Auto Scaling group.

      During automatic scaling events, GameLift FleetIQ and Amazon EC2 do not scale down the group below this minimum.

      In production, this value should be set to at least 1.

      After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs.

      Default: the default is 0

      Parameters:
      minSize - The minimum number of instances allowed in the Amazon EC2 Auto Scaling group. This parameter is required.
      Returns:
      this

    • protectGameServer

      @Stability(Experimental) public GameServerGroup.Builder protectGameServer(Boolean protectGameServer)
      (experimental) A flag that 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.

      An exception to this is with Spot Instances, which can be terminated by AWS regardless of protection status.

      Default: game servers running might be terminated during a scale-down event

      Parameters:
      protectGameServer - A flag that indicates whether instances in the game server group are protected from early termination. This parameter is required.
      Returns:
      this

    • role

      @Stability(Experimental) public GameServerGroup.Builder role(IRole role)
      (experimental) The IAM role that allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups.

      Default: - a role will be created with default trust to Gamelift and Autoscaling service principal with a default policy `GameLiftGameServerGroupPolicy` attached.

      Parameters:
      role - The IAM role that allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups. This parameter is required.
      Returns:
      this
      See Also:

    • vpcSubnets

      @Stability(Experimental) public GameServerGroup.Builder vpcSubnets(SubnetSelection vpcSubnets)
      (experimental) Game server group subnet selection.

      Default: all GameLift FleetIQ-supported Availability Zones are used.

      Parameters:
      vpcSubnets - Game server group subnet selection. This parameter is required.
      Returns:
      this

    • build

      @Stability(Experimental) public GameServerGroup build()
      Specified by:
      build in interface software.amazon.jsii.Builder<GameServerGroup>
      Returns:
      a newly built instance of GameServerGroup.