aws-sdk-gamelift 1.96.0 → 1.97.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-gamelift/client.rb +322 -155
- data/lib/aws-sdk-gamelift/client_api.rb +24 -0
- data/lib/aws-sdk-gamelift/types.rb +356 -119
- data/lib/aws-sdk-gamelift.rb +1 -1
- data/sig/client.rbs +11 -0
- data/sig/types.rbs +12 -1
- metadata +2 -2
@@ -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
|
-
#
|
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
|
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**
|
339
|
+
# * **GENERATED** - Generate a TLS/SSL certificate for this fleet.
|
334
340
|
#
|
335
|
-
# * **DISABLED**
|
336
|
-
#
|
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
|
-
#
|
606
|
-
#
|
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,
|
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
|
-
#
|
920
|
-
#
|
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
|
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][
|
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][
|
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/
|
1060
|
-
# [2]: https://docs.aws.amazon.com/
|
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
|
+
#
|
1188
|
+
#
|
1150
1189
|
#
|
1151
|
-
#
|
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
|
-
#
|
1177
|
-
#
|
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,
|
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
|
1329
|
-
# determines the type of fleet resources that you use for this
|
1330
|
-
# If your game build contains multiple executables, they all
|
1331
|
-
# on the same operating system.
|
1332
|
-
#
|
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
|
-
#
|
1469
|
-
#
|
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
|
-
#
|
1875
|
-
#
|
1876
|
-
#
|
1877
|
-
#
|
1878
|
-
# sets TCP and UDP
|
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` –
|
2036
|
-
#
|
2037
|
-
#
|
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
|
@@ -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:**
|
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
|
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
|
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
|
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
|
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
|
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
|
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
|
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
|
-
#
|
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
|
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
|
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
|
-
# **
|
6043
|
+
# **Returned by:** [DescribeContainerGroupDefinition][3],
|
6044
|
+
# [ListContainerGroupDefinitions][4],
|
6045
|
+
# [UpdateContainerGroupDefinition][5]
|
5965
6046
|
#
|
5966
|
-
#
|
5967
|
-
#
|
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
|
6044
|
-
# container is automatically considered essential; if an
|
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
|
+
#
|
6046
6136
|
#
|
6047
|
-
#
|
6048
|
-
#
|
6137
|
+
#
|
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:**
|
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
|
-
#
|
6474
|
-
#
|
6475
|
-
#
|
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
|
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
|
6723
|
-
#
|
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
|
6724
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
|
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
|
@@ -7010,7 +7123,12 @@ module Aws::GameLift
|
|
7010
7123
|
# @!attribute [rw] compute_name
|
7011
7124
|
# A unique identifier for the compute resource that you want to
|
7012
7125
|
# connect to. For an EC2 fleet compute, use the instance ID. Use
|
7013
|
-
#
|
7126
|
+
# [https://docs.aws.amazon.com/gamelift/latest/apireference/API\_ListCompute.html][1]
|
7127
|
+
# to retrieve compute identifiers.
|
7128
|
+
#
|
7129
|
+
#
|
7130
|
+
#
|
7131
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_ListCompute.html
|
7014
7132
|
# @return [String]
|
7015
7133
|
#
|
7016
7134
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/GetComputeAccessInput AWS API Documentation
|
@@ -7353,7 +7471,12 @@ module Aws::GameLift
|
|
7353
7471
|
|
7354
7472
|
# Information and credentials that you can use to remotely connect to an
|
7355
7473
|
# instance in an EC2 managed fleet. This data type is returned in
|
7356
|
-
# response to a call to
|
7474
|
+
# response to a call to
|
7475
|
+
# [https://docs.aws.amazon.com/gamelift/latest/apireference/API\_GetInstanceAccess][1].
|
7476
|
+
#
|
7477
|
+
#
|
7478
|
+
#
|
7479
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_GetInstanceAccess
|
7357
7480
|
#
|
7358
7481
|
# @!attribute [rw] fleet_id
|
7359
7482
|
# A unique identifier for the fleet containing the instance to be
|
@@ -7390,9 +7513,13 @@ module Aws::GameLift
|
|
7390
7513
|
|
7391
7514
|
# A set of credentials that allow remote access to an instance in an EC2
|
7392
7515
|
# managed fleet. These credentials are returned in response to a call to
|
7393
|
-
#
|
7394
|
-
#
|
7395
|
-
# or earlier.
|
7516
|
+
# [https://docs.aws.amazon.com/gamelift/latest/apireference/API\_GetInstanceAccess][1],
|
7517
|
+
# which requests access for instances that are running game servers with
|
7518
|
+
# the Amazon GameLift server SDK version 4.x or earlier.
|
7519
|
+
#
|
7520
|
+
#
|
7521
|
+
#
|
7522
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_GetInstanceAccess
|
7396
7523
|
#
|
7397
7524
|
# @!attribute [rw] user_name
|
7398
7525
|
# A user name for logging in.
|
@@ -7512,9 +7639,7 @@ module Aws::GameLift
|
|
7512
7639
|
# A range of IP addresses and port settings that allow inbound traffic
|
7513
7640
|
# to connect to processes on an instance in a fleet. Processes are
|
7514
7641
|
# assigned an IP address/port number combination, which must fall into
|
7515
|
-
# the fleet's allowed ranges.
|
7516
|
-
# settings must use the same port numbers as the fleet's connection
|
7517
|
-
# ports.
|
7642
|
+
# the fleet's allowed ranges.
|
7518
7643
|
#
|
7519
7644
|
# For Realtime Servers fleets, Amazon GameLift automatically opens two
|
7520
7645
|
# port ranges, one for TCP messaging and one for UDP.
|
@@ -8308,7 +8433,11 @@ module Aws::GameLift
|
|
8308
8433
|
|
8309
8434
|
# Properties of a custom location for use in an Amazon GameLift Anywhere
|
8310
8435
|
# fleet. This data type is returned in response to a call to
|
8311
|
-
#
|
8436
|
+
# [https://docs.aws.amazon.com/gamelift/latest/apireference/API\_CreateLocation][1].
|
8437
|
+
#
|
8438
|
+
#
|
8439
|
+
#
|
8440
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateLocation
|
8312
8441
|
#
|
8313
8442
|
# @!attribute [rw] location_name
|
8314
8443
|
# The location's name.
|
@@ -9663,8 +9792,8 @@ module Aws::GameLift
|
|
9663
9792
|
#
|
9664
9793
|
# @!attribute [rw] max_concurrent_game_session_activations
|
9665
9794
|
# The number of game sessions in status `ACTIVATING` to allow on an
|
9666
|
-
# instance. This setting limits the instance resources that
|
9667
|
-
# used for new game activations at any one time.
|
9795
|
+
# instance or compute. This setting limits the instance resources that
|
9796
|
+
# can be used for new game activations at any one time.
|
9668
9797
|
# @return [Integer]
|
9669
9798
|
#
|
9670
9799
|
# @!attribute [rw] game_session_activation_timeout_seconds
|
@@ -10496,12 +10625,21 @@ module Aws::GameLift
|
|
10496
10625
|
# You can update a support container definition and deploy the updates
|
10497
10626
|
# to an existing fleet. When creating or updating a game server
|
10498
10627
|
# container group definition, use the property
|
10499
|
-
# GameServerContainerDefinitionInput.
|
10628
|
+
# [GameServerContainerDefinitionInput][1].
|
10629
|
+
#
|
10630
|
+
# **Part of:** [ContainerGroupDefinition][2]
|
10500
10631
|
#
|
10501
|
-
# **
|
10632
|
+
# **Returned by:** [DescribeContainerGroupDefinition][3],
|
10633
|
+
# [ListContainerGroupDefinitions][4],
|
10634
|
+
# [UpdateContainerGroupDefinition][5]
|
10502
10635
|
#
|
10503
|
-
#
|
10504
|
-
#
|
10636
|
+
#
|
10637
|
+
#
|
10638
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_GameServerContainerDefinitionInput.html
|
10639
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_ContainerGroupDefinition.html
|
10640
|
+
# [3]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeContainerGroupDefinition.html
|
10641
|
+
# [4]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_ListContainerGroupDefinitions.html
|
10642
|
+
# [5]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateContainerGroupDefinition.html
|
10505
10643
|
#
|
10506
10644
|
# @!attribute [rw] container_name
|
10507
10645
|
# The container definition identifier. Container names are unique
|
@@ -10552,8 +10690,12 @@ module Aws::GameLift
|
|
10552
10690
|
# container. If memory limits aren't set for an individual container,
|
10553
10691
|
# the container shares the container group's total memory allocation.
|
10554
10692
|
#
|
10555
|
-
# <b>Related data type: </b>
|
10556
|
-
#
|
10693
|
+
# <b>Related data type: </b> [ContainerGroupDefinition
|
10694
|
+
# TotalMemoryLimitMebibytes][1]
|
10695
|
+
#
|
10696
|
+
#
|
10697
|
+
#
|
10698
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_ContainerGroupDefinition.html
|
10557
10699
|
# @return [Integer]
|
10558
10700
|
#
|
10559
10701
|
# @!attribute [rw] port_configuration
|
@@ -10575,7 +10717,12 @@ module Aws::GameLift
|
|
10575
10717
|
# resources are reserved, the container shares the total vCPU limit
|
10576
10718
|
# for the container group.
|
10577
10719
|
#
|
10578
|
-
# <b>Related data type: </b> ContainerGroupDefinition
|
10720
|
+
# <b>Related data type: </b> [ContainerGroupDefinition
|
10721
|
+
# TotalVcpuLimit][1]
|
10722
|
+
#
|
10723
|
+
#
|
10724
|
+
#
|
10725
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_ContainerGroupDefinition.html
|
10579
10726
|
# @return [Float]
|
10580
10727
|
#
|
10581
10728
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/SupportContainerDefinition AWS API Documentation
|
@@ -10604,10 +10751,16 @@ module Aws::GameLift
|
|
10604
10751
|
# This definition includes container configuration, resources, and start
|
10605
10752
|
# instructions. Use this data type when creating or updating a container
|
10606
10753
|
# group definition. For properties of a deployed support container, see
|
10607
|
-
# SupportContainerDefinition.
|
10754
|
+
# [SupportContainerDefinition][1].
|
10608
10755
|
#
|
10609
|
-
# <b>Use with: </b> CreateContainerGroupDefinition,
|
10610
|
-
# UpdateContainerGroupDefinition
|
10756
|
+
# <b>Use with: </b> [CreateContainerGroupDefinition][2],
|
10757
|
+
# [UpdateContainerGroupDefinition][3]
|
10758
|
+
#
|
10759
|
+
#
|
10760
|
+
#
|
10761
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_SupportContainerDefinition.html
|
10762
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateContainerGroupDefinition.html
|
10763
|
+
# [3]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateContainerGroupDefinition.html
|
10611
10764
|
#
|
10612
10765
|
# @!attribute [rw] container_name
|
10613
10766
|
# A string that uniquely identifies the container definition within a
|
@@ -10691,8 +10844,12 @@ module Aws::GameLift
|
|
10691
10844
|
# If you don't specify a container-specific memory limit, the
|
10692
10845
|
# container shares the container group's total memory allocation.
|
10693
10846
|
#
|
10694
|
-
# <b>Related data type: </b>
|
10695
|
-
# TotalMemoryLimitMebibytes``
|
10847
|
+
# <b>Related data type: </b>
|
10848
|
+
# [ContainerGroupDefinition][1]TotalMemoryLimitMebibytes``
|
10849
|
+
#
|
10850
|
+
#
|
10851
|
+
#
|
10852
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_ContainerGroupDefinition.html
|
10696
10853
|
# @return [Integer]
|
10697
10854
|
#
|
10698
10855
|
# @!attribute [rw] port_configuration
|
@@ -10714,7 +10871,12 @@ module Aws::GameLift
|
|
10714
10871
|
# don't reserve CPU units for this container, it shares the container
|
10715
10872
|
# group's total vCPU limit.
|
10716
10873
|
#
|
10717
|
-
# <b>Related data type: </b> ContainerGroupDefinition
|
10874
|
+
# <b>Related data type: </b> [ContainerGroupDefinition][1]
|
10875
|
+
# TotalCpuLimit
|
10876
|
+
#
|
10877
|
+
#
|
10878
|
+
#
|
10879
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_ContainerGroupDefinition.html
|
10718
10880
|
# @return [Float]
|
10719
10881
|
#
|
10720
10882
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/SupportContainerDefinitionInput AWS API Documentation
|
@@ -10924,6 +11086,71 @@ module Aws::GameLift
|
|
10924
11086
|
include Aws::Structure
|
10925
11087
|
end
|
10926
11088
|
|
11089
|
+
# @!attribute [rw] game_session_id
|
11090
|
+
# A unique identifier for the game session to be terminated. A game
|
11091
|
+
# session ARN has the following format:
|
11092
|
+
# `arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string
|
11093
|
+
# or idempotency token>`.
|
11094
|
+
# @return [String]
|
11095
|
+
#
|
11096
|
+
# @!attribute [rw] termination_mode
|
11097
|
+
# The method to use to terminate the game session. Available methods
|
11098
|
+
# include:
|
11099
|
+
#
|
11100
|
+
# * `TRIGGER_ON_PROCESS_TERMINATE` – Sends an `OnProcessTerminate()`
|
11101
|
+
# callback to the server process to initiate the normal game session
|
11102
|
+
# shutdown sequence. At a minimum, the callback method must include
|
11103
|
+
# a call to the server SDK action `ProcessEnding()`, which is how
|
11104
|
+
# the server process signals that a game session is ending. If the
|
11105
|
+
# server process doesn't call `ProcessEnding()`, this termination
|
11106
|
+
# method won't be successful.
|
11107
|
+
#
|
11108
|
+
# * `FORCE_TERMINATE` – Takes action to stop the server process, using
|
11109
|
+
# existing methods to control how server processes run on an Amazon
|
11110
|
+
# GameLift managed compute.
|
11111
|
+
#
|
11112
|
+
# <note markdown="1"> This method is not available for game sessions that are running on
|
11113
|
+
# Anywhere fleets unless the fleet is deployed with the Amazon
|
11114
|
+
# GameLift Agent. In this scenario, a force terminate request
|
11115
|
+
# results in an invalid or bad request exception.
|
11116
|
+
#
|
11117
|
+
# </note>
|
11118
|
+
# @return [String]
|
11119
|
+
#
|
11120
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/TerminateGameSessionInput AWS API Documentation
|
11121
|
+
#
|
11122
|
+
class TerminateGameSessionInput < Struct.new(
|
11123
|
+
:game_session_id,
|
11124
|
+
:termination_mode)
|
11125
|
+
SENSITIVE = []
|
11126
|
+
include Aws::Structure
|
11127
|
+
end
|
11128
|
+
|
11129
|
+
# @!attribute [rw] game_session
|
11130
|
+
# Properties describing a game session.
|
11131
|
+
#
|
11132
|
+
# A game session in ACTIVE status can host players. When a game
|
11133
|
+
# session ends, its status is set to `TERMINATED`.
|
11134
|
+
#
|
11135
|
+
# Amazon GameLift retains a game session resource for 30 days after
|
11136
|
+
# the game session ends. You can reuse idempotency token values after
|
11137
|
+
# this time. Game session logs are retained for 14 days.
|
11138
|
+
#
|
11139
|
+
# [All APIs by task][1]
|
11140
|
+
#
|
11141
|
+
#
|
11142
|
+
#
|
11143
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
|
11144
|
+
# @return [Types::GameSession]
|
11145
|
+
#
|
11146
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/TerminateGameSessionOutput AWS API Documentation
|
11147
|
+
#
|
11148
|
+
class TerminateGameSessionOutput < Struct.new(
|
11149
|
+
:game_session)
|
11150
|
+
SENSITIVE = []
|
11151
|
+
include Aws::Structure
|
11152
|
+
end
|
11153
|
+
|
10927
11154
|
# The client failed authentication. Clients should not retry such
|
10928
11155
|
# requests.
|
10929
11156
|
#
|
@@ -11076,8 +11303,13 @@ module Aws::GameLift
|
|
11076
11303
|
# definition.
|
11077
11304
|
#
|
11078
11305
|
# Update a container group definition by calling
|
11079
|
-
# UpdateContainerGroupDefinition. This operation creates a
|
11080
|
-
# ContainerGroupDefinition resource with an incremented version.
|
11306
|
+
# [UpdateContainerGroupDefinition][1]. This operation creates a
|
11307
|
+
# [ContainerGroupDefinition][2] resource with an incremented version.
|
11308
|
+
#
|
11309
|
+
#
|
11310
|
+
#
|
11311
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateContainerGroupDefinition.html
|
11312
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_ContainerGroupDefinition.html
|
11081
11313
|
# @return [String]
|
11082
11314
|
#
|
11083
11315
|
# @!attribute [rw] per_instance_container_group_definition_name
|
@@ -11089,11 +11321,16 @@ module Aws::GameLift
|
|
11089
11321
|
# the name value.
|
11090
11322
|
#
|
11091
11323
|
# Update a container group definition by calling
|
11092
|
-
# UpdateContainerGroupDefinition. This operation creates a
|
11093
|
-
# ContainerGroupDefinition resource with an incremented version.
|
11324
|
+
# [UpdateContainerGroupDefinition][1]. This operation creates a
|
11325
|
+
# [ContainerGroupDefinition][2] resource with an incremented version.
|
11094
11326
|
#
|
11095
11327
|
# To remove a fleet's per-instance container group definition, leave
|
11096
11328
|
# this parameter empty and use the parameter `RemoveAttributes`.
|
11329
|
+
#
|
11330
|
+
#
|
11331
|
+
#
|
11332
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateContainerGroupDefinition.html
|
11333
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_ContainerGroupDefinition.html
|
11097
11334
|
# @return [String]
|
11098
11335
|
#
|
11099
11336
|
# @!attribute [rw] game_server_container_groups_per_instance
|
@@ -11301,7 +11538,7 @@ module Aws::GameLift
|
|
11301
11538
|
# The game session protection policy to apply to all new game sessions
|
11302
11539
|
# created in this fleet. Game sessions that already exist are not
|
11303
11540
|
# affected. You can set protection for individual game sessions using
|
11304
|
-
# [UpdateGameSession][1].
|
11541
|
+
# [UpdateGameSession][1] .
|
11305
11542
|
#
|
11306
11543
|
# * **NoProtection** -- The game session can be terminated during a
|
11307
11544
|
# scale-down event.
|
@@ -11655,11 +11892,11 @@ module Aws::GameLift
|
|
11655
11892
|
# @!attribute [rw] protection_policy
|
11656
11893
|
# Game session protection policy to apply to this game session only.
|
11657
11894
|
#
|
11658
|
-
# *
|
11895
|
+
# * `NoProtection` -- The game session can be terminated during a
|
11659
11896
|
# scale-down event.
|
11660
11897
|
#
|
11661
|
-
# *
|
11662
|
-
#
|
11898
|
+
# * `FullProtection` -- If the game session is in an `ACTIVE` status,
|
11899
|
+
# it cannot be terminated during a scale-down event.
|
11663
11900
|
# @return [String]
|
11664
11901
|
#
|
11665
11902
|
# @!attribute [rw] game_properties
|