@aws-sdk/client-gamelift 3.1146.0 → 3.1148.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.
- package/dist-cjs/index.js +13 -9
- package/dist-es/models/enums.js +3 -0
- package/dist-es/schemas/schemas_0.js +9 -8
- package/dist-types/commands/AcceptMatchCommand.d.ts +1 -1
- package/dist-types/commands/CreateContainerGroupDefinitionCommand.d.ts +5 -4
- package/dist-types/commands/CreateFleetLocationsCommand.d.ts +1 -1
- package/dist-types/commands/CreateGameSessionCommand.d.ts +1 -1
- package/dist-types/commands/CreateMatchmakingConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/CreateVpcPeeringConnectionCommand.d.ts +1 -1
- package/dist-types/commands/DeleteFleetLocationsCommand.d.ts +1 -1
- package/dist-types/commands/DeleteVpcPeeringConnectionCommand.d.ts +1 -1
- package/dist-types/commands/DeregisterComputeCommand.d.ts +1 -1
- package/dist-types/commands/DescribeContainerFleetCommand.d.ts +1 -1
- package/dist-types/commands/DescribeContainerGroupDefinitionCommand.d.ts +1 -0
- package/dist-types/commands/DescribeFleetAttributesCommand.d.ts +1 -1
- package/dist-types/commands/DescribeGameSessionDetailsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeInstancesCommand.d.ts +1 -1
- package/dist-types/commands/ListContainerGroupDefinitionVersionsCommand.d.ts +1 -0
- package/dist-types/commands/ListContainerGroupDefinitionsCommand.d.ts +1 -0
- package/dist-types/commands/ListFleetsCommand.d.ts +1 -1
- package/dist-types/commands/ListGameServerGroupsCommand.d.ts +1 -1
- package/dist-types/commands/SearchGameSessionsCommand.d.ts +1 -1
- package/dist-types/commands/StartGameSessionPlacementCommand.d.ts +2 -2
- package/dist-types/commands/StartMatchBackfillCommand.d.ts +1 -1
- package/dist-types/commands/StopGameSessionPlacementCommand.d.ts +1 -1
- package/dist-types/commands/UpdateContainerFleetCommand.d.ts +2 -2
- package/dist-types/commands/UpdateContainerGroupDefinitionCommand.d.ts +13 -1
- package/dist-types/commands/UpdateFleetAttributesCommand.d.ts +1 -1
- package/dist-types/commands/UpdateGameServerCommand.d.ts +1 -1
- package/dist-types/models/enums.d.ts +11 -0
- package/dist-types/models/models_0.d.ts +129 -78
- package/dist-types/models/models_1.d.ts +28 -9
- package/dist-types/ts3.4/models/enums.d.ts +5 -0
- package/dist-types/ts3.4/models/models_0.d.ts +3 -1
- package/dist-types/ts3.4/models/models_1.d.ts +2 -0
- package/package.json +1 -1
|
@@ -174,7 +174,7 @@ export interface AttributeValue {
|
|
|
174
174
|
* task, call <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_RequestUploadCredentials.html">https://docs.aws.amazon.com/gamelift/latest/apireference/API_RequestUploadCredentials.html</a>.</p>
|
|
175
175
|
* </li>
|
|
176
176
|
* <li>
|
|
177
|
-
* <p>To remotely connect to an active Amazon GameLift Servers fleet
|
|
177
|
+
* <p>To remotely connect to an active Amazon GameLift Servers fleet instance.
|
|
178
178
|
* To get remote access, call <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_GetComputeAccess.html">https://docs.aws.amazon.com/gamelift/latest/apireference/API_GetComputeAccess.html</a>.</p>
|
|
179
179
|
* </li>
|
|
180
180
|
* </ul>
|
|
@@ -484,7 +484,7 @@ export interface ContainerAttribute {
|
|
|
484
484
|
}
|
|
485
485
|
/**
|
|
486
486
|
* <p>An Amazon GameLift Servers compute resource for hosting your game servers. Computes in an Amazon GameLift Servers
|
|
487
|
-
* fleet
|
|
487
|
+
* fleet differ depending on the fleet's compute type property as follows: </p>
|
|
488
488
|
* <ul>
|
|
489
489
|
* <li>
|
|
490
490
|
* <p>For managed EC2 fleets, a compute is an EC2 instance.</p>
|
|
@@ -626,7 +626,7 @@ export interface ConnectionPortRange {
|
|
|
626
626
|
}
|
|
627
627
|
/**
|
|
628
628
|
* <p>A container's dependency on another container in the same container group. The dependency
|
|
629
|
-
* impacts how the dependent container is able to start or shut down based the status of the
|
|
629
|
+
* impacts how the dependent container is able to start or shut down based on the status of the
|
|
630
630
|
* other container.</p>
|
|
631
631
|
* <p>For example, <i>ContainerA</i> is configured with the following dependency: a
|
|
632
632
|
* <code>START</code> dependency on <i>ContainerB</i>. This means that
|
|
@@ -715,7 +715,7 @@ export interface DeploymentDetails {
|
|
|
715
715
|
* consume available resources.</p>
|
|
716
716
|
* <p>The policy is evaluated when a player tries to create a new game session. On receiving
|
|
717
717
|
* a <code>CreateGameSession</code> request, Amazon GameLift Servers checks that the player (identified by
|
|
718
|
-
* <code>CreatorId</code>) has created fewer than game session limit in the specified
|
|
718
|
+
* <code>CreatorId</code>) has created fewer than the game session limit in the specified
|
|
719
719
|
* time period.</p>
|
|
720
720
|
* @public
|
|
721
721
|
*/
|
|
@@ -726,7 +726,7 @@ export interface GameSessionCreationLimitPolicy {
|
|
|
726
726
|
* consume available resources.</p>
|
|
727
727
|
* <p>The policy evaluates when a player tries to create a new game session. On receiving a
|
|
728
728
|
* <code>CreateGameSession</code> request, Amazon GameLift Servers checks that the player (identified
|
|
729
|
-
* by <code>CreatorId</code>) has created fewer than game session limit in the specified
|
|
729
|
+
* by <code>CreatorId</code>) has created fewer than the game session limit in the specified
|
|
730
730
|
* time period.</p>
|
|
731
731
|
* @public
|
|
732
732
|
*/
|
|
@@ -814,7 +814,7 @@ export interface ContainerFleetLocationAttributes {
|
|
|
814
814
|
* </li>
|
|
815
815
|
* <li>
|
|
816
816
|
* <p>
|
|
817
|
-
* <code>UPDATING</code> --
|
|
817
|
+
* <code>UPDATING</code> -- The container fleet is being updated. A
|
|
818
818
|
* deployment is in progress.</p>
|
|
819
819
|
* </li>
|
|
820
820
|
* <li>
|
|
@@ -950,7 +950,7 @@ export interface ContainerFleet {
|
|
|
950
950
|
*/
|
|
951
951
|
GameServerContainerGroupsPerInstance?: number | undefined;
|
|
952
952
|
/**
|
|
953
|
-
* <p>The calculated maximum number of game server container
|
|
953
|
+
* <p>The calculated maximum number of game server container groups that can be deployed on
|
|
954
954
|
* each fleet instance. The calculation depends on the resource needs of the container
|
|
955
955
|
* group and the CPU and memory resources of the fleet's instance type.</p>
|
|
956
956
|
* @public
|
|
@@ -959,7 +959,7 @@ export interface ContainerFleet {
|
|
|
959
959
|
/**
|
|
960
960
|
* <p>The Amazon EC2 instance type to use for all instances in the fleet. Instance type
|
|
961
961
|
* determines the computing resources and processing power that's available to host your
|
|
962
|
-
* game servers. This includes
|
|
962
|
+
* game servers. This includes CPU, memory, storage, and networking capacity. You
|
|
963
963
|
* can't update this fleet property.</p>
|
|
964
964
|
* @public
|
|
965
965
|
*/
|
|
@@ -1041,7 +1041,7 @@ export interface ContainerFleet {
|
|
|
1041
1041
|
* </li>
|
|
1042
1042
|
* <li>
|
|
1043
1043
|
* <p>
|
|
1044
|
-
* <code>UPDATING</code> --
|
|
1044
|
+
* <code>UPDATING</code> -- The container fleet is being updated. A deployment is in
|
|
1045
1045
|
* progress.</p>
|
|
1046
1046
|
* </li>
|
|
1047
1047
|
* <li>
|
|
@@ -1296,6 +1296,25 @@ export interface GameServerContainerDefinition {
|
|
|
1296
1296
|
* @public
|
|
1297
1297
|
*/
|
|
1298
1298
|
LinuxCapabilities?: LinuxCapabilities | undefined;
|
|
1299
|
+
/**
|
|
1300
|
+
* <p>The number of vCPU units reserved for the game server container. The container can use
|
|
1301
|
+
* more vCPU when it's available, up to the container group's total vCPU limit if one is set. If
|
|
1302
|
+
* the container group has a total vCPU limit and the request doesn't set this value, Amazon GameLift Servers
|
|
1303
|
+
* calculates the game server container's vCPU as the total vCPU limit minus the sum of the vCPU
|
|
1304
|
+
* units reserved for the group's support containers.</p>
|
|
1305
|
+
* <p>A game server container group needs either a total vCPU limit or this value. If the
|
|
1306
|
+
* container group doesn't have a total vCPU limit, the group's containers can use up to the
|
|
1307
|
+
* instance's available vCPU, and Amazon GameLift Servers uses the sum of the group's container
|
|
1308
|
+
* <code>Vcpu</code> values to calculate how many game server container groups fit on an
|
|
1309
|
+
* instance.</p>
|
|
1310
|
+
* <p>
|
|
1311
|
+
* <b>Related data type: </b>
|
|
1312
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_ContainerGroupDefinition.html">ContainerGroupDefinition</a>
|
|
1313
|
+
* <code>TotalVcpuLimit</code>
|
|
1314
|
+
* </p>
|
|
1315
|
+
* @public
|
|
1316
|
+
*/
|
|
1317
|
+
Vcpu?: number | undefined;
|
|
1299
1318
|
}
|
|
1300
1319
|
/**
|
|
1301
1320
|
* <p>Instructions on when and how to check the health of a support container in a container
|
|
@@ -1426,7 +1445,7 @@ export interface SupportContainerDefinition {
|
|
|
1426
1445
|
MemoryHardLimitMebibytes?: number | undefined;
|
|
1427
1446
|
/**
|
|
1428
1447
|
* <p>A set of ports that allow access to the container from external users. Processes running
|
|
1429
|
-
* in the container can bind to
|
|
1448
|
+
* in the container can bind to one of these ports. Container ports aren't directly accessed by
|
|
1430
1449
|
* inbound traffic. Amazon GameLift Servers maps these container ports to externally accessible connection ports,
|
|
1431
1450
|
* which are assigned as needed from the container fleet's
|
|
1432
1451
|
* <code>ConnectionPortRange</code>.</p>
|
|
@@ -1457,7 +1476,7 @@ export interface SupportContainerDefinition {
|
|
|
1457
1476
|
}
|
|
1458
1477
|
/**
|
|
1459
1478
|
* <p>The properties that describe a container group resource. You can update all properties of
|
|
1460
|
-
* a container group definition
|
|
1479
|
+
* a container group definition. Updates to a container group definition are saved as
|
|
1461
1480
|
* new versions. </p>
|
|
1462
1481
|
* <p>
|
|
1463
1482
|
* <b>Used with:</b>
|
|
@@ -1519,9 +1538,14 @@ export interface ContainerGroupDefinition {
|
|
|
1519
1538
|
/**
|
|
1520
1539
|
* <p>The amount of vCPU units on a fleet instance to allocate for the container group (1 vCPU
|
|
1521
1540
|
* is equal to 1024 CPU units). All containers in the group share these resources. You can set a
|
|
1522
|
-
*
|
|
1523
|
-
* total value must be equal to or greater than the sum of the
|
|
1524
|
-
* group.</p>
|
|
1541
|
+
* vCPU reservation for each container definition in the group. If individual containers have
|
|
1542
|
+
* reservations, this total value must be equal to or greater than the sum of the reservations
|
|
1543
|
+
* for each container in the group.</p>
|
|
1544
|
+
* <p>For a game server container group, if this property is set, Amazon GameLift Servers uses this value to
|
|
1545
|
+
* calculate how many game server container groups fit on an instance. If this property isn't set,
|
|
1546
|
+
* the group's containers can use up to the instance's available vCPU, and Amazon GameLift Servers uses the sum of
|
|
1547
|
+
* the containers' <code>Vcpu</code> values to calculate how many game server container groups fit
|
|
1548
|
+
* on an instance.</p>
|
|
1525
1549
|
* @public
|
|
1526
1550
|
*/
|
|
1527
1551
|
TotalVcpuLimit?: number | undefined;
|
|
@@ -1534,7 +1558,7 @@ export interface ContainerGroupDefinition {
|
|
|
1534
1558
|
GameServerContainerDefinition?: GameServerContainerDefinition | undefined;
|
|
1535
1559
|
/**
|
|
1536
1560
|
* <p>The set of definitions for support containers in this group. A container group definition
|
|
1537
|
-
* might have zero support container definitions. Support
|
|
1561
|
+
* might have zero support container definitions. Support containers can be used in any type of
|
|
1538
1562
|
* container group.</p>
|
|
1539
1563
|
* @public
|
|
1540
1564
|
*/
|
|
@@ -1585,11 +1609,11 @@ export interface ContainerGroupDefinition {
|
|
|
1585
1609
|
* <li>
|
|
1586
1610
|
* <p>An internal issue prevented Amazon GameLift Servers from creating
|
|
1587
1611
|
* the container group definition resource. Delete the failed resource and call
|
|
1588
|
-
* <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateContainerGroupDefinition.html">CreateContainerGroupDefinition</a>again. </p>
|
|
1612
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateContainerGroupDefinition.html">CreateContainerGroupDefinition</a> again. </p>
|
|
1589
1613
|
* </li>
|
|
1590
1614
|
* <li>
|
|
1591
1615
|
* <p>An access-denied message means that you don't have permissions to access the container image on ECR. See
|
|
1592
|
-
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-iam-policy-examples.html
|
|
1616
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-iam-policy-examples.html">
|
|
1593
1617
|
* IAM permission examples</a>
|
|
1594
1618
|
* for help setting up required IAM permissions for Amazon GameLift Servers.</p>
|
|
1595
1619
|
* </li>
|
|
@@ -1756,7 +1780,7 @@ export interface CreateAliasInput {
|
|
|
1756
1780
|
RoutingStrategy: RoutingStrategy | undefined;
|
|
1757
1781
|
/**
|
|
1758
1782
|
* <p>A list of labels to assign to the new alias resource. Tags are developer-defined
|
|
1759
|
-
* key-value pairs. Tagging Amazon Web Services resources
|
|
1783
|
+
* key-value pairs. Tagging Amazon Web Services resources is useful for resource management, access
|
|
1760
1784
|
* management and cost allocation. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html"> Tagging Amazon Web Services Resources</a> in the
|
|
1761
1785
|
* <i>Amazon Web Services General Reference</i>.</p>
|
|
1762
1786
|
* @public
|
|
@@ -1780,7 +1804,7 @@ export interface CreateAliasOutput {
|
|
|
1780
1804
|
*/
|
|
1781
1805
|
export interface S3Location {
|
|
1782
1806
|
/**
|
|
1783
|
-
* <p>An Amazon S3 bucket identifier.
|
|
1807
|
+
* <p>An Amazon S3 bucket identifier. The name of the S3 bucket.</p>
|
|
1784
1808
|
* <note>
|
|
1785
1809
|
* <p>Amazon GameLift Servers doesn't support uploading from Amazon S3 buckets with names that contain a dot
|
|
1786
1810
|
* (.).</p>
|
|
@@ -1863,7 +1887,7 @@ export interface CreateBuildInput {
|
|
|
1863
1887
|
OperatingSystem?: OperatingSystem | undefined;
|
|
1864
1888
|
/**
|
|
1865
1889
|
* <p>A list of labels to assign to the new build resource. Tags are developer defined
|
|
1866
|
-
* key-value pairs. Tagging Amazon Web Services resources
|
|
1890
|
+
* key-value pairs. Tagging Amazon Web Services resources is useful for resource management, access
|
|
1867
1891
|
* management and cost allocation. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html"> Tagging Amazon Web Services Resources</a> in the
|
|
1868
1892
|
* <i>Amazon Web Services General Reference</i>. Once the resource is created, you can
|
|
1869
1893
|
* use <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_TagResource.html">TagResource</a>, <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_UntagResource.html">UntagResource</a>, and
|
|
@@ -1886,7 +1910,7 @@ export interface CreateBuildInput {
|
|
|
1886
1910
|
*/
|
|
1887
1911
|
export interface CreateBuildOutput {
|
|
1888
1912
|
/**
|
|
1889
|
-
* <p>The newly created build resource, including a unique build
|
|
1913
|
+
* <p>The newly created build resource, including a unique build ID and status. </p>
|
|
1890
1914
|
* @public
|
|
1891
1915
|
*/
|
|
1892
1916
|
Build?: Build | undefined;
|
|
@@ -1951,7 +1975,7 @@ export interface CreateContainerFleetInput {
|
|
|
1951
1975
|
*/
|
|
1952
1976
|
GameServerContainerGroupDefinitionName?: string | undefined;
|
|
1953
1977
|
/**
|
|
1954
|
-
* <p>The name of a container group definition resource that describes a set of
|
|
1978
|
+
* <p>The name of a container group definition resource that describes a set of auxiliary
|
|
1955
1979
|
* software. A fleet instance has one process for executables in this container group. A
|
|
1956
1980
|
* per-instance container group is optional. You can update the fleet to add or remove a
|
|
1957
1981
|
* per-instance container group at any time. You can specify the container group
|
|
@@ -2032,7 +2056,7 @@ export interface CreateContainerFleetInput {
|
|
|
2032
2056
|
* instance. </p>
|
|
2033
2057
|
* <p>By default, Amazon GameLift Servers calculates the maximum number of game server container groups that
|
|
2034
2058
|
* can fit on each instance. This calculation is based on the CPU and memory resources of
|
|
2035
|
-
* the fleet's instance type
|
|
2059
|
+
* the fleet's instance type. To use the calculated maximum, don't set this parameter. If
|
|
2036
2060
|
* you set this number manually, Amazon GameLift Servers uses your value as long as it's less than the
|
|
2037
2061
|
* calculated maximum.</p>
|
|
2038
2062
|
* @public
|
|
@@ -2042,7 +2066,7 @@ export interface CreateContainerFleetInput {
|
|
|
2042
2066
|
* <p>The Amazon EC2 instance type to use for all instances in the fleet. For multi-location
|
|
2043
2067
|
* fleets, the instance type must be available in the home region and all remote locations.
|
|
2044
2068
|
* Instance type determines the computing resources and processing power that's available
|
|
2045
|
-
* to host your game servers. This includes
|
|
2069
|
+
* to host your game servers. This includes CPU, memory, storage, and networking
|
|
2046
2070
|
* capacity. </p>
|
|
2047
2071
|
* <p>By default, Amazon GameLift Servers uses the <code>c5.large</code> instance type. If this instance
|
|
2048
2072
|
* type does not have sufficient resources for your container groups, you can choose a
|
|
@@ -2125,20 +2149,20 @@ export interface CreateContainerFleetInput {
|
|
|
2125
2149
|
* </li>
|
|
2126
2150
|
* </ul>
|
|
2127
2151
|
* <p>By default, this property is set to <code>CLOUDWATCH</code>. </p>
|
|
2128
|
-
* <p>Amazon GameLift Servers requires permissions to send logs other Amazon Web Services services in your account. These permissions are included in the IAM fleet role for this container fleet (see <code>FleetRoleArn
|
|
2152
|
+
* <p>Amazon GameLift Servers requires permissions to send logs to other Amazon Web Services services in your account. These permissions are included in the IAM fleet role for this container fleet (see <code>FleetRoleArn</code>).</p>
|
|
2129
2153
|
* @public
|
|
2130
2154
|
*/
|
|
2131
2155
|
LogConfiguration?: LogConfiguration | undefined;
|
|
2132
2156
|
/**
|
|
2133
2157
|
* <p>A list of labels to assign to the new fleet resource. Tags are developer-defined
|
|
2134
|
-
* key-value pairs. Tagging Amazon Web Services resources
|
|
2158
|
+
* key-value pairs. Tagging Amazon Web Services resources is useful for resource management, access
|
|
2135
2159
|
* management and cost allocation. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html"> Tagging Amazon Web Services Resources</a> in the
|
|
2136
2160
|
* <i>Amazon Web Services General Reference</i>.</p>
|
|
2137
2161
|
* @public
|
|
2138
2162
|
*/
|
|
2139
2163
|
Tags?: Tag[] | undefined;
|
|
2140
2164
|
/**
|
|
2141
|
-
* <p>Configures player gateway for your fleet. Player gateway provides benefits such as DDoS protection by rate limiting and validating
|
|
2165
|
+
* <p>Configures player gateway for your fleet. Player gateway provides benefits such as DDoS protection by rate limiting and validating traffic before it reaches game servers, hiding game server IP addresses from players, and providing updated endpoints when relay endpoints become unhealthy.</p>
|
|
2142
2166
|
* <p>
|
|
2143
2167
|
* <b>How it works:</b> When enabled, game clients connect to relay endpoints instead of to your game servers. Player gateway validates player gateway tokens and routes traffic to the appropriate game server. Your game backend calls <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_GetPlayerConnectionDetails.html">GetPlayerConnectionDetails</a> to retrieve relay endpoints and player gateway tokens for your game clients. To learn more about this topic, see <a href="https://docs.aws.amazon.com/gameliftservers/latest/developerguide/ddos-protection-intro.html">DDoS protection with Amazon GameLift Servers player gateway</a>.</p>
|
|
2144
2168
|
* <p>Possible values include:</p>
|
|
@@ -2247,7 +2271,7 @@ export interface GameServerContainerDefinitionInput {
|
|
|
2247
2271
|
* <p>A set of ports that Amazon GameLift Servers can assign to processes in a container. The container port
|
|
2248
2272
|
* configuration must have enough ports for each container process that accepts inbound traffic
|
|
2249
2273
|
* connections. For example, a game server process requires a container port to allow game
|
|
2250
|
-
* clients to connect to it. A container port configuration can have
|
|
2274
|
+
* clients to connect to it. A container port configuration can have one or more
|
|
2251
2275
|
* container port ranges. Each range specifies starting and ending values as well as the
|
|
2252
2276
|
* supported network protocol.</p>
|
|
2253
2277
|
* <p>Container ports aren't directly accessed by inbound traffic. Amazon GameLift Servers maps each container
|
|
@@ -2267,6 +2291,25 @@ export interface GameServerContainerDefinitionInput {
|
|
|
2267
2291
|
* @public
|
|
2268
2292
|
*/
|
|
2269
2293
|
LinuxCapabilities?: LinuxCapabilities | undefined;
|
|
2294
|
+
/**
|
|
2295
|
+
* <p>The number of vCPU units reserved for the game server container. The container can use
|
|
2296
|
+
* more vCPU when it's available, up to the container group's total vCPU limit if one is set. If
|
|
2297
|
+
* the container group has a total vCPU limit and the request doesn't set this value, Amazon GameLift Servers
|
|
2298
|
+
* calculates the game server container's vCPU as the total vCPU limit minus the sum of the vCPU
|
|
2299
|
+
* units reserved for the group's support containers.</p>
|
|
2300
|
+
* <p>A game server container group needs either a total vCPU limit or this value. If the
|
|
2301
|
+
* container group doesn't have a total vCPU limit, the group's containers can use up to the
|
|
2302
|
+
* instance's available vCPU, and Amazon GameLift Servers uses the sum of the group's container
|
|
2303
|
+
* <code>Vcpu</code> values to calculate how many game server container groups fit on an
|
|
2304
|
+
* instance.</p>
|
|
2305
|
+
* <p>
|
|
2306
|
+
* <b>Related data type: </b>
|
|
2307
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_ContainerGroupDefinition.html">ContainerGroupDefinition</a>
|
|
2308
|
+
* <code>TotalVcpuLimit</code>
|
|
2309
|
+
* </p>
|
|
2310
|
+
* @public
|
|
2311
|
+
*/
|
|
2312
|
+
Vcpu?: number | undefined;
|
|
2270
2313
|
}
|
|
2271
2314
|
/**
|
|
2272
2315
|
* <p>Describes a support container in a container group. You can define a support container in
|
|
@@ -2292,7 +2335,6 @@ export interface SupportContainerDefinitionInput {
|
|
|
2292
2335
|
/**
|
|
2293
2336
|
* <p>Establishes dependencies between this container and the status of other containers in the
|
|
2294
2337
|
* same container group. A container can have dependencies on multiple different containers. </p>
|
|
2295
|
-
* <p>.</p>
|
|
2296
2338
|
* <p>You can use dependencies to establish a startup/shutdown sequence across the container
|
|
2297
2339
|
* group. For example, you might specify that <i>ContainerB</i> has a
|
|
2298
2340
|
* <code>START</code> dependency on <i>ContainerA</i>. This dependency means that
|
|
@@ -2363,7 +2405,8 @@ export interface SupportContainerDefinitionInput {
|
|
|
2363
2405
|
* allocation. </p>
|
|
2364
2406
|
* <p>
|
|
2365
2407
|
* <b>Related data type: </b>
|
|
2366
|
-
* <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_ContainerGroupDefinition.html">ContainerGroupDefinition</a>
|
|
2408
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_ContainerGroupDefinition.html">ContainerGroupDefinition</a>
|
|
2409
|
+
* <code>TotalMemoryLimitMebibytes</code>
|
|
2367
2410
|
* </p>
|
|
2368
2411
|
* @public
|
|
2369
2412
|
*/
|
|
@@ -2371,7 +2414,7 @@ export interface SupportContainerDefinitionInput {
|
|
|
2371
2414
|
/**
|
|
2372
2415
|
* <p>A set of ports that Amazon GameLift Servers can assign to processes in a container. The container port
|
|
2373
2416
|
* configuration must have enough ports for each container process that accepts inbound traffic
|
|
2374
|
-
* connections. A container port configuration can have
|
|
2417
|
+
* connections. A container port configuration can have one or more container port
|
|
2375
2418
|
* ranges. Each range specifies starting and ending values as well as the supported network
|
|
2376
2419
|
* protocol.</p>
|
|
2377
2420
|
* <p>Container ports aren't directly accessed by inbound traffic. Amazon GameLift Servers maps each container
|
|
@@ -2382,11 +2425,11 @@ export interface SupportContainerDefinitionInput {
|
|
|
2382
2425
|
PortConfiguration?: ContainerPortConfiguration | undefined;
|
|
2383
2426
|
/**
|
|
2384
2427
|
* <p>The number of vCPU units to reserve for this container. The container can use more
|
|
2385
|
-
* resources when needed, if available. If you don't reserve
|
|
2386
|
-
* shares the container group's total vCPU limit
|
|
2428
|
+
* resources when needed, if available. If you don't reserve vCPU units for this container, it
|
|
2429
|
+
* shares the container group's total vCPU limit.</p>
|
|
2387
2430
|
* <p>
|
|
2388
2431
|
* <b>Related data type: </b>
|
|
2389
|
-
* <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_ContainerGroupDefinition.html">ContainerGroupDefinition</a>
|
|
2432
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_ContainerGroupDefinition.html">ContainerGroupDefinition</a> TotalVcpuLimit
|
|
2390
2433
|
* </p>
|
|
2391
2434
|
* @public
|
|
2392
2435
|
*/
|
|
@@ -2424,13 +2467,20 @@ export interface CreateContainerGroupDefinitionInput {
|
|
|
2424
2467
|
TotalMemoryLimitMebibytes: number | undefined;
|
|
2425
2468
|
/**
|
|
2426
2469
|
* <p>The maximum amount of vCPU units to allocate to the container group (1 vCPU is equal to 1024
|
|
2427
|
-
* CPU units). All containers in the group share
|
|
2428
|
-
* individual containers, the total value must be equal to or greater than the sum of the
|
|
2429
|
-
*
|
|
2430
|
-
* <p>
|
|
2470
|
+
* CPU units). All containers in the group share these resources. If you set vCPU reservations for
|
|
2471
|
+
* individual containers, the total value must be equal to or greater than the sum of the
|
|
2472
|
+
* <code>Vcpu</code> values for all containers in the group.</p>
|
|
2473
|
+
* <p>This property is required for a per-instance container group.</p>
|
|
2474
|
+
* <p>For a game server container group, Amazon GameLift Servers requires either a total vCPU limit or a
|
|
2475
|
+
* <code>Vcpu</code> value for the game server container. If you set a total vCPU limit for a
|
|
2476
|
+
* game server container group, Amazon GameLift Servers uses this value to calculate how many game server
|
|
2477
|
+
* container groups fit on an instance. If you don't set a total vCPU limit, the group's
|
|
2478
|
+
* containers can use up to the instance's available vCPU, and Amazon GameLift Servers uses the sum of the
|
|
2479
|
+
* containers' <code>Vcpu</code> values to calculate how many game server container groups fit
|
|
2480
|
+
* on an instance.</p>
|
|
2431
2481
|
* @public
|
|
2432
2482
|
*/
|
|
2433
|
-
TotalVcpuLimit
|
|
2483
|
+
TotalVcpuLimit?: number | undefined;
|
|
2434
2484
|
/**
|
|
2435
2485
|
* <p>The definition for the game server container in this group. Define a game server container
|
|
2436
2486
|
* only when the container group type is <code>GAME_SERVER</code>. Game server containers specify
|
|
@@ -2468,7 +2518,7 @@ export interface CreateContainerGroupDefinitionInput {
|
|
|
2468
2518
|
VersionDescription?: string | undefined;
|
|
2469
2519
|
/**
|
|
2470
2520
|
* <p>A list of labels to assign to the container group definition resource. Tags are
|
|
2471
|
-
* developer-defined key-value pairs. Tagging Amazon Web Services resources
|
|
2521
|
+
* developer-defined key-value pairs. Tagging Amazon Web Services resources is useful for resource management,
|
|
2472
2522
|
* access management and cost allocation. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html"> Tagging Amazon Web Services Resources</a> in the
|
|
2473
2523
|
* <i>Amazon Web Services General Reference</i>. </p>
|
|
2474
2524
|
* @public
|
|
@@ -2503,7 +2553,7 @@ export interface PlayerGatewayConfiguration {
|
|
|
2503
2553
|
* consume available resources.</p>
|
|
2504
2554
|
* <p>The policy is evaluated when a player tries to create a new game session. On receiving
|
|
2505
2555
|
* a <code>CreateGameSession</code> request, Amazon GameLift Servers checks that the player (identified by
|
|
2506
|
-
* <code>CreatorId</code>) has created fewer than game session limit in the specified
|
|
2556
|
+
* <code>CreatorId</code>) has created fewer than the game session limit in the specified
|
|
2507
2557
|
* time period.</p>
|
|
2508
2558
|
* <p>The purpose of this policy is to prevent a single player from consuming a large share of
|
|
2509
2559
|
* available hosting resources. For example, setting <code>NewGameSessionsPerCreator</code> to
|
|
@@ -2520,7 +2570,7 @@ export interface ResourceCreationLimitPolicy {
|
|
|
2520
2570
|
* consume available resources.</p>
|
|
2521
2571
|
* <p>The policy is evaluated when a player tries to create a new game session. On receiving
|
|
2522
2572
|
* a <code>CreateGameSession</code> request, Amazon GameLift Servers checks that the player (identified by
|
|
2523
|
-
* <code>CreatorId</code>) has created fewer than game session limit in the specified
|
|
2573
|
+
* <code>CreatorId</code>) has created fewer than the game session limit in the specified
|
|
2524
2574
|
* time period.</p>
|
|
2525
2575
|
* @public
|
|
2526
2576
|
*/
|
|
@@ -2704,7 +2754,7 @@ export interface CreateFleetInput {
|
|
|
2704
2754
|
NewGameSessionProtectionPolicy?: ProtectionPolicy | undefined;
|
|
2705
2755
|
/**
|
|
2706
2756
|
* <p>Instructions for how to launch and run server processes on the fleet. Set runtime
|
|
2707
|
-
* configuration for managed EC2 fleets. For an Anywhere
|
|
2757
|
+
* configuration for managed EC2 fleets. For an Anywhere fleet, set this
|
|
2708
2758
|
* parameter only if the fleet is running the Amazon GameLift Servers Agent. The runtime configuration
|
|
2709
2759
|
* defines one or more server process configurations. Each server process identifies a game
|
|
2710
2760
|
* executable or Realtime script file and the number of processes to run concurrently. </p>
|
|
@@ -2796,7 +2846,7 @@ export interface CreateFleetInput {
|
|
|
2796
2846
|
Locations?: LocationConfiguration[] | undefined;
|
|
2797
2847
|
/**
|
|
2798
2848
|
* <p>A list of labels to assign to the new fleet resource. Tags are developer-defined
|
|
2799
|
-
* key-value pairs. Tagging Amazon Web Services resources
|
|
2849
|
+
* key-value pairs. Tagging Amazon Web Services resources is useful for resource management, access
|
|
2800
2850
|
* management and cost allocation. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html"> Tagging Amazon Web Services Resources</a> in the
|
|
2801
2851
|
* <i>Amazon Web Services General Reference</i>.</p>
|
|
2802
2852
|
* @public
|
|
@@ -2838,7 +2888,7 @@ export interface CreateFleetInput {
|
|
|
2838
2888
|
*/
|
|
2839
2889
|
InstanceRoleCredentialsProvider?: InstanceRoleCredentialsProvider | undefined;
|
|
2840
2890
|
/**
|
|
2841
|
-
* <p>Configures player gateway for your fleet. Player gateway provides benefits such as DDoS protection by rate limiting and validating
|
|
2891
|
+
* <p>Configures player gateway for your fleet. Player gateway provides benefits such as DDoS protection by rate limiting and validating traffic before it reaches game servers, hiding game server IP addresses from players, and providing updated endpoints when relay endpoints become unhealthy. Note, player gateway is only available for fleets using server SDK 5.x or later game server builds.</p>
|
|
2842
2892
|
* <p>
|
|
2843
2893
|
* <b>How it works:</b> When enabled, game clients connect to relay endpoints instead of to your game servers. Player gateway validates player gateway tokens and routes traffic to the appropriate game server. Your game backend calls <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_GetPlayerConnectionDetails.html">GetPlayerConnectionDetails</a> to retrieve relay endpoints and player gateway tokens for your game clients. To learn more about this topic, see <a href="https://docs.aws.amazon.com/gameliftservers/latest/developerguide/ddos-protection-intro.html">DDoS protection with Amazon GameLift Servers player gateway</a>.</p>
|
|
2844
2894
|
* <p>Possible values include:</p>
|
|
@@ -2940,7 +2990,7 @@ export interface FleetAttributes {
|
|
|
2940
2990
|
* Desired instances is set to 1. </p>
|
|
2941
2991
|
* </li>
|
|
2942
2992
|
* <li>
|
|
2943
|
-
* <p>DOWNLOADING/VALIDATING/BUILDING -- Amazon GameLift Servers is
|
|
2993
|
+
* <p>DOWNLOADING/VALIDATING/BUILDING -- Amazon GameLift Servers is downloading the game server build,
|
|
2944
2994
|
* running install scripts, and then validating the build files. When complete,
|
|
2945
2995
|
* Amazon GameLift Servers launches a fleet instance. </p>
|
|
2946
2996
|
* </li>
|
|
@@ -3063,7 +3113,7 @@ export interface FleetAttributes {
|
|
|
3063
3113
|
* consume available resources.</p>
|
|
3064
3114
|
* <p>The policy is evaluated when a player tries to create a new game session. On receiving
|
|
3065
3115
|
* a <code>CreateGameSession</code> request, Amazon GameLift Servers checks that the player (identified by
|
|
3066
|
-
* <code>CreatorId</code>) has created fewer than game session limit in the specified
|
|
3116
|
+
* <code>CreatorId</code>) has created fewer than the game session limit in the specified
|
|
3067
3117
|
* time period.</p>
|
|
3068
3118
|
* <p>The purpose of this policy is to prevent a single player from consuming a large share of
|
|
3069
3119
|
* available hosting resources. For example, setting <code>NewGameSessionsPerCreator</code> to
|
|
@@ -3477,7 +3527,7 @@ export interface CreateGameServerGroupInput {
|
|
|
3477
3527
|
* from early termination. Unprotected instances that have active game servers running might
|
|
3478
3528
|
* be terminated during a scale-down event, causing players to be dropped from the game.
|
|
3479
3529
|
* Protected instances cannot be terminated while there are active game servers running except
|
|
3480
|
-
* in the event of a forced game server group deletion
|
|
3530
|
+
* in the event of a forced game server group deletion. An exception to this is with Spot
|
|
3481
3531
|
* Instances, which can be terminated by Amazon Web Services regardless of protection status. This property is set to <code>NO_PROTECTION</code> by default.</p>
|
|
3482
3532
|
* @public
|
|
3483
3533
|
*/
|
|
@@ -3571,7 +3621,7 @@ export interface GameServerGroup {
|
|
|
3571
3621
|
* from early termination. Unprotected instances that have active game servers running might
|
|
3572
3622
|
* be terminated during a scale-down event, causing players to be dropped from the game.
|
|
3573
3623
|
* Protected instances cannot be terminated while there are active game servers running except
|
|
3574
|
-
* in the event of a forced game server group deletion
|
|
3624
|
+
* in the event of a forced game server group deletion. An exception to this is with Spot
|
|
3575
3625
|
* Instances, which can be terminated by Amazon Web Services regardless of protection status. </p>
|
|
3576
3626
|
* @public
|
|
3577
3627
|
*/
|
|
@@ -3746,7 +3796,7 @@ export interface CreateGameSessionInput {
|
|
|
3746
3796
|
* <code>CreateGameSession</code> operation requires a <code>CreatorId</code>. Amazon GameLift Servers
|
|
3747
3797
|
* limits the number of game session creation requests with the same <code>CreatorId</code>
|
|
3748
3798
|
* in a specified time period.</p>
|
|
3749
|
-
* <p>If
|
|
3799
|
+
* <p>If your fleet doesn't have a resource creation limit policy and you provide a
|
|
3750
3800
|
* <code>CreatorId</code> in your <code>CreateGameSession</code> requests, Amazon GameLift Servers
|
|
3751
3801
|
* limits requests to one request per <code>CreatorId</code> per second.</p>
|
|
3752
3802
|
* <p>To not limit <code>CreateGameSession</code> requests with the same
|
|
@@ -3872,7 +3922,6 @@ export interface GameSession {
|
|
|
3872
3922
|
* <code>FORCE_TERMINATE</code>. </p>
|
|
3873
3923
|
* </li>
|
|
3874
3924
|
* </ul>
|
|
3875
|
-
* <p></p>
|
|
3876
3925
|
* @public
|
|
3877
3926
|
*/
|
|
3878
3927
|
StatusReason?: GameSessionStatusReason | undefined;
|
|
@@ -4000,7 +4049,7 @@ export interface GameSessionQueueDestination {
|
|
|
4000
4049
|
/**
|
|
4001
4050
|
* <p>A list of fleet locations where a game session queue can place new game sessions. You
|
|
4002
4051
|
* can use a filter to temporarily exclude specific locations from receiving placements.
|
|
4003
|
-
* For queues that have multi-location fleets, you can use a filter configuration allow
|
|
4052
|
+
* For queues that have multi-location fleets, you can use a filter configuration to allow
|
|
4004
4053
|
* placement with some, but not all, of a fleet's locations.</p>
|
|
4005
4054
|
* @public
|
|
4006
4055
|
*/
|
|
@@ -4016,7 +4065,7 @@ export interface FilterConfiguration {
|
|
|
4016
4065
|
* <p>Sets a latency cap for individual players when placing a game session. With a latency
|
|
4017
4066
|
* policy in force, a game session cannot be placed in a fleet location where a player
|
|
4018
4067
|
* reports latency higher than the cap. Latency policies are used only with placement
|
|
4019
|
-
*
|
|
4068
|
+
* requests that provide player latency information. Player latency policies can be stacked
|
|
4020
4069
|
* to gradually relax latency requirements over time. </p>
|
|
4021
4070
|
* @public
|
|
4022
4071
|
*/
|
|
@@ -4052,7 +4101,7 @@ export interface PlayerLatencyPolicy {
|
|
|
4052
4101
|
* <li>
|
|
4053
4102
|
* <p>When a game session request includes player latency data, Amazon GameLift Servers re-orders
|
|
4054
4103
|
* the queue's destinations to make placements where the average player latency is
|
|
4055
|
-
* lowest. It reorders based the following priorities: (1) the lowest average
|
|
4104
|
+
* lowest. It reorders based on the following priorities: (1) the lowest average
|
|
4056
4105
|
* latency across all players, (2) the lowest hosting cost, (3) the queue's default
|
|
4057
4106
|
* destination order, and (4) for multi-location fleets, an alphabetic list of
|
|
4058
4107
|
* locations.</p>
|
|
@@ -4161,7 +4210,7 @@ export interface CreateGameSessionQueueInput {
|
|
|
4161
4210
|
NotificationTarget?: string | undefined;
|
|
4162
4211
|
/**
|
|
4163
4212
|
* <p>A list of labels to assign to the new game session queue resource. Tags are
|
|
4164
|
-
* developer-defined key-value pairs. Tagging Amazon Web Services resources
|
|
4213
|
+
* developer-defined key-value pairs. Tagging Amazon Web Services resources is useful for resource
|
|
4165
4214
|
* management, access management and cost allocation. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html"> Tagging Amazon Web Services
|
|
4166
4215
|
* Resources</a> in the <i>Amazon Web Services General Reference</i>.</p>
|
|
4167
4216
|
* @public
|
|
@@ -4256,9 +4305,9 @@ export interface CreateLocationInput {
|
|
|
4256
4305
|
LocationName: string | undefined;
|
|
4257
4306
|
/**
|
|
4258
4307
|
* <p>A list of labels to assign to the new resource. Tags are developer-defined key-value
|
|
4259
|
-
* pairs. Tagging Amazon Web Services resources
|
|
4308
|
+
* pairs. Tagging Amazon Web Services resources is useful for resource management, access management,
|
|
4260
4309
|
* and cost allocation. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html"> Tagging Amazon Web Services Resources</a> in the
|
|
4261
|
-
* <i>Amazon Web Services General
|
|
4310
|
+
* <i>Amazon Web Services General Reference</i>.</p>
|
|
4262
4311
|
* @public
|
|
4263
4312
|
*/
|
|
4264
4313
|
Tags?: Tag[] | undefined;
|
|
@@ -4347,8 +4396,10 @@ export interface CreateMatchmakingConfigurationInput {
|
|
|
4347
4396
|
/**
|
|
4348
4397
|
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a Amazon GameLift Servers game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>::gamesessionqueue/<queue name></code>. Queues can be located in any Region. Queues are used to start new
|
|
4349
4398
|
* Amazon GameLift Servers-hosted game sessions for matches that are created with this matchmaking
|
|
4350
|
-
* configuration.
|
|
4351
|
-
*
|
|
4399
|
+
* configuration. A matchmaking configuration supports only one queue; if you specify
|
|
4400
|
+
* more than one ARN, the request fails with an <code>InvalidRequestException</code>.
|
|
4401
|
+
* If <code>FlexMatchMode</code> is set to <code>STANDALONE</code>, do not set this
|
|
4402
|
+
* parameter. </p>
|
|
4352
4403
|
* @public
|
|
4353
4404
|
*/
|
|
4354
4405
|
GameSessionQueueArns?: string[] | undefined;
|
|
@@ -4456,7 +4507,7 @@ export interface CreateMatchmakingConfigurationInput {
|
|
|
4456
4507
|
FlexMatchMode?: FlexMatchMode | undefined;
|
|
4457
4508
|
/**
|
|
4458
4509
|
* <p>A list of labels to assign to the new matchmaking configuration resource. Tags are
|
|
4459
|
-
* developer-defined key-value pairs. Tagging Amazon Web Services resources
|
|
4510
|
+
* developer-defined key-value pairs. Tagging Amazon Web Services resources is useful for resource
|
|
4460
4511
|
* management, access management and cost allocation. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html"> Tagging Amazon Web Services
|
|
4461
4512
|
* Resources</a> in the <i>Amazon Web Services General Reference</i>.</p>
|
|
4462
4513
|
* @public
|
|
@@ -4633,7 +4684,7 @@ export interface CreateMatchmakingRuleSetInput {
|
|
|
4633
4684
|
RuleSetBody: string | undefined;
|
|
4634
4685
|
/**
|
|
4635
4686
|
* <p>A list of labels to assign to the new matchmaking rule set resource. Tags are
|
|
4636
|
-
* developer-defined key-value pairs. Tagging Amazon Web Services resources
|
|
4687
|
+
* developer-defined key-value pairs. Tagging Amazon Web Services resources is useful for resource
|
|
4637
4688
|
* management, access management and cost allocation. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html"> Tagging Amazon Web Services
|
|
4638
4689
|
* Resources</a> in the <i>Amazon Web Services General Reference</i>.</p>
|
|
4639
4690
|
* @public
|
|
@@ -4665,7 +4716,7 @@ export interface CreateMatchmakingRuleSetInput {
|
|
|
4665
4716
|
* based on player attributes. A rule might specify minimum requirements for
|
|
4666
4717
|
* individual players, teams, or entire matches. For example, a rule might require
|
|
4667
4718
|
* each player to meet a certain skill level, each team to have at least one player
|
|
4668
|
-
* in a certain role, or the match to have a minimum average skill level
|
|
4719
|
+
* in a certain role, or the match to have a minimum average skill level, or may
|
|
4669
4720
|
* describe an entire group--such as all teams must be evenly matched or have at
|
|
4670
4721
|
* least one player in a certain role. </p>
|
|
4671
4722
|
* </li>
|
|
@@ -4737,11 +4788,11 @@ export interface CreatePlayerSessionInput {
|
|
|
4737
4788
|
/**
|
|
4738
4789
|
* <p>Represents a player session. Player sessions are created either for a specific game
|
|
4739
4790
|
* session, or as part of a game session placement or matchmaking request. A player session
|
|
4740
|
-
* can
|
|
4791
|
+
* can represent a reserved player slot in a game session (when status is
|
|
4741
4792
|
* <code>RESERVED</code>) or actual player activity in a game session (when status is
|
|
4742
4793
|
* <code>ACTIVE</code>). A player session object, including player data, is
|
|
4743
4794
|
* automatically passed to a game session when the player connects to the game session and
|
|
4744
|
-
* is validated. After the game session ends, player
|
|
4795
|
+
* is validated. After the game session ends, player session information is retained for
|
|
4745
4796
|
* 30 days and then removed.</p>
|
|
4746
4797
|
* <p>
|
|
4747
4798
|
* <b>Related actions</b>
|
|
@@ -4933,7 +4984,7 @@ export interface CreateScriptInput {
|
|
|
4933
4984
|
ZipFile?: Uint8Array | undefined;
|
|
4934
4985
|
/**
|
|
4935
4986
|
* <p>A list of labels to assign to the new script resource. Tags are developer-defined
|
|
4936
|
-
* key-value pairs. Tagging Amazon Web Services resources
|
|
4987
|
+
* key-value pairs. Tagging Amazon Web Services resources is useful for resource management, access
|
|
4937
4988
|
* management and cost allocation. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html"> Tagging Amazon Web Services Resources</a> in the
|
|
4938
4989
|
* <i>Amazon Web Services General Reference</i>. Once the resource is created, you can
|
|
4939
4990
|
* use <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_TagResource.html">TagResource</a>, <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_UntagResource.html">UntagResource</a>, and
|
|
@@ -5036,7 +5087,7 @@ export interface CreateScriptOutput {
|
|
|
5036
5087
|
* storage location reflects an Amazon S3 location: (1) If the script was uploaded from an S3
|
|
5037
5088
|
* bucket under your account, the storage location reflects the information that was
|
|
5038
5089
|
* provided in the <i>CreateScript</i> request; (2) If the script file was
|
|
5039
|
-
* uploaded from a local zip file, the storage location reflects an S3 location
|
|
5090
|
+
* uploaded from a local zip file, the storage location reflects an S3 location controlled by
|
|
5040
5091
|
* the Amazon GameLift Servers service.</p>
|
|
5041
5092
|
* @public
|
|
5042
5093
|
*/
|
|
@@ -5750,7 +5801,7 @@ export interface DescribeEC2InstanceLimitsInput {
|
|
|
5750
5801
|
/**
|
|
5751
5802
|
* <p>The Amazon GameLift Servers service limits for an Amazon EC2 instance type and current utilization. Amazon GameLift Servers
|
|
5752
5803
|
* allows Amazon Web Services accounts a maximum number of instances, per instance type, per Amazon Web Services Region
|
|
5753
|
-
* or location, for use with Amazon GameLift Servers. You can request
|
|
5804
|
+
* or location, for use with Amazon GameLift Servers. You can request a limit increase for your account by
|
|
5754
5805
|
* using the <b>Service limits</b> page in the Amazon GameLift Servers
|
|
5755
5806
|
* console.</p>
|
|
5756
5807
|
* @public
|
|
@@ -5859,7 +5910,7 @@ export interface DescribeFleetCapacityInput {
|
|
|
5859
5910
|
* Combine this count with the number of server processes that each game server container group runs
|
|
5860
5911
|
* to learn how many game sessions the fleet is capable of hosting concurrently. For example, if a
|
|
5861
5912
|
* fleet has 50 game server container groups, and the game server container in each group runs 1 game server
|
|
5862
|
-
* process, then the fleet has the capacity to
|
|
5913
|
+
* process, then the fleet has the capacity to host 50 game sessions at a time. </p>
|
|
5863
5914
|
* <p>
|
|
5864
5915
|
* <b>Returned by:</b>
|
|
5865
5916
|
* <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetCapacity.html">https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetCapacity.html</a>, <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetLocationCapacity.html">https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetLocationCapacity.html</a>
|
|
@@ -6315,7 +6366,7 @@ export interface Event {
|
|
|
6315
6366
|
* </li>
|
|
6316
6367
|
* <li>
|
|
6317
6368
|
* <p>FLEET_CREATION_EXTRACTING_BUILD -- The game server build was successfully
|
|
6318
|
-
* downloaded to an instance, and Amazon GameLift
|
|
6369
|
+
* downloaded to an instance, and Amazon GameLift Servers is now extracting the build files from the
|
|
6319
6370
|
* uploaded build. Failure at this stage prevents a fleet from moving to ACTIVE
|
|
6320
6371
|
* status. Logs for this stage display a list of the files that are extracted and
|
|
6321
6372
|
* saved on the instance. Access the logs by using the URL in
|
|
@@ -6335,13 +6386,13 @@ export interface Event {
|
|
|
6335
6386
|
* soon.</p>
|
|
6336
6387
|
* </li>
|
|
6337
6388
|
* <li>
|
|
6338
|
-
* <p>FLEET_CREATION_FAILED_INSTALLER -- The
|
|
6389
|
+
* <p>FLEET_CREATION_FAILED_INSTALLER -- The installer failed while attempting to
|
|
6339
6390
|
* install the build files. This event indicates that the failure occurred before
|
|
6340
6391
|
* Amazon GameLift Servers could start validation. </p>
|
|
6341
6392
|
* </li>
|
|
6342
6393
|
* <li>
|
|
6343
6394
|
* <p>FLEET_CREATION_VALIDATING_RUNTIME_CONFIG -- The build process was successful,
|
|
6344
|
-
* and
|
|
6395
|
+
* and GameLift is now verifying that the game server launch paths, which are
|
|
6345
6396
|
* specified in the fleet's runtime configuration, exist. If any listed launch path
|
|
6346
6397
|
* exists, Amazon GameLift Servers tries to launch a game server process and waits for the process
|
|
6347
6398
|
* to report ready. Failures in this stage prevent a fleet from moving to
|
|
@@ -6884,7 +6935,7 @@ export interface DescribeGameServerInstancesInput {
|
|
|
6884
6935
|
* <p> Additional properties,
|
|
6885
6936
|
* including status, that describe an EC2 instance in a game server group. Instance
|
|
6886
6937
|
* configurations are set with game server group properties (see
|
|
6887
|
-
* <code>DescribeGameServerGroup</code> and with the EC2 launch template that was used
|
|
6938
|
+
* <code>DescribeGameServerGroup</code>) and with the EC2 launch template that was used
|
|
6888
6939
|
* when creating the game server group. </p>
|
|
6889
6940
|
* <p>Retrieve game server instances for a game server group by calling
|
|
6890
6941
|
* <code>DescribeGameServerInstances</code>. </p>
|
|
@@ -7086,7 +7137,7 @@ export interface PlayerLatency {
|
|
|
7086
7137
|
* <p>A priority configuration override list does not override a queue's
|
|
7087
7138
|
* FilterConfiguration setting, if the queue has one. Filter configurations are used to
|
|
7088
7139
|
* limit placements to a subset of the locations in a queue's destinations. If the
|
|
7089
|
-
* override list includes a location that's not
|
|
7140
|
+
* override list includes a location that's not in the
|
|
7090
7141
|
* <code>FilterConfiguration</code> allowed list, Amazon GameLift Servers won't attempt to place a
|
|
7091
7142
|
* game session there.</p>
|
|
7092
7143
|
* </note>
|
|
@@ -7819,7 +7870,7 @@ export interface MatchmakingTicket {
|
|
|
7819
7870
|
/**
|
|
7820
7871
|
* <p>Connection information for a new game session. Once a match is made, the FlexMatch
|
|
7821
7872
|
* engine creates a new game session for it. This information is added to the matchmaking
|
|
7822
|
-
* ticket, which you can
|
|
7873
|
+
* ticket, which you can retrieve by calling <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeMatchmaking.html">DescribeMatchmaking</a> .</p>
|
|
7823
7874
|
* @public
|
|
7824
7875
|
*/
|
|
7825
7876
|
GameSessionConnectionInfo?: GameSessionConnectionInfo | undefined;
|
|
@@ -8091,7 +8142,7 @@ export interface DescribeScalingPoliciesInput {
|
|
|
8091
8142
|
}
|
|
8092
8143
|
/**
|
|
8093
8144
|
* <p>Settings for a target-based scaling policy. A target-based policy tracks a particular
|
|
8094
|
-
* fleet metric specifies a target value for the metric. As player usage changes, the
|
|
8145
|
+
* fleet metric and specifies a target value for the metric. As player usage changes, the
|
|
8095
8146
|
* policy triggers Amazon GameLift Servers to adjust capacity so that the metric returns to the target
|
|
8096
8147
|
* value. The target configuration specifies settings as needed for the target based
|
|
8097
8148
|
* policy, including the target value. </p>
|
|
@@ -8241,7 +8292,7 @@ export interface ScalingPolicy {
|
|
|
8241
8292
|
* <li>
|
|
8242
8293
|
* <p>
|
|
8243
8294
|
* <b>AvailableGameSessions</b> -- Additional game
|
|
8244
|
-
* sessions that fleet could host simultaneously, given current capacity.</p>
|
|
8295
|
+
* sessions that a fleet could host simultaneously, given current capacity.</p>
|
|
8245
8296
|
* </li>
|
|
8246
8297
|
* <li>
|
|
8247
8298
|
* <p>
|
|
@@ -9405,7 +9456,7 @@ export interface PutScalingPolicyInput {
|
|
|
9405
9456
|
* <li>
|
|
9406
9457
|
* <p>
|
|
9407
9458
|
* <b>AvailableGameSessions</b> -- Additional game
|
|
9408
|
-
* sessions that fleet could host simultaneously, given current capacity.</p>
|
|
9459
|
+
* sessions that a fleet could host simultaneously, given current capacity.</p>
|
|
9409
9460
|
* </li>
|
|
9410
9461
|
* <li>
|
|
9411
9462
|
* <p>
|
|
@@ -10015,7 +10066,7 @@ export interface StartMatchmakingInput {
|
|
|
10015
10066
|
*/
|
|
10016
10067
|
export interface StartMatchmakingOutput {
|
|
10017
10068
|
/**
|
|
10018
|
-
* <p>Ticket representing the matchmaking request. This object
|
|
10069
|
+
* <p>Ticket representing the matchmaking request. This object includes the information
|
|
10019
10070
|
* included in the request, ticket status, and match results as generated during the
|
|
10020
10071
|
* matchmaking process.</p>
|
|
10021
10072
|
* @public
|