Package software.amazon.awssdk.services.gamelift.model

Interface CreateFleetRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateFleetRequest.Builder,CreateFleetRequest>, GameLiftRequest.Builder, SdkBuilder<CreateFleetRequest.Builder,CreateFleetRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateFleetRequest
public static interface CreateFleetRequest.Builder extends GameLiftRequest.Builder, SdkPojo, CopyableBuilder<CreateFleetRequest.Builder,CreateFleetRequest>

  • Method Details

    • name

      CreateFleetRequest.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. Fleet names do not need to be unique.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      CreateFleetRequest.Builder description(String description)

      A description for the fleet.

      Parameters:
      description - A description for the fleet.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • buildId

      CreateFleetRequest.Builder buildId(String buildId)

      The unique identifier for a custom game server build to be deployed to a fleet with compute type EC2. You can use either the build ID or ARN. The build must be uploaded to Amazon GameLift and in READY status. This fleet property can't be changed after the fleet is created.

      Parameters:
      buildId - The unique identifier for a custom game server build to be deployed to a fleet with compute type EC2. You can use either the build ID or ARN. The build must be uploaded to Amazon GameLift and in READY status. This fleet property can't be changed after the fleet is created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scriptId

      CreateFleetRequest.Builder scriptId(String scriptId)

      The unique identifier for a Realtime configuration script to be deployed to a fleet with compute type EC2. You can use either the script ID or ARN. Scripts must be uploaded to Amazon GameLift prior to creating the fleet. This fleet property can't be changed after the fleet is created.

      Parameters:
      scriptId - The unique identifier for a Realtime configuration script to be deployed to a fleet with compute type EC2. You can use either the script ID or ARN. Scripts must be uploaded to Amazon GameLift prior to creating the fleet. This fleet property can't be changed after the fleet is created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • serverLaunchPath

      CreateFleetRequest.Builder serverLaunchPath(String serverLaunchPath)

      This parameter is no longer used. Specify a server launch path using the RuntimeConfiguration parameter. Requests that use this parameter instead continue to be valid.

      Parameters:
      serverLaunchPath - This parameter is no longer used. Specify a server launch path using the RuntimeConfiguration parameter. Requests that use this parameter instead continue to be valid.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • serverLaunchParameters

      CreateFleetRequest.Builder serverLaunchParameters(String serverLaunchParameters)

      This parameter is no longer used. Specify server launch parameters using the RuntimeConfiguration parameter. Requests that use this parameter instead continue to be valid.

      Parameters:
      serverLaunchParameters - This parameter is no longer used. Specify server launch parameters using the RuntimeConfiguration parameter. Requests that use this parameter instead continue to be valid.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • logPaths

      CreateFleetRequest.Builder logPaths(Collection<String> logPaths)

      This parameter is no longer used. To specify where Amazon GameLift should store log files once a server process shuts down, use the Amazon GameLift server API ProcessReady() and specify one or more directory paths in logParameters. For more information, see Initialize the server process in the Amazon GameLift Developer Guide.

      Parameters:
      logPaths - This parameter is no longer used. To specify where Amazon GameLift should store log files once a server process shuts down, use the Amazon GameLift server API ProcessReady() and specify one or more directory paths in logParameters. For more information, see Initialize the server process in the Amazon GameLift Developer Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • logPaths

      CreateFleetRequest.Builder logPaths(String... logPaths)

      This parameter is no longer used. To specify where Amazon GameLift should store log files once a server process shuts down, use the Amazon GameLift server API ProcessReady() and specify one or more directory paths in logParameters. For more information, see Initialize the server process in the Amazon GameLift Developer Guide.

      Parameters:
      logPaths - This parameter is no longer used. To specify where Amazon GameLift should store log files once a server process shuts down, use the Amazon GameLift server API ProcessReady() and specify one or more directory paths in logParameters. For more information, see Initialize the server process in the Amazon GameLift Developer Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ec2InstanceType

      CreateFleetRequest.Builder ec2InstanceType(String ec2InstanceType)

      The Amazon GameLift-supported Amazon EC2 instance type to use with EC2 and container 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.

      Parameters:
      ec2InstanceType - The Amazon GameLift-supported Amazon EC2 instance type to use with EC2 and container 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:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • ec2InstanceType

      CreateFleetRequest.Builder ec2InstanceType(EC2InstanceType ec2InstanceType)

      The Amazon GameLift-supported Amazon EC2 instance type to use with EC2 and container 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.

      Parameters:
      ec2InstanceType - The Amazon GameLift-supported Amazon EC2 instance type to use with EC2 and container 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:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • ec2InboundPermissions

      CreateFleetRequest.Builder ec2InboundPermissions(Collection<IpPermission> 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 EC2 and container fleets. You can leave this parameter empty when creating the fleet, but you must call UpdateFleetPortSettings 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.

      To manage inbound access for a container fleet, set this parameter to the same port numbers that you set for the fleet's connection port range. During the life of the fleet, update this parameter to control which connection ports are open to inbound traffic.

      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 EC2 and container fleets. You can leave this parameter empty when creating the fleet, but you must call UpdateFleetPortSettings 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.

      To manage inbound access for a container fleet, set this parameter to the same port numbers that you set for the fleet's connection port range. During the life of the fleet, update this parameter to control which connection ports are open to inbound traffic.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ec2InboundPermissions

      CreateFleetRequest.Builder ec2InboundPermissions(IpPermission... 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 EC2 and container fleets. You can leave this parameter empty when creating the fleet, but you must call UpdateFleetPortSettings 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.

      To manage inbound access for a container fleet, set this parameter to the same port numbers that you set for the fleet's connection port range. During the life of the fleet, update this parameter to control which connection ports are open to inbound traffic.

      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 EC2 and container fleets. You can leave this parameter empty when creating the fleet, but you must call UpdateFleetPortSettings 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.

      To manage inbound access for a container fleet, set this parameter to the same port numbers that you set for the fleet's connection port range. During the life of the fleet, update this parameter to control which connection ports are open to inbound traffic.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ec2InboundPermissions

      CreateFleetRequest.Builder ec2InboundPermissions(Consumer<IpPermission.Builder>... 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 EC2 and container fleets. You can leave this parameter empty when creating the fleet, but you must call UpdateFleetPortSettings 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.

      To manage inbound access for a container fleet, set this parameter to the same port numbers that you set for the fleet's connection port range. During the life of the fleet, update this parameter to control which connection ports are open to inbound traffic.

      This is a convenience method that creates an instance of the IpPermission.Builder avoiding the need to create one manually via IpPermission.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to ec2InboundPermissions(List<IpPermission>).

      Parameters:
      ec2InboundPermissions - a consumer that will call methods on IpPermission.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • newGameSessionProtectionPolicy

      CreateFleetRequest.Builder newGameSessionProtectionPolicy(String newGameSessionProtectionPolicy)

      The status of termination protection for active game sessions on the fleet. By default, this property is set to NoProtection. You can also set game session protection for an individual game session by calling UpdateGameSession.

      • 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. By default, this property is set to NoProtection. You can also set game session protection for an individual game session by calling UpdateGameSession.

      • 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:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • newGameSessionProtectionPolicy

      CreateFleetRequest.Builder newGameSessionProtectionPolicy(ProtectionPolicy newGameSessionProtectionPolicy)

      The status of termination protection for active game sessions on the fleet. By default, this property is set to NoProtection. You can also set game session protection for an individual game session by calling UpdateGameSession.

      • 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. By default, this property is set to NoProtection. You can also set game session protection for an individual game session by calling UpdateGameSession.

      • 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:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • runtimeConfiguration

      CreateFleetRequest.Builder runtimeConfiguration(RuntimeConfiguration runtimeConfiguration)

      Instructions for how to launch and run server processes on the fleet. Set runtime configuration for EC2 fleets and container fleets. For an Anywhere fleets, set this parameter only if the fleet is running the Amazon GameLift Agent. The runtime configuration defines one or more server process configurations. Each server process identifies a game executable or Realtime script file and the number of processes to run concurrently.

      This parameter replaces the parameters ServerLaunchPath and ServerLaunchParameters, which are still supported for backward compatibility.

      Parameters:
      runtimeConfiguration - Instructions for how to launch and run server processes on the fleet. Set runtime configuration for EC2 fleets and container fleets. For an Anywhere fleets, set this parameter only if the fleet is running the Amazon GameLift Agent. The runtime configuration defines one or more server process configurations. Each server process identifies a game executable or Realtime script file and the number of processes to run concurrently.

      This parameter replaces the parameters ServerLaunchPath and ServerLaunchParameters, which are still supported for backward compatibility.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • runtimeConfiguration

      default CreateFleetRequest.Builder runtimeConfiguration(Consumer<RuntimeConfiguration.Builder> runtimeConfiguration)

      Instructions for how to launch and run server processes on the fleet. Set runtime configuration for EC2 fleets and container fleets. For an Anywhere fleets, set this parameter only if the fleet is running the Amazon GameLift Agent. The runtime configuration defines one or more server process configurations. Each server process identifies a game executable or Realtime script file and the number of processes to run concurrently.

      This parameter replaces the parameters ServerLaunchPath and ServerLaunchParameters, which are still supported for backward compatibility.

      This is a convenience method that creates an instance of the RuntimeConfiguration.Builder avoiding the need to create one manually via RuntimeConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to runtimeConfiguration(RuntimeConfiguration).

      Parameters:
      runtimeConfiguration - a consumer that will call methods on RuntimeConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • resourceCreationLimitPolicy

      CreateFleetRequest.Builder resourceCreationLimitPolicy(ResourceCreationLimitPolicy 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resourceCreationLimitPolicy

      default CreateFleetRequest.Builder resourceCreationLimitPolicy(Consumer<ResourceCreationLimitPolicy.Builder> 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 is a convenience method that creates an instance of the ResourceCreationLimitPolicy.Builder avoiding the need to create one manually via ResourceCreationLimitPolicy.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to resourceCreationLimitPolicy(ResourceCreationLimitPolicy).

      Parameters:
      resourceCreationLimitPolicy - a consumer that will call methods on ResourceCreationLimitPolicy.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • metricGroups

      CreateFleetRequest.Builder metricGroups(Collection<String> metricGroups)

      The name of an Amazon Web Services 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 Amazon Web Services 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:
      Returns a reference to this object so that method calls can be chained together.

    • metricGroups

      CreateFleetRequest.Builder metricGroups(String... metricGroups)

      The name of an Amazon Web Services 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 Amazon Web Services 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:
      Returns a reference to this object so that method calls can be chained together.

    • peerVpcAwsAccountId

      CreateFleetRequest.Builder peerVpcAwsAccountId(String peerVpcAwsAccountId)

      Used when peering your Amazon GameLift fleet with a VPC, the unique identifier for the Amazon Web Services account that owns the VPC. You can find your account ID in the Amazon Web Services Management Console under account settings.

      Parameters:
      peerVpcAwsAccountId - Used when peering your Amazon GameLift fleet with a VPC, the unique identifier for the Amazon Web Services account that owns the VPC. You can find your account ID in the Amazon Web Services Management Console under account settings.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • peerVpcId

      CreateFleetRequest.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 Amazon Web Services 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. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the Amazon Web Services Management Console. Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fleetType

      CreateFleetRequest.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 fleet property can't be changed after the fleet is created.

      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:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • fleetType

      CreateFleetRequest.Builder fleetType(FleetType 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.

      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:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • instanceRoleArn

      CreateFleetRequest.Builder instanceRoleArn(String instanceRoleArn)

      A unique identifier for an IAM role with access permissions to other Amazon Web Services services. Any application that runs on an instance in the fleet--including install scripts, server processes, and other processes--can use these permissions to interact with Amazon Web Services resources that you own or have access to. For more information about using the role with your game server builds, see Communicate with other Amazon Web Services resources from your fleets. This fleet property can't be changed after the fleet is created.

      Parameters:
      instanceRoleArn - A unique identifier for an IAM role with access permissions to other Amazon Web Services services. Any application that runs on an instance in the fleet--including install scripts, server processes, and other processes--can use these permissions to interact with Amazon Web Services resources that you own or have access to. For more information about using the role with your game server builds, see Communicate with other Amazon Web Services resources from your fleets. This fleet property can't be changed after the fleet is created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • certificateConfiguration

      CreateFleetRequest.Builder certificateConfiguration(CertificateConfiguration 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.

      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 Amazon Web Services 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 Certificate Manager User Guide.

      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.

      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 Amazon Web Services 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 Certificate Manager User Guide.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • certificateConfiguration

      default CreateFleetRequest.Builder certificateConfiguration(Consumer<CertificateConfiguration.Builder> 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.

      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 Amazon Web Services 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 Certificate Manager User Guide.

      This is a convenience method that creates an instance of the CertificateConfiguration.Builder avoiding the need to create one manually via CertificateConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to certificateConfiguration(CertificateConfiguration).

      Parameters:
      certificateConfiguration - a consumer that will call methods on CertificateConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • locations

      CreateFleetRequest.Builder locations(Collection<LocationConfiguration> 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 Amazon Web Services Regions that support multiple locations. You can add any Amazon GameLift-supported Amazon Web Services Region as a remote location, in the form of an Amazon Web Services Region code, such as us-west-2 or Local Zone code. To create a fleet with instances in the home Region only, don't set this parameter.

      When using this parameter, Amazon GameLift requires you to include 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 can only be used when creating fleets in Amazon Web Services Regions that support multiple locations. You can add any Amazon GameLift-supported Amazon Web Services Region as a remote location, in the form of an Amazon Web Services Region code, such as us-west-2 or Local Zone code. To create a fleet with instances in the home Region only, don't set this parameter.

      When using this parameter, Amazon GameLift requires you to include your home location in the request.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • locations

      CreateFleetRequest.Builder locations(LocationConfiguration... 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 Amazon Web Services Regions that support multiple locations. You can add any Amazon GameLift-supported Amazon Web Services Region as a remote location, in the form of an Amazon Web Services Region code, such as us-west-2 or Local Zone code. To create a fleet with instances in the home Region only, don't set this parameter.

      When using this parameter, Amazon GameLift requires you to include 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 can only be used when creating fleets in Amazon Web Services Regions that support multiple locations. You can add any Amazon GameLift-supported Amazon Web Services Region as a remote location, in the form of an Amazon Web Services Region code, such as us-west-2 or Local Zone code. To create a fleet with instances in the home Region only, don't set this parameter.

      When using this parameter, Amazon GameLift requires you to include your home location in the request.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • locations

      CreateFleetRequest.Builder locations(Consumer<LocationConfiguration.Builder>... 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 Amazon Web Services Regions that support multiple locations. You can add any Amazon GameLift-supported Amazon Web Services Region as a remote location, in the form of an Amazon Web Services Region code, such as us-west-2 or Local Zone code. To create a fleet with instances in the home Region only, don't set this parameter.

      When using this parameter, Amazon GameLift requires you to include your home location in the request.

      This is a convenience method that creates an instance of the LocationConfiguration.Builder avoiding the need to create one manually via LocationConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to locations(List<LocationConfiguration>).

      Parameters:
      locations - a consumer that will call methods on LocationConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tags

      CreateFleetRequest.Builder tags(Collection<Tag> tags)

      A list of labels to assign to the new fleet resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

      Parameters:
      tags - A list of labels to assign to the new fleet resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateFleetRequest.Builder tags(Tag... tags)

      A list of labels to assign to the new fleet resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

      Parameters:
      tags - A list of labels to assign to the new fleet resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateFleetRequest.Builder tags(Consumer<Tag.Builder>... tags)

      A list of labels to assign to the new fleet resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • computeType

      CreateFleetRequest.Builder computeType(String 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.

      • CONTAINER – Container images with your game server build and supporting software are deployed to Amazon EC2 instances for cloud hosting. With this compute type, you must specify the ContainerGroupsConfiguration parameter.

      • ANYWHERE – Game servers or container images with your game server and supporting software are deployed to compute resources that are provided and managed by you. With this compute type, you can also set the AnywhereConfiguration parameter.

      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.

      • CONTAINER – Container images with your game server build and supporting software are deployed to Amazon EC2 instances for cloud hosting. With this compute type, you must specify the ContainerGroupsConfiguration parameter.

      • ANYWHERE – Game servers or container images with your game server and supporting software are deployed to compute resources that are provided and managed by you. With this compute type, you can also set the AnywhereConfiguration parameter.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • computeType

      CreateFleetRequest.Builder computeType(ComputeType 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.

      • CONTAINER – Container images with your game server build and supporting software are deployed to Amazon EC2 instances for cloud hosting. With this compute type, you must specify the ContainerGroupsConfiguration parameter.

      • ANYWHERE – Game servers or container images with your game server and supporting software are deployed to compute resources that are provided and managed by you. With this compute type, you can also set the AnywhereConfiguration parameter.

      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.

      • CONTAINER – Container images with your game server build and supporting software are deployed to Amazon EC2 instances for cloud hosting. With this compute type, you must specify the ContainerGroupsConfiguration parameter.

      • ANYWHERE – Game servers or container images with your game server and supporting software are deployed to compute resources that are provided and managed by you. With this compute type, you can also set the AnywhereConfiguration parameter.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • anywhereConfiguration

      CreateFleetRequest.Builder anywhereConfiguration(AnywhereConfiguration anywhereConfiguration)

      Amazon GameLift Anywhere configuration options.

      Parameters:
      anywhereConfiguration - Amazon GameLift Anywhere configuration options.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • anywhereConfiguration

      default CreateFleetRequest.Builder anywhereConfiguration(Consumer<AnywhereConfiguration.Builder> anywhereConfiguration)

      Amazon GameLift Anywhere configuration options.

      This is a convenience method that creates an instance of the AnywhereConfiguration.Builder avoiding the need to create one manually via AnywhereConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to anywhereConfiguration(AnywhereConfiguration).

      Parameters:
      anywhereConfiguration - a consumer that will call methods on AnywhereConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • instanceRoleCredentialsProvider

      CreateFleetRequest.Builder instanceRoleCredentialsProvider(String instanceRoleCredentialsProvider)

      Prompts Amazon GameLift to generate a shared credentials file for the IAM role that's defined in InstanceRoleArn. The shared credentials file is stored on each fleet instance and refreshed as needed. Use shared credentials for applications that are deployed along with the game server executable, if the game server is integrated with server SDK version 5.x. For more information about using shared credentials, see Communicate with other Amazon Web Services resources from your fleets.

      Parameters:
      instanceRoleCredentialsProvider - Prompts Amazon GameLift to generate a shared credentials file for the IAM role that's defined in InstanceRoleArn. The shared credentials file is stored on each fleet instance and refreshed as needed. Use shared credentials for applications that are deployed along with the game server executable, if the game server is integrated with server SDK version 5.x. For more information about using shared credentials, see Communicate with other Amazon Web Services resources from your fleets.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • instanceRoleCredentialsProvider

      CreateFleetRequest.Builder instanceRoleCredentialsProvider(InstanceRoleCredentialsProvider instanceRoleCredentialsProvider)

      Prompts Amazon GameLift to generate a shared credentials file for the IAM role that's defined in InstanceRoleArn. The shared credentials file is stored on each fleet instance and refreshed as needed. Use shared credentials for applications that are deployed along with the game server executable, if the game server is integrated with server SDK version 5.x. For more information about using shared credentials, see Communicate with other Amazon Web Services resources from your fleets.

      Parameters:
      instanceRoleCredentialsProvider - Prompts Amazon GameLift to generate a shared credentials file for the IAM role that's defined in InstanceRoleArn. The shared credentials file is stored on each fleet instance and refreshed as needed. Use shared credentials for applications that are deployed along with the game server executable, if the game server is integrated with server SDK version 5.x. For more information about using shared credentials, see Communicate with other Amazon Web Services resources from your fleets.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • containerGroupsConfiguration

      CreateFleetRequest.Builder containerGroupsConfiguration(ContainerGroupsConfiguration containerGroupsConfiguration)

      The container groups to deploy to instances in the container fleet and other fleet-level configuration settings. Use the CreateContainerGroupDefinition action to create container groups. A container fleet must have exactly one replica container group, and can optionally have one daemon container group. You can't change this property after you create the fleet.

      Parameters:
      containerGroupsConfiguration - The container groups to deploy to instances in the container fleet and other fleet-level configuration settings. Use the CreateContainerGroupDefinition action to create container groups. A container fleet must have exactly one replica container group, and can optionally have one daemon container group. You can't change this property after you create the fleet.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • containerGroupsConfiguration

      default CreateFleetRequest.Builder containerGroupsConfiguration(Consumer<ContainerGroupsConfiguration.Builder> containerGroupsConfiguration)

      The container groups to deploy to instances in the container fleet and other fleet-level configuration settings. Use the CreateContainerGroupDefinition action to create container groups. A container fleet must have exactly one replica container group, and can optionally have one daemon container group. You can't change this property after you create the fleet.

      This is a convenience method that creates an instance of the ContainerGroupsConfiguration.Builder avoiding the need to create one manually via ContainerGroupsConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to containerGroupsConfiguration(ContainerGroupsConfiguration).

      Parameters:
      containerGroupsConfiguration - a consumer that will call methods on ContainerGroupsConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      CreateFleetRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateFleetRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.