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

Class GameServerGroupProps.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.gamelift.alpha.GameServerGroupProps.Jsii$Proxy
All Implemented Interfaces:
GameServerGroupProps, software.amazon.jsii.JsiiSerializable
Enclosing interface:
GameServerGroupProps
@Stability(Experimental) @Internal public static final class GameServerGroupProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements GameServerGroupProps
An implementation for GameServerGroupProps

  • Nested Class Summary

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

    Nested classes/interfaces inherited from interface software.amazon.awscdk.services.gamelift.alpha.GameServerGroupProps

    GameServerGroupProps.Builder, GameServerGroupProps.Jsii$Proxy

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Jsii$Proxy(GameServerGroupProps.Builder builder)
    Constructor that initializes the object based on literal property values passed by the GameServerGroupProps.Builder.
    protected
    Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
    Constructor that initializes the object based on values retrieved from the JsiiObject.

  • Method Summary

    Modifier and Type
    Method
    Description
    com.fasterxml.jackson.databind.JsonNode
    $jsii$toJson()
     
    final boolean
    equals(Object o)
     
    final AutoScalingPolicy
    getAutoScalingPolicy()
    (experimental) Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting.
    final BalancingStrategy
    getBalancingStrategy()
    (experimental) Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group.
    final DeleteOption
    getDeleteOption()
    (experimental) The type of delete to perform.
    final String
    getGameServerGroupName()
    (experimental) A developer-defined identifier for the game server group.
    final List<InstanceDefinition>
    getInstanceDefinitions()
    (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.
    final ILaunchTemplate
    getLaunchTemplate()
    (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.
    final Number
    getMaxSize()
    (experimental) The maximum number of instances allowed in the Amazon EC2 Auto Scaling group.
    final Number
    getMinSize()
    (experimental) The minimum number of instances allowed in the Amazon EC2 Auto Scaling group.
    final Boolean
    getProtectGameServer()
    (experimental) A flag that indicates whether instances in the game server group are protected from early termination.
    final IRole
    getRole()
    (experimental) The IAM role that allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups.
    final IVpc
    getVpc()
    (experimental) The VPC network to place the game server group in.
    final SubnetSelection
    getVpcSubnets()
    (experimental) Game server group subnet selection.
    final int
    hashCode()
     

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • Jsii$Proxy

      protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
      Constructor that initializes the object based on values retrieved from the JsiiObject.
      Parameters:
      objRef - Reference to the JSII managed object.

    • Jsii$Proxy

      protected Jsii$Proxy(GameServerGroupProps.Builder builder)
      Constructor that initializes the object based on literal property values passed by the GameServerGroupProps.Builder.

  • Method Details

    • getGameServerGroupName

      public final String getGameServerGroupName()
      Description copied from interface: GameServerGroupProps
      (experimental) A developer-defined identifier for the game server group.

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

      Specified by:
      getGameServerGroupName in interface GameServerGroupProps

    • getInstanceDefinitions

      public final List<InstanceDefinition> getInstanceDefinitions()
      Description copied from interface: GameServerGroupProps
      (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.
      Specified by:
      getInstanceDefinitions in interface GameServerGroupProps

    • getLaunchTemplate

      public final ILaunchTemplate getLaunchTemplate()
      Description copied from interface: GameServerGroupProps
      (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.

      Specified by:
      getLaunchTemplate in interface GameServerGroupProps
      See Also:

    • getVpc

      public final IVpc getVpc()
      Description copied from interface: GameServerGroupProps
      (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.

      Specified by:
      getVpc in interface GameServerGroupProps

    • getAutoScalingPolicy

      public final AutoScalingPolicy getAutoScalingPolicy()
      Description copied from interface: GameServerGroupProps
      (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

      Specified by:
      getAutoScalingPolicy in interface GameServerGroupProps

    • getBalancingStrategy

      public final BalancingStrategy getBalancingStrategy()
      Description copied from interface: GameServerGroupProps
      (experimental) Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group.

      Default: SPOT_PREFERRED

      Specified by:
      getBalancingStrategy in interface GameServerGroupProps

    • getDeleteOption

      public final DeleteOption getDeleteOption()
      Description copied from interface: GameServerGroupProps
      (experimental) The type of delete to perform.

      To delete a game server group, specify the DeleteOption

      Default: SAFE_DELETE

      Specified by:
      getDeleteOption in interface GameServerGroupProps

    • getMaxSize

      public final Number getMaxSize()
      Description copied from interface: GameServerGroupProps
      (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

      Specified by:
      getMaxSize in interface GameServerGroupProps

    • getMinSize

      public final Number getMinSize()
      Description copied from interface: GameServerGroupProps
      (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

      Specified by:
      getMinSize in interface GameServerGroupProps

    • getProtectGameServer

      public final Boolean getProtectGameServer()
      Description copied from interface: GameServerGroupProps
      (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

      Specified by:
      getProtectGameServer in interface GameServerGroupProps

    • getRole

      public final IRole getRole()
      Description copied from interface: GameServerGroupProps
      (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.

      Specified by:
      getRole in interface GameServerGroupProps
      See Also:

    • getVpcSubnets

      public final SubnetSelection getVpcSubnets()
      Description copied from interface: GameServerGroupProps
      (experimental) Game server group subnet selection.

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

      Specified by:
      getVpcSubnets in interface GameServerGroupProps

    • $jsii$toJson

      @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
      Specified by:
      $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

    • equals

      public final boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object