aws-sdk-gamelift 1.69.0 → 1.70.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-gamelift/client.rb +233 -157
- data/lib/aws-sdk-gamelift/types.rb +189 -142
- data/lib/aws-sdk-gamelift.rb +1 -1
- metadata +2 -2
@@ -163,27 +163,36 @@ module Aws::GameLift
|
|
163
163
|
include Aws::Structure
|
164
164
|
end
|
165
165
|
|
166
|
-
#
|
167
|
-
# Amazon GameLift
|
168
|
-
#
|
169
|
-
#
|
166
|
+
# Amazon Web Services account security credentials that allow
|
167
|
+
# interactions with Amazon GameLift resources. The credentials are
|
168
|
+
# temporary and valid for a limited time span. You can request fresh
|
169
|
+
# credentials at any time.
|
170
170
|
#
|
171
|
+
# Amazon Web Services security credentials consist of three parts: an
|
172
|
+
# access key ID, a secret access key, and a session token. You must use
|
173
|
+
# all three parts together to authenticate your access requests.
|
171
174
|
#
|
175
|
+
# You need Amazon Web Services credentials for the following tasks:
|
172
176
|
#
|
173
|
-
#
|
177
|
+
# * To upload a game server build directly to Amazon GameLift S3 storage
|
178
|
+
# using `CreateBuild`. To get access for this task, call
|
179
|
+
# RequestUploadCredentials.
|
180
|
+
#
|
181
|
+
# * To remotely connect to an active Amazon GameLift fleet instances. To
|
182
|
+
# get remote access, call GetComputeAccess.
|
174
183
|
#
|
175
184
|
# @!attribute [rw] access_key_id
|
176
|
-
#
|
185
|
+
# The access key ID that identifies the temporary security
|
186
|
+
# credentials.
|
177
187
|
# @return [String]
|
178
188
|
#
|
179
189
|
# @!attribute [rw] secret_access_key
|
180
|
-
#
|
181
|
-
# account.
|
190
|
+
# The secret access key that can be used to sign requests.
|
182
191
|
# @return [String]
|
183
192
|
#
|
184
193
|
# @!attribute [rw] session_token
|
185
|
-
#
|
186
|
-
#
|
194
|
+
# The token that users must pass to the service API to use the
|
195
|
+
# temporary credentials.
|
187
196
|
# @return [String]
|
188
197
|
#
|
189
198
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/AwsCredentials AWS API Documentation
|
@@ -387,36 +396,38 @@ module Aws::GameLift
|
|
387
396
|
include Aws::Structure
|
388
397
|
end
|
389
398
|
|
390
|
-
#
|
391
|
-
#
|
399
|
+
# An Amazon GameLift compute resource for hosting your game servers. A
|
400
|
+
# compute can be an EC2instance in a managed EC2 fleet or a registered
|
401
|
+
# compute in an Anywhere fleet.
|
392
402
|
#
|
393
403
|
# @!attribute [rw] fleet_id
|
394
|
-
# A unique identifier for the fleet that the compute
|
404
|
+
# A unique identifier for the fleet that the compute belongs to.
|
395
405
|
# @return [String]
|
396
406
|
#
|
397
407
|
# @!attribute [rw] fleet_arn
|
398
|
-
# The Amazon Resource Name (ARN) of the fleet that the compute
|
399
|
-
#
|
408
|
+
# The Amazon Resource Name (ARN) of the fleet that the compute belongs
|
409
|
+
# to.
|
400
410
|
# @return [String]
|
401
411
|
#
|
402
412
|
# @!attribute [rw] compute_name
|
403
|
-
# A descriptive label
|
404
|
-
#
|
413
|
+
# A descriptive label for the compute resource. For instances in a
|
414
|
+
# managed EC2 fleet, the compute name is an instance ID.
|
405
415
|
# @return [String]
|
406
416
|
#
|
407
417
|
# @!attribute [rw] compute_arn
|
408
|
-
# The ARN that is assigned to
|
409
|
-
# identifies it. ARNs are unique across locations.
|
418
|
+
# The ARN that is assigned to a compute resource and uniquely
|
419
|
+
# identifies it. ARNs are unique across locations. Instances in
|
420
|
+
# managed EC2 fleets are not assigned a ComputeARN.
|
410
421
|
# @return [String]
|
411
422
|
#
|
412
423
|
# @!attribute [rw] ip_address
|
413
|
-
# The IP address of
|
414
|
-
#
|
424
|
+
# The IP address of a compute resource. Amazon GameLift requires a DNS
|
425
|
+
# name or IP address for a compute.
|
415
426
|
# @return [String]
|
416
427
|
#
|
417
428
|
# @!attribute [rw] dns_name
|
418
|
-
# The DNS name of
|
419
|
-
#
|
429
|
+
# The DNS name of a compute resource. Amazon GameLift requires a DNS
|
430
|
+
# name or IP address for a compute.
|
420
431
|
# @return [String]
|
421
432
|
#
|
422
433
|
# @!attribute [rw] compute_status
|
@@ -436,17 +447,19 @@ module Aws::GameLift
|
|
436
447
|
# @return [Time]
|
437
448
|
#
|
438
449
|
# @!attribute [rw] operating_system
|
439
|
-
# The type of operating system on
|
450
|
+
# The type of operating system on the compute resource.
|
440
451
|
# @return [String]
|
441
452
|
#
|
442
453
|
# @!attribute [rw] type
|
443
|
-
# The
|
444
|
-
#
|
454
|
+
# The Amazon EC2 instance type that the fleet uses. For registered
|
455
|
+
# computes in an Amazon GameLift Anywhere fleet, this property is
|
456
|
+
# empty.
|
445
457
|
# @return [String]
|
446
458
|
#
|
447
459
|
# @!attribute [rw] game_lift_service_sdk_endpoint
|
448
|
-
# The
|
449
|
-
#
|
460
|
+
# The Amazon GameLift SDK endpoint connection for a registered compute
|
461
|
+
# resource in an Anywhere fleet. The game servers on the compute use
|
462
|
+
# this endpoint to connect to the Amazon GameLift service.
|
450
463
|
# @return [String]
|
451
464
|
#
|
452
465
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/Compute AWS API Documentation
|
@@ -1247,7 +1260,9 @@ module Aws::GameLift
|
|
1247
1260
|
# A fleet's remote location to place the new game session in. If this
|
1248
1261
|
# parameter is not set, the new game session is placed in the fleet's
|
1249
1262
|
# home Region. Specify a remote location with an Amazon Web Services
|
1250
|
-
# Region code such as `us-west-2`.
|
1263
|
+
# Region code such as `us-west-2`. When using an Anywhere fleet, this
|
1264
|
+
# parameter is required and must be set to the Anywhere fleet's
|
1265
|
+
# custom location.
|
1251
1266
|
# @return [String]
|
1252
1267
|
#
|
1253
1268
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateGameSessionInput AWS API Documentation
|
@@ -2184,12 +2199,13 @@ module Aws::GameLift
|
|
2184
2199
|
class DeleteVpcPeeringConnectionOutput < Aws::EmptyStructure; end
|
2185
2200
|
|
2186
2201
|
# @!attribute [rw] fleet_id
|
2187
|
-
#
|
2202
|
+
# A unique identifier for the fleet the compute resource is currently
|
2188
2203
|
# registered to.
|
2189
2204
|
# @return [String]
|
2190
2205
|
#
|
2191
2206
|
# @!attribute [rw] compute_name
|
2192
|
-
# The name of the compute resource
|
2207
|
+
# The name of the compute resource to remove from the specified
|
2208
|
+
# Anywhere fleet.
|
2193
2209
|
# @return [String]
|
2194
2210
|
#
|
2195
2211
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeregisterComputeInput AWS API Documentation
|
@@ -2275,12 +2291,14 @@ module Aws::GameLift
|
|
2275
2291
|
end
|
2276
2292
|
|
2277
2293
|
# @!attribute [rw] fleet_id
|
2278
|
-
# A unique identifier for the fleet the compute is registered to.
|
2294
|
+
# A unique identifier for the fleet that the compute is registered to.
|
2295
|
+
# You can use either the fleet ID or ARN value.
|
2279
2296
|
# @return [String]
|
2280
2297
|
#
|
2281
2298
|
# @!attribute [rw] compute_name
|
2282
|
-
#
|
2283
|
-
#
|
2299
|
+
# The unique identifier of the compute resource to retrieve properties
|
2300
|
+
# for. For an Anywhere fleet compute, use the registered compute name.
|
2301
|
+
# For a managed EC2 fleet instance, use the instance ID.
|
2284
2302
|
# @return [String]
|
2285
2303
|
#
|
2286
2304
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeComputeInput AWS API Documentation
|
@@ -2293,8 +2311,7 @@ module Aws::GameLift
|
|
2293
2311
|
end
|
2294
2312
|
|
2295
2313
|
# @!attribute [rw] compute
|
2296
|
-
# The
|
2297
|
-
# fleet.
|
2314
|
+
# The set of properties for the requested compute resource.
|
2298
2315
|
# @return [Types::Compute]
|
2299
2316
|
#
|
2300
2317
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeComputeOutput AWS API Documentation
|
@@ -2425,7 +2442,8 @@ module Aws::GameLift
|
|
2425
2442
|
# @!attribute [rw] fleet_capacity
|
2426
2443
|
# A collection of objects that contains capacity information for each
|
2427
2444
|
# requested fleet ID. Capacity objects are returned only for fleets
|
2428
|
-
# that currently exist.
|
2445
|
+
# that currently exist. Changes in desired instance value can take up
|
2446
|
+
# to 1 minute to be reflected.
|
2429
2447
|
# @return [Array<Types::FleetCapacity>]
|
2430
2448
|
#
|
2431
2449
|
# @!attribute [rw] next_token
|
@@ -2602,7 +2620,8 @@ module Aws::GameLift
|
|
2602
2620
|
# @!attribute [rw] fleet_capacity
|
2603
2621
|
# Resource capacity information for the requested fleet location.
|
2604
2622
|
# Capacity objects are returned only for fleets and locations that
|
2605
|
-
# currently exist.
|
2623
|
+
# currently exist. Changes in desired instance value can take up to 1
|
2624
|
+
# minute to be reflected.
|
2606
2625
|
# @return [Types::FleetCapacity]
|
2607
2626
|
#
|
2608
2627
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeFleetLocationCapacityOutput AWS API Documentation
|
@@ -3563,9 +3582,11 @@ module Aws::GameLift
|
|
3563
3582
|
# temporarily affected.
|
3564
3583
|
#
|
3565
3584
|
# @!attribute [rw] desired
|
3566
|
-
#
|
3567
|
-
# maintain the desired number of instances. Capacity is
|
3568
|
-
# down by changing the desired instances.
|
3585
|
+
# Requested number of active instances. Amazon GameLift takes action
|
3586
|
+
# as needed to maintain the desired number of instances. Capacity is
|
3587
|
+
# scaled up or down by changing the desired instances. A change in the
|
3588
|
+
# desired instances value can take up to 1 minute to be reflected when
|
3589
|
+
# viewing a fleet's capacity settings.
|
3569
3590
|
# @return [Integer]
|
3570
3591
|
#
|
3571
3592
|
# @!attribute [rw] minimum
|
@@ -3776,7 +3797,9 @@ module Aws::GameLift
|
|
3776
3797
|
# * INSTANCE\_INTERRUPTED -- A spot instance was interrupted by EC2
|
3777
3798
|
# with a two-minute notification.
|
3778
3799
|
#
|
3779
|
-
#
|
3800
|
+
# * INSTANCE\_RECYCLED -- A spot instance was determined to have a
|
3801
|
+
# high risk of interruption and is scheduled to be recycled once it
|
3802
|
+
# has no active game sessions.
|
3780
3803
|
#
|
3781
3804
|
# **Server process events:**
|
3782
3805
|
#
|
@@ -4654,8 +4677,8 @@ module Aws::GameLift
|
|
4654
4677
|
# A game session in ACTIVE status can host players. When a game session
|
4655
4678
|
# ends, its status is set to `TERMINATED`.
|
4656
4679
|
#
|
4657
|
-
#
|
4658
|
-
#
|
4680
|
+
# Amazon GameLift retains a game session resource for 30 days after the
|
4681
|
+
# game session ends. You can reuse idempotency token values after this
|
4659
4682
|
# time. Game session logs are retained for 14 days.
|
4660
4683
|
#
|
4661
4684
|
# [All APIs by task][1]
|
@@ -4784,14 +4807,13 @@ module Aws::GameLift
|
|
4784
4807
|
# @return [String]
|
4785
4808
|
#
|
4786
4809
|
# @!attribute [rw] matchmaker_data
|
4787
|
-
# Information about the matchmaking process that
|
4788
|
-
#
|
4789
|
-
#
|
4790
|
-
#
|
4791
|
-
#
|
4792
|
-
#
|
4793
|
-
#
|
4794
|
-
# backfill (see [StartMatchBackfill][2]).
|
4810
|
+
# Information about the matchmaking process that resulted in the game
|
4811
|
+
# session, if matchmaking was used. Data is in JSON syntax, formatted
|
4812
|
+
# as a string. Information includes the matchmaker ID as well as
|
4813
|
+
# player attributes and team assignments. For more details on
|
4814
|
+
# matchmaker data, see [Match Data][1]. Matchmaker data is updated
|
4815
|
+
# whenever new players are added during a successful backfill (see
|
4816
|
+
# [StartMatchBackfill][2]).
|
4795
4817
|
#
|
4796
4818
|
#
|
4797
4819
|
#
|
@@ -4931,8 +4953,19 @@ module Aws::GameLift
|
|
4931
4953
|
include Aws::Structure
|
4932
4954
|
end
|
4933
4955
|
|
4934
|
-
#
|
4935
|
-
#
|
4956
|
+
# Represents a potential game session placement, including the full
|
4957
|
+
# details of the original placement request and the current status.
|
4958
|
+
#
|
4959
|
+
# <note markdown="1"> If the game session placement status is `PENDING`, the properties for
|
4960
|
+
# game session ID/ARN, region, IP address/DNS, and port aren't final. A
|
4961
|
+
# game session is not active and ready to accept players until placement
|
4962
|
+
# status reaches `FULFILLED`. When the placement is in `PENDING` status,
|
4963
|
+
# Amazon GameLift may attempt to place a game session multiple times
|
4964
|
+
# before succeeding. With each attempt it creates a GameSession object
|
4965
|
+
# and updates this placement object with the new game session
|
4966
|
+
# properties..
|
4967
|
+
#
|
4968
|
+
# </note>
|
4936
4969
|
#
|
4937
4970
|
# @!attribute [rw] placement_id
|
4938
4971
|
# A unique identifier for a game session placement.
|
@@ -4946,12 +4979,11 @@ module Aws::GameLift
|
|
4946
4979
|
# @!attribute [rw] status
|
4947
4980
|
# Current status of the game session placement request.
|
4948
4981
|
#
|
4949
|
-
# * **PENDING** -- The placement request is
|
4950
|
-
#
|
4982
|
+
# * **PENDING** -- The placement request is in the queue waiting to be
|
4983
|
+
# processed. Game session properties are not yet final.
|
4951
4984
|
#
|
4952
|
-
# * **FULFILLED** -- A new game session
|
4953
|
-
#
|
4954
|
-
# *GameSessionArn* and *GameSessionRegion* are available.
|
4985
|
+
# * **FULFILLED** -- A new game session has been successfully placed.
|
4986
|
+
# Game session properties are now final.
|
4955
4987
|
#
|
4956
4988
|
# * **CANCELLED** -- The placement request was canceled.
|
4957
4989
|
#
|
@@ -4987,22 +5019,20 @@ module Aws::GameLift
|
|
4987
5019
|
# @return [String]
|
4988
5020
|
#
|
4989
5021
|
# @!attribute [rw] game_session_id
|
4990
|
-
# A unique identifier for the game session. This value
|
4991
|
-
#
|
5022
|
+
# A unique identifier for the game session. This value isn't final
|
5023
|
+
# until placement status is `FULFILLED`.
|
4992
5024
|
# @return [String]
|
4993
5025
|
#
|
4994
5026
|
# @!attribute [rw] game_session_arn
|
4995
5027
|
# Identifier for the game session created by this placement request.
|
4996
|
-
# This
|
4997
|
-
# status is `FULFILLED
|
4998
|
-
# Regions. You can use this value as a `GameSessionId` value as
|
4999
|
-
# needed.
|
5028
|
+
# This identifier is unique across all Regions. This value isn't
|
5029
|
+
# final until placement status is `FULFILLED`.
|
5000
5030
|
# @return [String]
|
5001
5031
|
#
|
5002
5032
|
# @!attribute [rw] game_session_region
|
5003
5033
|
# Name of the Region where the game session created by this placement
|
5004
|
-
# request is running. This value
|
5005
|
-
#
|
5034
|
+
# request is running. This value isn't final until placement status
|
5035
|
+
# is `FULFILLED`.
|
5006
5036
|
# @return [String]
|
5007
5037
|
#
|
5008
5038
|
# @!attribute [rw] player_latencies
|
@@ -5025,8 +5055,7 @@ module Aws::GameLift
|
|
5025
5055
|
# @!attribute [rw] ip_address
|
5026
5056
|
# The IP address of the game session. To connect to a Amazon GameLift
|
5027
5057
|
# game server, an app needs both the IP address and port number. This
|
5028
|
-
# value
|
5029
|
-
# is `FULFILLED`).
|
5058
|
+
# value isn't final until placement status is `FULFILLED`.
|
5030
5059
|
# @return [String]
|
5031
5060
|
#
|
5032
5061
|
# @!attribute [rw] dns_name
|
@@ -5051,17 +5080,17 @@ module Aws::GameLift
|
|
5051
5080
|
# @!attribute [rw] port
|
5052
5081
|
# The port number for the game session. To connect to a Amazon
|
5053
5082
|
# GameLift game server, an app needs both the IP address and port
|
5054
|
-
# number. This value
|
5055
|
-
#
|
5083
|
+
# number. This value isn't final until placement status is
|
5084
|
+
# `FULFILLED`.
|
5056
5085
|
# @return [Integer]
|
5057
5086
|
#
|
5058
5087
|
# @!attribute [rw] placed_player_sessions
|
5059
5088
|
# A collection of information on player sessions created in response
|
5060
5089
|
# to the game session placement request. These player sessions are
|
5061
|
-
# created only
|
5090
|
+
# created only after a new game session is successfully placed
|
5062
5091
|
# (placement status is `FULFILLED`). This information includes the
|
5063
|
-
# player ID
|
5064
|
-
#
|
5092
|
+
# player ID, provided in the placement request, and a corresponding
|
5093
|
+
# player session ID.
|
5065
5094
|
# @return [Array<Types::PlacedPlayerSession>]
|
5066
5095
|
#
|
5067
5096
|
# @!attribute [rw] game_session_data
|
@@ -5224,12 +5253,15 @@ module Aws::GameLift
|
|
5224
5253
|
end
|
5225
5254
|
|
5226
5255
|
# @!attribute [rw] fleet_id
|
5227
|
-
# A unique identifier for the fleet that the compute resource
|
5228
|
-
#
|
5256
|
+
# A unique identifier for the fleet that contains the compute resource
|
5257
|
+
# you want to connect to. You can use either the fleet ID or ARN
|
5258
|
+
# value.
|
5229
5259
|
# @return [String]
|
5230
5260
|
#
|
5231
5261
|
# @!attribute [rw] compute_name
|
5232
|
-
#
|
5262
|
+
# A unique identifier for the compute resource that you want to
|
5263
|
+
# connect to. You can use either a registered compute name or an
|
5264
|
+
# instance ID.
|
5233
5265
|
# @return [String]
|
5234
5266
|
#
|
5235
5267
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/GetComputeAccessInput AWS API Documentation
|
@@ -5242,7 +5274,8 @@ module Aws::GameLift
|
|
5242
5274
|
end
|
5243
5275
|
|
5244
5276
|
# @!attribute [rw] fleet_id
|
5245
|
-
# The
|
5277
|
+
# The ID of the fleet that contains the compute resource to be
|
5278
|
+
# accessed.
|
5246
5279
|
# @return [String]
|
5247
5280
|
#
|
5248
5281
|
# @!attribute [rw] fleet_arn
|
@@ -5257,11 +5290,12 @@ module Aws::GameLift
|
|
5257
5290
|
# @return [String]
|
5258
5291
|
#
|
5259
5292
|
# @!attribute [rw] compute_name
|
5260
|
-
# The
|
5293
|
+
# The identifier of the compute resource to be accessed. This value
|
5294
|
+
# might be either a compute name or an instance ID.
|
5261
5295
|
# @return [String]
|
5262
5296
|
#
|
5263
5297
|
# @!attribute [rw] compute_arn
|
5264
|
-
# The Amazon Resource Name ([ARN][1]) that is assigned to
|
5298
|
+
# The Amazon Resource Name ([ARN][1]) that is assigned to an Amazon
|
5265
5299
|
# GameLift compute resource and uniquely identifies it. ARNs are
|
5266
5300
|
# unique across all Regions. Format is
|
5267
5301
|
# `arn:aws:gamelift:<region>::compute/compute-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912`.
|
@@ -5272,7 +5306,9 @@ module Aws::GameLift
|
|
5272
5306
|
# @return [String]
|
5273
5307
|
#
|
5274
5308
|
# @!attribute [rw] credentials
|
5275
|
-
#
|
5309
|
+
# A set of temporary Amazon Web Services credentials for use when
|
5310
|
+
# connecting to the compute resource with Amazon EC2 Systems Manager
|
5311
|
+
# (SSM).
|
5276
5312
|
# @return [Types::AwsCredentials]
|
5277
5313
|
#
|
5278
5314
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/GetComputeAccessOutput AWS API Documentation
|
@@ -5321,15 +5357,15 @@ module Aws::GameLift
|
|
5321
5357
|
# @return [String]
|
5322
5358
|
#
|
5323
5359
|
# @!attribute [rw] compute_name
|
5324
|
-
# The name of the compute resource
|
5325
|
-
#
|
5360
|
+
# The name of the compute resource that the authentication token is
|
5361
|
+
# issued to.
|
5326
5362
|
# @return [String]
|
5327
5363
|
#
|
5328
5364
|
# @!attribute [rw] compute_arn
|
5329
|
-
# The Amazon Resource Name ([ARN][1]) that is assigned to
|
5365
|
+
# The Amazon Resource Name ([ARN][1]) that is assigned to an Amazon
|
5330
5366
|
# GameLift compute resource and uniquely identifies it. ARNs are
|
5331
5367
|
# unique across all Regions. Format is
|
5332
|
-
# `arn:aws:gamelift:<region>::compute/compute-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912
|
5368
|
+
# `arn:aws:gamelift:<region>::compute/compute-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912`.
|
5333
5369
|
#
|
5334
5370
|
#
|
5335
5371
|
#
|
@@ -5337,15 +5373,12 @@ module Aws::GameLift
|
|
5337
5373
|
# @return [String]
|
5338
5374
|
#
|
5339
5375
|
# @!attribute [rw] auth_token
|
5340
|
-
#
|
5341
|
-
# with Amazon GameLift.
|
5376
|
+
# A valid temporary authentication token.
|
5342
5377
|
# @return [String]
|
5343
5378
|
#
|
5344
5379
|
# @!attribute [rw] expiration_timestamp
|
5345
5380
|
# The amount of time until the authentication token is no longer
|
5346
|
-
# valid.
|
5347
|
-
# hosting, renew the authentication token by using this operation
|
5348
|
-
# again.
|
5381
|
+
# valid.
|
5349
5382
|
# @return [Time]
|
5350
5383
|
#
|
5351
5384
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/GetComputeAuthTokenOutput AWS API Documentation
|
@@ -5390,15 +5423,19 @@ module Aws::GameLift
|
|
5390
5423
|
|
5391
5424
|
# @!attribute [rw] fleet_id
|
5392
5425
|
# A unique identifier for the fleet that contains the instance you
|
5393
|
-
# want access
|
5394
|
-
#
|
5395
|
-
#
|
5396
|
-
#
|
5426
|
+
# want to access. You can request access to instances in EC2 fleets
|
5427
|
+
# with the following statuses: `ACTIVATING`, `ACTIVE`, or `ERROR`. Use
|
5428
|
+
# either a fleet ID or an ARN value.
|
5429
|
+
#
|
5430
|
+
# <note markdown="1"> You can access fleets in `ERROR` status for a short period of time
|
5431
|
+
# before Amazon GameLift deletes them.
|
5432
|
+
#
|
5433
|
+
# </note>
|
5397
5434
|
# @return [String]
|
5398
5435
|
#
|
5399
5436
|
# @!attribute [rw] instance_id
|
5400
|
-
# A unique identifier for the instance you want to
|
5401
|
-
#
|
5437
|
+
# A unique identifier for the instance you want to access. You can
|
5438
|
+
# access an instance in any status.
|
5402
5439
|
# @return [String]
|
5403
5440
|
#
|
5404
5441
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/GetInstanceAccessInput AWS API Documentation
|
@@ -5437,14 +5474,12 @@ module Aws::GameLift
|
|
5437
5474
|
include Aws::Structure
|
5438
5475
|
end
|
5439
5476
|
|
5440
|
-
# Represents
|
5441
|
-
#
|
5442
|
-
#
|
5443
|
-
#
|
5444
|
-
# **Related actions**
|
5477
|
+
# Represents a virtual computing instance that runs game server
|
5478
|
+
# processes and hosts game sessions. In Amazon GameLift, one or more
|
5479
|
+
# instances make up a managed EC2 fleet.
|
5445
5480
|
#
|
5446
5481
|
# @!attribute [rw] fleet_id
|
5447
|
-
# A unique identifier for the fleet that the instance
|
5482
|
+
# A unique identifier for the fleet that the instance belongs to.
|
5448
5483
|
# @return [String]
|
5449
5484
|
#
|
5450
5485
|
# @!attribute [rw] fleet_arn
|
@@ -5474,8 +5509,8 @@ module Aws::GameLift
|
|
5474
5509
|
# identifier>.amazongamelift.com`.
|
5475
5510
|
#
|
5476
5511
|
# * Non-TLS-enabled fleets: `ec2-<unique
|
5477
|
-
# identifier>.compute.amazonaws.com`. (See [Amazon
|
5478
|
-
# Addressing][1].)
|
5512
|
+
# identifier>.compute.amazonaws.com`. (See [Amazon Elastic Compute
|
5513
|
+
# Cloud Instance IP Addressing][1].)
|
5479
5514
|
#
|
5480
5515
|
# When connecting to a game session that is running on a TLS-enabled
|
5481
5516
|
# fleet, you must use the DNS name, not the IP address.
|
@@ -5486,12 +5521,12 @@ module Aws::GameLift
|
|
5486
5521
|
# @return [String]
|
5487
5522
|
#
|
5488
5523
|
# @!attribute [rw] operating_system
|
5489
|
-
# Operating system that is running on this instance.
|
5524
|
+
# Operating system that is running on this EC2 instance.
|
5490
5525
|
# @return [String]
|
5491
5526
|
#
|
5492
5527
|
# @!attribute [rw] type
|
5493
|
-
#
|
5494
|
-
#
|
5528
|
+
# EC2 instance type that defines the computing resources of this
|
5529
|
+
# instance.
|
5495
5530
|
# @return [String]
|
5496
5531
|
#
|
5497
5532
|
# @!attribute [rw] status
|
@@ -5540,19 +5575,21 @@ module Aws::GameLift
|
|
5540
5575
|
include Aws::Structure
|
5541
5576
|
end
|
5542
5577
|
|
5543
|
-
# Information
|
5578
|
+
# Information and credentials that you can use to remotely connect to an
|
5579
|
+
# instance in an EC2 managed fleet. This data type is returned in
|
5580
|
+
# response to a call to GetInstanceAccess.
|
5544
5581
|
#
|
5545
5582
|
# @!attribute [rw] fleet_id
|
5546
|
-
# A unique identifier for the fleet containing the instance
|
5583
|
+
# A unique identifier for the fleet containing the instance to be
|
5547
5584
|
# accessed.
|
5548
5585
|
# @return [String]
|
5549
5586
|
#
|
5550
5587
|
# @!attribute [rw] instance_id
|
5551
|
-
# A unique identifier for the instance
|
5588
|
+
# A unique identifier for the instance to be accessed.
|
5552
5589
|
# @return [String]
|
5553
5590
|
#
|
5554
5591
|
# @!attribute [rw] ip_address
|
5555
|
-
# IP address
|
5592
|
+
# IP address assigned to the instance.
|
5556
5593
|
# @return [String]
|
5557
5594
|
#
|
5558
5595
|
# @!attribute [rw] operating_system
|
@@ -5560,7 +5597,7 @@ module Aws::GameLift
|
|
5560
5597
|
# @return [String]
|
5561
5598
|
#
|
5562
5599
|
# @!attribute [rw] credentials
|
5563
|
-
#
|
5600
|
+
# Security credentials that are required to access the instance.
|
5564
5601
|
# @return [Types::InstanceCredentials]
|
5565
5602
|
#
|
5566
5603
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/InstanceAccess AWS API Documentation
|
@@ -5575,16 +5612,20 @@ module Aws::GameLift
|
|
5575
5612
|
include Aws::Structure
|
5576
5613
|
end
|
5577
5614
|
|
5578
|
-
#
|
5615
|
+
# A set of credentials that allow remote access to an instance in an EC2
|
5616
|
+
# managed fleet. These credentials are returned in response to a call to
|
5617
|
+
# GetInstanceAccess, which requests access for instances that are
|
5618
|
+
# running game servers with the Amazon GameLift server SDK version 4.x
|
5619
|
+
# or earlier.
|
5579
5620
|
#
|
5580
5621
|
# @!attribute [rw] user_name
|
5581
|
-
#
|
5622
|
+
# A user name for logging in.
|
5582
5623
|
# @return [String]
|
5583
5624
|
#
|
5584
5625
|
# @!attribute [rw] secret
|
5585
5626
|
# Secret string. For Windows instances, the secret is a password for
|
5586
|
-
# use with Windows Remote Desktop. For Linux instances, it
|
5587
|
-
# private key
|
5627
|
+
# use with Windows Remote Desktop. For Linux instances, it's a
|
5628
|
+
# private key for use with SSH.
|
5588
5629
|
# @return [String]
|
5589
5630
|
#
|
5590
5631
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/InstanceCredentials AWS API Documentation
|
@@ -5915,13 +5956,11 @@ module Aws::GameLift
|
|
5915
5956
|
end
|
5916
5957
|
|
5917
5958
|
# @!attribute [rw] fleet_id
|
5918
|
-
# A unique identifier for the fleet
|
5919
|
-
# registered to.
|
5959
|
+
# A unique identifier for the fleet to retrieve compute resources for.
|
5920
5960
|
# @return [String]
|
5921
5961
|
#
|
5922
5962
|
# @!attribute [rw] location
|
5923
|
-
# The name of
|
5924
|
-
# assigned to.
|
5963
|
+
# The name of a location to retrieve compute resources for.
|
5925
5964
|
# @return [String]
|
5926
5965
|
#
|
5927
5966
|
# @!attribute [rw] limit
|
@@ -5948,7 +5987,7 @@ module Aws::GameLift
|
|
5948
5987
|
end
|
5949
5988
|
|
5950
5989
|
# @!attribute [rw] compute_list
|
5951
|
-
# A list of compute resources
|
5990
|
+
# A list of compute resources in the specified fleet.
|
5952
5991
|
# @return [Array<Types::Compute>]
|
5953
5992
|
#
|
5954
5993
|
# @!attribute [rw] next_token
|
@@ -7246,28 +7285,27 @@ module Aws::GameLift
|
|
7246
7285
|
# @return [String]
|
7247
7286
|
#
|
7248
7287
|
# @!attribute [rw] compute_name
|
7249
|
-
# A descriptive label
|
7250
|
-
# registered to your fleet.
|
7288
|
+
# A descriptive label for the compute resource.
|
7251
7289
|
# @return [String]
|
7252
7290
|
#
|
7253
7291
|
# @!attribute [rw] certificate_path
|
7254
|
-
# The path to
|
7255
|
-
#
|
7292
|
+
# The path to a TLS certificate on your compute resource. Amazon
|
7293
|
+
# GameLift doesn't validate the path and certificate.
|
7256
7294
|
# @return [String]
|
7257
7295
|
#
|
7258
7296
|
# @!attribute [rw] dns_name
|
7259
|
-
# The DNS name of the compute resource. Amazon GameLift requires
|
7260
|
-
# DNS name or IP address
|
7297
|
+
# The DNS name of the compute resource. Amazon GameLift requires
|
7298
|
+
# either a DNS name or IP address.
|
7261
7299
|
# @return [String]
|
7262
7300
|
#
|
7263
7301
|
# @!attribute [rw] ip_address
|
7264
|
-
# The IP address of the compute resource. Amazon GameLift requires
|
7265
|
-
# DNS name or IP address
|
7302
|
+
# The IP address of the compute resource. Amazon GameLift requires
|
7303
|
+
# either a DNS name or IP address.
|
7266
7304
|
# @return [String]
|
7267
7305
|
#
|
7268
7306
|
# @!attribute [rw] location
|
7269
|
-
# The name of
|
7270
|
-
#
|
7307
|
+
# The name of a custom location to associate with the compute resource
|
7308
|
+
# being registered.
|
7271
7309
|
# @return [String]
|
7272
7310
|
#
|
7273
7311
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/RegisterComputeInput AWS API Documentation
|
@@ -7284,8 +7322,7 @@ module Aws::GameLift
|
|
7284
7322
|
end
|
7285
7323
|
|
7286
7324
|
# @!attribute [rw] compute
|
7287
|
-
# The details of the compute resource you registered
|
7288
|
-
# fleet.
|
7325
|
+
# The details of the compute resource you registered.
|
7289
7326
|
# @return [Types::Compute]
|
7290
7327
|
#
|
7291
7328
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/RegisterComputeOutput AWS API Documentation
|
@@ -8001,9 +8038,8 @@ module Aws::GameLift
|
|
8001
8038
|
# part of a fleet's runtime configuration.
|
8002
8039
|
#
|
8003
8040
|
# @!attribute [rw] launch_path
|
8004
|
-
# The location of a game build executable or
|
8005
|
-
#
|
8006
|
-
# scripts are installed on instances at the root:
|
8041
|
+
# The location of a game build executable or Realtime script. Game
|
8042
|
+
# builds and Realtime scripts are installed on instances at the root:
|
8007
8043
|
#
|
8008
8044
|
# * Windows (custom game builds only): `C:\game`. Example:
|
8009
8045
|
# "`C:\game\MyGame\server.exe`"
|
@@ -8011,6 +8047,13 @@ module Aws::GameLift
|
|
8011
8047
|
# * Linux: `/local/game`. Examples:
|
8012
8048
|
# "`/local/game/MyGame/server.exe`" or
|
8013
8049
|
# "`/local/game/MyRealtimeScript.js`"
|
8050
|
+
#
|
8051
|
+
# <note markdown="1"> Amazon GameLift doesn't support the use of setup scripts that
|
8052
|
+
# launch the game executable. For custom game builds, this parameter
|
8053
|
+
# must indicate the executable that calls the server SDK operations
|
8054
|
+
# `initSDK()` and `ProcessReady()`.
|
8055
|
+
#
|
8056
|
+
# </note>
|
8014
8057
|
# @return [String]
|
8015
8058
|
#
|
8016
8059
|
# @!attribute [rw] parameters
|
@@ -8715,9 +8758,9 @@ module Aws::GameLift
|
|
8715
8758
|
# @return [String]
|
8716
8759
|
#
|
8717
8760
|
# @!attribute [rw] new_game_session_protection_policy
|
8718
|
-
# The game session protection policy to apply to all new
|
8719
|
-
# created in this fleet.
|
8720
|
-
# affected. You can set protection for individual
|
8761
|
+
# The game session protection policy to apply to all new game sessions
|
8762
|
+
# created in this fleet. Game sessions that already exist are not
|
8763
|
+
# affected. You can set protection for individual game sessions using
|
8721
8764
|
# [UpdateGameSession][1] .
|
8722
8765
|
#
|
8723
8766
|
# * **NoProtection** -- The game session can be terminated during a
|
@@ -8794,7 +8837,9 @@ module Aws::GameLift
|
|
8794
8837
|
# @!attribute [rw] desired_instances
|
8795
8838
|
# The number of Amazon EC2 instances you want to maintain in the
|
8796
8839
|
# specified fleet location. This value must fall between the minimum
|
8797
|
-
# and maximum size limits.
|
8840
|
+
# and maximum size limits. Changes in desired instance value can take
|
8841
|
+
# up to 1 minute to be reflected when viewing the fleet's capacity
|
8842
|
+
# settings.
|
8798
8843
|
# @return [Integer]
|
8799
8844
|
#
|
8800
8845
|
# @!attribute [rw] min_size
|
@@ -9012,8 +9057,10 @@ module Aws::GameLift
|
|
9012
9057
|
# @return [String]
|
9013
9058
|
#
|
9014
9059
|
# @!attribute [rw] utilization_status
|
9015
|
-
# Indicates
|
9016
|
-
#
|
9060
|
+
# Indicates if the game server is available or is currently hosting
|
9061
|
+
# gameplay. You can update a game server status from `AVAILABLE` to
|
9062
|
+
# `UTILIZED`, but you can't change a the status from `UTILIZED` to
|
9063
|
+
# `AVAILABLE`.
|
9017
9064
|
# @return [String]
|
9018
9065
|
#
|
9019
9066
|
# @!attribute [rw] health_check
|