@propulsionworks/cloudformation 0.0.2 → 0.1.0

package/out/exports/resources.generated/aws-gamelift-fleet.d.ts

@@ -0,0 +1,430 @@
+import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+export type GameLiftFleet = ResourceDefinitionWithAttributes<"AWS::GameLift::Fleet", GameLiftFleetProps, GameLiftFleetAttribs>;
+/**
+ * The `AWS::GameLift::Fleet` resource creates an Amazon GameLift (GameLift) fleet to host custom game server or Realtime Servers. A fleet is a set of EC2 instances, configured with instructions to run game servers on each instance.
+ */
+export type GameLiftFleetProps = {
+    /**
+     * Amazon GameLift Servers Anywhere configuration options.
+     */
+    AnywhereConfiguration?: AnywhereConfiguration | undefined;
+    /**
+     * 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)
+     */
+    ApplyCapacity?: "ON_UPDATE" | "ON_CREATE_AND_UPDATE" | undefined;
+    /**
+     * 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.
+     * @pattern ^build-\S+|^arn:.*:build/build-\S+
+     */
+    BuildId?: string | undefined;
+    /**
+     * 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.
+     *
+     * > 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* .
+     */
+    CertificateConfiguration?: CertificateConfiguration | undefined;
+    /**
+     * 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.
+     */
+    ComputeType?: "EC2" | "ANYWHERE" | undefined;
+    /**
+     * A description for the fleet.
+     * @minLength 1
+     * @maxLength 1024
+     */
+    Description?: string | undefined;
+    /**
+     * 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.
+     * @min 0
+     */
+    DesiredEC2Instances?: number | undefined;
+    /**
+     * 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.
+     */
+    EC2InboundPermissions?: IpPermission[] | undefined;
+    /**
+     * 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.
+     * @pattern ^.*..*$
+     */
+    EC2InstanceType?: string | undefined;
+    /**
+     * 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.
+     */
+    FleetType?: "ON_DEMAND" | "SPOT" | undefined;
+    /**
+     * 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` .
+     * @minLength 1
+     * @pattern ^arn:aws(-.*)?:[a-z-]+:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$
+     */
+    InstanceRoleARN?: string | undefined;
+    /**
+     * 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` .
+     */
+    InstanceRoleCredentialsProvider?: "SHARED_CREDENTIAL_FILE" | undefined;
+    /**
+     * 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.
+     */
+    Locations?: LocationConfiguration[] | undefined;
+    /**
+     * 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()
+     */
+    LogPaths?: string[] | undefined;
+    /**
+     * The maximum number of instances that are allowed in the specified fleet location. If this parameter is not set, the default is 1.
+     * @min 0
+     */
+    MaxSize?: number | undefined;
+    /**
+     * 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.
+     */
+    MetricGroups?: string[] | undefined;
+    /**
+     * The minimum number of instances that are allowed in the specified fleet location. If this parameter is not set, the default is 0.
+     * @min 0
+     */
+    MinSize?: number | undefined;
+    /**
+     * A descriptive label that is associated with a fleet. Fleet names do not need to be unique.
+     * @minLength 1
+     * @maxLength 1024
+     */
+    Name: string;
+    /**
+     * 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.
+     */
+    NewGameSessionProtectionPolicy?: "FullProtection" | "NoProtection" | undefined;
+    /**
+     * 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.
+     * @minLength 1
+     * @maxLength 1024
+     * @pattern ^[0-9]{12}$
+     */
+    PeerVpcAwsAccountId?: string | undefined;
+    /**
+     * 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) .
+     * @minLength 1
+     * @maxLength 1024
+     * @pattern ^vpc-\S+
+     */
+    PeerVpcId?: string | undefined;
+    /**
+     * 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.
+     */
+    ResourceCreationLimitPolicy?: ResourceCreationLimitPolicy | undefined;
+    /**
+     * 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.
+     *
+     * > 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.
+     */
+    RuntimeConfiguration?: RuntimeConfiguration | undefined;
+    /**
+     * Rule that controls how a fleet is scaled. Scaling policies are uniquely identified by the combination of name and fleet ID.
+     */
+    ScalingPolicies?: ScalingPolicy[] | undefined;
+    /**
+     * The unique identifier for a Realtime configuration script to be deployed on fleet instances. You can use either the script ID or ARN. Scripts must be uploaded to Amazon GameLift Servers prior to creating the fleet. This fleet property cannot be changed later.
+     *
+     * > You can't use the `!Ref` command to reference a script created with a CloudFormation template for the fleet property `ScriptId` . Instead, use `Fn::GetAtt Script.Arn` or `Fn::GetAtt Script.Id` to retrieve either of these properties as input for `ScriptId` . Alternatively, enter a `ScriptId` string manually.
+     * @pattern ^script-\S+|^arn:.*:script/script-\S+
+     */
+    ScriptId?: string | undefined;
+    /**
+     * This parameter is no longer used but is retained for backward compatibility. Instead, specify server launch parameters in the RuntimeConfiguration parameter. A request must specify either a runtime configuration or values for both ServerLaunchParameters and ServerLaunchPath.
+     * @minLength 1
+     * @maxLength 1024
+     */
+    ServerLaunchParameters?: string | undefined;
+    /**
+     * This parameter is no longer used. Instead, specify a server launch path using the RuntimeConfiguration parameter. Requests that specify a server launch path and launch parameters instead of a runtime configuration will continue to work.
+     * @minLength 1
+     * @maxLength 1024
+     */
+    ServerLaunchPath?: string | undefined;
+    /**
+     * An array of key-value pairs to apply to this resource.
+     */
+    Tags?: Tag[] | undefined;
+};
+export type GameLiftFleetAttribs = {
+    /**
+     * The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift Servers Fleet resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift Fleet ARN, the resource ID matches the FleetId value.
+     * @pattern ^arn:.*:fleet/[a-z]*fleet-[a-zA-Z0-9\-]+$
+     */
+    FleetArn: string;
+    /**
+     * A unique identifier for the fleet.
+     * @pattern ^fleet-\S+
+     */
+    FleetId: string;
+};
+/**
+ * Amazon GameLift Servers configuration options for your Anywhere fleets.
+ */
+export type AnywhereConfiguration = {
+    /**
+     * 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* .
+     * @minLength 1
+     * @maxLength 11
+     * @pattern ^\d{1,5}(?:\.\d{1,5})?$
+     */
+    Cost: string;
+};
+/**
+ * Determines whether a TLS/SSL certificate is generated for a fleet. This feature must be enabled when creating the fleet. All instances in a fleet share the same certificate. The certificate can be retrieved by calling the [GameLift Server SDK](https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk.html) operation `GetInstanceCertificate` .
+ */
+export type CertificateConfiguration = {
+    /**
+     * Indicates whether a TLS/SSL certificate is generated for a fleet.
+     *
+     * Valid values include:
+     *
+     * - *GENERATED* - Generate a TLS/SSL certificate for this fleet.
+     * - *DISABLED* - (default) Do not generate a TLS/SSL certificate for this fleet.
+     */
+    CertificateType: "DISABLED" | "GENERATED";
+};
+/**
+ * A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an instance in a fleet. New game sessions are assigned an IP address/port number combination, which must fall into the fleet's allowed ranges. Fleets with custom game builds must have permissions explicitly set. For Realtime Servers fleets, GameLift automatically opens two port ranges, one for TCP messaging and one for UDP.
+ */
+export type IpPermission = {
+    /**
+     * 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.
+     * @min 1
+     * @max 60000
+     */
+    FromPort: number;
+    /**
+     * 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]` ".
+     * @pattern (^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(/([0-9]|[1-2][0-9]|3[0-2]))$)
+     */
+    IpRange: string;
+    /**
+     * The network communication protocol used by the fleet.
+     */
+    Protocol: "TCP" | "UDP";
+    /**
+     * An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be equal to or greater than `FromPort` .
+     *
+     * For fleets using Linux builds, only ports `22` and `1026-60000` are valid.
+     *
+     * For fleets using Windows builds, only ports `1026-60000` are valid.
+     * @min 1
+     * @max 60000
+     */
+    ToPort: number;
+};
+/**
+ * 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)
+ */
+export type LocationCapacity = {
+    /**
+     * The number of Amazon EC2 instances you want to maintain in the specified fleet location. This value must fall between the minimum and maximum size limits. Changes in desired instance value can take up to 1 minute to be reflected when viewing the fleet's capacity settings.
+     * @min 0
+     */
+    DesiredEC2Instances: number;
+    /**
+     * The maximum number of instances that are allowed in the specified fleet location. If this parameter is not set, the default is 1.
+     * @min 0
+     */
+    MaxSize: number;
+    /**
+     * The minimum number of instances that are allowed in the specified fleet location. If this parameter is not set, the default is 0.
+     * @min 0
+     */
+    MinSize: number;
+};
+/**
+ * A remote location where a multi-location fleet can deploy game servers for game hosting.
+ */
+export type LocationConfiguration = {
+    /**
+     * 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.
+     */
+    Location: string;
+    /**
+     * 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)
+     */
+    LocationCapacity?: LocationCapacity | undefined;
+};
+/**
+ * A policy that limits the number of game sessions a player can create on the same fleet. This optional policy gives game owners control over how players can consume available game server resources. A resource creation policy makes the following statement: "An individual player can create a maximum number of new game sessions within a specified time period".
+ *
+ * The policy is evaluated when a player tries to create a new game session. For example, assume you have a policy of 10 new game sessions and a time period of 60 minutes. On receiving a `CreateGameSession` request, Amazon GameLift checks that the player (identified by `CreatorId` ) has created fewer than 10 game sessions in the past 60 minutes.
+ */
+export type ResourceCreationLimitPolicy = {
+    /**
+     * 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.
+     * @min 0
+     */
+    NewGameSessionsPerCreator?: number | undefined;
+    /**
+     * The time span used in evaluating the resource creation limit policy.
+     * @min 0
+     */
+    PolicyPeriodInMinutes?: number | undefined;
+};
+/**
+ * A collection of server process configurations that describe the set of processes to run on each instance in a fleet. Server processes run either an executable in a custom game build or a Realtime Servers script. GameLift launches the configured processes, manages their life cycle, and replaces them as needed. Each instance checks regularly for an updated runtime configuration.
+ *
+ * A GameLift instance is limited to 50 processes running concurrently. To calculate the total number of processes in a runtime configuration, add the values of the `ConcurrentExecutions` parameter for each ServerProcess. Learn more about [Running Multiple Processes on a Fleet](https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-multiprocess.html) .
+ */
+export type RuntimeConfiguration = {
+    /**
+     * The maximum amount of time (in seconds) allowed to launch a new game session and have it report ready to host players. During this time, the game session is in status `ACTIVATING` . If the game session does not become active before the timeout, it is ended and the game session status is changed to `TERMINATED` .
+     * @min 1
+     * @max 600
+     */
+    GameSessionActivationTimeoutSeconds?: number | undefined;
+    /**
+     * The number of game sessions in status `ACTIVATING` to allow on an instance or compute. This setting limits the instance resources that can be used for new game activations at any one time.
+     * @min 1
+     * @max 2147483647
+     */
+    MaxConcurrentGameSessionActivations?: number | undefined;
+    /**
+     * A collection of server process configurations that identify what server processes to run on fleet computes.
+     */
+    ServerProcesses?: ServerProcess[] | undefined;
+};
+/**
+ * Rule that controls how a fleet is scaled. Scaling policies are uniquely identified by the combination of name and fleet ID.
+ */
+export type ScalingPolicy = {
+    /**
+     * Comparison operator to use when measuring a metric against the threshold value.
+     */
+    ComparisonOperator?: "GreaterThanOrEqualToThreshold" | "GreaterThanThreshold" | "LessThanThreshold" | "LessThanOrEqualToThreshold" | undefined;
+    /**
+     * Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
+     * @min 1
+     */
+    EvaluationPeriods?: number | undefined;
+    /**
+     * The fleet location.
+     */
+    Location?: string | undefined;
+    /**
+     * 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.
+     */
+    MetricName: "ActivatingGameSessions" | "ActiveGameSessions" | "ActiveInstances" | "AvailableGameSessions" | "AvailablePlayerSessions" | "CurrentPlayerSessions" | "IdleInstances" | "PercentAvailableGameSessions" | "PercentIdleInstances" | "QueueDepth" | "WaitTime" | "ConcurrentActivatableGameSessions";
+    /**
+     * A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique.
+     * @minLength 1
+     * @maxLength 1024
+     */
+    Name: string;
+    /**
+     * The type of scaling policy to create. For a target-based policy, set the parameter *MetricName* to 'PercentAvailableGameSessions' and specify a *TargetConfiguration* . For a rule-based policy set the following parameters: *MetricName* , *ComparisonOperator* , *Threshold* , *EvaluationPeriods* , *ScalingAdjustmentType* , and *ScalingAdjustment* .
+     */
+    PolicyType?: "RuleBased" | "TargetBased" | undefined;
+    /**
+     * Amount of adjustment to make, based on the scaling adjustment type.
+     */
+    ScalingAdjustment?: number | undefined;
+    /**
+     * The type of adjustment to make to a fleet's instance count.
+     *
+     * - *ChangeInCapacity* -- add (or subtract) the scaling adjustment value from the current instance count. Positive values scale up while negative values scale down.
+     * - *ExactCapacity* -- set the instance count to the scaling adjustment value.
+     * - *PercentChangeInCapacity* -- increase or reduce the current instance count by the scaling adjustment, read as a percentage. Positive values scale up while negative values scale down.
+     */
+    ScalingAdjustmentType?: "ChangeInCapacity" | "ExactCapacity" | "PercentChangeInCapacity" | undefined;
+    /**
+     * Current status of the scaling policy. The scaling policy can be in force only when in an `ACTIVE` status. Scaling policies can be suspended for individual fleets. If the policy is suspended for a fleet, the policy status does not change.
+     *
+     * - *ACTIVE* -- The scaling policy can be used for auto-scaling a fleet.
+     * - *UPDATE_REQUESTED* -- A request to update the scaling policy has been received.
+     * - *UPDATING* -- A change is being made to the scaling policy.
+     * - *DELETE_REQUESTED* -- A request to delete the scaling policy has been received.
+     * - *DELETING* -- The scaling policy is being deleted.
+     * - *DELETED* -- The scaling policy has been deleted.
+     * - *ERROR* -- An error occurred in creating the policy. It should be removed and recreated.
+     */
+    Status?: "ACTIVE" | "UPDATE_REQUESTED" | "UPDATING" | "DELETE_REQUESTED" | "DELETING" | "DELETED" | "ERROR" | undefined;
+    /**
+     * An object that contains settings for a target-based scaling policy.
+     */
+    TargetConfiguration?: TargetConfiguration | undefined;
+    /**
+     * Metric value used to trigger a scaling event.
+     */
+    Threshold?: number | undefined;
+    /**
+     * The current status of the fleet's scaling policies in a requested fleet location. The status `PENDING_UPDATE` indicates that an update was requested for the fleet but has not yet been completed for the location.
+     */
+    UpdateStatus?: "PENDING_UPDATE" | undefined;
+};
+/**
+ * A set of instructions for launching server processes on each instance in a fleet. Server processes run either an executable in a custom game build or a Realtime Servers script.
+ */
+export type ServerProcess = {
+    /**
+     * The number of server processes using this configuration that run concurrently on each instance or compute.
+     * @min 1
+     */
+    ConcurrentExecutions: number;
+    /**
+     * 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` "
+     *
+     * > 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()` .
+     * @minLength 1
+     * @maxLength 1024
+     * @pattern ^([Cc]:\\game\S+|/local/game/\S+)
+     */
+    LaunchPath: string;
+    /**
+     * 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_:.+\/\\\- =@{},?'\[\]"]+
+     * @minLength 1
+     * @maxLength 1024
+     */
+    Parameters?: string | undefined;
+};
+/**
+ * Settings for a target-based scaling policy. A target-based policy tracks a particular fleet metric specifies a target value for the metric. As player usage changes, the policy triggers Amazon GameLift 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.
+ */
+export type TargetConfiguration = {
+    /**
+     * 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).
+     */
+    TargetValue: number;
+};
+//# sourceMappingURL=aws-gamelift-fleet.d.ts.map

package/out/exports/resources.generated/aws-gamelift-gameservergroup.d.ts

@@ -0,0 +1,163 @@
+import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+export type GameLiftGameServerGroup = ResourceDefinitionWithAttributes<"AWS::GameLift::GameServerGroup", GameLiftGameServerGroupProps, GameLiftGameServerGroupAttribs>;
+/**
+ * *This operation is used with the Amazon GameLift FleetIQ solution and game server groups.*
+ *
+ * Creates a GameLift FleetIQ game server group for managing game hosting on a collection of Amazon EC2 instances for game hosting. This operation creates the game server group, creates an Auto Scaling group in your AWS account , and establishes a link between the two groups. You can view the status of your game server groups in the GameLift console. Game server group metrics and events are emitted to Amazon CloudWatch.
+ *
+ * Before creating a new game server group, you must have the following:
+ *
+ * - An Amazon EC2 launch template that specifies how to launch Amazon EC2 instances with your game server build. For more information, see [Launching an Instance from a Launch Template](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html) in the *Amazon EC2 User Guide* .
+ * - An IAM role that extends limited access to your AWS account to allow GameLift FleetIQ to create and interact with the Auto Scaling group. For more information, see [Create IAM roles for cross-service interaction](https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-iam-permissions-roles.html) in the *GameLift FleetIQ Developer Guide* .
+ *
+ * To create a new game server group, specify a unique group name, IAM role and Amazon EC2 launch template, and provide a list of instance types that can be used in the group. You must also set initial maximum and minimum limits on the group's instance count. You can optionally set an Auto Scaling policy with target tracking based on a GameLift FleetIQ metric.
+ *
+ * Once the game server group and corresponding Auto Scaling group are created, you have full access to change the Auto Scaling group's configuration as needed. Several properties that are set when creating a game server group, including maximum/minimum size and auto-scaling policy settings, must be updated directly in the Auto Scaling group. Keep in mind that some Auto Scaling group properties are periodically updated by GameLift FleetIQ as part of its balancing activities to optimize for availability and cost.
+ *
+ * *Learn more*
+ *
+ * [GameLift FleetIQ Guide](https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html)
+ */
+export type GameLiftGameServerGroupProps = {
+    /**
+     * 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.
+     */
+    AutoScalingPolicy?: AutoScalingPolicy | undefined;
+    /**
+     * 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.
+     */
+    BalancingStrategy?: BalancingStrategy | undefined;
+    /**
+     * 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.
+     */
+    DeleteOption?: DeleteOption | undefined;
+    /**
+     * A developer-defined identifier for the game server group. The name is unique for each Region in each AWS account.
+     */
+    GameServerGroupName: string;
+    /**
+     * 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.
+     */
+    GameServerProtectionPolicy?: GameServerProtectionPolicy | undefined;
+    /**
+     * 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.
+     */
+    InstanceDefinitions: InstanceDefinition[];
+    /**
+     * 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.
+     *
+     * > 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.
+     */
+    LaunchTemplate?: LaunchTemplate | undefined;
+    /**
+     * 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.
+     */
+    MaxSize?: number | undefined;
+    /**
+     * 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.
+     */
+    MinSize?: number | undefined;
+    /**
+     * 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.
+     */
+    RoleArn: string;
+    /**
+     * 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.
+     */
+    Tags?: Tag[] | undefined;
+    /**
+     * 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.
+     */
+    VpcSubnets?: string[] | undefined;
+};
+export type GameLiftGameServerGroupAttribs = {
+    /**
+     * A unique identifier for the auto scaling group.
+     */
+    AutoScalingGroupArn: string;
+    /**
+     * A unique identifier for the game server group.
+     */
+    GameServerGroupArn: string;
+};
+/**
+ * *This data type is used with the GameLift FleetIQ and game server groups.*
+ *
+ * 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.
+ */
+export type AutoScalingPolicy = {
+    /**
+     * 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.
+     */
+    EstimatedInstanceWarmup?: number | undefined;
+    /**
+     * 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.
+     */
+    TargetTrackingConfiguration: TargetTrackingConfiguration;
+};
+/**
+ * The fallback balancing method to use for the game server group when Spot Instances in a Region become unavailable or are not viable for game hosting.
+ */
+export type BalancingStrategy = "SPOT_ONLY" | "SPOT_PREFERRED" | "ON_DEMAND_ONLY";
+/**
+ * The type of delete to perform.
+ */
+export type DeleteOption = "SAFE_DELETE" | "FORCE_DELETE" | "RETAIN";
+/**
+ * A flag that indicates whether instances in the game server group are protected from early termination.
+ */
+export type GameServerProtectionPolicy = "NO_PROTECTION" | "FULL_PROTECTION";
+/**
+ * *This data type is used with the Amazon GameLift FleetIQ and game server groups.*
+ *
+ * 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.
+ */
+export type InstanceDefinition = {
+    /**
+     * An Amazon EC2 instance type designation.
+     */
+    InstanceType: string;
+    /**
+     * 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".
+     */
+    WeightedCapacity?: string | undefined;
+};
+/**
+ * *This data type is used with the GameLift FleetIQ and game server groups.*
+ *
+ * An Amazon EC2 launch template that contains configuration settings and game server code to be deployed to all instances in a game server group. The launch template is specified when creating a new game server group with `GameServerGroup` .
+ */
+export type LaunchTemplate = {
+    /**
+     * A unique identifier for an existing Amazon EC2 launch template.
+     */
+    LaunchTemplateId?: string | undefined;
+    /**
+     * A readable identifier for an existing Amazon EC2 launch template.
+     */
+    LaunchTemplateName?: string | undefined;
+    /**
+     * The version of the Amazon EC2 launch template to use. If no version is specified, the default version will be used. With Amazon EC2, you can specify a default version for a launch template. If none is set, the default is the first version created.
+     */
+    Version?: string | undefined;
+};
+/**
+ * *This data type is used with the Amazon GameLift FleetIQ and game server groups.*
+ *
+ * Settings for a target-based scaling policy as part of a `GameServerGroupAutoScalingPolicy` . 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.
+ */
+export type TargetTrackingConfiguration = {
+    /**
+     * Desired value to use with a game server group target-based scaling policy.
+     */
+    TargetValue: number;
+};
+//# sourceMappingURL=aws-gamelift-gameservergroup.d.ts.map