Package software.amazon.awscdk.services.gamelift

Class CfnFleetProps.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • name

      @Stability(Stable) public CfnFleetProps.Builder name(String name)
      Sets the value of CfnFleetProps.getName()
      Parameters:
      name - A descriptive label that is associated with a fleet. This parameter is required. Fleet names do not need to be unique.
      Returns:
      this

    • anywhereConfiguration

      @Stability(Stable) public CfnFleetProps.Builder anywhereConfiguration(IResolvable anywhereConfiguration)
      Sets the value of CfnFleetProps.getAnywhereConfiguration()
      Parameters:
      anywhereConfiguration - Amazon GameLift Anywhere configuration options.
      Returns:
      this

    • anywhereConfiguration

      @Stability(Stable) public CfnFleetProps.Builder anywhereConfiguration(CfnFleet.AnywhereConfigurationProperty anywhereConfiguration)
      Sets the value of CfnFleetProps.getAnywhereConfiguration()
      Parameters:
      anywhereConfiguration - Amazon GameLift Anywhere configuration options.
      Returns:
      this

    • applyCapacity

      @Stability(Stable) public CfnFleetProps.Builder applyCapacity(String applyCapacity)
      Sets the value of CfnFleetProps.getApplyCapacity()
      Parameters:
      applyCapacity - Current resource capacity settings for managed EC2 fleets and managed container fleets. For multi-location fleets, location values might refer to a fleet's remote location or its home Region.

      Returned by: DescribeFleetCapacity , DescribeFleetLocationCapacity , UpdateFleetCapacity

      Returns:
      this

    • buildId

      @Stability(Stable) public CfnFleetProps.Builder buildId(String buildId)
      Sets the value of CfnFleetProps.getBuildId()
      Parameters:
      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.
      Returns:
      this

    • certificateConfiguration

      @Stability(Stable) public CfnFleetProps.Builder certificateConfiguration(IResolvable certificateConfiguration)
      Sets the value of CfnFleetProps.getCertificateConfiguration()
      Parameters:
      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 .

      Returns:
      this

    • certificateConfiguration

      @Stability(Stable) public CfnFleetProps.Builder certificateConfiguration(CfnFleet.CertificateConfigurationProperty certificateConfiguration)
      Sets the value of CfnFleetProps.getCertificateConfiguration()
      Parameters:
      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 .

      Returns:
      this

    • computeType

      @Stability(Stable) public CfnFleetProps.Builder computeType(String computeType)
      Sets the value of CfnFleetProps.getComputeType()
      Parameters:
      computeType - The type of compute resource used to host your game servers.
      • EC2 – The game server build is deployed to Amazon EC2 instances for cloud hosting. This is the default setting.
      • ANYWHERE – Game servers and supporting software are deployed to compute resources that you provide and manage. With this compute type, you can also set the AnywhereConfiguration parameter.
      Returns:
      this

    • description

      @Stability(Stable) public CfnFleetProps.Builder description(String description)
      Sets the value of CfnFleetProps.getDescription()
      Parameters:
      description - A description for the fleet.
      Returns:
      this

    • desiredEc2Instances

      @Stability(Stable) public CfnFleetProps.Builder desiredEc2Instances(Number desiredEc2Instances)
      Sets the value of CfnFleetProps.getDesiredEc2Instances()
      Parameters:
      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.
      Returns:
      this

    • ec2InboundPermissions

      @Stability(Stable) public CfnFleetProps.Builder ec2InboundPermissions(IResolvable ec2InboundPermissions)
      Sets the value of CfnFleetProps.getEc2InboundPermissions()
      Parameters:
      ec2InboundPermissions - The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet. Set this parameter for managed EC2 fleets. You can leave this parameter empty when creating the fleet, but you must call to set it before players can connect to game sessions. As a best practice, we recommend opening ports for remote access only when you need them and closing them when you're finished. For Realtime Servers fleets, Amazon GameLift automatically sets TCP and UDP ranges.
      Returns:
      this

    • ec2InboundPermissions

      @Stability(Stable) public CfnFleetProps.Builder ec2InboundPermissions(List<? extends Object> ec2InboundPermissions)
      Sets the value of CfnFleetProps.getEc2InboundPermissions()
      Parameters:
      ec2InboundPermissions - The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet. Set this parameter for managed EC2 fleets. You can leave this parameter empty when creating the fleet, but you must call to set it before players can connect to game sessions. As a best practice, we recommend opening ports for remote access only when you need them and closing them when you're finished. For Realtime Servers fleets, Amazon GameLift automatically sets TCP and UDP ranges.
      Returns:
      this

    • ec2InstanceType

      @Stability(Stable) public CfnFleetProps.Builder ec2InstanceType(String ec2InstanceType)
      Sets the value of CfnFleetProps.getEc2InstanceType()
      Parameters:
      ec2InstanceType - The Amazon GameLift-supported Amazon EC2 instance type to use with managed EC2 fleets. 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.
      Returns:
      this

    • fleetType

      @Stability(Stable) public CfnFleetProps.Builder fleetType(String fleetType)
      Sets the value of CfnFleetProps.getFleetType()
      Parameters:
      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 fleet property can't be changed after the fleet is created.
      Returns:
      this

    • instanceRoleArn

      @Stability(Stable) public CfnFleetProps.Builder instanceRoleArn(String instanceRoleArn)
      Sets the value of CfnFleetProps.getInstanceRoleArn()
      Parameters:
      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 attribute is used with fleets where ComputeType is EC2 .
      Returns:
      this

    • instanceRoleCredentialsProvider

      @Stability(Stable) public CfnFleetProps.Builder instanceRoleCredentialsProvider(String instanceRoleCredentialsProvider)
      Sets the value of CfnFleetProps.getInstanceRoleCredentialsProvider()
      Parameters:
      instanceRoleCredentialsProvider - Indicates that fleet instances maintain a shared credentials file for the IAM role defined in InstanceRoleArn . Shared credentials allow applications that are deployed with the game server executable to communicate with other AWS resources. This property is used only when the game server is integrated with the server SDK version 5.x. For more information about using shared credentials, see Communicate with other AWS resources from your fleets . This attribute is used with fleets where ComputeType is EC2 .
      Returns:
      this

    • locations

      @Stability(Stable) public CfnFleetProps.Builder locations(IResolvable locations)
      Sets the value of CfnFleetProps.getLocations()
      Parameters:
      locations - A set of remote locations to deploy additional instances to and manage as a multi-location fleet. Use this parameter when creating a fleet in AWS Regions that support multiple locations. You can add any AWS Region or Local Zone that's supported by Amazon GameLift. Provide a list of one or more AWS Region codes, such as us-west-2 , or Local Zone names. When using this parameter, Amazon GameLift requires you to include your home location in the request. For a list of supported Regions and Local Zones, see Amazon GameLift service locations for managed hosting.
      Returns:
      this

    • locations

      @Stability(Stable) public CfnFleetProps.Builder locations(List<? extends Object> locations)
      Sets the value of CfnFleetProps.getLocations()
      Parameters:
      locations - A set of remote locations to deploy additional instances to and manage as a multi-location fleet. Use this parameter when creating a fleet in AWS Regions that support multiple locations. You can add any AWS Region or Local Zone that's supported by Amazon GameLift. Provide a list of one or more AWS Region codes, such as us-west-2 , or Local Zone names. When using this parameter, Amazon GameLift requires you to include your home location in the request. For a list of supported Regions and Local Zones, see Amazon GameLift service locations for managed hosting.
      Returns:
      this

    • logPaths

      @Stability(Deprecated) @Deprecated public CfnFleetProps.Builder logPaths(List<String> logPaths)
      Deprecated.
      this property has been deprecated
      Sets the value of CfnFleetProps.getLogPaths()
      Parameters:
      logPaths - This parameter is no longer used. When hosting a custom game build, specify where Amazon GameLift should store log files using the Amazon GameLift server API call ProcessReady()
      Returns:
      this

    • maxSize

      @Stability(Stable) public CfnFleetProps.Builder maxSize(Number maxSize)
      Sets the value of CfnFleetProps.getMaxSize()
      Parameters:
      maxSize - The maximum number of instances that are allowed in the specified fleet location. If this parameter is not set, the default is 1.
      Returns:
      this

    • metricGroups

      @Stability(Stable) public CfnFleetProps.Builder metricGroups(List<String> metricGroups)
      Sets the value of CfnFleetProps.getMetricGroups()
      Parameters:
      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.
      Returns:
      this

    • minSize

      @Stability(Stable) public CfnFleetProps.Builder minSize(Number minSize)
      Sets the value of CfnFleetProps.getMinSize()
      Parameters:
      minSize - The minimum number of instances that are allowed in the specified fleet location. If this parameter is not set, the default is 0.
      Returns:
      this

    • newGameSessionProtectionPolicy

      @Stability(Stable) public CfnFleetProps.Builder newGameSessionProtectionPolicy(String newGameSessionProtectionPolicy)
      Sets the value of CfnFleetProps.getNewGameSessionProtectionPolicy()
      Parameters:
      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.
      Returns:
      this

    • peerVpcAwsAccountId

      @Stability(Stable) public CfnFleetProps.Builder peerVpcAwsAccountId(String peerVpcAwsAccountId)
      Sets the value of CfnFleetProps.getPeerVpcAwsAccountId()
      Parameters:
      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.
      Returns:
      this

    • peerVpcId

      @Stability(Stable) public CfnFleetProps.Builder peerVpcId(String peerVpcId)
      Sets the value of CfnFleetProps.getPeerVpcId()
      Parameters:
      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 .
      Returns:
      this

    • resourceCreationLimitPolicy

      @Stability(Stable) public CfnFleetProps.Builder resourceCreationLimitPolicy(IResolvable resourceCreationLimitPolicy)
      Sets the value of CfnFleetProps.getResourceCreationLimitPolicy()
      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.
      Returns:
      this

    • resourceCreationLimitPolicy

      @Stability(Stable) public CfnFleetProps.Builder resourceCreationLimitPolicy(CfnFleet.ResourceCreationLimitPolicyProperty resourceCreationLimitPolicy)
      Sets the value of CfnFleetProps.getResourceCreationLimitPolicy()
      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.
      Returns:
      this

    • runtimeConfiguration

      @Stability(Stable) public CfnFleetProps.Builder runtimeConfiguration(IResolvable runtimeConfiguration)
      Sets the value of CfnFleetProps.getRuntimeConfiguration()
      Parameters:
      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.

      Returns:
      this

    • runtimeConfiguration

      @Stability(Stable) public CfnFleetProps.Builder runtimeConfiguration(CfnFleet.RuntimeConfigurationProperty runtimeConfiguration)
      Sets the value of CfnFleetProps.getRuntimeConfiguration()
      Parameters:
      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.

      Returns:
      this

    • scalingPolicies

      @Stability(Stable) public CfnFleetProps.Builder scalingPolicies(IResolvable scalingPolicies)
      Sets the value of CfnFleetProps.getScalingPolicies()
      Parameters:
      scalingPolicies - Rule that controls how a fleet is scaled. Scaling policies are uniquely identified by the combination of name and fleet ID.
      Returns:
      this

    • scalingPolicies

      @Stability(Stable) public CfnFleetProps.Builder scalingPolicies(List<? extends Object> scalingPolicies)
      Sets the value of CfnFleetProps.getScalingPolicies()
      Parameters:
      scalingPolicies - Rule that controls how a fleet is scaled. Scaling policies are uniquely identified by the combination of name and fleet ID.
      Returns:
      this

    • scriptId

      @Stability(Stable) public CfnFleetProps.Builder scriptId(String scriptId)
      Sets the value of CfnFleetProps.getScriptId()
      Parameters:
      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.

      Returns:
      this

    • serverLaunchParameters

      @Stability(Deprecated) @Deprecated public CfnFleetProps.Builder serverLaunchParameters(String serverLaunchParameters)
      Deprecated.
      this property has been deprecated
      Sets the value of CfnFleetProps.getServerLaunchParameters()
      Parameters:
      serverLaunchParameters - This parameter is no longer used but is retained for backward compatibility. Instead, specify server launch parameters in the RuntimeConfiguration parameter. A request must specify either a runtime configuration or values for both ServerLaunchParameters and ServerLaunchPath.
      Returns:
      this

    • serverLaunchPath

      @Stability(Deprecated) @Deprecated public CfnFleetProps.Builder serverLaunchPath(String serverLaunchPath)
      Deprecated.
      this property has been deprecated
      Sets the value of CfnFleetProps.getServerLaunchPath()
      Parameters:
      serverLaunchPath - This parameter is no longer used. Instead, specify a server launch path using the RuntimeConfiguration parameter. Requests that specify a server launch path and launch parameters instead of a runtime configuration will continue to work.
      Returns:
      this

    • build

      @Stability(Stable) public CfnFleetProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnFleetProps>
      Returns:
      a new instance of CfnFleetProps
      Throws:
      NullPointerException - if any required attribute was not provided