# Amazon GameLift Construct Library

This module is part of the [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) project.

```ts
import * as gamelift from 'aws-cdk-lib/aws-gamelift';
```

There are no official hand-written ([L2](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_lib)) constructs for this service yet. Here are some suggestions on how to proceed:

- Search [Construct Hub for GameLift construct libraries](https://constructs.dev/search?q=gamelift)
- Use the automatically generated [L1](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_l1_using) constructs, in the same way you would use [the CloudFormation AWS::GameLift resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_GameLift.html) directly.

> An experimental construct library for this service is available in preview. Since it is not stable yet, it is distributed
> as a separate package so that you can pin its version independently of the rest of the CDK. See the package:
>
> <span class="package-reference">@aws-cdk/aws-gamelift-alpha</span>

There are no hand-written ([L2](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_lib)) constructs for this service yet.
However, you can still use the automatically generated [L1](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_l1_using) constructs, and use this service exactly as you would using CloudFormation directly.

For more information on the resources and properties available for this service, see the [CloudFormation documentation for AWS::GameLift](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_GameLift.html).

(Read the [CDK Contributing Guide](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and submit an RFC if you are interested in contributing to this construct library.)

## Types

| Name | Kind | Summary |
| --- | --- | --- |
| [`CfnAlias`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnAlias) | Construct (L1) | The `AWS::GameLift::Alias` resource creates an alias for an Amazon GameLift (GameLift) fleet destination. |
| [`CfnBuild`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnBuild) | Construct (L1) | The `AWS::GameLift::Build` resource creates a game server build that is installed and run on instances in an Amazon GameLift fleet. |
| [`CfnContainerFleet`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnContainerFleet) | Construct (L1) | Describes an Amazon GameLift Servers managed container fleet. |
| [`CfnContainerGroupDefinition`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnContainerGroupDefinition) | Construct (L1) | The properties that describe a container group resource. |
| [`CfnFleet`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnFleet) | Construct (L1) | The `AWS::GameLift::Fleet` resource creates an Amazon GameLift (GameLift) fleet to host custom game server or Realtime Servers. |
| [`CfnGameServerGroup`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnGameServerGroup) | Construct (L1) | *This operation is used with the Amazon GameLift FleetIQ solution and game server groups.*. |
| [`CfnGameSessionQueue`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnGameSessionQueue) | Construct (L1) | The `AWS::GameLift::GameSessionQueue` resource creates a placement queue that processes requests for new game sessions. |
| [`CfnLocation`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnLocation) | Construct (L1) | The AWS::GameLift::Location resource creates a custom location for use in an Anywhere fleet. |
| [`CfnMatchmakingConfiguration`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnMatchmakingConfiguration) | Construct (L1) | The `AWS::GameLift::MatchmakingConfiguration` resource defines a new matchmaking configuration for use with FlexMatch. |
| [`CfnMatchmakingRuleSet`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnMatchmakingRuleSet) | Construct (L1) | Creates a new rule set for FlexMatch matchmaking. |
| [`CfnScript`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnScript) | Construct (L1) | The `AWS::GameLift::Script` resource creates a new script record for your Realtime Servers script. |
| [`CfnAlias.RoutingStrategyProperty`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnAlias.RoutingStrategyProperty) | Struct | The routing configuration for a fleet alias. |
| [`CfnAliasProps`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnAliasProps) | Struct | Properties for defining a `CfnAlias`. |
| [`CfnBuild.StorageLocationProperty`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnBuild.StorageLocationProperty) | Struct | The location in Amazon S3 where build or script files are stored for access by Amazon GameLift. |
| [`CfnBuildProps`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnBuildProps) | Struct | Properties for defining a `CfnBuild`. |
| [`CfnContainerFleet.ConnectionPortRangeProperty`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnContainerFleet.ConnectionPortRangeProperty) | Struct | The set of port numbers to open on each instance in a container fleet. |
| [`CfnContainerFleet.DeploymentConfigurationProperty`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnContainerFleet.DeploymentConfigurationProperty) | Struct | Set of rules for processing a deployment for a container fleet update. |
| [`CfnContainerFleet.DeploymentDetailsProperty`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnContainerFleet.DeploymentDetailsProperty) | Struct | Information about the most recent deployment for the container fleet. |
| [`CfnContainerFleet.GameSessionCreationLimitPolicyProperty`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnContainerFleet.GameSessionCreationLimitPolicyProperty) | Struct | A policy that puts limits on the number of game sessions that a player can create within a specified span of time. |
| [`CfnContainerFleet.IpPermissionProperty`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnContainerFleet.IpPermissionProperty) | Struct | A range of IP addresses and port settings that allow inbound traffic to connect to processes on an instance in a fleet. |
| [`CfnContainerFleet.LocationCapacityProperty`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnContainerFleet.LocationCapacityProperty) | Struct | Current resource capacity settings in a specified fleet or location. |
| [`CfnContainerFleet.LocationConfigurationProperty`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnContainerFleet.LocationConfigurationProperty) | Struct | A remote location where a multi-location fleet can deploy game servers for game hosting. |
| [`CfnContainerFleet.LogConfigurationProperty`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnContainerFleet.LogConfigurationProperty) | Struct | A method for collecting container logs for the fleet. |
| [`CfnContainerFleet.ManagedCapacityConfigurationProperty`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnContainerFleet.ManagedCapacityConfigurationProperty) | Struct | Configuration options for Amazon GameLift Servers managed capacity behavior. |
| [`CfnContainerFleet.ScalingPolicyProperty`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnContainerFleet.ScalingPolicyProperty) | Struct | Rule that controls how a fleet is scaled. |
| [`CfnContainerFleet.TargetConfigurationProperty`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnContainerFleet.TargetConfigurationProperty) | Struct | Settings for a target-based scaling policy. |
| [`CfnContainerFleetProps`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnContainerFleetProps) | Struct | Properties for defining a `CfnContainerFleet`. |
| [`CfnContainerGroupDefinition.ContainerDependencyProperty`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnContainerGroupDefinition.ContainerDependencyProperty) | Struct | A container's dependency on another container in the same container group. |
| [`CfnContainerGroupDefinition.ContainerEnvironmentProperty`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnContainerGroupDefinition.ContainerEnvironmentProperty) | Struct | An environment variable to set inside a container, in the form of a key-value pair. |
| [`CfnContainerGroupDefinition.ContainerHealthCheckProperty`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnContainerGroupDefinition.ContainerHealthCheckProperty) | Struct | Instructions on when and how to check the health of a support container in a container fleet. |
| [`CfnContainerGroupDefinition.ContainerMountPointProperty`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnContainerGroupDefinition.ContainerMountPointProperty) | Struct | A mount point that binds a container to a file or directory on the host system. |
| [`CfnContainerGroupDefinition.ContainerPortRangeProperty`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnContainerGroupDefinition.ContainerPortRangeProperty) | Struct | A set of one or more port numbers that can be opened on the container, and the supported network protocol. |
| [`CfnContainerGroupDefinition.GameServerContainerDefinitionProperty`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnContainerGroupDefinition.GameServerContainerDefinitionProperty) | Struct | Describes the game server container in an existing game server container group. |
| [`CfnContainerGroupDefinition.LinuxCapabilitiesProperty`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnContainerGroupDefinition.LinuxCapabilitiesProperty) | Struct | A set of Linux capabilities that are added to a container's default Docker configuration. |
| [`CfnContainerGroupDefinition.PortConfigurationProperty`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnContainerGroupDefinition.PortConfigurationProperty) | Struct | Defines the ports on a container. |
| [`CfnContainerGroupDefinition.SupportContainerDefinitionProperty`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnContainerGroupDefinition.SupportContainerDefinitionProperty) | Struct | Describes a support container in a container group. |
| [`CfnContainerGroupDefinitionProps`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnContainerGroupDefinitionProps) | Struct | Properties for defining a `CfnContainerGroupDefinition`. |
| [`CfnFleet.AnywhereConfigurationProperty`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnFleet.AnywhereConfigurationProperty) | Struct | Amazon GameLift Servers configuration options for your Anywhere fleets. |
| [`CfnFleet.CertificateConfigurationProperty`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnFleet.CertificateConfigurationProperty) | Struct | Determines whether a TLS/SSL certificate is generated for a fleet. |
| [`CfnFleet.IpPermissionProperty`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnFleet.IpPermissionProperty) | Struct | A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an instance in a fleet. |
| [`CfnFleet.LocationCapacityProperty`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnFleet.LocationCapacityProperty) | Struct | Current resource capacity settings for managed EC2 fleets and managed container fleets. |
| [`CfnFleet.LocationConfigurationProperty`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnFleet.LocationConfigurationProperty) | Struct | A remote location where a multi-location fleet can deploy game servers for game hosting. |
| [`CfnFleet.ManagedCapacityConfigurationProperty`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnFleet.ManagedCapacityConfigurationProperty) | Struct | Configuration options for Amazon GameLift Servers-managed capacity behavior. |
| [`CfnFleet.PlayerGatewayConfigurationProperty`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnFleet.PlayerGatewayConfigurationProperty) | Struct | Configuration for player gateway. |
| [`CfnFleet.ResourceCreationLimitPolicyProperty`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnFleet.ResourceCreationLimitPolicyProperty) | Struct | A policy that limits the number of game sessions a player can create on the same fleet. |
| [`CfnFleet.RuntimeConfigurationProperty`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnFleet.RuntimeConfigurationProperty) | Struct | A collection of server process configurations that describe the set of processes to run on each instance in a fleet. |
| [`CfnFleet.ScalingPolicyProperty`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnFleet.ScalingPolicyProperty) | Struct | Rule that controls how a fleet is scaled. |
| [`CfnFleet.ServerProcessProperty`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnFleet.ServerProcessProperty) | Struct | A set of instructions for launching server processes on each instance in a fleet. |
| [`CfnFleet.TargetConfigurationProperty`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnFleet.TargetConfigurationProperty) | Struct | Settings for a target-based scaling policy. |
| [`CfnFleetProps`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnFleetProps) | Struct | Properties for defining a `CfnFleet`. |
| [`CfnGameServerGroup.AutoScalingPolicyProperty`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnGameServerGroup.AutoScalingPolicyProperty) | Struct | *This data type is used with the GameLift FleetIQ and game server groups.*. |
| [`CfnGameServerGroup.InstanceDefinitionProperty`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnGameServerGroup.InstanceDefinitionProperty) | Struct | *This data type is used with the Amazon GameLift FleetIQ and game server groups.*. |
| [`CfnGameServerGroup.LaunchTemplateProperty`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnGameServerGroup.LaunchTemplateProperty) | Struct | *This data type is used with the GameLift FleetIQ and game server groups.*. |
| [`CfnGameServerGroup.TargetTrackingConfigurationProperty`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnGameServerGroup.TargetTrackingConfigurationProperty) | Struct | *This data type is used with the Amazon GameLift FleetIQ and game server groups.*. |
| [`CfnGameServerGroupProps`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnGameServerGroupProps) | Struct | Properties for defining a `CfnGameServerGroup`. |
| [`CfnGameSessionQueue.DestinationProperty`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnGameSessionQueue.DestinationProperty) | Struct |  |
| [`CfnGameSessionQueue.FilterConfigurationProperty`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnGameSessionQueue.FilterConfigurationProperty) | Struct | A list of fleet locations where a game session queue can place new game sessions. |
| [`CfnGameSessionQueue.GameSessionQueueDestinationProperty`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnGameSessionQueue.GameSessionQueueDestinationProperty) | Struct | A fleet or alias designated in a game session queue. |
| [`CfnGameSessionQueue.PlayerLatencyPolicyProperty`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnGameSessionQueue.PlayerLatencyPolicyProperty) | Struct | The queue setting that determines the highest latency allowed for individual players when placing a game session. |
| [`CfnGameSessionQueue.PriorityConfigurationProperty`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnGameSessionQueue.PriorityConfigurationProperty) | Struct | Custom prioritization settings for use by a game session queue when placing new game sessions with available game servers. |
| [`CfnGameSessionQueueProps`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnGameSessionQueueProps) | Struct | Properties for defining a `CfnGameSessionQueue`. |
| [`CfnLocationProps`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnLocationProps) | Struct | Properties for defining a `CfnLocation`. |
| [`CfnMatchmakingConfiguration.GamePropertyProperty`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnMatchmakingConfiguration.GamePropertyProperty) | Struct | This key-value pair can store custom data about a game session. |
| [`CfnMatchmakingConfigurationProps`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnMatchmakingConfigurationProps) | Struct | Properties for defining a `CfnMatchmakingConfiguration`. |
| [`CfnMatchmakingRuleSetProps`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnMatchmakingRuleSetProps) | Struct | Properties for defining a `CfnMatchmakingRuleSet`. |
| [`CfnScript.S3LocationProperty`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnScript.S3LocationProperty) | Struct | The location in Amazon S3 where build or script files can be stored for access by Amazon GameLift. |
| [`CfnScriptProps`](/v2/docs/aws-cdk-lib.aws_gamelift.CfnScriptProps) | Struct | Properties for defining a `CfnScript`. |