class Aws::GameLift::Types::FleetAttributes

Describes a GameLift fleet of game hosting resources.

**Related actions**

CreateFleet | DescribeFleetAttributes

@!attribute [rw] fleet_id

A unique identifier for the fleet.
@return [String]

@!attribute [rw] fleet_arn

The Amazon Resource Name ([ARN][1]) that is assigned to a GameLift
fleet resource and uniquely identifies it. ARNs are unique across
all Regions. Format is
`arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912`.
In a GameLift fleet ARN, the resource ID matches the `FleetId`
value.

[1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html
@return [String]

@!attribute [rw] fleet_type

The kind of instances, On-Demand or Spot, that this fleet uses.
@return [String]

@!attribute [rw] instance_type

The EC2 instance type that determines the computing resources of
each instance in the fleet. Instance type defines the CPU, memory,
storage, and networking capacity. See [Amazon EC2 Instance Types][1]
for detailed descriptions.

[1]: http://aws.amazon.com/ec2/instance-types/
@return [String]

@!attribute [rw] description

A human-readable description of the fleet.
@return [String]

@!attribute [rw] name

A descriptive label that is associated with a fleet. Fleet names do
not need to be unique.
@return [String]

@!attribute [rw] creation_time

A time stamp indicating when this data object was created. Format is
a number expressed in Unix time as milliseconds (for example
`"1469498468.057"`).
@return [Time]

@!attribute [rw] termination_time

A time stamp indicating when this data object was terminated. Format
is a number expressed in Unix time as milliseconds (for example
`"1469498468.057"`).
@return [Time]

@!attribute [rw] status

Current status of the fleet. Possible fleet statuses include the
following:

* **NEW** -- A new fleet has been defined and desired instances is
  set to 1.

* **DOWNLOADING/VALIDATING/BUILDING/ACTIVATING** -- GameLift is
  setting up the new fleet, creating new instances with the game
  build or Realtime script and starting server processes.

* **ACTIVE** -- Hosts can now accept game sessions.

* **ERROR** -- An error occurred when downloading, validating,
  building, or activating the fleet.

* **DELETING** -- Hosts are responding to a delete fleet request.

* **TERMINATED** -- The fleet no longer exists.
@return [String]

@!attribute [rw] build_id

A unique identifier for the build resource that is deployed on
instances in this fleet.
@return [String]

@!attribute [rw] build_arn

The Amazon Resource Name ([ARN][1]) associated with the GameLift
build resource that is deployed on instances in this fleet. In a
GameLift build ARN, the resource ID matches the `BuildId` value.

[1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html
@return [String]

@!attribute [rw] script_id

A unique identifier for the Realtime script resource that is
deployed on instances in this fleet.
@return [String]

@!attribute [rw] script_arn

The Amazon Resource Name ([ARN][1]) associated with the GameLift
script resource that is deployed on instances in this fleet. In a
GameLift script ARN, the resource ID matches the `ScriptId` value.

[1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html
@return [String]

@!attribute [rw] server_launch_path

**This parameter is no longer used.** Server launch paths are now
defined using the fleet's RuntimeConfiguration parameter. Requests
that use this parameter instead continue to be valid.
@return [String]

@!attribute [rw] server_launch_parameters

**This parameter is no longer used.** Server launch parameters are
now defined using the fleet's RuntimeConfiguration parameter.
Requests that use this parameter instead continue to be valid.
@return [String]

@!attribute [rw] log_paths

**This parameter is no longer used.** Game session log paths are now
defined using the GameLift server API `ProcessReady()`
`logParameters`. See more information in the [Server API
Reference][1].

[1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api-ref.html#gamelift-sdk-server-api-ref-dataypes-process
@return [Array<String>]

@!attribute [rw] new_game_session_protection_policy

The type of game session protection to set on all new instances that
are started in the fleet.

* **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.
@return [String]

@!attribute [rw] operating_system

The operating system of the fleet's computing resources. A fleet's
operating system is determined by the OS of the build or script that
is deployed on this fleet.
@return [String]

@!attribute [rw] resource_creation_limit_policy

The fleet policy that limits the number of game sessions an
individual player can create over a span of time.
@return [Types::ResourceCreationLimitPolicy]

@!attribute [rw] metric_groups

Name of a metric group that metrics for this fleet are added to. In
Amazon CloudWatch, you can view aggregated metrics for fleets that
are in a metric group. A fleet can be included in only one metric
group at a time.
@return [Array<String>]

@!attribute [rw] stopped_actions

A list of fleet activity that has been suspended using
StopFleetActions. This includes fleet auto-scaling.
@return [Array<String>]

@!attribute [rw] instance_role_arn

A unique identifier for an AWS 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][1] in the AWS Management Console. Learn more about using
on-box credentials for your game servers at [ Access external
resources from a game server][2].

[1]: https://console.aws.amazon.com/iam/
[2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html
@return [String]

@!attribute [rw] certificate_configuration

Indicates whether a TLS/SSL certificate was generated for the fleet.
@return [Types::CertificateConfiguration]

@see docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/FleetAttributes AWS API Documentation

Constants

SENSITIVE