class Aws::GameLift::Types::FleetAttributes

@see docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/FleetAttributes AWS API Documentation
@return [Types::PlayerGatewayConfiguration]
Configuration settings for player gateway on this fleet.
@!attribute [rw] player_gateway_configuration
@return [String]
server.
player gateway. Instead, they have to directly connect to the game
connect with the game server. If ‘DISABLED`, game clients cannot use
If `ENABLED` or `REQUIRED`, game clients can use player gateway to
impact to latency.
gateway provides benefits such as DDoS protection with negligible
Indicates whether player gateway is enabled for this fleet. Player
@!attribute [rw] player_gateway_mode
@return [String] : docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html where `ComputeType` is `EC2`.
resources from your fleets]. This attribute is used with fleets
credentials, see [ Communicate with other Amazon Web Services
server SDK version 5.x. For more information about using shared
property is used only when the game server is integrated with the
to communicate with other Amazon Web Services resources. This
allow applications that are deployed with the game server executable
for the IAM role defined in `InstanceRoleArn`. Shared credentials
Indicates that fleet instances maintain a shared credentials file
@!attribute [rw] instance_role_credentials_provider
@return [Types::AnywhereConfiguration]
A set of attributes that are specific to an Anywhere fleet.
@!attribute [rw] anywhere_configuration
@return [String]
or use Amazon EC2 instances with managed Amazon GameLift Servers.
use your own compute resources with Amazon GameLift Servers Anywhere
The type of compute resource used to host your game servers. You can
@!attribute [rw] compute_type
@return [Types::CertificateConfiguration]
in a fleet share the same certificate.
This feature must be enabled when creating the fleet. All instances
Determines whether a TLS/SSL certificate is generated for a fleet.
@!attribute [rw] certificate_configuration
@return [String] : docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html [1]: console.aws.amazon.com/iam/
attribute is used with fleets where `ComputeType` is `EC2`.
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 [Array<String>] : docs.aws.amazon.com/gamelift/latest/apireference/API_StopFleetActions.html attribute is used with fleets where ‘ComputeType` is `EC2`. [1]. This includes fleet auto-scaling. This
A list of fleet activity that has been suspended using
@!attribute [rw] stopped_actions
@return [Array<String>]
`ComputeType` is `EC2`.
group at a time. This attribute is used with fleets where
are in a metric group. A fleet can be included in only one metric
Amazon CloudWatch, you can view aggregated metrics for fleets that
Name of a metric group that metrics for this fleet are added to. In
@!attribute [rw] metric_groups
@return [Types::ResourceCreationLimitPolicy]
created fewer than game session limit in the specified time period.
Servers checks that the player (identified by `CreatorId`) has
session. On receiving a `CreateGameSession` request, Amazon GameLift
The policy is evaluated when a player tries to create a new game
you can control players’ ability to consume available resources.
player can create within a specified span of time. With this policy,
A policy that puts limits on the number of game sessions that a
@!attribute [rw] resource_creation_limit_policy
@return [String] : docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk5-migration.html [1]: aws.amazon.com/aws.amazon.com/amazon-linux-2/faqs/ </note> 5.][2] then deploy to AL2023 instances. See [ Migrate to server SDK version
Servers, first update the game server build to server SDK 5.x, and
are hosted on AL2 and use server SDK version 4.x for Amazon GameLift
more details in the [Amazon Linux 2 FAQs]. For game servers that
<note markdown=“1”> Amazon Linux 2 (AL2) will reach end of support on 6/30/2026. See
`ComputeType` is ‘EC2`.
is deployed on this fleet. This attribute is used with fleets where
operating system is determined by the OS of the build or script that
The operating system of the fleet’s computing resources. A fleet’s
@!attribute [rw] operating_system
@return [String]
status, it cannot be terminated during a scale-down event.
* FullProtection – If the game session is in an ‘ACTIVE`
scale-down event.
* NoProtection – The game session can be terminated during a
`ComputeType` is `EC2`.
are started in the fleet. This attribute is used with fleets where
The type of game session protection to set on all new instances that
@!attribute [rw] new_game_session_protection_policy
@return [Array<String>] : docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api-ref.html#gamelift-sdk-server-api-ref-dataypes-process [Server API Reference].
`ProcessReady()` `logParameters`. See more information in the
defined using the Amazon GameLift Servers server API
**This parameter is no longer used.** Game session log paths are now
@!attribute [rw] log_paths
@return [String]
use this parameter continue to be valid.
now defined using the fleet’s runtime configuration. Requests that
**This parameter is no longer used.** Server launch parameters are
@!attribute [rw] server_launch_parameters
@return [String] : docs.aws.amazon.com/gamelift/latest/apireference/RuntimeConfiguration.html use this parameter continue to be valid.
defined using the fleet’s [RuntimeConfiguration]. Requests that
**This parameter is no longer used.** Server launch paths are now
@!attribute [rw] server_launch_path
@return [String] : docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html GameLift script ARN, the resource ID matches the ‘ScriptId` value.
script resource that is deployed on instances in this fleet. In a
The Amazon Resource Name ([ARN]) associated with the GameLift
@!attribute [rw] script_arn
@return [String]
fleets where `ComputeType` is “EC2”.
deployed on instances in this fleet. This attribute is used with
A unique identifier for the Realtime script resource that is
@!attribute [rw] script_id
@return [String] : docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html `ComputeType` is “EC2”.
`BuildId` value. This attribute is used with fleets where
this fleet. In a GameLift build ARN, the resource ID matches the
GameLift Servers build resource that is deployed on instances in
The Amazon Resource Name ([ARN]) associated with the Amazon
@!attribute [rw] build_arn
@return [String]
`ComputeType` is “EC2”.
instances in this fleet. This attribute is used with fleets where
A unique identifier for the build resource that is deployed on
@!attribute [rw] build_id
@return [String]
* TERMINATED – The fleet no longer exists.
* DELETING – Hosts are responding to a delete fleet request.
or activating the fleet.
* ERROR – An error occurred when downloading, validating, building,
* ACTIVE – The fleet is now ready to host game sessions.
Servers service.
process and testing its connectivity with the Amazon GameLift
* ACTIVATING – Amazon GameLift Servers is launching a game server
launches a fleet instance.
validating the build files. When complete, Amazon GameLift Servers
download the game server build, running install scripts, and then
* DOWNLOADING/VALIDATING/BUILDING – Amazon GameLift Servers is
to 1.
Servers has started creating the fleet. Desired instances is set
* NEW – A new fleet resource has been defined and Amazon GameLift
following:
Current status of the fleet. Possible fleet statuses include the
@!attribute [rw] status
@return [Time]
`“1469498468.057”`).
is a number expressed in Unix time as milliseconds (for example
A time stamp indicating when this data object was terminated. Format
@!attribute [rw] termination_time
@return [Time]
`“1469498468.057”`).
a number expressed in Unix time as milliseconds (for example
A time stamp indicating when this data object was created. Format is
@!attribute [rw] creation_time
@return [String]
not need to be unique.
A descriptive label that is associated with a fleet. Fleet names do
@!attribute [rw] name
@return [String]
A human-readable description of the fleet.
@!attribute [rw] description
@return [String] : aws.amazon.com/ec2/instance-types/
This attribute is used with fleets where `ComputeType` is `EC2`.
Elastic Compute Cloud Instance Types] for detailed descriptions.
including CPU, memory, storage, and networking capacity. See [Amazon
determines the computing resources of each instance in the fleet,
The Amazon EC2 instance type that the fleet uses. Instance type
@!attribute [rw] instance_type
@return [String] : docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-ec2-instances.html#gamelift-ec2-instances-spot fleet property can’t be changed after the fleet is created.
more information, see [ On-Demand versus Spot Instances]. This
Indicates whether the fleet uses On-Demand or Spot instances. For
@!attribute [rw] fleet_type
@return [String] : docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html value.
In a GameLift fleet ARN, the resource ID matches the ‘FleetId`
`arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912`.
unique across all Regions. Format is
GameLift Servers fleet resource and uniquely identifies it. ARNs are
The Amazon Resource Name ([ARN]) that is assigned to a Amazon
@!attribute [rw] fleet_arn
@return [String]
A unique identifier for the fleet.
@!attribute [rw] fleet_id : docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetAttributes [https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetAttributes][1]
**Returned by:**
descriptive properties, creation/termination time, and fleet status.
the fleet’s computes. Attributes include fleet identifiers and
attributes, because most fleet configurations are set directly on
* Amazon GameLift Servers Anywhere fleets have an abbreviated set of
GameLift Servers Realtime fleets).
customer game server builds) or a ‘Script` resource (for Amazon
* EC2 fleet attributes identify a `Build` resource (for fleets with
Attributes differ based on the fleet’s compute type, as follows:
Describes an Amazon GameLift Servers fleet of game hosting resources.

class Aws::GameLift::Types::FleetAttributes

Namespace

Included Modules

Defined in