Package software.amazon.awscdk.services.gamelift

Class CfnFleet.Builder

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

  • Method Details

    • create

      @Stability(Stable) public static CfnFleet.Builder create(Construct scope, String id)
      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      Returns:
      a new instance of CfnFleet.Builder.

    • name

      @Stability(Stable) public CfnFleet.Builder name(String name)
      A descriptive label that is associated with a fleet.

      Fleet names do not need to be unique.

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

    • anywhereConfiguration

      @Stability(Stable) public CfnFleet.Builder anywhereConfiguration(IResolvable anywhereConfiguration)
      AWS::GameLift::Fleet.AnywhereConfiguration.

      Parameters:
      anywhereConfiguration - AWS::GameLift::Fleet.AnywhereConfiguration. This parameter is required.
      Returns:
      this

    • anywhereConfiguration

      @Stability(Stable) public CfnFleet.Builder anywhereConfiguration(CfnFleet.AnywhereConfigurationProperty anywhereConfiguration)
      AWS::GameLift::Fleet.AnywhereConfiguration.

      Parameters:
      anywhereConfiguration - AWS::GameLift::Fleet.AnywhereConfiguration. This parameter is required.
      Returns:
      this

    • buildId

      @Stability(Stable) public CfnFleet.Builder buildId(String buildId)
      A unique identifier for a build to be deployed on the new fleet.

      If you are deploying the fleet with a custom game build, you must specify this property. 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:
      buildId - A unique identifier for a build to be deployed on the new fleet. This parameter is required.
      Returns:
      this

    • certificateConfiguration

      @Stability(Stable) public CfnFleet.Builder certificateConfiguration(IResolvable certificateConfiguration)
      Prompts Amazon GameLift to generate a TLS/SSL certificate for the fleet.

      Amazon GameLift uses the certificates to encrypt traffic between game clients and the game servers running on Amazon GameLift. By default, the CertificateConfiguration is DISABLED . You can't change this property after you create the fleet.

      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.

      ACM isn't available in all AWS regions. A fleet creation request with certificate generation enabled in an unsupported Region, fails with a 4xx error. For more information about the supported Regions, see Supported Regions in the AWS Certificate Manager User Guide .

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

    • certificateConfiguration

      @Stability(Stable) public CfnFleet.Builder certificateConfiguration(CfnFleet.CertificateConfigurationProperty certificateConfiguration)
      Prompts Amazon GameLift to generate a TLS/SSL certificate for the fleet.

      Amazon GameLift uses the certificates to encrypt traffic between game clients and the game servers running on Amazon GameLift. By default, the CertificateConfiguration is DISABLED . You can't change this property after you create the fleet.

      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.

      ACM isn't available in all AWS regions. A fleet creation request with certificate generation enabled in an unsupported Region, fails with a 4xx error. For more information about the supported Regions, see Supported Regions in the AWS Certificate Manager User Guide .

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

    • computeType

      @Stability(Stable) public CfnFleet.Builder computeType(String computeType)
      The type of compute resource used to host your game servers.

      You can use your own compute resources with Amazon GameLift Anywhere or use Amazon EC2 instances with managed Amazon GameLift.

      Parameters:
      computeType - The type of compute resource used to host your game servers. This parameter is required.
      Returns:
      this

    • description

      @Stability(Stable) public CfnFleet.Builder description(String description)
      A description for the fleet.

      Parameters:
      description - A description for the fleet. This parameter is required.
      Returns:
      this

    • desiredEc2Instances

      @Stability(Stable) public CfnFleet.Builder desiredEc2Instances(Number desiredEc2Instances)
      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.

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

    • ec2InboundPermissions

      @Stability(Stable) public CfnFleet.Builder ec2InboundPermissions(IResolvable ec2InboundPermissions)
      The allowed IP address ranges and port settings that allow inbound traffic to access game sessions on this fleet.

      If the fleet is hosting a custom game build, this property must be set before players can connect to game sessions. For Realtime Servers fleets, Amazon GameLift automatically sets TCP and UDP ranges.

      Parameters:
      ec2InboundPermissions - 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

    • ec2InboundPermissions

      @Stability(Stable) public CfnFleet.Builder ec2InboundPermissions(List<? extends Object> ec2InboundPermissions)
      The allowed IP address ranges and port settings that allow inbound traffic to access game sessions on this fleet.

      If the fleet is hosting a custom game build, this property must be set before players can connect to game sessions. For Realtime Servers fleets, Amazon GameLift automatically sets TCP and UDP ranges.

      Parameters:
      ec2InboundPermissions - 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

    • ec2InstanceType

      @Stability(Stable) public CfnFleet.Builder ec2InstanceType(String ec2InstanceType)
      The Amazon 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. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions of Amazon EC2 instance types.

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

    • fleetType

      @Stability(Stable) public CfnFleet.Builder fleetType(String fleetType)
      Indicates whether to use On-Demand or Spot instances for this fleet.

      By default, this property is set to ON_DEMAND . Learn more about when to use On-Demand versus Spot Instances . This property cannot be changed after the fleet is created.

      Parameters:
      fleetType - Indicates whether to use On-Demand or Spot instances for this fleet. This parameter is required.
      Returns:
      this

    • instanceRoleArn

      @Stability(Stable) public CfnFleet.Builder instanceRoleArn(String instanceRoleArn)
      A unique identifier for an IAM role that manages access to your AWS services.

      With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). Create a role or look up a role's ARN by using the IAM dashboard in the AWS Management Console . Learn more about using on-box credentials for your game servers at Access external resources from a game server . This property cannot be changed after the fleet is created.

      Parameters:
      instanceRoleArn - A unique identifier for an IAM role that manages access to your AWS services. This parameter is required.
      Returns:
      this

    • locations

      @Stability(Stable) public CfnFleet.Builder locations(IResolvable locations)
      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 Amazon 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, don't use this parameter.

      To use this parameter, Amazon GameLift requires you to use your home location in the request.

      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

    • locations

      @Stability(Stable) public CfnFleet.Builder locations(List<? extends Object> locations)
      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 Amazon 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, don't use this parameter.

      To use this parameter, Amazon GameLift requires you to use your home location in the request.

      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(Stable) public CfnFleet.Builder maxSize(Number maxSize)
      The maximum number of instances that are allowed in the specified fleet location.

      If this parameter is not set, 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

    • metricGroups

      @Stability(Stable) public CfnFleet.Builder metricGroups(List<String> metricGroups)
      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.

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

    • minSize

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

      If this parameter is not set, 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

    • newGameSessionProtectionPolicy

      @Stability(Stable) public CfnFleet.Builder newGameSessionProtectionPolicy(String newGameSessionProtectionPolicy)
      The status of termination protection for active game sessions on the fleet.

      By default, this property is set to NoProtection .

      • NoProtection - Game sessions can be terminated during active gameplay as a result of a scale-down event.
      • FullProtection - Game sessions in ACTIVE status cannot be terminated during a scale-down event.

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

    • peerVpcAwsAccountId

      @Stability(Stable) public CfnFleet.Builder peerVpcAwsAccountId(String peerVpcAwsAccountId)
      Used when peering your Amazon GameLift fleet with a VPC, the unique identifier for the AWS account that owns the VPC.

      You can find your account ID in the AWS Management Console under account settings.

      Parameters:
      peerVpcAwsAccountId - Used when peering your Amazon GameLift fleet with a VPC, the unique identifier for the AWS account that owns the VPC. This parameter is required.
      Returns:
      this

    • peerVpcId

      @Stability(Stable) public CfnFleet.Builder peerVpcId(String peerVpcId)
      A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet.

      The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the AWS Management Console . Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets .

      Parameters:
      peerVpcId - A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. This parameter is required.
      Returns:
      this

    • resourceCreationLimitPolicy

      @Stability(Stable) public CfnFleet.Builder resourceCreationLimitPolicy(IResolvable 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.

      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

    • resourceCreationLimitPolicy

      @Stability(Stable) public CfnFleet.Builder resourceCreationLimitPolicy(CfnFleet.ResourceCreationLimitPolicyProperty 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.

      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

    • runtimeConfiguration

      @Stability(Stable) public CfnFleet.Builder runtimeConfiguration(IResolvable runtimeConfiguration)
      Instructions for how to launch and maintain server processes on instances in the fleet.

      The runtime configuration defines one or more server process configurations, each identifying a build executable or Realtime script file and the number of processes of that type to run concurrently.

      The RuntimeConfiguration parameter is required unless the fleet is being configured using the older parameters ServerLaunchPath and ServerLaunchParameters , which are still supported for backward compatibility.

      Parameters:
      runtimeConfiguration - Instructions for how to launch and maintain server processes on instances in the fleet. This parameter is required.
      Returns:
      this

    • runtimeConfiguration

      @Stability(Stable) public CfnFleet.Builder runtimeConfiguration(CfnFleet.RuntimeConfigurationProperty runtimeConfiguration)
      Instructions for how to launch and maintain server processes on instances in the fleet.

      The runtime configuration defines one or more server process configurations, each identifying a build executable or Realtime script file and the number of processes of that type to run concurrently.

      The RuntimeConfiguration parameter is required unless the fleet is being configured using the older parameters ServerLaunchPath and ServerLaunchParameters , which are still supported for backward compatibility.

      Parameters:
      runtimeConfiguration - Instructions for how to launch and maintain server processes on instances in the fleet. This parameter is required.
      Returns:
      this

    • scriptId

      @Stability(Stable) public CfnFleet.Builder scriptId(String scriptId)
      The unique identifier for a Realtime configuration script to be deployed on fleet instances.

      You can use either the script ID or ARN. Scripts must be uploaded to Amazon GameLift prior to creating the fleet. This fleet property cannot be changed later.

      You can't use the !Ref command to reference a script created with a CloudFormation template for the fleet property ScriptId . Instead, use Fn::GetAtt Script.Arn or Fn::GetAtt Script.Id to retrieve either of these properties as input for ScriptId . Alternatively, enter a ScriptId string manually.

      Parameters:
      scriptId - The unique identifier for a Realtime configuration script to be deployed on fleet instances. This parameter is required.
      Returns:
      this

    • build

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