aws-cdk-lib 2.168.0__py3-none-any.whl → 2.170.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.
Files changed (40) hide show
  1. aws_cdk/__init__.py +2 -0
  2. aws_cdk/_jsii/__init__.py +1 -1
  3. aws_cdk/_jsii/{aws-cdk-lib@2.168.0.jsii.tgz → aws-cdk-lib@2.170.0.jsii.tgz} +0 -0
  4. aws_cdk/aws_accessanalyzer/__init__.py +244 -13
  5. aws_cdk/aws_applicationsignals/__init__.py +8 -1
  6. aws_cdk/aws_autoscaling/__init__.py +310 -9
  7. aws_cdk/aws_cloudfront/__init__.py +50 -0
  8. aws_cdk/aws_cloudfront/experimental/__init__.py +5 -0
  9. aws_cdk/aws_codebuild/__init__.py +2 -2
  10. aws_cdk/aws_connect/__init__.py +378 -0
  11. aws_cdk/aws_customerprofiles/__init__.py +44 -0
  12. aws_cdk/aws_deadline/__init__.py +299 -6
  13. aws_cdk/aws_dynamodb/__init__.py +47 -25
  14. aws_cdk/aws_ec2/__init__.py +6 -2
  15. aws_cdk/aws_ecs/__init__.py +28 -22
  16. aws_cdk/aws_efs/__init__.py +61 -4
  17. aws_cdk/aws_eks/__init__.py +116 -0
  18. aws_cdk/aws_gamelift/__init__.py +385 -251
  19. aws_cdk/aws_iot/__init__.py +209 -0
  20. aws_cdk/aws_iotfleetwise/__init__.py +550 -0
  21. aws_cdk/aws_iotsitewise/__init__.py +6 -3
  22. aws_cdk/aws_ivs/__init__.py +458 -0
  23. aws_cdk/aws_kinesisfirehose/__init__.py +90 -33
  24. aws_cdk/aws_lambda/__init__.py +150 -6
  25. aws_cdk/aws_lambda_event_sources/__init__.py +298 -1
  26. aws_cdk/aws_rbin/__init__.py +902 -0
  27. aws_cdk/aws_rds/__init__.py +115 -0
  28. aws_cdk/aws_route53resolver/__init__.py +76 -19
  29. aws_cdk/aws_sagemaker/__init__.py +32 -0
  30. aws_cdk/aws_sns/__init__.py +593 -8
  31. aws_cdk/aws_sns_subscriptions/__init__.py +68 -22
  32. aws_cdk/aws_synthetics/__init__.py +46 -0
  33. aws_cdk/aws_vpclattice/__init__.py +118 -2
  34. aws_cdk/aws_wisdom/__init__.py +16 -21
  35. {aws_cdk_lib-2.168.0.dist-info → aws_cdk_lib-2.170.0.dist-info}/METADATA +1 -1
  36. {aws_cdk_lib-2.168.0.dist-info → aws_cdk_lib-2.170.0.dist-info}/RECORD +40 -39
  37. {aws_cdk_lib-2.168.0.dist-info → aws_cdk_lib-2.170.0.dist-info}/LICENSE +0 -0
  38. {aws_cdk_lib-2.168.0.dist-info → aws_cdk_lib-2.170.0.dist-info}/NOTICE +0 -0
  39. {aws_cdk_lib-2.168.0.dist-info → aws_cdk_lib-2.170.0.dist-info}/WHEEL +0 -0
  40. {aws_cdk_lib-2.168.0.dist-info → aws_cdk_lib-2.170.0.dist-info}/top_level.txt +0 -0
@@ -478,7 +478,7 @@ class CfnBuild(
478
478
  :param scope: Scope in which this resource is defined.
479
479
  :param id: Construct identifier for this resource (unique in its scope).
480
480
  :param name: A descriptive label that is associated with a build. Build names do not need to be unique.
481
- :param operating_system: The environment that your game server binaries run on. This value determines the type of fleet resources that you use for this build. If your game build contains multiple executables, they all must run on the same operating system. This parameter is required, and there's no default value. You can't change a build's operating system later. .. epigraph:: Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more details in the `Amazon Linux 2 FAQs <https://docs.aws.amazon.com/https://aws.amazon.com/amazon-linux-2/faqs/>`_ . For game servers that are hosted on AL2 and use Amazon GameLift server SDK 4.x., first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See `Migrate to Amazon GameLift server SDK version 5. <https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk5-migration.html>`_
481
+ :param operating_system: The operating system that your game server binaries run on. This value determines the type of fleet resources that you use for this build. If your game build contains multiple executables, they all must run on the same operating system. You must specify a valid operating system in this request. There is no default value. You can't change a build's operating system later. .. epigraph:: Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more details in the `Amazon Linux 2 FAQs <https://docs.aws.amazon.com/https://aws.amazon.com/amazon-linux-2/faqs/>`_ . For game servers that are hosted on AL2 and use Amazon GameLift server SDK 4.x., first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See `Migrate to Amazon GameLift server SDK version 5. <https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk5-migration.html>`_
482
482
  :param server_sdk_version: A server SDK version you used when integrating your game server build with Amazon GameLift. For more information see `Integrate games with custom game servers <https://docs.aws.amazon.com/gamelift/latest/developerguide/integration-custom-intro.html>`_ . By default Amazon GameLift sets this value to ``4.0.2`` .
483
483
  :param storage_location: Information indicating where your game build files are stored. Use this parameter only when creating a build with files stored in an Amazon S3 bucket that you own. The storage location must specify an Amazon S3 bucket name and key. The location must also specify a role ARN that you set up to allow Amazon GameLift to access your Amazon S3 bucket. The S3 bucket and your new build must be in the same Region. If a ``StorageLocation`` is specified, the size of your file can be found in your Amazon S3 bucket. Amazon GameLift will report a ``SizeOnDisk`` of 0.
484
484
  :param version: Version information that is associated with this build. Version strings do not need to be unique.
@@ -557,7 +557,7 @@ class CfnBuild(
557
557
  @builtins.property
558
558
  @jsii.member(jsii_name="operatingSystem")
559
559
  def operating_system(self) -> typing.Optional[builtins.str]:
560
- '''The environment that your game server binaries run on.'''
560
+ '''The operating system that your game server binaries run on.'''
561
561
  return typing.cast(typing.Optional[builtins.str], jsii.get(self, "operatingSystem"))
562
562
 
563
563
  @operating_system.setter
@@ -750,7 +750,7 @@ class CfnBuildProps:
750
750
  '''Properties for defining a ``CfnBuild``.
751
751
 
752
752
  :param name: A descriptive label that is associated with a build. Build names do not need to be unique.
753
- :param operating_system: The environment that your game server binaries run on. This value determines the type of fleet resources that you use for this build. If your game build contains multiple executables, they all must run on the same operating system. This parameter is required, and there's no default value. You can't change a build's operating system later. .. epigraph:: Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more details in the `Amazon Linux 2 FAQs <https://docs.aws.amazon.com/https://aws.amazon.com/amazon-linux-2/faqs/>`_ . For game servers that are hosted on AL2 and use Amazon GameLift server SDK 4.x., first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See `Migrate to Amazon GameLift server SDK version 5. <https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk5-migration.html>`_
753
+ :param operating_system: The operating system that your game server binaries run on. This value determines the type of fleet resources that you use for this build. If your game build contains multiple executables, they all must run on the same operating system. You must specify a valid operating system in this request. There is no default value. You can't change a build's operating system later. .. epigraph:: Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more details in the `Amazon Linux 2 FAQs <https://docs.aws.amazon.com/https://aws.amazon.com/amazon-linux-2/faqs/>`_ . For game servers that are hosted on AL2 and use Amazon GameLift server SDK 4.x., first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See `Migrate to Amazon GameLift server SDK version 5. <https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk5-migration.html>`_
754
754
  :param server_sdk_version: A server SDK version you used when integrating your game server build with Amazon GameLift. For more information see `Integrate games with custom game servers <https://docs.aws.amazon.com/gamelift/latest/developerguide/integration-custom-intro.html>`_ . By default Amazon GameLift sets this value to ``4.0.2`` .
755
755
  :param storage_location: Information indicating where your game build files are stored. Use this parameter only when creating a build with files stored in an Amazon S3 bucket that you own. The storage location must specify an Amazon S3 bucket name and key. The location must also specify a role ARN that you set up to allow Amazon GameLift to access your Amazon S3 bucket. The S3 bucket and your new build must be in the same Region. If a ``StorageLocation`` is specified, the size of your file can be found in your Amazon S3 bucket. Amazon GameLift will report a ``SizeOnDisk`` of 0.
756
756
  :param version: Version information that is associated with this build. Version strings do not need to be unique.
@@ -811,9 +811,9 @@ class CfnBuildProps:
811
811
 
812
812
  @builtins.property
813
813
  def operating_system(self) -> typing.Optional[builtins.str]:
814
- '''The environment that your game server binaries run on.
814
+ '''The operating system that your game server binaries run on.
815
815
 
816
- This value determines the type of fleet resources that you use for this build. If your game build contains multiple executables, they all must run on the same operating system. This parameter is required, and there's no default value. You can't change a build's operating system later.
816
+ This value determines the type of fleet resources that you use for this build. If your game build contains multiple executables, they all must run on the same operating system. You must specify a valid operating system in this request. There is no default value. You can't change a build's operating system later.
817
817
  .. epigraph::
818
818
 
819
819
  Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more details in the `Amazon Linux 2 FAQs <https://docs.aws.amazon.com/https://aws.amazon.com/amazon-linux-2/faqs/>`_ . For game servers that are hosted on AL2 and use Amazon GameLift server SDK 4.x., first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See `Migrate to Amazon GameLift server SDK version 5. <https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk5-migration.html>`_
@@ -878,7 +878,7 @@ class CfnContainerFleet(
878
878
  metaclass=jsii.JSIIMeta,
879
879
  jsii_type="aws-cdk-lib.aws_gamelift.CfnContainerFleet",
880
880
  ):
881
- '''The AWS::GameLift::ContainerFleet resource creates an Amazon GameLift (GameLift) container fleet to host game servers.
881
+ '''Describes an Amazon GameLift managed container fleet.
882
882
 
883
883
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html
884
884
  :cloudformationResource: AWS::GameLift::ContainerFleet
@@ -984,21 +984,21 @@ class CfnContainerFleet(
984
984
  '''
985
985
  :param scope: Scope in which this resource is defined.
986
986
  :param id: Construct identifier for this resource (unique in its scope).
987
- :param fleet_role_arn: A unique identifier for an AWS IAM role that manages access to your AWS services. Create a role or look up a role's ARN from the IAM dashboard in the AWS Management Console.
988
- :param billing_type: Indicates whether to use On-Demand instances or Spot instances for this fleet. If empty, the default is ON_DEMAND. Both categories of instances use identical hardware and configurations based on the instance type selected for this fleet.
989
- :param deployment_configuration: Provides details about how to drain old tasks and replace them with new updated tasks.
990
- :param description: A human-readable description of a fleet.
991
- :param game_server_container_group_definition_name: The name of the container group definition that will be created per game server. You must specify GAME_SERVER container group. You have the option to also specify one PER_INSTANCE container group.
992
- :param game_server_container_groups_per_instance: The number of desired game server container groups per instance, a number between 1-5000.
993
- :param game_session_creation_limit_policy: A policy that limits the number of game sessions a player can create on the same fleet. This optional policy gives game owners control over how players can consume available game server resources. A resource creation policy makes the following statement: "An individual player can create a maximum number of new game sessions within a specified time period". The policy is evaluated when a player tries to create a new game session. For example, assume you have a policy of 10 new game sessions and a time period of 60 minutes. On receiving a CreateGameSession request, Amazon GameLift checks that the player (identified by CreatorId) has created fewer than 10 game sessions in the past 60 minutes.
994
- :param instance_connection_port_range: Defines the range of ports on the instance that allow inbound traffic to connect with containers in a fleet.
995
- :param instance_inbound_permissions: A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.
996
- :param instance_type: The name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.
987
+ :param fleet_role_arn: The unique identifier for an AWS Identity and Access Management (IAM) role with permissions to run your containers on resources that are managed by Amazon GameLift. See `Set up an IAM service role <https://docs.aws.amazon.com/gamelift/latest/developerguide/setting-up-role.html>`_ . This fleet property can't be changed.
988
+ :param billing_type: Indicates whether the fleet uses On-Demand or Spot instances for this fleet. 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>`_ . You can't update this fleet property. By default, this property is set to ``ON_DEMAND`` .
989
+ :param deployment_configuration: Set of rules for processing a deployment for a container fleet update.
990
+ :param description: A meaningful description of the container fleet.
991
+ :param game_server_container_group_definition_name: The name of the fleet's game server container group definition, which describes how to deploy containers with your game server build and support software onto each fleet instance.
992
+ :param game_server_container_groups_per_instance: The number of times to replicate the game server container group on each fleet instance.
993
+ :param game_session_creation_limit_policy: A policy that limits the number of game sessions that each individual player can create on instances in this fleet. The limit applies for a specified span of time.
994
+ :param instance_connection_port_range: 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.
995
+ :param instance_inbound_permissions: The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet.
996
+ :param instance_type: The Amazon EC2 instance type to use for all instances in the fleet. Instance type determines the computing resources and processing power that's available to host your game servers. This includes including CPU, memory, storage, and networking capacity. You can't update this fleet property.
997
997
  :param locations:
998
- :param log_configuration: A policy the location and provider of logs from the fleet.
999
- :param metric_groups: The name of an Amazon CloudWatch metric group. A metric group aggregates the metrics for all fleets in the group. Specify a string containing the metric group name. You can use an existing name or use a new name to create a new metric group. Currently, this parameter can have only one string.
1000
- :param new_game_session_protection_policy: A game session protection policy to apply to all game sessions hosted on instances in this fleet. When protected, active game sessions cannot be terminated during a scale-down event. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy to affect future game sessions on the fleet. You can also set protection for individual game sessions.
1001
- :param per_instance_container_group_definition_name: The name of the container group definition that will be created per instance. This field is optional if you specify GameServerContainerGroupDefinitionName.
998
+ :param log_configuration: The method that is used to collect container logs for the fleet. Amazon GameLift saves all standard output for each container in logs, including game session logs. - ``CLOUDWATCH`` -- Send logs to an Amazon CloudWatch log group that you define. Each container emits a log stream, which is organized in the log group. - ``S3`` -- Store logs in an Amazon S3 bucket that you define. - ``NONE`` -- Don't collect container logs.
999
+ :param metric_groups: The name of an AWS CloudWatch metric group to add this fleet to. Metric groups aggregate metrics for multiple fleets.
1000
+ :param new_game_session_protection_policy: Determines whether Amazon GameLift can shut down game sessions on the fleet that are actively running and hosting players. Amazon GameLift might prompt an instance shutdown when scaling down fleet capacity or when retiring unhealthy instances. You can also set game session protection for individual game sessions using `UpdateGameSession <https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSession.html>`_ . - *NoProtection* -- Game sessions can be shut down during active gameplay. - *FullProtection* -- Game sessions in ``ACTIVE`` status can't be shut down.
1001
+ :param per_instance_container_group_definition_name: The name of the fleet's per-instance container group definition.
1002
1002
  :param scaling_policies: A list of rules that control how a fleet is scaled.
1003
1003
  :param tags: An array of key-value pairs to apply to this resource.
1004
1004
  '''
@@ -1063,7 +1063,7 @@ class CfnContainerFleet(
1063
1063
  def attr_creation_time(self) -> builtins.str:
1064
1064
  '''A time stamp indicating when this data object was created.
1065
1065
 
1066
- Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
1066
+ Format is a number expressed in Unix time as milliseconds (for example ``"1469498468.057"`` ).
1067
1067
 
1068
1068
  :cloudformationAttribute: CreationTime
1069
1069
  '''
@@ -1081,7 +1081,7 @@ class CfnContainerFleet(
1081
1081
  @builtins.property
1082
1082
  @jsii.member(jsii_name="attrFleetArn")
1083
1083
  def attr_fleet_arn(self) -> builtins.str:
1084
- '''The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift container fleet resource and uniquely identifies it across all AWS Regions.
1084
+ '''The Amazon Resource Name ( `ARN <https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html>`_ ) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is ``arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912`` . In a GameLift fleet ARN, the resource ID matches the ``FleetId`` value.
1085
1085
 
1086
1086
  :cloudformationAttribute: FleetArn
1087
1087
  '''
@@ -1090,7 +1090,7 @@ class CfnContainerFleet(
1090
1090
  @builtins.property
1091
1091
  @jsii.member(jsii_name="attrFleetId")
1092
1092
  def attr_fleet_id(self) -> builtins.str:
1093
- '''Unique fleet ID.
1093
+ '''A unique identifier for the container fleet to retrieve.
1094
1094
 
1095
1095
  :cloudformationAttribute: FleetId
1096
1096
  '''
@@ -1099,9 +1099,7 @@ class CfnContainerFleet(
1099
1099
  @builtins.property
1100
1100
  @jsii.member(jsii_name="attrGameServerContainerGroupDefinitionArn")
1101
1101
  def attr_game_server_container_group_definition_arn(self) -> builtins.str:
1102
- '''The Amazon Resource Name (ARN) of the game server container group definition.
1103
-
1104
- This field will be empty if GameServerContainerGroupDefinitionName is not specified.
1102
+ '''The Amazon Resource Name ( `ARN <https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html>`_ ) that is assigned to the fleet's game server container group. The ARN value also identifies the specific container group definition version in use.
1105
1103
 
1106
1104
  :cloudformationAttribute: GameServerContainerGroupDefinitionArn
1107
1105
  '''
@@ -1110,7 +1108,9 @@ class CfnContainerFleet(
1110
1108
  @builtins.property
1111
1109
  @jsii.member(jsii_name="attrMaximumGameServerContainerGroupsPerInstance")
1112
1110
  def attr_maximum_game_server_container_groups_per_instance(self) -> jsii.Number:
1113
- '''The maximum number of game server container groups per instance, a number between 1-5000.
1111
+ '''The calculated maximum number of game server container group that can be deployed on each fleet instance.
1112
+
1113
+ The calculation depends on the resource needs of the container group and the CPU and memory resources of the fleet's instance type.
1114
1114
 
1115
1115
  :cloudformationAttribute: MaximumGameServerContainerGroupsPerInstance
1116
1116
  '''
@@ -1119,9 +1119,7 @@ class CfnContainerFleet(
1119
1119
  @builtins.property
1120
1120
  @jsii.member(jsii_name="attrPerInstanceContainerGroupDefinitionArn")
1121
1121
  def attr_per_instance_container_group_definition_arn(self) -> builtins.str:
1122
- '''The Amazon Resource Name (ARN) of the per instance container group definition.
1123
-
1124
- This field will be empty if PerInstanceContainerGroupDefinitionName is not specified.
1122
+ '''The Amazon Resource Name ( `ARN <https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html>`_ ) that is assigned to the fleet's per-instance container group. The ARN value also identifies the specific container group definition version in use.
1125
1123
 
1126
1124
  :cloudformationAttribute: PerInstanceContainerGroupDefinitionArn
1127
1125
  '''
@@ -1132,6 +1130,13 @@ class CfnContainerFleet(
1132
1130
  def attr_status(self) -> builtins.str:
1133
1131
  '''The current status of the container fleet.
1134
1132
 
1133
+ - ``PENDING`` -- A new container fleet has been requested.
1134
+ - ``CREATING`` -- A new container fleet resource is being created.
1135
+ - ``CREATED`` -- A new container fleet resource has been created. No fleet instances have been deployed.
1136
+ - ``ACTIVATING`` -- New container fleet instances are being deployed.
1137
+ - ``ACTIVE`` -- The container fleet has been deployed and is ready to host game sessions.
1138
+ - ``UPDATING`` -- Updates to the container fleet is being updated. A deployment is in progress.
1139
+
1135
1140
  :cloudformationAttribute: Status
1136
1141
  '''
1137
1142
  return typing.cast(builtins.str, jsii.get(self, "attrStatus"))
@@ -1150,7 +1155,7 @@ class CfnContainerFleet(
1150
1155
  @builtins.property
1151
1156
  @jsii.member(jsii_name="fleetRoleArn")
1152
1157
  def fleet_role_arn(self) -> builtins.str:
1153
- '''A unique identifier for an AWS IAM role that manages access to your AWS services.'''
1158
+ '''The unique identifier for an AWS Identity and Access Management (IAM) role with permissions to run your containers on resources that are managed by Amazon GameLift.'''
1154
1159
  return typing.cast(builtins.str, jsii.get(self, "fleetRoleArn"))
1155
1160
 
1156
1161
  @fleet_role_arn.setter
@@ -1163,7 +1168,7 @@ class CfnContainerFleet(
1163
1168
  @builtins.property
1164
1169
  @jsii.member(jsii_name="billingType")
1165
1170
  def billing_type(self) -> typing.Optional[builtins.str]:
1166
- '''Indicates whether to use On-Demand instances or Spot instances for this fleet.'''
1171
+ '''Indicates whether the fleet uses On-Demand or Spot instances for this fleet.'''
1167
1172
  return typing.cast(typing.Optional[builtins.str], jsii.get(self, "billingType"))
1168
1173
 
1169
1174
  @billing_type.setter
@@ -1178,7 +1183,7 @@ class CfnContainerFleet(
1178
1183
  def deployment_configuration(
1179
1184
  self,
1180
1185
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnContainerFleet.DeploymentConfigurationProperty"]]:
1181
- '''Provides details about how to drain old tasks and replace them with new updated tasks.'''
1186
+ '''Set of rules for processing a deployment for a container fleet update.'''
1182
1187
  return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnContainerFleet.DeploymentConfigurationProperty"]], jsii.get(self, "deploymentConfiguration"))
1183
1188
 
1184
1189
  @deployment_configuration.setter
@@ -1194,7 +1199,7 @@ class CfnContainerFleet(
1194
1199
  @builtins.property
1195
1200
  @jsii.member(jsii_name="description")
1196
1201
  def description(self) -> typing.Optional[builtins.str]:
1197
- '''A human-readable description of a fleet.'''
1202
+ '''A meaningful description of the container fleet.'''
1198
1203
  return typing.cast(typing.Optional[builtins.str], jsii.get(self, "description"))
1199
1204
 
1200
1205
  @description.setter
@@ -1209,7 +1214,7 @@ class CfnContainerFleet(
1209
1214
  def game_server_container_group_definition_name(
1210
1215
  self,
1211
1216
  ) -> typing.Optional[builtins.str]:
1212
- '''The name of the container group definition that will be created per game server.'''
1217
+ '''The name of the fleet's game server container group definition, which describes how to deploy containers with your game server build and support software onto each fleet instance.'''
1213
1218
  return typing.cast(typing.Optional[builtins.str], jsii.get(self, "gameServerContainerGroupDefinitionName"))
1214
1219
 
1215
1220
  @game_server_container_group_definition_name.setter
@@ -1225,7 +1230,7 @@ class CfnContainerFleet(
1225
1230
  @builtins.property
1226
1231
  @jsii.member(jsii_name="gameServerContainerGroupsPerInstance")
1227
1232
  def game_server_container_groups_per_instance(self) -> typing.Optional[jsii.Number]:
1228
- '''The number of desired game server container groups per instance, a number between 1-5000.'''
1233
+ '''The number of times to replicate the game server container group on each fleet instance.'''
1229
1234
  return typing.cast(typing.Optional[jsii.Number], jsii.get(self, "gameServerContainerGroupsPerInstance"))
1230
1235
 
1231
1236
  @game_server_container_groups_per_instance.setter
@@ -1243,7 +1248,7 @@ class CfnContainerFleet(
1243
1248
  def game_session_creation_limit_policy(
1244
1249
  self,
1245
1250
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnContainerFleet.GameSessionCreationLimitPolicyProperty"]]:
1246
- '''A policy that limits the number of game sessions a player can create on the same fleet.'''
1251
+ '''A policy that limits the number of game sessions that each individual player can create on instances in this fleet.'''
1247
1252
  return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnContainerFleet.GameSessionCreationLimitPolicyProperty"]], jsii.get(self, "gameSessionCreationLimitPolicy"))
1248
1253
 
1249
1254
  @game_session_creation_limit_policy.setter
@@ -1261,7 +1266,7 @@ class CfnContainerFleet(
1261
1266
  def instance_connection_port_range(
1262
1267
  self,
1263
1268
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnContainerFleet.ConnectionPortRangeProperty"]]:
1264
- '''Defines the range of ports on the instance that allow inbound traffic to connect with containers in a fleet.'''
1269
+ '''The set of port numbers to open on each instance in a container fleet.'''
1265
1270
  return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnContainerFleet.ConnectionPortRangeProperty"]], jsii.get(self, "instanceConnectionPortRange"))
1266
1271
 
1267
1272
  @instance_connection_port_range.setter
@@ -1279,7 +1284,7 @@ class CfnContainerFleet(
1279
1284
  def instance_inbound_permissions(
1280
1285
  self,
1281
1286
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnContainerFleet.IpPermissionProperty"]]]]:
1282
- '''A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.'''
1287
+ '''The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet.'''
1283
1288
  return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnContainerFleet.IpPermissionProperty"]]]], jsii.get(self, "instanceInboundPermissions"))
1284
1289
 
1285
1290
  @instance_inbound_permissions.setter
@@ -1295,7 +1300,7 @@ class CfnContainerFleet(
1295
1300
  @builtins.property
1296
1301
  @jsii.member(jsii_name="instanceType")
1297
1302
  def instance_type(self) -> typing.Optional[builtins.str]:
1298
- '''The name of an EC2 instance type that is supported in Amazon GameLift.'''
1303
+ '''The Amazon EC2 instance type to use for all instances in the fleet.'''
1299
1304
  return typing.cast(typing.Optional[builtins.str], jsii.get(self, "instanceType"))
1300
1305
 
1301
1306
  @instance_type.setter
@@ -1327,7 +1332,7 @@ class CfnContainerFleet(
1327
1332
  def log_configuration(
1328
1333
  self,
1329
1334
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnContainerFleet.LogConfigurationProperty"]]:
1330
- '''A policy the location and provider of logs from the fleet.'''
1335
+ '''The method that is used to collect container logs for the fleet.'''
1331
1336
  return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnContainerFleet.LogConfigurationProperty"]], jsii.get(self, "logConfiguration"))
1332
1337
 
1333
1338
  @log_configuration.setter
@@ -1343,7 +1348,7 @@ class CfnContainerFleet(
1343
1348
  @builtins.property
1344
1349
  @jsii.member(jsii_name="metricGroups")
1345
1350
  def metric_groups(self) -> typing.Optional[typing.List[builtins.str]]:
1346
- '''The name of an Amazon CloudWatch metric group.'''
1351
+ '''The name of an AWS CloudWatch metric group to add this fleet to.'''
1347
1352
  return typing.cast(typing.Optional[typing.List[builtins.str]], jsii.get(self, "metricGroups"))
1348
1353
 
1349
1354
  @metric_groups.setter
@@ -1356,7 +1361,7 @@ class CfnContainerFleet(
1356
1361
  @builtins.property
1357
1362
  @jsii.member(jsii_name="newGameSessionProtectionPolicy")
1358
1363
  def new_game_session_protection_policy(self) -> typing.Optional[builtins.str]:
1359
- '''A game session protection policy to apply to all game sessions hosted on instances in this fleet.'''
1364
+ '''Determines whether Amazon GameLift can shut down game sessions on the fleet that are actively running and hosting players.'''
1360
1365
  return typing.cast(typing.Optional[builtins.str], jsii.get(self, "newGameSessionProtectionPolicy"))
1361
1366
 
1362
1367
  @new_game_session_protection_policy.setter
@@ -1374,7 +1379,7 @@ class CfnContainerFleet(
1374
1379
  def per_instance_container_group_definition_name(
1375
1380
  self,
1376
1381
  ) -> typing.Optional[builtins.str]:
1377
- '''The name of the container group definition that will be created per instance.'''
1382
+ '''The name of the fleet's per-instance container group definition.'''
1378
1383
  return typing.cast(typing.Optional[builtins.str], jsii.get(self, "perInstanceContainerGroupDefinitionName"))
1379
1384
 
1380
1385
  @per_instance_container_group_definition_name.setter
@@ -1425,10 +1430,12 @@ class CfnContainerFleet(
1425
1430
  )
1426
1431
  class ConnectionPortRangeProperty:
1427
1432
  def __init__(self, *, from_port: jsii.Number, to_port: jsii.Number) -> None:
1428
- '''Defines the range of ports on the instance that allow inbound traffic to connect with containers in a fleet.
1433
+ '''The set of port numbers to open on each instance in a container fleet.
1429
1434
 
1430
- :param from_port: A starting value for a range of allowed port numbers.
1431
- :param to_port: An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort.
1435
+ Connection ports are used by inbound traffic to connect with processes that are running in containers on the fleet.
1436
+
1437
+ :param from_port: Starting value for the port range.
1438
+ :param to_port: Ending value for the port. Port numbers are end-inclusive. This value must be equal to or greater than ``FromPort`` .
1432
1439
 
1433
1440
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-connectionportrange.html
1434
1441
  :exampleMetadata: fixture=_generated
@@ -1455,7 +1462,7 @@ class CfnContainerFleet(
1455
1462
 
1456
1463
  @builtins.property
1457
1464
  def from_port(self) -> jsii.Number:
1458
- '''A starting value for a range of allowed port numbers.
1465
+ '''Starting value for the port range.
1459
1466
 
1460
1467
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-connectionportrange.html#cfn-gamelift-containerfleet-connectionportrange-fromport
1461
1468
  '''
@@ -1465,9 +1472,9 @@ class CfnContainerFleet(
1465
1472
 
1466
1473
  @builtins.property
1467
1474
  def to_port(self) -> jsii.Number:
1468
- '''An ending value for a range of allowed port numbers.
1475
+ '''Ending value for the port.
1469
1476
 
1470
- Port numbers are end-inclusive. This value must be higher than FromPort.
1477
+ Port numbers are end-inclusive. This value must be equal to or greater than ``FromPort`` .
1471
1478
 
1472
1479
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-connectionportrange.html#cfn-gamelift-containerfleet-connectionportrange-toport
1473
1480
  '''
@@ -1503,11 +1510,11 @@ class CfnContainerFleet(
1503
1510
  minimum_healthy_percentage: typing.Optional[jsii.Number] = None,
1504
1511
  protection_strategy: typing.Optional[builtins.str] = None,
1505
1512
  ) -> None:
1506
- '''Provides details about how to drain old tasks and replace them with new updated tasks.
1513
+ '''Set of rules for processing a deployment for a container fleet update.
1507
1514
 
1508
- :param impairment_strategy: The strategy to apply in case of impairment; defaults to MAINTAIN.
1509
- :param minimum_healthy_percentage: The minimum percentage of healthy required; defaults to 75.
1510
- :param protection_strategy: The protection strategy for deployment on the container fleet; defaults to WITH_PROTECTION.
1515
+ :param impairment_strategy: Determines what actions to take if a deployment fails. If the fleet is multi-location, this strategy applies across all fleet locations. With a rollback strategy, updated fleet instances are rolled back to the last successful deployment. Alternatively, you can maintain a few impaired containers for the purpose of debugging, while all other tasks return to the last successful deployment.
1516
+ :param minimum_healthy_percentage: Sets a minimum level of healthy tasks to maintain during deployment activity.
1517
+ :param protection_strategy: Determines how fleet deployment activity affects active game sessions on the fleet. With protection, a deployment honors game session protection, and delays actions that would interrupt a protected active game session until the game session ends. Without protection, deployment activity can shut down all running tasks, including active game sessions, regardless of game session protection.
1511
1518
 
1512
1519
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-deploymentconfiguration.html
1513
1520
  :exampleMetadata: fixture=_generated
@@ -1539,9 +1546,9 @@ class CfnContainerFleet(
1539
1546
 
1540
1547
  @builtins.property
1541
1548
  def impairment_strategy(self) -> typing.Optional[builtins.str]:
1542
- '''The strategy to apply in case of impairment;
1549
+ '''Determines what actions to take if a deployment fails.
1543
1550
 
1544
- defaults to MAINTAIN.
1551
+ If the fleet is multi-location, this strategy applies across all fleet locations. With a rollback strategy, updated fleet instances are rolled back to the last successful deployment. Alternatively, you can maintain a few impaired containers for the purpose of debugging, while all other tasks return to the last successful deployment.
1545
1552
 
1546
1553
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-deploymentconfiguration.html#cfn-gamelift-containerfleet-deploymentconfiguration-impairmentstrategy
1547
1554
  '''
@@ -1550,9 +1557,7 @@ class CfnContainerFleet(
1550
1557
 
1551
1558
  @builtins.property
1552
1559
  def minimum_healthy_percentage(self) -> typing.Optional[jsii.Number]:
1553
- '''The minimum percentage of healthy required;
1554
-
1555
- defaults to 75.
1560
+ '''Sets a minimum level of healthy tasks to maintain during deployment activity.
1556
1561
 
1557
1562
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-deploymentconfiguration.html#cfn-gamelift-containerfleet-deploymentconfiguration-minimumhealthypercentage
1558
1563
  '''
@@ -1561,9 +1566,9 @@ class CfnContainerFleet(
1561
1566
 
1562
1567
  @builtins.property
1563
1568
  def protection_strategy(self) -> typing.Optional[builtins.str]:
1564
- '''The protection strategy for deployment on the container fleet;
1569
+ '''Determines how fleet deployment activity affects active game sessions on the fleet.
1565
1570
 
1566
- defaults to WITH_PROTECTION.
1571
+ With protection, a deployment honors game session protection, and delays actions that would interrupt a protected active game session until the game session ends. Without protection, deployment activity can shut down all running tasks, including active game sessions, regardless of game session protection.
1567
1572
 
1568
1573
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-deploymentconfiguration.html#cfn-gamelift-containerfleet-deploymentconfiguration-protectionstrategy
1569
1574
  '''
@@ -1592,9 +1597,9 @@ class CfnContainerFleet(
1592
1597
  *,
1593
1598
  latest_deployment_id: typing.Optional[builtins.str] = None,
1594
1599
  ) -> None:
1595
- '''Provides information about the last deployment ID and its status.
1600
+ '''Information about the most recent deployment for the container fleet.
1596
1601
 
1597
- :param latest_deployment_id: The ID of the last deployment on the container fleet. This field will be empty if the container fleet does not have a ContainerGroupDefinition attached.
1602
+ :param latest_deployment_id: A unique identifier for a fleet deployment.
1598
1603
 
1599
1604
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-deploymentdetails.html
1600
1605
  :exampleMetadata: fixture=_generated
@@ -1618,9 +1623,7 @@ class CfnContainerFleet(
1618
1623
 
1619
1624
  @builtins.property
1620
1625
  def latest_deployment_id(self) -> typing.Optional[builtins.str]:
1621
- '''The ID of the last deployment on the container fleet.
1622
-
1623
- This field will be empty if the container fleet does not have a ContainerGroupDefinition attached.
1626
+ '''A unique identifier for a fleet deployment.
1624
1627
 
1625
1628
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-deploymentdetails.html#cfn-gamelift-containerfleet-deploymentdetails-latestdeploymentid
1626
1629
  '''
@@ -1653,13 +1656,13 @@ class CfnContainerFleet(
1653
1656
  new_game_sessions_per_creator: typing.Optional[jsii.Number] = None,
1654
1657
  policy_period_in_minutes: typing.Optional[jsii.Number] = None,
1655
1658
  ) -> None:
1656
- '''A policy that limits the number of game sessions a player can create on the same fleet.
1659
+ '''A policy that puts limits on the number of game sessions that a player can create within a specified span of time.
1657
1660
 
1658
- This optional policy gives game owners control over how players can consume available game server resources. A resource creation policy makes the following statement: "An individual player can create a maximum number of new game sessions within a specified time period".
1661
+ With this policy, you can control players' ability to consume available resources.
1659
1662
 
1660
- The policy is evaluated when a player tries to create a new game session. For example, assume you have a policy of 10 new game sessions and a time period of 60 minutes. On receiving a CreateGameSession request, Amazon GameLift checks that the player (identified by CreatorId) has created fewer than 10 game sessions in the past 60 minutes.
1663
+ The policy is evaluated when a player tries to create a new game session. On receiving a ``CreateGameSession`` request, Amazon GameLift checks that the player (identified by ``CreatorId`` ) has created fewer than game session limit in the specified time period.
1661
1664
 
1662
- :param new_game_sessions_per_creator: The maximum number of game sessions that an individual can create during the policy period.
1665
+ :param new_game_sessions_per_creator: A policy that puts limits on the number of game sessions that a player can create within a specified span of time. With this policy, you can control players' ability to consume available resources. The policy evaluates when a player tries to create a new game session. On receiving a ``CreateGameSession`` request, Amazon GameLift checks that the player (identified by ``CreatorId`` ) has created fewer than game session limit in the specified time period.
1663
1666
  :param policy_period_in_minutes: The time span used in evaluating the resource creation limit policy.
1664
1667
 
1665
1668
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-gamesessioncreationlimitpolicy.html
@@ -1688,7 +1691,11 @@ class CfnContainerFleet(
1688
1691
 
1689
1692
  @builtins.property
1690
1693
  def new_game_sessions_per_creator(self) -> typing.Optional[jsii.Number]:
1691
- '''The maximum number of game sessions that an individual can create during the policy period.
1694
+ '''A policy that puts limits on the number of game sessions that a player can create within a specified span of time.
1695
+
1696
+ With this policy, you can control players' ability to consume available resources.
1697
+
1698
+ The policy evaluates when a player tries to create a new game session. On receiving a ``CreateGameSession`` request, Amazon GameLift checks that the player (identified by ``CreatorId`` ) has created fewer than game session limit in the specified time period.
1692
1699
 
1693
1700
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-gamesessioncreationlimitpolicy.html#cfn-gamelift-containerfleet-gamesessioncreationlimitpolicy-newgamesessionspercreator
1694
1701
  '''
@@ -1734,14 +1741,16 @@ class CfnContainerFleet(
1734
1741
  protocol: builtins.str,
1735
1742
  to_port: jsii.Number,
1736
1743
  ) -> None:
1737
- '''A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift hosting resource.
1744
+ '''A range of IP addresses and port settings that allow inbound traffic to connect to processes on an instance in a fleet.
1745
+
1746
+ Processes are assigned an IP address/port number combination, which must fall into the fleet's allowed ranges.
1738
1747
 
1739
- New game sessions that are started on the fleet are assigned an IP address/port number combination, which must fall into the fleet's allowed ranges. For fleets created with a custom game server, the ranges reflect the server's game session assignments. For Realtime Servers fleets, Amazon GameLift automatically opens two port ranges, one for TCP messaging and one for UDP, for use by the Realtime servers.
1748
+ For Realtime Servers fleets, Amazon GameLift automatically opens two port ranges, one for TCP messaging and one for UDP.
1740
1749
 
1741
- :param from_port: A starting value for a range of allowed port numbers.
1742
- :param ip_range: A range of allowed IP addresses. This value must be expressed in CIDR notation. Example: "000.000.000.000/[subnet mask]" or optionally the shortened version "0.0.0.0/[subnet mask]".
1750
+ :param from_port: A starting value for a range of allowed port numbers. For fleets using Linux builds, only ports ``22`` and ``1026-60000`` are valid. For fleets using Windows builds, only ports ``1026-60000`` are valid.
1751
+ :param ip_range: A range of allowed IP addresses. This value must be expressed in CIDR notation. Example: " ``000.000.000.000/[subnet mask]`` " or optionally the shortened version " ``0.0.0.0/[subnet mask]`` ".
1743
1752
  :param protocol: The network communication protocol used by the fleet.
1744
- :param to_port: An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort.
1753
+ :param to_port: An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be equal to or greater than ``FromPort`` . For fleets using Linux builds, only ports ``22`` and ``1026-60000`` are valid. For fleets using Windows builds, only ports ``1026-60000`` are valid.
1745
1754
 
1746
1755
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-ippermission.html
1747
1756
  :exampleMetadata: fixture=_generated
@@ -1776,6 +1785,10 @@ class CfnContainerFleet(
1776
1785
  def from_port(self) -> jsii.Number:
1777
1786
  '''A starting value for a range of allowed port numbers.
1778
1787
 
1788
+ For fleets using Linux builds, only ports ``22`` and ``1026-60000`` are valid.
1789
+
1790
+ For fleets using Windows builds, only ports ``1026-60000`` are valid.
1791
+
1779
1792
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-ippermission.html#cfn-gamelift-containerfleet-ippermission-fromport
1780
1793
  '''
1781
1794
  result = self._values.get("from_port")
@@ -1786,7 +1799,7 @@ class CfnContainerFleet(
1786
1799
  def ip_range(self) -> builtins.str:
1787
1800
  '''A range of allowed IP addresses.
1788
1801
 
1789
- This value must be expressed in CIDR notation. Example: "000.000.000.000/[subnet mask]" or optionally the shortened version "0.0.0.0/[subnet mask]".
1802
+ This value must be expressed in CIDR notation. Example: " ``000.000.000.000/[subnet mask]`` " or optionally the shortened version " ``0.0.0.0/[subnet mask]`` ".
1790
1803
 
1791
1804
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-ippermission.html#cfn-gamelift-containerfleet-ippermission-iprange
1792
1805
  '''
@@ -1808,7 +1821,11 @@ class CfnContainerFleet(
1808
1821
  def to_port(self) -> jsii.Number:
1809
1822
  '''An ending value for a range of allowed port numbers.
1810
1823
 
1811
- Port numbers are end-inclusive. This value must be higher than FromPort.
1824
+ Port numbers are end-inclusive. This value must be equal to or greater than ``FromPort`` .
1825
+
1826
+ For fleets using Linux builds, only ports ``22`` and ``1026-60000`` are valid.
1827
+
1828
+ For fleets using Windows builds, only ports ``1026-60000`` are valid.
1812
1829
 
1813
1830
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-ippermission.html#cfn-gamelift-containerfleet-ippermission-toport
1814
1831
  '''
@@ -1938,9 +1955,9 @@ class CfnContainerFleet(
1938
1955
  location_capacity: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnContainerFleet.LocationCapacityProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
1939
1956
  stopped_actions: typing.Optional[typing.Sequence[builtins.str]] = None,
1940
1957
  ) -> None:
1941
- '''A remote location where a multi-location fleet can deploy EC2 instances for game hosting.
1958
+ '''A remote location where a multi-location fleet can deploy game servers for game hosting.
1942
1959
 
1943
- :param location:
1960
+ :param location: An AWS Region code, such as ``us-west-2`` . For a list of supported Regions and Local Zones, see `Amazon GameLift service locations <https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-regions.html>`_ for managed hosting.
1944
1961
  :param location_capacity: Current resource capacity settings in a specified fleet or location. The location value might refer to a fleet's remote location or its home Region.
1945
1962
  :param stopped_actions: A list of fleet actions that have been suspended in the fleet location.
1946
1963
 
@@ -1980,7 +1997,10 @@ class CfnContainerFleet(
1980
1997
 
1981
1998
  @builtins.property
1982
1999
  def location(self) -> builtins.str:
1983
- '''
2000
+ '''An AWS Region code, such as ``us-west-2`` .
2001
+
2002
+ For a list of supported Regions and Local Zones, see `Amazon GameLift service locations <https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-regions.html>`_ for managed hosting.
2003
+
1984
2004
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-locationconfiguration.html#cfn-gamelift-containerfleet-locationconfiguration-location
1985
2005
  '''
1986
2006
  result = self._values.get("location")
@@ -2035,10 +2055,12 @@ class CfnContainerFleet(
2035
2055
  log_destination: typing.Optional[builtins.str] = None,
2036
2056
  s3_bucket_name: typing.Optional[builtins.str] = None,
2037
2057
  ) -> None:
2038
- '''A policy the location and provider of logs from the fleet.
2058
+ '''A method for collecting container logs for the fleet.
2039
2059
 
2040
- :param log_destination: Configures the service that provides logs.
2041
- :param s3_bucket_name: The name of the S3 bucket to pull logs from if S3 is the LogDestination.
2060
+ Amazon GameLift saves all standard output for each container in logs, including game session logs. You can select from the following methods:
2061
+
2062
+ :param log_destination: The type of log collection to use for a fleet. - ``CLOUDWATCH`` -- (default value) Send logs to an Amazon CloudWatch log group that you define. Each container emits a log stream, which is organized in the log group. - ``S3`` -- Store logs in an Amazon S3 bucket that you define. - ``NONE`` -- Don't collect container logs.
2063
+ :param s3_bucket_name: If log destination is ``S3`` , logs are sent to the specified Amazon S3 bucket name.
2042
2064
 
2043
2065
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-logconfiguration.html
2044
2066
  :exampleMetadata: fixture=_generated
@@ -2066,7 +2088,11 @@ class CfnContainerFleet(
2066
2088
 
2067
2089
  @builtins.property
2068
2090
  def log_destination(self) -> typing.Optional[builtins.str]:
2069
- '''Configures the service that provides logs.
2091
+ '''The type of log collection to use for a fleet.
2092
+
2093
+ - ``CLOUDWATCH`` -- (default value) Send logs to an Amazon CloudWatch log group that you define. Each container emits a log stream, which is organized in the log group.
2094
+ - ``S3`` -- Store logs in an Amazon S3 bucket that you define.
2095
+ - ``NONE`` -- Don't collect container logs.
2070
2096
 
2071
2097
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-logconfiguration.html#cfn-gamelift-containerfleet-logconfiguration-logdestination
2072
2098
  '''
@@ -2075,7 +2101,7 @@ class CfnContainerFleet(
2075
2101
 
2076
2102
  @builtins.property
2077
2103
  def s3_bucket_name(self) -> typing.Optional[builtins.str]:
2078
- '''The name of the S3 bucket to pull logs from if S3 is the LogDestination.
2104
+ '''If log destination is ``S3`` , logs are sent to the specified Amazon S3 bucket name.
2079
2105
 
2080
2106
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-logconfiguration.html#cfn-gamelift-containerfleet-logconfiguration-s3bucketname
2081
2107
  '''
@@ -2126,14 +2152,14 @@ class CfnContainerFleet(
2126
2152
 
2127
2153
  Scaling policies are uniquely identified by the combination of name and fleet ID.
2128
2154
 
2129
- :param metric_name: Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment.
2155
+ :param metric_name: Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment. For detailed descriptions of fleet metrics, see `Monitor Amazon GameLift with Amazon CloudWatch <https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html>`_ . - *ActivatingGameSessions* -- Game sessions in the process of being created. - *ActiveGameSessions* -- Game sessions that are currently running. - *ActiveInstances* -- Fleet instances that are currently running at least one game session. - *AvailableGameSessions* -- Additional game sessions that fleet could host simultaneously, given current capacity. - *AvailablePlayerSessions* -- Empty player slots in currently active game sessions. This includes game sessions that are not currently accepting players. Reserved player slots are not included. - *CurrentPlayerSessions* -- Player slots in active game sessions that are being used by a player or are reserved for a player. - *IdleInstances* -- Active instances that are currently hosting zero game sessions. - *PercentAvailableGameSessions* -- Unused percentage of the total number of game sessions that a fleet could host simultaneously, given current capacity. Use this metric for a target-based scaling policy. - *PercentIdleInstances* -- Percentage of the total number of active instances that are hosting zero game sessions. - *QueueDepth* -- Pending game session placement requests, in any queue, where the current fleet is the top-priority destination. - *WaitTime* -- Current wait time for pending game session placement requests, in any queue, where the current fleet is the top-priority destination.
2130
2156
  :param name: A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique.
2131
2157
  :param comparison_operator: Comparison operator to use when measuring a metric against the threshold value.
2132
2158
  :param evaluation_periods: Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
2133
- :param policy_type: The type of scaling policy to create. For a target-based policy, set the parameter MetricName to 'PercentAvailableGameSessions' and specify a TargetConfiguration. For a rule-based policy set the following parameters: MetricName, ComparisonOperator, Threshold, EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment.
2159
+ :param policy_type: The type of scaling policy to create. For a target-based policy, set the parameter *MetricName* to 'PercentAvailableGameSessions' and specify a *TargetConfiguration* . For a rule-based policy set the following parameters: *MetricName* , *ComparisonOperator* , *Threshold* , *EvaluationPeriods* , *ScalingAdjustmentType* , and *ScalingAdjustment* .
2134
2160
  :param scaling_adjustment: Amount of adjustment to make, based on the scaling adjustment type.
2135
- :param scaling_adjustment_type: The type of adjustment to make to a fleet's instance count.
2136
- :param target_configuration: Settings for a target-based scaling policy. A target-based policy tracks a particular fleet metric specifies a target value for the metric. As player usage changes, the policy triggers Amazon GameLift to adjust capacity so that the metric returns to the target value. The target configuration specifies settings as needed for the target based policy, including the target value.
2161
+ :param scaling_adjustment_type: The type of adjustment to make to a fleet's instance count. - *ChangeInCapacity* -- add (or subtract) the scaling adjustment value from the current instance count. Positive values scale up while negative values scale down. - *ExactCapacity* -- set the instance count to the scaling adjustment value. - *PercentChangeInCapacity* -- increase or reduce the current instance count by the scaling adjustment, read as a percentage. Positive values scale up while negative values scale down.
2162
+ :param target_configuration: An object that contains settings for a target-based scaling policy.
2137
2163
  :param threshold: Metric value used to trigger a scaling event.
2138
2164
 
2139
2165
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-scalingpolicy.html
@@ -2195,6 +2221,20 @@ class CfnContainerFleet(
2195
2221
  def metric_name(self) -> builtins.str:
2196
2222
  '''Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment.
2197
2223
 
2224
+ For detailed descriptions of fleet metrics, see `Monitor Amazon GameLift with Amazon CloudWatch <https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html>`_ .
2225
+
2226
+ - *ActivatingGameSessions* -- Game sessions in the process of being created.
2227
+ - *ActiveGameSessions* -- Game sessions that are currently running.
2228
+ - *ActiveInstances* -- Fleet instances that are currently running at least one game session.
2229
+ - *AvailableGameSessions* -- Additional game sessions that fleet could host simultaneously, given current capacity.
2230
+ - *AvailablePlayerSessions* -- Empty player slots in currently active game sessions. This includes game sessions that are not currently accepting players. Reserved player slots are not included.
2231
+ - *CurrentPlayerSessions* -- Player slots in active game sessions that are being used by a player or are reserved for a player.
2232
+ - *IdleInstances* -- Active instances that are currently hosting zero game sessions.
2233
+ - *PercentAvailableGameSessions* -- Unused percentage of the total number of game sessions that a fleet could host simultaneously, given current capacity. Use this metric for a target-based scaling policy.
2234
+ - *PercentIdleInstances* -- Percentage of the total number of active instances that are hosting zero game sessions.
2235
+ - *QueueDepth* -- Pending game session placement requests, in any queue, where the current fleet is the top-priority destination.
2236
+ - *WaitTime* -- Current wait time for pending game session placement requests, in any queue, where the current fleet is the top-priority destination.
2237
+
2198
2238
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-scalingpolicy.html#cfn-gamelift-containerfleet-scalingpolicy-metricname
2199
2239
  '''
2200
2240
  result = self._values.get("metric_name")
@@ -2235,7 +2275,7 @@ class CfnContainerFleet(
2235
2275
  def policy_type(self) -> typing.Optional[builtins.str]:
2236
2276
  '''The type of scaling policy to create.
2237
2277
 
2238
- For a target-based policy, set the parameter MetricName to 'PercentAvailableGameSessions' and specify a TargetConfiguration. For a rule-based policy set the following parameters: MetricName, ComparisonOperator, Threshold, EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment.
2278
+ For a target-based policy, set the parameter *MetricName* to 'PercentAvailableGameSessions' and specify a *TargetConfiguration* . For a rule-based policy set the following parameters: *MetricName* , *ComparisonOperator* , *Threshold* , *EvaluationPeriods* , *ScalingAdjustmentType* , and *ScalingAdjustment* .
2239
2279
 
2240
2280
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-scalingpolicy.html#cfn-gamelift-containerfleet-scalingpolicy-policytype
2241
2281
  '''
@@ -2255,6 +2295,10 @@ class CfnContainerFleet(
2255
2295
  def scaling_adjustment_type(self) -> typing.Optional[builtins.str]:
2256
2296
  '''The type of adjustment to make to a fleet's instance count.
2257
2297
 
2298
+ - *ChangeInCapacity* -- add (or subtract) the scaling adjustment value from the current instance count. Positive values scale up while negative values scale down.
2299
+ - *ExactCapacity* -- set the instance count to the scaling adjustment value.
2300
+ - *PercentChangeInCapacity* -- increase or reduce the current instance count by the scaling adjustment, read as a percentage. Positive values scale up while negative values scale down.
2301
+
2258
2302
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-scalingpolicy.html#cfn-gamelift-containerfleet-scalingpolicy-scalingadjustmenttype
2259
2303
  '''
2260
2304
  result = self._values.get("scaling_adjustment_type")
@@ -2264,9 +2308,7 @@ class CfnContainerFleet(
2264
2308
  def target_configuration(
2265
2309
  self,
2266
2310
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnContainerFleet.TargetConfigurationProperty"]]:
2267
- '''Settings for a target-based scaling policy.
2268
-
2269
- A target-based policy tracks a particular fleet metric specifies a target value for the metric. As player usage changes, the policy triggers Amazon GameLift to adjust capacity so that the metric returns to the target value. The target configuration specifies settings as needed for the target based policy, including the target value.
2311
+ '''An object that contains settings for a target-based scaling policy.
2270
2312
 
2271
2313
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-scalingpolicy.html#cfn-gamelift-containerfleet-scalingpolicy-targetconfiguration
2272
2314
  '''
@@ -2397,21 +2439,21 @@ class CfnContainerFleetProps:
2397
2439
  ) -> None:
2398
2440
  '''Properties for defining a ``CfnContainerFleet``.
2399
2441
 
2400
- :param fleet_role_arn: A unique identifier for an AWS IAM role that manages access to your AWS services. Create a role or look up a role's ARN from the IAM dashboard in the AWS Management Console.
2401
- :param billing_type: Indicates whether to use On-Demand instances or Spot instances for this fleet. If empty, the default is ON_DEMAND. Both categories of instances use identical hardware and configurations based on the instance type selected for this fleet.
2402
- :param deployment_configuration: Provides details about how to drain old tasks and replace them with new updated tasks.
2403
- :param description: A human-readable description of a fleet.
2404
- :param game_server_container_group_definition_name: The name of the container group definition that will be created per game server. You must specify GAME_SERVER container group. You have the option to also specify one PER_INSTANCE container group.
2405
- :param game_server_container_groups_per_instance: The number of desired game server container groups per instance, a number between 1-5000.
2406
- :param game_session_creation_limit_policy: A policy that limits the number of game sessions a player can create on the same fleet. This optional policy gives game owners control over how players can consume available game server resources. A resource creation policy makes the following statement: "An individual player can create a maximum number of new game sessions within a specified time period". The policy is evaluated when a player tries to create a new game session. For example, assume you have a policy of 10 new game sessions and a time period of 60 minutes. On receiving a CreateGameSession request, Amazon GameLift checks that the player (identified by CreatorId) has created fewer than 10 game sessions in the past 60 minutes.
2407
- :param instance_connection_port_range: Defines the range of ports on the instance that allow inbound traffic to connect with containers in a fleet.
2408
- :param instance_inbound_permissions: A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.
2409
- :param instance_type: The name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.
2442
+ :param fleet_role_arn: The unique identifier for an AWS Identity and Access Management (IAM) role with permissions to run your containers on resources that are managed by Amazon GameLift. See `Set up an IAM service role <https://docs.aws.amazon.com/gamelift/latest/developerguide/setting-up-role.html>`_ . This fleet property can't be changed.
2443
+ :param billing_type: Indicates whether the fleet uses On-Demand or Spot instances for this fleet. 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>`_ . You can't update this fleet property. By default, this property is set to ``ON_DEMAND`` .
2444
+ :param deployment_configuration: Set of rules for processing a deployment for a container fleet update.
2445
+ :param description: A meaningful description of the container fleet.
2446
+ :param game_server_container_group_definition_name: The name of the fleet's game server container group definition, which describes how to deploy containers with your game server build and support software onto each fleet instance.
2447
+ :param game_server_container_groups_per_instance: The number of times to replicate the game server container group on each fleet instance.
2448
+ :param game_session_creation_limit_policy: A policy that limits the number of game sessions that each individual player can create on instances in this fleet. The limit applies for a specified span of time.
2449
+ :param instance_connection_port_range: 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.
2450
+ :param instance_inbound_permissions: The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet.
2451
+ :param instance_type: The Amazon EC2 instance type to use for all instances in the fleet. Instance type determines the computing resources and processing power that's available to host your game servers. This includes including CPU, memory, storage, and networking capacity. You can't update this fleet property.
2410
2452
  :param locations:
2411
- :param log_configuration: A policy the location and provider of logs from the fleet.
2412
- :param metric_groups: The name of an Amazon CloudWatch metric group. A metric group aggregates the metrics for all fleets in the group. Specify a string containing the metric group name. You can use an existing name or use a new name to create a new metric group. Currently, this parameter can have only one string.
2413
- :param new_game_session_protection_policy: A game session protection policy to apply to all game sessions hosted on instances in this fleet. When protected, active game sessions cannot be terminated during a scale-down event. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy to affect future game sessions on the fleet. You can also set protection for individual game sessions.
2414
- :param per_instance_container_group_definition_name: The name of the container group definition that will be created per instance. This field is optional if you specify GameServerContainerGroupDefinitionName.
2453
+ :param log_configuration: The method that is used to collect container logs for the fleet. Amazon GameLift saves all standard output for each container in logs, including game session logs. - ``CLOUDWATCH`` -- Send logs to an Amazon CloudWatch log group that you define. Each container emits a log stream, which is organized in the log group. - ``S3`` -- Store logs in an Amazon S3 bucket that you define. - ``NONE`` -- Don't collect container logs.
2454
+ :param metric_groups: The name of an AWS CloudWatch metric group to add this fleet to. Metric groups aggregate metrics for multiple fleets.
2455
+ :param new_game_session_protection_policy: Determines whether Amazon GameLift can shut down game sessions on the fleet that are actively running and hosting players. Amazon GameLift might prompt an instance shutdown when scaling down fleet capacity or when retiring unhealthy instances. You can also set game session protection for individual game sessions using `UpdateGameSession <https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSession.html>`_ . - *NoProtection* -- Game sessions can be shut down during active gameplay. - *FullProtection* -- Game sessions in ``ACTIVE`` status can't be shut down.
2456
+ :param per_instance_container_group_definition_name: The name of the fleet's per-instance container group definition.
2415
2457
  :param scaling_policies: A list of rules that control how a fleet is scaled.
2416
2458
  :param tags: An array of key-value pairs to apply to this resource.
2417
2459
 
@@ -2548,9 +2590,9 @@ class CfnContainerFleetProps:
2548
2590
 
2549
2591
  @builtins.property
2550
2592
  def fleet_role_arn(self) -> builtins.str:
2551
- '''A unique identifier for an AWS IAM role that manages access to your AWS services.
2593
+ '''The unique identifier for an AWS Identity and Access Management (IAM) role with permissions to run your containers on resources that are managed by Amazon GameLift.
2552
2594
 
2553
- Create a role or look up a role's ARN from the IAM dashboard in the AWS Management Console.
2595
+ See `Set up an IAM service role <https://docs.aws.amazon.com/gamelift/latest/developerguide/setting-up-role.html>`_ . This fleet property can't be changed.
2554
2596
 
2555
2597
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-fleetrolearn
2556
2598
  '''
@@ -2560,9 +2602,11 @@ class CfnContainerFleetProps:
2560
2602
 
2561
2603
  @builtins.property
2562
2604
  def billing_type(self) -> typing.Optional[builtins.str]:
2563
- '''Indicates whether to use On-Demand instances or Spot instances for this fleet.
2605
+ '''Indicates whether the fleet uses On-Demand or Spot instances for this fleet.
2606
+
2607
+ 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>`_ . You can't update this fleet property.
2564
2608
 
2565
- If empty, the default is ON_DEMAND. Both categories of instances use identical hardware and configurations based on the instance type selected for this fleet.
2609
+ By default, this property is set to ``ON_DEMAND`` .
2566
2610
 
2567
2611
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-billingtype
2568
2612
  '''
@@ -2573,7 +2617,7 @@ class CfnContainerFleetProps:
2573
2617
  def deployment_configuration(
2574
2618
  self,
2575
2619
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnContainerFleet.DeploymentConfigurationProperty]]:
2576
- '''Provides details about how to drain old tasks and replace them with new updated tasks.
2620
+ '''Set of rules for processing a deployment for a container fleet update.
2577
2621
 
2578
2622
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-deploymentconfiguration
2579
2623
  '''
@@ -2582,7 +2626,7 @@ class CfnContainerFleetProps:
2582
2626
 
2583
2627
  @builtins.property
2584
2628
  def description(self) -> typing.Optional[builtins.str]:
2585
- '''A human-readable description of a fleet.
2629
+ '''A meaningful description of the container fleet.
2586
2630
 
2587
2631
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-description
2588
2632
  '''
@@ -2593,9 +2637,7 @@ class CfnContainerFleetProps:
2593
2637
  def game_server_container_group_definition_name(
2594
2638
  self,
2595
2639
  ) -> typing.Optional[builtins.str]:
2596
- '''The name of the container group definition that will be created per game server.
2597
-
2598
- You must specify GAME_SERVER container group. You have the option to also specify one PER_INSTANCE container group.
2640
+ '''The name of the fleet's game server container group definition, which describes how to deploy containers with your game server build and support software onto each fleet instance.
2599
2641
 
2600
2642
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-gameservercontainergroupdefinitionname
2601
2643
  '''
@@ -2604,7 +2646,7 @@ class CfnContainerFleetProps:
2604
2646
 
2605
2647
  @builtins.property
2606
2648
  def game_server_container_groups_per_instance(self) -> typing.Optional[jsii.Number]:
2607
- '''The number of desired game server container groups per instance, a number between 1-5000.
2649
+ '''The number of times to replicate the game server container group on each fleet instance.
2608
2650
 
2609
2651
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-gameservercontainergroupsperinstance
2610
2652
  '''
@@ -2615,11 +2657,9 @@ class CfnContainerFleetProps:
2615
2657
  def game_session_creation_limit_policy(
2616
2658
  self,
2617
2659
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnContainerFleet.GameSessionCreationLimitPolicyProperty]]:
2618
- '''A policy that limits the number of game sessions a player can create on the same fleet.
2619
-
2620
- This optional policy gives game owners control over how players can consume available game server resources. A resource creation policy makes the following statement: "An individual player can create a maximum number of new game sessions within a specified time period".
2660
+ '''A policy that limits the number of game sessions that each individual player can create on instances in this fleet.
2621
2661
 
2622
- The policy is evaluated when a player tries to create a new game session. For example, assume you have a policy of 10 new game sessions and a time period of 60 minutes. On receiving a CreateGameSession request, Amazon GameLift checks that the player (identified by CreatorId) has created fewer than 10 game sessions in the past 60 minutes.
2662
+ The limit applies for a specified span of time.
2623
2663
 
2624
2664
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-gamesessioncreationlimitpolicy
2625
2665
  '''
@@ -2630,7 +2670,9 @@ class CfnContainerFleetProps:
2630
2670
  def instance_connection_port_range(
2631
2671
  self,
2632
2672
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnContainerFleet.ConnectionPortRangeProperty]]:
2633
- '''Defines the range of ports on the instance that allow inbound traffic to connect with containers in a fleet.
2673
+ '''The set of port numbers to open on each instance in a container fleet.
2674
+
2675
+ Connection ports are used by inbound traffic to connect with processes that are running in containers on the fleet.
2634
2676
 
2635
2677
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-instanceconnectionportrange
2636
2678
  '''
@@ -2641,7 +2683,7 @@ class CfnContainerFleetProps:
2641
2683
  def instance_inbound_permissions(
2642
2684
  self,
2643
2685
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, CfnContainerFleet.IpPermissionProperty]]]]:
2644
- '''A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.
2686
+ '''The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet.
2645
2687
 
2646
2688
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-instanceinboundpermissions
2647
2689
  '''
@@ -2650,9 +2692,9 @@ class CfnContainerFleetProps:
2650
2692
 
2651
2693
  @builtins.property
2652
2694
  def instance_type(self) -> typing.Optional[builtins.str]:
2653
- '''The name of an EC2 instance type that is supported in Amazon GameLift.
2695
+ '''The Amazon EC2 instance type to use for all instances in the fleet.
2654
2696
 
2655
- A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.
2697
+ Instance type determines the computing resources and processing power that's available to host your game servers. This includes including CPU, memory, storage, and networking capacity. You can't update this fleet property.
2656
2698
 
2657
2699
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-instancetype
2658
2700
  '''
@@ -2673,7 +2715,13 @@ class CfnContainerFleetProps:
2673
2715
  def log_configuration(
2674
2716
  self,
2675
2717
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnContainerFleet.LogConfigurationProperty]]:
2676
- '''A policy the location and provider of logs from the fleet.
2718
+ '''The method that is used to collect container logs for the fleet.
2719
+
2720
+ Amazon GameLift saves all standard output for each container in logs, including game session logs.
2721
+
2722
+ - ``CLOUDWATCH`` -- Send logs to an Amazon CloudWatch log group that you define. Each container emits a log stream, which is organized in the log group.
2723
+ - ``S3`` -- Store logs in an Amazon S3 bucket that you define.
2724
+ - ``NONE`` -- Don't collect container logs.
2677
2725
 
2678
2726
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-logconfiguration
2679
2727
  '''
@@ -2682,9 +2730,9 @@ class CfnContainerFleetProps:
2682
2730
 
2683
2731
  @builtins.property
2684
2732
  def metric_groups(self) -> typing.Optional[typing.List[builtins.str]]:
2685
- '''The name of an Amazon CloudWatch metric group.
2733
+ '''The name of an AWS CloudWatch metric group to add this fleet to.
2686
2734
 
2687
- A metric group aggregates the metrics for all fleets in the group. Specify a string containing the metric group name. You can use an existing name or use a new name to create a new metric group. Currently, this parameter can have only one string.
2735
+ Metric groups aggregate metrics for multiple fleets.
2688
2736
 
2689
2737
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-metricgroups
2690
2738
  '''
@@ -2693,9 +2741,12 @@ class CfnContainerFleetProps:
2693
2741
 
2694
2742
  @builtins.property
2695
2743
  def new_game_session_protection_policy(self) -> typing.Optional[builtins.str]:
2696
- '''A game session protection policy to apply to all game sessions hosted on instances in this fleet.
2744
+ '''Determines whether Amazon GameLift can shut down game sessions on the fleet that are actively running and hosting players.
2745
+
2746
+ Amazon GameLift might prompt an instance shutdown when scaling down fleet capacity or when retiring unhealthy instances. You can also set game session protection for individual game sessions using `UpdateGameSession <https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSession.html>`_ .
2697
2747
 
2698
- When protected, active game sessions cannot be terminated during a scale-down event. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy to affect future game sessions on the fleet. You can also set protection for individual game sessions.
2748
+ - *NoProtection* -- Game sessions can be shut down during active gameplay.
2749
+ - *FullProtection* -- Game sessions in ``ACTIVE`` status can't be shut down.
2699
2750
 
2700
2751
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-newgamesessionprotectionpolicy
2701
2752
  '''
@@ -2706,9 +2757,7 @@ class CfnContainerFleetProps:
2706
2757
  def per_instance_container_group_definition_name(
2707
2758
  self,
2708
2759
  ) -> typing.Optional[builtins.str]:
2709
- '''The name of the container group definition that will be created per instance.
2710
-
2711
- This field is optional if you specify GameServerContainerGroupDefinitionName.
2760
+ '''The name of the fleet's per-instance container group definition.
2712
2761
 
2713
2762
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html#cfn-gamelift-containerfleet-perinstancecontainergroupdefinitionname
2714
2763
  '''
@@ -2757,9 +2806,9 @@ class CfnContainerGroupDefinition(
2757
2806
 
2758
2807
  You can update all properties of a container group definition properties. Updates to a container group definition are saved as new versions.
2759
2808
 
2760
- *Used with:* ``CreateContainerGroupDefinition``
2809
+ *Used with:* `CreateContainerGroupDefinition <https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateContainerGroupDefinition.html>`_
2761
2810
 
2762
- *Returned by:* ``DescribeContainerGroupDefinition`` , ``ListContainerGroupDefinitions`` , ``UpdateContainerGroupDefinition``
2811
+ *Returned by:* `DescribeContainerGroupDefinition <https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeContainerGroupDefinition.html>`_ , `ListContainerGroupDefinitions <https://docs.aws.amazon.com/gamelift/latest/apireference/API_ListContainerGroupDefinitions.html>`_ , `UpdateContainerGroupDefinition <https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateContainerGroupDefinition.html>`_
2763
2812
 
2764
2813
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html
2765
2814
  :cloudformationResource: AWS::GameLift::ContainerGroupDefinition
@@ -2880,14 +2929,14 @@ class CfnContainerGroupDefinition(
2880
2929
  :param id: Construct identifier for this resource (unique in its scope).
2881
2930
  :param name: A descriptive identifier for the container group definition. The name value is unique in an AWS Region.
2882
2931
  :param operating_system: The platform that all containers in the container group definition run on. .. epigraph:: Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more details in the `Amazon Linux 2 FAQs <https://docs.aws.amazon.com/https://aws.amazon.com/amazon-linux-2/faqs/>`_ . For game servers that are hosted on AL2 and use Amazon GameLift server SDK 4.x, first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See `Migrate to Amazon GameLift server SDK version 5. <https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk5-migration.html>`_
2883
- :param total_memory_limit_mebibytes: The total memory limit of container groups following this definition in MiB.
2884
- :param total_vcpu_limit: The total amount of virtual CPUs on the container group definition.
2885
- :param container_group_type: The scope of the container group.
2886
- :param game_server_container_definition: Specifies the information required to run game servers with this container group.
2932
+ :param total_memory_limit_mebibytes: 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 a limit for each container definition in the group. If individual containers have limits, this total value must be greater than any individual container's memory limit.
2933
+ :param total_vcpu_limit: The amount of vCPU units on a fleet instance to allocate for the container group (1 vCPU is equal to 1024 CPU units). All containers in the group share these resources. You can set a limit for each container definition in the group. If individual containers have limits, this total value must be equal to or greater than the sum of the limits for each container in the group.
2934
+ :param container_group_type: The type of container group. Container group type determines how Amazon GameLift deploys the container group on each fleet instance.
2935
+ :param game_server_container_definition: The definition for the game server container in this group. This property is used only when the container group type is ``GAME_SERVER`` . This container definition specifies a container image with the game server build.
2887
2936
  :param source_version_number: A specific ContainerGroupDefinition version to be updated.
2888
2937
  :param support_container_definitions: The set of definitions for support containers in this group. A container group definition might have zero support container definitions. Support container can be used in any type of container group.
2889
2938
  :param tags: An array of key-value pairs to apply to this resource.
2890
- :param version_description: The description of this version.
2939
+ :param version_description: An optional description that was provided for a container group definition update. Each version can have a unique description.
2891
2940
  '''
2892
2941
  if __debug__:
2893
2942
  type_hints = typing.get_type_hints(_typecheckingstub__2d0ad3aeb1243549bc05c0346bb1e8303d21326ec9f1a17ec63327d7e3f29a1e)
@@ -2976,8 +3025,8 @@ class CfnContainerGroupDefinition(
2976
3025
  def attr_status_reason(self) -> builtins.str:
2977
3026
  '''Additional information about a container group definition that's in ``FAILED`` status. Possible reasons include:.
2978
3027
 
2979
- - An internal issue prevented Amazon GameLift from creating the container group definition resource. Delete the failed resource and call ``CreateContainerGroupDefinition`` again.
2980
- - An access-denied message means that you don't have permissions to access the container image on ECR. See `IAM permission examples <https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-iam-policy-examples.html>`_ for help setting up required IAM permissions for Amazon GameLift.
3028
+ - An internal issue prevented Amazon GameLift from creating the container group definition resource. Delete the failed resource and call `CreateContainerGroupDefinition <https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateContainerGroupDefinition.html>`_ again.
3029
+ - An access-denied message means that you don't have permissions to access the container image on ECR. See `IAM permission examples <https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-iam-policy-examples.html.html>`_ for help setting up required IAM permissions for Amazon GameLift.
2981
3030
  - The ``ImageUri`` value for at least one of the containers in the container group definition was invalid or not found in the current AWS account.
2982
3031
  - At least one of the container images referenced in the container group definition exceeds the allowed size. For size limits, see `Amazon GameLift endpoints and quotas <https://docs.aws.amazon.com/general/latest/gr/gamelift.html>`_ .
2983
3032
  - At least one of the container images referenced in the container group definition uses a different operating system than the one defined for the container group.
@@ -2989,7 +3038,9 @@ class CfnContainerGroupDefinition(
2989
3038
  @builtins.property
2990
3039
  @jsii.member(jsii_name="attrVersionNumber")
2991
3040
  def attr_version_number(self) -> jsii.Number:
2992
- '''The version of this ContainerGroupDefinition.
3041
+ '''Indicates the version of a particular container group definition.
3042
+
3043
+ This number is incremented automatically when you update a container group definition. You can view, update, or delete individual versions or the entire container group definition.
2993
3044
 
2994
3045
  :cloudformationAttribute: VersionNumber
2995
3046
  '''
@@ -3035,7 +3086,7 @@ class CfnContainerGroupDefinition(
3035
3086
  @builtins.property
3036
3087
  @jsii.member(jsii_name="totalMemoryLimitMebibytes")
3037
3088
  def total_memory_limit_mebibytes(self) -> jsii.Number:
3038
- '''The total memory limit of container groups following this definition in MiB.'''
3089
+ '''The amount of memory (in MiB) on a fleet instance to allocate for the container group.'''
3039
3090
  return typing.cast(jsii.Number, jsii.get(self, "totalMemoryLimitMebibytes"))
3040
3091
 
3041
3092
  @total_memory_limit_mebibytes.setter
@@ -3048,7 +3099,7 @@ class CfnContainerGroupDefinition(
3048
3099
  @builtins.property
3049
3100
  @jsii.member(jsii_name="totalVcpuLimit")
3050
3101
  def total_vcpu_limit(self) -> jsii.Number:
3051
- '''The total amount of virtual CPUs on the container group definition.'''
3102
+ '''The amount of vCPU units on a fleet instance to allocate for the container group (1 vCPU is equal to 1024 CPU units).'''
3052
3103
  return typing.cast(jsii.Number, jsii.get(self, "totalVcpuLimit"))
3053
3104
 
3054
3105
  @total_vcpu_limit.setter
@@ -3061,7 +3112,7 @@ class CfnContainerGroupDefinition(
3061
3112
  @builtins.property
3062
3113
  @jsii.member(jsii_name="containerGroupType")
3063
3114
  def container_group_type(self) -> typing.Optional[builtins.str]:
3064
- '''The scope of the container group.'''
3115
+ '''The type of container group.'''
3065
3116
  return typing.cast(typing.Optional[builtins.str], jsii.get(self, "containerGroupType"))
3066
3117
 
3067
3118
  @container_group_type.setter
@@ -3076,7 +3127,7 @@ class CfnContainerGroupDefinition(
3076
3127
  def game_server_container_definition(
3077
3128
  self,
3078
3129
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnContainerGroupDefinition.GameServerContainerDefinitionProperty"]]:
3079
- '''Specifies the information required to run game servers with this container group.'''
3130
+ '''The definition for the game server container in this group.'''
3080
3131
  return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnContainerGroupDefinition.GameServerContainerDefinitionProperty"]], jsii.get(self, "gameServerContainerDefinition"))
3081
3132
 
3082
3133
  @game_server_container_definition.setter
@@ -3136,7 +3187,7 @@ class CfnContainerGroupDefinition(
3136
3187
  @builtins.property
3137
3188
  @jsii.member(jsii_name="versionDescription")
3138
3189
  def version_description(self) -> typing.Optional[builtins.str]:
3139
- '''The description of this version.'''
3190
+ '''An optional description that was provided for a container group definition update.'''
3140
3191
  return typing.cast(typing.Optional[builtins.str], jsii.get(self, "versionDescription"))
3141
3192
 
3142
3193
  @version_description.setter
@@ -3158,10 +3209,16 @@ class CfnContainerGroupDefinition(
3158
3209
  condition: builtins.str,
3159
3210
  container_name: builtins.str,
3160
3211
  ) -> None:
3161
- '''A dependency that impacts a container's startup and shutdown.
3212
+ '''A container's dependency on another container in the same container group.
3213
+
3214
+ The dependency impacts how the dependent container is able to start or shut down based the status of the other container.
3215
+
3216
+ 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* .
3162
3217
 
3163
- :param condition: The type of dependency.
3164
- :param container_name: A descriptive label for the container definition. The container being defined depends on this container's condition.
3218
+ *Part of:* `GameServerContainerDefinition <https://docs.aws.amazon.com/gamelift/latest/apireference/API_GameServerContainerDefinition.html>`_ , `GameServerContainerDefinitionInput <https://docs.aws.amazon.com/gamelift/latest/apireference/API_GameServerContainerDefinitionInput.html>`_ , `SupportContainerDefinition <https://docs.aws.amazon.com/gamelift/latest/apireference/API_SupportContainerDefinition.html>`_ , `SupportContainerDefinitionInput <https://docs.aws.amazon.com/gamelift/latest/apireference/API_SupportContainerDefinitionInput.html>`_
3219
+
3220
+ :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.
3221
+ :param container_name: A descriptive label for the container definition that this container depends on.
3165
3222
 
3166
3223
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerdependency.html
3167
3224
  :exampleMetadata: fixture=_generated
@@ -3188,7 +3245,12 @@ class CfnContainerGroupDefinition(
3188
3245
 
3189
3246
  @builtins.property
3190
3247
  def condition(self) -> builtins.str:
3191
- '''The type of dependency.
3248
+ '''The condition that the dependency container must reach before the dependent container can start. Valid conditions include:.
3249
+
3250
+ - START - The dependency container must have started.
3251
+ - 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.
3252
+ - SUCCESS - The dependency container has run to completion and exited with a zero status. The dependency container can't be an essential container.
3253
+ - 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.
3192
3254
 
3193
3255
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerdependency.html#cfn-gamelift-containergroupdefinition-containerdependency-condition
3194
3256
  '''
@@ -3198,9 +3260,7 @@ class CfnContainerGroupDefinition(
3198
3260
 
3199
3261
  @builtins.property
3200
3262
  def container_name(self) -> builtins.str:
3201
- '''A descriptive label for the container definition.
3202
-
3203
- The container being defined depends on this container's condition.
3263
+ '''A descriptive label for the container definition that this container depends on.
3204
3264
 
3205
3265
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerdependency.html#cfn-gamelift-containergroupdefinition-containerdependency-containername
3206
3266
  '''
@@ -3228,6 +3288,8 @@ class CfnContainerGroupDefinition(
3228
3288
  def __init__(self, *, name: builtins.str, value: builtins.str) -> None:
3229
3289
  '''An environment variable to set inside a container, in the form of a key-value pair.
3230
3290
 
3291
+ *Part of:* `GameServerContainerDefinition <https://docs.aws.amazon.com/gamelift/latest/apireference/API_GameServerContainerDefinition.html>`_ , `GameServerContainerDefinitionInput <https://docs.aws.amazon.com/gamelift/latest/apireference/API_GameServerContainerDefinitionInput.html>`_ , `SupportContainerDefinition <https://docs.aws.amazon.com/gamelift/latest/apireference/API_SupportContainerDefinition.html>`_ , `SupportContainerDefinitionInput <https://docs.aws.amazon.com/gamelift/latest/apireference/API_SupportContainerDefinitionInput.html>`_
3292
+
3231
3293
  :param name: The environment variable name.
3232
3294
  :param value: The environment variable value.
3233
3295
 
@@ -3306,13 +3368,21 @@ class CfnContainerGroupDefinition(
3306
3368
  start_period: typing.Optional[jsii.Number] = None,
3307
3369
  timeout: typing.Optional[jsii.Number] = None,
3308
3370
  ) -> None:
3309
- '''Specifies how the process manager checks the health of containers.
3371
+ '''Instructions on when and how to check the health of a support container in a container fleet.
3310
3372
 
3311
- :param command: A string array representing the command that the container runs to determine if it is healthy.
3312
- :param interval: How often (in seconds) the health is checked.
3313
- :param retries: How many times the process manager will retry the command after a timeout. (The first run of the command does not count as a retry.)
3314
- :param start_period: The optional grace period (in seconds) to give a container time to boostrap before teh health check is declared failed.
3315
- :param timeout: How many seconds the process manager allows the command to run before canceling it.
3373
+ These properties override any Docker health checks that are set 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* . Game server containers don't have a health check parameter; Amazon GameLift automatically handles health checks for these containers.
3374
+
3375
+ The following example instructs the container to initiate a health check command every 60 seconds and wait 10 seconds for it to succeed. If it fails, retry the command 3 times before flagging the container as unhealthy. It also tells the container to wait 100 seconds after launch before counting failed health checks.
3376
+
3377
+ ``{"Command": [ "CMD-SHELL", "ps cax | grep "processmanager" || exit 1" ], "Interval": 60, "Timeout": 10, "Retries": 3, "StartPeriod": 100 }``
3378
+
3379
+ *Part of:* `SupportContainerDefinition <https://docs.aws.amazon.com/gamelift/latest/apireference/API_SupportContainerDefinition.html>`_ , `SupportContainerDefinitionInput <https://docs.aws.amazon.com/gamelift/latest/apireference/API_SupportContainerDefinitionInput.html>`_
3380
+
3381
+ :param command: A string array that specifies the command that the container runs to determine if it's healthy.
3382
+ :param interval: The time period (in seconds) between each health check.
3383
+ :param retries: The number of times to retry a failed health check before flagging the container unhealthy. The first run of the command does not count as a retry.
3384
+ :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.
3385
+ :param timeout: The time period (in seconds) to wait for a health check to succeed before counting a failed health check.
3316
3386
 
3317
3387
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerhealthcheck.html
3318
3388
  :exampleMetadata: fixture=_generated
@@ -3354,7 +3424,7 @@ class CfnContainerGroupDefinition(
3354
3424
 
3355
3425
  @builtins.property
3356
3426
  def command(self) -> typing.List[builtins.str]:
3357
- '''A string array representing the command that the container runs to determine if it is healthy.
3427
+ '''A string array that specifies the command that the container runs to determine if it's healthy.
3358
3428
 
3359
3429
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerhealthcheck.html#cfn-gamelift-containergroupdefinition-containerhealthcheck-command
3360
3430
  '''
@@ -3364,7 +3434,7 @@ class CfnContainerGroupDefinition(
3364
3434
 
3365
3435
  @builtins.property
3366
3436
  def interval(self) -> typing.Optional[jsii.Number]:
3367
- '''How often (in seconds) the health is checked.
3437
+ '''The time period (in seconds) between each health check.
3368
3438
 
3369
3439
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerhealthcheck.html#cfn-gamelift-containergroupdefinition-containerhealthcheck-interval
3370
3440
  '''
@@ -3373,9 +3443,9 @@ class CfnContainerGroupDefinition(
3373
3443
 
3374
3444
  @builtins.property
3375
3445
  def retries(self) -> typing.Optional[jsii.Number]:
3376
- '''How many times the process manager will retry the command after a timeout.
3446
+ '''The number of times to retry a failed health check before flagging the container unhealthy.
3377
3447
 
3378
- (The first run of the command does not count as a retry.)
3448
+ The first run of the command does not count as a retry.
3379
3449
 
3380
3450
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerhealthcheck.html#cfn-gamelift-containergroupdefinition-containerhealthcheck-retries
3381
3451
  '''
@@ -3384,7 +3454,7 @@ class CfnContainerGroupDefinition(
3384
3454
 
3385
3455
  @builtins.property
3386
3456
  def start_period(self) -> typing.Optional[jsii.Number]:
3387
- '''The optional grace period (in seconds) to give a container time to boostrap before teh health check is declared failed.
3457
+ '''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.
3388
3458
 
3389
3459
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerhealthcheck.html#cfn-gamelift-containergroupdefinition-containerhealthcheck-startperiod
3390
3460
  '''
@@ -3393,7 +3463,7 @@ class CfnContainerGroupDefinition(
3393
3463
 
3394
3464
  @builtins.property
3395
3465
  def timeout(self) -> typing.Optional[jsii.Number]:
3396
- '''How many seconds the process manager allows the command to run before canceling it.
3466
+ '''The time period (in seconds) to wait for a health check to succeed before counting a failed health check.
3397
3467
 
3398
3468
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerhealthcheck.html#cfn-gamelift-containergroupdefinition-containerhealthcheck-timeout
3399
3469
  '''
@@ -3428,11 +3498,13 @@ class CfnContainerGroupDefinition(
3428
3498
  access_level: typing.Optional[builtins.str] = None,
3429
3499
  container_path: typing.Optional[builtins.str] = None,
3430
3500
  ) -> None:
3431
- '''Defines the mount point configuration within a container.
3501
+ '''A mount point that binds a container to a file or directory on the host system.
3432
3502
 
3433
- :param instance_path: The path on the host that will be mounted in the container.
3434
- :param access_level: The access permissions for the mounted path.
3435
- :param container_path: The path inside the container where the mount is accessible.
3503
+ *Part of:* `GameServerContainerDefinition <https://docs.aws.amazon.com/gamelift/latest/apireference/API_GameServerContainerDefinition.html>`_ , ` <https://docs.aws.amazon.com/gamelift/latest/apireference/API_GameServerContainerDefinitionInput.html>`_ , `SupportContainerDefinition <https://docs.aws.amazon.com/gamelift/latest/apireference/API_SupportContainerDefinition.html>`_ , ` <https://docs.aws.amazon.com/gamelift/latest/apireference/API_SupportContainerDefinitionInput.html>`_
3504
+
3505
+ :param instance_path: The path to the source file or directory.
3506
+ :param access_level: The type of access for the container.
3507
+ :param container_path: The mount path on the container. If this property isn't set, the instance path is used.
3436
3508
 
3437
3509
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containermountpoint.html
3438
3510
  :exampleMetadata: fixture=_generated
@@ -3466,7 +3538,7 @@ class CfnContainerGroupDefinition(
3466
3538
 
3467
3539
  @builtins.property
3468
3540
  def instance_path(self) -> builtins.str:
3469
- '''The path on the host that will be mounted in the container.
3541
+ '''The path to the source file or directory.
3470
3542
 
3471
3543
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containermountpoint.html#cfn-gamelift-containergroupdefinition-containermountpoint-instancepath
3472
3544
  '''
@@ -3476,7 +3548,7 @@ class CfnContainerGroupDefinition(
3476
3548
 
3477
3549
  @builtins.property
3478
3550
  def access_level(self) -> typing.Optional[builtins.str]:
3479
- '''The access permissions for the mounted path.
3551
+ '''The type of access for the container.
3480
3552
 
3481
3553
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containermountpoint.html#cfn-gamelift-containergroupdefinition-containermountpoint-accesslevel
3482
3554
  '''
@@ -3485,7 +3557,9 @@ class CfnContainerGroupDefinition(
3485
3557
 
3486
3558
  @builtins.property
3487
3559
  def container_path(self) -> typing.Optional[builtins.str]:
3488
- '''The path inside the container where the mount is accessible.
3560
+ '''The mount path on the container.
3561
+
3562
+ If this property isn't set, the instance path is used.
3489
3563
 
3490
3564
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containermountpoint.html#cfn-gamelift-containergroupdefinition-containermountpoint-containerpath
3491
3565
  '''
@@ -3522,9 +3596,11 @@ class CfnContainerGroupDefinition(
3522
3596
  ) -> None:
3523
3597
  '''A set of one or more port numbers that can be opened on the container.
3524
3598
 
3599
+ *Part of:* `ContainerPortConfiguration <https://docs.aws.amazon.com/gamelift/latest/apireference/API_ContainerPortConfiguration.html>`_
3600
+
3525
3601
  :param from_port: A starting value for the range of allowed port numbers.
3526
- :param protocol: Defines the protocol of these ports.
3527
- :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.
3602
+ :param protocol: The network protocol that these ports support.
3603
+ :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`` .
3528
3604
 
3529
3605
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerportrange.html
3530
3606
  :exampleMetadata: fixture=_generated
@@ -3564,7 +3640,7 @@ class CfnContainerGroupDefinition(
3564
3640
 
3565
3641
  @builtins.property
3566
3642
  def protocol(self) -> builtins.str:
3567
- '''Defines the protocol of these ports.
3643
+ '''The network protocol that these ports support.
3568
3644
 
3569
3645
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerportrange.html#cfn-gamelift-containergroupdefinition-containerportrange-protocol
3570
3646
  '''
@@ -3576,7 +3652,7 @@ class CfnContainerGroupDefinition(
3576
3652
  def to_port(self) -> jsii.Number:
3577
3653
  '''An ending value for the range of allowed port numbers.
3578
3654
 
3579
- Port numbers are end-inclusive. This value must be equal to or greater than FromPort.
3655
+ Port numbers are end-inclusive. This value must be equal to or greater than ``FromPort`` .
3580
3656
 
3581
3657
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerportrange.html#cfn-gamelift-containergroupdefinition-containerportrange-toport
3582
3658
  '''
@@ -3622,16 +3698,24 @@ class CfnContainerGroupDefinition(
3622
3698
  port_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnContainerGroupDefinition.PortConfigurationProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
3623
3699
  resolved_image_digest: typing.Optional[builtins.str] = None,
3624
3700
  ) -> None:
3625
- '''Specifies the information required to run game servers with this container group.
3701
+ '''Describes the game server container in an existing game server container group.
3626
3702
 
3627
- :param container_name: A descriptive label for the container definition. Container definition names must be unique with a container group definition.
3628
- :param image_uri: Specifies the image URI of this container.
3629
- :param server_sdk_version: The version of the server SDK used in this container group.
3630
- :param depends_on: A list of container dependencies that determines when this container starts up and shuts down. For container groups with multiple containers, dependencies let you define a startup/shutdown sequence across the containers.
3631
- :param environment_override: The environment variables to pass to a container.
3632
- :param mount_points: A list of mount point configurations to be used in a container.
3633
- :param port_configuration: Defines the ports on a container.
3634
- :param resolved_image_digest: The digest of the container image.
3703
+ A game server container identifies a container image with your game server build. A game server container is automatically considered essential; if an essential container fails, the entire container group restarts.
3704
+
3705
+ You can update a container definition and deploy the updates to an existing fleet. When creating or updating a game server container group definition, use the property ` <https://docs.aws.amazon.com/gamelift/latest/apireference/API_GameServerContainerDefinitionInput>`_ .
3706
+
3707
+ *Part of:* `ContainerGroupDefinition <https://docs.aws.amazon.com/gamelift/latest/apireference/API_ContainerGroupDefinition.html>`_
3708
+
3709
+ *Returned by:* `DescribeContainerGroupDefinition <https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeContainerGroupDefinition.html>`_ , `ListContainerGroupDefinitions <https://docs.aws.amazon.com/gamelift/latest/apireference/API_ListContainerGroupDefinitions.html>`_ , `UpdateContainerGroupDefinition <https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateContainerGroupDefinition.html>`_
3710
+
3711
+ :param container_name: The container definition identifier. Container names are unique within a container group definition.
3712
+ :param image_uri: The URI to the image that Amazon GameLift uses when deploying this container to a container fleet. For a more specific identifier, see ``ResolvedImageDigest`` .
3713
+ :param server_sdk_version: The Amazon GameLift server SDK version that the game server is integrated with. Only game servers using 5.2.0 or higher are compatible with container fleets.
3714
+ :param depends_on: Indicates that the container relies on the status of other containers in the same container group during startup and shutdown sequences. A container might have dependencies on multiple containers.
3715
+ :param environment_override: 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* .
3716
+ :param mount_points: A mount point that binds a path inside the container to a file or directory on the host system and lets it access the file or directory.
3717
+ :param port_configuration: The set of ports that are available to bind 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`` .
3718
+ :param resolved_image_digest: A unique and immutable identifier for the container image. The digest is a SHA 256 hash of the container image manifest.
3635
3719
 
3636
3720
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-gameservercontainerdefinition.html
3637
3721
  :exampleMetadata: fixture=_generated
@@ -3701,9 +3785,9 @@ class CfnContainerGroupDefinition(
3701
3785
 
3702
3786
  @builtins.property
3703
3787
  def container_name(self) -> builtins.str:
3704
- '''A descriptive label for the container definition.
3788
+ '''The container definition identifier.
3705
3789
 
3706
- Container definition names must be unique with a container group definition.
3790
+ Container names are unique within a container group definition.
3707
3791
 
3708
3792
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-gameservercontainerdefinition.html#cfn-gamelift-containergroupdefinition-gameservercontainerdefinition-containername
3709
3793
  '''
@@ -3713,7 +3797,9 @@ class CfnContainerGroupDefinition(
3713
3797
 
3714
3798
  @builtins.property
3715
3799
  def image_uri(self) -> builtins.str:
3716
- '''Specifies the image URI of this container.
3800
+ '''The URI to the image that Amazon GameLift uses when deploying this container to a container fleet.
3801
+
3802
+ For a more specific identifier, see ``ResolvedImageDigest`` .
3717
3803
 
3718
3804
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-gameservercontainerdefinition.html#cfn-gamelift-containergroupdefinition-gameservercontainerdefinition-imageuri
3719
3805
  '''
@@ -3723,7 +3809,9 @@ class CfnContainerGroupDefinition(
3723
3809
 
3724
3810
  @builtins.property
3725
3811
  def server_sdk_version(self) -> builtins.str:
3726
- '''The version of the server SDK used in this container group.
3812
+ '''The Amazon GameLift server SDK version that the game server is integrated with.
3813
+
3814
+ Only game servers using 5.2.0 or higher are compatible with container fleets.
3727
3815
 
3728
3816
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-gameservercontainerdefinition.html#cfn-gamelift-containergroupdefinition-gameservercontainerdefinition-serversdkversion
3729
3817
  '''
@@ -3735,9 +3823,9 @@ class CfnContainerGroupDefinition(
3735
3823
  def depends_on(
3736
3824
  self,
3737
3825
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnContainerGroupDefinition.ContainerDependencyProperty"]]]]:
3738
- '''A list of container dependencies that determines when this container starts up and shuts down.
3826
+ '''Indicates that the container relies on the status of other containers in the same container group during startup and shutdown sequences.
3739
3827
 
3740
- For container groups with multiple containers, dependencies let you define a startup/shutdown sequence across the containers.
3828
+ A container might have dependencies on multiple containers.
3741
3829
 
3742
3830
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-gameservercontainerdefinition.html#cfn-gamelift-containergroupdefinition-gameservercontainerdefinition-dependson
3743
3831
  '''
@@ -3748,7 +3836,9 @@ class CfnContainerGroupDefinition(
3748
3836
  def environment_override(
3749
3837
  self,
3750
3838
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnContainerGroupDefinition.ContainerEnvironmentProperty"]]]]:
3751
- '''The environment variables to pass to a container.
3839
+ '''A set of environment variables that's passed to the container on startup.
3840
+
3841
+ 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* .
3752
3842
 
3753
3843
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-gameservercontainerdefinition.html#cfn-gamelift-containergroupdefinition-gameservercontainerdefinition-environmentoverride
3754
3844
  '''
@@ -3759,7 +3849,7 @@ class CfnContainerGroupDefinition(
3759
3849
  def mount_points(
3760
3850
  self,
3761
3851
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnContainerGroupDefinition.ContainerMountPointProperty"]]]]:
3762
- '''A list of mount point configurations to be used in a container.
3852
+ '''A mount point that binds a path inside the container to a file or directory on the host system and lets it access the file or directory.
3763
3853
 
3764
3854
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-gameservercontainerdefinition.html#cfn-gamelift-containergroupdefinition-gameservercontainerdefinition-mountpoints
3765
3855
  '''
@@ -3770,7 +3860,9 @@ class CfnContainerGroupDefinition(
3770
3860
  def port_configuration(
3771
3861
  self,
3772
3862
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnContainerGroupDefinition.PortConfigurationProperty"]]:
3773
- '''Defines the ports on a container.
3863
+ '''The set of ports that are available to bind to processes in the container.
3864
+
3865
+ 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`` .
3774
3866
 
3775
3867
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-gameservercontainerdefinition.html#cfn-gamelift-containergroupdefinition-gameservercontainerdefinition-portconfiguration
3776
3868
  '''
@@ -3779,7 +3871,9 @@ class CfnContainerGroupDefinition(
3779
3871
 
3780
3872
  @builtins.property
3781
3873
  def resolved_image_digest(self) -> typing.Optional[builtins.str]:
3782
- '''The digest of the container image.
3874
+ '''A unique and immutable identifier for the container image.
3875
+
3876
+ The digest is a SHA 256 hash of the container image manifest.
3783
3877
 
3784
3878
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-gameservercontainerdefinition.html#cfn-gamelift-containergroupdefinition-gameservercontainerdefinition-resolvedimagedigest
3785
3879
  '''
@@ -3892,19 +3986,27 @@ class CfnContainerGroupDefinition(
3892
3986
  resolved_image_digest: typing.Optional[builtins.str] = None,
3893
3987
  vcpu: typing.Optional[jsii.Number] = None,
3894
3988
  ) -> None:
3895
- '''Supports the function of the main container group.
3896
-
3897
- :param container_name: A descriptive label for the container definition.
3898
- :param image_uri: Specifies the image URI of this container.
3899
- :param depends_on: A list of container dependencies that determines when this container starts up and shuts down. For container groups with multiple containers, dependencies let you define a startup/shutdown sequence across the containers.
3900
- :param environment_override: The environment variables to pass to a container.
3901
- :param essential: Specifies if the container is essential. If an essential container fails a health check, then all containers in the container group will be restarted. You must specify exactly 1 essential container in a container group.
3902
- :param health_check: Specifies how the process manager checks the health of containers.
3903
- :param memory_hard_limit_mebibytes: The total memory limit of container groups following this definition in MiB.
3904
- :param mount_points: A list of mount point configurations to be used in a container.
3905
- :param port_configuration: Defines the ports on a container.
3906
- :param resolved_image_digest: The digest of the container image.
3907
- :param vcpu: The number of virtual CPUs to give to the support group.
3989
+ '''Describes a support container in a container group.
3990
+
3991
+ A support container might be in a game server container group or a per-instance container group. Support containers don't run game server processes.
3992
+
3993
+ You can update a support container definition and deploy the updates to an existing fleet. When creating or updating a game server container group definition, use the property `GameServerContainerDefinitionInput <https://docs.aws.amazon.com/gamelift/latest/apireference/API_GameServerContainerDefinitionInput.html>`_ .
3994
+
3995
+ *Part of:* `ContainerGroupDefinition <https://docs.aws.amazon.com/gamelift/latest/apireference/API_ContainerGroupDefinition.html>`_
3996
+
3997
+ *Returned by:* `DescribeContainerGroupDefinition <https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeContainerGroupDefinition.html>`_ , `ListContainerGroupDefinitions <https://docs.aws.amazon.com/gamelift/latest/apireference/API_ListContainerGroupDefinitions.html>`_ , `UpdateContainerGroupDefinition <https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateContainerGroupDefinition.html>`_
3998
+
3999
+ :param container_name: The container definition identifier. Container names are unique within a container group definition.
4000
+ :param image_uri: The URI to the image that Amazon GameLift deploys to a container fleet. For a more specific identifier, see ``ResolvedImageDigest`` .
4001
+ :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.
4002
+ :param environment_override: 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* .
4003
+ :param essential: Indicates whether the container is vital to the container group. If an essential container fails, the entire container group restarts.
4004
+ :param health_check: A configuration for a non-terminal health check. A support container automatically restarts if it stops functioning or if it fails this health check.
4005
+ :param memory_hard_limit_mebibytes: 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 TotalMemoryLimitMebibytes <https://docs.aws.amazon.com/gamelift/latest/apireference/API_ContainerGroupDefinition.html>`_
4006
+ :param mount_points: A mount point that binds a path inside the container to a file or directory on the host system and lets it access the file or directory.
4007
+ :param port_configuration: A set of ports that allow access to the container from external users. Processes running in the container can bind to a one of these ports. 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`` .
4008
+ :param resolved_image_digest: A unique and immutable identifier for the container image. The digest is a SHA 256 hash of the container image manifest.
4009
+ :param vcpu: The number of vCPU units that are reserved for the container. If no resources are reserved, the container shares the total vCPU limit for the container group. *Related data type:* `ContainerGroupDefinition TotalVcpuLimit <https://docs.aws.amazon.com/gamelift/latest/apireference/API_ContainerGroupDefinition.html>`_
3908
4010
 
3909
4011
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-supportcontainerdefinition.html
3910
4012
  :exampleMetadata: fixture=_generated
@@ -3995,7 +4097,9 @@ class CfnContainerGroupDefinition(
3995
4097
 
3996
4098
  @builtins.property
3997
4099
  def container_name(self) -> builtins.str:
3998
- '''A descriptive label for the container definition.
4100
+ '''The container definition identifier.
4101
+
4102
+ Container names are unique within a container group definition.
3999
4103
 
4000
4104
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-supportcontainerdefinition.html#cfn-gamelift-containergroupdefinition-supportcontainerdefinition-containername
4001
4105
  '''
@@ -4005,7 +4109,9 @@ class CfnContainerGroupDefinition(
4005
4109
 
4006
4110
  @builtins.property
4007
4111
  def image_uri(self) -> builtins.str:
4008
- '''Specifies the image URI of this container.
4112
+ '''The URI to the image that Amazon GameLift deploys to a container fleet.
4113
+
4114
+ For a more specific identifier, see ``ResolvedImageDigest`` .
4009
4115
 
4010
4116
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-supportcontainerdefinition.html#cfn-gamelift-containergroupdefinition-supportcontainerdefinition-imageuri
4011
4117
  '''
@@ -4017,9 +4123,9 @@ class CfnContainerGroupDefinition(
4017
4123
  def depends_on(
4018
4124
  self,
4019
4125
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnContainerGroupDefinition.ContainerDependencyProperty"]]]]:
4020
- '''A list of container dependencies that determines when this container starts up and shuts down.
4126
+ '''Indicates that the container relies on the status of other containers in the same container group during its startup and shutdown sequences.
4021
4127
 
4022
- For container groups with multiple containers, dependencies let you define a startup/shutdown sequence across the containers.
4128
+ A container might have dependencies on multiple containers.
4023
4129
 
4024
4130
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-supportcontainerdefinition.html#cfn-gamelift-containergroupdefinition-supportcontainerdefinition-dependson
4025
4131
  '''
@@ -4030,7 +4136,9 @@ class CfnContainerGroupDefinition(
4030
4136
  def environment_override(
4031
4137
  self,
4032
4138
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnContainerGroupDefinition.ContainerEnvironmentProperty"]]]]:
4033
- '''The environment variables to pass to a container.
4139
+ '''A set of environment variables that's passed to the container on startup.
4140
+
4141
+ 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* .
4034
4142
 
4035
4143
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-supportcontainerdefinition.html#cfn-gamelift-containergroupdefinition-supportcontainerdefinition-environmentoverride
4036
4144
  '''
@@ -4041,9 +4149,9 @@ class CfnContainerGroupDefinition(
4041
4149
  def essential(
4042
4150
  self,
4043
4151
  ) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
4044
- '''Specifies if the container is essential.
4152
+ '''Indicates whether the container is vital to the container group.
4045
4153
 
4046
- If an essential container fails a health check, then all containers in the container group will be restarted. You must specify exactly 1 essential container in a container group.
4154
+ If an essential container fails, the entire container group restarts.
4047
4155
 
4048
4156
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-supportcontainerdefinition.html#cfn-gamelift-containergroupdefinition-supportcontainerdefinition-essential
4049
4157
  '''
@@ -4054,7 +4162,9 @@ class CfnContainerGroupDefinition(
4054
4162
  def health_check(
4055
4163
  self,
4056
4164
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnContainerGroupDefinition.ContainerHealthCheckProperty"]]:
4057
- '''Specifies how the process manager checks the health of containers.
4165
+ '''A configuration for a non-terminal health check.
4166
+
4167
+ A support container automatically restarts if it stops functioning or if it fails this health check.
4058
4168
 
4059
4169
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-supportcontainerdefinition.html#cfn-gamelift-containergroupdefinition-supportcontainerdefinition-healthcheck
4060
4170
  '''
@@ -4063,7 +4173,11 @@ class CfnContainerGroupDefinition(
4063
4173
 
4064
4174
  @builtins.property
4065
4175
  def memory_hard_limit_mebibytes(self) -> typing.Optional[jsii.Number]:
4066
- '''The total memory limit of container groups following this definition in MiB.
4176
+ '''The amount of memory that Amazon GameLift makes available to the container.
4177
+
4178
+ If memory limits aren't set for an individual container, the container shares the container group's total memory allocation.
4179
+
4180
+ *Related data type:* `ContainerGroupDefinition TotalMemoryLimitMebibytes <https://docs.aws.amazon.com/gamelift/latest/apireference/API_ContainerGroupDefinition.html>`_
4067
4181
 
4068
4182
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-supportcontainerdefinition.html#cfn-gamelift-containergroupdefinition-supportcontainerdefinition-memoryhardlimitmebibytes
4069
4183
  '''
@@ -4074,7 +4188,7 @@ class CfnContainerGroupDefinition(
4074
4188
  def mount_points(
4075
4189
  self,
4076
4190
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnContainerGroupDefinition.ContainerMountPointProperty"]]]]:
4077
- '''A list of mount point configurations to be used in a container.
4191
+ '''A mount point that binds a path inside the container to a file or directory on the host system and lets it access the file or directory.
4078
4192
 
4079
4193
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-supportcontainerdefinition.html#cfn-gamelift-containergroupdefinition-supportcontainerdefinition-mountpoints
4080
4194
  '''
@@ -4085,7 +4199,9 @@ class CfnContainerGroupDefinition(
4085
4199
  def port_configuration(
4086
4200
  self,
4087
4201
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnContainerGroupDefinition.PortConfigurationProperty"]]:
4088
- '''Defines the ports on a container.
4202
+ '''A set of ports that allow access to the container from external users.
4203
+
4204
+ Processes running in the container can bind to a one of these ports. 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`` .
4089
4205
 
4090
4206
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-supportcontainerdefinition.html#cfn-gamelift-containergroupdefinition-supportcontainerdefinition-portconfiguration
4091
4207
  '''
@@ -4094,7 +4210,9 @@ class CfnContainerGroupDefinition(
4094
4210
 
4095
4211
  @builtins.property
4096
4212
  def resolved_image_digest(self) -> typing.Optional[builtins.str]:
4097
- '''The digest of the container image.
4213
+ '''A unique and immutable identifier for the container image.
4214
+
4215
+ The digest is a SHA 256 hash of the container image manifest.
4098
4216
 
4099
4217
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-supportcontainerdefinition.html#cfn-gamelift-containergroupdefinition-supportcontainerdefinition-resolvedimagedigest
4100
4218
  '''
@@ -4103,7 +4221,11 @@ class CfnContainerGroupDefinition(
4103
4221
 
4104
4222
  @builtins.property
4105
4223
  def vcpu(self) -> typing.Optional[jsii.Number]:
4106
- '''The number of virtual CPUs to give to the support group.
4224
+ '''The number of vCPU units that are reserved for the container.
4225
+
4226
+ If no resources are reserved, the container shares the total vCPU limit for the container group.
4227
+
4228
+ *Related data type:* `ContainerGroupDefinition TotalVcpuLimit <https://docs.aws.amazon.com/gamelift/latest/apireference/API_ContainerGroupDefinition.html>`_
4107
4229
 
4108
4230
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-supportcontainerdefinition.html#cfn-gamelift-containergroupdefinition-supportcontainerdefinition-vcpu
4109
4231
  '''
@@ -4157,14 +4279,14 @@ class CfnContainerGroupDefinitionProps:
4157
4279
 
4158
4280
  :param name: A descriptive identifier for the container group definition. The name value is unique in an AWS Region.
4159
4281
  :param operating_system: The platform that all containers in the container group definition run on. .. epigraph:: Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more details in the `Amazon Linux 2 FAQs <https://docs.aws.amazon.com/https://aws.amazon.com/amazon-linux-2/faqs/>`_ . For game servers that are hosted on AL2 and use Amazon GameLift server SDK 4.x, first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See `Migrate to Amazon GameLift server SDK version 5. <https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk5-migration.html>`_
4160
- :param total_memory_limit_mebibytes: The total memory limit of container groups following this definition in MiB.
4161
- :param total_vcpu_limit: The total amount of virtual CPUs on the container group definition.
4162
- :param container_group_type: The scope of the container group.
4163
- :param game_server_container_definition: Specifies the information required to run game servers with this container group.
4282
+ :param total_memory_limit_mebibytes: 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 a limit for each container definition in the group. If individual containers have limits, this total value must be greater than any individual container's memory limit.
4283
+ :param total_vcpu_limit: The amount of vCPU units on a fleet instance to allocate for the container group (1 vCPU is equal to 1024 CPU units). All containers in the group share these resources. You can set a limit for each container definition in the group. If individual containers have limits, this total value must be equal to or greater than the sum of the limits for each container in the group.
4284
+ :param container_group_type: The type of container group. Container group type determines how Amazon GameLift deploys the container group on each fleet instance.
4285
+ :param game_server_container_definition: The definition for the game server container in this group. This property is used only when the container group type is ``GAME_SERVER`` . This container definition specifies a container image with the game server build.
4164
4286
  :param source_version_number: A specific ContainerGroupDefinition version to be updated.
4165
4287
  :param support_container_definitions: The set of definitions for support containers in this group. A container group definition might have zero support container definitions. Support container can be used in any type of container group.
4166
4288
  :param tags: An array of key-value pairs to apply to this resource.
4167
- :param version_description: The description of this version.
4289
+ :param version_description: An optional description that was provided for a container group definition update. Each version can have a unique description.
4168
4290
 
4169
4291
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html
4170
4292
  :exampleMetadata: fixture=_generated
@@ -4321,7 +4443,11 @@ class CfnContainerGroupDefinitionProps:
4321
4443
 
4322
4444
  @builtins.property
4323
4445
  def total_memory_limit_mebibytes(self) -> jsii.Number:
4324
- '''The total memory limit of container groups following this definition in MiB.
4446
+ '''The amount of memory (in MiB) on a fleet instance to allocate for the container group.
4447
+
4448
+ All containers in the group share these resources.
4449
+
4450
+ You can set a limit for each container definition in the group. If individual containers have limits, this total value must be greater than any individual container's memory limit.
4325
4451
 
4326
4452
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-totalmemorylimitmebibytes
4327
4453
  '''
@@ -4331,7 +4457,9 @@ class CfnContainerGroupDefinitionProps:
4331
4457
 
4332
4458
  @builtins.property
4333
4459
  def total_vcpu_limit(self) -> jsii.Number:
4334
- '''The total amount of virtual CPUs on the container group definition.
4460
+ '''The amount of vCPU units on a fleet instance to allocate for the container group (1 vCPU is equal to 1024 CPU units).
4461
+
4462
+ All containers in the group share these resources. You can set a limit for each container definition in the group. If individual containers have limits, this total value must be equal to or greater than the sum of the limits for each container in the group.
4335
4463
 
4336
4464
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-totalvcpulimit
4337
4465
  '''
@@ -4341,7 +4469,9 @@ class CfnContainerGroupDefinitionProps:
4341
4469
 
4342
4470
  @builtins.property
4343
4471
  def container_group_type(self) -> typing.Optional[builtins.str]:
4344
- '''The scope of the container group.
4472
+ '''The type of container group.
4473
+
4474
+ Container group type determines how Amazon GameLift deploys the container group on each fleet instance.
4345
4475
 
4346
4476
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-containergrouptype
4347
4477
  '''
@@ -4352,7 +4482,9 @@ class CfnContainerGroupDefinitionProps:
4352
4482
  def game_server_container_definition(
4353
4483
  self,
4354
4484
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnContainerGroupDefinition.GameServerContainerDefinitionProperty]]:
4355
- '''Specifies the information required to run game servers with this container group.
4485
+ '''The definition for the game server container in this group.
4486
+
4487
+ This property is used only when the container group type is ``GAME_SERVER`` . This container definition specifies a container image with the game server build.
4356
4488
 
4357
4489
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-gameservercontainerdefinition
4358
4490
  '''
@@ -4392,7 +4524,9 @@ class CfnContainerGroupDefinitionProps:
4392
4524
 
4393
4525
  @builtins.property
4394
4526
  def version_description(self) -> typing.Optional[builtins.str]:
4395
- '''The description of this version.
4527
+ '''An optional description that was provided for a container group definition update.
4528
+
4529
+ Each version can have a unique description.
4396
4530
 
4397
4531
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-versiondescription
4398
4532
  '''
@@ -4553,14 +4687,14 @@ class CfnFleet(
4553
4687
  :param apply_capacity: Current resource capacity settings for managed EC2 fleets and managed 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>`_
4554
4688
  :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.
4555
4689
  :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* .
4556
- :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. - ``ANYWHERE`` – Your game server and supporting software is deployed to compute resources that are provided and managed by you. With this compute type, you can also set the ``AnywhereConfiguration`` parameter.
4690
+ :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. - ``ANYWHERE`` – Game servers and supporting software are deployed to compute resources that you provide and manage. With this compute type, you can also set the ``AnywhereConfiguration`` parameter.
4557
4691
  :param description: A description for the fleet.
4558
4692
  :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.
4559
- :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 managed EC2 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.
4693
+ :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 managed EC2 fleets. You can leave this parameter empty when creating the fleet, but you must call ` <https://docs.aws.amazon.com/gamelift/latest/apireference/API_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.
4560
4694
  :param ec2_instance_type: The Amazon GameLift-supported Amazon EC2 instance type to use with managed EC2 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.
4561
4695
  :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.
4562
- :param instance_role_arn: A unique identifier for an IAM role that manages access to your AWS services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). Create a role or look up a role's ARN by using the `IAM dashboard <https://docs.aws.amazon.com/iam/>`_ in the AWS Management Console . Learn more about using on-box credentials for your game servers at `Access external resources from a game server <https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html>`_ . This attribute is used with fleets where ``ComputeType`` is "EC2".
4563
- :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".
4696
+ :param instance_role_arn: A unique identifier for an IAM role that manages access to your AWS services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). Create a role or look up a role's ARN by using the `IAM dashboard <https://docs.aws.amazon.com/iam/>`_ in the AWS Management Console . Learn more about using on-box credentials for your game servers at `Access external resources from a game server <https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html>`_ . This attribute is used with fleets where ``ComputeType`` is ``EC2`` .
4697
+ :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`` .
4564
4698
  :param locations: A set of remote locations to deploy additional instances to and manage as a multi-location fleet. Use this parameter when creating a fleet in AWS Regions that support multiple locations. You can add any AWS Region or Local Zone that's supported by Amazon GameLift. Provide a list of one or more AWS Region codes, such as ``us-west-2`` , or Local Zone names. When using this parameter, Amazon GameLift requires you to include your home location in the request. For a list of supported Regions and Local Zones, see `Amazon GameLift service locations <https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-regions.html>`_ for managed hosting.
4565
4699
  :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()
4566
4700
  :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.
@@ -5128,7 +5262,7 @@ class CfnFleet(
5128
5262
 
5129
5263
  This feature must be enabled when creating the fleet. All instances in a fleet share the same certificate. The certificate can be retrieved by calling the `GameLift Server SDK <https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk.html>`_ operation ``GetInstanceCertificate`` .
5130
5264
 
5131
- :param certificate_type: Indicates whether a TLS/SSL certificate is generated for a fleet. Valid values include: - *GENERATED* -- Generate a TLS/SSL certificate for this fleet. - *DISABLED* -- (default) Do not generate a TLS/SSL certificate for this fleet.
5265
+ :param certificate_type: Indicates whether a TLS/SSL certificate is generated for a fleet. Valid values include: - *GENERATED* - Generate a TLS/SSL certificate for this fleet. - *DISABLED* - (default) Do not generate a TLS/SSL certificate for this fleet.
5132
5266
 
5133
5267
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-certificateconfiguration.html
5134
5268
  :exampleMetadata: fixture=_generated
@@ -5156,8 +5290,8 @@ class CfnFleet(
5156
5290
 
5157
5291
  Valid values include:
5158
5292
 
5159
- - *GENERATED* -- Generate a TLS/SSL certificate for this fleet.
5160
- - *DISABLED* -- (default) Do not generate a TLS/SSL certificate for this fleet.
5293
+ - *GENERATED* - Generate a TLS/SSL certificate for this fleet.
5294
+ - *DISABLED* - (default) Do not generate a TLS/SSL certificate for this fleet.
5161
5295
 
5162
5296
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-certificateconfiguration.html#cfn-gamelift-fleet-certificateconfiguration-certificatetype
5163
5297
  '''
@@ -5586,7 +5720,7 @@ class CfnFleet(
5586
5720
  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>`_ .
5587
5721
 
5588
5722
  :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`` .
5589
- :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.
5723
+ :param max_concurrent_game_session_activations: The number of game sessions in status ``ACTIVATING`` to allow on an instance or compute. This setting limits the instance resources that can be used for new game activations at any one time.
5590
5724
  :param server_processes: A collection of server process configurations that identify what server processes to run on fleet computes.
5591
5725
 
5592
5726
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-runtimeconfiguration.html
@@ -5640,7 +5774,7 @@ class CfnFleet(
5640
5774
  def max_concurrent_game_session_activations(
5641
5775
  self,
5642
5776
  ) -> typing.Optional[jsii.Number]:
5643
- '''The number of game sessions in status ``ACTIVATING`` to allow on an instance.
5777
+ '''The number of game sessions in status ``ACTIVATING`` to allow on an instance or compute.
5644
5778
 
5645
5779
  This setting limits the instance resources that can be used for new game activations at any one time.
5646
5780
 
@@ -6183,14 +6317,14 @@ class CfnFleetProps:
6183
6317
  :param apply_capacity: Current resource capacity settings for managed EC2 fleets and managed 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>`_
6184
6318
  :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.
6185
6319
  :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* .
6186
- :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. - ``ANYWHERE`` – Your game server and supporting software is deployed to compute resources that are provided and managed by you. With this compute type, you can also set the ``AnywhereConfiguration`` parameter.
6320
+ :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. - ``ANYWHERE`` – Game servers and supporting software are deployed to compute resources that you provide and manage. With this compute type, you can also set the ``AnywhereConfiguration`` parameter.
6187
6321
  :param description: A description for the fleet.
6188
6322
  :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.
6189
- :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 managed EC2 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.
6323
+ :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 managed EC2 fleets. You can leave this parameter empty when creating the fleet, but you must call ` <https://docs.aws.amazon.com/gamelift/latest/apireference/API_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.
6190
6324
  :param ec2_instance_type: The Amazon GameLift-supported Amazon EC2 instance type to use with managed EC2 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.
6191
6325
  :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.
6192
- :param instance_role_arn: A unique identifier for an IAM role that manages access to your AWS services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). Create a role or look up a role's ARN by using the `IAM dashboard <https://docs.aws.amazon.com/iam/>`_ in the AWS Management Console . Learn more about using on-box credentials for your game servers at `Access external resources from a game server <https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html>`_ . This attribute is used with fleets where ``ComputeType`` is "EC2".
6193
- :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".
6326
+ :param instance_role_arn: A unique identifier for an IAM role that manages access to your AWS services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). Create a role or look up a role's ARN by using the `IAM dashboard <https://docs.aws.amazon.com/iam/>`_ in the AWS Management Console . Learn more about using on-box credentials for your game servers at `Access external resources from a game server <https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html>`_ . This attribute is used with fleets where ``ComputeType`` is ``EC2`` .
6327
+ :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`` .
6194
6328
  :param locations: A set of remote locations to deploy additional instances to and manage as a multi-location fleet. Use this parameter when creating a fleet in AWS Regions that support multiple locations. You can add any AWS Region or Local Zone that's supported by Amazon GameLift. Provide a list of one or more AWS Region codes, such as ``us-west-2`` , or Local Zone names. When using this parameter, Amazon GameLift requires you to include your home location in the request. For a list of supported Regions and Local Zones, see `Amazon GameLift service locations <https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-regions.html>`_ for managed hosting.
6195
6329
  :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()
6196
6330
  :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.
@@ -6450,7 +6584,7 @@ class CfnFleetProps:
6450
6584
  '''The type of compute resource used to host your game servers.
6451
6585
 
6452
6586
  - ``EC2`` – The game server build is deployed to Amazon EC2 instances for cloud hosting. This is the default setting.
6453
- - ``ANYWHERE`` – Your game server and supporting software is deployed to compute resources that are provided and managed by you. With this compute type, you can also set the ``AnywhereConfiguration`` parameter.
6587
+ - ``ANYWHERE`` – Game servers and supporting software are deployed to compute resources that you provide and manage. With this compute type, you can also set the ``AnywhereConfiguration`` parameter.
6454
6588
 
6455
6589
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-computetype
6456
6590
  '''
@@ -6483,7 +6617,7 @@ class CfnFleetProps:
6483
6617
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, CfnFleet.IpPermissionProperty]]]]:
6484
6618
  '''The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet.
6485
6619
 
6486
- Set this parameter for managed EC2 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.
6620
+ Set this parameter for managed EC2 fleets. You can leave this parameter empty when creating the fleet, but you must call ` <https://docs.aws.amazon.com/gamelift/latest/apireference/API_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.
6487
6621
 
6488
6622
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-ec2inboundpermissions
6489
6623
  '''
@@ -6516,7 +6650,7 @@ class CfnFleetProps:
6516
6650
  def instance_role_arn(self) -> typing.Optional[builtins.str]:
6517
6651
  '''A unique identifier for an IAM role that manages access to your AWS services.
6518
6652
 
6519
- With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). Create a role or look up a role's ARN by using the `IAM dashboard <https://docs.aws.amazon.com/iam/>`_ in the AWS Management Console . Learn more about using on-box credentials for your game servers at `Access external resources from a game server <https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html>`_ . This attribute is used with fleets where ``ComputeType`` is "EC2".
6653
+ With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). Create a role or look up a role's ARN by using the `IAM dashboard <https://docs.aws.amazon.com/iam/>`_ in the AWS Management Console . Learn more about using on-box credentials for your game servers at `Access external resources from a game server <https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html>`_ . This attribute is used with fleets where ``ComputeType`` is ``EC2`` .
6520
6654
 
6521
6655
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-instancerolearn
6522
6656
  '''
@@ -6527,7 +6661,7 @@ class CfnFleetProps:
6527
6661
  def instance_role_credentials_provider(self) -> typing.Optional[builtins.str]:
6528
6662
  '''Indicates that fleet instances maintain a shared credentials file for the IAM role defined in ``InstanceRoleArn`` .
6529
6663
 
6530
- 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".
6664
+ 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`` .
6531
6665
 
6532
6666
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-instancerolecredentialsprovider
6533
6667
  '''