describe-fleet-attributes¶
Description¶
Retrieves core fleet-wide properties for fleets in an Amazon Web Services Region. Properties include the computing hardware and deployment configuration for instances in the fleet.
You can use this operation in the following ways:
- To get attributes for specific fleets, provide a list of fleet IDs or fleet ARNs.
- To get attributes for all fleets, do not provide a fleet identifier.
When requesting attributes for multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a FleetAttributes object is returned for each fleet requested, unless the fleet identifier is not found.
Note
Some API operations limit the number of fleet IDs that allowed in one request. If a request exceeds this limit, the request fails and the error message contains the maximum allowed number.
Learn more
See also: AWS API Documentation
describe-fleet-attributes is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument.
When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: FleetAttributes
Synopsis¶
describe-fleet-attributes
[--fleet-ids <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
Options¶
--fleet-ids (list)
A list of unique fleet identifiers to retrieve attributes for. You can use either the fleet ID or ARN value. To retrieve attributes for all current fleets, do not include this parameter.
Constraints:
- min:
1(string)
Constraints:
- min:
1- max:
512- pattern:
^[a-z]*fleet-[a-zA-Z0-9\-]+$|^arn:.*:[a-z]*fleet\/[a-z]*fleet-[a-zA-Z0-9\-]+$
Syntax:
"string" "string" ...
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--starting-token (string)
A token to specify where to start paginating. This is the
NextTokenfrom a previously truncated response.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--page-size (integer)
The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.
For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--max-items (integer)
The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a
NextTokenis provided in the command’s output. To resume pagination, provide theNextTokenvalue in thestarting-tokenargument of a subsequent command. Do not use theNextTokenresponse element directly outside of the AWS CLI.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
Global Options¶
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command’s default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output (string)
The formatting style for command output.
- json
- text
- table
- yaml
- yaml-stream
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
- on
- off
- auto
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format (string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (boolean)
Disable cli pager for output.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt (boolean)
Disable automatically prompt for CLI input parameters.
Examples¶
Note
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
Example1: To view attributes for a list of fleets
The following describe-fleet-attributes example retrieves fleet attributes for two specified fleets. As shown, the requested fleets are deployed with the same build, one for On-Demand instances and one for Spot instances, with some minor configuration differences.
aws gamelift describe-fleet-attributes \
--fleet-ids arn:aws:gamelift:us-west-2::fleet/fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222
Output:
{
"FleetAttributes": [
{
"FleetId": "fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"FleetArn": "arn:aws:gamelift:us-west-2::fleet/fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"FleetType": "ON_DEMAND",
"InstanceType": "c4.large",
"Description": "On-demand hosts for v2 North America",
"Name": "MegaFrogRaceServer.NA.v2-od",
"CreationTime": 1568836191.995,
"Status": "ACTIVE",
"BuildId": "build-a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
"BuildArn": "arn:aws:gamelift:us-west-2::build/build-a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
"ServerLaunchPath": "C:\\game\\MegaFrogRace_Server.exe",
"ServerLaunchParameters": "+gamelift_start_server",
"NewGameSessionProtectionPolicy": "NoProtection",
"OperatingSystem": "WINDOWS_2012",
"MetricGroups": [
"default"
],
"CertificateConfiguration": {
"CertificateType": "DISABLED"
}
},
{
"FleetId": "fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
"FleetArn": "arn:aws:gamelift:us-west-2::fleet/fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
"FleetType": "SPOT",
"InstanceType": "c4.large",
"Description": "On-demand hosts for v2 North America",
"Name": "MegaFrogRaceServer.NA.v2-spot",
"CreationTime": 1568838275.379,
"Status": "ACTIVATING",
"BuildId": "build-a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
"BuildArn": "arn:aws:gamelift:us-west-2::build/build-a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
"ServerLaunchPath": "C:\\game\\MegaFrogRace_Server.exe",
"NewGameSessionProtectionPolicy": "NoProtection",
"OperatingSystem": "WINDOWS_2012",
"MetricGroups": [
"default"
],
"CertificateConfiguration": {
"CertificateType": "GENERATED"
}
}
]
}
Example2: To request attributes for all fleets
The following describe-fleet-attributes returns fleet attributes for all fleets with any status. This example illustrates the use of pagination parameters to return one fleet at a time.
aws gamelift describe-fleet-attributes \
--limit 1
Output:
{
"FleetAttributes": [
{
"FleetId": "fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
"FleetArn": "arn:aws:gamelift:us-west-2::fleet/fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
"FleetType": "SPOT",
"InstanceType": "c4.large",
"Description": "On-demand hosts for v2 North America",
"Name": "MegaFrogRaceServer.NA.v2-spot",
"CreationTime": 1568838275.379,
"Status": "ACTIVATING",
"BuildId": "build-a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
"BuildArn": "arn:aws:gamelift:us-west-2::build/build-a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
"ServerLaunchPath": "C:\\game\\MegaFrogRace_Server.exe",
"NewGameSessionProtectionPolicy": "NoProtection",
"OperatingSystem": "WINDOWS_2012",
"MetricGroups": [
"default"
],
"CertificateConfiguration": {
"CertificateType": "GENERATED"
}
}
],
"NextToken": "eyJhd3NBY2NvdW50SWQiOnsicyI6IjMwMjc3NjAxNjM5OCJ9LCJidWlsZElkIjp7InMiOiJidWlsZC01NWYxZTZmMS1jY2FlLTQ3YTctOWI5ZS1iYjFkYTQwMjEXAMPLE2"
}
The output includes a NextToken value that you can use when you call the command a second time. Pass the value to the --next-token parameter to specify where to pick up the output. The following command returns the second result in the output.
aws gamelift describe-fleet-attributes \
--limit 1 \
--next-token eyJhd3NBY2NvdW50SWQiOnsicyI6IjMwMjc3NjAxNjM5OCJ9LCJidWlsZElkIjp7InMiOiJidWlsZC01NWYxZTZmMS1jY2FlLTQ3YTctOWI5ZS1iYjFkYTQwMjEXAMPLE1
Repeat until the response doesn’t include a NextToken value.
For more information, see Setting Up GameLift Fleets in the Amazon GameLift Developer Guide.
Output¶
FleetAttributes -> (list)
A collection of objects containing attribute metadata for each requested fleet ID. Attribute objects are returned only for fleets that currently exist.
(structure)
Describes an Amazon GameLift Servers fleet of game hosting resources. Attributes differ based on the fleet’s compute type, as follows:
- EC2 fleet attributes identify a
Buildresource (for fleets with customer game server builds) or aScriptresource (for Amazon GameLift Servers Realtime fleets).- Amazon GameLift Servers Anywhere fleets have an abbreviated set of attributes, because most fleet configurations are set directly on the fleet’s computes. Attributes include fleet identifiers and descriptive properties, creation/termination time, and fleet status.
FleetId -> (string)
A unique identifier for the fleet.
Constraints:
- min:
1- max:
128- pattern:
^[a-z]*fleet-[a-zA-Z0-9\-]+FleetArn -> (string)
The Amazon Resource Name (ARN ) that is assigned to a Amazon GameLift Servers 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 theFleetIdvalue.Constraints:
- min:
1- max:
512- pattern:
^arn:.*:[a-z]*fleet\/[a-z]*fleet-[a-zA-Z0-9\-]+$FleetType -> (string)
Indicates whether the fleet uses On-Demand or Spot instances. For more information, see On-Demand versus Spot Instances . This fleet property can’t be changed after the fleet is created.
Possible values:
ON_DEMANDSPOTInstanceType -> (string)
The Amazon EC2 instance type that the fleet uses. Instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions. This attribute is used with fleets where
ComputeTypeisEC2.Possible values:
t2.microt2.smallt2.mediumt2.largec3.largec3.xlargec3.2xlargec3.4xlargec3.8xlargec4.largec4.xlargec4.2xlargec4.4xlargec4.8xlargec5.largec5.xlargec5.2xlargec5.4xlargec5.9xlargec5.12xlargec5.18xlargec5.24xlargec5a.largec5a.xlargec5a.2xlargec5a.4xlargec5a.8xlargec5a.12xlargec5a.16xlargec5a.24xlarger3.larger3.xlarger3.2xlarger3.4xlarger3.8xlarger4.larger4.xlarger4.2xlarger4.4xlarger4.8xlarger4.16xlarger5.larger5.xlarger5.2xlarger5.4xlarger5.8xlarger5.12xlarger5.16xlarger5.24xlarger5a.larger5a.xlarger5a.2xlarger5a.4xlarger5a.8xlarger5a.12xlarger5a.16xlarger5a.24xlargem3.mediumm3.largem3.xlargem3.2xlargem4.largem4.xlargem4.2xlargem4.4xlargem4.10xlargem5.largem5.xlargem5.2xlargem5.4xlargem5.8xlargem5.12xlargem5.16xlargem5.24xlargem5a.largem5a.xlargem5a.2xlargem5a.4xlargem5a.8xlargem5a.12xlargem5a.16xlargem5a.24xlargec5d.largec5d.xlargec5d.2xlargec5d.4xlargec5d.9xlargec5d.12xlargec5d.18xlargec5d.24xlargec6a.largec6a.xlargec6a.2xlargec6a.4xlargec6a.8xlargec6a.12xlargec6a.16xlargec6a.24xlargec6i.largec6i.xlargec6i.2xlargec6i.4xlargec6i.8xlargec6i.12xlargec6i.16xlargec6i.24xlarger5d.larger5d.xlarger5d.2xlarger5d.4xlarger5d.8xlarger5d.12xlarger5d.16xlarger5d.24xlargem6g.mediumm6g.largem6g.xlargem6g.2xlargem6g.4xlargem6g.8xlargem6g.12xlargem6g.16xlargec6g.mediumc6g.largec6g.xlargec6g.2xlargec6g.4xlargec6g.8xlargec6g.12xlargec6g.16xlarger6g.mediumr6g.larger6g.xlarger6g.2xlarger6g.4xlarger6g.8xlarger6g.12xlarger6g.16xlargec6gn.mediumc6gn.largec6gn.xlargec6gn.2xlargec6gn.4xlargec6gn.8xlargec6gn.12xlargec6gn.16xlargec7g.mediumc7g.largec7g.xlargec7g.2xlargec7g.4xlargec7g.8xlargec7g.12xlargec7g.16xlarger7g.mediumr7g.larger7g.xlarger7g.2xlarger7g.4xlarger7g.8xlarger7g.12xlarger7g.16xlargem7g.mediumm7g.largem7g.xlargem7g.2xlargem7g.4xlargem7g.8xlargem7g.12xlargem7g.16xlargeg5g.xlargeg5g.2xlargeg5g.4xlargeg5g.8xlargeg5g.16xlarger6i.larger6i.xlarger6i.2xlarger6i.4xlarger6i.8xlarger6i.12xlarger6i.16xlargec6gd.mediumc6gd.largec6gd.xlargec6gd.2xlargec6gd.4xlargec6gd.8xlargec6gd.12xlargec6gd.16xlargec6in.largec6in.xlargec6in.2xlargec6in.4xlargec6in.8xlargec6in.12xlargec6in.16xlargec7a.mediumc7a.largec7a.xlargec7a.2xlargec7a.4xlargec7a.8xlargec7a.12xlargec7a.16xlargec7gd.mediumc7gd.largec7gd.xlargec7gd.2xlargec7gd.4xlargec7gd.8xlargec7gd.12xlargec7gd.16xlargec7gn.mediumc7gn.largec7gn.xlargec7gn.2xlargec7gn.4xlargec7gn.8xlargec7gn.12xlargec7gn.16xlargec7i.largec7i.xlargec7i.2xlargec7i.4xlargec7i.8xlargec7i.12xlargec7i.16xlargem6a.largem6a.xlargem6a.2xlargem6a.4xlargem6a.8xlargem6a.12xlargem6a.16xlargem6gd.mediumm6gd.largem6gd.xlargem6gd.2xlargem6gd.4xlargem6gd.8xlargem6gd.12xlargem6gd.16xlargem6i.largem6i.xlargem6i.2xlargem6i.4xlargem6i.8xlargem6i.12xlargem6i.16xlargem7a.mediumm7a.largem7a.xlargem7a.2xlargem7a.4xlargem7a.8xlargem7a.12xlargem7a.16xlargem7gd.mediumm7gd.largem7gd.xlargem7gd.2xlargem7gd.4xlargem7gd.8xlargem7gd.12xlargem7gd.16xlargem7i.largem7i.xlargem7i.2xlargem7i.4xlargem7i.8xlargem7i.12xlargem7i.16xlarger6gd.mediumr6gd.larger6gd.xlarger6gd.2xlarger6gd.4xlarger6gd.8xlarger6gd.12xlarger6gd.16xlarger7a.mediumr7a.larger7a.xlarger7a.2xlarger7a.4xlarger7a.8xlarger7a.12xlarger7a.16xlarger7gd.mediumr7gd.larger7gd.xlarger7gd.2xlarger7gd.4xlarger7gd.8xlarger7gd.12xlarger7gd.16xlarger7i.larger7i.xlarger7i.2xlarger7i.4xlarger7i.8xlarger7i.12xlarger7i.16xlarger7i.24xlarger7i.48xlargec5ad.largec5ad.xlargec5ad.2xlargec5ad.4xlargec5ad.8xlargec5ad.12xlargec5ad.16xlargec5ad.24xlargec5n.largec5n.xlargec5n.2xlargec5n.4xlargec5n.9xlargec5n.18xlarger5ad.larger5ad.xlarger5ad.2xlarger5ad.4xlarger5ad.8xlarger5ad.12xlarger5ad.16xlarger5ad.24xlargec6id.largec6id.xlargec6id.2xlargec6id.4xlargec6id.8xlargec6id.12xlargec6id.16xlargec6id.24xlargec6id.32xlargec8g.mediumc8g.largec8g.xlargec8g.2xlargec8g.4xlargec8g.8xlargec8g.12xlargec8g.16xlargec8g.24xlargec8g.48xlargem5ad.largem5ad.xlargem5ad.2xlargem5ad.4xlargem5ad.8xlargem5ad.12xlargem5ad.16xlargem5ad.24xlargem5d.largem5d.xlargem5d.2xlargem5d.4xlargem5d.8xlargem5d.12xlargem5d.16xlargem5d.24xlargem5dn.largem5dn.xlargem5dn.2xlargem5dn.4xlargem5dn.8xlargem5dn.12xlargem5dn.16xlargem5dn.24xlargem5n.largem5n.xlargem5n.2xlargem5n.4xlargem5n.8xlargem5n.12xlargem5n.16xlargem5n.24xlargem6id.largem6id.xlargem6id.2xlargem6id.4xlargem6id.8xlargem6id.12xlargem6id.16xlargem6id.24xlargem6id.32xlargem6idn.largem6idn.xlargem6idn.2xlargem6idn.4xlargem6idn.8xlargem6idn.12xlargem6idn.16xlargem6idn.24xlargem6idn.32xlargem6in.largem6in.xlargem6in.2xlargem6in.4xlargem6in.8xlargem6in.12xlargem6in.16xlargem6in.24xlargem6in.32xlargem8g.mediumm8g.largem8g.xlargem8g.2xlargem8g.4xlargem8g.8xlargem8g.12xlargem8g.16xlargem8g.24xlargem8g.48xlarger5dn.larger5dn.xlarger5dn.2xlarger5dn.4xlarger5dn.8xlarger5dn.12xlarger5dn.16xlarger5dn.24xlarger5n.larger5n.xlarger5n.2xlarger5n.4xlarger5n.8xlarger5n.12xlarger5n.16xlarger5n.24xlarger6a.larger6a.xlarger6a.2xlarger6a.4xlarger6a.8xlarger6a.12xlarger6a.16xlarger6a.24xlarger6a.32xlarger6a.48xlarger6id.larger6id.xlarger6id.2xlarger6id.4xlarger6id.8xlarger6id.12xlarger6id.16xlarger6id.24xlarger6id.32xlarger6idn.larger6idn.xlarger6idn.2xlarger6idn.4xlarger6idn.8xlarger6idn.12xlarger6idn.16xlarger6idn.24xlarger6idn.32xlarger6in.larger6in.xlarger6in.2xlarger6in.4xlarger6in.8xlarger6in.12xlarger6in.16xlarger6in.24xlarger6in.32xlarger8g.mediumr8g.larger8g.xlarger8g.2xlarger8g.4xlarger8g.8xlarger8g.12xlarger8g.16xlarger8g.24xlarger8g.48xlargem4.16xlargec6a.32xlargec6a.48xlargec6i.32xlarger6i.24xlarger6i.32xlargec6in.24xlargec6in.32xlargec7a.24xlargec7a.32xlargec7a.48xlargec7i.24xlargec7i.48xlargem6a.24xlargem6a.32xlargem6a.48xlargem6i.24xlargem6i.32xlargem7a.24xlargem7a.32xlargem7a.48xlargem7i.24xlargem7i.48xlarger7a.24xlarger7a.32xlarger7a.48xlargeDescription -> (string)
A human-readable description of the fleet.
Constraints:
- min:
1- max:
1024Name -> (string)
A descriptive label that is associated with a fleet. Fleet names do not need to be unique.
Constraints:
- min:
1- max:
1024CreationTime -> (timestamp)
A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example"1469498468.057").TerminationTime -> (timestamp)
A time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example"1469498468.057").Status -> (string)
Current status of the fleet. Possible fleet statuses include the following:
- NEW – A new fleet resource has been defined and Amazon GameLift Servers has started creating the fleet. Desired instances is set to 1.
- DOWNLOADING/VALIDATING/BUILDING – Amazon GameLift Servers is download the game server build, running install scripts, and then validating the build files. When complete, Amazon GameLift Servers launches a fleet instance.
- ACTIVATING – Amazon GameLift Servers is launching a game server process and testing its connectivity with the Amazon GameLift Servers service.
- ACTIVE – The fleet is now ready to host 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.
Possible values:
NEWDOWNLOADINGVALIDATINGBUILDINGACTIVATINGACTIVEDELETINGERRORTERMINATEDNOT_FOUNDBuildId -> (string)
A unique identifier for the build resource that is deployed on instances in this fleet. This attribute is used with fleets where
ComputeTypeis “EC2”.Constraints:
- pattern:
^build-\S+BuildArn -> (string)
The Amazon Resource Name (ARN ) associated with the Amazon GameLift Servers build resource that is deployed on instances in this fleet. In a GameLift build ARN, the resource ID matches the
BuildIdvalue. This attribute is used with fleets whereComputeTypeis “EC2”.Constraints:
- pattern:
^arn:.*:build\/build-\S+ScriptId -> (string)
A unique identifier for the Realtime script resource that is deployed on instances in this fleet. This attribute is used with fleets where
ComputeTypeis “EC2”.Constraints:
- pattern:
^script-\S+ScriptArn -> (string)
The Amazon Resource Name (ARN ) associated with the GameLift script resource that is deployed on instances in this fleet. In a GameLift script ARN, the resource ID matches the
ScriptIdvalue.Constraints:
- pattern:
^arn:.*:script\/script-\S+ServerLaunchPath -> (string)
This parameter is no longer used. Server launch paths are now defined using the fleet’s RuntimeConfiguration . Requests that use this parameter continue to be valid.Constraints:
- min:
1- max:
1024- pattern:
[A-Za-z0-9_:.+\/\\\- ]+ServerLaunchParameters -> (string)
This parameter is no longer used. Server launch parameters are now defined using the fleet’s runtime configuration. Requests that use this parameter continue to be valid.Constraints:
- min:
1- max:
1024- pattern:
[A-Za-z0-9_:.+\/\\\- =@;{},?'\[\]"]+LogPaths -> (list)
This parameter is no longer used. Game session log paths are now defined using the Amazon GameLift Servers server APIProcessReady()logParameters. See more information in the Server API Reference .(string)
Constraints:
- min:
1- max:
1024NewGameSessionProtectionPolicy -> (string)
The type of game session protection to set on all new instances that are started in the fleet. This attribute is used with fleets where
ComputeTypeisEC2.
- NoProtection – The game session can be terminated during a scale-down event.
- FullProtection – If the game session is in an
ACTIVEstatus, it cannot be terminated during a scale-down event.Possible values:
NoProtectionFullProtectionOperatingSystem -> (string)
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. This attribute is used with fleets where
ComputeTypeisEC2.Note
Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more details in the Amazon Linux 2 FAQs . For game servers that are hosted on AL2 and use server SDK version 4.x for Amazon GameLift Servers, first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See Migrate to server SDK version 5.Possible values:
WINDOWS_2012AMAZON_LINUXAMAZON_LINUX_2WINDOWS_2016AMAZON_LINUX_2023ResourceCreationLimitPolicy -> (structure)
A policy that puts limits on the number of game sessions that a player can create within a specified span of time. With this policy, you can control players’ ability to consume available resources.
The policy is evaluated when a player tries to create a new game session. On receiving a
CreateGameSessionrequest, Amazon GameLift Servers checks that the player (identified byCreatorId) has created fewer than game session limit in the specified time period.NewGameSessionsPerCreator -> (integer)
A policy that puts limits on the number of game sessions that a player can create within a specified span of time. With this policy, you can control players’ ability to consume available resources.
The policy is evaluated when a player tries to create a new game session. On receiving a
CreateGameSessionrequest, Amazon GameLift Servers checks that the player (identified byCreatorId) has created fewer than game session limit in the specified time period.Constraints:
- min:
0PolicyPeriodInMinutes -> (integer)
The time span used in evaluating the resource creation limit policy.
Constraints:
- min:
0MetricGroups -> (list)
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. This attribute is used with fleets where
ComputeTypeisEC2.Constraints:
- max:
1(string)
Constraints:
- min:
1- max:
255StoppedActions -> (list)
A list of fleet activity that has been suspended using StopFleetActions . This includes fleet auto-scaling. This attribute is used with fleets where
ComputeTypeisEC2.Constraints:
- min:
1- max:
1(string)
Possible values:
AUTO_SCALINGInstanceRoleArn -> (string)
A unique identifier for an IAM role that manages access to your Amazon Web Services 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 in the Amazon Web Services Management Console. Learn more about using on-box credentials for your game servers at Access external resources from a game server . This attribute is used with fleets where
ComputeTypeisEC2.Constraints:
- min:
1CertificateConfiguration -> (structure)
Determines whether a TLS/SSL certificate is generated for a fleet. This feature must be enabled when creating the fleet. All instances in a fleet share the same certificate.
CertificateType -> (string) [required]
Indicates whether a TLS/SSL certificate is generated for a fleet.
Valid values include:
- GENERATED - Generate a TLS/SSL certificate for this fleet.
- DISABLED - (default) Do not generate a TLS/SSL certificate for this fleet.
Possible values:
DISABLEDGENERATEDComputeType -> (string)
The type of compute resource used to host your game servers. You can use your own compute resources with Amazon GameLift Servers Anywhere or use Amazon EC2 instances with managed Amazon GameLift Servers.
Possible values:
EC2ANYWHEREAnywhereConfiguration -> (structure)
A set of attributes that are specific to an Anywhere fleet.
Cost -> (string) [required]
The cost to run your fleet per hour. Amazon GameLift Servers uses the provided cost of your fleet to balance usage in queues. For more information about queues, see Setting up queues in the Amazon GameLift Servers Developer Guide .
Constraints:
- min:
1- max:
11- pattern:
^\d{1,5}(?:\.\d{1,5})?$InstanceRoleCredentialsProvider -> (string)
Indicates that fleet instances maintain a shared credentials file for the IAM role defined in
InstanceRoleArn. Shared credentials allow applications that are deployed with the game server executable to communicate with other Amazon Web Services resources. This property is used only when the game server is integrated with the server SDK version 5.x. For more information about using shared credentials, see Communicate with other Amazon Web Services resources from your fleets . This attribute is used with fleets whereComputeTypeisEC2.Possible values:
SHARED_CREDENTIAL_FILE
NextToken -> (string)
A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.
Constraints:
- min:
1- max:
1024