@aws-cdk/aws-gamelift-alpha 2.45.0-alpha.0

package/.warnings.jsii.js

@@ -0,0 +1,89 @@
+function _aws_cdk_aws_gamelift_alpha_Content(p) {
+}
+function _aws_cdk_aws_gamelift_alpha_ContentConfig(p) {
+}
+function _aws_cdk_aws_gamelift_alpha_S3Content(p) {
+}
+function _aws_cdk_aws_gamelift_alpha_AssetContent(p) {
+}
+function _aws_cdk_aws_gamelift_alpha_IBuild(p) {
+}
+function _aws_cdk_aws_gamelift_alpha_BuildBase(p) {
+}
+function _aws_cdk_aws_gamelift_alpha_OperatingSystem(p) {
+}
+function _aws_cdk_aws_gamelift_alpha_BuildAttributes(p) {
+}
+function _aws_cdk_aws_gamelift_alpha_BuildProps(p) {
+    if (p == null)
+        return;
+    visitedObjects.add(p);
+    try {
+        if (!visitedObjects.has(p.content))
+            _aws_cdk_aws_gamelift_alpha_Content(p.content);
+        if (!visitedObjects.has(p.operatingSystem))
+            _aws_cdk_aws_gamelift_alpha_OperatingSystem(p.operatingSystem);
+    }
+    finally {
+        visitedObjects.delete(p);
+    }
+}
+function _aws_cdk_aws_gamelift_alpha_Build(p) {
+}
+function _aws_cdk_aws_gamelift_alpha_IScript(p) {
+}
+function _aws_cdk_aws_gamelift_alpha_ScriptBase(p) {
+}
+function _aws_cdk_aws_gamelift_alpha_ScriptAttributes(p) {
+}
+function _aws_cdk_aws_gamelift_alpha_ScriptProps(p) {
+    if (p == null)
+        return;
+    visitedObjects.add(p);
+    try {
+        if (!visitedObjects.has(p.content))
+            _aws_cdk_aws_gamelift_alpha_Content(p.content);
+    }
+    finally {
+        visitedObjects.delete(p);
+    }
+}
+function _aws_cdk_aws_gamelift_alpha_Script(p) {
+}
+function print(name, deprecationMessage) {
+    const deprecated = process.env.JSII_DEPRECATED;
+    const deprecationMode = ["warn", "fail", "quiet"].includes(deprecated) ? deprecated : "warn";
+    const message = `${name} is deprecated.\n  ${deprecationMessage.trim()}\n  This API will be removed in the next major release.`;
+    switch (deprecationMode) {
+        case "fail":
+            throw new DeprecationError(message);
+        case "warn":
+            console.warn("[WARNING]", message);
+            break;
+    }
+}
+function getPropertyDescriptor(obj, prop) {
+    const descriptor = Object.getOwnPropertyDescriptor(obj, prop);
+    if (descriptor) {
+        return descriptor;
+    }
+    const proto = Object.getPrototypeOf(obj);
+    const prototypeDescriptor = proto && getPropertyDescriptor(proto, prop);
+    if (prototypeDescriptor) {
+        return prototypeDescriptor;
+    }
+    return {};
+}
+const visitedObjects = new Set();
+class DeprecationError extends Error {
+    constructor(...args) {
+        super(...args);
+        Object.defineProperty(this, "name", {
+            configurable: false,
+            enumerable: true,
+            value: "DeprecationError",
+            writable: false,
+        });
+    }
+}
+module.exports = { print, getPropertyDescriptor, DeprecationError, _aws_cdk_aws_gamelift_alpha_Content, _aws_cdk_aws_gamelift_alpha_ContentConfig, _aws_cdk_aws_gamelift_alpha_S3Content, _aws_cdk_aws_gamelift_alpha_AssetContent, _aws_cdk_aws_gamelift_alpha_IBuild, _aws_cdk_aws_gamelift_alpha_BuildBase, _aws_cdk_aws_gamelift_alpha_OperatingSystem, _aws_cdk_aws_gamelift_alpha_BuildAttributes, _aws_cdk_aws_gamelift_alpha_BuildProps, _aws_cdk_aws_gamelift_alpha_Build, _aws_cdk_aws_gamelift_alpha_IScript, _aws_cdk_aws_gamelift_alpha_ScriptBase, _aws_cdk_aws_gamelift_alpha_ScriptAttributes, _aws_cdk_aws_gamelift_alpha_ScriptProps, _aws_cdk_aws_gamelift_alpha_Script };

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2018-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,2 @@
+AWS Cloud Development Kit (AWS CDK)
+Copyright 2018-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.

package/README.md

@@ -0,0 +1,105 @@
+# Amazon GameLift Construct Library
+<!--BEGIN STABILITY BANNER-->
+
+---
+
+![cdk-constructs: Experimental](https://img.shields.io/badge/cdk--constructs-experimental-important.svg?style=for-the-badge)
+
+> The APIs of higher level constructs in this module are experimental and under active development.
+> They are subject to non-backward compatible changes or removal in any future version. These are
+> not subject to the [Semantic Versioning](https://semver.org/) model and breaking changes will be
+> announced in the release notes. This means that while you may use them, you may need to update
+> your source code when upgrading to a newer version of this package.
+
+---
+
+<!--END STABILITY BANNER-->
+
+[Amazon GameLift](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-intro.html) is a service used
+to deploy, operate, and scale dedicated, low-cost servers in the cloud for session-based multiplayer games. Built
+on AWS global computing infrastructure, GameLift helps deliver high-performance, high-reliability game servers
+while dynamically scaling your resource usage to meet worldwide player demand.
+
+GameLift is composed of three main components:
+
+* GameLift FlexMatch which is a customizable matchmaking service for
+multiplayer games. With FlexMatch, you can
+build a custom set of rules that defines what a multiplayer match looks like
+for your game, and determines how to
+evaluate and select compatible players for each match. You can also customize
+key aspects of the matchmaking
+process to fit your game, including fine-tuning the matching algorithm.
+  
+* GameLift hosting for custom or realtime servers which helps you deploy,
+operate, and scale dedicated game servers. It regulates the resources needed to
+host games, finds available game servers to host new game sessions, and puts
+players into games.
+  
+* GameLift FleetIQ to optimize the use of low-cost Amazon Elastic Compute Cloud
+(Amazon EC2) Spot Instances for cloud-based game hosting. With GameLift
+FleetIQ, you can work directly with your hosting resources in Amazon EC2 and
+Amazon EC2 Auto Scaling while taking advantage of GameLift optimizations to
+deliver inexpensive, resilient game hosting for your players
+
+This module is part of the [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) project. It allows you to define components for your matchmaking
+configuration or game server fleet management system.
+
+## GameLift Hosting
+
+### Defining a GameLift Fleet
+
+GameLift helps you deploy, operate, and scale dedicated game servers for
+session-based multiplayer games. It helps you regulate the resources needed to
+host your games, finds available game servers to host new game sessions, and
+puts players into games.
+
+### Uploading builds and scripts to GameLift
+
+Before deploying your GameLift-enabled multiplayer game servers for hosting with the GameLift service, you need to upload
+your game server files. This section provides guidance on preparing and uploading custom game server build
+files or Realtime Servers server script files. When you upload files, you create a GameLift build or script resource, which
+you then deploy on fleets of hosting resources.
+
+To troubleshoot fleet activation problems related to the server script, see [Debug GameLift fleet issues](https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html).
+
+#### Upload a custom server build to GameLift
+
+Before uploading your configured game server to GameLift for hosting, package the game build files into a build directory.
+This directory must include all components required to run your game servers and host game sessions, including the following:
+
+* Game server binaries – The binary files required to run the game server. A build can include binaries for multiple game
+servers built to run on the same platform. For a list of supported platforms, see [Download Amazon GameLift SDKs](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-supported.html).
+
+* Dependencies – Any dependent files that your game server executables require to run. Examples include assets, configuration
+files, and dependent libraries.
+
+* Install script – A script file to handle tasks that are required to fully install your game build on GameLift hosting
+servers. Place this file at the root of the build directory. GameLift runs the install script as part of fleet creation.
+
+You can set up any application in your build, including your install script, to access your resources securely on other AWS
+services.
+
+```ts
+declare const bucket: s3.Bucket;
+new gamelift.Build(this, 'Build', {
+  content: gamelift.Content.fromBucket(bucket, "sample-asset-key")
+});
+```
+
+#### Upload a realtime server Script
+
+Your server script can include one or more files combined into a single .zip file for uploading. The .zip file must contain
+all files that your script needs to run.
+
+You can store your zipped script files in either a local file directory or in an Amazon Simple Storage Service (Amazon S3)
+bucket or defines a directory asset which is archived as a .zip file and uploaded to S3 during deployment.
+
+After you create the script resource, GameLift deploys the script with a new Realtime Servers fleet. GameLift installs your
+server script onto each instance in the fleet, placing the script files in `/local/game`.
+
+```ts
+declare const bucket: s3.Bucket;
+new gamelift.Script(this, 'Script', {
+  content: gamelift.Content.fromBucket(bucket, "sample-asset-key")
+});
+```

package/lib/build.d.ts

@@ -0,0 +1,143 @@
+import * as iam from 'aws-cdk-lib/aws-iam';
+import * as s3 from 'aws-cdk-lib/aws-s3';
+import * as s3_assets from 'aws-cdk-lib/aws-s3-assets';
+import * as cdk from 'aws-cdk-lib';
+import { Construct } from 'constructs';
+import { Content } from './content';
+/**
+ * Your custom-built game server software that runs on GameLift and hosts game sessions for your players.
+ * A game build represents the set of files that run your game server on a particular operating system.
+ * You can have many different builds, such as for different flavors of your game.
+ * The game build must be integrated with the GameLift service.
+ * You upload game build files to the GameLift service in the Regions where you plan to set up fleets.
+ *
+ * @see https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-cli-uploading.html
+ */
+export interface IBuild extends cdk.IResource, iam.IGrantable {
+    /**
+     * The Identifier of the build.
+     *
+     * @attribute
+     */
+    readonly buildId: string;
+}
+/**
+ * Base class for new and imported GameLift server build.
+ */
+export declare abstract class BuildBase extends cdk.Resource implements IBuild {
+    /**
+       * The Identifier of the build.
+       */
+    abstract readonly buildId: string;
+    abstract readonly grantPrincipal: iam.IPrincipal;
+}
+/**
+ * The operating system that the game server binaries are built to run on.
+ */
+export declare enum OperatingSystem {
+    AMAZON_LINUX = "AMAZON_LINUX",
+    AMAZON_LINUX_2 = "AMAZON_LINUX_2",
+    WINDOWS_2012 = "WINDOWS_2012"
+}
+/**
+ * Represents a Build content defined outside of this stack.
+ */
+export interface BuildAttributes {
+    /**
+       * The identifier of the build
+       */
+    readonly buildId: string;
+    /**
+     * The IAM role assumed by GameLift to access server build in S3.
+     * @default - undefined
+     */
+    readonly role?: iam.IRole;
+}
+/**
+ * Properties for a new build
+ */
+export interface BuildProps {
+    /**
+       * Name of this build
+       *
+       * @default No name
+       */
+    readonly buildName?: string;
+    /**
+       * Version of this build
+       *
+       * @default No version
+       */
+    readonly buildVersion?: string;
+    /**
+       * The operating system that the game server binaries are built to run on.
+       *
+       * @default No version
+       */
+    readonly operatingSystem?: OperatingSystem;
+    /**
+       * The game build file storage
+       */
+    readonly content: Content;
+    /**
+      * The IAM role assumed by GameLift to access server build in S3.
+      * If providing a custom role, it needs to trust the GameLift service principal (gamelift.amazonaws.com) and be granted sufficient permissions
+      * to have Read access to a specific key content into a specific S3 bucket.
+      * Below an example of required permission:
+      * {
+      *  "Version": "2012-10-17",
+      *  "Statement": [{
+      *        "Effect": "Allow",
+      *        "Action": [
+      *            "s3:GetObject",
+      *            "s3:GetObjectVersion"
+      *        ],
+      *        "Resource": "arn:aws:s3:::bucket-name/object-name"
+      *  }]
+      *}
+      *
+      * @see https://docs.aws.amazon.com/gamelift/latest/developerguide/security_iam_id-based-policy-examples.html#security_iam_id-based-policy-examples-access-storage-loc
+      *
+      * @default - a role will be created with default permissions.
+      */
+    readonly role?: iam.IRole;
+}
+/**
+ * A GameLift build, that is installed and runs on instances in an Amazon GameLift fleet. It consists of
+ * a zip file with all of the components of the game server build.
+ *
+ * @see https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-cli-uploading.html
+ *
+ * @resource AWS::GameLift::Build
+ */
+export declare class Build extends BuildBase {
+    /**
+     * Create a new Build from s3 content
+     */
+    static fromBucket(scope: Construct, id: string, bucket: s3.IBucket, key: string, objectVersion?: string): Build;
+    /**
+     * Create a new Build from asset content
+     */
+    static fromAsset(scope: Construct, id: string, path: string, options?: s3_assets.AssetOptions): Build;
+    /**
+       * Import a build into CDK using its identifier
+       */
+    static fromBuildId(scope: Construct, id: string, buildId: string): IBuild;
+    /**
+     * Import an existing build from its attributes.
+     */
+    static fromBuildAttributes(scope: Construct, id: string, attrs: BuildAttributes): IBuild;
+    /**
+     * The Identifier of the build.
+     */
+    readonly buildId: string;
+    /**
+     * The IAM role GameLift assumes to acccess server build content.
+     */
+    readonly role: iam.IRole;
+    /**
+     * The principal this GameLift Build is using.
+     */
+    readonly grantPrincipal: iam.IPrincipal;
+    constructor(scope: Construct, id: string, props: BuildProps);
+}