class Aws::GameLift::Types::CreateFleetInput

@see docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateFleetInput AWS API Documentation
@return [Types::PlayerGatewayConfiguration]
advanced options for how player gateway handles connections.
Configuration settings for player gateway. Use this to specify
@!attribute [rw] player_gateway_configuration
@return [String] : docs.aws.amazon.com/gameliftservers/latest/developerguide/ddos-protection-intro.html [1]: docs.aws.amazon.com/gamelift/latest/apireference/API_GetPlayerConnectionDetails.html ‘InvalidRequestException`.
which does not support player gateway will result in an
this feature. Attempting to add a remote location to your fleet
it is supported, and the fleet can only use locations that support
* `REQUIRED` – Player gateway is available in fleet locations where
and endpoints for game clients. [1] to obtain a player gateway token
it is supported. Your game backend can call
* `ENABLED` – Player gateway is available in fleet locations where
with player gateway.
endpoint. Use this when you do not intend to integrate your game
* `DISABLED` (default) – Game clients connect to the game server
Possible values include:
Amazon GameLift Servers player gateway].
clients. To learn more about this topic, see [DDoS protection with
retrieve relay endpoints and player gateway tokens for your game
server. Your game backend calls [GetPlayerConnectionDetails] to
player gateway tokens and routes traffic to the appropriate game
endpoints instead of to your game servers. Player gateway validates
**How it works:** When enabled, game clients connect to relay
for fleets using server SDK 5.x or later game server builds.
endpoints become unhealthy. Note, player gateway is only available
addresses from players, and providing updated endpoints when relay
traﬃc before it reaches game servers, hiding game server IP
benefits such as DDoS protection by rate limiting and validating
Configures player gateway for your fleet. Player gateway provides
@!attribute [rw] player_gateway_mode
@return [String] : docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html other Amazon Web Services resources from your fleets].
information about using shared credentials, see [ Communicate with
server is integrated with server SDK version 5.x. For more
are deployed along with the game server executable, if the game
refreshed as needed. Use shared credentials for applications that
shared credentials file is stored on each fleet instance and
file for the IAM role that’s defined in ‘InstanceRoleArn`. The
Prompts Amazon GameLift Servers to generate a shared credentials
@!attribute [rw] instance_role_credentials_provider
@return [Types::AnywhereConfiguration]
Amazon GameLift Servers Anywhere configuration options.
@!attribute [rw] anywhere_configuration
@return [String]
type, you can also set the `AnywhereConfiguration` parameter.
compute resources that you provide and manage. With this compute
* `ANYWHERE` – Game servers and supporting software are deployed to
for cloud hosting. This is the default setting.
* `EC2` – The game server build is deployed to Amazon EC2 instances
The type of compute resource used to host your game servers.
@!attribute [rw] compute_type
@return [Array<Types::Tag>] : docs.aws.amazon.com/general/latest/gr/aws_tagging.html Reference*.
Services Resources] in the *Amazon Web Services General
cost allocation. For more information, see [ Tagging Amazon Web
resources are useful for resource management, access management and
developer-defined key-value pairs. Tagging Amazon Web Services
A list of labels to assign to the new fleet resource. Tags are
@!attribute [rw] tags
@return [Array<Types::LocationConfiguration>] : docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-regions.html Servers service locations] for managed hosting.
list of supported Regions and Local Zones, see [ Amazon GameLift
requires you to include your home location in the request. For a
Local Zone names. When using this parameter, Amazon GameLift Servers
or more Amazon Web Services Region codes, such as `us-west-2`, or
that’s supported by Amazon GameLift Servers. Provide a list of one
locations. You can add any Amazon Web Services Region or Local Zone
fleet in Amazon Web Services Regions that support multiple
manage as a multi-location fleet. Use this parameter when creating a
A set of remote locations to deploy additional instances to and
@!attribute [rw] locations
@return [Types::CertificateConfiguration] : docs.aws.amazon.com/acm/latest/userguide/acm-regions.html </note>
*Certificate Manager User Guide*.
about the supported Regions, see [Supported Regions] in the
unsupported Region, fails with a 4xx error. For more information
creation request with certificate generation enabled in an
<note markdown=“1”> ACM isn’t available in all Amazon Web Services regions. A fleet
transition.
fleets before 13 months, consider using fleet aliases for a smooth
from connecting to instances in the fleet. We recommend you replace
Certificate expiration can cause fleets to fail, preventing players
Certificate Manager (ACM) certificates expire after 13 months.
fleet.
is ‘DISABLED`. You can’t change this property after you create the
Amazon GameLift Servers. By default, the ‘CertificateConfiguration`
encrypt traffic between game clients and the game servers running on
for the fleet. Amazon GameLift Servers uses the certificates to
Prompts Amazon GameLift Servers to generate a TLS/SSL certificate
@!attribute [rw] certificate_configuration
@return [String] : docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html [1]: console.aws.amazon.com/iam/
fleet property can’t be changed after the fleet is created.
servers at [ Access external resources from a game server]. This
Console. Learn more about using on-box credentials for your game
using the [IAM dashboard] in the Amazon Web Services Management
(background processes). Create a role or look up a role’s ARN by
role, including install scripts, server processes, and daemons
application that runs on an instance in this fleet can assume the
Amazon Web Services services. With an instance role ARN set, any
A unique identifier for an IAM role that manages access to your
@!attribute [rw] instance_role_arn
@return [String] : docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-ec2-instances.html#gamelift-ec2-instances-spot property can’t be changed after the fleet is created.
when to use [ On-Demand versus Spot Instances]. This fleet
By default, this property is set to ‘ON_DEMAND`. Learn more about
Indicates whether to use On-Demand or Spot instances for this fleet.
@!attribute [rw] fleet_type
@return [String] : docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html [1]: console.aws.amazon.com/vpc/
in [VPC Peering with Amazon GameLift Servers Fleets].
Amazon Web Services Management Console. Learn more about VPC peering
your fleet. To look up a VPC ID, use the [VPC Dashboard] in the
Amazon GameLift Servers fleet. The VPC must be in the same Region as
A unique identifier for a VPC with resources to be accessed by your
@!attribute [rw] peer_vpc_id
@return [String]
Management Console under account settings.
VPC. You can find your account ID in the Amazon Web Services
unique identifier for the Amazon Web Services account that owns the
Used when peering your Amazon GameLift Servers fleet with a VPC, the
@!attribute [rw] peer_vpc_aws_account_id
@return [Array<String>]
in only one metric group at a time.
set a new name to create a new metric group. A fleet can be included
multiple fleets. You can specify an existing metric group name or
this fleet to. A metric group is used to aggregate the metrics for
The name of an Amazon Web Services CloudWatch metric group to add
@!attribute [rw] metric_groups
@return [Types::ResourceCreationLimitPolicy]
of time.
player can create on instances in this fleet within a specified span
A policy that limits the number of game sessions that an individual
@!attribute [rw] resource_creation_limit_policy
@return [Types::RuntimeConfiguration]
</note>
compatibility.
`ServerLaunchParameters`, which are still supported for backward
<note markdown=“1”> This parameter replaces the parameters `ServerLaunchPath` and
of processes to run concurrently.
identifies a game executable or Realtime script file and the number
or more server process configurations. Each server process
Amazon GameLift Servers Agent. The runtime configuration defines one
Anywhere fleets, set this parameter only if the fleet is running the
fleet. Set runtime configuration for managed EC2 fleets. For an
Instructions for how to launch and run server processes on the
@!attribute [rw] runtime_configuration
@return [String]
terminated during a scale-down event.
* FullProtection - Game sessions in `ACTIVE` status cannot be
gameplay as a result of a scale-down event.
* NoProtection - Game sessions can be terminated during active (gamelift/latest/apireference/API_UpdateGameSession.html).
calling
also set game session protection for an individual game session by
fleet. By default, this property is set to `NoProtection`. You can
The status of termination protection for active game sessions on the
@!attribute [rw] new_game_session_protection_policy
@return [Array<Types::IpPermission>] : docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateFleetPortSettings automatically sets TCP and UDP ranges.
GameLift Servers Realtime fleets, Amazon GameLift Servers
need them and closing them when you’re finished. For Amazon
practice, we recommend opening ports for remote access only when you
to set it before players can connect to game sessions. As a best [1]
parameter empty when creating the fleet, but you must call
Set this parameter for managed EC2 fleets. You can leave this
to access game server processes and other processes on this fleet.
The IP address ranges and port settings that allow inbound traffic
@!attribute [rw] ec2_inbound_permissions
@return [String] : aws.amazon.com/ec2/instance-types/
EC2 instance types.
Compute Cloud Instance Types] for detailed descriptions of Amazon
CPU, memory, storage, and networking capacity. See [Amazon Elastic
resources that will be used to host your game servers, including
use with managed EC2 fleets. Instance type determines the computing
The Amazon GameLift Servers-supported Amazon EC2 instance type to
@!attribute [rw] ec2_instance_type
@return [Array<String>] : docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-initialize GameLift Servers Developer Guide*.
information, see [Initialize the server process] in the *Amazon
and specify one or more directory paths in ‘logParameters`. For more
down, use the Amazon GameLift Servers server API `ProcessReady()`
GameLift Servers should store log files once a server process shuts
**This parameter is no longer used.** To specify where Amazon
@!attribute [rw] log_paths
@return [String]
use this parameter instead continue to be valid.
parameters using the `RuntimeConfiguration` parameter. Requests that
**This parameter is no longer used.** Specify server launch
@!attribute [rw] server_launch_parameters
@return [String]
parameter instead continue to be valid.
using the `RuntimeConfiguration` parameter. Requests that use this
**This parameter is no longer used.** Specify a server launch path
@!attribute [rw] server_launch_path
@return [String]
changed after the fleet is created.
Servers prior to creating the fleet. This fleet property can’t be
script ID or ARN. Scripts must be uploaded to Amazon GameLift
deployed to a fleet with compute type ‘EC2`. You can use either the
The unique identifier for a Realtime configuration script to be
@!attribute [rw] script_id
@return [String]
fleet is created.
`READY` status. This fleet property can’t be changed after the
or ARN. The build must be uploaded to Amazon GameLift Servers and in
to a fleet with compute type ‘EC2`. You can use either the build ID
The unique identifier for a custom game server build to be deployed
@!attribute [rw] build_id
@return [String]
A description for the fleet.
@!attribute [rw] description
@return [String]
not need to be unique.
A descriptive label that is associated with a fleet. Fleet names do
@!attribute [rw] name

class Aws::GameLift::Types::CreateFleetInput

Namespace

Included Modules

Defined in