aws-cdk-lib 2.184.1__py3-none-any.whl → 2.185.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of aws-cdk-lib might be problematic. Click here for more details.
- aws_cdk/_jsii/__init__.py +1 -1
- aws_cdk/_jsii/{aws-cdk-lib@2.184.1.jsii.tgz → aws-cdk-lib@2.185.0.jsii.tgz} +0 -0
- aws_cdk/aws_apigateway/__init__.py +1 -1
- aws_cdk/aws_applicationsignals/__init__.py +134 -0
- aws_cdk/aws_appsync/__init__.py +0 -8
- aws_cdk/aws_athena/__init__.py +143 -0
- aws_cdk/aws_backup/__init__.py +4 -2
- aws_cdk/aws_batch/__init__.py +9 -0
- aws_cdk/aws_bedrock/__init__.py +260 -185
- aws_cdk/aws_cassandra/__init__.py +3 -5
- aws_cdk/aws_chatbot/__init__.py +41 -0
- aws_cdk/aws_codebuild/__init__.py +10 -3
- aws_cdk/aws_config/__init__.py +1 -1
- aws_cdk/aws_datasync/__init__.py +12 -14
- aws_cdk/aws_ec2/__init__.py +148 -19
- aws_cdk/aws_ecr/__init__.py +84 -2
- aws_cdk/aws_ecs/__init__.py +5 -5
- aws_cdk/aws_eks/__init__.py +2 -0
- aws_cdk/aws_elasticloadbalancingv2/__init__.py +42 -5
- aws_cdk/aws_elasticsearch/__init__.py +1 -1
- aws_cdk/aws_events_targets/__init__.py +5 -5
- aws_cdk/aws_gamelift/__init__.py +162 -162
- aws_cdk/aws_gameliftstreams/__init__.py +199 -59
- aws_cdk/aws_iam/__init__.py +56 -25
- aws_cdk/aws_imagebuilder/__init__.py +42 -5
- aws_cdk/aws_iotfleetwise/__init__.py +15 -6
- aws_cdk/aws_kinesisfirehose/__init__.py +113 -110
- aws_cdk/aws_logs/__init__.py +21 -27
- aws_cdk/aws_msk/__init__.py +9 -48
- aws_cdk/aws_opensearchservice/__init__.py +1 -1
- aws_cdk/aws_pcs/__init__.py +33 -22
- aws_cdk/aws_rds/__init__.py +8 -4
- aws_cdk/aws_rum/__init__.py +148 -0
- aws_cdk/aws_s3/__init__.py +4 -6
- aws_cdk/aws_s3_deployment/__init__.py +2 -0
- aws_cdk/aws_sagemaker/__init__.py +524 -0
- aws_cdk/aws_ses/__init__.py +9 -9
- aws_cdk/aws_sns/__init__.py +12 -12
- aws_cdk/cx_api/__init__.py +30 -0
- aws_cdk/region_info/__init__.py +2 -2
- {aws_cdk_lib-2.184.1.dist-info → aws_cdk_lib-2.185.0.dist-info}/METADATA +1 -1
- {aws_cdk_lib-2.184.1.dist-info → aws_cdk_lib-2.185.0.dist-info}/RECORD +46 -46
- {aws_cdk_lib-2.184.1.dist-info → aws_cdk_lib-2.185.0.dist-info}/LICENSE +0 -0
- {aws_cdk_lib-2.184.1.dist-info → aws_cdk_lib-2.185.0.dist-info}/NOTICE +0 -0
- {aws_cdk_lib-2.184.1.dist-info → aws_cdk_lib-2.185.0.dist-info}/WHEEL +0 -0
- {aws_cdk_lib-2.184.1.dist-info → aws_cdk_lib-2.185.0.dist-info}/top_level.txt +0 -0
aws_cdk/aws_gamelift/__init__.py
CHANGED
|
@@ -478,9 +478,9 @@ 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 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
|
|
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
|
-
: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.
|
|
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 server SDK version 4.x for Amazon GameLift Servers, first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See `Migrate to server SDK version 5. <https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk5-migration.html>`_
|
|
482
|
+
:param server_sdk_version: A server SDK version you used when integrating your game server build with Amazon GameLift Servers. 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 Servers sets this value to ``4.0.2`` .
|
|
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 Servers 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 Servers 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.
|
|
485
485
|
'''
|
|
486
486
|
if __debug__:
|
|
@@ -570,7 +570,7 @@ class CfnBuild(
|
|
|
570
570
|
@builtins.property
|
|
571
571
|
@jsii.member(jsii_name="serverSdkVersion")
|
|
572
572
|
def server_sdk_version(self) -> typing.Optional[builtins.str]:
|
|
573
|
-
'''A server SDK version you used when integrating your game server build with Amazon GameLift.'''
|
|
573
|
+
'''A server SDK version you used when integrating your game server build with Amazon GameLift Servers.'''
|
|
574
574
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "serverSdkVersion"))
|
|
575
575
|
|
|
576
576
|
@server_sdk_version.setter
|
|
@@ -750,9 +750,9 @@ 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 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
|
|
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
|
-
: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.
|
|
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 server SDK version 4.x for Amazon GameLift Servers, first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See `Migrate to server SDK version 5. <https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk5-migration.html>`_
|
|
754
|
+
:param server_sdk_version: A server SDK version you used when integrating your game server build with Amazon GameLift Servers. 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 Servers sets this value to ``4.0.2`` .
|
|
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 Servers 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 Servers 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.
|
|
757
757
|
|
|
758
758
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-build.html
|
|
@@ -816,7 +816,7 @@ class CfnBuildProps:
|
|
|
816
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
|
-
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
|
|
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 server SDK version 4.x for Amazon GameLift Servers, first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See `Migrate to server SDK version 5. <https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk5-migration.html>`_
|
|
820
820
|
|
|
821
821
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-build.html#cfn-gamelift-build-operatingsystem
|
|
822
822
|
'''
|
|
@@ -825,9 +825,9 @@ class CfnBuildProps:
|
|
|
825
825
|
|
|
826
826
|
@builtins.property
|
|
827
827
|
def server_sdk_version(self) -> typing.Optional[builtins.str]:
|
|
828
|
-
'''A server SDK version you used when integrating your game server build with Amazon GameLift.
|
|
828
|
+
'''A server SDK version you used when integrating your game server build with Amazon GameLift Servers.
|
|
829
829
|
|
|
830
|
-
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`` .
|
|
830
|
+
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 Servers sets this value to ``4.0.2`` .
|
|
831
831
|
|
|
832
832
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-build.html#cfn-gamelift-build-serversdkversion
|
|
833
833
|
'''
|
|
@@ -840,9 +840,9 @@ class CfnBuildProps:
|
|
|
840
840
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnBuild.StorageLocationProperty]]:
|
|
841
841
|
'''Information indicating where your game build files are stored.
|
|
842
842
|
|
|
843
|
-
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.
|
|
843
|
+
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 Servers to access your Amazon S3 bucket. The S3 bucket and your new build must be in the same Region.
|
|
844
844
|
|
|
845
|
-
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.
|
|
845
|
+
If a ``StorageLocation`` is specified, the size of your file can be found in your Amazon S3 bucket. Amazon GameLift Servers will report a ``SizeOnDisk`` of 0.
|
|
846
846
|
|
|
847
847
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-build.html#cfn-gamelift-build-storagelocation
|
|
848
848
|
'''
|
|
@@ -878,7 +878,7 @@ class CfnContainerFleet(
|
|
|
878
878
|
metaclass=jsii.JSIIMeta,
|
|
879
879
|
jsii_type="aws-cdk-lib.aws_gamelift.CfnContainerFleet",
|
|
880
880
|
):
|
|
881
|
-
'''Describes an Amazon GameLift managed container fleet.
|
|
881
|
+
'''Describes an Amazon GameLift Servers 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,7 +984,7 @@ 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: 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.
|
|
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 Servers. 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
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
989
|
:param deployment_configuration: Set of rules for processing a deployment for a container fleet update.
|
|
990
990
|
:param description: A meaningful description of the container fleet.
|
|
@@ -995,9 +995,9 @@ class CfnContainerFleet(
|
|
|
995
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
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: 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.
|
|
998
|
+
:param log_configuration: The method that is used to collect container logs for the fleet. Amazon GameLift Servers 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
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.
|
|
1000
|
+
:param new_game_session_protection_policy: Determines whether Amazon GameLift Servers can shut down game sessions on the fleet that are actively running and hosting players. Amazon GameLift Servers 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
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.
|
|
@@ -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 <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.
|
|
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 Servers 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
|
'''
|
|
@@ -1155,7 +1155,7 @@ class CfnContainerFleet(
|
|
|
1155
1155
|
@builtins.property
|
|
1156
1156
|
@jsii.member(jsii_name="fleetRoleArn")
|
|
1157
1157
|
def fleet_role_arn(self) -> builtins.str:
|
|
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.'''
|
|
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 Servers.'''
|
|
1159
1159
|
return typing.cast(builtins.str, jsii.get(self, "fleetRoleArn"))
|
|
1160
1160
|
|
|
1161
1161
|
@fleet_role_arn.setter
|
|
@@ -1361,7 +1361,7 @@ class CfnContainerFleet(
|
|
|
1361
1361
|
@builtins.property
|
|
1362
1362
|
@jsii.member(jsii_name="newGameSessionProtectionPolicy")
|
|
1363
1363
|
def new_game_session_protection_policy(self) -> typing.Optional[builtins.str]:
|
|
1364
|
-
'''Determines whether Amazon GameLift can shut down game sessions on the fleet that are actively running and hosting players.'''
|
|
1364
|
+
'''Determines whether Amazon GameLift Servers can shut down game sessions on the fleet that are actively running and hosting players.'''
|
|
1365
1365
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "newGameSessionProtectionPolicy"))
|
|
1366
1366
|
|
|
1367
1367
|
@new_game_session_protection_policy.setter
|
|
@@ -1660,9 +1660,9 @@ class CfnContainerFleet(
|
|
|
1660
1660
|
|
|
1661
1661
|
With this policy, you can control players' ability to consume available resources.
|
|
1662
1662
|
|
|
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.
|
|
1663
|
+
The policy is evaluated when a player tries to create a new game session. On receiving a ``CreateGameSession`` request, Amazon GameLift Servers checks that the player (identified by ``CreatorId`` ) has created fewer than game session limit in the specified time period.
|
|
1664
1664
|
|
|
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.
|
|
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 Servers checks that the player (identified by ``CreatorId`` ) has created fewer than game session limit in the specified time period.
|
|
1666
1666
|
:param policy_period_in_minutes: The time span used in evaluating the resource creation limit policy.
|
|
1667
1667
|
|
|
1668
1668
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-gamesessioncreationlimitpolicy.html
|
|
@@ -1695,7 +1695,7 @@ class CfnContainerFleet(
|
|
|
1695
1695
|
|
|
1696
1696
|
With this policy, you can control players' ability to consume available resources.
|
|
1697
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.
|
|
1698
|
+
The policy evaluates when a player tries to create a new game session. On receiving a ``CreateGameSession`` request, Amazon GameLift Servers checks that the player (identified by ``CreatorId`` ) has created fewer than game session limit in the specified time period.
|
|
1699
1699
|
|
|
1700
1700
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-gamesessioncreationlimitpolicy.html#cfn-gamelift-containerfleet-gamesessioncreationlimitpolicy-newgamesessionspercreator
|
|
1701
1701
|
'''
|
|
@@ -1745,7 +1745,7 @@ class CfnContainerFleet(
|
|
|
1745
1745
|
|
|
1746
1746
|
Processes are assigned an IP address/port number combination, which must fall into the fleet's allowed ranges.
|
|
1747
1747
|
|
|
1748
|
-
For
|
|
1748
|
+
For Amazon GameLift Servers Realtime fleets, Amazon GameLift Servers automatically opens two port ranges, one for TCP messaging and one for UDP.
|
|
1749
1749
|
|
|
1750
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
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]`` ".
|
|
@@ -1957,7 +1957,7 @@ class CfnContainerFleet(
|
|
|
1957
1957
|
) -> None:
|
|
1958
1958
|
'''A remote location where a multi-location fleet can deploy game servers for game hosting.
|
|
1959
1959
|
|
|
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.
|
|
1960
|
+
:param location: An AWS Region code, such as ``us-west-2`` . For a list of supported Regions and Local Zones, see `Amazon GameLift Servers service locations <https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-regions.html>`_ for managed hosting.
|
|
1961
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.
|
|
1962
1962
|
:param stopped_actions: A list of fleet actions that have been suspended in the fleet location.
|
|
1963
1963
|
|
|
@@ -1999,7 +1999,7 @@ class CfnContainerFleet(
|
|
|
1999
1999
|
def location(self) -> builtins.str:
|
|
2000
2000
|
'''An AWS Region code, such as ``us-west-2`` .
|
|
2001
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.
|
|
2002
|
+
For a list of supported Regions and Local Zones, see `Amazon GameLift Servers service locations <https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-regions.html>`_ for managed hosting.
|
|
2003
2003
|
|
|
2004
2004
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-locationconfiguration.html#cfn-gamelift-containerfleet-locationconfiguration-location
|
|
2005
2005
|
'''
|
|
@@ -2057,9 +2057,9 @@ class CfnContainerFleet(
|
|
|
2057
2057
|
) -> None:
|
|
2058
2058
|
'''A method for collecting container logs for the fleet.
|
|
2059
2059
|
|
|
2060
|
-
Amazon GameLift saves all standard output for each container in logs, including game session logs. You can select from the following methods:
|
|
2060
|
+
Amazon GameLift Servers saves all standard output for each container in logs, including game session logs. You can select from the following methods:
|
|
2061
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.
|
|
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. This bucket must reside in the fleet's home AWS Region. - ``NONE`` -- Don't collect container logs.
|
|
2063
2063
|
:param s3_bucket_name: If log destination is ``S3`` , logs are sent to the specified Amazon S3 bucket name.
|
|
2064
2064
|
|
|
2065
2065
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-logconfiguration.html
|
|
@@ -2091,7 +2091,7 @@ class CfnContainerFleet(
|
|
|
2091
2091
|
'''The type of log collection to use for a fleet.
|
|
2092
2092
|
|
|
2093
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.
|
|
2094
|
+
- ``S3`` -- Store logs in an Amazon S3 bucket that you define. This bucket must reside in the fleet's home AWS Region.
|
|
2095
2095
|
- ``NONE`` -- Don't collect container logs.
|
|
2096
2096
|
|
|
2097
2097
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-logconfiguration.html#cfn-gamelift-containerfleet-logconfiguration-logdestination
|
|
@@ -2152,7 +2152,7 @@ class CfnContainerFleet(
|
|
|
2152
2152
|
|
|
2153
2153
|
Scaling policies are uniquely identified by the combination of name and fleet ID.
|
|
2154
2154
|
|
|
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.
|
|
2155
|
+
:param metric_name: Name of the Amazon GameLift Servers-defined metric that is used to trigger a scaling adjustment. For detailed descriptions of fleet metrics, see `Monitor Amazon GameLift Servers 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.
|
|
2156
2156
|
:param name: A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique.
|
|
2157
2157
|
:param comparison_operator: Comparison operator to use when measuring a metric against the threshold value.
|
|
2158
2158
|
:param evaluation_periods: Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
|
|
@@ -2219,9 +2219,9 @@ class CfnContainerFleet(
|
|
|
2219
2219
|
|
|
2220
2220
|
@builtins.property
|
|
2221
2221
|
def metric_name(self) -> builtins.str:
|
|
2222
|
-
'''Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment.
|
|
2222
|
+
'''Name of the Amazon GameLift Servers-defined metric that is used to trigger a scaling adjustment.
|
|
2223
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>`_ .
|
|
2224
|
+
For detailed descriptions of fleet metrics, see `Monitor Amazon GameLift Servers with Amazon CloudWatch <https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html>`_ .
|
|
2225
2225
|
|
|
2226
2226
|
- *ActivatingGameSessions* -- Game sessions in the process of being created.
|
|
2227
2227
|
- *ActiveGameSessions* -- Game sessions that are currently running.
|
|
@@ -2344,7 +2344,7 @@ class CfnContainerFleet(
|
|
|
2344
2344
|
def __init__(self, *, target_value: jsii.Number) -> None:
|
|
2345
2345
|
'''Settings for a target-based scaling policy.
|
|
2346
2346
|
|
|
2347
|
-
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.
|
|
2347
|
+
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 Servers 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.
|
|
2348
2348
|
|
|
2349
2349
|
:param target_value: Desired value to use with a target-based scaling policy. The value must be relevant for whatever metric the scaling policy is using. For example, in a policy using the metric PercentAvailableGameSessions, the target value should be the preferred size of the fleet's buffer (the percent of capacity that should be idle and ready for new game sessions).
|
|
2350
2350
|
|
|
@@ -2439,7 +2439,7 @@ class CfnContainerFleetProps:
|
|
|
2439
2439
|
) -> None:
|
|
2440
2440
|
'''Properties for defining a ``CfnContainerFleet``.
|
|
2441
2441
|
|
|
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.
|
|
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 Servers. 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
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
2444
|
:param deployment_configuration: Set of rules for processing a deployment for a container fleet update.
|
|
2445
2445
|
:param description: A meaningful description of the container fleet.
|
|
@@ -2450,9 +2450,9 @@ class CfnContainerFleetProps:
|
|
|
2450
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
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.
|
|
2452
2452
|
:param locations:
|
|
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.
|
|
2453
|
+
:param log_configuration: The method that is used to collect container logs for the fleet. Amazon GameLift Servers 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
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.
|
|
2455
|
+
:param new_game_session_protection_policy: Determines whether Amazon GameLift Servers can shut down game sessions on the fleet that are actively running and hosting players. Amazon GameLift Servers 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
2456
|
:param per_instance_container_group_definition_name: The name of the fleet's per-instance container group definition.
|
|
2457
2457
|
:param scaling_policies: A list of rules that control how a fleet is scaled.
|
|
2458
2458
|
:param tags: An array of key-value pairs to apply to this resource.
|
|
@@ -2590,7 +2590,7 @@ class CfnContainerFleetProps:
|
|
|
2590
2590
|
|
|
2591
2591
|
@builtins.property
|
|
2592
2592
|
def fleet_role_arn(self) -> builtins.str:
|
|
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.
|
|
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 Servers.
|
|
2594
2594
|
|
|
2595
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.
|
|
2596
2596
|
|
|
@@ -2717,7 +2717,7 @@ class CfnContainerFleetProps:
|
|
|
2717
2717
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnContainerFleet.LogConfigurationProperty]]:
|
|
2718
2718
|
'''The method that is used to collect container logs for the fleet.
|
|
2719
2719
|
|
|
2720
|
-
Amazon GameLift saves all standard output for each container in logs, including game session logs.
|
|
2720
|
+
Amazon GameLift Servers saves all standard output for each container in logs, including game session logs.
|
|
2721
2721
|
|
|
2722
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
2723
|
- ``S3`` -- Store logs in an Amazon S3 bucket that you define.
|
|
@@ -2741,9 +2741,9 @@ class CfnContainerFleetProps:
|
|
|
2741
2741
|
|
|
2742
2742
|
@builtins.property
|
|
2743
2743
|
def new_game_session_protection_policy(self) -> typing.Optional[builtins.str]:
|
|
2744
|
-
'''Determines whether Amazon GameLift can shut down game sessions on the fleet that are actively running and hosting players.
|
|
2744
|
+
'''Determines whether Amazon GameLift Servers can shut down game sessions on the fleet that are actively running and hosting players.
|
|
2745
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>`_ .
|
|
2746
|
+
Amazon GameLift Servers 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>`_ .
|
|
2747
2747
|
|
|
2748
2748
|
- *NoProtection* -- Game sessions can be shut down during active gameplay.
|
|
2749
2749
|
- *FullProtection* -- Game sessions in ``ACTIVE`` status can't be shut down.
|
|
@@ -2928,10 +2928,10 @@ class CfnContainerGroupDefinition(
|
|
|
2928
2928
|
:param scope: Scope in which this resource is defined.
|
|
2929
2929
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
2930
2930
|
:param name: A descriptive identifier for the container group definition. The name value is unique in an AWS Region.
|
|
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
|
|
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 server SDK version 4.x for Amazon GameLift Servers, first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See `Migrate to server SDK version 5. <https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk5-migration.html>`_
|
|
2932
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
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.
|
|
2934
|
+
:param container_group_type: The type of container group. Container group type determines how Amazon GameLift Servers deploys the container group on each fleet instance.
|
|
2935
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.
|
|
2936
2936
|
:param source_version_number: A specific ContainerGroupDefinition version to be updated.
|
|
2937
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.
|
|
@@ -2990,7 +2990,7 @@ class CfnContainerGroupDefinition(
|
|
|
2990
2990
|
@builtins.property
|
|
2991
2991
|
@jsii.member(jsii_name="attrContainerGroupDefinitionArn")
|
|
2992
2992
|
def attr_container_group_definition_arn(self) -> builtins.str:
|
|
2993
|
-
'''The Amazon Resource Name ( `ARN <https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html>`_ ) that is assigned to an Amazon GameLift ``ContainerGroupDefinition`` resource. It uniquely identifies the resource across all AWS Regions. Format is ``arn:aws:gamelift:[region]::containergroupdefinition/[container group definition name]:[version]`` .
|
|
2993
|
+
'''The Amazon Resource Name ( `ARN <https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html>`_ ) that is assigned to an Amazon GameLift Servers ``ContainerGroupDefinition`` resource. It uniquely identifies the resource across all AWS Regions. Format is ``arn:aws:gamelift:[region]::containergroupdefinition/[container group definition name]:[version]`` .
|
|
2994
2994
|
|
|
2995
2995
|
:cloudformationAttribute: ContainerGroupDefinitionArn
|
|
2996
2996
|
'''
|
|
@@ -3012,9 +3012,9 @@ class CfnContainerGroupDefinition(
|
|
|
3012
3012
|
def attr_status(self) -> builtins.str:
|
|
3013
3013
|
'''Current status of the container group definition resource. Values include:.
|
|
3014
3014
|
|
|
3015
|
-
- ``COPYING`` -- Amazon GameLift is in the process of making copies of all container images that are defined in the group. While in this state, the resource can't be used to create a container fleet.
|
|
3016
|
-
- ``READY`` -- Amazon GameLift has copied the registry images for all containers that are defined in the group. You can use a container group definition in this status to create a container fleet.
|
|
3017
|
-
- ``FAILED`` -- Amazon GameLift failed to create a valid container group definition resource. For more details on the cause of the failure, see ``StatusReason`` . A container group definition resource in failed status will be deleted within a few minutes.
|
|
3015
|
+
- ``COPYING`` -- Amazon GameLift Servers is in the process of making copies of all container images that are defined in the group. While in this state, the resource can't be used to create a container fleet.
|
|
3016
|
+
- ``READY`` -- Amazon GameLift Servers has copied the registry images for all containers that are defined in the group. You can use a container group definition in this status to create a container fleet.
|
|
3017
|
+
- ``FAILED`` -- Amazon GameLift Servers failed to create a valid container group definition resource. For more details on the cause of the failure, see ``StatusReason`` . A container group definition resource in failed status will be deleted within a few minutes.
|
|
3018
3018
|
|
|
3019
3019
|
:cloudformationAttribute: Status
|
|
3020
3020
|
'''
|
|
@@ -3025,10 +3025,10 @@ class CfnContainerGroupDefinition(
|
|
|
3025
3025
|
def attr_status_reason(self) -> builtins.str:
|
|
3026
3026
|
'''Additional information about a container group definition that's in ``FAILED`` status. Possible reasons include:.
|
|
3027
3027
|
|
|
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.
|
|
3028
|
+
- An internal issue prevented Amazon GameLift Servers 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 Servers.
|
|
3030
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.
|
|
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>`_ .
|
|
3031
|
+
- At least one of the container images referenced in the container group definition exceeds the allowed size. For size limits, see `Amazon GameLift Servers endpoints and quotas <https://docs.aws.amazon.com/general/latest/gr/gamelift.html>`_ .
|
|
3032
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.
|
|
3033
3033
|
|
|
3034
3034
|
:cloudformationAttribute: StatusReason
|
|
@@ -3370,7 +3370,7 @@ class CfnContainerGroupDefinition(
|
|
|
3370
3370
|
) -> None:
|
|
3371
3371
|
'''Instructions on when and how to check the health of a support container in a container fleet.
|
|
3372
3372
|
|
|
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.
|
|
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 Servers automatically handles health checks for these containers.
|
|
3374
3374
|
|
|
3375
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
3376
|
|
|
@@ -3709,12 +3709,12 @@ class CfnContainerGroupDefinition(
|
|
|
3709
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
3710
|
|
|
3711
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.
|
|
3712
|
+
:param image_uri: The URI to the image that Amazon GameLift Servers uses when deploying this container to a container fleet. For a more specific identifier, see ``ResolvedImageDigest`` .
|
|
3713
|
+
:param server_sdk_version: The Amazon GameLift Servers 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
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
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
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`` .
|
|
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 Servers maps these container ports to externally accessible connection ports, which are assigned as needed from the container fleet's ``ConnectionPortRange`` .
|
|
3718
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.
|
|
3719
3719
|
|
|
3720
3720
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-gameservercontainerdefinition.html
|
|
@@ -3797,7 +3797,7 @@ class CfnContainerGroupDefinition(
|
|
|
3797
3797
|
|
|
3798
3798
|
@builtins.property
|
|
3799
3799
|
def image_uri(self) -> builtins.str:
|
|
3800
|
-
'''The URI to the image that Amazon GameLift uses when deploying this container to a container fleet.
|
|
3800
|
+
'''The URI to the image that Amazon GameLift Servers uses when deploying this container to a container fleet.
|
|
3801
3801
|
|
|
3802
3802
|
For a more specific identifier, see ``ResolvedImageDigest`` .
|
|
3803
3803
|
|
|
@@ -3809,7 +3809,7 @@ class CfnContainerGroupDefinition(
|
|
|
3809
3809
|
|
|
3810
3810
|
@builtins.property
|
|
3811
3811
|
def server_sdk_version(self) -> builtins.str:
|
|
3812
|
-
'''The Amazon GameLift server SDK version that the game server is integrated with.
|
|
3812
|
+
'''The Amazon GameLift Servers server SDK version that the game server is integrated with.
|
|
3813
3813
|
|
|
3814
3814
|
Only game servers using 5.2.0 or higher are compatible with container fleets.
|
|
3815
3815
|
|
|
@@ -3862,7 +3862,7 @@ class CfnContainerGroupDefinition(
|
|
|
3862
3862
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnContainerGroupDefinition.PortConfigurationProperty"]]:
|
|
3863
3863
|
'''The set of ports that are available to bind to processes in the container.
|
|
3864
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`` .
|
|
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 Servers maps these container ports to externally accessible connection ports, which are assigned as needed from the container fleet's ``ConnectionPortRange`` .
|
|
3866
3866
|
|
|
3867
3867
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-gameservercontainerdefinition.html#cfn-gamelift-containergroupdefinition-gameservercontainerdefinition-portconfiguration
|
|
3868
3868
|
'''
|
|
@@ -3997,14 +3997,14 @@ class CfnContainerGroupDefinition(
|
|
|
3997
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
3998
|
|
|
3999
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`` .
|
|
4000
|
+
:param image_uri: The URI to the image that Amazon GameLift Servers deploys to a container fleet. For a more specific identifier, see ``ResolvedImageDigest`` .
|
|
4001
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
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
4003
|
:param essential: Indicates whether the container is vital to the container group. If an essential container fails, the entire container group restarts.
|
|
4004
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>`_
|
|
4005
|
+
:param memory_hard_limit_mebibytes: The amount of memory that Amazon GameLift Servers 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
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`` .
|
|
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 Servers maps these container ports to externally accessible connection ports, which are assigned as needed from the container fleet's ``ConnectionPortRange`` .
|
|
4008
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
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>`_
|
|
4010
4010
|
|
|
@@ -4109,7 +4109,7 @@ class CfnContainerGroupDefinition(
|
|
|
4109
4109
|
|
|
4110
4110
|
@builtins.property
|
|
4111
4111
|
def image_uri(self) -> builtins.str:
|
|
4112
|
-
'''The URI to the image that Amazon GameLift deploys to a container fleet.
|
|
4112
|
+
'''The URI to the image that Amazon GameLift Servers deploys to a container fleet.
|
|
4113
4113
|
|
|
4114
4114
|
For a more specific identifier, see ``ResolvedImageDigest`` .
|
|
4115
4115
|
|
|
@@ -4173,7 +4173,7 @@ class CfnContainerGroupDefinition(
|
|
|
4173
4173
|
|
|
4174
4174
|
@builtins.property
|
|
4175
4175
|
def memory_hard_limit_mebibytes(self) -> typing.Optional[jsii.Number]:
|
|
4176
|
-
'''The amount of memory that Amazon GameLift makes available to the container.
|
|
4176
|
+
'''The amount of memory that Amazon GameLift Servers makes available to the container.
|
|
4177
4177
|
|
|
4178
4178
|
If memory limits aren't set for an individual container, the container shares the container group's total memory allocation.
|
|
4179
4179
|
|
|
@@ -4201,7 +4201,7 @@ class CfnContainerGroupDefinition(
|
|
|
4201
4201
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnContainerGroupDefinition.PortConfigurationProperty"]]:
|
|
4202
4202
|
'''A set of ports that allow access to the container from external users.
|
|
4203
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`` .
|
|
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 Servers maps these container ports to externally accessible connection ports, which are assigned as needed from the container fleet's ``ConnectionPortRange`` .
|
|
4205
4205
|
|
|
4206
4206
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-supportcontainerdefinition.html#cfn-gamelift-containergroupdefinition-supportcontainerdefinition-portconfiguration
|
|
4207
4207
|
'''
|
|
@@ -4278,10 +4278,10 @@ class CfnContainerGroupDefinitionProps:
|
|
|
4278
4278
|
'''Properties for defining a ``CfnContainerGroupDefinition``.
|
|
4279
4279
|
|
|
4280
4280
|
:param name: A descriptive identifier for the container group definition. The name value is unique in an AWS Region.
|
|
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
|
|
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 server SDK version 4.x for Amazon GameLift Servers, first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See `Migrate to server SDK version 5. <https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk5-migration.html>`_
|
|
4282
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
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.
|
|
4284
|
+
:param container_group_type: The type of container group. Container group type determines how Amazon GameLift Servers deploys the container group on each fleet instance.
|
|
4285
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.
|
|
4286
4286
|
:param source_version_number: A specific ContainerGroupDefinition version to be updated.
|
|
4287
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.
|
|
@@ -4433,7 +4433,7 @@ class CfnContainerGroupDefinitionProps:
|
|
|
4433
4433
|
|
|
4434
4434
|
.. epigraph::
|
|
4435
4435
|
|
|
4436
|
-
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
|
|
4436
|
+
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 server SDK version 4.x for Amazon GameLift Servers, first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See `Migrate to server SDK version 5. <https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk5-migration.html>`_
|
|
4437
4437
|
|
|
4438
4438
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-operatingsystem
|
|
4439
4439
|
'''
|
|
@@ -4471,7 +4471,7 @@ class CfnContainerGroupDefinitionProps:
|
|
|
4471
4471
|
def container_group_type(self) -> typing.Optional[builtins.str]:
|
|
4472
4472
|
'''The type of container group.
|
|
4473
4473
|
|
|
4474
|
-
Container group type determines how Amazon GameLift deploys the container group on each fleet instance.
|
|
4474
|
+
Container group type determines how Amazon GameLift Servers deploys the container group on each fleet instance.
|
|
4475
4475
|
|
|
4476
4476
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-containergrouptype
|
|
4477
4477
|
'''
|
|
@@ -4683,26 +4683,26 @@ class CfnFleet(
|
|
|
4683
4683
|
:param scope: Scope in which this resource is defined.
|
|
4684
4684
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
4685
4685
|
:param name: A descriptive label that is associated with a fleet. Fleet names do not need to be unique.
|
|
4686
|
-
:param anywhere_configuration: Amazon GameLift Anywhere configuration options.
|
|
4686
|
+
:param anywhere_configuration: Amazon GameLift Servers Anywhere configuration options.
|
|
4687
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>`_
|
|
4688
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.
|
|
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* .
|
|
4689
|
+
:param certificate_configuration: Prompts Amazon GameLift Servers to generate a TLS/SSL certificate for the fleet. Amazon GameLift Servers uses the certificates to encrypt traffic between game clients and the game servers running on Amazon GameLift Servers. 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* .
|
|
4690
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.
|
|
4691
4691
|
:param description: A description for the fleet.
|
|
4692
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.
|
|
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
|
|
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.
|
|
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 Amazon GameLift Servers Realtime fleets, Amazon GameLift Servers automatically sets TCP and UDP ranges.
|
|
4694
|
+
:param ec2_instance_type: The Amazon GameLift Servers-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.
|
|
4695
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.
|
|
4696
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
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`` .
|
|
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.
|
|
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 Servers. 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 Servers requires you to include your home location in the request. For a list of supported Regions and Local Zones, see `Amazon GameLift Servers service locations <https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-regions.html>`_ for managed hosting.
|
|
4699
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()
|
|
4700
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.
|
|
4701
4701
|
:param metric_groups: The name of an AWS CloudWatch metric group to add this fleet to. A metric group is used to aggregate the metrics for multiple fleets. You can specify an existing metric group name or set a new name to create a new metric group. A fleet can be included in only one metric group at a time.
|
|
4702
4702
|
:param min_size: The minimum number of instances that are allowed in the specified fleet location. If this parameter is not set, the default is 0.
|
|
4703
4703
|
:param new_game_session_protection_policy: The status of termination protection for active game sessions on the fleet. By default, this property is set to ``NoProtection`` . - *NoProtection* - Game sessions can be terminated during active gameplay as a result of a scale-down event. - *FullProtection* - Game sessions in ``ACTIVE`` status cannot be terminated during a scale-down event.
|
|
4704
|
-
:param peer_vpc_aws_account_id: Used when peering your Amazon GameLift fleet with a VPC, the unique identifier for the AWS account that owns the VPC. You can find your account ID in the AWS Management Console under account settings.
|
|
4705
|
-
:param peer_vpc_id: A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the `VPC Dashboard <https://docs.aws.amazon.com/vpc/>`_ in the AWS Management Console . Learn more about VPC peering in `VPC Peering with Amazon GameLift Fleets <https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html>`_ .
|
|
4704
|
+
:param peer_vpc_aws_account_id: Used when peering your Amazon GameLift Servers fleet with a VPC, the unique identifier for the AWS account that owns the VPC. You can find your account ID in the AWS Management Console under account settings.
|
|
4705
|
+
:param peer_vpc_id: A unique identifier for a VPC with resources to be accessed by your Amazon GameLift Servers fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the `VPC Dashboard <https://docs.aws.amazon.com/vpc/>`_ in the AWS Management Console . Learn more about VPC peering in `VPC Peering with Amazon GameLift Servers Fleets <https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html>`_ .
|
|
4706
4706
|
:param resource_creation_limit_policy: A policy that limits the number of game sessions that an individual player can create on instances in this fleet within a specified span of time.
|
|
4707
4707
|
:param runtime_configuration: Instructions for how to launch and maintain server processes on instances in the fleet. The runtime configuration defines one or more server process configurations, each identifying a build executable or Realtime script file and the number of processes of that type to run concurrently. .. epigraph:: The ``RuntimeConfiguration`` parameter is required unless the fleet is being configured using the older parameters ``ServerLaunchPath`` and ``ServerLaunchParameters`` , which are still supported for backward compatibility.
|
|
4708
4708
|
:param scaling_policies: Rule that controls how a fleet is scaled. Scaling policies are uniquely identified by the combination of name and fleet ID.
|
|
@@ -4808,7 +4808,7 @@ class CfnFleet(
|
|
|
4808
4808
|
def anywhere_configuration(
|
|
4809
4809
|
self,
|
|
4810
4810
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnFleet.AnywhereConfigurationProperty"]]:
|
|
4811
|
-
'''Amazon GameLift Anywhere configuration options.'''
|
|
4811
|
+
'''Amazon GameLift Servers Anywhere configuration options.'''
|
|
4812
4812
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnFleet.AnywhereConfigurationProperty"]], jsii.get(self, "anywhereConfiguration"))
|
|
4813
4813
|
|
|
4814
4814
|
@anywhere_configuration.setter
|
|
@@ -4852,7 +4852,7 @@ class CfnFleet(
|
|
|
4852
4852
|
def certificate_configuration(
|
|
4853
4853
|
self,
|
|
4854
4854
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnFleet.CertificateConfigurationProperty"]]:
|
|
4855
|
-
'''Prompts Amazon GameLift to generate a TLS/SSL certificate for the fleet.'''
|
|
4855
|
+
'''Prompts Amazon GameLift Servers to generate a TLS/SSL certificate for the fleet.'''
|
|
4856
4856
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnFleet.CertificateConfigurationProperty"]], jsii.get(self, "certificateConfiguration"))
|
|
4857
4857
|
|
|
4858
4858
|
@certificate_configuration.setter
|
|
@@ -4925,7 +4925,7 @@ class CfnFleet(
|
|
|
4925
4925
|
@builtins.property
|
|
4926
4926
|
@jsii.member(jsii_name="ec2InstanceType")
|
|
4927
4927
|
def ec2_instance_type(self) -> typing.Optional[builtins.str]:
|
|
4928
|
-
'''The Amazon GameLift-supported Amazon EC2 instance type to use with managed EC2 fleets.'''
|
|
4928
|
+
'''The Amazon GameLift Servers-supported Amazon EC2 instance type to use with managed EC2 fleets.'''
|
|
4929
4929
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "ec2InstanceType"))
|
|
4930
4930
|
|
|
4931
4931
|
@ec2_instance_type.setter
|
|
@@ -5071,7 +5071,7 @@ class CfnFleet(
|
|
|
5071
5071
|
@builtins.property
|
|
5072
5072
|
@jsii.member(jsii_name="peerVpcAwsAccountId")
|
|
5073
5073
|
def peer_vpc_aws_account_id(self) -> typing.Optional[builtins.str]:
|
|
5074
|
-
'''Used when peering your Amazon GameLift fleet with a VPC, the unique identifier for the AWS account that owns the VPC.'''
|
|
5074
|
+
'''Used when peering your Amazon GameLift Servers fleet with a VPC, the unique identifier for the AWS account that owns the VPC.'''
|
|
5075
5075
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "peerVpcAwsAccountId"))
|
|
5076
5076
|
|
|
5077
5077
|
@peer_vpc_aws_account_id.setter
|
|
@@ -5084,7 +5084,7 @@ class CfnFleet(
|
|
|
5084
5084
|
@builtins.property
|
|
5085
5085
|
@jsii.member(jsii_name="peerVpcId")
|
|
5086
5086
|
def peer_vpc_id(self) -> typing.Optional[builtins.str]:
|
|
5087
|
-
'''A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet.'''
|
|
5087
|
+
'''A unique identifier for a VPC with resources to be accessed by your Amazon GameLift Servers fleet.'''
|
|
5088
5088
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "peerVpcId"))
|
|
5089
5089
|
|
|
5090
5090
|
@peer_vpc_id.setter
|
|
@@ -5204,9 +5204,9 @@ class CfnFleet(
|
|
|
5204
5204
|
)
|
|
5205
5205
|
class AnywhereConfigurationProperty:
|
|
5206
5206
|
def __init__(self, *, cost: builtins.str) -> None:
|
|
5207
|
-
'''Amazon GameLift configuration options for your Anywhere fleets.
|
|
5207
|
+
'''Amazon GameLift Servers configuration options for your Anywhere fleets.
|
|
5208
5208
|
|
|
5209
|
-
:param cost: The cost to run your fleet per hour. Amazon GameLift uses the provided cost of your fleet to balance usage in queues. For more information about queues, see `Setting up queues <https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-intro.html>`_ in the *Amazon GameLift Developer Guide* .
|
|
5209
|
+
:param cost: The cost to run your fleet per hour. Amazon GameLift Servers uses the provided cost of your fleet to balance usage in queues. For more information about queues, see `Setting up queues <https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-intro.html>`_ in the *Amazon GameLift Servers Developer Guide* .
|
|
5210
5210
|
|
|
5211
5211
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-anywhereconfiguration.html
|
|
5212
5212
|
:exampleMetadata: fixture=_generated
|
|
@@ -5232,7 +5232,7 @@ class CfnFleet(
|
|
|
5232
5232
|
def cost(self) -> builtins.str:
|
|
5233
5233
|
'''The cost to run your fleet per hour.
|
|
5234
5234
|
|
|
5235
|
-
Amazon GameLift uses the provided cost of your fleet to balance usage in queues. For more information about queues, see `Setting up queues <https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-intro.html>`_ in the *Amazon GameLift Developer Guide* .
|
|
5235
|
+
Amazon GameLift Servers uses the provided cost of your fleet to balance usage in queues. For more information about queues, see `Setting up queues <https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-intro.html>`_ in the *Amazon GameLift Servers Developer Guide* .
|
|
5236
5236
|
|
|
5237
5237
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-anywhereconfiguration.html#cfn-gamelift-fleet-anywhereconfiguration-cost
|
|
5238
5238
|
'''
|
|
@@ -5544,7 +5544,7 @@ class CfnFleet(
|
|
|
5544
5544
|
) -> None:
|
|
5545
5545
|
'''A remote location where a multi-location fleet can deploy game servers for game hosting.
|
|
5546
5546
|
|
|
5547
|
-
: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.
|
|
5547
|
+
:param location: An AWS Region code, such as ``us-west-2`` . For a list of supported Regions and Local Zones, see `Amazon GameLift Servers service locations <https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-regions.html>`_ for managed hosting.
|
|
5548
5548
|
:param location_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>`_
|
|
5549
5549
|
|
|
5550
5550
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-locationconfiguration.html
|
|
@@ -5581,7 +5581,7 @@ class CfnFleet(
|
|
|
5581
5581
|
def location(self) -> builtins.str:
|
|
5582
5582
|
'''An AWS Region code, such as ``us-west-2`` .
|
|
5583
5583
|
|
|
5584
|
-
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.
|
|
5584
|
+
For a list of supported Regions and Local Zones, see `Amazon GameLift Servers service locations <https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-regions.html>`_ for managed hosting.
|
|
5585
5585
|
|
|
5586
5586
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-locationconfiguration.html#cfn-gamelift-fleet-locationconfiguration-location
|
|
5587
5587
|
'''
|
|
@@ -5636,7 +5636,7 @@ class CfnFleet(
|
|
|
5636
5636
|
|
|
5637
5637
|
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.
|
|
5638
5638
|
|
|
5639
|
-
: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 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.
|
|
5639
|
+
: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 is evaluated when a player tries to create a new game session. On receiving a ``CreateGameSession`` request, Amazon GameLift Servers checks that the player (identified by ``CreatorId`` ) has created fewer than game session limit in the specified time period.
|
|
5640
5640
|
:param policy_period_in_minutes: The time span used in evaluating the resource creation limit policy.
|
|
5641
5641
|
|
|
5642
5642
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-resourcecreationlimitpolicy.html
|
|
@@ -5669,7 +5669,7 @@ class CfnFleet(
|
|
|
5669
5669
|
|
|
5670
5670
|
With this policy, you can control players' ability to consume available resources.
|
|
5671
5671
|
|
|
5672
|
-
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.
|
|
5672
|
+
The policy is evaluated when a player tries to create a new game session. On receiving a ``CreateGameSession`` request, Amazon GameLift Servers checks that the player (identified by ``CreatorId`` ) has created fewer than game session limit in the specified time period.
|
|
5673
5673
|
|
|
5674
5674
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-resourcecreationlimitpolicy.html#cfn-gamelift-fleet-resourcecreationlimitpolicy-newgamesessionspercreator
|
|
5675
5675
|
'''
|
|
@@ -5844,7 +5844,7 @@ class CfnFleet(
|
|
|
5844
5844
|
|
|
5845
5845
|
Scaling policies are uniquely identified by the combination of name and fleet ID.
|
|
5846
5846
|
|
|
5847
|
-
: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.
|
|
5847
|
+
:param metric_name: Name of the Amazon GameLift Servers-defined metric that is used to trigger a scaling adjustment. For detailed descriptions of fleet metrics, see `Monitor Amazon GameLift Servers 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.
|
|
5848
5848
|
:param name: A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique.
|
|
5849
5849
|
:param comparison_operator: Comparison operator to use when measuring a metric against the threshold value.
|
|
5850
5850
|
:param evaluation_periods: Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
|
|
@@ -5926,9 +5926,9 @@ class CfnFleet(
|
|
|
5926
5926
|
|
|
5927
5927
|
@builtins.property
|
|
5928
5928
|
def metric_name(self) -> builtins.str:
|
|
5929
|
-
'''Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment.
|
|
5929
|
+
'''Name of the Amazon GameLift Servers-defined metric that is used to trigger a scaling adjustment.
|
|
5930
5930
|
|
|
5931
|
-
For detailed descriptions of fleet metrics, see `Monitor Amazon GameLift with Amazon CloudWatch <https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html>`_ .
|
|
5931
|
+
For detailed descriptions of fleet metrics, see `Monitor Amazon GameLift Servers with Amazon CloudWatch <https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html>`_ .
|
|
5932
5932
|
|
|
5933
5933
|
- *ActivatingGameSessions* -- Game sessions in the process of being created.
|
|
5934
5934
|
- *ActiveGameSessions* -- Game sessions that are currently running.
|
|
@@ -6103,7 +6103,7 @@ class CfnFleet(
|
|
|
6103
6103
|
Server processes run either an executable in a custom game build or a Realtime Servers script.
|
|
6104
6104
|
|
|
6105
6105
|
:param concurrent_executions: The number of server processes using this configuration that run concurrently on each instance or compute.
|
|
6106
|
-
:param launch_path: The location of a game build executable or Realtime script. Game builds and Realtime scripts are installed on instances at the root: - Windows (custom game builds only): ``C:\\game`` . Example: " ``C:\\game\\MyGame\\server.exe`` " - Linux: ``/local/game`` . Examples: " ``/local/game/MyGame/server.exe`` " or " ``/local/game/MyRealtimeScript.js`` " .. epigraph:: Amazon GameLift doesn't support the use of setup scripts that launch the game executable. For custom game builds, this parameter must indicate the executable that calls the server SDK operations ``initSDK()`` and ``ProcessReady()`` .
|
|
6106
|
+
:param launch_path: The location of a game build executable or Realtime script. Game builds and Realtime scripts are installed on instances at the root: - Windows (custom game builds only): ``C:\\game`` . Example: " ``C:\\game\\MyGame\\server.exe`` " - Linux: ``/local/game`` . Examples: " ``/local/game/MyGame/server.exe`` " or " ``/local/game/MyRealtimeScript.js`` " .. epigraph:: Amazon GameLift Servers doesn't support the use of setup scripts that launch the game executable. For custom game builds, this parameter must indicate the executable that calls the server SDK operations ``initSDK()`` and ``ProcessReady()`` .
|
|
6107
6107
|
:param parameters: An optional list of parameters to pass to the server executable or Realtime script on launch. Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: [A-Za-z0-9_:.+/\\- =@{},?'[]"]+
|
|
6108
6108
|
|
|
6109
6109
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-serverprocess.html
|
|
@@ -6156,7 +6156,7 @@ class CfnFleet(
|
|
|
6156
6156
|
|
|
6157
6157
|
.. epigraph::
|
|
6158
6158
|
|
|
6159
|
-
Amazon GameLift doesn't support the use of setup scripts that launch the game executable. For custom game builds, this parameter must indicate the executable that calls the server SDK operations ``initSDK()`` and ``ProcessReady()`` .
|
|
6159
|
+
Amazon GameLift Servers doesn't support the use of setup scripts that launch the game executable. For custom game builds, this parameter must indicate the executable that calls the server SDK operations ``initSDK()`` and ``ProcessReady()`` .
|
|
6160
6160
|
|
|
6161
6161
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-serverprocess.html#cfn-gamelift-fleet-serverprocess-launchpath
|
|
6162
6162
|
'''
|
|
@@ -6197,7 +6197,7 @@ class CfnFleet(
|
|
|
6197
6197
|
def __init__(self, *, target_value: jsii.Number) -> None:
|
|
6198
6198
|
'''Settings for a target-based scaling policy.
|
|
6199
6199
|
|
|
6200
|
-
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.
|
|
6200
|
+
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 Servers 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.
|
|
6201
6201
|
|
|
6202
6202
|
:param target_value: Desired value to use with a target-based scaling policy. The value must be relevant for whatever metric the scaling policy is using. For example, in a policy using the metric PercentAvailableGameSessions, the target value should be the preferred size of the fleet's buffer (the percent of capacity that should be idle and ready for new game sessions).
|
|
6203
6203
|
|
|
@@ -6313,26 +6313,26 @@ class CfnFleetProps:
|
|
|
6313
6313
|
'''Properties for defining a ``CfnFleet``.
|
|
6314
6314
|
|
|
6315
6315
|
:param name: A descriptive label that is associated with a fleet. Fleet names do not need to be unique.
|
|
6316
|
-
:param anywhere_configuration: Amazon GameLift Anywhere configuration options.
|
|
6316
|
+
:param anywhere_configuration: Amazon GameLift Servers Anywhere configuration options.
|
|
6317
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>`_
|
|
6318
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.
|
|
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* .
|
|
6319
|
+
:param certificate_configuration: Prompts Amazon GameLift Servers to generate a TLS/SSL certificate for the fleet. Amazon GameLift Servers uses the certificates to encrypt traffic between game clients and the game servers running on Amazon GameLift Servers. 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* .
|
|
6320
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.
|
|
6321
6321
|
:param description: A description for the fleet.
|
|
6322
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.
|
|
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
|
|
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.
|
|
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 Amazon GameLift Servers Realtime fleets, Amazon GameLift Servers automatically sets TCP and UDP ranges.
|
|
6324
|
+
:param ec2_instance_type: The Amazon GameLift Servers-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.
|
|
6325
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.
|
|
6326
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
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`` .
|
|
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.
|
|
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 Servers. 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 Servers requires you to include your home location in the request. For a list of supported Regions and Local Zones, see `Amazon GameLift Servers service locations <https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-regions.html>`_ for managed hosting.
|
|
6329
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()
|
|
6330
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.
|
|
6331
6331
|
:param metric_groups: The name of an AWS CloudWatch metric group to add this fleet to. A metric group is used to aggregate the metrics for multiple fleets. You can specify an existing metric group name or set a new name to create a new metric group. A fleet can be included in only one metric group at a time.
|
|
6332
6332
|
:param min_size: The minimum number of instances that are allowed in the specified fleet location. If this parameter is not set, the default is 0.
|
|
6333
6333
|
:param new_game_session_protection_policy: The status of termination protection for active game sessions on the fleet. By default, this property is set to ``NoProtection`` . - *NoProtection* - Game sessions can be terminated during active gameplay as a result of a scale-down event. - *FullProtection* - Game sessions in ``ACTIVE`` status cannot be terminated during a scale-down event.
|
|
6334
|
-
:param peer_vpc_aws_account_id: Used when peering your Amazon GameLift fleet with a VPC, the unique identifier for the AWS account that owns the VPC. You can find your account ID in the AWS Management Console under account settings.
|
|
6335
|
-
:param peer_vpc_id: A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the `VPC Dashboard <https://docs.aws.amazon.com/vpc/>`_ in the AWS Management Console . Learn more about VPC peering in `VPC Peering with Amazon GameLift Fleets <https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html>`_ .
|
|
6334
|
+
:param peer_vpc_aws_account_id: Used when peering your Amazon GameLift Servers fleet with a VPC, the unique identifier for the AWS account that owns the VPC. You can find your account ID in the AWS Management Console under account settings.
|
|
6335
|
+
:param peer_vpc_id: A unique identifier for a VPC with resources to be accessed by your Amazon GameLift Servers fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the `VPC Dashboard <https://docs.aws.amazon.com/vpc/>`_ in the AWS Management Console . Learn more about VPC peering in `VPC Peering with Amazon GameLift Servers Fleets <https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html>`_ .
|
|
6336
6336
|
:param resource_creation_limit_policy: A policy that limits the number of game sessions that an individual player can create on instances in this fleet within a specified span of time.
|
|
6337
6337
|
:param runtime_configuration: Instructions for how to launch and maintain server processes on instances in the fleet. The runtime configuration defines one or more server process configurations, each identifying a build executable or Realtime script file and the number of processes of that type to run concurrently. .. epigraph:: The ``RuntimeConfiguration`` parameter is required unless the fleet is being configured using the older parameters ``ServerLaunchPath`` and ``ServerLaunchParameters`` , which are still supported for backward compatibility.
|
|
6338
6338
|
:param scaling_policies: Rule that controls how a fleet is scaled. Scaling policies are uniquely identified by the combination of name and fleet ID.
|
|
@@ -6530,7 +6530,7 @@ class CfnFleetProps:
|
|
|
6530
6530
|
def anywhere_configuration(
|
|
6531
6531
|
self,
|
|
6532
6532
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnFleet.AnywhereConfigurationProperty]]:
|
|
6533
|
-
'''Amazon GameLift Anywhere configuration options.
|
|
6533
|
+
'''Amazon GameLift Servers Anywhere configuration options.
|
|
6534
6534
|
|
|
6535
6535
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-anywhereconfiguration
|
|
6536
6536
|
'''
|
|
@@ -6565,9 +6565,9 @@ class CfnFleetProps:
|
|
|
6565
6565
|
def certificate_configuration(
|
|
6566
6566
|
self,
|
|
6567
6567
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnFleet.CertificateConfigurationProperty]]:
|
|
6568
|
-
'''Prompts Amazon GameLift to generate a TLS/SSL certificate for the fleet.
|
|
6568
|
+
'''Prompts Amazon GameLift Servers to generate a TLS/SSL certificate for the fleet.
|
|
6569
6569
|
|
|
6570
|
-
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.
|
|
6570
|
+
Amazon GameLift Servers uses the certificates to encrypt traffic between game clients and the game servers running on Amazon GameLift Servers. By default, the ``CertificateConfiguration`` is ``DISABLED`` . You can't change this property after you create the fleet.
|
|
6571
6571
|
|
|
6572
6572
|
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.
|
|
6573
6573
|
.. epigraph::
|
|
@@ -6617,7 +6617,7 @@ class CfnFleetProps:
|
|
|
6617
6617
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, CfnFleet.IpPermissionProperty]]]]:
|
|
6618
6618
|
'''The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet.
|
|
6619
6619
|
|
|
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
|
|
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 Amazon GameLift Servers Realtime fleets, Amazon GameLift Servers automatically sets TCP and UDP ranges.
|
|
6621
6621
|
|
|
6622
6622
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-ec2inboundpermissions
|
|
6623
6623
|
'''
|
|
@@ -6626,7 +6626,7 @@ class CfnFleetProps:
|
|
|
6626
6626
|
|
|
6627
6627
|
@builtins.property
|
|
6628
6628
|
def ec2_instance_type(self) -> typing.Optional[builtins.str]:
|
|
6629
|
-
'''The Amazon GameLift-supported Amazon EC2 instance type to use with managed EC2 fleets.
|
|
6629
|
+
'''The Amazon GameLift Servers-supported Amazon EC2 instance type to use with managed EC2 fleets.
|
|
6630
6630
|
|
|
6631
6631
|
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.
|
|
6632
6632
|
|
|
@@ -6674,7 +6674,7 @@ class CfnFleetProps:
|
|
|
6674
6674
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, CfnFleet.LocationConfigurationProperty]]]]:
|
|
6675
6675
|
'''A set of remote locations to deploy additional instances to and manage as a multi-location fleet.
|
|
6676
6676
|
|
|
6677
|
-
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.
|
|
6677
|
+
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 Servers. 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 Servers requires you to include your home location in the request. For a list of supported Regions and Local Zones, see `Amazon GameLift Servers service locations <https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-regions.html>`_ for managed hosting.
|
|
6678
6678
|
|
|
6679
6679
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-locations
|
|
6680
6680
|
'''
|
|
@@ -6744,7 +6744,7 @@ class CfnFleetProps:
|
|
|
6744
6744
|
|
|
6745
6745
|
@builtins.property
|
|
6746
6746
|
def peer_vpc_aws_account_id(self) -> typing.Optional[builtins.str]:
|
|
6747
|
-
'''Used when peering your Amazon GameLift fleet with a VPC, the unique identifier for the AWS account that owns the VPC.
|
|
6747
|
+
'''Used when peering your Amazon GameLift Servers fleet with a VPC, the unique identifier for the AWS account that owns the VPC.
|
|
6748
6748
|
|
|
6749
6749
|
You can find your account ID in the AWS Management Console under account settings.
|
|
6750
6750
|
|
|
@@ -6755,9 +6755,9 @@ class CfnFleetProps:
|
|
|
6755
6755
|
|
|
6756
6756
|
@builtins.property
|
|
6757
6757
|
def peer_vpc_id(self) -> typing.Optional[builtins.str]:
|
|
6758
|
-
'''A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet.
|
|
6758
|
+
'''A unique identifier for a VPC with resources to be accessed by your Amazon GameLift Servers fleet.
|
|
6759
6759
|
|
|
6760
|
-
The VPC must be in the same Region as your fleet. To look up a VPC ID, use the `VPC Dashboard <https://docs.aws.amazon.com/vpc/>`_ in the AWS Management Console . Learn more about VPC peering in `VPC Peering with Amazon GameLift Fleets <https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html>`_ .
|
|
6760
|
+
The VPC must be in the same Region as your fleet. To look up a VPC ID, use the `VPC Dashboard <https://docs.aws.amazon.com/vpc/>`_ in the AWS Management Console . Learn more about VPC peering in `VPC Peering with Amazon GameLift Servers Fleets <https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html>`_ .
|
|
6761
6761
|
|
|
6762
6762
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-peervpcid
|
|
6763
6763
|
'''
|
|
@@ -6950,17 +6950,17 @@ class CfnGameServerGroup(
|
|
|
6950
6950
|
:param scope: Scope in which this resource is defined.
|
|
6951
6951
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
6952
6952
|
:param game_server_group_name: A developer-defined identifier for the game server group. The name is unique for each Region in each AWS account.
|
|
6953
|
-
:param instance_definitions: The set of Amazon EC2 instance types that Amazon GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.
|
|
6954
|
-
:param role_arn: The Amazon Resource Name ( `ARN <https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html>`_ ) for an IAM role that allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups.
|
|
6953
|
+
:param instance_definitions: The set of Amazon EC2 instance types that Amazon GameLift Servers FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.
|
|
6954
|
+
:param role_arn: The Amazon Resource Name ( `ARN <https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html>`_ ) for an IAM role that allows Amazon GameLift Servers to access your Amazon EC2 Auto Scaling groups.
|
|
6955
6955
|
:param auto_scaling_policy: Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting. The scaling policy uses the metric ``"PercentUtilizedGameServers"`` to maintain a buffer of idle game servers that can immediately accommodate new games and players. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs.
|
|
6956
|
-
:param balancing_strategy: Indicates how Amazon GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group. Method options include the following: - ``SPOT_ONLY`` - Only Spot Instances are used in the game server group. If Spot Instances are unavailable or not viable for game hosting, the game server group provides no hosting capacity until Spot Instances can again be used. Until then, no new instances are started, and the existing nonviable Spot Instances are terminated (after current gameplay ends) and are not replaced. - ``SPOT_PREFERRED`` - (default value) Spot Instances are used whenever available in the game server group. If Spot Instances are unavailable, the game server group continues to provide hosting capacity by falling back to On-Demand Instances. Existing nonviable Spot Instances are terminated (after current gameplay ends) and are replaced with new On-Demand Instances. - ``ON_DEMAND_ONLY`` - Only On-Demand Instances are used in the game server group. No Spot Instances are used, even when available, while this balancing strategy is in force.
|
|
6956
|
+
:param balancing_strategy: Indicates how Amazon GameLift Servers FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group. Method options include the following: - ``SPOT_ONLY`` - Only Spot Instances are used in the game server group. If Spot Instances are unavailable or not viable for game hosting, the game server group provides no hosting capacity until Spot Instances can again be used. Until then, no new instances are started, and the existing nonviable Spot Instances are terminated (after current gameplay ends) and are not replaced. - ``SPOT_PREFERRED`` - (default value) Spot Instances are used whenever available in the game server group. If Spot Instances are unavailable, the game server group continues to provide hosting capacity by falling back to On-Demand Instances. Existing nonviable Spot Instances are terminated (after current gameplay ends) and are replaced with new On-Demand Instances. - ``ON_DEMAND_ONLY`` - Only On-Demand Instances are used in the game server group. No Spot Instances are used, even when available, while this balancing strategy is in force.
|
|
6957
6957
|
:param delete_option: The type of delete to perform. To delete a game server group, specify the ``DeleteOption`` . Options include the following: - ``SAFE_DELETE`` – (default) Terminates the game server group and Amazon EC2 Auto Scaling group only when it has no game servers that are in ``UTILIZED`` status. - ``FORCE_DELETE`` – Terminates the game server group, including all active game servers regardless of their utilization status, and the Amazon EC2 Auto Scaling group. - ``RETAIN`` – Does a safe delete of the game server group but retains the Amazon EC2 Auto Scaling group as is.
|
|
6958
6958
|
:param game_server_protection_policy: A flag that indicates whether instances in the game server group are protected from early termination. Unprotected instances that have active game servers running might be terminated during a scale-down event, causing players to be dropped from the game. Protected instances cannot be terminated while there are active game servers running except in the event of a forced game server group deletion (see ). An exception to this is with Spot Instances, which can be terminated by AWS regardless of protection status.
|
|
6959
|
-
:param launch_template: The Amazon EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group. You can specify the template using either the template name or ID. For help with creating a launch template, see `Creating a Launch Template for an Auto Scaling Group <https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html>`_ in the *Amazon Elastic Compute Cloud Auto Scaling User Guide* . After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs. .. epigraph:: If you specify network interfaces in your launch template, you must explicitly set the property ``AssociatePublicIpAddress`` to "true". If no network interface is specified in the launch template, Amazon GameLift FleetIQ uses your account's default VPC.
|
|
6960
|
-
:param max_size: The maximum number of instances allowed in the Amazon EC2 Auto Scaling group. During automatic scaling events, Amazon GameLift FleetIQ and EC2 do not scale up the group above this maximum. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs.
|
|
6961
|
-
:param min_size: The minimum number of instances allowed in the Amazon EC2 Auto Scaling group. During automatic scaling events, Amazon GameLift FleetIQ and Amazon EC2 do not scale down the group below this minimum. In production, this value should be set to at least 1. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs.
|
|
6959
|
+
:param launch_template: The Amazon EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group. You can specify the template using either the template name or ID. For help with creating a launch template, see `Creating a Launch Template for an Auto Scaling Group <https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html>`_ in the *Amazon Elastic Compute Cloud Auto Scaling User Guide* . After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs. .. epigraph:: If you specify network interfaces in your launch template, you must explicitly set the property ``AssociatePublicIpAddress`` to "true". If no network interface is specified in the launch template, Amazon GameLift Servers FleetIQ uses your account's default VPC.
|
|
6960
|
+
:param max_size: The maximum number of instances allowed in the Amazon EC2 Auto Scaling group. During automatic scaling events, Amazon GameLift Servers FleetIQ and EC2 do not scale up the group above this maximum. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs.
|
|
6961
|
+
:param min_size: The minimum number of instances allowed in the Amazon EC2 Auto Scaling group. During automatic scaling events, Amazon GameLift Servers FleetIQ and Amazon EC2 do not scale down the group below this minimum. In production, this value should be set to at least 1. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs.
|
|
6962
6962
|
:param tags: A list of labels to assign to the new game server group resource. Tags are developer-defined key-value pairs. Tagging AWS resources is useful for resource management, access management, and cost allocation. For more information, see `Tagging AWS Resources <https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html>`_ in the *AWS General Reference* . Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags, respectively. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.
|
|
6963
|
-
:param vpc_subnets: A list of virtual private cloud (VPC) subnets to use with instances in the game server group. By default, all Amazon GameLift FleetIQ-supported Availability Zones are used. You can use this parameter to specify VPCs that you've set up. This property cannot be updated after the game server group is created, and the corresponding Auto Scaling group will always use the property value that is set with this request, even if the Auto Scaling group is updated directly.
|
|
6963
|
+
:param vpc_subnets: A list of virtual private cloud (VPC) subnets to use with instances in the game server group. By default, all Amazon GameLift Servers FleetIQ-supported Availability Zones are used. You can use this parameter to specify VPCs that you've set up. This property cannot be updated after the game server group is created, and the corresponding Auto Scaling group will always use the property value that is set with this request, even if the Auto Scaling group is updated directly.
|
|
6964
6964
|
'''
|
|
6965
6965
|
if __debug__:
|
|
6966
6966
|
type_hints = typing.get_type_hints(_typecheckingstub__39a0d4e260fba686f866a885f9a542286a05d085037e114d8febabfdd92cfd24)
|
|
@@ -7060,7 +7060,7 @@ class CfnGameServerGroup(
|
|
|
7060
7060
|
def instance_definitions(
|
|
7061
7061
|
self,
|
|
7062
7062
|
) -> typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnGameServerGroup.InstanceDefinitionProperty"]]]:
|
|
7063
|
-
'''The set of Amazon EC2 instance types that Amazon GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.'''
|
|
7063
|
+
'''The set of Amazon EC2 instance types that Amazon GameLift Servers FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.'''
|
|
7064
7064
|
return typing.cast(typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnGameServerGroup.InstanceDefinitionProperty"]]], jsii.get(self, "instanceDefinitions"))
|
|
7065
7065
|
|
|
7066
7066
|
@instance_definitions.setter
|
|
@@ -7076,7 +7076,7 @@ class CfnGameServerGroup(
|
|
|
7076
7076
|
@builtins.property
|
|
7077
7077
|
@jsii.member(jsii_name="roleArn")
|
|
7078
7078
|
def role_arn(self) -> builtins.str:
|
|
7079
|
-
'''The Amazon Resource Name ( `ARN <https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html>`_ ) for an IAM role that allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups.'''
|
|
7079
|
+
'''The Amazon Resource Name ( `ARN <https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html>`_ ) for an IAM role that allows Amazon GameLift Servers to access your Amazon EC2 Auto Scaling groups.'''
|
|
7080
7080
|
return typing.cast(builtins.str, jsii.get(self, "roleArn"))
|
|
7081
7081
|
|
|
7082
7082
|
@role_arn.setter
|
|
@@ -7107,7 +7107,7 @@ class CfnGameServerGroup(
|
|
|
7107
7107
|
@builtins.property
|
|
7108
7108
|
@jsii.member(jsii_name="balancingStrategy")
|
|
7109
7109
|
def balancing_strategy(self) -> typing.Optional[builtins.str]:
|
|
7110
|
-
'''Indicates how Amazon GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group.'''
|
|
7110
|
+
'''Indicates how Amazon GameLift Servers FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group.'''
|
|
7111
7111
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "balancingStrategy"))
|
|
7112
7112
|
|
|
7113
7113
|
@balancing_strategy.setter
|
|
@@ -7236,7 +7236,7 @@ class CfnGameServerGroup(
|
|
|
7236
7236
|
Configuration settings for intelligent automatic scaling that uses target tracking. After the Auto Scaling group is created, all updates to Auto Scaling policies, including changing this policy and adding or removing other policies, is done directly on the Auto Scaling group.
|
|
7237
7237
|
|
|
7238
7238
|
:param target_tracking_configuration: Settings for a target-based scaling policy applied to Auto Scaling group. These settings are used to create a target-based policy that tracks the GameLift FleetIQ metric ``PercentUtilizedGameServers`` and specifies a target value for the metric. As player usage changes, the policy triggers to adjust the game server group capacity so that the metric returns to the target value.
|
|
7239
|
-
:param estimated_instance_warmup: Length of time, in seconds, it takes for a new instance to start new game server processes and register with Amazon GameLift FleetIQ. Specifying a warm-up time can be useful, particularly with game servers that take a long time to start up, because it avoids prematurely starting new instances.
|
|
7239
|
+
:param estimated_instance_warmup: Length of time, in seconds, it takes for a new instance to start new game server processes and register with Amazon GameLift Servers FleetIQ. Specifying a warm-up time can be useful, particularly with game servers that take a long time to start up, because it avoids prematurely starting new instances.
|
|
7240
7240
|
|
|
7241
7241
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gameservergroup-autoscalingpolicy.html
|
|
7242
7242
|
:exampleMetadata: fixture=_generated
|
|
@@ -7282,7 +7282,7 @@ class CfnGameServerGroup(
|
|
|
7282
7282
|
|
|
7283
7283
|
@builtins.property
|
|
7284
7284
|
def estimated_instance_warmup(self) -> typing.Optional[jsii.Number]:
|
|
7285
|
-
'''Length of time, in seconds, it takes for a new instance to start new game server processes and register with Amazon GameLift FleetIQ.
|
|
7285
|
+
'''Length of time, in seconds, it takes for a new instance to start new game server processes and register with Amazon GameLift Servers FleetIQ.
|
|
7286
7286
|
|
|
7287
7287
|
Specifying a warm-up time can be useful, particularly with game servers that take a long time to start up, because it avoids prematurely starting new instances.
|
|
7288
7288
|
|
|
@@ -7322,7 +7322,7 @@ class CfnGameServerGroup(
|
|
|
7322
7322
|
An allowed instance type for a ``GameServerGroup`` . All game server groups must have at least two instance types defined for it. GameLift FleetIQ periodically evaluates each defined instance type for viability. It then updates the Auto Scaling group with the list of viable instance types.
|
|
7323
7323
|
|
|
7324
7324
|
:param instance_type: An Amazon EC2 instance type designation.
|
|
7325
|
-
:param weighted_capacity: Instance weighting that indicates how much this instance type contributes to the total capacity of a game server group. Instance weights are used by Amazon GameLift FleetIQ to calculate the instance type's cost per unit hour and better identify the most cost-effective options. For detailed information on weighting instance capacity, see `Instance Weighting <https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-weighting.html>`_ in the *Amazon Elastic Compute Cloud Auto Scaling User Guide* . Default value is "1".
|
|
7325
|
+
:param weighted_capacity: Instance weighting that indicates how much this instance type contributes to the total capacity of a game server group. Instance weights are used by Amazon GameLift Servers FleetIQ to calculate the instance type's cost per unit hour and better identify the most cost-effective options. For detailed information on weighting instance capacity, see `Instance Weighting <https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-weighting.html>`_ in the *Amazon Elastic Compute Cloud Auto Scaling User Guide* . Default value is "1".
|
|
7326
7326
|
|
|
7327
7327
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gameservergroup-instancedefinition.html
|
|
7328
7328
|
:exampleMetadata: fixture=_generated
|
|
@@ -7364,7 +7364,7 @@ class CfnGameServerGroup(
|
|
|
7364
7364
|
def weighted_capacity(self) -> typing.Optional[builtins.str]:
|
|
7365
7365
|
'''Instance weighting that indicates how much this instance type contributes to the total capacity of a game server group.
|
|
7366
7366
|
|
|
7367
|
-
Instance weights are used by Amazon GameLift FleetIQ to calculate the instance type's cost per unit hour and better identify the most cost-effective options. For detailed information on weighting instance capacity, see `Instance Weighting <https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-weighting.html>`_ in the *Amazon Elastic Compute Cloud Auto Scaling User Guide* . Default value is "1".
|
|
7367
|
+
Instance weights are used by Amazon GameLift Servers FleetIQ to calculate the instance type's cost per unit hour and better identify the most cost-effective options. For detailed information on weighting instance capacity, see `Instance Weighting <https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-weighting.html>`_ in the *Amazon Elastic Compute Cloud Auto Scaling User Guide* . Default value is "1".
|
|
7368
7368
|
|
|
7369
7369
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gameservergroup-instancedefinition.html#cfn-gamelift-gameservergroup-instancedefinition-weightedcapacity
|
|
7370
7370
|
'''
|
|
@@ -7568,17 +7568,17 @@ class CfnGameServerGroupProps:
|
|
|
7568
7568
|
'''Properties for defining a ``CfnGameServerGroup``.
|
|
7569
7569
|
|
|
7570
7570
|
:param game_server_group_name: A developer-defined identifier for the game server group. The name is unique for each Region in each AWS account.
|
|
7571
|
-
:param instance_definitions: The set of Amazon EC2 instance types that Amazon GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.
|
|
7572
|
-
:param role_arn: The Amazon Resource Name ( `ARN <https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html>`_ ) for an IAM role that allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups.
|
|
7571
|
+
:param instance_definitions: The set of Amazon EC2 instance types that Amazon GameLift Servers FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.
|
|
7572
|
+
:param role_arn: The Amazon Resource Name ( `ARN <https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html>`_ ) for an IAM role that allows Amazon GameLift Servers to access your Amazon EC2 Auto Scaling groups.
|
|
7573
7573
|
:param auto_scaling_policy: Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting. The scaling policy uses the metric ``"PercentUtilizedGameServers"`` to maintain a buffer of idle game servers that can immediately accommodate new games and players. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs.
|
|
7574
|
-
:param balancing_strategy: Indicates how Amazon GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group. Method options include the following: - ``SPOT_ONLY`` - Only Spot Instances are used in the game server group. If Spot Instances are unavailable or not viable for game hosting, the game server group provides no hosting capacity until Spot Instances can again be used. Until then, no new instances are started, and the existing nonviable Spot Instances are terminated (after current gameplay ends) and are not replaced. - ``SPOT_PREFERRED`` - (default value) Spot Instances are used whenever available in the game server group. If Spot Instances are unavailable, the game server group continues to provide hosting capacity by falling back to On-Demand Instances. Existing nonviable Spot Instances are terminated (after current gameplay ends) and are replaced with new On-Demand Instances. - ``ON_DEMAND_ONLY`` - Only On-Demand Instances are used in the game server group. No Spot Instances are used, even when available, while this balancing strategy is in force.
|
|
7574
|
+
:param balancing_strategy: Indicates how Amazon GameLift Servers FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group. Method options include the following: - ``SPOT_ONLY`` - Only Spot Instances are used in the game server group. If Spot Instances are unavailable or not viable for game hosting, the game server group provides no hosting capacity until Spot Instances can again be used. Until then, no new instances are started, and the existing nonviable Spot Instances are terminated (after current gameplay ends) and are not replaced. - ``SPOT_PREFERRED`` - (default value) Spot Instances are used whenever available in the game server group. If Spot Instances are unavailable, the game server group continues to provide hosting capacity by falling back to On-Demand Instances. Existing nonviable Spot Instances are terminated (after current gameplay ends) and are replaced with new On-Demand Instances. - ``ON_DEMAND_ONLY`` - Only On-Demand Instances are used in the game server group. No Spot Instances are used, even when available, while this balancing strategy is in force.
|
|
7575
7575
|
:param delete_option: The type of delete to perform. To delete a game server group, specify the ``DeleteOption`` . Options include the following: - ``SAFE_DELETE`` – (default) Terminates the game server group and Amazon EC2 Auto Scaling group only when it has no game servers that are in ``UTILIZED`` status. - ``FORCE_DELETE`` – Terminates the game server group, including all active game servers regardless of their utilization status, and the Amazon EC2 Auto Scaling group. - ``RETAIN`` – Does a safe delete of the game server group but retains the Amazon EC2 Auto Scaling group as is.
|
|
7576
7576
|
:param game_server_protection_policy: A flag that indicates whether instances in the game server group are protected from early termination. Unprotected instances that have active game servers running might be terminated during a scale-down event, causing players to be dropped from the game. Protected instances cannot be terminated while there are active game servers running except in the event of a forced game server group deletion (see ). An exception to this is with Spot Instances, which can be terminated by AWS regardless of protection status.
|
|
7577
|
-
:param launch_template: The Amazon EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group. You can specify the template using either the template name or ID. For help with creating a launch template, see `Creating a Launch Template for an Auto Scaling Group <https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html>`_ in the *Amazon Elastic Compute Cloud Auto Scaling User Guide* . After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs. .. epigraph:: If you specify network interfaces in your launch template, you must explicitly set the property ``AssociatePublicIpAddress`` to "true". If no network interface is specified in the launch template, Amazon GameLift FleetIQ uses your account's default VPC.
|
|
7578
|
-
:param max_size: The maximum number of instances allowed in the Amazon EC2 Auto Scaling group. During automatic scaling events, Amazon GameLift FleetIQ and EC2 do not scale up the group above this maximum. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs.
|
|
7579
|
-
:param min_size: The minimum number of instances allowed in the Amazon EC2 Auto Scaling group. During automatic scaling events, Amazon GameLift FleetIQ and Amazon EC2 do not scale down the group below this minimum. In production, this value should be set to at least 1. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs.
|
|
7577
|
+
:param launch_template: The Amazon EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group. You can specify the template using either the template name or ID. For help with creating a launch template, see `Creating a Launch Template for an Auto Scaling Group <https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html>`_ in the *Amazon Elastic Compute Cloud Auto Scaling User Guide* . After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs. .. epigraph:: If you specify network interfaces in your launch template, you must explicitly set the property ``AssociatePublicIpAddress`` to "true". If no network interface is specified in the launch template, Amazon GameLift Servers FleetIQ uses your account's default VPC.
|
|
7578
|
+
:param max_size: The maximum number of instances allowed in the Amazon EC2 Auto Scaling group. During automatic scaling events, Amazon GameLift Servers FleetIQ and EC2 do not scale up the group above this maximum. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs.
|
|
7579
|
+
:param min_size: The minimum number of instances allowed in the Amazon EC2 Auto Scaling group. During automatic scaling events, Amazon GameLift Servers FleetIQ and Amazon EC2 do not scale down the group below this minimum. In production, this value should be set to at least 1. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs.
|
|
7580
7580
|
:param tags: A list of labels to assign to the new game server group resource. Tags are developer-defined key-value pairs. Tagging AWS resources is useful for resource management, access management, and cost allocation. For more information, see `Tagging AWS Resources <https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html>`_ in the *AWS General Reference* . Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags, respectively. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.
|
|
7581
|
-
:param vpc_subnets: A list of virtual private cloud (VPC) subnets to use with instances in the game server group. By default, all Amazon GameLift FleetIQ-supported Availability Zones are used. You can use this parameter to specify VPCs that you've set up. This property cannot be updated after the game server group is created, and the corresponding Auto Scaling group will always use the property value that is set with this request, even if the Auto Scaling group is updated directly.
|
|
7581
|
+
:param vpc_subnets: A list of virtual private cloud (VPC) subnets to use with instances in the game server group. By default, all Amazon GameLift Servers FleetIQ-supported Availability Zones are used. You can use this parameter to specify VPCs that you've set up. This property cannot be updated after the game server group is created, and the corresponding Auto Scaling group will always use the property value that is set with this request, even if the Auto Scaling group is updated directly.
|
|
7582
7582
|
|
|
7583
7583
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html
|
|
7584
7584
|
:exampleMetadata: fixture=_generated
|
|
@@ -7679,7 +7679,7 @@ class CfnGameServerGroupProps:
|
|
|
7679
7679
|
def instance_definitions(
|
|
7680
7680
|
self,
|
|
7681
7681
|
) -> typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, CfnGameServerGroup.InstanceDefinitionProperty]]]:
|
|
7682
|
-
'''The set of Amazon EC2 instance types that Amazon GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.
|
|
7682
|
+
'''The set of Amazon EC2 instance types that Amazon GameLift Servers FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.
|
|
7683
7683
|
|
|
7684
7684
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-instancedefinitions
|
|
7685
7685
|
'''
|
|
@@ -7689,7 +7689,7 @@ class CfnGameServerGroupProps:
|
|
|
7689
7689
|
|
|
7690
7690
|
@builtins.property
|
|
7691
7691
|
def role_arn(self) -> builtins.str:
|
|
7692
|
-
'''The Amazon Resource Name ( `ARN <https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html>`_ ) for an IAM role that allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups.
|
|
7692
|
+
'''The Amazon Resource Name ( `ARN <https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html>`_ ) for an IAM role that allows Amazon GameLift Servers to access your Amazon EC2 Auto Scaling groups.
|
|
7693
7693
|
|
|
7694
7694
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-rolearn
|
|
7695
7695
|
'''
|
|
@@ -7712,7 +7712,7 @@ class CfnGameServerGroupProps:
|
|
|
7712
7712
|
|
|
7713
7713
|
@builtins.property
|
|
7714
7714
|
def balancing_strategy(self) -> typing.Optional[builtins.str]:
|
|
7715
|
-
'''Indicates how Amazon GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group.
|
|
7715
|
+
'''Indicates how Amazon GameLift Servers FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group.
|
|
7716
7716
|
|
|
7717
7717
|
Method options include the following:
|
|
7718
7718
|
|
|
@@ -7760,7 +7760,7 @@ class CfnGameServerGroupProps:
|
|
|
7760
7760
|
You can specify the template using either the template name or ID. For help with creating a launch template, see `Creating a Launch Template for an Auto Scaling Group <https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html>`_ in the *Amazon Elastic Compute Cloud Auto Scaling User Guide* . After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs.
|
|
7761
7761
|
.. epigraph::
|
|
7762
7762
|
|
|
7763
|
-
If you specify network interfaces in your launch template, you must explicitly set the property ``AssociatePublicIpAddress`` to "true". If no network interface is specified in the launch template, Amazon GameLift FleetIQ uses your account's default VPC.
|
|
7763
|
+
If you specify network interfaces in your launch template, you must explicitly set the property ``AssociatePublicIpAddress`` to "true". If no network interface is specified in the launch template, Amazon GameLift Servers FleetIQ uses your account's default VPC.
|
|
7764
7764
|
|
|
7765
7765
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-launchtemplate
|
|
7766
7766
|
'''
|
|
@@ -7771,7 +7771,7 @@ class CfnGameServerGroupProps:
|
|
|
7771
7771
|
def max_size(self) -> typing.Optional[jsii.Number]:
|
|
7772
7772
|
'''The maximum number of instances allowed in the Amazon EC2 Auto Scaling group.
|
|
7773
7773
|
|
|
7774
|
-
During automatic scaling events, Amazon GameLift FleetIQ and EC2 do not scale up the group above this maximum. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs.
|
|
7774
|
+
During automatic scaling events, Amazon GameLift Servers FleetIQ and EC2 do not scale up the group above this maximum. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs.
|
|
7775
7775
|
|
|
7776
7776
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-maxsize
|
|
7777
7777
|
'''
|
|
@@ -7782,7 +7782,7 @@ class CfnGameServerGroupProps:
|
|
|
7782
7782
|
def min_size(self) -> typing.Optional[jsii.Number]:
|
|
7783
7783
|
'''The minimum number of instances allowed in the Amazon EC2 Auto Scaling group.
|
|
7784
7784
|
|
|
7785
|
-
During automatic scaling events, Amazon GameLift FleetIQ and Amazon EC2 do not scale down the group below this minimum. In production, this value should be set to at least 1. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs.
|
|
7785
|
+
During automatic scaling events, Amazon GameLift Servers FleetIQ and Amazon EC2 do not scale down the group below this minimum. In production, this value should be set to at least 1. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs.
|
|
7786
7786
|
|
|
7787
7787
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-minsize
|
|
7788
7788
|
'''
|
|
@@ -7804,7 +7804,7 @@ class CfnGameServerGroupProps:
|
|
|
7804
7804
|
def vpc_subnets(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
7805
7805
|
'''A list of virtual private cloud (VPC) subnets to use with instances in the game server group.
|
|
7806
7806
|
|
|
7807
|
-
By default, all Amazon GameLift FleetIQ-supported Availability Zones are used. You can use this parameter to specify VPCs that you've set up. This property cannot be updated after the game server group is created, and the corresponding Auto Scaling group will always use the property value that is set with this request, even if the Auto Scaling group is updated directly.
|
|
7807
|
+
By default, all Amazon GameLift Servers FleetIQ-supported Availability Zones are used. You can use this parameter to specify VPCs that you've set up. This property cannot be updated after the game server group is created, and the corresponding Auto Scaling group will always use the property value that is set with this request, even if the Auto Scaling group is updated directly.
|
|
7808
7808
|
|
|
7809
7809
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-vpcsubnets
|
|
7810
7810
|
'''
|
|
@@ -7894,7 +7894,7 @@ class CfnGameSessionQueue(
|
|
|
7894
7894
|
:param destinations: A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue. Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference.
|
|
7895
7895
|
:param filter_configuration: A list of locations where a queue is allowed to place new game sessions. Locations are specified in the form of AWS Region codes, such as ``us-west-2`` . If this parameter is not set, game sessions can be placed in any queue location.
|
|
7896
7896
|
:param notification_target: An SNS topic ARN that is set up to receive game session placement notifications. See `Setting up notifications for game session placement <https://docs.aws.amazon.com/gamelift/latest/developerguide/queue-notification.html>`_ .
|
|
7897
|
-
:param player_latency_policies: A set of policies that enforce a sliding cap on player latency when processing game sessions placement requests. Use multiple policies to gradually relax the cap over time if Amazon GameLift can't make a placement. Policies are evaluated in order starting with the lowest maximum latency value.
|
|
7897
|
+
:param player_latency_policies: A set of policies that enforce a sliding cap on player latency when processing game sessions placement requests. Use multiple policies to gradually relax the cap over time if Amazon GameLift Servers can't make a placement. Policies are evaluated in order starting with the lowest maximum latency value.
|
|
7898
7898
|
:param priority_configuration: Custom settings to use when prioritizing destinations and locations for game session placements. This configuration replaces the FleetIQ default prioritization process. Priority types that are not explicitly named will be automatically applied at the end of the prioritization process.
|
|
7899
7899
|
:param tags: A list of labels to assign to the new game session queue resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see `Tagging AWS Resources <https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html>`_ in the *AWS General Reference* . Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.
|
|
7900
7900
|
:param timeout_in_seconds: The maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a ``TIMED_OUT`` status.
|
|
@@ -8389,8 +8389,8 @@ class CfnGameSessionQueue(
|
|
|
8389
8389
|
|
|
8390
8390
|
Changing the priority order will affect how game sessions are placed.
|
|
8391
8391
|
|
|
8392
|
-
:param location_order: The prioritization order to use for fleet locations, when the ``PriorityOrder`` property includes ``LOCATION`` . Locations can include AWS Region codes (such as ``us-west-2`` ), local zones, and custom locations (for Anywhere fleets). Each location must be listed only once. For details, see `Amazon GameLift service locations. <https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-regions.html>`_
|
|
8393
|
-
:param priority_order: A custom sequence to use when prioritizing where to place new game sessions. Each priority type is listed once. - ``LATENCY`` -- Amazon GameLift prioritizes locations where the average player latency is lowest. Player latency data is provided in each game session placement request. - ``COST`` -- Amazon GameLift prioritizes destinations with the lowest current hosting costs. Cost is evaluated based on the location, instance type, and fleet type (Spot or On-Demand) of each destination in the queue. - ``DESTINATION`` -- Amazon GameLift prioritizes based on the list order of destinations in the queue configuration. - ``LOCATION`` -- Amazon GameLift prioritizes based on the provided order of locations, as defined in ``LocationOrder`` .
|
|
8392
|
+
:param location_order: The prioritization order to use for fleet locations, when the ``PriorityOrder`` property includes ``LOCATION`` . Locations can include AWS Region codes (such as ``us-west-2`` ), local zones, and custom locations (for Anywhere fleets). Each location must be listed only once. For details, see `Amazon GameLift Servers service locations. <https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-regions.html>`_
|
|
8393
|
+
:param priority_order: A custom sequence to use when prioritizing where to place new game sessions. Each priority type is listed once. - ``LATENCY`` -- Amazon GameLift Servers prioritizes locations where the average player latency is lowest. Player latency data is provided in each game session placement request. - ``COST`` -- Amazon GameLift Servers prioritizes destinations with the lowest current hosting costs. Cost is evaluated based on the location, instance type, and fleet type (Spot or On-Demand) of each destination in the queue. - ``DESTINATION`` -- Amazon GameLift Servers prioritizes based on the list order of destinations in the queue configuration. - ``LOCATION`` -- Amazon GameLift Servers prioritizes based on the provided order of locations, as defined in ``LocationOrder`` .
|
|
8394
8394
|
|
|
8395
8395
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gamesessionqueue-priorityconfiguration.html
|
|
8396
8396
|
:exampleMetadata: fixture=_generated
|
|
@@ -8420,7 +8420,7 @@ class CfnGameSessionQueue(
|
|
|
8420
8420
|
def location_order(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
8421
8421
|
'''The prioritization order to use for fleet locations, when the ``PriorityOrder`` property includes ``LOCATION`` .
|
|
8422
8422
|
|
|
8423
|
-
Locations can include AWS Region codes (such as ``us-west-2`` ), local zones, and custom locations (for Anywhere fleets). Each location must be listed only once. For details, see `Amazon GameLift service locations. <https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-regions.html>`_
|
|
8423
|
+
Locations can include AWS Region codes (such as ``us-west-2`` ), local zones, and custom locations (for Anywhere fleets). Each location must be listed only once. For details, see `Amazon GameLift Servers service locations. <https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-regions.html>`_
|
|
8424
8424
|
|
|
8425
8425
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gamesessionqueue-priorityconfiguration.html#cfn-gamelift-gamesessionqueue-priorityconfiguration-locationorder
|
|
8426
8426
|
'''
|
|
@@ -8431,10 +8431,10 @@ class CfnGameSessionQueue(
|
|
|
8431
8431
|
def priority_order(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
8432
8432
|
'''A custom sequence to use when prioritizing where to place new game sessions. Each priority type is listed once.
|
|
8433
8433
|
|
|
8434
|
-
- ``LATENCY`` -- Amazon GameLift prioritizes locations where the average player latency is lowest. Player latency data is provided in each game session placement request.
|
|
8435
|
-
- ``COST`` -- Amazon GameLift prioritizes destinations with the lowest current hosting costs. Cost is evaluated based on the location, instance type, and fleet type (Spot or On-Demand) of each destination in the queue.
|
|
8436
|
-
- ``DESTINATION`` -- Amazon GameLift prioritizes based on the list order of destinations in the queue configuration.
|
|
8437
|
-
- ``LOCATION`` -- Amazon GameLift prioritizes based on the provided order of locations, as defined in ``LocationOrder`` .
|
|
8434
|
+
- ``LATENCY`` -- Amazon GameLift Servers prioritizes locations where the average player latency is lowest. Player latency data is provided in each game session placement request.
|
|
8435
|
+
- ``COST`` -- Amazon GameLift Servers prioritizes destinations with the lowest current hosting costs. Cost is evaluated based on the location, instance type, and fleet type (Spot or On-Demand) of each destination in the queue.
|
|
8436
|
+
- ``DESTINATION`` -- Amazon GameLift Servers prioritizes based on the list order of destinations in the queue configuration.
|
|
8437
|
+
- ``LOCATION`` -- Amazon GameLift Servers prioritizes based on the provided order of locations, as defined in ``LocationOrder`` .
|
|
8438
8438
|
|
|
8439
8439
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gamesessionqueue-priorityconfiguration.html#cfn-gamelift-gamesessionqueue-priorityconfiguration-priorityorder
|
|
8440
8440
|
'''
|
|
@@ -8489,7 +8489,7 @@ class CfnGameSessionQueueProps:
|
|
|
8489
8489
|
:param destinations: A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue. Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference.
|
|
8490
8490
|
:param filter_configuration: A list of locations where a queue is allowed to place new game sessions. Locations are specified in the form of AWS Region codes, such as ``us-west-2`` . If this parameter is not set, game sessions can be placed in any queue location.
|
|
8491
8491
|
:param notification_target: An SNS topic ARN that is set up to receive game session placement notifications. See `Setting up notifications for game session placement <https://docs.aws.amazon.com/gamelift/latest/developerguide/queue-notification.html>`_ .
|
|
8492
|
-
:param player_latency_policies: A set of policies that enforce a sliding cap on player latency when processing game sessions placement requests. Use multiple policies to gradually relax the cap over time if Amazon GameLift can't make a placement. Policies are evaluated in order starting with the lowest maximum latency value.
|
|
8492
|
+
:param player_latency_policies: A set of policies that enforce a sliding cap on player latency when processing game sessions placement requests. Use multiple policies to gradually relax the cap over time if Amazon GameLift Servers can't make a placement. Policies are evaluated in order starting with the lowest maximum latency value.
|
|
8493
8493
|
:param priority_configuration: Custom settings to use when prioritizing destinations and locations for game session placements. This configuration replaces the FleetIQ default prioritization process. Priority types that are not explicitly named will be automatically applied at the end of the prioritization process.
|
|
8494
8494
|
:param tags: A list of labels to assign to the new game session queue resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see `Tagging AWS Resources <https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html>`_ in the *AWS General Reference* . Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.
|
|
8495
8495
|
:param timeout_in_seconds: The maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a ``TIMED_OUT`` status.
|
|
@@ -8625,7 +8625,7 @@ class CfnGameSessionQueueProps:
|
|
|
8625
8625
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, CfnGameSessionQueue.PlayerLatencyPolicyProperty]]]]:
|
|
8626
8626
|
'''A set of policies that enforce a sliding cap on player latency when processing game sessions placement requests.
|
|
8627
8627
|
|
|
8628
|
-
Use multiple policies to gradually relax the cap over time if Amazon GameLift can't make a placement. Policies are evaluated in order starting with the lowest maximum latency value.
|
|
8628
|
+
Use multiple policies to gradually relax the cap over time if Amazon GameLift Servers can't make a placement. Policies are evaluated in order starting with the lowest maximum latency value.
|
|
8629
8629
|
|
|
8630
8630
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gamesessionqueue.html#cfn-gamelift-gamesessionqueue-playerlatencypolicies
|
|
8631
8631
|
'''
|
|
@@ -8973,10 +8973,10 @@ class CfnMatchmakingConfiguration(
|
|
|
8973
8973
|
:param creation_time: A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example ``"1469498468.057"`` ).
|
|
8974
8974
|
:param custom_event_data: Information to add to all events related to the matchmaking configuration.
|
|
8975
8975
|
:param description: A description for the matchmaking configuration.
|
|
8976
|
-
:param flex_match_mode: Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution. - *STANDALONE* - FlexMatch forms matches and returns match information, including players and team assignments, in a `MatchmakingSucceeded <https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html#match-events-matchmakingsucceeded>`_ event. - *WITH_QUEUE* - FlexMatch forms matches and uses the specified Amazon GameLift queue to start a game session for the match.
|
|
8976
|
+
:param flex_match_mode: Indicates whether this matchmaking configuration is being used with Amazon GameLift Servers hosting or as a standalone matchmaking solution. - *STANDALONE* - FlexMatch forms matches and returns match information, including players and team assignments, in a `MatchmakingSucceeded <https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html#match-events-matchmakingsucceeded>`_ event. - *WITH_QUEUE* - FlexMatch forms matches and uses the specified Amazon GameLift Servers queue to start a game session for the match.
|
|
8977
8977
|
:param game_properties: A set of custom properties for a game session, formatted as key-value pairs. These properties are passed to a game server process with a request to start a new game session. See `Start a Game Session <https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession>`_ . This parameter is not used if ``FlexMatchMode`` is set to ``STANDALONE`` .
|
|
8978
8978
|
:param game_session_data: A set of custom game session properties, formatted as a single string value. This data is passed to a game server process with a request to start a new game session. See `Start a Game Session <https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession>`_ . This parameter is not used if ``FlexMatchMode`` is set to ``STANDALONE`` .
|
|
8979
|
-
:param game_session_queue_arns: The Amazon Resource Name ( `ARN <https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html>`_ ) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is ``arn:aws:gamelift:<region>::gamesessionqueue/<queue name>`` . Queues can be located in any Region. Queues are used to start new Amazon GameLift-hosted game sessions for matches that are created with this matchmaking configuration. If ``FlexMatchMode`` is set to ``STANDALONE`` , do not set this parameter.
|
|
8979
|
+
:param game_session_queue_arns: The Amazon Resource Name ( `ARN <https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html>`_ ) that is assigned to a Amazon GameLift Servers game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is ``arn:aws:gamelift:<region>::gamesessionqueue/<queue name>`` . Queues can be located in any Region. Queues are used to start new Amazon GameLift Servers-hosted game sessions for matches that are created with this matchmaking configuration. If ``FlexMatchMode`` is set to ``STANDALONE`` , do not set this parameter.
|
|
8980
8980
|
:param notification_target: An SNS topic ARN that is set up to receive matchmaking notifications. See `Setting up notifications for matchmaking <https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html>`_ for more information.
|
|
8981
8981
|
:param rule_set_arn: The Amazon Resource Name ( `ARN <https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html>`_ ) associated with the GameLift matchmaking rule set resource that this configuration uses.
|
|
8982
8982
|
:param tags: A list of labels to assign to the new matchmaking configuration resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see `Tagging AWS Resources <https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html>`_ in the *AWS General Reference* . Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.
|
|
@@ -9202,7 +9202,7 @@ class CfnMatchmakingConfiguration(
|
|
|
9202
9202
|
@builtins.property
|
|
9203
9203
|
@jsii.member(jsii_name="flexMatchMode")
|
|
9204
9204
|
def flex_match_mode(self) -> typing.Optional[builtins.str]:
|
|
9205
|
-
'''Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution.'''
|
|
9205
|
+
'''Indicates whether this matchmaking configuration is being used with Amazon GameLift Servers hosting or as a standalone matchmaking solution.'''
|
|
9206
9206
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "flexMatchMode"))
|
|
9207
9207
|
|
|
9208
9208
|
@flex_match_mode.setter
|
|
@@ -9246,7 +9246,7 @@ class CfnMatchmakingConfiguration(
|
|
|
9246
9246
|
@builtins.property
|
|
9247
9247
|
@jsii.member(jsii_name="gameSessionQueueArns")
|
|
9248
9248
|
def game_session_queue_arns(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
9249
|
-
'''The Amazon Resource Name ( `ARN <https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html>`_ ) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is ``arn:aws:gamelift:<region>::gamesessionqueue/<queue name>`` . Queues can be located in any Region. Queues are used to start new Amazon GameLift-hosted game sessions for matches that are created with this matchmaking configuration. If ``FlexMatchMode`` is set to ``STANDALONE`` , do not set this parameter.'''
|
|
9249
|
+
'''The Amazon Resource Name ( `ARN <https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html>`_ ) that is assigned to a Amazon GameLift Servers game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is ``arn:aws:gamelift:<region>::gamesessionqueue/<queue name>`` . Queues can be located in any Region. Queues are used to start new Amazon GameLift Servers-hosted game sessions for matches that are created with this matchmaking configuration. If ``FlexMatchMode`` is set to ``STANDALONE`` , do not set this parameter.'''
|
|
9250
9250
|
return typing.cast(typing.Optional[typing.List[builtins.str]], jsii.get(self, "gameSessionQueueArns"))
|
|
9251
9251
|
|
|
9252
9252
|
@game_session_queue_arns.setter
|
|
@@ -9428,10 +9428,10 @@ class CfnMatchmakingConfigurationProps:
|
|
|
9428
9428
|
:param creation_time: A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example ``"1469498468.057"`` ).
|
|
9429
9429
|
:param custom_event_data: Information to add to all events related to the matchmaking configuration.
|
|
9430
9430
|
:param description: A description for the matchmaking configuration.
|
|
9431
|
-
:param flex_match_mode: Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution. - *STANDALONE* - FlexMatch forms matches and returns match information, including players and team assignments, in a `MatchmakingSucceeded <https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html#match-events-matchmakingsucceeded>`_ event. - *WITH_QUEUE* - FlexMatch forms matches and uses the specified Amazon GameLift queue to start a game session for the match.
|
|
9431
|
+
:param flex_match_mode: Indicates whether this matchmaking configuration is being used with Amazon GameLift Servers hosting or as a standalone matchmaking solution. - *STANDALONE* - FlexMatch forms matches and returns match information, including players and team assignments, in a `MatchmakingSucceeded <https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html#match-events-matchmakingsucceeded>`_ event. - *WITH_QUEUE* - FlexMatch forms matches and uses the specified Amazon GameLift Servers queue to start a game session for the match.
|
|
9432
9432
|
:param game_properties: A set of custom properties for a game session, formatted as key-value pairs. These properties are passed to a game server process with a request to start a new game session. See `Start a Game Session <https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession>`_ . This parameter is not used if ``FlexMatchMode`` is set to ``STANDALONE`` .
|
|
9433
9433
|
:param game_session_data: A set of custom game session properties, formatted as a single string value. This data is passed to a game server process with a request to start a new game session. See `Start a Game Session <https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession>`_ . This parameter is not used if ``FlexMatchMode`` is set to ``STANDALONE`` .
|
|
9434
|
-
:param game_session_queue_arns: The Amazon Resource Name ( `ARN <https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html>`_ ) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is ``arn:aws:gamelift:<region>::gamesessionqueue/<queue name>`` . Queues can be located in any Region. Queues are used to start new Amazon GameLift-hosted game sessions for matches that are created with this matchmaking configuration. If ``FlexMatchMode`` is set to ``STANDALONE`` , do not set this parameter.
|
|
9434
|
+
:param game_session_queue_arns: The Amazon Resource Name ( `ARN <https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html>`_ ) that is assigned to a Amazon GameLift Servers game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is ``arn:aws:gamelift:<region>::gamesessionqueue/<queue name>`` . Queues can be located in any Region. Queues are used to start new Amazon GameLift Servers-hosted game sessions for matches that are created with this matchmaking configuration. If ``FlexMatchMode`` is set to ``STANDALONE`` , do not set this parameter.
|
|
9435
9435
|
:param notification_target: An SNS topic ARN that is set up to receive matchmaking notifications. See `Setting up notifications for matchmaking <https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html>`_ for more information.
|
|
9436
9436
|
:param rule_set_arn: The Amazon Resource Name ( `ARN <https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html>`_ ) associated with the GameLift matchmaking rule set resource that this configuration uses.
|
|
9437
9437
|
:param tags: A list of labels to assign to the new matchmaking configuration resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see `Tagging AWS Resources <https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html>`_ in the *AWS General Reference* . Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.
|
|
@@ -9635,10 +9635,10 @@ class CfnMatchmakingConfigurationProps:
|
|
|
9635
9635
|
|
|
9636
9636
|
@builtins.property
|
|
9637
9637
|
def flex_match_mode(self) -> typing.Optional[builtins.str]:
|
|
9638
|
-
'''Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution.
|
|
9638
|
+
'''Indicates whether this matchmaking configuration is being used with Amazon GameLift Servers hosting or as a standalone matchmaking solution.
|
|
9639
9639
|
|
|
9640
9640
|
- *STANDALONE* - FlexMatch forms matches and returns match information, including players and team assignments, in a `MatchmakingSucceeded <https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html#match-events-matchmakingsucceeded>`_ event.
|
|
9641
|
-
- *WITH_QUEUE* - FlexMatch forms matches and uses the specified Amazon GameLift queue to start a game session for the match.
|
|
9641
|
+
- *WITH_QUEUE* - FlexMatch forms matches and uses the specified Amazon GameLift Servers queue to start a game session for the match.
|
|
9642
9642
|
|
|
9643
9643
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-flexmatchmode
|
|
9644
9644
|
'''
|
|
@@ -9671,7 +9671,7 @@ class CfnMatchmakingConfigurationProps:
|
|
|
9671
9671
|
|
|
9672
9672
|
@builtins.property
|
|
9673
9673
|
def game_session_queue_arns(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
9674
|
-
'''The Amazon Resource Name ( `ARN <https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html>`_ ) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is ``arn:aws:gamelift:<region>::gamesessionqueue/<queue name>`` . Queues can be located in any Region. Queues are used to start new Amazon GameLift-hosted game sessions for matches that are created with this matchmaking configuration. If ``FlexMatchMode`` is set to ``STANDALONE`` , do not set this parameter.
|
|
9674
|
+
'''The Amazon Resource Name ( `ARN <https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html>`_ ) that is assigned to a Amazon GameLift Servers game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is ``arn:aws:gamelift:<region>::gamesessionqueue/<queue name>`` . Queues can be located in any Region. Queues are used to start new Amazon GameLift Servers-hosted game sessions for matches that are created with this matchmaking configuration. If ``FlexMatchMode`` is set to ``STANDALONE`` , do not set this parameter.
|
|
9675
9675
|
|
|
9676
9676
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-gamesessionqueuearns
|
|
9677
9677
|
'''
|
|
@@ -10050,7 +10050,7 @@ class CfnScript(
|
|
|
10050
10050
|
'''
|
|
10051
10051
|
:param scope: Scope in which this resource is defined.
|
|
10052
10052
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
10053
|
-
:param storage_location: The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the "key"), and a role ARN that allows Amazon GameLift to access the Amazon S3 storage location. The S3 bucket must be in the same Region where you want to create a new script. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the ``ObjectVersion`` parameter to specify an earlier version.
|
|
10053
|
+
:param storage_location: The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the "key"), and a role ARN that allows Amazon GameLift Servers to access the Amazon S3 storage location. The S3 bucket must be in the same Region where you want to create a new script. By default, Amazon GameLift Servers uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the ``ObjectVersion`` parameter to specify an earlier version.
|
|
10054
10054
|
:param name: A descriptive label that is associated with a script. Script names do not need to be unique.
|
|
10055
10055
|
:param tags: A list of labels to assign to the new script resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see `Tagging AWS Resources <https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html>`_ in the *AWS General Reference* . Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.
|
|
10056
10056
|
:param version: The version that is associated with a build or script. Version strings do not need to be unique.
|
|
@@ -10224,10 +10224,10 @@ class CfnScript(
|
|
|
10224
10224
|
) -> None:
|
|
10225
10225
|
'''The location in Amazon S3 where build or script files can be stored for access by Amazon GameLift.
|
|
10226
10226
|
|
|
10227
|
-
:param bucket: An Amazon S3 bucket identifier. Thename of the S3 bucket. .. epigraph:: Amazon GameLift doesn't support uploading from Amazon S3 buckets with names that contain a dot (.).
|
|
10227
|
+
:param bucket: An Amazon S3 bucket identifier. Thename of the S3 bucket. .. epigraph:: Amazon GameLift Servers doesn't support uploading from Amazon S3 buckets with names that contain a dot (.).
|
|
10228
10228
|
:param key: The name of the zip file that contains the build files or script files.
|
|
10229
|
-
:param role_arn: The Amazon Resource Name ( `ARN <https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html>`_ ) for an IAM role that allows Amazon GameLift to access the S3 bucket.
|
|
10230
|
-
:param object_version: The version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses this information when retrieving files from an S3 bucket that you own. Use this parameter to specify a specific version of the file. If not set, the latest version of the file is retrieved.
|
|
10229
|
+
:param role_arn: The Amazon Resource Name ( `ARN <https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html>`_ ) for an IAM role that allows Amazon GameLift Servers to access the S3 bucket.
|
|
10230
|
+
:param object_version: The version of the file, if object versioning is turned on for the bucket. Amazon GameLift Servers uses this information when retrieving files from an S3 bucket that you own. Use this parameter to specify a specific version of the file. If not set, the latest version of the file is retrieved.
|
|
10231
10231
|
|
|
10232
10232
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-script-s3location.html
|
|
10233
10233
|
:exampleMetadata: fixture=_generated
|
|
@@ -10267,7 +10267,7 @@ class CfnScript(
|
|
|
10267
10267
|
|
|
10268
10268
|
.. epigraph::
|
|
10269
10269
|
|
|
10270
|
-
Amazon GameLift doesn't support uploading from Amazon S3 buckets with names that contain a dot (.).
|
|
10270
|
+
Amazon GameLift Servers doesn't support uploading from Amazon S3 buckets with names that contain a dot (.).
|
|
10271
10271
|
|
|
10272
10272
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-script-s3location.html#cfn-gamelift-script-s3location-bucket
|
|
10273
10273
|
'''
|
|
@@ -10287,7 +10287,7 @@ class CfnScript(
|
|
|
10287
10287
|
|
|
10288
10288
|
@builtins.property
|
|
10289
10289
|
def role_arn(self) -> builtins.str:
|
|
10290
|
-
'''The Amazon Resource Name ( `ARN <https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html>`_ ) for an IAM role that allows Amazon GameLift to access the S3 bucket.
|
|
10290
|
+
'''The Amazon Resource Name ( `ARN <https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html>`_ ) for an IAM role that allows Amazon GameLift Servers to access the S3 bucket.
|
|
10291
10291
|
|
|
10292
10292
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-script-s3location.html#cfn-gamelift-script-s3location-rolearn
|
|
10293
10293
|
'''
|
|
@@ -10299,7 +10299,7 @@ class CfnScript(
|
|
|
10299
10299
|
def object_version(self) -> typing.Optional[builtins.str]:
|
|
10300
10300
|
'''The version of the file, if object versioning is turned on for the bucket.
|
|
10301
10301
|
|
|
10302
|
-
Amazon GameLift uses this information when retrieving files from an S3 bucket that you own. Use this parameter to specify a specific version of the file. If not set, the latest version of the file is retrieved.
|
|
10302
|
+
Amazon GameLift Servers uses this information when retrieving files from an S3 bucket that you own. Use this parameter to specify a specific version of the file. If not set, the latest version of the file is retrieved.
|
|
10303
10303
|
|
|
10304
10304
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-script-s3location.html#cfn-gamelift-script-s3location-objectversion
|
|
10305
10305
|
'''
|
|
@@ -10339,7 +10339,7 @@ class CfnScriptProps:
|
|
|
10339
10339
|
) -> None:
|
|
10340
10340
|
'''Properties for defining a ``CfnScript``.
|
|
10341
10341
|
|
|
10342
|
-
:param storage_location: The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the "key"), and a role ARN that allows Amazon GameLift to access the Amazon S3 storage location. The S3 bucket must be in the same Region where you want to create a new script. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the ``ObjectVersion`` parameter to specify an earlier version.
|
|
10342
|
+
:param storage_location: The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the "key"), and a role ARN that allows Amazon GameLift Servers to access the Amazon S3 storage location. The S3 bucket must be in the same Region where you want to create a new script. By default, Amazon GameLift Servers uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the ``ObjectVersion`` parameter to specify an earlier version.
|
|
10343
10343
|
:param name: A descriptive label that is associated with a script. Script names do not need to be unique.
|
|
10344
10344
|
:param tags: A list of labels to assign to the new script resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see `Tagging AWS Resources <https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html>`_ in the *AWS General Reference* . Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.
|
|
10345
10345
|
:param version: The version that is associated with a build or script. Version strings do not need to be unique.
|
|
@@ -10394,7 +10394,7 @@ class CfnScriptProps:
|
|
|
10394
10394
|
) -> typing.Union[_IResolvable_da3f097b, CfnScript.S3LocationProperty]:
|
|
10395
10395
|
'''The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored.
|
|
10396
10396
|
|
|
10397
|
-
The storage location must specify the Amazon S3 bucket name, the zip file name (the "key"), and a role ARN that allows Amazon GameLift to access the Amazon S3 storage location. The S3 bucket must be in the same Region where you want to create a new script. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the ``ObjectVersion`` parameter to specify an earlier version.
|
|
10397
|
+
The storage location must specify the Amazon S3 bucket name, the zip file name (the "key"), and a role ARN that allows Amazon GameLift Servers to access the Amazon S3 storage location. The S3 bucket must be in the same Region where you want to create a new script. By default, Amazon GameLift Servers uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the ``ObjectVersion`` parameter to specify an earlier version.
|
|
10398
10398
|
|
|
10399
10399
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-script.html#cfn-gamelift-script-storagelocation
|
|
10400
10400
|
'''
|