@aws-sdk/client-gamelift 3.1038.0 → 3.1039.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/README.md +7 -0
- package/dist-cjs/index.js +14 -0
- package/dist-cjs/schemas/schemas_0.js +52 -10
- package/dist-es/GameLift.js +2 -0
- package/dist-es/commands/DescribeContainerGroupPortMappingsCommand.js +16 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/schemas/schemas_0.js +42 -0
- package/dist-types/GameLift.d.ts +7 -0
- package/dist-types/GameLiftClient.d.ts +3 -2
- package/dist-types/commands/DescribeContainerGroupPortMappingsCommand.d.ts +160 -0
- package/dist-types/commands/DescribeEC2InstanceLimitsCommand.d.ts +15 -12
- package/dist-types/commands/SearchGameSessionsCommand.d.ts +2 -2
- package/dist-types/commands/UpdateContainerFleetCommand.d.ts +1 -1
- package/dist-types/commands/UpdateContainerGroupDefinitionCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +212 -213
- package/dist-types/models/models_1.d.ts +202 -3
- package/dist-types/schemas/schemas_0.d.ts +5 -0
- package/dist-types/ts3.4/GameLift.d.ts +23 -0
- package/dist-types/ts3.4/GameLiftClient.d.ts +6 -0
- package/dist-types/ts3.4/commands/DescribeContainerGroupPortMappingsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateContainerFleetCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateContainerGroupDefinitionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +26 -35
- package/dist-types/ts3.4/models/models_1.d.ts +44 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +5 -0
- package/package.json +7 -7
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { AcceptanceType, BackfillMode, BalancingStrategy, BuildStatus, CertificateType, ComparisonOperatorType, ComputeStatus, ComputeType, ContainerDependencyCondition, ContainerFleetBillingType, ContainerFleetLocationStatus,
|
|
1
|
+
import type { AcceptanceType, BackfillMode, BalancingStrategy, BuildStatus, CertificateType, ComparisonOperatorType, ComputeStatus, ComputeType, ContainerDependencyCondition, ContainerFleetBillingType, ContainerFleetLocationStatus, ContainerFleetStatus, ContainerGroupDefinitionStatus, ContainerGroupType, ContainerMountPointAccessLevel, ContainerOperatingSystem, DeploymentImpairmentStrategy, DeploymentProtectionStrategy, DeploymentStatus, EC2InstanceType, EventCode, FilterInstanceStatus, FleetAction, FleetStatus, FleetType, FlexMatchMode, GameServerClaimStatus, GameServerGroupAction, GameServerGroupDeleteOption, GameServerGroupInstanceType, GameServerGroupStatus, GameServerInstanceStatus, GameServerIpProtocolSupported, GameServerProtectionPolicy, GameServerUtilizationStatus, GameSessionPlacementState, GameSessionStatus, GameSessionStatusReason, InstanceRoleCredentialsProvider, InstanceStatus, IpProtocol, ListComputeInputStatus, LocationFilter, LocationUpdateStatus, LogDestination, MatchmakingConfigurationStatus, MetricName, OperatingSystem, PlacementFallbackStrategy, PlayerGatewayMode, PlayerGatewayStatus, PlayerSessionCreationPolicy, PlayerSessionStatus, PolicyType, PriorityType, ProtectionPolicy, RoutingStrategyType, ScalingAdjustmentType, ScalingStatusType, SortOrder, TerminationMode, ZeroCapacityStrategy } from "./enums";
|
|
2
2
|
/**
|
|
3
3
|
* @public
|
|
4
4
|
*/
|
|
@@ -606,6 +606,9 @@ export interface Compute {
|
|
|
606
606
|
* <p>The set of port numbers to open on each instance in a container fleet. Connection
|
|
607
607
|
* ports are used by inbound traffic to connect with processes that are running in
|
|
608
608
|
* containers on the fleet.</p>
|
|
609
|
+
* <p>The port range must not overlap with the Amazon GameLift Servers reserved port range
|
|
610
|
+
* <code>4092-4191</code>. This range is reserved for internal Amazon GameLift Servers
|
|
611
|
+
* services.</p>
|
|
609
612
|
* @public
|
|
610
613
|
*/
|
|
611
614
|
export interface ConnectionPortRange {
|
|
@@ -923,6 +926,9 @@ export interface ContainerFleet {
|
|
|
923
926
|
* <p>The set of port numbers to open on each instance in a container fleet. Connection
|
|
924
927
|
* ports are used by inbound traffic to connect with processes that are running in
|
|
925
928
|
* containers on the fleet.</p>
|
|
929
|
+
* <p>The port range must not overlap with the Amazon GameLift Servers reserved port range
|
|
930
|
+
* <code>4092-4191</code>. This range is reserved for internal Amazon GameLift Servers
|
|
931
|
+
* services.</p>
|
|
926
932
|
* @public
|
|
927
933
|
*/
|
|
928
934
|
InstanceConnectionPortRange?: ConnectionPortRange | undefined;
|
|
@@ -1548,6 +1554,66 @@ export interface ContainerGroupDefinition {
|
|
|
1548
1554
|
*/
|
|
1549
1555
|
StatusReason?: string | undefined;
|
|
1550
1556
|
}
|
|
1557
|
+
/**
|
|
1558
|
+
* <p>Describes a mapping between a container port and a connection port on a fleet
|
|
1559
|
+
* instance. You define container ports in a container group definition. Amazon GameLift Servers assigns
|
|
1560
|
+
* connection ports when it deploys the container group to an instance.</p>
|
|
1561
|
+
* <p>
|
|
1562
|
+
* <b>Part of:</b>
|
|
1563
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_ContainerGroupPortMapping.html">ContainerGroupPortMapping</a>
|
|
1564
|
+
* </p>
|
|
1565
|
+
* @public
|
|
1566
|
+
*/
|
|
1567
|
+
export interface ContainerPortMapping {
|
|
1568
|
+
/**
|
|
1569
|
+
* <p>The port number on the container. This port is defined in the container group
|
|
1570
|
+
* definition. Container port numbers must be unique within a container group
|
|
1571
|
+
* definition.</p>
|
|
1572
|
+
* @public
|
|
1573
|
+
*/
|
|
1574
|
+
ContainerPort?: number | undefined;
|
|
1575
|
+
/**
|
|
1576
|
+
* <p>The port number on the fleet instance that maps to the container port. Connection
|
|
1577
|
+
* ports are assigned by Amazon GameLift Servers when the container group is deployed to an
|
|
1578
|
+
* instance.</p>
|
|
1579
|
+
* @public
|
|
1580
|
+
*/
|
|
1581
|
+
ConnectionPort?: number | undefined;
|
|
1582
|
+
/**
|
|
1583
|
+
* <p>The network protocol for the port mapping. Valid values are <code>TCP</code> or
|
|
1584
|
+
* <code>UDP</code>.</p>
|
|
1585
|
+
* @public
|
|
1586
|
+
*/
|
|
1587
|
+
Protocol?: IpProtocol | undefined;
|
|
1588
|
+
}
|
|
1589
|
+
/**
|
|
1590
|
+
* <p>Describes the port mappings for a single container in a container group. Each mapping
|
|
1591
|
+
* shows how a container port maps to a connection port on the fleet instance.</p>
|
|
1592
|
+
* <p>
|
|
1593
|
+
* <b>Returned by:</b>
|
|
1594
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeContainerGroupPortMappings.html">DescribeContainerGroupPortMappings</a>
|
|
1595
|
+
* </p>
|
|
1596
|
+
* @public
|
|
1597
|
+
*/
|
|
1598
|
+
export interface ContainerGroupPortMapping {
|
|
1599
|
+
/**
|
|
1600
|
+
* <p>The name of the container, as defined in the container group definition.</p>
|
|
1601
|
+
* @public
|
|
1602
|
+
*/
|
|
1603
|
+
ContainerName?: string | undefined;
|
|
1604
|
+
/**
|
|
1605
|
+
* <p>The runtime ID for the container that's running in a compute. This value is unique
|
|
1606
|
+
* within the compute.</p>
|
|
1607
|
+
* @public
|
|
1608
|
+
*/
|
|
1609
|
+
ContainerRuntimeId?: string | undefined;
|
|
1610
|
+
/**
|
|
1611
|
+
* <p>A list of <code>ContainerPortMapping</code> objects that describe the port mappings
|
|
1612
|
+
* for this container.</p>
|
|
1613
|
+
* @public
|
|
1614
|
+
*/
|
|
1615
|
+
ContainerPortMappings?: ContainerPortMapping[] | undefined;
|
|
1616
|
+
}
|
|
1551
1617
|
/**
|
|
1552
1618
|
* <p>A unique identifier for a container in a compute on a managed container fleet instance.
|
|
1553
1619
|
* This information makes it possible to remotely connect to a specific container on a fleet
|
|
@@ -1862,6 +1928,9 @@ export interface CreateContainerFleetInput {
|
|
|
1862
1928
|
* <p>If you set values manually, Amazon GameLift Servers no longer calculates a port range for you,
|
|
1863
1929
|
* even if you later remove the manual settings. </p>
|
|
1864
1930
|
* </note>
|
|
1931
|
+
* <p>The port range must not overlap with the Amazon GameLift Servers reserved port range
|
|
1932
|
+
* <code>4092-4191</code>. This range is reserved for internal Amazon GameLift Servers
|
|
1933
|
+
* services.</p>
|
|
1865
1934
|
* @public
|
|
1866
1935
|
*/
|
|
1867
1936
|
InstanceConnectionPortRange?: ConnectionPortRange | undefined;
|
|
@@ -1893,6 +1962,9 @@ export interface CreateContainerFleetInput {
|
|
|
1893
1962
|
* <p>If you set values manually, Amazon GameLift Servers no longer calculates a port range for you,
|
|
1894
1963
|
* even if you later remove the manual settings. </p>
|
|
1895
1964
|
* </note>
|
|
1965
|
+
* <p>The port range must not overlap with the Amazon GameLift Servers reserved port range
|
|
1966
|
+
* <code>4092-4191</code>. This range is reserved for internal Amazon GameLift Servers
|
|
1967
|
+
* services.</p>
|
|
1896
1968
|
* @public
|
|
1897
1969
|
*/
|
|
1898
1970
|
InstanceInboundPermissions?: IpPermission[] | undefined;
|
|
@@ -3615,8 +3687,8 @@ export interface CreateGameSessionInput {
|
|
|
3615
3687
|
* only once. Subsequent requests with the same string return the original
|
|
3616
3688
|
* <code>GameSession</code> object, with an updated status. Maximum token length is 48
|
|
3617
3689
|
* characters. If provided, this string is included in the new game session's ID.
|
|
3618
|
-
*
|
|
3619
|
-
* <code>arn:aws:gamelift:<location>::gamesession/<fleet ID>/<
|
|
3690
|
+
* The value is always a full ARN in the following format:
|
|
3691
|
+
* <code>arn:aws:gamelift:<location>::gamesession/<fleet ID>/<ID string></code>. Idempotency tokens remain in use for 30 days after a game session has ended;
|
|
3620
3692
|
* game session objects are retained for this time period and then deleted.</p>
|
|
3621
3693
|
* @public
|
|
3622
3694
|
*/
|
|
@@ -3650,8 +3722,8 @@ export interface CreateGameSessionInput {
|
|
|
3650
3722
|
*/
|
|
3651
3723
|
export interface GameSession {
|
|
3652
3724
|
/**
|
|
3653
|
-
* <p>
|
|
3654
|
-
* <code>arn:aws:gamelift:<location>::gamesession/<fleet ID>/<
|
|
3725
|
+
* <p>An identifier for the game session that is unique across all regions. The value is always a full ARN in the following format:
|
|
3726
|
+
* <code>arn:aws:gamelift:<location>::gamesession/<fleet ID>/<ID string></code>.</p>
|
|
3655
3727
|
* @public
|
|
3656
3728
|
*/
|
|
3657
3729
|
GameSessionId?: string | undefined;
|
|
@@ -4564,7 +4636,8 @@ export interface CreateMatchmakingRuleSetOutput {
|
|
|
4564
4636
|
*/
|
|
4565
4637
|
export interface CreatePlayerSessionInput {
|
|
4566
4638
|
/**
|
|
4567
|
-
* <p>
|
|
4639
|
+
* <p>An identifier for the game session that is unique across all regions to add a player to. The value is always a full ARN in the following format:
|
|
4640
|
+
* <code>arn:aws:gamelift:<location>::gamesession/<fleet ID>/<ID string></code>.</p>
|
|
4568
4641
|
* @public
|
|
4569
4642
|
*/
|
|
4570
4643
|
GameSessionId: string | undefined;
|
|
@@ -4608,7 +4681,8 @@ export interface PlayerSession {
|
|
|
4608
4681
|
*/
|
|
4609
4682
|
PlayerId?: string | undefined;
|
|
4610
4683
|
/**
|
|
4611
|
-
* <p>
|
|
4684
|
+
* <p>An identifier for the game session that is unique across all regions that the player session is connected to. The value is always a full ARN in the following format:
|
|
4685
|
+
* <code>arn:aws:gamelift:<location>::gamesession/<fleet ID>/<ID string></code>.</p>
|
|
4612
4686
|
* @public
|
|
4613
4687
|
*/
|
|
4614
4688
|
GameSessionId?: string | undefined;
|
|
@@ -4711,7 +4785,8 @@ export interface CreatePlayerSessionOutput {
|
|
|
4711
4785
|
*/
|
|
4712
4786
|
export interface CreatePlayerSessionsInput {
|
|
4713
4787
|
/**
|
|
4714
|
-
* <p>
|
|
4788
|
+
* <p>An identifier for the game session that is unique across all regions to add players to. The value is always a full ARN in the following format:
|
|
4789
|
+
* <code>arn:aws:gamelift:<location>::gamesession/<fleet ID>/<ID string></code>.</p>
|
|
4715
4790
|
* @public
|
|
4716
4791
|
*/
|
|
4717
4792
|
GameSessionId: string | undefined;
|
|
@@ -5460,6 +5535,113 @@ export interface DescribeContainerGroupDefinitionOutput {
|
|
|
5460
5535
|
*/
|
|
5461
5536
|
ContainerGroupDefinition?: ContainerGroupDefinition | undefined;
|
|
5462
5537
|
}
|
|
5538
|
+
/**
|
|
5539
|
+
* @public
|
|
5540
|
+
*/
|
|
5541
|
+
export interface DescribeContainerGroupPortMappingsInput {
|
|
5542
|
+
/**
|
|
5543
|
+
* <p>A unique identifier for the container fleet. You can use either the fleet ID or ARN
|
|
5544
|
+
* value.</p>
|
|
5545
|
+
* @public
|
|
5546
|
+
*/
|
|
5547
|
+
FleetId: string | undefined;
|
|
5548
|
+
/**
|
|
5549
|
+
* <p>The type of container group to retrieve port mappings for.</p>
|
|
5550
|
+
* <ul>
|
|
5551
|
+
* <li>
|
|
5552
|
+
* <p>
|
|
5553
|
+
* <code>GAME_SERVER</code> -- Get port mappings for a game server
|
|
5554
|
+
* container group.</p>
|
|
5555
|
+
* </li>
|
|
5556
|
+
* <li>
|
|
5557
|
+
* <p>
|
|
5558
|
+
* <code>PER_INSTANCE</code> -- Get port mappings for a per-instance
|
|
5559
|
+
* container group.</p>
|
|
5560
|
+
* </li>
|
|
5561
|
+
* </ul>
|
|
5562
|
+
* @public
|
|
5563
|
+
*/
|
|
5564
|
+
ContainerGroupType: ContainerGroupType | undefined;
|
|
5565
|
+
/**
|
|
5566
|
+
* <p>A unique identifier for the compute resource for which to retrieve port mappings. For a
|
|
5567
|
+
* container fleet, a compute represents a game server container group running on a fleet
|
|
5568
|
+
* instance. You can use either the compute name or ARN value.</p>
|
|
5569
|
+
* <p>When <code>ContainerGroupType</code> is <code>GAME_SERVER</code>, this parameter is
|
|
5570
|
+
* required.</p>
|
|
5571
|
+
* <p>When <code>ContainerGroupType</code> is <code>PER_INSTANCE</code>, do not provide
|
|
5572
|
+
* this parameter. If you provide a compute name with <code>PER_INSTANCE</code>, the
|
|
5573
|
+
* request fails with an <code>InvalidRequestException</code>.</p>
|
|
5574
|
+
* @public
|
|
5575
|
+
*/
|
|
5576
|
+
ComputeName?: string | undefined;
|
|
5577
|
+
/**
|
|
5578
|
+
* <p>A unique identifier for the fleet instance to retrieve port mappings for.</p>
|
|
5579
|
+
* <p>When <code>ContainerGroupType</code> is <code>PER_INSTANCE</code>, this parameter is
|
|
5580
|
+
* required.</p>
|
|
5581
|
+
* <p>When <code>ContainerGroupType</code> is <code>GAME_SERVER</code>, this parameter is
|
|
5582
|
+
* optional. If you provide an instance ID, it must match the instance that's running the
|
|
5583
|
+
* specified compute. If the instance ID doesn't match, the request fails with an
|
|
5584
|
+
* <code>InvalidRequestException</code>.</p>
|
|
5585
|
+
* @public
|
|
5586
|
+
*/
|
|
5587
|
+
InstanceId?: string | undefined;
|
|
5588
|
+
/**
|
|
5589
|
+
* <p>A container name to filter the results. When provided, the operation returns port
|
|
5590
|
+
* mappings for the specified container only. If no container with the specified name
|
|
5591
|
+
* exists in the container group, the request fails with a
|
|
5592
|
+
* <code>NotFoundException</code>.</p>
|
|
5593
|
+
* <p>If not provided, the operation returns port mappings for all containers in the container
|
|
5594
|
+
* group.</p>
|
|
5595
|
+
* @public
|
|
5596
|
+
*/
|
|
5597
|
+
ContainerName?: string | undefined;
|
|
5598
|
+
}
|
|
5599
|
+
/**
|
|
5600
|
+
* @public
|
|
5601
|
+
*/
|
|
5602
|
+
export interface DescribeContainerGroupPortMappingsOutput {
|
|
5603
|
+
/**
|
|
5604
|
+
* <p>A unique identifier for the container fleet.</p>
|
|
5605
|
+
* @public
|
|
5606
|
+
*/
|
|
5607
|
+
FleetId?: string | undefined;
|
|
5608
|
+
/**
|
|
5609
|
+
* <p>The location of the fleet instance, expressed as an Amazon Web Services Region code, such as
|
|
5610
|
+
* <code>us-west-2</code>.</p>
|
|
5611
|
+
* @public
|
|
5612
|
+
*/
|
|
5613
|
+
Location?: string | undefined;
|
|
5614
|
+
/**
|
|
5615
|
+
* <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 the container group definition. The ARN value also
|
|
5616
|
+
* identifies the specific container group definition version in use.</p>
|
|
5617
|
+
* @public
|
|
5618
|
+
*/
|
|
5619
|
+
ContainerGroupDefinitionArn?: string | undefined;
|
|
5620
|
+
/**
|
|
5621
|
+
* <p>The type of container group that was specified in the request. Valid values are <code>GAME_SERVER</code> or <code>PER_INSTANCE</code>.</p>
|
|
5622
|
+
* @public
|
|
5623
|
+
*/
|
|
5624
|
+
ContainerGroupType?: ContainerGroupType | undefined;
|
|
5625
|
+
/**
|
|
5626
|
+
* <p>A unique identifier for the compute resource running the game server container group.
|
|
5627
|
+
* Returned when <code>ContainerGroupType</code> is <code>GAME_SERVER</code>.</p>
|
|
5628
|
+
* @public
|
|
5629
|
+
*/
|
|
5630
|
+
ComputeName?: string | undefined;
|
|
5631
|
+
/**
|
|
5632
|
+
* <p>A unique identifier for the fleet instance. For <code>GAME_SERVER</code> requests,
|
|
5633
|
+
* this is the instance running the specified compute. For <code>PER_INSTANCE</code>
|
|
5634
|
+
* requests, this is the instance specified in the request.</p>
|
|
5635
|
+
* @public
|
|
5636
|
+
*/
|
|
5637
|
+
InstanceId?: string | undefined;
|
|
5638
|
+
/**
|
|
5639
|
+
* <p>A list of <code>ContainerGroupPortMapping</code> objects that describe the port
|
|
5640
|
+
* mappings for each container in the container group.</p>
|
|
5641
|
+
* @public
|
|
5642
|
+
*/
|
|
5643
|
+
ContainerGroupPortMappings?: ContainerGroupPortMapping[] | undefined;
|
|
5644
|
+
}
|
|
5463
5645
|
/**
|
|
5464
5646
|
* @public
|
|
5465
5647
|
*/
|
|
@@ -6670,7 +6852,8 @@ export interface DescribeGameSessionDetailsInput {
|
|
|
6670
6852
|
*/
|
|
6671
6853
|
FleetId?: string | undefined;
|
|
6672
6854
|
/**
|
|
6673
|
-
* <p>
|
|
6855
|
+
* <p>An identifier for the game session that is unique across all regions to retrieve. The value is always a full ARN in the following format:
|
|
6856
|
+
* <code>arn:aws:gamelift:<location>::gamesession/<fleet ID>/<ID string></code>.</p>
|
|
6674
6857
|
* @public
|
|
6675
6858
|
*/
|
|
6676
6859
|
GameSessionId?: string | undefined;
|
|
@@ -6936,14 +7119,15 @@ export interface GameSessionPlacement {
|
|
|
6936
7119
|
*/
|
|
6937
7120
|
GameSessionName?: string | undefined;
|
|
6938
7121
|
/**
|
|
6939
|
-
* <p>
|
|
7122
|
+
* <p>An identifier for the game session that is unique across all regions. The value is always a full ARN in the following format:
|
|
7123
|
+
* <code>arn:aws:gamelift:<location>::gamesession/<fleet ID>/<ID string></code>. This value is the same as <code>GameSessionArn</code>. This value isn't final until placement status is
|
|
6940
7124
|
* <code>FULFILLED</code>.</p>
|
|
6941
7125
|
* @public
|
|
6942
7126
|
*/
|
|
6943
7127
|
GameSessionId?: string | undefined;
|
|
6944
7128
|
/**
|
|
6945
|
-
* <p>
|
|
6946
|
-
*
|
|
7129
|
+
* <p>An identifier for the game session that is unique across all regions. The value is always a full ARN in the following format:
|
|
7130
|
+
* <code>arn:aws:gamelift:<location>::gamesession/<fleet ID>/<ID string></code>. This value is the same as <code>GameSessionId</code>. This value isn't final until placement status is
|
|
6947
7131
|
* <code>FULFILLED</code>.</p>
|
|
6948
7132
|
* @public
|
|
6949
7133
|
*/
|
|
@@ -7102,7 +7286,8 @@ export interface DescribeGameSessionsInput {
|
|
|
7102
7286
|
*/
|
|
7103
7287
|
FleetId?: string | undefined;
|
|
7104
7288
|
/**
|
|
7105
|
-
* <p>
|
|
7289
|
+
* <p>An identifier for the game session that is unique across all regions to retrieve. The value is always a full ARN in the following format:
|
|
7290
|
+
* <code>arn:aws:gamelift:<location>::gamesession/<fleet ID>/<ID string></code>.</p>
|
|
7106
7291
|
* @public
|
|
7107
7292
|
*/
|
|
7108
7293
|
GameSessionId?: string | undefined;
|
|
@@ -7341,7 +7526,8 @@ export interface MatchedPlayerSession {
|
|
|
7341
7526
|
*/
|
|
7342
7527
|
export interface GameSessionConnectionInfo {
|
|
7343
7528
|
/**
|
|
7344
|
-
* <p>
|
|
7529
|
+
* <p>An identifier for the game session that is unique across all regions. The value is always a full ARN in the following format:
|
|
7530
|
+
* <code>arn:aws:gamelift:<location>::gamesession/<fleet ID>/<ID string></code>.</p>
|
|
7345
7531
|
* @public
|
|
7346
7532
|
*/
|
|
7347
7533
|
GameSessionArn?: string | undefined;
|
|
@@ -7652,7 +7838,8 @@ export interface DescribeMatchmakingRuleSetsOutput {
|
|
|
7652
7838
|
*/
|
|
7653
7839
|
export interface DescribePlayerSessionsInput {
|
|
7654
7840
|
/**
|
|
7655
|
-
* <p>
|
|
7841
|
+
* <p>An identifier for the game session that is unique across all regions to retrieve player sessions for. The value is always a full ARN in the following format:
|
|
7842
|
+
* <code>arn:aws:gamelift:<location>::gamesession/<fleet ID>/<ID string></code>.</p>
|
|
7656
7843
|
* @public
|
|
7657
7844
|
*/
|
|
7658
7845
|
GameSessionId?: string | undefined;
|
|
@@ -8333,7 +8520,8 @@ export interface GetComputeAuthTokenOutput {
|
|
|
8333
8520
|
*/
|
|
8334
8521
|
export interface GetGameSessionLogUrlInput {
|
|
8335
8522
|
/**
|
|
8336
|
-
* <p>
|
|
8523
|
+
* <p>An identifier for the game session that is unique across all regions to get logs for. The value is always a full ARN in the following format:
|
|
8524
|
+
* <code>arn:aws:gamelift:<location>::gamesession/<fleet ID>/<ID string></code>.</p>
|
|
8337
8525
|
* @public
|
|
8338
8526
|
*/
|
|
8339
8527
|
GameSessionId: string | undefined;
|
|
@@ -8439,7 +8627,8 @@ export interface GetInstanceAccessOutput {
|
|
|
8439
8627
|
*/
|
|
8440
8628
|
export interface GetPlayerConnectionDetailsInput {
|
|
8441
8629
|
/**
|
|
8442
|
-
* <p>
|
|
8630
|
+
* <p>An identifier for the game session that is unique across all regions for which to retrieve player connection details. The value is always a full ARN in the following format:
|
|
8631
|
+
* <code>arn:aws:gamelift:<location>::gamesession/<fleet ID>/<ID string></code>.</p>
|
|
8443
8632
|
* @public
|
|
8444
8633
|
*/
|
|
8445
8634
|
GameSessionId: string | undefined;
|
|
@@ -8503,7 +8692,8 @@ export interface PlayerConnectionDetail {
|
|
|
8503
8692
|
*/
|
|
8504
8693
|
export interface GetPlayerConnectionDetailsOutput {
|
|
8505
8694
|
/**
|
|
8506
|
-
* <p>
|
|
8695
|
+
* <p>An identifier for the game session that is unique across all regions for which the player connection details were retrieved. The value is always a full ARN in the following format:
|
|
8696
|
+
* <code>arn:aws:gamelift:<location>::gamesession/<fleet ID>/<ID string></code>.</p>
|
|
8507
8697
|
* @public
|
|
8508
8698
|
*/
|
|
8509
8699
|
GameSessionId?: string | undefined;
|
|
@@ -9666,7 +9856,8 @@ export interface StartMatchBackfillInput {
|
|
|
9666
9856
|
*/
|
|
9667
9857
|
ConfigurationName: string | undefined;
|
|
9668
9858
|
/**
|
|
9669
|
-
* <p>
|
|
9859
|
+
* <p>An identifier for the game session that is unique across all regions. The value is always a full ARN in the following format:
|
|
9860
|
+
* <code>arn:aws:gamelift:<location>::gamesession/<fleet ID>/<ID string></code>. When using FlexMatch as a standalone matchmaking
|
|
9670
9861
|
* solution, this parameter is not needed. </p>
|
|
9671
9862
|
* @public
|
|
9672
9863
|
*/
|
|
@@ -9880,8 +10071,8 @@ export interface TagResourceResponse {
|
|
|
9880
10071
|
*/
|
|
9881
10072
|
export interface TerminateGameSessionInput {
|
|
9882
10073
|
/**
|
|
9883
|
-
* <p>
|
|
9884
|
-
* <code>arn:aws:gamelift:<location>::gamesession/<fleet ID>/<
|
|
10074
|
+
* <p>An identifier for the game session that is unique across all regions to be terminated. The value is always a full ARN in the following format:
|
|
10075
|
+
* <code>arn:aws:gamelift:<location>::gamesession/<fleet ID>/<ID string></code>.</p>
|
|
9885
10076
|
* @public
|
|
9886
10077
|
*/
|
|
9887
10078
|
GameSessionId: string | undefined;
|
|
@@ -10025,195 +10216,3 @@ export interface UpdateBuildOutput {
|
|
|
10025
10216
|
*/
|
|
10026
10217
|
Build?: Build | undefined;
|
|
10027
10218
|
}
|
|
10028
|
-
/**
|
|
10029
|
-
* @public
|
|
10030
|
-
*/
|
|
10031
|
-
export interface UpdateContainerFleetInput {
|
|
10032
|
-
/**
|
|
10033
|
-
* <p>A unique identifier for the container fleet to update. You can use either the fleet ID
|
|
10034
|
-
* or ARN value.</p>
|
|
10035
|
-
* @public
|
|
10036
|
-
*/
|
|
10037
|
-
FleetId: string | undefined;
|
|
10038
|
-
/**
|
|
10039
|
-
* <p>The name or ARN value of a new game server container group definition to deploy on the
|
|
10040
|
-
* fleet. If you're updating the fleet to a specific version of a container group
|
|
10041
|
-
* definition, use the ARN value and include the version number. If you're updating the
|
|
10042
|
-
* fleet to the latest version of a container group definition, you can use the name value.
|
|
10043
|
-
* You can't remove a fleet's game server container group definition, you can only update
|
|
10044
|
-
* or replace it with another definition.</p>
|
|
10045
|
-
* <p>Update a container group definition by calling
|
|
10046
|
-
* <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateContainerGroupDefinition.html">UpdateContainerGroupDefinition</a>.
|
|
10047
|
-
* This operation creates a
|
|
10048
|
-
* <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_ContainerGroupDefinition.html">ContainerGroupDefinition</a>
|
|
10049
|
-
* resource with an incremented version. </p>
|
|
10050
|
-
* @public
|
|
10051
|
-
*/
|
|
10052
|
-
GameServerContainerGroupDefinitionName?: string | undefined;
|
|
10053
|
-
/**
|
|
10054
|
-
* <p>The name or ARN value of a new per-instance container group definition to deploy on
|
|
10055
|
-
* the fleet. If you're updating the fleet to a specific version of a container group
|
|
10056
|
-
* definition, use the ARN value and include the version number. If you're updating the
|
|
10057
|
-
* fleet to the latest version of a container group definition, you can use the name
|
|
10058
|
-
* value.</p>
|
|
10059
|
-
* <p>Update a container group definition by calling
|
|
10060
|
-
* <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateContainerGroupDefinition.html">UpdateContainerGroupDefinition</a>.
|
|
10061
|
-
* This operation creates a
|
|
10062
|
-
* <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_ContainerGroupDefinition.html">ContainerGroupDefinition</a>
|
|
10063
|
-
* resource with an incremented version. </p>
|
|
10064
|
-
* <p>To remove a fleet's per-instance container group definition, leave this parameter empty
|
|
10065
|
-
* and use the parameter <code>RemoveAttributes</code>.</p>
|
|
10066
|
-
* @public
|
|
10067
|
-
*/
|
|
10068
|
-
PerInstanceContainerGroupDefinitionName?: string | undefined;
|
|
10069
|
-
/**
|
|
10070
|
-
* <p>The number of times to replicate the game server container group on each fleet
|
|
10071
|
-
* instance. By default, Amazon GameLift Servers calculates the maximum number of game server container
|
|
10072
|
-
* groups that can fit on each instance. You can remove this property value to use the
|
|
10073
|
-
* calculated value, or set it manually. If you set this number manually, Amazon GameLift Servers uses your
|
|
10074
|
-
* value as long as it's less than the calculated maximum.</p>
|
|
10075
|
-
* @public
|
|
10076
|
-
*/
|
|
10077
|
-
GameServerContainerGroupsPerInstance?: number | undefined;
|
|
10078
|
-
/**
|
|
10079
|
-
* <p>A revised set of port numbers to open on each fleet instance. By default, Amazon GameLift Servers
|
|
10080
|
-
* calculates an optimal port range based on your fleet configuration. If you previously
|
|
10081
|
-
* set this parameter manually, you can't reset this to use the calculated settings.</p>
|
|
10082
|
-
* @public
|
|
10083
|
-
*/
|
|
10084
|
-
InstanceConnectionPortRange?: ConnectionPortRange | undefined;
|
|
10085
|
-
/**
|
|
10086
|
-
* <p>A set of ports to add to the container fleet's inbound permissions.</p>
|
|
10087
|
-
* @public
|
|
10088
|
-
*/
|
|
10089
|
-
InstanceInboundPermissionAuthorizations?: IpPermission[] | undefined;
|
|
10090
|
-
/**
|
|
10091
|
-
* <p>A set of ports to remove from the container fleet's inbound permissions.</p>
|
|
10092
|
-
* @public
|
|
10093
|
-
*/
|
|
10094
|
-
InstanceInboundPermissionRevocations?: IpPermission[] | undefined;
|
|
10095
|
-
/**
|
|
10096
|
-
* <p>Instructions for how to deploy updates to a container fleet, if the fleet update
|
|
10097
|
-
* initiates a deployment. The deployment configuration lets you determine how to replace
|
|
10098
|
-
* fleet instances and what actions to take if the deployment fails.</p>
|
|
10099
|
-
* @public
|
|
10100
|
-
*/
|
|
10101
|
-
DeploymentConfiguration?: DeploymentConfiguration | undefined;
|
|
10102
|
-
/**
|
|
10103
|
-
* <p>A meaningful description of the container fleet.</p>
|
|
10104
|
-
* @public
|
|
10105
|
-
*/
|
|
10106
|
-
Description?: string | undefined;
|
|
10107
|
-
/**
|
|
10108
|
-
* <p>The name of an Amazon Web Services CloudWatch metric group to add this fleet to. </p>
|
|
10109
|
-
* @public
|
|
10110
|
-
*/
|
|
10111
|
-
MetricGroups?: string[] | undefined;
|
|
10112
|
-
/**
|
|
10113
|
-
* <p>The game session protection policy to apply to all new game sessions that are started
|
|
10114
|
-
* in this fleet. Game sessions that already exist are not affected. </p>
|
|
10115
|
-
* @public
|
|
10116
|
-
*/
|
|
10117
|
-
NewGameSessionProtectionPolicy?: ProtectionPolicy | undefined;
|
|
10118
|
-
/**
|
|
10119
|
-
* <p>A policy that limits the number of game sessions that each individual player can create
|
|
10120
|
-
* on instances in this fleet. The limit applies for a specified span of time.</p>
|
|
10121
|
-
* @public
|
|
10122
|
-
*/
|
|
10123
|
-
GameSessionCreationLimitPolicy?: GameSessionCreationLimitPolicy | undefined;
|
|
10124
|
-
/**
|
|
10125
|
-
* <p>The method for collecting container logs for the fleet. </p>
|
|
10126
|
-
* @public
|
|
10127
|
-
*/
|
|
10128
|
-
LogConfiguration?: LogConfiguration | undefined;
|
|
10129
|
-
/**
|
|
10130
|
-
* <p>If set, this update removes a fleet's per-instance container group definition. You
|
|
10131
|
-
* can't remove a fleet's game server container group definition.</p>
|
|
10132
|
-
* @public
|
|
10133
|
-
*/
|
|
10134
|
-
RemoveAttributes?: ContainerFleetRemoveAttribute[] | undefined;
|
|
10135
|
-
}
|
|
10136
|
-
/**
|
|
10137
|
-
* @public
|
|
10138
|
-
*/
|
|
10139
|
-
export interface UpdateContainerFleetOutput {
|
|
10140
|
-
/**
|
|
10141
|
-
* <p>A collection of container fleet objects for all fleets that match the request
|
|
10142
|
-
* criteria.</p>
|
|
10143
|
-
* @public
|
|
10144
|
-
*/
|
|
10145
|
-
ContainerFleet?: ContainerFleet | undefined;
|
|
10146
|
-
}
|
|
10147
|
-
/**
|
|
10148
|
-
* @public
|
|
10149
|
-
*/
|
|
10150
|
-
export interface UpdateContainerGroupDefinitionInput {
|
|
10151
|
-
/**
|
|
10152
|
-
* <p>A descriptive identifier for the container group definition. The name value must be unique in an Amazon Web Services Region.</p>
|
|
10153
|
-
* @public
|
|
10154
|
-
*/
|
|
10155
|
-
Name: string | undefined;
|
|
10156
|
-
/**
|
|
10157
|
-
* <p>An updated definition for the game server container in this group. Define a game server
|
|
10158
|
-
* container only when the container group type is <code>GAME_SERVER</code>. You can pass in your
|
|
10159
|
-
* container definitions as a JSON file.</p>
|
|
10160
|
-
* @public
|
|
10161
|
-
*/
|
|
10162
|
-
GameServerContainerDefinition?: GameServerContainerDefinitionInput | undefined;
|
|
10163
|
-
/**
|
|
10164
|
-
* <p>One or more definitions for support containers in this group. You can define a support
|
|
10165
|
-
* container in any type of container group. You can pass in your container definitions as a JSON
|
|
10166
|
-
* file.</p>
|
|
10167
|
-
* @public
|
|
10168
|
-
*/
|
|
10169
|
-
SupportContainerDefinitions?: SupportContainerDefinitionInput[] | undefined;
|
|
10170
|
-
/**
|
|
10171
|
-
* <p>The maximum amount of memory (in MiB) to allocate to the container group. All containers in
|
|
10172
|
-
* the group share this memory. If you specify memory limits for an individual container, the
|
|
10173
|
-
* total value must be greater than any individual container's memory limit.</p>
|
|
10174
|
-
* @public
|
|
10175
|
-
*/
|
|
10176
|
-
TotalMemoryLimitMebibytes?: number | undefined;
|
|
10177
|
-
/**
|
|
10178
|
-
* <p>The maximum amount of vCPU units to allocate to the container group (1 vCPU is equal to 1024
|
|
10179
|
-
* CPU units). All containers in the group share this memory. If you specify vCPU limits for
|
|
10180
|
-
* individual containers, the total value must be equal to or greater than the sum of the CPU
|
|
10181
|
-
* limits for all containers in the group.</p>
|
|
10182
|
-
* @public
|
|
10183
|
-
*/
|
|
10184
|
-
TotalVcpuLimit?: number | undefined;
|
|
10185
|
-
/**
|
|
10186
|
-
* <p>A description for this update to the container group definition. </p>
|
|
10187
|
-
* @public
|
|
10188
|
-
*/
|
|
10189
|
-
VersionDescription?: string | undefined;
|
|
10190
|
-
/**
|
|
10191
|
-
* <p>The container group definition version to update. The new version starts with values from
|
|
10192
|
-
* the source version, and then updates values included in this request. </p>
|
|
10193
|
-
* @public
|
|
10194
|
-
*/
|
|
10195
|
-
SourceVersionNumber?: number | undefined;
|
|
10196
|
-
/**
|
|
10197
|
-
* <p>The platform that all containers in the group use. Containers in a group must run on the
|
|
10198
|
-
* same operating system.</p>
|
|
10199
|
-
* <note>
|
|
10200
|
-
* <p>Amazon Linux 2 (AL2) will reach end of support on 6/30/2026. See more details in the <a href="http://aws.amazon.com/amazon-linux-2/faqs/">Amazon Linux 2 FAQs</a>. For game
|
|
10201
|
-
* servers that are hosted on AL2 and use server SDK version 4.x for Amazon GameLift Servers, first update the game
|
|
10202
|
-
* server build to server SDK 5.x, and then deploy to AL2023 instances. See <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk5-migration.html"> Migrate to
|
|
10203
|
-
* server SDK version 5.</a>
|
|
10204
|
-
* </p>
|
|
10205
|
-
* </note>
|
|
10206
|
-
* @public
|
|
10207
|
-
*/
|
|
10208
|
-
OperatingSystem?: ContainerOperatingSystem | undefined;
|
|
10209
|
-
}
|
|
10210
|
-
/**
|
|
10211
|
-
* @public
|
|
10212
|
-
*/
|
|
10213
|
-
export interface UpdateContainerGroupDefinitionOutput {
|
|
10214
|
-
/**
|
|
10215
|
-
* <p>The properties of the updated container group definition version.</p>
|
|
10216
|
-
* @public
|
|
10217
|
-
*/
|
|
10218
|
-
ContainerGroupDefinition?: ContainerGroupDefinition | undefined;
|
|
10219
|
-
}
|