aws-cdk-lib 2.140.0__py3-none-any.whl → 2.141.0__py3-none-any.whl
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.
Potentially problematic release.
This version of aws-cdk-lib might be problematic. Click here for more details.
- aws_cdk/_jsii/__init__.py +1 -1
- aws_cdk/_jsii/{aws-cdk-lib@2.140.0.jsii.tgz → aws-cdk-lib@2.141.0.jsii.tgz} +0 -0
- aws_cdk/aws_bedrock/__init__.py +51 -41
- aws_cdk/aws_cloudtrail/__init__.py +13 -4
- aws_cdk/aws_connectcampaigns/__init__.py +2 -2
- aws_cdk/aws_datasync/__init__.py +51 -56
- aws_cdk/aws_dynamodb/__init__.py +410 -0
- aws_cdk/aws_ec2/__init__.py +90 -40
- aws_cdk/aws_ecr/__init__.py +32 -7
- aws_cdk/aws_entityresolution/__init__.py +6 -2
- aws_cdk/aws_fms/__init__.py +7 -7
- aws_cdk/aws_gamelift/__init__.py +261 -160
- aws_cdk/aws_ivs/__init__.py +1 -3
- aws_cdk/aws_kms/__init__.py +11 -5
- aws_cdk/aws_location/__init__.py +8 -4
- aws_cdk/aws_oam/__init__.py +45 -11
- aws_cdk/aws_omics/__init__.py +4 -4
- aws_cdk/aws_paymentcryptography/__init__.py +128 -48
- aws_cdk/aws_pinpoint/__init__.py +7 -5
- aws_cdk/aws_qbusiness/__init__.py +620 -294
- aws_cdk/aws_quicksight/__init__.py +103 -40
- aws_cdk/aws_rds/__init__.py +38 -8
- aws_cdk/aws_route53profiles/__init__.py +49 -49
- aws_cdk/aws_sagemaker/__init__.py +30 -30
- aws_cdk/aws_ses/__init__.py +9 -9
- aws_cdk/aws_transfer/__init__.py +4 -4
- aws_cdk/aws_voiceid/__init__.py +2 -2
- {aws_cdk_lib-2.140.0.dist-info → aws_cdk_lib-2.141.0.dist-info}/METADATA +1 -1
- {aws_cdk_lib-2.140.0.dist-info → aws_cdk_lib-2.141.0.dist-info}/RECORD +33 -33
- {aws_cdk_lib-2.140.0.dist-info → aws_cdk_lib-2.141.0.dist-info}/LICENSE +0 -0
- {aws_cdk_lib-2.140.0.dist-info → aws_cdk_lib-2.141.0.dist-info}/NOTICE +0 -0
- {aws_cdk_lib-2.140.0.dist-info → aws_cdk_lib-2.141.0.dist-info}/WHEEL +0 -0
- {aws_cdk_lib-2.140.0.dist-info → aws_cdk_lib-2.141.0.dist-info}/top_level.txt +0 -0
aws_cdk/aws_gamelift/__init__.py
CHANGED
|
@@ -863,7 +863,13 @@ class CfnContainerGroupDefinition(
|
|
|
863
863
|
metaclass=jsii.JSIIMeta,
|
|
864
864
|
jsii_type="aws-cdk-lib.aws_gamelift.CfnContainerGroupDefinition",
|
|
865
865
|
):
|
|
866
|
-
'''
|
|
866
|
+
'''*This data type is used with the Amazon GameLift containers feature, which is currently in public preview.*.
|
|
867
|
+
|
|
868
|
+
The properties that describe a container group resource. Container group definition properties can't be updated. To change a property, create a new container group definition.
|
|
869
|
+
|
|
870
|
+
*Used with:* ``CreateContainerGroupDefinition``
|
|
871
|
+
|
|
872
|
+
*Returned by:* ``DescribeContainerGroupDefinition`` , ``ListContainerGroupDefinitions``
|
|
867
873
|
|
|
868
874
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html
|
|
869
875
|
:cloudformationResource: AWS::GameLift::ContainerGroupDefinition
|
|
@@ -946,12 +952,12 @@ class CfnContainerGroupDefinition(
|
|
|
946
952
|
'''
|
|
947
953
|
:param scope: Scope in which this resource is defined.
|
|
948
954
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
949
|
-
:param container_definitions:
|
|
950
|
-
:param name: A descriptive
|
|
951
|
-
:param operating_system: The
|
|
952
|
-
:param total_cpu_limit: The
|
|
953
|
-
:param total_memory_limit: The
|
|
954
|
-
:param scheduling_strategy:
|
|
955
|
+
:param container_definitions: The set of container definitions that are included in the container group.
|
|
956
|
+
:param name: A descriptive identifier for the container group definition. The name value is unique in an AWS Region.
|
|
957
|
+
:param operating_system: The platform required for all containers in the container group definition.
|
|
958
|
+
:param total_cpu_limit: The amount of CPU units on a fleet instance to allocate for the container group. All containers in the group share these resources. This property is an integer value in CPU units (1 vCPU is equal to 1024 CPU units). You can set additional limits for each ``ContainerDefinition`` in the group. If individual containers have limits, this value must be equal to or greater than the sum of all container-specific CPU limits in the group. For more details on memory allocation, see the `Container fleet design guide <https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-design-fleet>`_ .
|
|
959
|
+
:param total_memory_limit: The amount of memory (in MiB) on a fleet instance to allocate for the container group. All containers in the group share these resources. You can set additional limits for each ``ContainerDefinition`` in the group. If individual containers have limits, this value must meet the following requirements: - Equal to or greater than the sum of all container-specific soft memory limits in the group. - Equal to or greater than any container-specific hard limits in the group. For more details on memory allocation, see the `Container fleet design guide <https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-design-fleet>`_ .
|
|
960
|
+
:param scheduling_strategy: The method for deploying the container group across fleet instances. A replica container group might have multiple copies on each fleet instance. A daemon container group maintains only one copy per fleet instance.
|
|
955
961
|
:param tags: An array of key-value pairs to apply to this resource.
|
|
956
962
|
'''
|
|
957
963
|
if __debug__:
|
|
@@ -1003,7 +1009,7 @@ class CfnContainerGroupDefinition(
|
|
|
1003
1009
|
@builtins.property
|
|
1004
1010
|
@jsii.member(jsii_name="attrContainerGroupDefinitionArn")
|
|
1005
1011
|
def attr_container_group_definition_arn(self) -> builtins.str:
|
|
1006
|
-
'''The Amazon Resource Name (ARN) that is assigned to
|
|
1012
|
+
'''The Amazon Resource Name ( `ARN <https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html>`_ ) that is assigned to an Amazon GameLift ``ContainerGroupDefinition`` resource. It uniquely identifies the resource across all AWS Regions. Format is ``arn:aws:gamelift:<region>::containergroupdefinition/[container group definition name]`` .
|
|
1007
1013
|
|
|
1008
1014
|
:cloudformationAttribute: ContainerGroupDefinitionArn
|
|
1009
1015
|
'''
|
|
@@ -1014,7 +1020,7 @@ class CfnContainerGroupDefinition(
|
|
|
1014
1020
|
def attr_creation_time(self) -> builtins.str:
|
|
1015
1021
|
'''A time stamp indicating when this data object was created.
|
|
1016
1022
|
|
|
1017
|
-
Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
|
|
1023
|
+
Format is a number expressed in Unix time as milliseconds (for example ``"1469498468.057"`` ).
|
|
1018
1024
|
|
|
1019
1025
|
:cloudformationAttribute: CreationTime
|
|
1020
1026
|
'''
|
|
@@ -1036,7 +1042,7 @@ class CfnContainerGroupDefinition(
|
|
|
1036
1042
|
def container_definitions(
|
|
1037
1043
|
self,
|
|
1038
1044
|
) -> typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnContainerGroupDefinition.ContainerDefinitionProperty"]]]:
|
|
1039
|
-
'''
|
|
1045
|
+
'''The set of container definitions that are included in the container group.'''
|
|
1040
1046
|
return typing.cast(typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnContainerGroupDefinition.ContainerDefinitionProperty"]]], jsii.get(self, "containerDefinitions"))
|
|
1041
1047
|
|
|
1042
1048
|
@container_definitions.setter
|
|
@@ -1052,7 +1058,7 @@ class CfnContainerGroupDefinition(
|
|
|
1052
1058
|
@builtins.property
|
|
1053
1059
|
@jsii.member(jsii_name="name")
|
|
1054
1060
|
def name(self) -> builtins.str:
|
|
1055
|
-
'''A descriptive
|
|
1061
|
+
'''A descriptive identifier for the container group definition.'''
|
|
1056
1062
|
return typing.cast(builtins.str, jsii.get(self, "name"))
|
|
1057
1063
|
|
|
1058
1064
|
@name.setter
|
|
@@ -1065,7 +1071,7 @@ class CfnContainerGroupDefinition(
|
|
|
1065
1071
|
@builtins.property
|
|
1066
1072
|
@jsii.member(jsii_name="operatingSystem")
|
|
1067
1073
|
def operating_system(self) -> builtins.str:
|
|
1068
|
-
'''The
|
|
1074
|
+
'''The platform required for all containers in the container group definition.'''
|
|
1069
1075
|
return typing.cast(builtins.str, jsii.get(self, "operatingSystem"))
|
|
1070
1076
|
|
|
1071
1077
|
@operating_system.setter
|
|
@@ -1078,7 +1084,7 @@ class CfnContainerGroupDefinition(
|
|
|
1078
1084
|
@builtins.property
|
|
1079
1085
|
@jsii.member(jsii_name="totalCpuLimit")
|
|
1080
1086
|
def total_cpu_limit(self) -> jsii.Number:
|
|
1081
|
-
'''The
|
|
1087
|
+
'''The amount of CPU units on a fleet instance to allocate for the container group.'''
|
|
1082
1088
|
return typing.cast(jsii.Number, jsii.get(self, "totalCpuLimit"))
|
|
1083
1089
|
|
|
1084
1090
|
@total_cpu_limit.setter
|
|
@@ -1091,7 +1097,7 @@ class CfnContainerGroupDefinition(
|
|
|
1091
1097
|
@builtins.property
|
|
1092
1098
|
@jsii.member(jsii_name="totalMemoryLimit")
|
|
1093
1099
|
def total_memory_limit(self) -> jsii.Number:
|
|
1094
|
-
'''The
|
|
1100
|
+
'''The amount of memory (in MiB) on a fleet instance to allocate for the container group.'''
|
|
1095
1101
|
return typing.cast(jsii.Number, jsii.get(self, "totalMemoryLimit"))
|
|
1096
1102
|
|
|
1097
1103
|
@total_memory_limit.setter
|
|
@@ -1104,7 +1110,7 @@ class CfnContainerGroupDefinition(
|
|
|
1104
1110
|
@builtins.property
|
|
1105
1111
|
@jsii.member(jsii_name="schedulingStrategy")
|
|
1106
1112
|
def scheduling_strategy(self) -> typing.Optional[builtins.str]:
|
|
1107
|
-
'''
|
|
1113
|
+
'''The method for deploying the container group across fleet instances.'''
|
|
1108
1114
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "schedulingStrategy"))
|
|
1109
1115
|
|
|
1110
1116
|
@scheduling_strategy.setter
|
|
@@ -1164,21 +1170,27 @@ class CfnContainerGroupDefinition(
|
|
|
1164
1170
|
resolved_image_digest: typing.Optional[builtins.str] = None,
|
|
1165
1171
|
working_directory: typing.Optional[builtins.str] = None,
|
|
1166
1172
|
) -> None:
|
|
1167
|
-
'''
|
|
1168
|
-
|
|
1169
|
-
|
|
1170
|
-
|
|
1171
|
-
|
|
1172
|
-
|
|
1173
|
-
|
|
1174
|
-
|
|
1175
|
-
:param
|
|
1176
|
-
:param
|
|
1177
|
-
:param
|
|
1178
|
-
:param
|
|
1179
|
-
:param
|
|
1180
|
-
:param
|
|
1181
|
-
:param
|
|
1173
|
+
'''*This data type is used with the Amazon GameLift containers feature, which is currently in public preview.*.
|
|
1174
|
+
|
|
1175
|
+
Describes a container in a container fleet, the resources available to the container, and the commands that are run when the container starts. Container properties can't be updated. To change a property, create a new container group definition. See also ``ContainerDefinitionInput`` .
|
|
1176
|
+
|
|
1177
|
+
*Part of:* ``ContainerGroupDefinition``
|
|
1178
|
+
|
|
1179
|
+
*Returned by:* ``DescribeContainerGroupDefinition`` , ``ListContainerGroupDefinitions``
|
|
1180
|
+
|
|
1181
|
+
:param container_name: The container definition identifier. Container names are unique within a container group definition.
|
|
1182
|
+
:param image_uri: The URI to the image that $short; copied and deployed to a container fleet. For a more specific identifier, see ``ResolvedImageDigest`` .
|
|
1183
|
+
:param command: A command that's passed to the container on startup. Each argument for the command is an additional string in the array. See the `ContainerDefinition::command <https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html#ECS-Type-ContainerDefinition-command>`_ parameter in the *Amazon Elastic Container Service API reference.*
|
|
1184
|
+
:param cpu: The number of CPU units that are reserved for the container. Note: 1 vCPU unit equals 1024 CPU units. If no resources are reserved, the container shares the total CPU limit for the container group. *Related data type:* ``ContainerGroupDefinition$TotalCpuLimit``
|
|
1185
|
+
:param depends_on: Indicates that the container relies on the status of other containers in the same container group during its startup and shutdown sequences. A container might have dependencies on multiple containers.
|
|
1186
|
+
:param entry_point: The entry point that's passed to the container on startup. If there are multiple arguments, each argument is an additional string in the array. See the `ContainerDefinition::entryPoint <https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html#ECS-Type-ContainerDefinition-entryPoint>`_ parameter in the *Amazon Elastic Container Service API Reference* .
|
|
1187
|
+
:param environment: A set of environment variables that's passed to the container on startup. See the `ContainerDefinition::environment <https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html#ECS-Type-ContainerDefinition-environment>`_ parameter in the *Amazon Elastic Container Service API Reference* .
|
|
1188
|
+
:param essential: Indicates whether the container is vital to the container group. If an essential container fails, the entire container group is restarted.
|
|
1189
|
+
:param health_check: A configuration for a non-terminal health check. A container, which automatically restarts if it stops functioning, also restarts if it fails this health check. If an essential container in the daemon group fails a health check, the entire container group is restarted. The essential container in the replica group doesn't use this health check mechanism, because the Amazon GameLift Agent automatically handles the task.
|
|
1190
|
+
:param memory_limits: The amount of memory that Amazon GameLift makes available to the container. If memory limits aren't set for an individual container, the container shares the container group's total memory allocation. *Related data type:* ``ContainerGroupDefinition$TotalMemoryLimit``
|
|
1191
|
+
:param port_configuration: Defines the ports that are available to assign to processes in the container. For example, a game server process requires a container port to allow game clients to connect to it. Container ports aren't directly accessed by inbound traffic. Amazon GameLift maps these container ports to externally accessible connection ports, which are assigned as needed from the container fleet's ``ConnectionPortRange`` .
|
|
1192
|
+
:param resolved_image_digest: A unique and immutable identifier for the container image that is deployed to a container fleet. The digest is a SHA 256 hash of the container image manifest.
|
|
1193
|
+
:param working_directory: The directory in the container where commands are run. See the `ContainerDefinition::workingDirectory <https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html#ECS-Type-ContainerDefinition-workingDirectory>`_ parameter in the *Amazon Elastic Container Service API Reference* .
|
|
1182
1194
|
|
|
1183
1195
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerdefinition.html
|
|
1184
1196
|
:exampleMetadata: fixture=_generated
|
|
@@ -1274,9 +1286,9 @@ class CfnContainerGroupDefinition(
|
|
|
1274
1286
|
|
|
1275
1287
|
@builtins.property
|
|
1276
1288
|
def container_name(self) -> builtins.str:
|
|
1277
|
-
'''
|
|
1289
|
+
'''The container definition identifier.
|
|
1278
1290
|
|
|
1279
|
-
Container
|
|
1291
|
+
Container names are unique within a container group definition.
|
|
1280
1292
|
|
|
1281
1293
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerdefinition.html#cfn-gamelift-containergroupdefinition-containerdefinition-containername
|
|
1282
1294
|
'''
|
|
@@ -1286,7 +1298,9 @@ class CfnContainerGroupDefinition(
|
|
|
1286
1298
|
|
|
1287
1299
|
@builtins.property
|
|
1288
1300
|
def image_uri(self) -> builtins.str:
|
|
1289
|
-
'''
|
|
1301
|
+
'''The URI to the image that $short;
|
|
1302
|
+
|
|
1303
|
+
copied and deployed to a container fleet. For a more specific identifier, see ``ResolvedImageDigest`` .
|
|
1290
1304
|
|
|
1291
1305
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerdefinition.html#cfn-gamelift-containergroupdefinition-containerdefinition-imageuri
|
|
1292
1306
|
'''
|
|
@@ -1296,7 +1310,9 @@ class CfnContainerGroupDefinition(
|
|
|
1296
1310
|
|
|
1297
1311
|
@builtins.property
|
|
1298
1312
|
def command(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
1299
|
-
'''
|
|
1313
|
+
'''A command that's passed to the container on startup.
|
|
1314
|
+
|
|
1315
|
+
Each argument for the command is an additional string in the array. See the `ContainerDefinition::command <https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html#ECS-Type-ContainerDefinition-command>`_ parameter in the *Amazon Elastic Container Service API reference.*
|
|
1300
1316
|
|
|
1301
1317
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerdefinition.html#cfn-gamelift-containergroupdefinition-containerdefinition-command
|
|
1302
1318
|
'''
|
|
@@ -1305,9 +1321,11 @@ class CfnContainerGroupDefinition(
|
|
|
1305
1321
|
|
|
1306
1322
|
@builtins.property
|
|
1307
1323
|
def cpu(self) -> typing.Optional[jsii.Number]:
|
|
1308
|
-
'''The
|
|
1324
|
+
'''The number of CPU units that are reserved for the container.
|
|
1325
|
+
|
|
1326
|
+
Note: 1 vCPU unit equals 1024 CPU units. If no resources are reserved, the container shares the total CPU limit for the container group.
|
|
1309
1327
|
|
|
1310
|
-
|
|
1328
|
+
*Related data type:* ``ContainerGroupDefinition$TotalCpuLimit``
|
|
1311
1329
|
|
|
1312
1330
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerdefinition.html#cfn-gamelift-containergroupdefinition-containerdefinition-cpu
|
|
1313
1331
|
'''
|
|
@@ -1318,9 +1336,9 @@ class CfnContainerGroupDefinition(
|
|
|
1318
1336
|
def depends_on(
|
|
1319
1337
|
self,
|
|
1320
1338
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnContainerGroupDefinition.ContainerDependencyProperty"]]]]:
|
|
1321
|
-
'''
|
|
1339
|
+
'''Indicates that the container relies on the status of other containers in the same container group during its startup and shutdown sequences.
|
|
1322
1340
|
|
|
1323
|
-
|
|
1341
|
+
A container might have dependencies on multiple containers.
|
|
1324
1342
|
|
|
1325
1343
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerdefinition.html#cfn-gamelift-containergroupdefinition-containerdefinition-dependson
|
|
1326
1344
|
'''
|
|
@@ -1329,9 +1347,9 @@ class CfnContainerGroupDefinition(
|
|
|
1329
1347
|
|
|
1330
1348
|
@builtins.property
|
|
1331
1349
|
def entry_point(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
1332
|
-
'''The entry point that's passed to the container
|
|
1350
|
+
'''The entry point that's passed to the container on startup.
|
|
1333
1351
|
|
|
1334
|
-
If there are multiple arguments, each argument is
|
|
1352
|
+
If there are multiple arguments, each argument is an additional string in the array. See the `ContainerDefinition::entryPoint <https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html#ECS-Type-ContainerDefinition-entryPoint>`_ parameter in the *Amazon Elastic Container Service API Reference* .
|
|
1335
1353
|
|
|
1336
1354
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerdefinition.html#cfn-gamelift-containergroupdefinition-containerdefinition-entrypoint
|
|
1337
1355
|
'''
|
|
@@ -1342,7 +1360,9 @@ class CfnContainerGroupDefinition(
|
|
|
1342
1360
|
def environment(
|
|
1343
1361
|
self,
|
|
1344
1362
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnContainerGroupDefinition.ContainerEnvironmentProperty"]]]]:
|
|
1345
|
-
'''
|
|
1363
|
+
'''A set of environment variables that's passed to the container on startup.
|
|
1364
|
+
|
|
1365
|
+
See the `ContainerDefinition::environment <https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html#ECS-Type-ContainerDefinition-environment>`_ parameter in the *Amazon Elastic Container Service API Reference* .
|
|
1346
1366
|
|
|
1347
1367
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerdefinition.html#cfn-gamelift-containergroupdefinition-containerdefinition-environment
|
|
1348
1368
|
'''
|
|
@@ -1353,9 +1373,9 @@ class CfnContainerGroupDefinition(
|
|
|
1353
1373
|
def essential(
|
|
1354
1374
|
self,
|
|
1355
1375
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
1356
|
-
'''
|
|
1376
|
+
'''Indicates whether the container is vital to the container group.
|
|
1357
1377
|
|
|
1358
|
-
If an essential container fails
|
|
1378
|
+
If an essential container fails, the entire container group is restarted.
|
|
1359
1379
|
|
|
1360
1380
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerdefinition.html#cfn-gamelift-containergroupdefinition-containerdefinition-essential
|
|
1361
1381
|
'''
|
|
@@ -1366,7 +1386,9 @@ class CfnContainerGroupDefinition(
|
|
|
1366
1386
|
def health_check(
|
|
1367
1387
|
self,
|
|
1368
1388
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnContainerGroupDefinition.ContainerHealthCheckProperty"]]:
|
|
1369
|
-
'''
|
|
1389
|
+
'''A configuration for a non-terminal health check.
|
|
1390
|
+
|
|
1391
|
+
A container, which automatically restarts if it stops functioning, also restarts if it fails this health check. If an essential container in the daemon group fails a health check, the entire container group is restarted. The essential container in the replica group doesn't use this health check mechanism, because the Amazon GameLift Agent automatically handles the task.
|
|
1370
1392
|
|
|
1371
1393
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerdefinition.html#cfn-gamelift-containergroupdefinition-containerdefinition-healthcheck
|
|
1372
1394
|
'''
|
|
@@ -1377,7 +1399,11 @@ class CfnContainerGroupDefinition(
|
|
|
1377
1399
|
def memory_limits(
|
|
1378
1400
|
self,
|
|
1379
1401
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnContainerGroupDefinition.MemoryLimitsProperty"]]:
|
|
1380
|
-
'''
|
|
1402
|
+
'''The amount of memory that Amazon GameLift makes available to the container.
|
|
1403
|
+
|
|
1404
|
+
If memory limits aren't set for an individual container, the container shares the container group's total memory allocation.
|
|
1405
|
+
|
|
1406
|
+
*Related data type:* ``ContainerGroupDefinition$TotalMemoryLimit``
|
|
1381
1407
|
|
|
1382
1408
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerdefinition.html#cfn-gamelift-containergroupdefinition-containerdefinition-memorylimits
|
|
1383
1409
|
'''
|
|
@@ -1388,7 +1414,9 @@ class CfnContainerGroupDefinition(
|
|
|
1388
1414
|
def port_configuration(
|
|
1389
1415
|
self,
|
|
1390
1416
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnContainerGroupDefinition.PortConfigurationProperty"]]:
|
|
1391
|
-
'''Defines the ports
|
|
1417
|
+
'''Defines the ports that are available to assign to processes in the container.
|
|
1418
|
+
|
|
1419
|
+
For example, a game server process requires a container port to allow game clients to connect to it. Container ports aren't directly accessed by inbound traffic. Amazon GameLift maps these container ports to externally accessible connection ports, which are assigned as needed from the container fleet's ``ConnectionPortRange`` .
|
|
1392
1420
|
|
|
1393
1421
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerdefinition.html#cfn-gamelift-containergroupdefinition-containerdefinition-portconfiguration
|
|
1394
1422
|
'''
|
|
@@ -1397,7 +1425,9 @@ class CfnContainerGroupDefinition(
|
|
|
1397
1425
|
|
|
1398
1426
|
@builtins.property
|
|
1399
1427
|
def resolved_image_digest(self) -> typing.Optional[builtins.str]:
|
|
1400
|
-
'''
|
|
1428
|
+
'''A unique and immutable identifier for the container image that is deployed to a container fleet.
|
|
1429
|
+
|
|
1430
|
+
The digest is a SHA 256 hash of the container image manifest.
|
|
1401
1431
|
|
|
1402
1432
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerdefinition.html#cfn-gamelift-containergroupdefinition-containerdefinition-resolvedimagedigest
|
|
1403
1433
|
'''
|
|
@@ -1406,7 +1436,9 @@ class CfnContainerGroupDefinition(
|
|
|
1406
1436
|
|
|
1407
1437
|
@builtins.property
|
|
1408
1438
|
def working_directory(self) -> typing.Optional[builtins.str]:
|
|
1409
|
-
'''The
|
|
1439
|
+
'''The directory in the container where commands are run.
|
|
1440
|
+
|
|
1441
|
+
See the `ContainerDefinition::workingDirectory <https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html#ECS-Type-ContainerDefinition-workingDirectory>`_ parameter in the *Amazon Elastic Container Service API Reference* .
|
|
1410
1442
|
|
|
1411
1443
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerdefinition.html#cfn-gamelift-containergroupdefinition-containerdefinition-workingdirectory
|
|
1412
1444
|
'''
|
|
@@ -1436,10 +1468,16 @@ class CfnContainerGroupDefinition(
|
|
|
1436
1468
|
condition: builtins.str,
|
|
1437
1469
|
container_name: builtins.str,
|
|
1438
1470
|
) -> None:
|
|
1439
|
-
'''
|
|
1471
|
+
'''*This data type is used with the Amazon GameLift containers feature, which is currently in public preview.*.
|
|
1472
|
+
|
|
1473
|
+
A container's dependency on another container in the same container group. The dependency impacts how the dependent container is able to start or shut down based the status of the other container.
|
|
1440
1474
|
|
|
1441
|
-
|
|
1442
|
-
|
|
1475
|
+
For example, ContainerA is configured with the following dependency: a ``START`` dependency on ContainerB. This means that ContainerA can't start until ContainerB has started. It also means that ContainerA must shut down before ContainerB.
|
|
1476
|
+
|
|
1477
|
+
*Part of:* ``ContainerDefinition``
|
|
1478
|
+
|
|
1479
|
+
:param condition: The condition that the dependency container must reach before the dependent container can start. Valid conditions include:. - START - The dependency container must have started. - COMPLETE - The dependency container has run to completion (exits). Use this condition with nonessential containers, such as those that run a script and then exit. The dependency container can't be an essential container. - SUCCESS - The dependency container has run to completion and exited with a zero status. The dependency container can't be an essential container. - HEALTHY - The dependency container has passed its Docker health check. Use this condition with dependency containers that have health checks configured. This condition is confirmed at container group startup only.
|
|
1480
|
+
:param container_name: A descriptive label for the container definition that this container depends on.
|
|
1443
1481
|
|
|
1444
1482
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerdependency.html
|
|
1445
1483
|
:exampleMetadata: fixture=_generated
|
|
@@ -1466,7 +1504,12 @@ class CfnContainerGroupDefinition(
|
|
|
1466
1504
|
|
|
1467
1505
|
@builtins.property
|
|
1468
1506
|
def condition(self) -> builtins.str:
|
|
1469
|
-
'''The
|
|
1507
|
+
'''The condition that the dependency container must reach before the dependent container can start. Valid conditions include:.
|
|
1508
|
+
|
|
1509
|
+
- START - The dependency container must have started.
|
|
1510
|
+
- COMPLETE - The dependency container has run to completion (exits). Use this condition with nonessential containers, such as those that run a script and then exit. The dependency container can't be an essential container.
|
|
1511
|
+
- SUCCESS - The dependency container has run to completion and exited with a zero status. The dependency container can't be an essential container.
|
|
1512
|
+
- HEALTHY - The dependency container has passed its Docker health check. Use this condition with dependency containers that have health checks configured. This condition is confirmed at container group startup only.
|
|
1470
1513
|
|
|
1471
1514
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerdependency.html#cfn-gamelift-containergroupdefinition-containerdependency-condition
|
|
1472
1515
|
'''
|
|
@@ -1476,9 +1519,7 @@ class CfnContainerGroupDefinition(
|
|
|
1476
1519
|
|
|
1477
1520
|
@builtins.property
|
|
1478
1521
|
def container_name(self) -> builtins.str:
|
|
1479
|
-
'''A descriptive label for the container definition.
|
|
1480
|
-
|
|
1481
|
-
The container being defined depends on this container's condition.
|
|
1522
|
+
'''A descriptive label for the container definition that this container depends on.
|
|
1482
1523
|
|
|
1483
1524
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerdependency.html#cfn-gamelift-containergroupdefinition-containerdependency-containername
|
|
1484
1525
|
'''
|
|
@@ -1504,7 +1545,11 @@ class CfnContainerGroupDefinition(
|
|
|
1504
1545
|
)
|
|
1505
1546
|
class ContainerEnvironmentProperty:
|
|
1506
1547
|
def __init__(self, *, name: builtins.str, value: builtins.str) -> None:
|
|
1507
|
-
'''
|
|
1548
|
+
'''*This data type is used with the Amazon GameLift containers feature, which is currently in public preview.*.
|
|
1549
|
+
|
|
1550
|
+
An environment variable to set inside a container, in the form of a key-value pair.
|
|
1551
|
+
|
|
1552
|
+
*Related data type:* ``ContainerDefinition$Environment``
|
|
1508
1553
|
|
|
1509
1554
|
:param name: The environment variable name.
|
|
1510
1555
|
:param value: The environment variable value.
|
|
@@ -1584,13 +1629,21 @@ class CfnContainerGroupDefinition(
|
|
|
1584
1629
|
start_period: typing.Optional[jsii.Number] = None,
|
|
1585
1630
|
timeout: typing.Optional[jsii.Number] = None,
|
|
1586
1631
|
) -> None:
|
|
1587
|
-
'''
|
|
1632
|
+
'''Instructions on when and how to check the health of a container in a container fleet.
|
|
1633
|
+
|
|
1634
|
+
When health check properties are set in a container definition, they override any Docker health checks in the container image. For more information on container health checks, see `HealthCheck command <https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_HealthCheck.html#ECS-Type-HealthCheck-command>`_ in the *Amazon Elastic Container Service API* .
|
|
1635
|
+
|
|
1636
|
+
The following example instructions tell the container to wait 100 seconds after launch before counting failed health checks, then initiate the health check command every 60 seconds. After issuing the health check command, wait 10 seconds for it to succeed. If it fails, retry the command 3 times before considering the container to be unhealthy.
|
|
1588
1637
|
|
|
1589
|
-
:
|
|
1590
|
-
|
|
1591
|
-
|
|
1592
|
-
|
|
1593
|
-
:param
|
|
1638
|
+
``{"Command": [ "CMD-SHELL", "ps cax | grep "processmanager" || exit 1" ], "Interval": 300, "Timeout": 30, "Retries": 5, "StartPeriod": 100 }``
|
|
1639
|
+
|
|
1640
|
+
*Part of:* ``ContainerDefinition$HealthCheck``
|
|
1641
|
+
|
|
1642
|
+
:param command: A string array that specifies the command that the container runs to determine if it's healthy.
|
|
1643
|
+
:param interval: The time period (in seconds) between each health check.
|
|
1644
|
+
:param retries: The number of times to retry a failed health check before the container is considered unhealthy. The first run of the command does not count as a retry.
|
|
1645
|
+
:param start_period: The optional grace period (in seconds) to give a container time to bootstrap before the first failed health check counts toward the number of retries.
|
|
1646
|
+
:param timeout: The time period (in seconds) to wait for a health check to succeed before a failed health check is counted.
|
|
1594
1647
|
|
|
1595
1648
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerhealthcheck.html
|
|
1596
1649
|
:exampleMetadata: fixture=_generated
|
|
@@ -1632,7 +1685,7 @@ class CfnContainerGroupDefinition(
|
|
|
1632
1685
|
|
|
1633
1686
|
@builtins.property
|
|
1634
1687
|
def command(self) -> typing.List[builtins.str]:
|
|
1635
|
-
'''A string array
|
|
1688
|
+
'''A string array that specifies the command that the container runs to determine if it's healthy.
|
|
1636
1689
|
|
|
1637
1690
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerhealthcheck.html#cfn-gamelift-containergroupdefinition-containerhealthcheck-command
|
|
1638
1691
|
'''
|
|
@@ -1642,7 +1695,7 @@ class CfnContainerGroupDefinition(
|
|
|
1642
1695
|
|
|
1643
1696
|
@builtins.property
|
|
1644
1697
|
def interval(self) -> typing.Optional[jsii.Number]:
|
|
1645
|
-
'''
|
|
1698
|
+
'''The time period (in seconds) between each health check.
|
|
1646
1699
|
|
|
1647
1700
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerhealthcheck.html#cfn-gamelift-containergroupdefinition-containerhealthcheck-interval
|
|
1648
1701
|
'''
|
|
@@ -1651,9 +1704,9 @@ class CfnContainerGroupDefinition(
|
|
|
1651
1704
|
|
|
1652
1705
|
@builtins.property
|
|
1653
1706
|
def retries(self) -> typing.Optional[jsii.Number]:
|
|
1654
|
-
'''
|
|
1707
|
+
'''The number of times to retry a failed health check before the container is considered unhealthy.
|
|
1655
1708
|
|
|
1656
|
-
|
|
1709
|
+
The first run of the command does not count as a retry.
|
|
1657
1710
|
|
|
1658
1711
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerhealthcheck.html#cfn-gamelift-containergroupdefinition-containerhealthcheck-retries
|
|
1659
1712
|
'''
|
|
@@ -1662,7 +1715,7 @@ class CfnContainerGroupDefinition(
|
|
|
1662
1715
|
|
|
1663
1716
|
@builtins.property
|
|
1664
1717
|
def start_period(self) -> typing.Optional[jsii.Number]:
|
|
1665
|
-
'''The optional grace period (in seconds) to give a container time to
|
|
1718
|
+
'''The optional grace period (in seconds) to give a container time to bootstrap before the first failed health check counts toward the number of retries.
|
|
1666
1719
|
|
|
1667
1720
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerhealthcheck.html#cfn-gamelift-containergroupdefinition-containerhealthcheck-startperiod
|
|
1668
1721
|
'''
|
|
@@ -1671,7 +1724,7 @@ class CfnContainerGroupDefinition(
|
|
|
1671
1724
|
|
|
1672
1725
|
@builtins.property
|
|
1673
1726
|
def timeout(self) -> typing.Optional[jsii.Number]:
|
|
1674
|
-
'''
|
|
1727
|
+
'''The time period (in seconds) to wait for a health check to succeed before a failed health check is counted.
|
|
1675
1728
|
|
|
1676
1729
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerhealthcheck.html#cfn-gamelift-containergroupdefinition-containerhealthcheck-timeout
|
|
1677
1730
|
'''
|
|
@@ -1706,11 +1759,15 @@ class CfnContainerGroupDefinition(
|
|
|
1706
1759
|
protocol: builtins.str,
|
|
1707
1760
|
to_port: jsii.Number,
|
|
1708
1761
|
) -> None:
|
|
1709
|
-
'''
|
|
1762
|
+
'''*This data type is used with the Amazon GameLift containers feature, which is currently in public preview.*.
|
|
1763
|
+
|
|
1764
|
+
A set of one or more port numbers that can be opened on the container.
|
|
1765
|
+
|
|
1766
|
+
*Part of:* ``ContainerPortConfiguration``
|
|
1710
1767
|
|
|
1711
1768
|
:param from_port: A starting value for the range of allowed port numbers.
|
|
1712
|
-
:param protocol:
|
|
1713
|
-
:param to_port: An ending value for the range of allowed port numbers. Port numbers are end-inclusive. This value must be equal to or greater than FromPort.
|
|
1769
|
+
:param protocol: The network protocol that these ports support.
|
|
1770
|
+
:param to_port: An ending value for the range of allowed port numbers. Port numbers are end-inclusive. This value must be equal to or greater than ``FromPort`` .
|
|
1714
1771
|
|
|
1715
1772
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerportrange.html
|
|
1716
1773
|
:exampleMetadata: fixture=_generated
|
|
@@ -1750,7 +1807,7 @@ class CfnContainerGroupDefinition(
|
|
|
1750
1807
|
|
|
1751
1808
|
@builtins.property
|
|
1752
1809
|
def protocol(self) -> builtins.str:
|
|
1753
|
-
'''
|
|
1810
|
+
'''The network protocol that these ports support.
|
|
1754
1811
|
|
|
1755
1812
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerportrange.html#cfn-gamelift-containergroupdefinition-containerportrange-protocol
|
|
1756
1813
|
'''
|
|
@@ -1762,7 +1819,7 @@ class CfnContainerGroupDefinition(
|
|
|
1762
1819
|
def to_port(self) -> jsii.Number:
|
|
1763
1820
|
'''An ending value for the range of allowed port numbers.
|
|
1764
1821
|
|
|
1765
|
-
Port numbers are end-inclusive. This value must be equal to or greater than FromPort.
|
|
1822
|
+
Port numbers are end-inclusive. This value must be equal to or greater than ``FromPort`` .
|
|
1766
1823
|
|
|
1767
1824
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerportrange.html#cfn-gamelift-containergroupdefinition-containerportrange-toport
|
|
1768
1825
|
'''
|
|
@@ -1941,12 +1998,12 @@ class CfnContainerGroupDefinitionProps:
|
|
|
1941
1998
|
) -> None:
|
|
1942
1999
|
'''Properties for defining a ``CfnContainerGroupDefinition``.
|
|
1943
2000
|
|
|
1944
|
-
:param container_definitions:
|
|
1945
|
-
:param name: A descriptive
|
|
1946
|
-
:param operating_system: The
|
|
1947
|
-
:param total_cpu_limit: The
|
|
1948
|
-
:param total_memory_limit: The
|
|
1949
|
-
:param scheduling_strategy:
|
|
2001
|
+
:param container_definitions: The set of container definitions that are included in the container group.
|
|
2002
|
+
:param name: A descriptive identifier for the container group definition. The name value is unique in an AWS Region.
|
|
2003
|
+
:param operating_system: The platform required for all containers in the container group definition.
|
|
2004
|
+
:param total_cpu_limit: The amount of CPU units on a fleet instance to allocate for the container group. All containers in the group share these resources. This property is an integer value in CPU units (1 vCPU is equal to 1024 CPU units). You can set additional limits for each ``ContainerDefinition`` in the group. If individual containers have limits, this value must be equal to or greater than the sum of all container-specific CPU limits in the group. For more details on memory allocation, see the `Container fleet design guide <https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-design-fleet>`_ .
|
|
2005
|
+
:param total_memory_limit: The amount of memory (in MiB) on a fleet instance to allocate for the container group. All containers in the group share these resources. You can set additional limits for each ``ContainerDefinition`` in the group. If individual containers have limits, this value must meet the following requirements: - Equal to or greater than the sum of all container-specific soft memory limits in the group. - Equal to or greater than any container-specific hard limits in the group. For more details on memory allocation, see the `Container fleet design guide <https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-design-fleet>`_ .
|
|
2006
|
+
:param scheduling_strategy: The method for deploying the container group across fleet instances. A replica container group might have multiple copies on each fleet instance. A daemon container group maintains only one copy per fleet instance.
|
|
1950
2007
|
:param tags: An array of key-value pairs to apply to this resource.
|
|
1951
2008
|
|
|
1952
2009
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html
|
|
@@ -2037,7 +2094,7 @@ class CfnContainerGroupDefinitionProps:
|
|
|
2037
2094
|
def container_definitions(
|
|
2038
2095
|
self,
|
|
2039
2096
|
) -> typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, CfnContainerGroupDefinition.ContainerDefinitionProperty]]]:
|
|
2040
|
-
'''
|
|
2097
|
+
'''The set of container definitions that are included in the container group.
|
|
2041
2098
|
|
|
2042
2099
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-containerdefinitions
|
|
2043
2100
|
'''
|
|
@@ -2047,7 +2104,9 @@ class CfnContainerGroupDefinitionProps:
|
|
|
2047
2104
|
|
|
2048
2105
|
@builtins.property
|
|
2049
2106
|
def name(self) -> builtins.str:
|
|
2050
|
-
'''A descriptive
|
|
2107
|
+
'''A descriptive identifier for the container group definition.
|
|
2108
|
+
|
|
2109
|
+
The name value is unique in an AWS Region.
|
|
2051
2110
|
|
|
2052
2111
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-name
|
|
2053
2112
|
'''
|
|
@@ -2057,7 +2116,7 @@ class CfnContainerGroupDefinitionProps:
|
|
|
2057
2116
|
|
|
2058
2117
|
@builtins.property
|
|
2059
2118
|
def operating_system(self) -> builtins.str:
|
|
2060
|
-
'''The
|
|
2119
|
+
'''The platform required for all containers in the container group definition.
|
|
2061
2120
|
|
|
2062
2121
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-operatingsystem
|
|
2063
2122
|
'''
|
|
@@ -2067,9 +2126,13 @@ class CfnContainerGroupDefinitionProps:
|
|
|
2067
2126
|
|
|
2068
2127
|
@builtins.property
|
|
2069
2128
|
def total_cpu_limit(self) -> jsii.Number:
|
|
2070
|
-
'''The
|
|
2129
|
+
'''The amount of CPU units on a fleet instance to allocate for the container group.
|
|
2130
|
+
|
|
2131
|
+
All containers in the group share these resources. This property is an integer value in CPU units (1 vCPU is equal to 1024 CPU units).
|
|
2071
2132
|
|
|
2072
|
-
|
|
2133
|
+
You can set additional limits for each ``ContainerDefinition`` in the group. If individual containers have limits, this value must be equal to or greater than the sum of all container-specific CPU limits in the group.
|
|
2134
|
+
|
|
2135
|
+
For more details on memory allocation, see the `Container fleet design guide <https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-design-fleet>`_ .
|
|
2073
2136
|
|
|
2074
2137
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-totalcpulimit
|
|
2075
2138
|
'''
|
|
@@ -2079,7 +2142,16 @@ class CfnContainerGroupDefinitionProps:
|
|
|
2079
2142
|
|
|
2080
2143
|
@builtins.property
|
|
2081
2144
|
def total_memory_limit(self) -> jsii.Number:
|
|
2082
|
-
'''The
|
|
2145
|
+
'''The amount of memory (in MiB) on a fleet instance to allocate for the container group.
|
|
2146
|
+
|
|
2147
|
+
All containers in the group share these resources.
|
|
2148
|
+
|
|
2149
|
+
You can set additional limits for each ``ContainerDefinition`` in the group. If individual containers have limits, this value must meet the following requirements:
|
|
2150
|
+
|
|
2151
|
+
- Equal to or greater than the sum of all container-specific soft memory limits in the group.
|
|
2152
|
+
- Equal to or greater than any container-specific hard limits in the group.
|
|
2153
|
+
|
|
2154
|
+
For more details on memory allocation, see the `Container fleet design guide <https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-design-fleet>`_ .
|
|
2083
2155
|
|
|
2084
2156
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-totalmemorylimit
|
|
2085
2157
|
'''
|
|
@@ -2089,7 +2161,9 @@ class CfnContainerGroupDefinitionProps:
|
|
|
2089
2161
|
|
|
2090
2162
|
@builtins.property
|
|
2091
2163
|
def scheduling_strategy(self) -> typing.Optional[builtins.str]:
|
|
2092
|
-
'''
|
|
2164
|
+
'''The method for deploying the container group across fleet instances.
|
|
2165
|
+
|
|
2166
|
+
A replica container group might have multiple copies on each fleet instance. A daemon container group maintains only one copy per fleet instance.
|
|
2093
2167
|
|
|
2094
2168
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-schedulingstrategy
|
|
2095
2169
|
'''
|
|
@@ -2270,19 +2344,19 @@ class CfnFleet(
|
|
|
2270
2344
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
2271
2345
|
:param name: A descriptive label that is associated with a fleet. Fleet names do not need to be unique.
|
|
2272
2346
|
:param anywhere_configuration: Amazon GameLift Anywhere configuration options.
|
|
2273
|
-
:param apply_capacity: Current resource capacity settings
|
|
2347
|
+
:param apply_capacity: Current resource capacity settings for managed EC2 fleets and container fleets. For multi-location fleets, location values might refer to a fleet's remote location or its home Region. *Returned by:* `DescribeFleetCapacity <https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetCapacity.html>`_ , `DescribeFleetLocationCapacity <https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetLocationCapacity.html>`_ , `UpdateFleetCapacity <https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateFleetCapacity.html>`_
|
|
2274
2348
|
:param build_id: A unique identifier for a build to be deployed on the new fleet. If you are deploying the fleet with a custom game build, you must specify this property. The build must have been successfully uploaded to Amazon GameLift and be in a ``READY`` status. This fleet setting cannot be changed once the fleet is created.
|
|
2275
2349
|
:param certificate_configuration: Prompts Amazon GameLift to generate a TLS/SSL certificate for the fleet. Amazon GameLift uses the certificates to encrypt traffic between game clients and the game servers running on Amazon GameLift. By default, the ``CertificateConfiguration`` is ``DISABLED`` . You can't change this property after you create the fleet. AWS Certificate Manager (ACM) certificates expire after 13 months. Certificate expiration can cause fleets to fail, preventing players from connecting to instances in the fleet. We recommend you replace fleets before 13 months, consider using fleet aliases for a smooth transition. .. epigraph:: ACM isn't available in all AWS regions. A fleet creation request with certificate generation enabled in an unsupported Region, fails with a 4xx error. For more information about the supported Regions, see `Supported Regions <https://docs.aws.amazon.com/acm/latest/userguide/acm-regions.html>`_ in the *AWS Certificate Manager User Guide* .
|
|
2276
|
-
:param compute_type: The type of compute resource used to host your game servers.
|
|
2277
|
-
:param container_groups_configuration:
|
|
2350
|
+
:param compute_type: The type of compute resource used to host your game servers. - ``EC2`` – The game server build is deployed to Amazon EC2 instances for cloud hosting. This is the default setting. - ``CONTAINER`` – Container images with your game server build and supporting software are deployed to Amazon EC2 instances for cloud hosting. With this compute type, you must specify the ``ContainerGroupsConfiguration`` parameter. - ``ANYWHERE`` – Game servers or container images with your game server and supporting software are deployed to compute resources that are provided and managed by you. With this compute type, you can also set the ``AnywhereConfiguration`` parameter.
|
|
2351
|
+
:param container_groups_configuration: *This data type is used with the Amazon GameLift containers feature, which is currently in public preview.*. Configuration details for a set of container groups, for use when creating a fleet with compute type ``CONTAINER`` . *Used with:* ``CreateFleet``
|
|
2278
2352
|
:param description: A description for the fleet.
|
|
2279
2353
|
:param desired_ec2_instances: The number of EC2 instances that you want this fleet to host. When creating a new fleet, GameLift automatically sets this value to "1" and initiates a single instance. Once the fleet is active, update this value to trigger GameLift to add or remove instances from the fleet.
|
|
2280
|
-
:param ec2_inbound_permissions: The
|
|
2281
|
-
:param ec2_instance_type: The Amazon GameLift-supported Amazon EC2 instance type to use
|
|
2354
|
+
:param ec2_inbound_permissions: The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet. Set this parameter for EC2 and container fleets. You can leave this parameter empty when creating the fleet, but you must call ``UpdateFleetPortSettings`` to set it before players can connect to game sessions. As a best practice, we recommend opening ports for remote access only when you need them and closing them when you're finished. For Realtime Servers fleets, Amazon GameLift automatically sets TCP and UDP ranges. To manage inbound access for a container fleet, set this parameter to the same port numbers that you set for the fleet's connection port range. During the life of the fleet, update this parameter to control which connection ports are open to inbound traffic.
|
|
2355
|
+
:param ec2_instance_type: The Amazon GameLift-supported Amazon EC2 instance type to use with EC2 and container fleets. Instance type determines the computing resources that will be used to host your game servers, including CPU, memory, storage, and networking capacity. See `Amazon Elastic Compute Cloud Instance Types <https://docs.aws.amazon.com/ec2/instance-types/>`_ for detailed descriptions of Amazon EC2 instance types.
|
|
2282
2356
|
:param fleet_type: Indicates whether to use On-Demand or Spot instances for this fleet. By default, this property is set to ``ON_DEMAND`` . Learn more about when to use `On-Demand versus Spot Instances <https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-ec2-instances.html#gamelift-ec2-instances-spot>`_ . This fleet property can't be changed after the fleet is created.
|
|
2283
|
-
:param instance_role_arn: A unique identifier for an IAM role with access permissions to other AWS services. Any application that runs on an instance in the fleet--including install scripts, server processes, and other processes--can use these permissions to interact with AWS resources that you own or have access to. For more information about using the role with your game server builds, see `Communicate with other AWS resources from your fleets <https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html>`_ .
|
|
2284
|
-
:param instance_role_credentials_provider: Indicates that fleet instances maintain a shared credentials file for the IAM role defined in ``InstanceRoleArn`` . Shared credentials allow applications that are deployed with the game server executable to communicate with other AWS resources. This property is used only when the game server is integrated with the server SDK version 5.x. For more information about using shared credentials, see `Communicate with other AWS resources from your fleets <https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html>`_ .
|
|
2285
|
-
:param locations: A set of remote locations to deploy additional instances to and manage as part of the fleet. This parameter can only be used when creating fleets in AWS Regions that support multiple locations. You can add any Amazon GameLift-supported AWS Region as a remote location, in the form of an AWS Region code such as ``us-west-2`` . To create a fleet with instances in the home Region only, don't
|
|
2357
|
+
:param instance_role_arn: A unique identifier for an IAM role with access permissions to other AWS services. Any application that runs on an instance in the fleet--including install scripts, server processes, and other processes--can use these permissions to interact with AWS resources that you own or have access to. For more information about using the role with your game server builds, see `Communicate with other AWS resources from your fleets <https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html>`_ . This attribute is used with fleets where ``ComputeType`` is "EC2" or "Container".
|
|
2358
|
+
:param instance_role_credentials_provider: Indicates that fleet instances maintain a shared credentials file for the IAM role defined in ``InstanceRoleArn`` . Shared credentials allow applications that are deployed with the game server executable to communicate with other AWS resources. This property is used only when the game server is integrated with the server SDK version 5.x. For more information about using shared credentials, see `Communicate with other AWS resources from your fleets <https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html>`_ . This attribute is used with fleets where ``ComputeType`` is "EC2" or "Container".
|
|
2359
|
+
:param locations: A set of remote locations to deploy additional instances to and manage as part of the fleet. This parameter can only be used when creating fleets in AWS Regions that support multiple locations. You can add any Amazon GameLift-supported AWS Region as a remote location, in the form of an AWS Region code, such as ``us-west-2`` or Local Zone code. To create a fleet with instances in the home Region only, don't set this parameter. When using this parameter, Amazon GameLift requires you to include your home location in the request.
|
|
2286
2360
|
:param log_paths: (deprecated) This parameter is no longer used. When hosting a custom game build, specify where Amazon GameLift should store log files using the Amazon GameLift server API call ProcessReady()
|
|
2287
2361
|
:param max_size: The maximum number of instances that are allowed in the specified fleet location. If this parameter is not set, the default is 1.
|
|
2288
2362
|
:param metric_groups: The name of an AWS CloudWatch metric group to add this fleet to. A metric group is used to aggregate the metrics for multiple fleets. You can specify an existing metric group name or set a new name to create a new metric group. A fleet can be included in only one metric group at a time.
|
|
@@ -2369,7 +2443,7 @@ class CfnFleet(
|
|
|
2369
2443
|
def attr_container_groups_configuration_container_groups_per_instance_max_replica_container_groups_per_instance(
|
|
2370
2444
|
self,
|
|
2371
2445
|
) -> jsii.Number:
|
|
2372
|
-
'''
|
|
2446
|
+
'''The maximum possible number of replica container groups that each fleet instance can have.
|
|
2373
2447
|
|
|
2374
2448
|
:cloudformationAttribute: ContainerGroupsConfiguration.ContainerGroupsPerInstance.MaxReplicaContainerGroupsPerInstance
|
|
2375
2449
|
'''
|
|
@@ -2423,7 +2497,7 @@ class CfnFleet(
|
|
|
2423
2497
|
@builtins.property
|
|
2424
2498
|
@jsii.member(jsii_name="applyCapacity")
|
|
2425
2499
|
def apply_capacity(self) -> typing.Optional[builtins.str]:
|
|
2426
|
-
'''Current resource capacity settings
|
|
2500
|
+
'''Current resource capacity settings for managed EC2 fleets and container fleets.'''
|
|
2427
2501
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "applyCapacity"))
|
|
2428
2502
|
|
|
2429
2503
|
@apply_capacity.setter
|
|
@@ -2482,7 +2556,7 @@ class CfnFleet(
|
|
|
2482
2556
|
def container_groups_configuration(
|
|
2483
2557
|
self,
|
|
2484
2558
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnFleet.ContainerGroupsConfigurationProperty"]]:
|
|
2485
|
-
'''
|
|
2559
|
+
'''*This data type is used with the Amazon GameLift containers feature, which is currently in public preview.*.'''
|
|
2486
2560
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnFleet.ContainerGroupsConfigurationProperty"]], jsii.get(self, "containerGroupsConfiguration"))
|
|
2487
2561
|
|
|
2488
2562
|
@container_groups_configuration.setter
|
|
@@ -2526,7 +2600,7 @@ class CfnFleet(
|
|
|
2526
2600
|
def ec2_inbound_permissions(
|
|
2527
2601
|
self,
|
|
2528
2602
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnFleet.IpPermissionProperty"]]]]:
|
|
2529
|
-
'''The
|
|
2603
|
+
'''The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet.'''
|
|
2530
2604
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnFleet.IpPermissionProperty"]]]], jsii.get(self, "ec2InboundPermissions"))
|
|
2531
2605
|
|
|
2532
2606
|
@ec2_inbound_permissions.setter
|
|
@@ -2542,7 +2616,7 @@ class CfnFleet(
|
|
|
2542
2616
|
@builtins.property
|
|
2543
2617
|
@jsii.member(jsii_name="ec2InstanceType")
|
|
2544
2618
|
def ec2_instance_type(self) -> typing.Optional[builtins.str]:
|
|
2545
|
-
'''The Amazon GameLift-supported Amazon EC2 instance type to use
|
|
2619
|
+
'''The Amazon GameLift-supported Amazon EC2 instance type to use with EC2 and container fleets.'''
|
|
2546
2620
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "ec2InstanceType"))
|
|
2547
2621
|
|
|
2548
2622
|
@ec2_instance_type.setter
|
|
@@ -2821,7 +2895,7 @@ class CfnFleet(
|
|
|
2821
2895
|
)
|
|
2822
2896
|
class AnywhereConfigurationProperty:
|
|
2823
2897
|
def __init__(self, *, cost: builtins.str) -> None:
|
|
2824
|
-
'''Amazon GameLift
|
|
2898
|
+
'''Amazon GameLift configuration options for your Anywhere fleets.
|
|
2825
2899
|
|
|
2826
2900
|
:param cost: The cost to run your fleet per hour. Amazon GameLift uses the provided cost of your fleet to balance usage in queues. For more information about queues, see `Setting up queues <https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-intro.html>`_ in the *Amazon GameLift Developer Guide* .
|
|
2827
2901
|
|
|
@@ -2934,10 +3008,14 @@ class CfnFleet(
|
|
|
2934
3008
|
)
|
|
2935
3009
|
class ConnectionPortRangeProperty:
|
|
2936
3010
|
def __init__(self, *, from_port: jsii.Number, to_port: jsii.Number) -> None:
|
|
2937
|
-
'''
|
|
3011
|
+
'''*This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.*.
|
|
2938
3012
|
|
|
2939
|
-
|
|
2940
|
-
|
|
3013
|
+
The set of port numbers to open on each instance in a container fleet. Connection ports are used by inbound traffic to connect with processes that are running in containers on the fleet.
|
|
3014
|
+
|
|
3015
|
+
*Part of:* ``ContainerGroupsConfiguration`` , ``ContainerGroupsAttributes``
|
|
3016
|
+
|
|
3017
|
+
:param from_port: Starting value for the port range.
|
|
3018
|
+
:param to_port: Ending value for the port. Port numbers are end-inclusive. This value must be equal to or greater than ``FromPort`` .
|
|
2941
3019
|
|
|
2942
3020
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-connectionportrange.html
|
|
2943
3021
|
:exampleMetadata: fixture=_generated
|
|
@@ -2964,7 +3042,7 @@ class CfnFleet(
|
|
|
2964
3042
|
|
|
2965
3043
|
@builtins.property
|
|
2966
3044
|
def from_port(self) -> jsii.Number:
|
|
2967
|
-
'''
|
|
3045
|
+
'''Starting value for the port range.
|
|
2968
3046
|
|
|
2969
3047
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-connectionportrange.html#cfn-gamelift-fleet-connectionportrange-fromport
|
|
2970
3048
|
'''
|
|
@@ -2974,9 +3052,9 @@ class CfnFleet(
|
|
|
2974
3052
|
|
|
2975
3053
|
@builtins.property
|
|
2976
3054
|
def to_port(self) -> jsii.Number:
|
|
2977
|
-
'''
|
|
3055
|
+
'''Ending value for the port.
|
|
2978
3056
|
|
|
2979
|
-
Port numbers are end-inclusive. This value must be
|
|
3057
|
+
Port numbers are end-inclusive. This value must be equal to or greater than ``FromPort`` .
|
|
2980
3058
|
|
|
2981
3059
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-connectionportrange.html#cfn-gamelift-fleet-connectionportrange-toport
|
|
2982
3060
|
'''
|
|
@@ -3012,12 +3090,14 @@ class CfnFleet(
|
|
|
3012
3090
|
container_group_definition_names: typing.Sequence[builtins.str],
|
|
3013
3091
|
container_groups_per_instance: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnFleet.ContainerGroupsPerInstanceProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
3014
3092
|
) -> None:
|
|
3015
|
-
'''
|
|
3093
|
+
'''*This data type is used with the Amazon GameLift containers feature, which is currently in public preview.*.
|
|
3094
|
+
|
|
3095
|
+
Configuration details for a set of container groups, for use when creating a fleet with compute type ``CONTAINER`` .
|
|
3016
3096
|
|
|
3017
|
-
|
|
3097
|
+
*Used with:* ``CreateFleet``
|
|
3018
3098
|
|
|
3019
|
-
:param connection_port_range:
|
|
3020
|
-
:param container_group_definition_names: The
|
|
3099
|
+
:param connection_port_range: A set of ports to allow inbound traffic, including game clients, to connect to processes running in the container fleet. Connection ports are dynamically mapped to container ports, which are assigned to individual processes running in a container. The connection port range must have enough ports to map to all container ports across a fleet instance. To calculate the minimum connection ports needed, use the following formula: *[Total number of container ports as defined for containers in the replica container group] * [Desired or calculated number of replica container groups per instance] + [Total number of container ports as defined for containers in the daemon container group]* As a best practice, double the minimum number of connection ports. .. epigraph:: Use the fleet's ``EC2InboundPermissions`` property to control external access to connection ports. Set this property to the connection port numbers that you want to open access to. See ``IpPermission`` for more details.
|
|
3100
|
+
:param container_group_definition_names: The list of container group definition names to deploy to a new container fleet.
|
|
3021
3101
|
:param container_groups_per_instance: The number of container groups per instance.
|
|
3022
3102
|
|
|
3023
3103
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-containergroupsconfiguration.html
|
|
@@ -3059,7 +3139,16 @@ class CfnFleet(
|
|
|
3059
3139
|
def connection_port_range(
|
|
3060
3140
|
self,
|
|
3061
3141
|
) -> typing.Union[_IResolvable_da3f097b, "CfnFleet.ConnectionPortRangeProperty"]:
|
|
3062
|
-
'''
|
|
3142
|
+
'''A set of ports to allow inbound traffic, including game clients, to connect to processes running in the container fleet.
|
|
3143
|
+
|
|
3144
|
+
Connection ports are dynamically mapped to container ports, which are assigned to individual processes running in a container. The connection port range must have enough ports to map to all container ports across a fleet instance. To calculate the minimum connection ports needed, use the following formula:
|
|
3145
|
+
|
|
3146
|
+
*[Total number of container ports as defined for containers in the replica container group] * [Desired or calculated number of replica container groups per instance] + [Total number of container ports as defined for containers in the daemon container group]*
|
|
3147
|
+
|
|
3148
|
+
As a best practice, double the minimum number of connection ports.
|
|
3149
|
+
.. epigraph::
|
|
3150
|
+
|
|
3151
|
+
Use the fleet's ``EC2InboundPermissions`` property to control external access to connection ports. Set this property to the connection port numbers that you want to open access to. See ``IpPermission`` for more details.
|
|
3063
3152
|
|
|
3064
3153
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-containergroupsconfiguration.html#cfn-gamelift-fleet-containergroupsconfiguration-connectionportrange
|
|
3065
3154
|
'''
|
|
@@ -3069,9 +3158,7 @@ class CfnFleet(
|
|
|
3069
3158
|
|
|
3070
3159
|
@builtins.property
|
|
3071
3160
|
def container_group_definition_names(self) -> typing.List[builtins.str]:
|
|
3072
|
-
'''The
|
|
3073
|
-
|
|
3074
|
-
You must specify exactly one REPLICA container group. You have the option to also specify one DAEMON container group.
|
|
3161
|
+
'''The list of container group definition names to deploy to a new container fleet.
|
|
3075
3162
|
|
|
3076
3163
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-containergroupsconfiguration.html#cfn-gamelift-fleet-containergroupsconfiguration-containergroupdefinitionnames
|
|
3077
3164
|
'''
|
|
@@ -3116,10 +3203,22 @@ class CfnFleet(
|
|
|
3116
3203
|
desired_replica_container_groups_per_instance: typing.Optional[jsii.Number] = None,
|
|
3117
3204
|
max_replica_container_groups_per_instance: typing.Optional[jsii.Number] = None,
|
|
3118
3205
|
) -> None:
|
|
3119
|
-
'''
|
|
3206
|
+
'''*This data type is used with the Amazon GameLift containers feature, which is currently in public preview.*.
|
|
3207
|
+
|
|
3208
|
+
Determines how many replica container groups that Amazon GameLift deploys to each instance in a container fleet.
|
|
3209
|
+
|
|
3210
|
+
Amazon GameLift calculates the maximum possible replica groups per instance based on the instance 's CPU and memory resources. When deploying a fleet, Amazon GameLift places replica container groups on each fleet instance based on the following:
|
|
3211
|
+
|
|
3212
|
+
- If no desired value is set, Amazon GameLift places the calculated maximum.
|
|
3213
|
+
- If a desired number is set to a value higher than the calculated maximum, fleet creation fails..
|
|
3214
|
+
- If a desired number is set to a value lower than the calculated maximum, Amazon GameLift places the desired number.
|
|
3120
3215
|
|
|
3121
|
-
|
|
3122
|
-
|
|
3216
|
+
*Part of:* ``ContainerGroupsConfiguration`` , ``ContainerGroupsAttributes``
|
|
3217
|
+
|
|
3218
|
+
*Returned by:* ``DescribeFleetAttributes`` , ``CreateFleet``
|
|
3219
|
+
|
|
3220
|
+
:param desired_replica_container_groups_per_instance: The desired number of replica container groups to place on each fleet instance.
|
|
3221
|
+
:param max_replica_container_groups_per_instance: The maximum possible number of replica container groups that each fleet instance can have.
|
|
3123
3222
|
|
|
3124
3223
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-containergroupsperinstance.html
|
|
3125
3224
|
:exampleMetadata: fixture=_generated
|
|
@@ -3149,7 +3248,7 @@ class CfnFleet(
|
|
|
3149
3248
|
def desired_replica_container_groups_per_instance(
|
|
3150
3249
|
self,
|
|
3151
3250
|
) -> typing.Optional[jsii.Number]:
|
|
3152
|
-
'''
|
|
3251
|
+
'''The desired number of replica container groups to place on each fleet instance.
|
|
3153
3252
|
|
|
3154
3253
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-containergroupsperinstance.html#cfn-gamelift-fleet-containergroupsperinstance-desiredreplicacontainergroupsperinstance
|
|
3155
3254
|
'''
|
|
@@ -3160,7 +3259,7 @@ class CfnFleet(
|
|
|
3160
3259
|
def max_replica_container_groups_per_instance(
|
|
3161
3260
|
self,
|
|
3162
3261
|
) -> typing.Optional[jsii.Number]:
|
|
3163
|
-
'''
|
|
3262
|
+
'''The maximum possible number of replica container groups that each fleet instance can have.
|
|
3164
3263
|
|
|
3165
3264
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-containergroupsperinstance.html#cfn-gamelift-fleet-containergroupsperinstance-maxreplicacontainergroupsperinstance
|
|
3166
3265
|
'''
|
|
@@ -3315,13 +3414,11 @@ class CfnFleet(
|
|
|
3315
3414
|
max_size: jsii.Number,
|
|
3316
3415
|
min_size: jsii.Number,
|
|
3317
3416
|
) -> None:
|
|
3318
|
-
'''Current resource capacity settings
|
|
3417
|
+
'''Current resource capacity settings for managed EC2 fleets and container fleets.
|
|
3319
3418
|
|
|
3320
|
-
|
|
3419
|
+
For multi-location fleets, location values might refer to a fleet's remote location or its home Region.
|
|
3321
3420
|
|
|
3322
|
-
*
|
|
3323
|
-
|
|
3324
|
-
`DescribeFleetCapacity <https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetCapacity.html>`_ | `DescribeFleetLocationCapacity <https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetLocationCapacity.html>`_ | `UpdateFleetCapacity <https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateFleetCapacity.html>`_
|
|
3421
|
+
*Returned by:* `DescribeFleetCapacity <https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetCapacity.html>`_ , `DescribeFleetLocationCapacity <https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetLocationCapacity.html>`_ , `UpdateFleetCapacity <https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateFleetCapacity.html>`_
|
|
3325
3422
|
|
|
3326
3423
|
:param desired_ec2_instances: The number of Amazon EC2 instances you want to maintain in the specified fleet location. This value must fall between the minimum and maximum size limits. Changes in desired instance value can take up to 1 minute to be reflected when viewing the fleet's capacity settings.
|
|
3327
3424
|
:param max_size: The maximum number of instances that are allowed in the specified fleet location. If this parameter is not set, the default is 1.
|
|
@@ -3412,10 +3509,12 @@ class CfnFleet(
|
|
|
3412
3509
|
location: builtins.str,
|
|
3413
3510
|
location_capacity: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnFleet.LocationCapacityProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
3414
3511
|
) -> None:
|
|
3415
|
-
'''
|
|
3512
|
+
'''*This data type has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.*.
|
|
3513
|
+
|
|
3514
|
+
A remote location where a multi-location fleet can deploy game servers for game hosting.
|
|
3416
3515
|
|
|
3417
3516
|
:param location: An AWS Region code, such as ``us-west-2`` .
|
|
3418
|
-
:param location_capacity: Current resource capacity settings
|
|
3517
|
+
:param location_capacity: Current resource capacity settings for managed EC2 fleets and container fleets. For multi-location fleets, location values might refer to a fleet's remote location or its home Region. *Returned by:* `DescribeFleetCapacity <https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetCapacity.html>`_ , `DescribeFleetLocationCapacity <https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetLocationCapacity.html>`_ , `UpdateFleetCapacity <https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateFleetCapacity.html>`_
|
|
3419
3518
|
|
|
3420
3519
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-locationconfiguration.html
|
|
3421
3520
|
:exampleMetadata: fixture=_generated
|
|
@@ -3461,13 +3560,11 @@ class CfnFleet(
|
|
|
3461
3560
|
def location_capacity(
|
|
3462
3561
|
self,
|
|
3463
3562
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnFleet.LocationCapacityProperty"]]:
|
|
3464
|
-
'''Current resource capacity settings
|
|
3563
|
+
'''Current resource capacity settings for managed EC2 fleets and container fleets.
|
|
3465
3564
|
|
|
3466
|
-
|
|
3565
|
+
For multi-location fleets, location values might refer to a fleet's remote location or its home Region.
|
|
3467
3566
|
|
|
3468
|
-
*
|
|
3469
|
-
|
|
3470
|
-
`DescribeFleetCapacity <https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetCapacity.html>`_ | `DescribeFleetLocationCapacity <https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetLocationCapacity.html>`_ | `UpdateFleetCapacity <https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateFleetCapacity.html>`_
|
|
3567
|
+
*Returned by:* `DescribeFleetCapacity <https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetCapacity.html>`_ , `DescribeFleetLocationCapacity <https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetLocationCapacity.html>`_ , `UpdateFleetCapacity <https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateFleetCapacity.html>`_
|
|
3471
3568
|
|
|
3472
3569
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-locationconfiguration.html#cfn-gamelift-fleet-locationconfiguration-locationcapacity
|
|
3473
3570
|
'''
|
|
@@ -3590,8 +3687,8 @@ class CfnFleet(
|
|
|
3590
3687
|
A GameLift instance is limited to 50 processes running concurrently. To calculate the total number of processes in a runtime configuration, add the values of the ``ConcurrentExecutions`` parameter for each ServerProcess. Learn more about `Running Multiple Processes on a Fleet <https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-multiprocess.html>`_ .
|
|
3591
3688
|
|
|
3592
3689
|
:param game_session_activation_timeout_seconds: The maximum amount of time (in seconds) allowed to launch a new game session and have it report ready to host players. During this time, the game session is in status ``ACTIVATING`` . If the game session does not become active before the timeout, it is ended and the game session status is changed to ``TERMINATED`` .
|
|
3593
|
-
:param max_concurrent_game_session_activations: The number of game sessions in status ``ACTIVATING`` to allow on an instance. This setting limits the instance resources that can be used for new game activations at any one time.
|
|
3594
|
-
:param server_processes: A collection of server process configurations that identify what server processes to run on
|
|
3690
|
+
:param max_concurrent_game_session_activations: The number of game sessions in status ``ACTIVATING`` to allow on an instance or container. This setting limits the instance resources that can be used for new game activations at any one time.
|
|
3691
|
+
:param server_processes: A collection of server process configurations that identify what server processes to run on fleet computes.
|
|
3595
3692
|
|
|
3596
3693
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-runtimeconfiguration.html
|
|
3597
3694
|
:exampleMetadata: fixture=_generated
|
|
@@ -3644,7 +3741,7 @@ class CfnFleet(
|
|
|
3644
3741
|
def max_concurrent_game_session_activations(
|
|
3645
3742
|
self,
|
|
3646
3743
|
) -> typing.Optional[jsii.Number]:
|
|
3647
|
-
'''The number of game sessions in status ``ACTIVATING`` to allow on an instance.
|
|
3744
|
+
'''The number of game sessions in status ``ACTIVATING`` to allow on an instance or container.
|
|
3648
3745
|
|
|
3649
3746
|
This setting limits the instance resources that can be used for new game activations at any one time.
|
|
3650
3747
|
|
|
@@ -3657,7 +3754,7 @@ class CfnFleet(
|
|
|
3657
3754
|
def server_processes(
|
|
3658
3755
|
self,
|
|
3659
3756
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnFleet.ServerProcessProperty"]]]]:
|
|
3660
|
-
'''A collection of server process configurations that identify what server processes to run on
|
|
3757
|
+
'''A collection of server process configurations that identify what server processes to run on fleet computes.
|
|
3661
3758
|
|
|
3662
3759
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-runtimeconfiguration.html#cfn-gamelift-fleet-runtimeconfiguration-serverprocesses
|
|
3663
3760
|
'''
|
|
@@ -3972,7 +4069,7 @@ class CfnFleet(
|
|
|
3972
4069
|
|
|
3973
4070
|
Server processes run either an executable in a custom game build or a Realtime Servers script.
|
|
3974
4071
|
|
|
3975
|
-
:param concurrent_executions: The number of server processes using this configuration that run concurrently on each instance
|
|
4072
|
+
:param concurrent_executions: The number of server processes using this configuration that run concurrently on each instance or container..
|
|
3976
4073
|
:param launch_path: The location of a game build executable or Realtime script. Game builds and Realtime scripts are installed on instances at the root: - Windows (custom game builds only): ``C:\\game`` . Example: " ``C:\\game\\MyGame\\server.exe`` " - Linux: ``/local/game`` . Examples: " ``/local/game/MyGame/server.exe`` " or " ``/local/game/MyRealtimeScript.js`` " .. epigraph:: Amazon GameLift doesn't support the use of setup scripts that launch the game executable. For custom game builds, this parameter must indicate the executable that calls the server SDK operations ``initSDK()`` and ``ProcessReady()`` .
|
|
3977
4074
|
:param parameters: An optional list of parameters to pass to the server executable or Realtime script on launch. Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: [A-Za-z0-9_:.+/\\- =@{},?'[]"]+
|
|
3978
4075
|
|
|
@@ -4007,7 +4104,7 @@ class CfnFleet(
|
|
|
4007
4104
|
|
|
4008
4105
|
@builtins.property
|
|
4009
4106
|
def concurrent_executions(self) -> jsii.Number:
|
|
4010
|
-
'''The number of server processes using this configuration that run concurrently on each instance
|
|
4107
|
+
'''The number of server processes using this configuration that run concurrently on each instance or container..
|
|
4011
4108
|
|
|
4012
4109
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-serverprocess.html#cfn-gamelift-fleet-serverprocess-concurrentexecutions
|
|
4013
4110
|
'''
|
|
@@ -4186,19 +4283,19 @@ class CfnFleetProps:
|
|
|
4186
4283
|
|
|
4187
4284
|
:param name: A descriptive label that is associated with a fleet. Fleet names do not need to be unique.
|
|
4188
4285
|
:param anywhere_configuration: Amazon GameLift Anywhere configuration options.
|
|
4189
|
-
:param apply_capacity: Current resource capacity settings
|
|
4286
|
+
:param apply_capacity: Current resource capacity settings for managed EC2 fleets and container fleets. For multi-location fleets, location values might refer to a fleet's remote location or its home Region. *Returned by:* `DescribeFleetCapacity <https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetCapacity.html>`_ , `DescribeFleetLocationCapacity <https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetLocationCapacity.html>`_ , `UpdateFleetCapacity <https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateFleetCapacity.html>`_
|
|
4190
4287
|
:param build_id: A unique identifier for a build to be deployed on the new fleet. If you are deploying the fleet with a custom game build, you must specify this property. The build must have been successfully uploaded to Amazon GameLift and be in a ``READY`` status. This fleet setting cannot be changed once the fleet is created.
|
|
4191
4288
|
:param certificate_configuration: Prompts Amazon GameLift to generate a TLS/SSL certificate for the fleet. Amazon GameLift uses the certificates to encrypt traffic between game clients and the game servers running on Amazon GameLift. By default, the ``CertificateConfiguration`` is ``DISABLED`` . You can't change this property after you create the fleet. AWS Certificate Manager (ACM) certificates expire after 13 months. Certificate expiration can cause fleets to fail, preventing players from connecting to instances in the fleet. We recommend you replace fleets before 13 months, consider using fleet aliases for a smooth transition. .. epigraph:: ACM isn't available in all AWS regions. A fleet creation request with certificate generation enabled in an unsupported Region, fails with a 4xx error. For more information about the supported Regions, see `Supported Regions <https://docs.aws.amazon.com/acm/latest/userguide/acm-regions.html>`_ in the *AWS Certificate Manager User Guide* .
|
|
4192
|
-
:param compute_type: The type of compute resource used to host your game servers.
|
|
4193
|
-
:param container_groups_configuration:
|
|
4289
|
+
:param compute_type: The type of compute resource used to host your game servers. - ``EC2`` – The game server build is deployed to Amazon EC2 instances for cloud hosting. This is the default setting. - ``CONTAINER`` – Container images with your game server build and supporting software are deployed to Amazon EC2 instances for cloud hosting. With this compute type, you must specify the ``ContainerGroupsConfiguration`` parameter. - ``ANYWHERE`` – Game servers or container images with your game server and supporting software are deployed to compute resources that are provided and managed by you. With this compute type, you can also set the ``AnywhereConfiguration`` parameter.
|
|
4290
|
+
:param container_groups_configuration: *This data type is used with the Amazon GameLift containers feature, which is currently in public preview.*. Configuration details for a set of container groups, for use when creating a fleet with compute type ``CONTAINER`` . *Used with:* ``CreateFleet``
|
|
4194
4291
|
:param description: A description for the fleet.
|
|
4195
4292
|
:param desired_ec2_instances: The number of EC2 instances that you want this fleet to host. When creating a new fleet, GameLift automatically sets this value to "1" and initiates a single instance. Once the fleet is active, update this value to trigger GameLift to add or remove instances from the fleet.
|
|
4196
|
-
:param ec2_inbound_permissions: The
|
|
4197
|
-
:param ec2_instance_type: The Amazon GameLift-supported Amazon EC2 instance type to use
|
|
4293
|
+
:param ec2_inbound_permissions: The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet. Set this parameter for EC2 and container fleets. You can leave this parameter empty when creating the fleet, but you must call ``UpdateFleetPortSettings`` to set it before players can connect to game sessions. As a best practice, we recommend opening ports for remote access only when you need them and closing them when you're finished. For Realtime Servers fleets, Amazon GameLift automatically sets TCP and UDP ranges. To manage inbound access for a container fleet, set this parameter to the same port numbers that you set for the fleet's connection port range. During the life of the fleet, update this parameter to control which connection ports are open to inbound traffic.
|
|
4294
|
+
:param ec2_instance_type: The Amazon GameLift-supported Amazon EC2 instance type to use with EC2 and container fleets. Instance type determines the computing resources that will be used to host your game servers, including CPU, memory, storage, and networking capacity. See `Amazon Elastic Compute Cloud Instance Types <https://docs.aws.amazon.com/ec2/instance-types/>`_ for detailed descriptions of Amazon EC2 instance types.
|
|
4198
4295
|
:param fleet_type: Indicates whether to use On-Demand or Spot instances for this fleet. By default, this property is set to ``ON_DEMAND`` . Learn more about when to use `On-Demand versus Spot Instances <https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-ec2-instances.html#gamelift-ec2-instances-spot>`_ . This fleet property can't be changed after the fleet is created.
|
|
4199
|
-
:param instance_role_arn: A unique identifier for an IAM role with access permissions to other AWS services. Any application that runs on an instance in the fleet--including install scripts, server processes, and other processes--can use these permissions to interact with AWS resources that you own or have access to. For more information about using the role with your game server builds, see `Communicate with other AWS resources from your fleets <https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html>`_ .
|
|
4200
|
-
:param instance_role_credentials_provider: Indicates that fleet instances maintain a shared credentials file for the IAM role defined in ``InstanceRoleArn`` . Shared credentials allow applications that are deployed with the game server executable to communicate with other AWS resources. This property is used only when the game server is integrated with the server SDK version 5.x. For more information about using shared credentials, see `Communicate with other AWS resources from your fleets <https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html>`_ .
|
|
4201
|
-
:param locations: A set of remote locations to deploy additional instances to and manage as part of the fleet. This parameter can only be used when creating fleets in AWS Regions that support multiple locations. You can add any Amazon GameLift-supported AWS Region as a remote location, in the form of an AWS Region code such as ``us-west-2`` . To create a fleet with instances in the home Region only, don't
|
|
4296
|
+
:param instance_role_arn: A unique identifier for an IAM role with access permissions to other AWS services. Any application that runs on an instance in the fleet--including install scripts, server processes, and other processes--can use these permissions to interact with AWS resources that you own or have access to. For more information about using the role with your game server builds, see `Communicate with other AWS resources from your fleets <https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html>`_ . This attribute is used with fleets where ``ComputeType`` is "EC2" or "Container".
|
|
4297
|
+
:param instance_role_credentials_provider: Indicates that fleet instances maintain a shared credentials file for the IAM role defined in ``InstanceRoleArn`` . Shared credentials allow applications that are deployed with the game server executable to communicate with other AWS resources. This property is used only when the game server is integrated with the server SDK version 5.x. For more information about using shared credentials, see `Communicate with other AWS resources from your fleets <https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html>`_ . This attribute is used with fleets where ``ComputeType`` is "EC2" or "Container".
|
|
4298
|
+
:param locations: A set of remote locations to deploy additional instances to and manage as part of the fleet. This parameter can only be used when creating fleets in AWS Regions that support multiple locations. You can add any Amazon GameLift-supported AWS Region as a remote location, in the form of an AWS Region code, such as ``us-west-2`` or Local Zone code. To create a fleet with instances in the home Region only, don't set this parameter. When using this parameter, Amazon GameLift requires you to include your home location in the request.
|
|
4202
4299
|
:param log_paths: (deprecated) This parameter is no longer used. When hosting a custom game build, specify where Amazon GameLift should store log files using the Amazon GameLift server API call ProcessReady()
|
|
4203
4300
|
:param max_size: The maximum number of instances that are allowed in the specified fleet location. If this parameter is not set, the default is 1.
|
|
4204
4301
|
:param metric_groups: The name of an AWS CloudWatch metric group to add this fleet to. A metric group is used to aggregate the metrics for multiple fleets. You can specify an existing metric group name or set a new name to create a new metric group. A fleet can be included in only one metric group at a time.
|
|
@@ -4428,13 +4525,11 @@ class CfnFleetProps:
|
|
|
4428
4525
|
|
|
4429
4526
|
@builtins.property
|
|
4430
4527
|
def apply_capacity(self) -> typing.Optional[builtins.str]:
|
|
4431
|
-
'''Current resource capacity settings
|
|
4432
|
-
|
|
4433
|
-
The location value might refer to a fleet's remote location or its home Region.
|
|
4528
|
+
'''Current resource capacity settings for managed EC2 fleets and container fleets.
|
|
4434
4529
|
|
|
4435
|
-
|
|
4530
|
+
For multi-location fleets, location values might refer to a fleet's remote location or its home Region.
|
|
4436
4531
|
|
|
4437
|
-
`DescribeFleetCapacity <https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetCapacity.html>`_
|
|
4532
|
+
*Returned by:* `DescribeFleetCapacity <https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetCapacity.html>`_ , `DescribeFleetLocationCapacity <https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetLocationCapacity.html>`_ , `UpdateFleetCapacity <https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateFleetCapacity.html>`_
|
|
4438
4533
|
|
|
4439
4534
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-applycapacity
|
|
4440
4535
|
'''
|
|
@@ -4474,7 +4569,9 @@ class CfnFleetProps:
|
|
|
4474
4569
|
def compute_type(self) -> typing.Optional[builtins.str]:
|
|
4475
4570
|
'''The type of compute resource used to host your game servers.
|
|
4476
4571
|
|
|
4477
|
-
|
|
4572
|
+
- ``EC2`` – The game server build is deployed to Amazon EC2 instances for cloud hosting. This is the default setting.
|
|
4573
|
+
- ``CONTAINER`` – Container images with your game server build and supporting software are deployed to Amazon EC2 instances for cloud hosting. With this compute type, you must specify the ``ContainerGroupsConfiguration`` parameter.
|
|
4574
|
+
- ``ANYWHERE`` – Game servers or container images with your game server and supporting software are deployed to compute resources that are provided and managed by you. With this compute type, you can also set the ``AnywhereConfiguration`` parameter.
|
|
4478
4575
|
|
|
4479
4576
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-computetype
|
|
4480
4577
|
'''
|
|
@@ -4485,9 +4582,11 @@ class CfnFleetProps:
|
|
|
4485
4582
|
def container_groups_configuration(
|
|
4486
4583
|
self,
|
|
4487
4584
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnFleet.ContainerGroupsConfigurationProperty]]:
|
|
4488
|
-
'''
|
|
4585
|
+
'''*This data type is used with the Amazon GameLift containers feature, which is currently in public preview.*.
|
|
4489
4586
|
|
|
4490
|
-
|
|
4587
|
+
Configuration details for a set of container groups, for use when creating a fleet with compute type ``CONTAINER`` .
|
|
4588
|
+
|
|
4589
|
+
*Used with:* ``CreateFleet``
|
|
4491
4590
|
|
|
4492
4591
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-containergroupsconfiguration
|
|
4493
4592
|
'''
|
|
@@ -4518,9 +4617,11 @@ class CfnFleetProps:
|
|
|
4518
4617
|
def ec2_inbound_permissions(
|
|
4519
4618
|
self,
|
|
4520
4619
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, CfnFleet.IpPermissionProperty]]]]:
|
|
4521
|
-
'''The
|
|
4620
|
+
'''The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet.
|
|
4621
|
+
|
|
4622
|
+
Set this parameter for EC2 and container fleets. You can leave this parameter empty when creating the fleet, but you must call ``UpdateFleetPortSettings`` to set it before players can connect to game sessions. As a best practice, we recommend opening ports for remote access only when you need them and closing them when you're finished. For Realtime Servers fleets, Amazon GameLift automatically sets TCP and UDP ranges.
|
|
4522
4623
|
|
|
4523
|
-
|
|
4624
|
+
To manage inbound access for a container fleet, set this parameter to the same port numbers that you set for the fleet's connection port range. During the life of the fleet, update this parameter to control which connection ports are open to inbound traffic.
|
|
4524
4625
|
|
|
4525
4626
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-ec2inboundpermissions
|
|
4526
4627
|
'''
|
|
@@ -4529,7 +4630,7 @@ class CfnFleetProps:
|
|
|
4529
4630
|
|
|
4530
4631
|
@builtins.property
|
|
4531
4632
|
def ec2_instance_type(self) -> typing.Optional[builtins.str]:
|
|
4532
|
-
'''The Amazon GameLift-supported Amazon EC2 instance type to use
|
|
4633
|
+
'''The Amazon GameLift-supported Amazon EC2 instance type to use with EC2 and container fleets.
|
|
4533
4634
|
|
|
4534
4635
|
Instance type determines the computing resources that will be used to host your game servers, including CPU, memory, storage, and networking capacity. See `Amazon Elastic Compute Cloud Instance Types <https://docs.aws.amazon.com/ec2/instance-types/>`_ for detailed descriptions of Amazon EC2 instance types.
|
|
4535
4636
|
|
|
@@ -4553,7 +4654,7 @@ class CfnFleetProps:
|
|
|
4553
4654
|
def instance_role_arn(self) -> typing.Optional[builtins.str]:
|
|
4554
4655
|
'''A unique identifier for an IAM role with access permissions to other AWS services.
|
|
4555
4656
|
|
|
4556
|
-
Any application that runs on an instance in the fleet--including install scripts, server processes, and other processes--can use these permissions to interact with AWS resources that you own or have access to. For more information about using the role with your game server builds, see `Communicate with other AWS resources from your fleets <https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html>`_ .
|
|
4657
|
+
Any application that runs on an instance in the fleet--including install scripts, server processes, and other processes--can use these permissions to interact with AWS resources that you own or have access to. For more information about using the role with your game server builds, see `Communicate with other AWS resources from your fleets <https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html>`_ . This attribute is used with fleets where ``ComputeType`` is "EC2" or "Container".
|
|
4557
4658
|
|
|
4558
4659
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-instancerolearn
|
|
4559
4660
|
'''
|
|
@@ -4564,7 +4665,7 @@ class CfnFleetProps:
|
|
|
4564
4665
|
def instance_role_credentials_provider(self) -> typing.Optional[builtins.str]:
|
|
4565
4666
|
'''Indicates that fleet instances maintain a shared credentials file for the IAM role defined in ``InstanceRoleArn`` .
|
|
4566
4667
|
|
|
4567
|
-
Shared credentials allow applications that are deployed with the game server executable to communicate with other AWS resources. This property is used only when the game server is integrated with the server SDK version 5.x. For more information about using shared credentials, see `Communicate with other AWS resources from your fleets <https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html>`_ .
|
|
4668
|
+
Shared credentials allow applications that are deployed with the game server executable to communicate with other AWS resources. This property is used only when the game server is integrated with the server SDK version 5.x. For more information about using shared credentials, see `Communicate with other AWS resources from your fleets <https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html>`_ . This attribute is used with fleets where ``ComputeType`` is "EC2" or "Container".
|
|
4568
4669
|
|
|
4569
4670
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-instancerolecredentialsprovider
|
|
4570
4671
|
'''
|
|
@@ -4577,9 +4678,9 @@ class CfnFleetProps:
|
|
|
4577
4678
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, CfnFleet.LocationConfigurationProperty]]]]:
|
|
4578
4679
|
'''A set of remote locations to deploy additional instances to and manage as part of the fleet.
|
|
4579
4680
|
|
|
4580
|
-
This parameter can only be used when creating fleets in AWS Regions that support multiple locations. You can add any Amazon GameLift-supported AWS Region as a remote location, in the form of an AWS Region code such as ``us-west-2`` . To create a fleet with instances in the home Region only, don't
|
|
4681
|
+
This parameter can only be used when creating fleets in AWS Regions that support multiple locations. You can add any Amazon GameLift-supported AWS Region as a remote location, in the form of an AWS Region code, such as ``us-west-2`` or Local Zone code. To create a fleet with instances in the home Region only, don't set this parameter.
|
|
4581
4682
|
|
|
4582
|
-
|
|
4683
|
+
When using this parameter, Amazon GameLift requires you to include your home location in the request.
|
|
4583
4684
|
|
|
4584
4685
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-locations
|
|
4585
4686
|
'''
|