You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::GameLift::Types::CreateFleetInput

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateFleetInput as input to an Aws::Client method, you can use a vanilla Hash:

{
  name: "NonZeroAndMaxString", # required
  description: "NonZeroAndMaxString",
  build_id: "BuildId", # required
  server_launch_path: "NonZeroAndMaxString",
  server_launch_parameters: "NonZeroAndMaxString",
  log_paths: ["NonZeroAndMaxString"],
  ec2_instance_type: "t2.micro", # required, accepts t2.micro, t2.small, t2.medium, t2.large, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, r4.large, r4.xlarge, r4.2xlarge, r4.4xlarge, r4.8xlarge, r4.16xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge
  ec2_inbound_permissions: [
    {
      from_port: 1, # required
      to_port: 1, # required
      ip_range: "NonBlankString", # required
      protocol: "TCP", # required, accepts TCP, UDP
    },
  ],
  new_game_session_protection_policy: "NoProtection", # accepts NoProtection, FullProtection
  runtime_configuration: {
    server_processes: [
      {
        launch_path: "NonZeroAndMaxString", # required
        parameters: "NonZeroAndMaxString",
        concurrent_executions: 1, # required
      },
    ],
    max_concurrent_game_session_activations: 1,
    game_session_activation_timeout_seconds: 1,
  },
  resource_creation_limit_policy: {
    new_game_sessions_per_creator: 1,
    policy_period_in_minutes: 1,
  },
  metric_groups: ["MetricGroup"],
  peer_vpc_aws_account_id: "NonZeroAndMaxString",
  peer_vpc_id: "NonZeroAndMaxString",
}

Represents the input for a request action.

Instance Attribute Summary collapse

Instance Attribute Details

#build_idString

Unique identifier for a build to be deployed on the new 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.

Returns:

  • (String)

    Unique identifier for a build to be deployed on the new fleet.

#descriptionString

Human-readable description of a fleet.

Returns:

  • (String)

    Human-readable description of a fleet.

#ec2_inbound_permissionsArray<Types::IpPermission>

Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet. If no inbound permissions are set, including both IP address range and port range, the server processes in the fleet cannot accept connections. You can specify one or more sets of permissions for a fleet.

Returns:

  • (Array<Types::IpPermission>)

    Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet.

#ec2_instance_typeString

Name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.

Returns:

  • (String)

    Name of an EC2 instance type that is supported in Amazon GameLift.

#log_pathsArray<String>

This parameter is no longer used. Instead, 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. See more information in the Server API Reference.

Returns:

  • (Array<String>)

    This parameter is no longer used.

#metric_groupsArray<String>

Names of metric groups to add this fleet to. Use an existing metric group name to add this fleet to the group. Or use a new name to create a new metric group. A fleet can only be included in one metric group at a time.

Returns:

  • (Array<String>)

    Names of metric groups to add this fleet to.

#nameString

Descriptive label that is associated with a fleet. Fleet names do not need to be unique.

Returns:

  • (String)

    Descriptive label that is associated with a fleet.

#new_game_session_protection_policyString

Game session protection policy to apply to all instances in this fleet. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet\'s protection policy using UpdateFleetAttributes, but this change will only affect sessions created after the policy change. You can also set protection for individual instances using UpdateGameSession.

  • NoProtection -- The game session can be terminated during a scale-down event.

  • FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

    Possible values:

    • NoProtection
    • FullProtection

Returns:

  • (String)

    Game session protection policy to apply to all instances in this fleet.

#peer_vpc_aws_account_idString

Unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with. You can find your Account ID in the AWS Management Console under account settings.

Returns:

  • (String)

    Unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with.

#peer_vpc_idString

Unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same region where your fleet is deployed. To get VPC information, including IDs, use the Virtual Private Cloud service tools, including the VPC Dashboard in the AWS Management Console.

Returns:

  • (String)

    Unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet.

#resource_creation_limit_policyTypes::ResourceCreationLimitPolicy

Policy that limits the number of game sessions an individual player can create over a span of time for this fleet.

Returns:

#runtime_configurationTypes::RuntimeConfiguration

Instructions for launching server processes on each instance in the fleet. The run-time configuration for a fleet has a collection of server process configurations, one for each type of server process to run on an instance. A server process configuration specifies the location of the server executable, launch parameters, and the number of concurrent processes with that configuration to maintain on each instance. A CreateFleet request must include a run-time configuration with at least one server process configuration; otherwise the request fails with an invalid request exception. (This parameter replaces the parameters ServerLaunchPath and ServerLaunchParameters; requests that contain values for these parameters instead of a run-time configuration will continue to work.)

Returns:

#server_launch_parametersString

This parameter is no longer used. Instead, specify server launch parameters in the RuntimeConfiguration parameter. (Requests that specify a server launch path and launch parameters instead of a run-time configuration will continue to work.)

Returns:

  • (String)

    This parameter is no longer used.

#server_launch_pathString

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 run-time configuration will continue to work.)

Returns:

  • (String)

    This parameter is no longer used.