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

Class BuildFleet.Builder

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

  • Method Details

    • create

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

    • fleetName

      @Stability(Experimental) public BuildFleet.Builder fleetName(String fleetName)
      (experimental) A descriptive label that is associated with a fleet.

      Fleet names do not need to be unique.

      Parameters:
      fleetName - A descriptive label that is associated with a fleet. This parameter is required.
      Returns:
      this

    • instanceType

      @Stability(Experimental) public BuildFleet.Builder instanceType(InstanceType instanceType)
      (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.

      Parameters:
      instanceType - The GameLift-supported Amazon EC2 instance type to use for all fleet instances. This parameter is required.
      Returns:
      this
      See Also:

    • runtimeConfiguration

      @Stability(Experimental) public BuildFleet.Builder runtimeConfiguration(RuntimeConfiguration runtimeConfiguration)
      (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.

      Parameters:
      runtimeConfiguration - A collection of server process configurations that describe the set of processes to run on each instance in a fleet. This parameter is required.
      Returns:
      this
      See Also:

    • description

      @Stability(Experimental) public BuildFleet.Builder description(String description)
      (experimental) A human-readable description of the fleet.

      Default: no description is provided

      Parameters:
      description - A human-readable description of the fleet. This parameter is required.
      Returns:
      this

    • desiredCapacity

      @Stability(Experimental) public BuildFleet.Builder desiredCapacity(Number desiredCapacity)
      (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

      Parameters:
      desiredCapacity - The number of EC2 instances that you want this fleet to host. This parameter is required.
      Returns:
      this

    • locations

      @Stability(Experimental) public BuildFleet.Builder locations(List<? extends Location> locations)
      (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

      Parameters:
      locations - A set of remote locations to deploy additional instances to and manage as part of the fleet. This parameter is required.
      Returns:
      this

    • maxSize

      @Stability(Experimental) public BuildFleet.Builder maxSize(Number maxSize)
      (experimental) The maximum number of instances that are allowed in the specified fleet location.

      Default: the default is 1

      Parameters:
      maxSize - The maximum number of instances that are allowed in the specified fleet location. This parameter is required.
      Returns:
      this

    • metricGroup

      @Stability(Experimental) public BuildFleet.Builder metricGroup(String metricGroup)
      (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

      Parameters:
      metricGroup - The name of an AWS CloudWatch metric group to add this fleet to. This parameter is required.
      Returns:
      this

    • minSize

      @Stability(Experimental) public BuildFleet.Builder minSize(Number minSize)
      (experimental) The minimum number of instances that are allowed in the specified fleet location.

      Default: the default is 0

      Parameters:
      minSize - The minimum number of instances that are allowed in the specified fleet location. This parameter is required.
      Returns:
      this

    • peerVpc

      @Stability(Experimental) public BuildFleet.Builder peerVpc(IVpc peerVpc)
      (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

      Parameters:
      peerVpc - A VPC peering connection between your GameLift-hosted game servers and your other non-GameLift resources. This parameter is required.
      Returns:
      this
      See Also:

    • protectNewGameSession

      @Stability(Experimental) public BuildFleet.Builder protectNewGameSession(Boolean protectNewGameSession)
      (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.

      Parameters:
      protectNewGameSession - The status of termination protection for active game sessions on the fleet. This parameter is required.
      Returns:
      this

    • resourceCreationLimitPolicy

      @Stability(Experimental) public BuildFleet.Builder resourceCreationLimitPolicy(ResourceCreationLimitPolicy resourceCreationLimitPolicy)
      (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

      Parameters:
      resourceCreationLimitPolicy - 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. This parameter is required.
      Returns:
      this

    • role

      @Stability(Experimental) public BuildFleet.Builder role(IRole role)
      (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.

      Parameters:
      role - The IAM role assumed by GameLift fleet instances to access AWS ressources. This parameter is required.
      Returns:
      this
      See Also:

    • useCertificate

      @Stability(Experimental) public BuildFleet.Builder useCertificate(Boolean useCertificate)
      (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

      Parameters:
      useCertificate - Prompts GameLift to generate a TLS/SSL certificate for the fleet. This parameter is required.
      Returns:
      this

    • useSpot

      @Stability(Experimental) public BuildFleet.Builder useSpot(Boolean useSpot)
      (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

      Parameters:
      useSpot - Indicates whether to use On-Demand or Spot instances for this fleet. By default, fleet use on demand capacity. This parameter is required.
      Returns:
      this
      See Also:

    • content

      @Stability(Experimental) public BuildFleet.Builder content(IBuild content)
      (experimental) A build to be deployed on the fleet.

      The build must have been successfully uploaded to Amazon GameLift and be in a READY status.

      This fleet setting cannot be changed once the fleet is created.

      Parameters:
      content - A build to be deployed on the fleet. This parameter is required.
      Returns:
      this

    • ingressRules

      @Stability(Experimental) public BuildFleet.Builder ingressRules(List<? extends IngressRule> ingressRules)
      (experimental) The allowed IP address ranges and port settings that allow inbound traffic to access game sessions on this fleet.

      This property must be set before players can connect to game sessions.

      Default: no inbound traffic allowed

      Parameters:
      ingressRules - The allowed IP address ranges and port settings that allow inbound traffic to access game sessions on this fleet. This parameter is required.
      Returns:
      this

    • build

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