aws-sdk-gamelift 1.96.0 → 1.98.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.
@@ -175,10 +175,16 @@ module Aws::GameLift
175
175
  #
176
176
  # * To upload a game server build directly to Amazon GameLift S3 storage
177
177
  # using `CreateBuild`. To get access for this task, call
178
- # RequestUploadCredentials.
178
+ # [https://docs.aws.amazon.com/gamelift/latest/apireference/API\_RequestUploadCredentials.html][1].
179
179
  #
180
180
  # * To remotely connect to an active Amazon GameLift fleet instances. To
181
- # get remote access, call GetComputeAccess.
181
+ # get remote access, call
182
+ # [https://docs.aws.amazon.com/gamelift/latest/apireference/API\_GetComputeAccess.html][2].
183
+ #
184
+ #
185
+ #
186
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_RequestUploadCredentials.html
187
+ # [2]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_GetComputeAccess.html
182
188
  #
183
189
  # @!attribute [rw] access_key_id
184
190
  # The access key ID that identifies the temporary security
@@ -330,10 +336,10 @@ module Aws::GameLift
330
336
  #
331
337
  # Valid values include:
332
338
  #
333
- # * **GENERATED** -- Generate a TLS/SSL certificate for this fleet.
339
+ # * **GENERATED** - Generate a TLS/SSL certificate for this fleet.
334
340
  #
335
- # * **DISABLED** -- (default) Do not generate a TLS/SSL certificate
336
- # for this fleet.
341
+ # * **DISABLED** - (default) Do not generate a TLS/SSL certificate for
342
+ # this fleet.
337
343
  # @return [String]
338
344
  #
339
345
  # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CertificateConfiguration AWS API Documentation
@@ -573,7 +579,11 @@ module Aws::GameLift
573
579
 
574
580
  # A unique identifier for a container in a container fleet compute.
575
581
  #
576
- # **Returned by:** DescribeCompute
582
+ # **Returned by:** [DescribeCompute][1]
583
+ #
584
+ #
585
+ #
586
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeCompute.html
577
587
  #
578
588
  # @!attribute [rw] container_name
579
589
  # The identifier for a container that's running in a compute.
@@ -602,9 +612,16 @@ module Aws::GameLift
602
612
  # can't start until *ContainerB* has started. It also means that
603
613
  # *ContainerA* must shut down before *ContainerB*.
604
614
  #
605
- # eiifcbfhgrdurhnucnufkgbnbnnerrvbtjvljdetkehc**Part of:**
606
- # GameServerContainerDefinition, GameServerContainerDefinitionInput,
607
- # SupportContainerDefinition, SupportContainerDefinitionInput
615
+ # **Part of:** [GameServerContainerDefinition][1],
616
+ # [GameServerContainerDefinitionInput][2],
617
+ # [SupportContainerDefinition][3], [SupportContainerDefinitionInput][4]
618
+ #
619
+ #
620
+ #
621
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_GameServerContainerDefinition.html
622
+ # [2]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_GameServerContainerDefinitionInput.html
623
+ # [3]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_SupportContainerDefinition.html
624
+ # [4]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_SupportContainerDefinitionInput.html
608
625
  #
609
626
  # @!attribute [rw] container_name
610
627
  # A descriptive label for the container definition that this container
@@ -644,9 +661,16 @@ module Aws::GameLift
644
661
  # An environment variable to set inside a container, in the form of a
645
662
  # key-value pair.
646
663
  #
647
- # **Part of:** GameServerContainerDefinition,
648
- # GameServerContainerDefinitionInput, SupportContainerDefinition,
649
- # SupportContainerDefinitionInput
664
+ # **Part of:** [GameServerContainerDefinition][1],
665
+ # [GameServerContainerDefinitionInput][2],
666
+ # [SupportContainerDefinition][3], [SupportContainerDefinitionInput][4]
667
+ #
668
+ #
669
+ #
670
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_GameServerContainerDefinition.html
671
+ # [2]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_GameServerContainerDefinitionInput.html
672
+ # [3]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_SupportContainerDefinition.html
673
+ # [4]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_SupportContainerDefinitionInput.html
650
674
  #
651
675
  # @!attribute [rw] name
652
676
  # The environment variable name.
@@ -914,10 +938,18 @@ module Aws::GameLift
914
938
  # update all properties of a container group definition properties.
915
939
  # Updates to a container group definition are saved as new versions.
916
940
  #
917
- # **Used with:** CreateContainerGroupDefinition
941
+ # **Used with:** [CreateContainerGroupDefinition][1]
942
+ #
943
+ # **Returned by:** [DescribeContainerGroupDefinition][2],
944
+ # [ListContainerGroupDefinitions][3],
945
+ # [UpdateContainerGroupDefinition][4]
946
+ #
918
947
  #
919
- # **Returned by:** DescribeContainerGroupDefinition,
920
- # ListContainerGroupDefinitions, UpdateContainerGroupDefinition
948
+ #
949
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateContainerGroupDefinition.html
950
+ # [2]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeContainerGroupDefinition.html
951
+ # [3]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_ListContainerGroupDefinitions.html
952
+ # [4]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateContainerGroupDefinition.html
921
953
  #
922
954
  # @!attribute [rw] container_group_definition_arn
923
955
  # The Amazon Resource Name ([ARN][1]) that is assigned to an Amazon
@@ -1035,11 +1067,11 @@ module Aws::GameLift
1035
1067
  #
1036
1068
  # * An internal issue prevented Amazon GameLift from creating the
1037
1069
  # container group definition resource. Delete the failed resource
1038
- # and call CreateContainerGroupDefinitionagain.
1070
+ # and call [CreateContainerGroupDefinition][1]again.
1039
1071
  #
1040
1072
  # * An access-denied message means that you don't have permissions to
1041
1073
  # access the container image on ECR. See [ IAM permission
1042
- # examples][1] for help setting up required IAM permissions for
1074
+ # examples][2] for help setting up required IAM permissions for
1043
1075
  # Amazon GameLift.
1044
1076
  #
1045
1077
  # * The `ImageUri` value for at least one of the containers in the
@@ -1048,7 +1080,7 @@ module Aws::GameLift
1048
1080
  #
1049
1081
  # * At least one of the container images referenced in the container
1050
1082
  # group definition exceeds the allowed size. For size limits, see [
1051
- # Amazon GameLift endpoints and quotas][2].
1083
+ # Amazon GameLift endpoints and quotas][3].
1052
1084
  #
1053
1085
  # * At least one of the container images referenced in the container
1054
1086
  # group definition uses a different operating system than the one
@@ -1056,8 +1088,9 @@ module Aws::GameLift
1056
1088
  #
1057
1089
  #
1058
1090
  #
1059
- # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-iam-policy-examples.html
1060
- # [2]: https://docs.aws.amazon.com/general/latest/gr/gamelift.html
1091
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateContainerGroupDefinition.html
1092
+ # [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-iam-policy-examples.html.html
1093
+ # [3]: https://docs.aws.amazon.com/general/latest/gr/gamelift.html
1061
1094
  # @return [String]
1062
1095
  #
1063
1096
  # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ContainerGroupDefinition AWS API Documentation
@@ -1097,12 +1130,14 @@ module Aws::GameLift
1097
1130
  # `{"Command": [ "CMD-SHELL", "ps cax | grep "processmanager" || exit 1"
1098
1131
  # ], "Interval": 60, "Timeout": 10, "Retries": 3, "StartPeriod": 100 }`
1099
1132
  #
1100
- # **Part of:** SupportContainerDefinition,
1101
- # SupportContainerDefinitionInput
1133
+ # **Part of:** [SupportContainerDefinition][2],
1134
+ # [SupportContainerDefinitionInput][3]
1102
1135
  #
1103
1136
  #
1104
1137
  #
1105
1138
  # [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_HealthCheck.html#ECS-Type-HealthCheck-command
1139
+ # [2]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_SupportContainerDefinition.html
1140
+ # [3]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_SupportContainerDefinitionInput.html
1106
1141
  #
1107
1142
  # @!attribute [rw] command
1108
1143
  # A string array that specifies the command that the container runs to
@@ -1146,9 +1181,14 @@ module Aws::GameLift
1146
1181
  # container fleet instance. This information makes it possible to
1147
1182
  # remotely connect to a specific container on a fleet instance.
1148
1183
  #
1149
- # **Related to:** ContainerAttribute
1184
+ # **Related to:** [ContainerAttribute][1]
1185
+ #
1186
+ # <b>Use with: </b> [GetComputeAccess][2]
1187
+ #
1150
1188
  #
1151
- # <b>Use with: </b> GetComputeAccess
1189
+ #
1190
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_ContainerAttribute.html
1191
+ # [2]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_GetComputeAccess.html
1152
1192
  #
1153
1193
  # @!attribute [rw] container_name
1154
1194
  # The identifier for a container that's running in a compute.
@@ -1172,9 +1212,17 @@ module Aws::GameLift
1172
1212
  # A mount point that binds a container to a file or directory on the
1173
1213
  # host system.
1174
1214
  #
1175
- # **Part of:** GameServerContainerDefinition,
1176
- # GameServerContainerDefinitionInput, SupportContainerDefinition,
1177
- # SupportContainerDefinitionInput
1215
+ # **Part of:** [GameServerContainerDefinition][1],
1216
+ # [https://docs.aws.amazon.com/gamelift/latest/apireference/API\_GameServerContainerDefinitionInput.html][2],
1217
+ # [SupportContainerDefinition][3],
1218
+ # [https://docs.aws.amazon.com/gamelift/latest/apireference/API\_SupportContainerDefinitionInput.html][4]
1219
+ #
1220
+ #
1221
+ #
1222
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_GameServerContainerDefinition.html
1223
+ # [2]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_GameServerContainerDefinitionInput.html
1224
+ # [3]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_SupportContainerDefinition.html
1225
+ # [4]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_SupportContainerDefinitionInput.html
1178
1226
  #
1179
1227
  # @!attribute [rw] instance_path
1180
1228
  # The path to the source file or directory.
@@ -1204,9 +1252,16 @@ module Aws::GameLift
1204
1252
  # accessible to inbound traffic. Container ports map to a container
1205
1253
  # fleet's connection ports.
1206
1254
  #
1207
- # **Part of:** GameServerContainerDefinition,
1208
- # GameServerContainerDefinitionInput, SupportContainerDefinition,
1209
- # SupportContainerDefinitionInput
1255
+ # **Part of:** [GameServerContainerDefinition][1],
1256
+ # [GameServerContainerDefinitionInput][2],
1257
+ # [SupportContainerDefinition][3], [SupportContainerDefinitionInput][4]
1258
+ #
1259
+ #
1260
+ #
1261
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_GameServerContainerDefinition.html
1262
+ # [2]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_GameServerContainerDefinitionInput.html
1263
+ # [3]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_SupportContainerDefinition.html
1264
+ # [4]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_SupportContainerDefinitionInput.html
1210
1265
  #
1211
1266
  # @!attribute [rw] container_port_ranges
1212
1267
  # A set of one or more container port number ranges. The ranges can't
@@ -1223,7 +1278,11 @@ module Aws::GameLift
1223
1278
 
1224
1279
  # A set of one or more port numbers that can be opened on the container.
1225
1280
  #
1226
- # **Part of:** ContainerPortConfiguration
1281
+ # **Part of:** [ContainerPortConfiguration][1]
1282
+ #
1283
+ #
1284
+ #
1285
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_ContainerPortConfiguration.html
1227
1286
  #
1228
1287
  # @!attribute [rw] from_port
1229
1288
  # A starting value for the range of allowed port numbers.
@@ -1325,12 +1384,12 @@ module Aws::GameLift
1325
1384
  # @return [Types::S3Location]
1326
1385
  #
1327
1386
  # @!attribute [rw] operating_system
1328
- # The environment that your game server binaries run on. This value
1329
- # determines the type of fleet resources that you use for this build.
1330
- # If your game build contains multiple executables, they all must run
1331
- # on the same operating system. This parameter is required, and
1332
- # there's no default value. You can't change a build's operating
1333
- # system later.
1387
+ # The operating system that your game server binaries run on. This
1388
+ # value determines the type of fleet resources that you use for this
1389
+ # build. If your game build contains multiple executables, they all
1390
+ # must run on the same operating system. You must specify a valid
1391
+ # operating system in this request. There is no default value. You
1392
+ # can't change a build's operating system later.
1334
1393
  #
1335
1394
  # <note markdown="1"> Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See
1336
1395
  # more details in the [Amazon Linux 2 FAQs][1]. For game servers that
@@ -1451,8 +1510,13 @@ module Aws::GameLift
1451
1510
  # an ARN value with a specific version number.
1452
1511
  #
1453
1512
  # Create a container group definition by calling
1454
- # CreateContainerGroupDefinition. This operation creates a
1455
- # ContainerGroupDefinition resource.
1513
+ # [CreateContainerGroupDefinition][1]. This operation creates a
1514
+ # [ContainerGroupDefinition][2] resource.
1515
+ #
1516
+ #
1517
+ #
1518
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateContainerGroupDefinition.html
1519
+ # [2]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_ContainerGroupDefinition.html
1456
1520
  # @return [String]
1457
1521
  #
1458
1522
  # @!attribute [rw] per_instance_container_group_definition_name
@@ -1465,8 +1529,15 @@ module Aws::GameLift
1465
1529
  # Alternatively, provide an ARN value with a specific version number.
1466
1530
  #
1467
1531
  # Create a container group definition by calling
1468
- # CreateContainerGroupDefinition. This operation creates a
1469
- # ContainerGroupDefinition resource.
1532
+ # [https://docs.aws.amazon.com/gamelift/latest/apireference/API\_CreateContainerGroupDefinition.html][1].
1533
+ # This operation creates a
1534
+ # [https://docs.aws.amazon.com/gamelift/latest/apireference/API\_ContainerGroupDefinition.html][2]
1535
+ # resource.
1536
+ #
1537
+ #
1538
+ #
1539
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateContainerGroupDefinition.html
1540
+ # [2]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_ContainerGroupDefinition.html
1470
1541
  # @return [String]
1471
1542
  #
1472
1543
  # @!attribute [rw] instance_connection_port_range
@@ -1871,11 +1942,16 @@ module Aws::GameLift
1871
1942
  # to access game server processes and other processes on this fleet.
1872
1943
  # Set this parameter for managed EC2 fleets. You can leave this
1873
1944
  # parameter empty when creating the fleet, but you must call
1874
- # UpdateFleetPortSettings to set it before players can connect to game
1875
- # sessions. As a best practice, we recommend opening ports for remote
1876
- # access only when you need them and closing them when you're
1877
- # finished. For Realtime Servers fleets, Amazon GameLift automatically
1878
- # sets TCP and UDP ranges.
1945
+ # [https://docs.aws.amazon.com/gamelift/latest/apireference/API\_UpdateFleetPortSettings][1]
1946
+ # to set it before players can connect to game sessions. As a best
1947
+ # practice, we recommend opening ports for remote access only when you
1948
+ # need them and closing them when you're finished. For Realtime
1949
+ # Servers fleets, Amazon GameLift automatically sets TCP and UDP
1950
+ # ranges.
1951
+ #
1952
+ #
1953
+ #
1954
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateFleetPortSettings
1879
1955
  # @return [Array<Types::IpPermission>]
1880
1956
  #
1881
1957
  # @!attribute [rw] new_game_session_protection_policy
@@ -2032,10 +2108,9 @@ module Aws::GameLift
2032
2108
  # * `EC2` – The game server build is deployed to Amazon EC2 instances
2033
2109
  # for cloud hosting. This is the default setting.
2034
2110
  #
2035
- # * `ANYWHERE` – Your game server and supporting software is deployed
2036
- # to compute resources that are provided and managed by you. With
2037
- # this compute type, you can also set the `AnywhereConfiguration`
2038
- # parameter.
2111
+ # * `ANYWHERE` – Game servers and supporting software are deployed to
2112
+ # compute resources that you provide and manage. With this compute
2113
+ # type, you can also set the `AnywhereConfiguration` parameter.
2039
2114
  # @return [String]
2040
2115
  #
2041
2116
  # @!attribute [rw] anywhere_configuration
@@ -5153,14 +5228,6 @@ module Aws::GameLift
5153
5228
  # * FLEET\_VPC\_PEERING\_DELETED -- A VPC peering connection has been
5154
5229
  # successfully deleted.
5155
5230
  #
5156
- # **Container group events:**
5157
- #
5158
- # * CONTAINER\_GROUP\_REGISTRATION\_FAILED – A game server container
5159
- # group started, but timed out before calling `RegisterCompute`.
5160
- #
5161
- # * CONTAINER\_GROUP\_CRASHED A game server container group started
5162
- # and terminated without calling `RegisterCompute`.
5163
- #
5164
5231
  # **Spot instance events:**
5165
5232
  #
5166
5233
  # * INSTANCE\_INTERRUPTED -- A spot instance was interrupted by EC2
@@ -5271,10 +5338,10 @@ module Aws::GameLift
5271
5338
  end
5272
5339
 
5273
5340
  # A list of fleet locations where a game session queue can place new
5274
- # game sessions. You can use a filter to temporarily turn off placements
5275
- # for specific locations. For queues that have multi-location fleets,
5276
- # you can use a filter configuration allow placement with some, but not
5277
- # all of these locations.
5341
+ # game sessions. You can use a filter to temporarily exclude specific
5342
+ # locations from receiving placements. For queues that have
5343
+ # multi-location fleets, you can use a filter configuration allow
5344
+ # placement with some, but not all, of a fleet's locations.
5278
5345
  #
5279
5346
  # @!attribute [rw] allowed_locations
5280
5347
  # A list of locations to allow game session placement in, in the form
@@ -5301,7 +5368,12 @@ module Aws::GameLift
5301
5368
  # the fleet's computes. Attributes include fleet identifiers and
5302
5369
  # descriptive properties, creation/termination time, and fleet status.
5303
5370
  #
5304
- # **Returned by:** DescribeFleetAttributes
5371
+ # **Returned by:**
5372
+ # [https://docs.aws.amazon.com/gamelift/latest/apireference/API\_DescribeFleetAttributes][1]
5373
+ #
5374
+ #
5375
+ #
5376
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetAttributes
5305
5377
  #
5306
5378
  # @!attribute [rw] fleet_id
5307
5379
  # A unique identifier for the fleet.
@@ -5335,7 +5407,7 @@ module Aws::GameLift
5335
5407
  # determines the computing resources of each instance in the fleet,
5336
5408
  # including CPU, memory, storage, and networking capacity. See [Amazon
5337
5409
  # Elastic Compute Cloud Instance Types][1] for detailed descriptions.
5338
- # This attribute is used with fleets where `ComputeType` is "EC2".
5410
+ # This attribute is used with fleets where `ComputeType` is `EC2`.
5339
5411
  #
5340
5412
  #
5341
5413
  #
@@ -5452,7 +5524,7 @@ module Aws::GameLift
5452
5524
  # @!attribute [rw] new_game_session_protection_policy
5453
5525
  # The type of game session protection to set on all new instances that
5454
5526
  # are started in the fleet. This attribute is used with fleets where
5455
- # `ComputeType` is "EC2".
5527
+ # `ComputeType` is `EC2`.
5456
5528
  #
5457
5529
  # * **NoProtection** -- The game session can be terminated during a
5458
5530
  # scale-down event.
@@ -5465,11 +5537,11 @@ module Aws::GameLift
5465
5537
  # The operating system of the fleet's computing resources. A fleet's
5466
5538
  # operating system is determined by the OS of the build or script that
5467
5539
  # is deployed on this fleet. This attribute is used with fleets where
5468
- # `ComputeType` is "EC2".
5540
+ # `ComputeType` is `EC2`.
5469
5541
  #
5470
5542
  # <note markdown="1"> Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See
5471
5543
  # more details in the [Amazon Linux 2 FAQs][1]. For game servers that
5472
- # are hosted on AL2 and use Amazon GameLift server SDK 4.x, first
5544
+ # are hosted on AL2 and use Amazon GameLift server SDK 4.x., first
5473
5545
  # update the game server build to server SDK 5.x, and then deploy to
5474
5546
  # AL2023 instances. See [ Migrate to Amazon GameLift server SDK
5475
5547
  # version 5.][2]
@@ -5498,13 +5570,13 @@ module Aws::GameLift
5498
5570
  # Amazon CloudWatch, you can view aggregated metrics for fleets that
5499
5571
  # are in a metric group. A fleet can be included in only one metric
5500
5572
  # group at a time. This attribute is used with fleets where
5501
- # `ComputeType` is "EC2".
5573
+ # `ComputeType` is `EC2`.
5502
5574
  # @return [Array<String>]
5503
5575
  #
5504
5576
  # @!attribute [rw] stopped_actions
5505
5577
  # A list of fleet activity that has been suspended using
5506
5578
  # [StopFleetActions][1]. This includes fleet auto-scaling. This
5507
- # attribute is used with fleets where `ComputeType` is "EC2".
5579
+ # attribute is used with fleets where `ComputeType` is `EC2`.
5508
5580
  #
5509
5581
  #
5510
5582
  #
@@ -5520,7 +5592,7 @@ module Aws::GameLift
5520
5592
  # using the [IAM dashboard][1] in the Amazon Web Services Management
5521
5593
  # Console. Learn more about using on-box credentials for your game
5522
5594
  # servers at [ Access external resources from a game server][2]. This
5523
- # attribute is used with fleets where `ComputeType` is "EC2".
5595
+ # attribute is used with fleets where `ComputeType` is `EC2`.
5524
5596
  #
5525
5597
  #
5526
5598
  #
@@ -5541,7 +5613,7 @@ module Aws::GameLift
5541
5613
  # @return [String]
5542
5614
  #
5543
5615
  # @!attribute [rw] anywhere_configuration
5544
- # Amazon GameLift Anywhere configuration options.
5616
+ # A set of attributes that are specific to an Anywhere fleet.
5545
5617
  # @return [Types::AnywhereConfiguration]
5546
5618
  #
5547
5619
  # @!attribute [rw] instance_role_credentials_provider
@@ -5553,7 +5625,7 @@ module Aws::GameLift
5553
5625
  # server SDK version 5.x. For more information about using shared
5554
5626
  # credentials, see [ Communicate with other Amazon Web Services
5555
5627
  # resources from your fleets][1]. This attribute is used with fleets
5556
- # where `ComputeType` is "EC2".
5628
+ # where `ComputeType` is `EC2`.
5557
5629
  #
5558
5630
  #
5559
5631
  #
@@ -5694,7 +5766,9 @@ module Aws::GameLift
5694
5766
  #
5695
5767
  # @!attribute [rw] rollback_game_server_binary_arn
5696
5768
  # The unique identifier for the version of the game server container
5697
- # group definition to roll back to if deployment fails.
5769
+ # group definition to roll back to if deployment fails. Amazon
5770
+ # GameLift sets this property to the container group definition
5771
+ # version that the fleet used when it was last active.
5698
5772
  # @return [String]
5699
5773
  #
5700
5774
  # @!attribute [rw] per_instance_binary_arn
@@ -5704,7 +5778,9 @@ module Aws::GameLift
5704
5778
  #
5705
5779
  # @!attribute [rw] rollback_per_instance_binary_arn
5706
5780
  # The unique identifier for the version of the per-instance container
5707
- # group definition to roll back to if deployment fails.
5781
+ # group definition to roll back to if deployment fails. Amazon
5782
+ # GameLift sets this property to the container group definition
5783
+ # version that the fleet used when it was last active.
5708
5784
  # @return [String]
5709
5785
  #
5710
5786
  # @!attribute [rw] deployment_status
@@ -5959,12 +6035,22 @@ module Aws::GameLift
5959
6035
  #
5960
6036
  # You can update a container definition and deploy the updates to an
5961
6037
  # existing fleet. When creating or updating a game server container
5962
- # group definition, use the property GameServerContainerDefinitionInput.
6038
+ # group definition, use the property
6039
+ # [https://docs.aws.amazon.com/gamelift/latest/apireference/API\_GameServerContainerDefinitionInput][1].
6040
+ #
6041
+ # **Part of:** [ContainerGroupDefinition][2]
5963
6042
  #
5964
- # **Part of:** ContainerGroupDefinition
6043
+ # **Returned by:** [DescribeContainerGroupDefinition][3],
6044
+ # [ListContainerGroupDefinitions][4],
6045
+ # [UpdateContainerGroupDefinition][5]
5965
6046
  #
5966
- # **Returned by:** DescribeContainerGroupDefinition,
5967
- # ListContainerGroupDefinitions, UpdateContainerGroupDefinition
6047
+ #
6048
+ #
6049
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_GameServerContainerDefinitionInput
6050
+ # [2]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_ContainerGroupDefinition.html
6051
+ # [3]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeContainerGroupDefinition.html
6052
+ # [4]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_ListContainerGroupDefinitions.html
6053
+ # [5]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateContainerGroupDefinition.html
5968
6054
  #
5969
6055
  # @!attribute [rw] container_name
5970
6056
  # The container definition identifier. Container names are unique
@@ -6040,12 +6126,18 @@ module Aws::GameLift
6040
6126
  # executable. This definition includes container configuration,
6041
6127
  # resources, and start instructions. Use this data type when creating or
6042
6128
  # updating a game server container group definition. For properties of a
6043
- # deployed container, see GameServerContainerDefinition. A game server
6044
- # container is automatically considered essential; if an essential
6045
- # container fails, the entire container group restarts.
6129
+ # deployed container, see [GameServerContainerDefinition][1]. A game
6130
+ # server container is automatically considered essential; if an
6131
+ # essential container fails, the entire container group restarts.
6132
+ #
6133
+ # <b>Use with: </b> [CreateContainerGroupDefinition][2],
6134
+ # [UpdateContainerGroupDefinition][3]
6135
+ #
6136
+ #
6046
6137
  #
6047
- # <b>Use with: </b> CreateContainerGroupDefinition,
6048
- # UpdateContainerGroupDefinition
6138
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_GameServerContainerDefinition.html
6139
+ # [2]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateContainerGroupDefinition.html
6140
+ # [3]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateContainerGroupDefinition.html
6049
6141
  #
6050
6142
  # @!attribute [rw] container_name
6051
6143
  # A string that uniquely identifies the container definition within a
@@ -6145,7 +6237,14 @@ module Aws::GameLift
6145
6237
  # process, then the fleet has the capacity to run host 50 game sessions
6146
6238
  # at a time.
6147
6239
  #
6148
- # **Returned by:** DescribeFleetCapacity, DescribeFleetLocationCapacity
6240
+ # **Returned by:**
6241
+ # [https://docs.aws.amazon.com/gamelift/latest/apireference/API\_DescribeFleetCapacity.html][1],
6242
+ # [https://docs.aws.amazon.com/gamelift/latest/apireference/API\_DescribeFleetLocationCapacity.html][2]
6243
+ #
6244
+ #
6245
+ #
6246
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetCapacity.html
6247
+ # [2]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetLocationCapacity.html
6149
6248
  #
6150
6249
  # @!attribute [rw] pending
6151
6250
  # The number of container groups that are starting up but haven't yet
@@ -6470,9 +6569,18 @@ module Aws::GameLift
6470
6569
  #
6471
6570
  # @!attribute [rw] status_reason
6472
6571
  # Provides additional information about game session status.
6473
- # `INTERRUPTED` indicates that the game session was hosted on a spot
6474
- # instance that was reclaimed, causing the active game session to be
6475
- # terminated.
6572
+ #
6573
+ # * `INTERRUPTED` -- The game session was hosted on an EC2 Spot
6574
+ # instance that was reclaimed, causing the active game session to be
6575
+ # stopped.
6576
+ #
6577
+ # * `TRIGGERED_ON_PROCESS_TERMINATE` – The game session was stopped by
6578
+ # calling `TerminateGameSession` with the termination mode
6579
+ # `TRIGGER_ON_PROCESS_TERMINATE`.
6580
+ #
6581
+ # * `FORCE_TERMINATED` – The game session was stopped by calling
6582
+ # `TerminateGameSession` with the termination mode
6583
+ # `FORCE_TERMINATE`.
6476
6584
  # @return [String]
6477
6585
  #
6478
6586
  # @!attribute [rw] game_properties
@@ -6511,7 +6619,7 @@ module Aws::GameLift
6511
6619
  # @return [Integer]
6512
6620
  #
6513
6621
  # @!attribute [rw] player_session_creation_policy
6514
- # Indicates whether or not the game session is accepting new players.
6622
+ # Indicates whether the game session is accepting new players.
6515
6623
  # @return [String]
6516
6624
  #
6517
6625
  # @!attribute [rw] creator_id
@@ -6719,12 +6827,17 @@ module Aws::GameLift
6719
6827
  # game session is not active and ready to accept players until placement
6720
6828
  # status reaches `FULFILLED`. When the placement is in `PENDING` status,
6721
6829
  # Amazon GameLift may attempt to place a game session multiple times
6722
- # before succeeding. With each attempt it creates a GameSession object
6723
- # and updates this placement object with the new game session
6724
- # properties..
6830
+ # before succeeding. With each attempt it creates a
6831
+ # [https://docs.aws.amazon.com/gamelift/latest/apireference/API\_GameSession][1]
6832
+ # object and updates this placement object with the new game session
6833
+ # properties.
6725
6834
  #
6726
6835
  # </note>
6727
6836
  #
6837
+ #
6838
+ #
6839
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_GameSession
6840
+ #
6728
6841
  # @!attribute [rw] placement_id
6729
6842
  # A unique identifier for a game session placement.
6730
6843
  # @return [String]
@@ -6746,7 +6859,7 @@ module Aws::GameLift
6746
6859
  # * **CANCELLED** -- The placement request was canceled.
6747
6860
  #
6748
6861
  # * **TIMED\_OUT** -- A new game session was not successfully created
6749
- # before the time limit expired. You can resubmit as a new placement
6862
+ # before the time limit expired. You can resubmit the placement
6750
6863
  # request as needed.
6751
6864
  #
6752
6865
  # * **FAILED** -- Amazon GameLift is not able to complete the process
@@ -6789,8 +6902,8 @@ module Aws::GameLift
6789
6902
  #
6790
6903
  # @!attribute [rw] player_latencies
6791
6904
  # A set of values, expressed in milliseconds, that indicates the
6792
- # amount of latency that a player experiences when connected to @aws;
6793
- # Regions.
6905
+ # amount of latency that a player experiences when connected to Amazon
6906
+ # Web Services Regions.
6794
6907
  # @return [Array<Types::PlayerLatency>]
6795
6908
  #
6796
6909
  # @!attribute [rw] start_time
@@ -6869,6 +6982,17 @@ module Aws::GameLift
6869
6982
  # [1]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-server.html#match-server-data
6870
6983
  # @return [String]
6871
6984
  #
6985
+ # @!attribute [rw] priority_configuration_override
6986
+ # A prioritized list of locations to use with a game session placement
6987
+ # request and instructions on how to use it. This list overrides a
6988
+ # queue's prioritized location list for a single game session
6989
+ # placement request only. The list can include Amazon Web Services
6990
+ # Regions, local zones, and custom locations (for Anywhere fleets).
6991
+ # The fallback strategy instructs Amazon GameLift to use the override
6992
+ # list for the first placement attempt only or for all placement
6993
+ # attempts.
6994
+ # @return [Types::PriorityConfigurationOverride]
6995
+ #
6872
6996
  # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/GameSessionPlacement AWS API Documentation
6873
6997
  #
6874
6998
  class GameSessionPlacement < Struct.new(
@@ -6889,7 +7013,8 @@ module Aws::GameLift
6889
7013
  :port,
6890
7014
  :placed_player_sessions,
6891
7015
  :game_session_data,
6892
- :matchmaker_data)
7016
+ :matchmaker_data,
7017
+ :priority_configuration_override)
6893
7018
  SENSITIVE = [:ip_address, :port]
6894
7019
  include Aws::Structure
6895
7020
  end
@@ -7010,7 +7135,12 @@ module Aws::GameLift
7010
7135
  # @!attribute [rw] compute_name
7011
7136
  # A unique identifier for the compute resource that you want to
7012
7137
  # connect to. For an EC2 fleet compute, use the instance ID. Use
7013
- # ListCompute to retrieve compute identifiers.
7138
+ # [https://docs.aws.amazon.com/gamelift/latest/apireference/API\_ListCompute.html][1]
7139
+ # to retrieve compute identifiers.
7140
+ #
7141
+ #
7142
+ #
7143
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_ListCompute.html
7014
7144
  # @return [String]
7015
7145
  #
7016
7146
  # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/GetComputeAccessInput AWS API Documentation
@@ -7353,7 +7483,12 @@ module Aws::GameLift
7353
7483
 
7354
7484
  # Information and credentials that you can use to remotely connect to an
7355
7485
  # instance in an EC2 managed fleet. This data type is returned in
7356
- # response to a call to GetInstanceAccess.
7486
+ # response to a call to
7487
+ # [https://docs.aws.amazon.com/gamelift/latest/apireference/API\_GetInstanceAccess][1].
7488
+ #
7489
+ #
7490
+ #
7491
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_GetInstanceAccess
7357
7492
  #
7358
7493
  # @!attribute [rw] fleet_id
7359
7494
  # A unique identifier for the fleet containing the instance to be
@@ -7390,9 +7525,13 @@ module Aws::GameLift
7390
7525
 
7391
7526
  # A set of credentials that allow remote access to an instance in an EC2
7392
7527
  # managed fleet. These credentials are returned in response to a call to
7393
- # GetInstanceAccess, which requests access for instances that are
7394
- # running game servers with the Amazon GameLift server SDK version 4.x
7395
- # or earlier.
7528
+ # [https://docs.aws.amazon.com/gamelift/latest/apireference/API\_GetInstanceAccess][1],
7529
+ # which requests access for instances that are running game servers with
7530
+ # the Amazon GameLift server SDK version 4.x or earlier.
7531
+ #
7532
+ #
7533
+ #
7534
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_GetInstanceAccess
7396
7535
  #
7397
7536
  # @!attribute [rw] user_name
7398
7537
  # A user name for logging in.
@@ -7512,9 +7651,7 @@ module Aws::GameLift
7512
7651
  # A range of IP addresses and port settings that allow inbound traffic
7513
7652
  # to connect to processes on an instance in a fleet. Processes are
7514
7653
  # assigned an IP address/port number combination, which must fall into
7515
- # the fleet's allowed ranges. For managed container fleets, the port
7516
- # settings must use the same port numbers as the fleet's connection
7517
- # ports.
7654
+ # the fleet's allowed ranges.
7518
7655
  #
7519
7656
  # For Realtime Servers fleets, Amazon GameLift automatically opens two
7520
7657
  # port ranges, one for TCP messaging and one for UDP.
@@ -8308,7 +8445,11 @@ module Aws::GameLift
8308
8445
 
8309
8446
  # Properties of a custom location for use in an Amazon GameLift Anywhere
8310
8447
  # fleet. This data type is returned in response to a call to
8311
- # CreateLocation.
8448
+ # [https://docs.aws.amazon.com/gamelift/latest/apireference/API\_CreateLocation][1].
8449
+ #
8450
+ #
8451
+ #
8452
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateLocation
8312
8453
  #
8313
8454
  # @!attribute [rw] location_name
8314
8455
  # The location's name.
@@ -8953,9 +9094,10 @@ module Aws::GameLift
8953
9094
  #
8954
9095
  # @!attribute [rw] latency_in_ms
8955
9096
  # A set of values, expressed in milliseconds, that indicates the
8956
- # amount of latency that a player experiences when connected to @aws;
8957
- # Regions. If this property is present, FlexMatch considers placing
8958
- # the match only in Regions for which latency is reported.
9097
+ # amount of latency that a player experiences when connected to Amazon
9098
+ # Web Services Regions. If this property is present, FlexMatch
9099
+ # considers placing the match only in Regions for which latency is
9100
+ # reported.
8959
9101
  #
8960
9102
  # If a matchmaker has a rule that evaluates player latency, players
8961
9103
  # must report latency in order to be matched. If no latency is
@@ -9162,52 +9304,61 @@ module Aws::GameLift
9162
9304
  include Aws::Structure
9163
9305
  end
9164
9306
 
9165
- # Custom prioritization settings for use by a game session queue when
9166
- # placing new game sessions with available game servers. When defined,
9167
- # this configuration replaces the default FleetIQ prioritization
9168
- # process, which is as follows:
9307
+ # Custom prioritization settings for a game session queue to use when
9308
+ # searching for available game servers to place new game sessions. This
9309
+ # configuration replaces the default FleetIQ prioritization process.
9169
9310
  #
9170
- # * If player latency data is included in a game session request,
9171
- # destinations and locations are prioritized first based on lowest
9172
- # average latency (1), then on lowest hosting cost (2), then on
9173
- # destination list order (3), and finally on location (alphabetical)
9174
- # (4). This approach ensures that the queue's top priority is to
9175
- # place game sessions where average player latency is lowest, and--if
9176
- # latency is the same--where the hosting cost is less, etc.
9311
+ # By default, a queue makes placements based on the following default
9312
+ # prioritizations:
9177
9313
  #
9178
- # * If player latency data is not included, destinations and locations
9179
- # are prioritized first on destination list order (1), and then on
9180
- # location (alphabetical) (2). This approach ensures that the queue's
9181
- # top priority is to place game sessions on the first destination
9182
- # fleet listed. If that fleet has multiple locations, the game session
9183
- # is placed on the first location (when listed alphabetically).
9314
+ # * If player latency data is included in a game session request, Amazon
9315
+ # GameLift prioritizes placing game sessions where the average player
9316
+ # latency is lowest. Amazon GameLift re-orders the queue's
9317
+ # destinations and locations (for multi-location fleets) based on the
9318
+ # following priorities: (1) the lowest average latency across all
9319
+ # players, (2) the lowest hosting cost, (3) the queue's default
9320
+ # destination order, and then (4), an alphabetic list of locations.
9184
9321
  #
9185
- # Changing the priority order will affect how game sessions are placed.
9322
+ # * If player latency data is not included, Amazon GameLift prioritizes
9323
+ # placing game sessions in the queue's first destination. If that
9324
+ # fleet has multiple locations, the game session is placed on the
9325
+ # first location (when listed alphabetically). Amazon GameLift
9326
+ # re-orders the queue's destinations and locations (for
9327
+ # multi-location fleets) based on the following priorities: (1) the
9328
+ # queue's default destination order, and then (2) an alphabetic list
9329
+ # of locations.
9186
9330
  #
9187
9331
  # @!attribute [rw] priority_order
9188
- # The recommended sequence to use when prioritizing where to place new
9189
- # game sessions. Each type can only be listed once.
9332
+ # A custom sequence to use when prioritizing where to place new game
9333
+ # sessions. Each priority type is listed once.
9190
9334
  #
9191
- # * `LATENCY` -- FleetIQ prioritizes locations where the average
9192
- # player latency (provided in each game session request) is lowest.
9335
+ # * `LATENCY` -- Amazon GameLift prioritizes locations where the
9336
+ # average player latency is lowest. Player latency data is provided
9337
+ # in each game session placement request.
9193
9338
  #
9194
- # * `COST` -- FleetIQ prioritizes destinations with the lowest current
9195
- # hosting costs. Cost is evaluated based on the location, instance
9196
- # type, and fleet type (Spot or On-Demand) for each destination in
9197
- # the queue.
9339
+ # * `COST` -- Amazon GameLift prioritizes destinations with the lowest
9340
+ # current hosting costs. Cost is evaluated based on the location,
9341
+ # instance type, and fleet type (Spot or On-Demand) of each
9342
+ # destination in the queue.
9198
9343
  #
9199
- # * `DESTINATION` -- FleetIQ prioritizes based on the order that
9200
- # destinations are listed in the queue configuration.
9344
+ # * `DESTINATION` -- Amazon GameLift prioritizes based on the list
9345
+ # order of destinations in the queue configuration.
9201
9346
  #
9202
- # * `LOCATION` -- FleetIQ prioritizes based on the provided order of
9203
- # locations, as defined in `LocationOrder`.
9347
+ # * `LOCATION` -- Amazon GameLift prioritizes based on the provided
9348
+ # order of locations, as defined in `LocationOrder`.
9204
9349
  # @return [Array<String>]
9205
9350
  #
9206
9351
  # @!attribute [rw] location_order
9207
9352
  # The prioritization order to use for fleet locations, when the
9208
- # `PriorityOrder` property includes `LOCATION`. Locations are
9209
- # identified by Amazon Web Services Region codes such as `us-west-2`.
9210
- # Each location can only be listed once.
9353
+ # `PriorityOrder` property includes `LOCATION`. Locations can include
9354
+ # Amazon Web Services Region codes (such as `us-west-2`), local zones,
9355
+ # and custom locations (for Anywhere fleets). Each location must be
9356
+ # listed only once. For details, see [Amazon GameLift service
9357
+ # locations.][1]
9358
+ #
9359
+ #
9360
+ #
9361
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-regions.html
9211
9362
  # @return [Array<String>]
9212
9363
  #
9213
9364
  # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/PriorityConfiguration AWS API Documentation
@@ -9219,6 +9370,65 @@ module Aws::GameLift
9219
9370
  include Aws::Structure
9220
9371
  end
9221
9372
 
9373
+ # An alternate list of prioritized locations for use with a game session
9374
+ # queue. When this property is included in a
9375
+ # [StartGameSessionPlacement][1] request, this list overrides the
9376
+ # queue's default location prioritization, as defined in the queue's
9377
+ # [PriorityConfiguration](gamelift/latest/apireference/API_PriorityConfiguration.html)
9378
+ # setting (*LocationOrder*). This property overrides the queue's
9379
+ # default priority list for individual placement requests only. Use this
9380
+ # property only with queues that have a `PriorityConfiguration` setting
9381
+ # that prioritizes first.
9382
+ #
9383
+ # <note markdown="1"> A priority configuration override list does not override a queue's
9384
+ # FilterConfiguration setting, if the queue has one. Filter
9385
+ # configurations are used to limit placements to a subset of the
9386
+ # locations in a queue's destinations. If the override list includes a
9387
+ # location that's not included in the FilterConfiguration allowed list,
9388
+ # Amazon GameLift won't attempt to place a game session there.
9389
+ #
9390
+ # </note>
9391
+ #
9392
+ #
9393
+ #
9394
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartGameSessionPlacement.html
9395
+ #
9396
+ # @!attribute [rw] placement_fallback_strategy
9397
+ # Instructions for how to use the override list if the first round of
9398
+ # placement attempts fails. The first round is a failure if Amazon
9399
+ # GameLift searches all listed locations, in all of the queue's
9400
+ # destinations, without finding an available hosting resource for a
9401
+ # new game session. Valid strategies include:
9402
+ #
9403
+ # * `DEFAULT_AFTER_SINGLE_PASS` -- After the first round of placement
9404
+ # attempts, discard the override list and use the queue's default
9405
+ # location priority list. Continue to use the queue's default list
9406
+ # until the placement request times out.
9407
+ #
9408
+ # * `NONE` -- Continue to use the override list for all rounds of
9409
+ # placement attempts until the placement request times out.
9410
+ # @return [String]
9411
+ #
9412
+ # @!attribute [rw] location_order
9413
+ # A prioritized list of hosting locations. The list can include Amazon
9414
+ # Web Services Regions (such as `us-west-2`), local zones, and custom
9415
+ # locations (for Anywhere fleets). Each location must be listed only
9416
+ # once. For details, see [Amazon GameLift service locations.][1]
9417
+ #
9418
+ #
9419
+ #
9420
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-regions.html
9421
+ # @return [Array<String>]
9422
+ #
9423
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/PriorityConfigurationOverride AWS API Documentation
9424
+ #
9425
+ class PriorityConfigurationOverride < Struct.new(
9426
+ :placement_fallback_strategy,
9427
+ :location_order)
9428
+ SENSITIVE = []
9429
+ include Aws::Structure
9430
+ end
9431
+
9222
9432
  # @!attribute [rw] name
9223
9433
  # A descriptive label that is associated with a fleet's scaling
9224
9434
  # policy. Policy names do not need to be unique. A fleet can have only
@@ -9663,8 +9873,8 @@ module Aws::GameLift
9663
9873
  #
9664
9874
  # @!attribute [rw] max_concurrent_game_session_activations
9665
9875
  # The number of game sessions in status `ACTIVATING` to allow on an
9666
- # instance. This setting limits the instance resources that can be
9667
- # used for new game activations at any one time.
9876
+ # instance or compute. This setting limits the instance resources that
9877
+ # can be used for new game activations at any one time.
9668
9878
  # @return [Integer]
9669
9879
  #
9670
9880
  # @!attribute [rw] game_session_activation_timeout_seconds
@@ -10231,10 +10441,10 @@ module Aws::GameLift
10231
10441
  #
10232
10442
  # @!attribute [rw] player_latencies
10233
10443
  # A set of values, expressed in milliseconds, that indicates the
10234
- # amount of latency that a player experiences when connected to @aws;
10235
- # Regions. This information is used to try to place the new game
10236
- # session where it can offer the best possible gameplay experience for
10237
- # the players.
10444
+ # amount of latency that a player experiences when connected to Amazon
10445
+ # Web Services Regions. This information is used to try to place the
10446
+ # new game session where it can offer the best possible gameplay
10447
+ # experience for the players.
10238
10448
  # @return [Array<Types::PlayerLatency>]
10239
10449
  #
10240
10450
  # @!attribute [rw] desired_player_sessions
@@ -10252,6 +10462,16 @@ module Aws::GameLift
10252
10462
  # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession
10253
10463
  # @return [String]
10254
10464
  #
10465
+ # @!attribute [rw] priority_configuration_override
10466
+ # A prioritized list of locations to use for the game session
10467
+ # placement and instructions on how to use it. This list overrides a
10468
+ # queue's prioritized location list for this game session placement
10469
+ # request only. You can include Amazon Web Services Regions, local
10470
+ # zones, and custom locations (for Anywhere fleets). Choose a fallback
10471
+ # strategy to instruct Amazon GameLift to use the override list for
10472
+ # the first placement attempt only or for all placement attempts.
10473
+ # @return [Types::PriorityConfigurationOverride]
10474
+ #
10255
10475
  # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/StartGameSessionPlacementInput AWS API Documentation
10256
10476
  #
10257
10477
  class StartGameSessionPlacementInput < Struct.new(
@@ -10262,7 +10482,8 @@ module Aws::GameLift
10262
10482
  :game_session_name,
10263
10483
  :player_latencies,
10264
10484
  :desired_player_sessions,
10265
- :game_session_data)
10485
+ :game_session_data,
10486
+ :priority_configuration_override)
10266
10487
  SENSITIVE = []
10267
10488
  include Aws::Structure
10268
10489
  end
@@ -10496,12 +10717,21 @@ module Aws::GameLift
10496
10717
  # You can update a support container definition and deploy the updates
10497
10718
  # to an existing fleet. When creating or updating a game server
10498
10719
  # container group definition, use the property
10499
- # GameServerContainerDefinitionInput.
10720
+ # [GameServerContainerDefinitionInput][1].
10721
+ #
10722
+ # **Part of:** [ContainerGroupDefinition][2]
10500
10723
  #
10501
- # **Part of:** ContainerGroupDefinition
10724
+ # **Returned by:** [DescribeContainerGroupDefinition][3],
10725
+ # [ListContainerGroupDefinitions][4],
10726
+ # [UpdateContainerGroupDefinition][5]
10502
10727
  #
10503
- # **Returned by:** DescribeContainerGroupDefinition,
10504
- # ListContainerGroupDefinitions, UpdateContainerGroupDefinition
10728
+ #
10729
+ #
10730
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_GameServerContainerDefinitionInput.html
10731
+ # [2]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_ContainerGroupDefinition.html
10732
+ # [3]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeContainerGroupDefinition.html
10733
+ # [4]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_ListContainerGroupDefinitions.html
10734
+ # [5]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateContainerGroupDefinition.html
10505
10735
  #
10506
10736
  # @!attribute [rw] container_name
10507
10737
  # The container definition identifier. Container names are unique
@@ -10552,8 +10782,12 @@ module Aws::GameLift
10552
10782
  # container. If memory limits aren't set for an individual container,
10553
10783
  # the container shares the container group's total memory allocation.
10554
10784
  #
10555
- # <b>Related data type: </b>
10556
- # ContainerGroupDefinition$TotalMemoryLimitMebibytes
10785
+ # <b>Related data type: </b> [ContainerGroupDefinition
10786
+ # TotalMemoryLimitMebibytes][1]
10787
+ #
10788
+ #
10789
+ #
10790
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_ContainerGroupDefinition.html
10557
10791
  # @return [Integer]
10558
10792
  #
10559
10793
  # @!attribute [rw] port_configuration
@@ -10575,7 +10809,12 @@ module Aws::GameLift
10575
10809
  # resources are reserved, the container shares the total vCPU limit
10576
10810
  # for the container group.
10577
10811
  #
10578
- # <b>Related data type: </b> ContainerGroupDefinition$TotalVcpuLimit
10812
+ # <b>Related data type: </b> [ContainerGroupDefinition
10813
+ # TotalVcpuLimit][1]
10814
+ #
10815
+ #
10816
+ #
10817
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_ContainerGroupDefinition.html
10579
10818
  # @return [Float]
10580
10819
  #
10581
10820
  # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/SupportContainerDefinition AWS API Documentation
@@ -10604,10 +10843,16 @@ module Aws::GameLift
10604
10843
  # This definition includes container configuration, resources, and start
10605
10844
  # instructions. Use this data type when creating or updating a container
10606
10845
  # group definition. For properties of a deployed support container, see
10607
- # SupportContainerDefinition.
10846
+ # [SupportContainerDefinition][1].
10847
+ #
10848
+ # <b>Use with: </b> [CreateContainerGroupDefinition][2],
10849
+ # [UpdateContainerGroupDefinition][3]
10850
+ #
10608
10851
  #
10609
- # <b>Use with: </b> CreateContainerGroupDefinition,
10610
- # UpdateContainerGroupDefinition
10852
+ #
10853
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_SupportContainerDefinition.html
10854
+ # [2]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateContainerGroupDefinition.html
10855
+ # [3]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateContainerGroupDefinition.html
10611
10856
  #
10612
10857
  # @!attribute [rw] container_name
10613
10858
  # A string that uniquely identifies the container definition within a
@@ -10691,8 +10936,12 @@ module Aws::GameLift
10691
10936
  # If you don't specify a container-specific memory limit, the
10692
10937
  # container shares the container group's total memory allocation.
10693
10938
  #
10694
- # <b>Related data type: </b> ContainerGroupDefinition
10695
- # TotalMemoryLimitMebibytes``
10939
+ # <b>Related data type: </b>
10940
+ # [ContainerGroupDefinition][1]TotalMemoryLimitMebibytes``
10941
+ #
10942
+ #
10943
+ #
10944
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_ContainerGroupDefinition.html
10696
10945
  # @return [Integer]
10697
10946
  #
10698
10947
  # @!attribute [rw] port_configuration
@@ -10714,7 +10963,12 @@ module Aws::GameLift
10714
10963
  # don't reserve CPU units for this container, it shares the container
10715
10964
  # group's total vCPU limit.
10716
10965
  #
10717
- # <b>Related data type: </b> ContainerGroupDefinition TotalCpuLimit
10966
+ # <b>Related data type: </b> [ContainerGroupDefinition][1]
10967
+ # TotalCpuLimit
10968
+ #
10969
+ #
10970
+ #
10971
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_ContainerGroupDefinition.html
10718
10972
  # @return [Float]
10719
10973
  #
10720
10974
  # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/SupportContainerDefinitionInput AWS API Documentation
@@ -10924,6 +11178,74 @@ module Aws::GameLift
10924
11178
  include Aws::Structure
10925
11179
  end
10926
11180
 
11181
+ # @!attribute [rw] game_session_id
11182
+ # A unique identifier for the game session to be terminated. A game
11183
+ # session ARN has the following format:
11184
+ # `arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string
11185
+ # or idempotency token>`.
11186
+ # @return [String]
11187
+ #
11188
+ # @!attribute [rw] termination_mode
11189
+ # The method to use to terminate the game session. Available methods
11190
+ # include:
11191
+ #
11192
+ # * `TRIGGER_ON_PROCESS_TERMINATE` – Prompts the Amazon GameLift
11193
+ # service to send an `OnProcessTerminate()` callback to the server
11194
+ # process and initiate the normal game session shutdown sequence.
11195
+ # The `OnProcessTerminate` method, which is implemented in the game
11196
+ # server code, must include a call to the server SDK action
11197
+ # `ProcessEnding()`, which is how the server process signals to
11198
+ # Amazon GameLift that a game session is ending. If the server
11199
+ # process doesn't call `ProcessEnding()`, the game session
11200
+ # termination won't conclude successfully.
11201
+ #
11202
+ # * `FORCE_TERMINATE` – Prompts the Amazon GameLift service to stop
11203
+ # the server process immediately. Amazon GameLift takes action
11204
+ # (depending on the type of fleet) to shut down the server process
11205
+ # without the normal game session shutdown sequence.
11206
+ #
11207
+ # <note markdown="1"> This method is not available for game sessions that are running on
11208
+ # Anywhere fleets unless the fleet is deployed with the Amazon
11209
+ # GameLift Agent. In this scenario, a force terminate request
11210
+ # results in an invalid or bad request exception.
11211
+ #
11212
+ # </note>
11213
+ # @return [String]
11214
+ #
11215
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/TerminateGameSessionInput AWS API Documentation
11216
+ #
11217
+ class TerminateGameSessionInput < Struct.new(
11218
+ :game_session_id,
11219
+ :termination_mode)
11220
+ SENSITIVE = []
11221
+ include Aws::Structure
11222
+ end
11223
+
11224
+ # @!attribute [rw] game_session
11225
+ # Properties describing a game session.
11226
+ #
11227
+ # A game session in ACTIVE status can host players. When a game
11228
+ # session ends, its status is set to `TERMINATED`.
11229
+ #
11230
+ # Amazon GameLift retains a game session resource for 30 days after
11231
+ # the game session ends. You can reuse idempotency token values after
11232
+ # this time. Game session logs are retained for 14 days.
11233
+ #
11234
+ # [All APIs by task][1]
11235
+ #
11236
+ #
11237
+ #
11238
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
11239
+ # @return [Types::GameSession]
11240
+ #
11241
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/TerminateGameSessionOutput AWS API Documentation
11242
+ #
11243
+ class TerminateGameSessionOutput < Struct.new(
11244
+ :game_session)
11245
+ SENSITIVE = []
11246
+ include Aws::Structure
11247
+ end
11248
+
10927
11249
  # The client failed authentication. Clients should not retry such
10928
11250
  # requests.
10929
11251
  #
@@ -11076,8 +11398,13 @@ module Aws::GameLift
11076
11398
  # definition.
11077
11399
  #
11078
11400
  # Update a container group definition by calling
11079
- # UpdateContainerGroupDefinition. This operation creates a
11080
- # ContainerGroupDefinition resource with an incremented version.
11401
+ # [UpdateContainerGroupDefinition][1]. This operation creates a
11402
+ # [ContainerGroupDefinition][2] resource with an incremented version.
11403
+ #
11404
+ #
11405
+ #
11406
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateContainerGroupDefinition.html
11407
+ # [2]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_ContainerGroupDefinition.html
11081
11408
  # @return [String]
11082
11409
  #
11083
11410
  # @!attribute [rw] per_instance_container_group_definition_name
@@ -11089,11 +11416,16 @@ module Aws::GameLift
11089
11416
  # the name value.
11090
11417
  #
11091
11418
  # Update a container group definition by calling
11092
- # UpdateContainerGroupDefinition. This operation creates a
11093
- # ContainerGroupDefinition resource with an incremented version.
11419
+ # [UpdateContainerGroupDefinition][1]. This operation creates a
11420
+ # [ContainerGroupDefinition][2] resource with an incremented version.
11094
11421
  #
11095
11422
  # To remove a fleet's per-instance container group definition, leave
11096
11423
  # this parameter empty and use the parameter `RemoveAttributes`.
11424
+ #
11425
+ #
11426
+ #
11427
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateContainerGroupDefinition.html
11428
+ # [2]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_ContainerGroupDefinition.html
11097
11429
  # @return [String]
11098
11430
  #
11099
11431
  # @!attribute [rw] game_server_container_groups_per_instance
@@ -11301,7 +11633,7 @@ module Aws::GameLift
11301
11633
  # The game session protection policy to apply to all new game sessions
11302
11634
  # created in this fleet. Game sessions that already exist are not
11303
11635
  # affected. You can set protection for individual game sessions using
11304
- # [UpdateGameSession][1].
11636
+ # [UpdateGameSession][1] .
11305
11637
  #
11306
11638
  # * **NoProtection** -- The game session can be terminated during a
11307
11639
  # scale-down event.
@@ -11655,11 +11987,11 @@ module Aws::GameLift
11655
11987
  # @!attribute [rw] protection_policy
11656
11988
  # Game session protection policy to apply to this game session only.
11657
11989
  #
11658
- # * **NoProtection** -- The game session can be terminated during a
11990
+ # * `NoProtection` -- The game session can be terminated during a
11659
11991
  # scale-down event.
11660
11992
  #
11661
- # * **FullProtection** -- If the game session is in an `ACTIVE`
11662
- # status, it cannot be terminated during a scale-down event.
11993
+ # * `FullProtection` -- If the game session is in an `ACTIVE` status,
11994
+ # it cannot be terminated during a scale-down event.
11663
11995
  # @return [String]
11664
11996
  #
11665
11997
  # @!attribute [rw] game_properties