Package software.amazon.awscdk.services.gamelift

Class CfnGameServerGroupProps.Jsii$Proxy

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

  • 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.CfnGameServerGroupProps

    CfnGameServerGroupProps.Builder, CfnGameServerGroupProps.Jsii$Proxy

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Jsii$Proxy(CfnGameServerGroupProps.Builder builder)
    Constructor that initializes the object based on literal property values passed by the CfnGameServerGroupProps.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 Object
    getAutoScalingPolicy()
    Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting.
    final String
    getBalancingStrategy()
    Indicates how Amazon GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group.
    final String
    getDeleteOption()
    The type of delete to perform.
    final String
    getGameServerGroupName()
    A developer-defined identifier for the game server group.
    final String
    getGameServerProtectionPolicy()
    A flag that indicates whether instances in the game server group are protected from early termination.
    final Object
    getInstanceDefinitions()
    The set of Amazon EC2 instance types that Amazon GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.
    final Object
    getLaunchTemplate()
    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()
    The maximum number of instances allowed in the Amazon EC2 Auto Scaling group.
    final Number
    getMinSize()
    The minimum number of instances allowed in the Amazon EC2 Auto Scaling group.
    final String
    getRoleArn()
    The Amazon Resource Name ( ARN ) for an IAM role that allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups.
    final List<CfnTag>
    getTags()
    A list of labels to assign to the new game server group resource.
    final List<String>
    getVpcSubnets()
    A list of virtual private cloud (VPC) subnets to use with instances in the game server group.
    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(CfnGameServerGroupProps.Builder builder)
      Constructor that initializes the object based on literal property values passed by the CfnGameServerGroupProps.Builder.

  • Method Details

    • getGameServerGroupName

      public final String getGameServerGroupName()
      Description copied from interface: CfnGameServerGroupProps
      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 CfnGameServerGroupProps

    • getInstanceDefinitions

      public final Object getInstanceDefinitions()
      Description copied from interface: CfnGameServerGroupProps
      The set of Amazon EC2 instance types that Amazon GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.
      Specified by:
      getInstanceDefinitions in interface CfnGameServerGroupProps

    • getRoleArn

      public final String getRoleArn()
      Description copied from interface: CfnGameServerGroupProps
      The Amazon Resource Name ( ARN ) for an IAM role that allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups.
      Specified by:
      getRoleArn in interface CfnGameServerGroupProps

    • getAutoScalingPolicy

      public final Object getAutoScalingPolicy()
      Description copied from interface: CfnGameServerGroupProps
      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.

      Specified by:
      getAutoScalingPolicy in interface CfnGameServerGroupProps

    • getBalancingStrategy

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

      Method options include the following:

      • SPOT_ONLY - Only Spot Instances are used in the game server group. If Spot Instances are unavailable or not viable for game hosting, the game server group provides no hosting capacity until Spot Instances can again be used. Until then, no new instances are started, and the existing nonviable Spot Instances are terminated (after current gameplay ends) and are not replaced.
      • SPOT_PREFERRED - (default value) Spot Instances are used whenever available in the game server group. If Spot Instances are unavailable, the game server group continues to provide hosting capacity by falling back to On-Demand Instances. Existing nonviable Spot Instances are terminated (after current gameplay ends) and are replaced with new On-Demand Instances.
      • ON_DEMAND_ONLY - Only On-Demand Instances are used in the game server group. No Spot Instances are used, even when available, while this balancing strategy is in force.
      Specified by:
      getBalancingStrategy in interface CfnGameServerGroupProps

    • getDeleteOption

      public final String getDeleteOption()
      Description copied from interface: CfnGameServerGroupProps
      The type of delete to perform.

      To delete a game server group, specify the DeleteOption . Options include the following:

      • SAFE_DELETE – (default) Terminates the game server group and Amazon EC2 Auto Scaling group only when it has no game servers that are in UTILIZED status.
      • FORCE_DELETE – Terminates the game server group, including all active game servers regardless of their utilization status, and the Amazon EC2 Auto Scaling group.
      • RETAIN – Does a safe delete of the game server group but retains the Amazon EC2 Auto Scaling group as is.
      Specified by:
      getDeleteOption in interface CfnGameServerGroupProps

    • getGameServerProtectionPolicy

      public final String getGameServerProtectionPolicy()
      Description copied from interface: CfnGameServerGroupProps
      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 (see ). An exception to this is with Spot Instances, which can be terminated by AWS regardless of protection status.

      Specified by:
      getGameServerProtectionPolicy in interface CfnGameServerGroupProps

    • getLaunchTemplate

      public final Object getLaunchTemplate()
      Description copied from interface: CfnGameServerGroupProps
      The Amazon EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group.

      You can specify the template using either the template name or ID. For help with creating a launch template, see Creating a Launch Template for an Auto Scaling Group in the Amazon Elastic Compute Cloud Auto Scaling User Guide . After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs.

      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, Amazon GameLift FleetIQ uses your account's default VPC.

      Specified by:
      getLaunchTemplate in interface CfnGameServerGroupProps

    • getMaxSize

      public final Number getMaxSize()
      Description copied from interface: CfnGameServerGroupProps
      The maximum number of instances allowed in the Amazon EC2 Auto Scaling group.

      During automatic scaling events, Amazon 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.

      Specified by:
      getMaxSize in interface CfnGameServerGroupProps

    • getMinSize

      public final Number getMinSize()
      Description copied from interface: CfnGameServerGroupProps
      The minimum number of instances allowed in the Amazon EC2 Auto Scaling group.

      During automatic scaling events, Amazon 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.

      Specified by:
      getMinSize in interface CfnGameServerGroupProps

    • getTags

      public final List<CfnTag> getTags()
      Description copied from interface: CfnGameServerGroupProps
      A list of labels to assign to the new game server group resource.

      Tags are developer-defined key-value pairs. Tagging AWS resources is useful for resource management, access management, and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference . Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags, respectively. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

      Specified by:
      getTags in interface CfnGameServerGroupProps

    • getVpcSubnets

      public final List<String> getVpcSubnets()
      Description copied from interface: CfnGameServerGroupProps
      A list of virtual private cloud (VPC) subnets to use with instances in the game server group.

      By default, all Amazon 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:
      getVpcSubnets in interface CfnGameServerGroupProps

    • $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