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

Class FleetProps.Jsii$Proxy

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

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

    FleetProps.Builder, FleetProps.Jsii$Proxy

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Jsii$Proxy(FleetProps.Builder builder)
    Constructor that initializes the object based on literal property values passed by the FleetProps.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 String
    getDescription()
    (experimental) A human-readable description of the fleet.
    final Number
    getDesiredCapacity()
    (experimental) The number of EC2 instances that you want this fleet to host.
    final String
    getFleetName()
    (experimental) A descriptive label that is associated with a fleet.
    final InstanceType
    getInstanceType()
    (experimental) The GameLift-supported Amazon EC2 instance type to use for all fleet instances.
    final List<Location>
    getLocations()
    (experimental) A set of remote locations to deploy additional instances to and manage as part of the fleet.
    final Number
    getMaxSize()
    (experimental) The maximum number of instances that are allowed in the specified fleet location.
    final String
    getMetricGroup()
    (experimental) The name of an AWS CloudWatch metric group to add this fleet to.
    final Number
    getMinSize()
    (experimental) The minimum number of instances that are allowed in the specified fleet location.
    final IVpc
    getPeerVpc()
    (experimental) A VPC peering connection between your GameLift-hosted game servers and your other non-GameLift resources.
    final Boolean
    getProtectNewGameSession()
    (experimental) The status of termination protection for active game sessions on the fleet.
    final ResourceCreationLimitPolicy
    getResourceCreationLimitPolicy()
    (experimental) A policy that limits the number of game sessions that an individual player can create on instances in this fleet within a specified span of time.
    final IRole
    getRole()
    (experimental) The IAM role assumed by GameLift fleet instances to access AWS ressources.
    final RuntimeConfiguration
    getRuntimeConfiguration()
    (experimental) A collection of server process configurations that describe the set of processes to run on each instance in a fleet.
    final Boolean
    getUseCertificate()
    (experimental) Prompts GameLift to generate a TLS/SSL certificate for the fleet.
    final Boolean
    getUseSpot()
    (experimental) Indicates whether to use On-Demand or Spot instances for this fleet.
    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(FleetProps.Builder builder)
      Constructor that initializes the object based on literal property values passed by the FleetProps.Builder.

  • Method Details

    • getFleetName

      public final String getFleetName()
      Description copied from interface: FleetProps
      (experimental) A descriptive label that is associated with a fleet.

      Fleet names do not need to be unique.

      Specified by:
      getFleetName in interface FleetProps

    • getInstanceType

      public final InstanceType getInstanceType()
      Description copied from interface: FleetProps
      (experimental) The GameLift-supported Amazon EC2 instance type to use for all fleet instances.

      Instance type determines the computing resources that will be used to host your game servers, including CPU, memory, storage, and networking capacity.

      Specified by:
      getInstanceType in interface FleetProps
      See Also:

    • getRuntimeConfiguration

      public final RuntimeConfiguration getRuntimeConfiguration()
      Description copied from interface: FleetProps
      (experimental) A collection of server process configurations that describe the set of processes to run on each instance in a fleet.

      Server processes run either an executable in a custom game build or a Realtime Servers script. GameLift launches the configured processes, manages their life cycle, and replaces them as needed. Each instance checks regularly for an updated runtime configuration.

      A GameLift instance is limited to 50 processes running concurrently. To calculate the total number of processes in a runtime configuration, add the values of the ConcurrentExecutions parameter for each ServerProcess.

      Specified by:
      getRuntimeConfiguration in interface FleetProps
      See Also:

    • getDescription

      public final String getDescription()
      Description copied from interface: FleetProps
      (experimental) A human-readable description of the fleet.

      Default: no description is provided

      Specified by:
      getDescription in interface FleetProps

    • getDesiredCapacity

      public final Number getDesiredCapacity()
      Description copied from interface: FleetProps
      (experimental) The number of EC2 instances that you want this fleet to host.

      When creating a new fleet, GameLift automatically sets this value to "1" and initiates a single instance. Once the fleet is active, update this value to trigger GameLift to add or remove instances from the fleet.

      Default: Default capacity is 0

      Specified by:
      getDesiredCapacity in interface FleetProps

    • getLocations

      public final List<Location> getLocations()
      Description copied from interface: FleetProps
      (experimental) A set of remote locations to deploy additional instances to and manage as part of the fleet.

      This parameter can only be used when creating fleets in AWS Regions that support multiple locations. You can add any GameLift-supported AWS Region as a remote location, in the form of an AWS Region code such as us-west-2. To create a fleet with instances in the home region only, omit this parameter.

      Default: Create a fleet with instances in the home region only

      Specified by:
      getLocations in interface FleetProps

    • getMaxSize

      public final Number getMaxSize()
      Description copied from interface: FleetProps
      (experimental) The maximum number of instances that are allowed in the specified fleet location.

      Default: the default is 1

      Specified by:
      getMaxSize in interface FleetProps

    • getMetricGroup

      public final String getMetricGroup()
      Description copied from interface: FleetProps
      (experimental) The name of an AWS CloudWatch metric group to add this fleet to.

      A metric group is used to aggregate the metrics for multiple fleets. You can specify an existing metric group name or set a new name to create a new metric group. A fleet can be included in only one metric group at a time.

      Default: Fleet metrics are aggregated with other fleets in the default metric group

      Specified by:
      getMetricGroup in interface FleetProps

    • getMinSize

      public final Number getMinSize()
      Description copied from interface: FleetProps
      (experimental) The minimum number of instances that are allowed in the specified fleet location.

      Default: the default is 0

      Specified by:
      getMinSize in interface FleetProps

    • getPeerVpc

      public final IVpc getPeerVpc()
      Description copied from interface: FleetProps
      (experimental) A VPC peering connection between your GameLift-hosted game servers and your other non-GameLift resources.

      Use Amazon Virtual Private Cloud (VPC) peering connections to enable your game servers to communicate directly and privately with your other AWS resources, such as a web service or a repository. You can establish VPC peering with any resources that run on AWS and are managed by an AWS account that you have access to. The VPC must be in the same Region as your fleet.

      Warning: Be sure to create a VPC Peering authorization through Gamelift Service API.

      Default: no vpc peering

      Specified by:
      getPeerVpc in interface FleetProps
      See Also:

    • getProtectNewGameSession

      public final Boolean getProtectNewGameSession()
      Description copied from interface: FleetProps
      (experimental) The status of termination protection for active game sessions on the fleet.

      By default, new game sessions are protected and cannot be terminated during a scale-down event.

      Default: true - Game sessions in `ACTIVE` status cannot be terminated during a scale-down event.

      Specified by:
      getProtectNewGameSession in interface FleetProps

    • getResourceCreationLimitPolicy

      public final ResourceCreationLimitPolicy getResourceCreationLimitPolicy()
      Description copied from interface: FleetProps
      (experimental) A policy that limits the number of game sessions that an individual player can create on instances in this fleet within a specified span of time.

      Default: No resource creation limit policy

      Specified by:
      getResourceCreationLimitPolicy in interface FleetProps

    • getRole

      public final IRole getRole()
      Description copied from interface: FleetProps
      (experimental) The IAM role assumed by GameLift fleet instances to access AWS ressources.

      With a role set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). If providing a custom role, it needs to trust the GameLift service principal (gamelift.amazonaws.com). No permission is required by default.

      This property cannot be changed after the fleet is created.

      Default: - a role will be created with default trust to Gamelift service principal.

      Specified by:
      getRole in interface FleetProps
      See Also:

    • getUseCertificate

      public final Boolean getUseCertificate()
      Description copied from interface: FleetProps
      (experimental) Prompts GameLift to generate a TLS/SSL certificate for the fleet.

      GameLift uses the certificates to encrypt traffic between game clients and the game servers running on GameLift.

      You can't change this property after you create the fleet.

      Additionnal info: AWS Certificate Manager (ACM) certificates expire after 13 months. Certificate expiration can cause fleets to fail, preventing players from connecting to instances in the fleet. We recommend you replace fleets before 13 months, consider using fleet aliases for a smooth transition.

      Default: TLS/SSL certificate are generated for the fleet

      Specified by:
      getUseCertificate in interface FleetProps

    • getUseSpot

      public final Boolean getUseSpot()
      Description copied from interface: FleetProps
      (experimental) Indicates whether to use On-Demand or Spot instances for this fleet. By default, fleet use on demand capacity.

      This property cannot be changed after the fleet is created.

      Default: Gamelift fleet use on demand capacity

      Specified by:
      getUseSpot in interface FleetProps
      See Also:

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