@propulsionworks/cloudformation 0.0.1 → 0.1.0

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

@@ -0,0 +1,70 @@
+import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+export type GameLiftBuild = ResourceDefinitionWithAttributes<"AWS::GameLift::Build", GameLiftBuildProps, GameLiftBuildAttribs>;
+/**
+ * The `AWS::GameLift::Build` resource creates a game server build that is installed and run on instances in an Amazon GameLift fleet. This resource points to an Amazon S3 location that contains a zip file with all of the components of the game server build.
+ */
+export type GameLiftBuildProps = {
+    /**
+     * A descriptive label that is associated with a build. Build names do not need to be unique.
+     */
+    Name?: string | undefined;
+    /**
+     * 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.
+     *
+     * > 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/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)
+     */
+    OperatingSystem?: "AMAZON_LINUX" | "AMAZON_LINUX_2" | "AMAZON_LINUX_2023" | "WINDOWS_2012" | "WINDOWS_2016" | undefined;
+    /**
+     * 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` .
+     */
+    ServerSdkVersion?: string | undefined;
+    /**
+     * 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.
+     */
+    StorageLocation?: StorageLocation | undefined;
+    /**
+     * An array of key-value pairs to apply to this resource.
+     */
+    Tags?: Tag[] | undefined;
+    /**
+     * Version information that is associated with this build. Version strings do not need to be unique.
+     */
+    Version?: string | undefined;
+};
+export type GameLiftBuildAttribs = {
+    /**
+     * 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 build resource and uniquely identifies it. ARNs are unique across all Regions. Format is `arn:aws:gamelift:<region>::build/build-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912` . In a GameLift build ARN, the resource ID matches the *BuildId* value.
+     * @pattern ^arn:.*:build\/build-\S+
+     */
+    BuildArn: string;
+    /**
+     * A unique identifier for the build.
+     */
+    BuildId: string;
+};
+/**
+ * The location in Amazon S3 where build or script files are stored for access by Amazon GameLift.
+ */
+export type StorageLocation = {
+    /**
+     * An Amazon S3 bucket identifier. The name of the S3 bucket.
+     *
+     * > Amazon GameLift doesn't support uploading from Amazon S3 buckets with names that contain a dot (.).
+     */
+    Bucket: string;
+    /**
+     * The name of the zip file that contains the build files or script files.
+     */
+    Key: string;
+    /**
+     * A version of a stored file to retrieve, if the object versioning feature is turned on for the S3 bucket. Use this parameter to specify a specific version. If this parameter isn't set, Amazon GameLift Servers retrieves the latest version of the file.
+     */
+    ObjectVersion?: string | undefined;
+    /**
+     * The ARNfor an IAM role that allows Amazon GameLift to access the S3 bucket.
+     */
+    RoleArn: string;
+};
+//# sourceMappingURL=aws-gamelift-build.d.ts.map

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

@@ -0,0 +1,366 @@
+import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+export type GameLiftContainerFleet = ResourceDefinitionWithAttributes<"AWS::GameLift::ContainerFleet", GameLiftContainerFleetProps, GameLiftContainerFleetAttribs>;
+/**
+ * Describes an Amazon GameLift Servers managed container fleet.
+ */
+export type GameLiftContainerFleetProps = {
+    /**
+     * 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` .
+     */
+    BillingType?: "ON_DEMAND" | "SPOT" | undefined;
+    /**
+     * Set of rules for processing a deployment for a container fleet update.
+     */
+    DeploymentConfiguration?: DeploymentConfiguration | undefined;
+    /**
+     * A meaningful description of the container fleet.
+     * @minLength 1
+     * @maxLength 1024
+     */
+    Description?: string | undefined;
+    /**
+     * 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.
+     * @minLength 1
+     * @maxLength 256
+     * @pattern ^arn:aws(-.*)?:[a-z-]+:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$
+     */
+    FleetRoleArn: string;
+    /**
+     * The name of the fleet's game server container group definition, which describes how to deploy containers with your game server build and support software onto each fleet instance.
+     * @minLength 1
+     * @maxLength 512
+     * @pattern ^[a-zA-Z0-9\-]+$|^arn:.*:containergroupdefinition\/[a-zA-Z0-9\-]+(:[0-9]+)?$
+     */
+    GameServerContainerGroupDefinitionName?: string | undefined;
+    /**
+     * The number of times to replicate the game server container group on each fleet instance.
+     * @min 1
+     * @max 5000
+     */
+    GameServerContainerGroupsPerInstance?: number | undefined;
+    /**
+     * A policy that limits the number of game sessions that each individual player can create on instances in this fleet. The limit applies for a specified span of time.
+     */
+    GameSessionCreationLimitPolicy?: GameSessionCreationLimitPolicy | undefined;
+    /**
+     * The set of port numbers to open on each instance in a container fleet. Connection ports are used by inbound traffic to connect with processes that are running in containers on the fleet.
+     */
+    InstanceConnectionPortRange?: ConnectionPortRange | undefined;
+    /**
+     * The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet.
+     */
+    InstanceInboundPermissions?: IpPermission[] | undefined;
+    /**
+     * 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.
+     * @minLength 1
+     * @maxLength 1024
+     */
+    InstanceType?: string | undefined;
+    Locations?: LocationConfiguration[] | undefined;
+    /**
+     * 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.
+     */
+    LogConfiguration?: LogConfiguration | undefined;
+    /**
+     * The name of an AWS CloudWatch metric group to add this fleet to. Metric groups aggregate metrics for multiple fleets.
+     */
+    MetricGroups?: string[] | undefined;
+    /**
+     * 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.
+     */
+    NewGameSessionProtectionPolicy?: "FullProtection" | "NoProtection" | undefined;
+    /**
+     * The name of the fleet's per-instance container group definition.
+     * @minLength 1
+     * @maxLength 512
+     * @pattern ^[a-zA-Z0-9\-]+$|^arn:.*:containergroupdefinition\/[a-zA-Z0-9\-]+(:[0-9]+)?$
+     */
+    PerInstanceContainerGroupDefinitionName?: string | undefined;
+    /**
+     * A list of rules that control how a fleet is scaled.
+     */
+    ScalingPolicies?: ScalingPolicy[] | undefined;
+    /**
+     * An array of key-value pairs to apply to this resource.
+     */
+    Tags?: Tag[] | undefined;
+};
+export type GameLiftContainerFleetAttribs = {
+    /**
+     * A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example `"1469498468.057"` ).
+     */
+    CreationTime: string;
+    /**
+     * 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.
+     * @minLength 1
+     * @maxLength 512
+     * @pattern ^arn:.*:[a-z]*fleet\/[a-z]*fleet-[a-zA-Z0-9\-]+$
+     */
+    FleetArn: string;
+    /**
+     * A unique identifier for the container fleet to retrieve.
+     * @minLength 1
+     * @maxLength 128
+     * @pattern ^[a-z]*fleet-[a-zA-Z0-9\-]+
+     */
+    FleetId: string;
+    /**
+     * The Amazon Resource Name ( [ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) ) that is assigned to the fleet's game server container group. The ARN value also identifies the specific container group definition version in use.
+     * @maxLength 512
+     * @pattern ^arn:.*:containergroupdefinition\/[a-zA-Z0-9\-]+(:[0-9]+)?$|^$
+     */
+    GameServerContainerGroupDefinitionArn: string;
+    /**
+     * The calculated maximum number of game server container group that can be deployed on each fleet instance. The calculation depends on the resource needs of the container group and the CPU and memory resources of the fleet's instance type.
+     * @min 1
+     * @max 5000
+     */
+    MaximumGameServerContainerGroupsPerInstance: number;
+    /**
+     * The Amazon Resource Name ( [ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) ) that is assigned to the fleet's per-instance container group. The ARN value also identifies the specific container group definition version in use.
+     * @maxLength 512
+     * @pattern ^arn:.*:containergroupdefinition\/[a-zA-Z0-9\-]+(:[0-9]+)?$|^$
+     */
+    PerInstanceContainerGroupDefinitionArn: string;
+    /**
+     * The current status of the container fleet.
+     *
+     * - `PENDING` -- A new container fleet has been requested.
+     * - `CREATING` -- A new container fleet resource is being created.
+     * - `CREATED` -- A new container fleet resource has been created. No fleet instances have been deployed.
+     * - `ACTIVATING` -- New container fleet instances are being deployed.
+     * - `ACTIVE` -- The container fleet has been deployed and is ready to host game sessions.
+     * - `UPDATING` -- Updates to the container fleet is being updated. A deployment is in progress.
+     */
+    Status: "PENDING" | "CREATING" | "CREATED" | "ACTIVATING" | "ACTIVE" | "UPDATING" | "DELETING";
+};
+/**
+ * The set of port numbers to open on each instance in a container fleet. Connection ports are used by inbound traffic to connect with processes that are running in containers on the fleet.
+ */
+export type ConnectionPortRange = {
+    /**
+     * Starting value for the port range.
+     * @min 1
+     * @max 60000
+     */
+    FromPort: number;
+    /**
+     * Ending value for the port. Port numbers are end-inclusive. This value must be equal to or greater than `FromPort` .
+     * @min 1
+     * @max 60000
+     */
+    ToPort: number;
+};
+/**
+ * Set of rules for processing a deployment for a container fleet update.
+ */
+export type DeploymentConfiguration = {
+    /**
+     * Determines what actions to take if a deployment fails. If the fleet is multi-location, this strategy applies across all fleet locations. With a rollback strategy, updated fleet instances are rolled back to the last successful deployment. Alternatively, you can maintain a few impaired containers for the purpose of debugging, while all other tasks return to the last successful deployment.
+     */
+    ImpairmentStrategy?: "MAINTAIN" | "ROLLBACK" | undefined;
+    /**
+     * Sets a minimum level of healthy tasks to maintain during deployment activity.
+     * @min 30
+     * @max 75
+     */
+    MinimumHealthyPercentage?: number | undefined;
+    /**
+     * Determines how fleet deployment activity affects active game sessions on the fleet. With protection, a deployment honors game session protection, and delays actions that would interrupt a protected active game session until the game session ends. Without protection, deployment activity can shut down all running tasks, including active game sessions, regardless of game session protection.
+     */
+    ProtectionStrategy?: "WITH_PROTECTION" | "IGNORE_PROTECTION" | undefined;
+};
+/**
+ * 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.
+ */
+export type GameSessionCreationLimitPolicy = {
+    /**
+     * 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.
+     * @min 0
+     */
+    NewGameSessionsPerCreator?: number | undefined;
+    /**
+     * The time span used in evaluating the resource creation limit policy.
+     * @min 0
+     */
+    PolicyPeriodInMinutes?: number | undefined;
+};
+/**
+ * A range of IP addresses and port settings that allow inbound traffic to connect to processes on an instance in a fleet. Processes are assigned an IP address/port number combination, which must fall into the fleet's allowed ranges.
+ *
+ * For Amazon GameLift Servers Realtime fleets, Amazon GameLift Servers 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 in a specified fleet or location. The location value might refer to a fleet's remote location or its home Region.
+ */
+export type LocationCapacity = {
+    /**
+     * The number of EC2 instances you want to maintain in the specified fleet location. This value must fall between the minimum and maximum size limits.
+     * @min 0
+     */
+    DesiredEC2Instances: number;
+    /**
+     * The maximum value that is allowed for the fleet's instance count for a location.
+     * @min 0
+     */
+    MaxSize: number;
+    /**
+     * The minimum value allowed for the fleet's instance count for a location.
+     * @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 in a specified fleet or location. The location value might refer to a fleet's remote location or its home Region.
+     */
+    LocationCapacity?: LocationCapacity | undefined;
+    /**
+     * A list of fleet actions that have been suspended in the fleet location.
+     */
+    StoppedActions?: "AUTO_SCALING"[] | undefined;
+};
+/**
+ * A method for collecting container logs for the fleet. Amazon GameLift Servers saves all standard output for each container in logs, including game session logs. You can select from the following methods:
+ */
+export type LogConfiguration = {
+    /**
+     * 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.
+     */
+    LogDestination?: LogDestination | undefined;
+    /**
+     * If log destination is `S3` , logs are sent to the specified Amazon S3 bucket name.
+     * @minLength 1
+     * @maxLength 1024
+     */
+    S3BucketName?: string | undefined;
+};
+/**
+ * Configures the service that provides logs.
+ */
+export type LogDestination = "NONE" | "CLOUDWATCH" | "S3";
+/**
+ * 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;
+    /**
+     * 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;
+    /**
+     * 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;
+};
+/**
+ * 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-containerfleet.d.ts.map