@aws-cdk/aws-gamelift-alpha 2.49.1-alpha.0 → 2.51.0-alpha.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.jsii +3892 -182
- package/.jsii.tabl.json.gz +0 -0
- package/.warnings.jsii.js +155 -1
- package/README.md +417 -7
- package/lib/build-fleet.d.ts +81 -0
- package/lib/build-fleet.js +155 -0
- package/lib/build.js +4 -3
- package/lib/content.d.ts +3 -3
- package/lib/content.js +21 -8
- package/lib/fleet-base.d.ts +408 -0
- package/lib/fleet-base.js +233 -0
- package/lib/game-server-group.d.ts +334 -0
- package/lib/game-server-group.js +271 -0
- package/lib/index.d.ts +4 -0
- package/lib/index.js +5 -1
- package/lib/ingress-rule.d.ts +117 -0
- package/lib/ingress-rule.js +168 -0
- package/lib/script.js +2 -2
- package/package.json +9 -8
- package/rosetta/default.ts-fixture +2 -1
package/.jsii
CHANGED
|
@@ -8,10 +8,88 @@
|
|
|
8
8
|
"url": "https://aws.amazon.com"
|
|
9
9
|
},
|
|
10
10
|
"dependencies": {
|
|
11
|
-
"aws-cdk-lib": "^2.
|
|
11
|
+
"aws-cdk-lib": "^2.51.0",
|
|
12
12
|
"constructs": "^10.0.0"
|
|
13
13
|
},
|
|
14
14
|
"dependencyClosure": {
|
|
15
|
+
"@aws-cdk/asset-awscli-v1": {
|
|
16
|
+
"targets": {
|
|
17
|
+
"dotnet": {
|
|
18
|
+
"namespace": "Amazon.CDK.Asset.AwsCliV1",
|
|
19
|
+
"packageId": "Amazon.CDK.Asset.AwsCliV1"
|
|
20
|
+
},
|
|
21
|
+
"go": {
|
|
22
|
+
"moduleName": "github.com/cdklabs/awscdk-asset-awscli-go",
|
|
23
|
+
"packageName": "awscliv1"
|
|
24
|
+
},
|
|
25
|
+
"java": {
|
|
26
|
+
"maven": {
|
|
27
|
+
"artifactId": "cdk-asset-awscli-v1",
|
|
28
|
+
"groupId": "software.amazon.awscdk"
|
|
29
|
+
},
|
|
30
|
+
"package": "software.amazon.awscdk.cdk.asset.awscli.v1"
|
|
31
|
+
},
|
|
32
|
+
"js": {
|
|
33
|
+
"npm": "@aws-cdk/asset-awscli-v1"
|
|
34
|
+
},
|
|
35
|
+
"python": {
|
|
36
|
+
"distName": "aws-cdk.asset-awscli-v1",
|
|
37
|
+
"module": "aws_cdk.asset_awscli_v1"
|
|
38
|
+
}
|
|
39
|
+
}
|
|
40
|
+
},
|
|
41
|
+
"@aws-cdk/asset-kubectl-v20": {
|
|
42
|
+
"targets": {
|
|
43
|
+
"dotnet": {
|
|
44
|
+
"namespace": "Amazon.CDK.Asset.KubectlV20",
|
|
45
|
+
"packageId": "Amazon.CDK.Asset.KubectlV20"
|
|
46
|
+
},
|
|
47
|
+
"go": {
|
|
48
|
+
"moduleName": "github.com/cdklabs/awscdk-asset-kubectl-go",
|
|
49
|
+
"packageName": "kubectlv20"
|
|
50
|
+
},
|
|
51
|
+
"java": {
|
|
52
|
+
"maven": {
|
|
53
|
+
"artifactId": "cdk-asset-kubectl-v20",
|
|
54
|
+
"groupId": "software.amazon.awscdk"
|
|
55
|
+
},
|
|
56
|
+
"package": "software.amazon.awscdk.cdk.asset.kubectl.v20"
|
|
57
|
+
},
|
|
58
|
+
"js": {
|
|
59
|
+
"npm": "@aws-cdk/asset-kubectl-v20"
|
|
60
|
+
},
|
|
61
|
+
"python": {
|
|
62
|
+
"distName": "aws-cdk.asset-kubectl-v20",
|
|
63
|
+
"module": "aws_cdk.asset_kubectl_v20"
|
|
64
|
+
}
|
|
65
|
+
}
|
|
66
|
+
},
|
|
67
|
+
"@aws-cdk/asset-node-proxy-agent-v5": {
|
|
68
|
+
"targets": {
|
|
69
|
+
"dotnet": {
|
|
70
|
+
"namespace": "Amazon.CDK.Asset.NodeProxyAgentV5",
|
|
71
|
+
"packageId": "Amazon.CDK.Asset.NodeProxyAgentV5"
|
|
72
|
+
},
|
|
73
|
+
"go": {
|
|
74
|
+
"moduleName": "github.com/cdklabs/awscdk-asset-node-proxy-agent-go",
|
|
75
|
+
"packageName": "nodeproxyagentv5"
|
|
76
|
+
},
|
|
77
|
+
"java": {
|
|
78
|
+
"maven": {
|
|
79
|
+
"artifactId": "cdk-asset-node-proxy-agent-v5",
|
|
80
|
+
"groupId": "software.amazon.awscdk"
|
|
81
|
+
},
|
|
82
|
+
"package": "software.amazon.awscdk.cdk.asset.node.proxy.agent.v5"
|
|
83
|
+
},
|
|
84
|
+
"js": {
|
|
85
|
+
"npm": "@aws-cdk/asset-node-proxy-agent-v5"
|
|
86
|
+
},
|
|
87
|
+
"python": {
|
|
88
|
+
"distName": "aws-cdk.asset-node-proxy-agent-v5",
|
|
89
|
+
"module": "aws_cdk.asset_node_proxy_agent_v5"
|
|
90
|
+
}
|
|
91
|
+
}
|
|
92
|
+
},
|
|
15
93
|
"aws-cdk-lib": {
|
|
16
94
|
"submodules": {
|
|
17
95
|
"aws-cdk-lib.alexa_ask": {
|
|
@@ -2147,6 +2225,19 @@
|
|
|
2147
2225
|
}
|
|
2148
2226
|
}
|
|
2149
2227
|
},
|
|
2228
|
+
"aws-cdk-lib.aws_organizations": {
|
|
2229
|
+
"targets": {
|
|
2230
|
+
"dotnet": {
|
|
2231
|
+
"namespace": "Amazon.CDK.AWS.Organizations"
|
|
2232
|
+
},
|
|
2233
|
+
"java": {
|
|
2234
|
+
"package": "software.amazon.awscdk.services.organizations"
|
|
2235
|
+
},
|
|
2236
|
+
"python": {
|
|
2237
|
+
"module": "aws_cdk.aws_organizations"
|
|
2238
|
+
}
|
|
2239
|
+
}
|
|
2240
|
+
},
|
|
2150
2241
|
"aws-cdk-lib.aws_panorama": {
|
|
2151
2242
|
"targets": {
|
|
2152
2243
|
"dotnet": {
|
|
@@ -2316,6 +2407,19 @@
|
|
|
2316
2407
|
}
|
|
2317
2408
|
}
|
|
2318
2409
|
},
|
|
2410
|
+
"aws-cdk-lib.aws_resourceexplorer2": {
|
|
2411
|
+
"targets": {
|
|
2412
|
+
"dotnet": {
|
|
2413
|
+
"namespace": "Amazon.CDK.AWS.ResourceExplorer2"
|
|
2414
|
+
},
|
|
2415
|
+
"java": {
|
|
2416
|
+
"package": "software.amazon.awscdk.services.resourceexplorer2"
|
|
2417
|
+
},
|
|
2418
|
+
"python": {
|
|
2419
|
+
"module": "aws_cdk.aws_resourceexplorer2"
|
|
2420
|
+
}
|
|
2421
|
+
}
|
|
2422
|
+
},
|
|
2319
2423
|
"aws-cdk-lib.aws_resourcegroups": {
|
|
2320
2424
|
"targets": {
|
|
2321
2425
|
"dotnet": {
|
|
@@ -2550,6 +2654,19 @@
|
|
|
2550
2654
|
}
|
|
2551
2655
|
}
|
|
2552
2656
|
},
|
|
2657
|
+
"aws-cdk-lib.aws_scheduler": {
|
|
2658
|
+
"targets": {
|
|
2659
|
+
"dotnet": {
|
|
2660
|
+
"namespace": "Amazon.CDK.AWS.Scheduler"
|
|
2661
|
+
},
|
|
2662
|
+
"java": {
|
|
2663
|
+
"package": "software.amazon.awscdk.services.scheduler"
|
|
2664
|
+
},
|
|
2665
|
+
"python": {
|
|
2666
|
+
"module": "aws_cdk.aws_scheduler"
|
|
2667
|
+
}
|
|
2668
|
+
}
|
|
2669
|
+
},
|
|
2553
2670
|
"aws-cdk-lib.aws_sdb": {
|
|
2554
2671
|
"targets": {
|
|
2555
2672
|
"dotnet": {
|
|
@@ -3115,7 +3232,7 @@
|
|
|
3115
3232
|
"stability": "experimental"
|
|
3116
3233
|
},
|
|
3117
3234
|
"homepage": "https://github.com/aws/aws-cdk",
|
|
3118
|
-
"jsiiVersion": "1.
|
|
3235
|
+
"jsiiVersion": "1.71.0 (build f1f58ae)",
|
|
3119
3236
|
"keywords": [
|
|
3120
3237
|
"aws",
|
|
3121
3238
|
"cdk",
|
|
@@ -3136,7 +3253,7 @@
|
|
|
3136
3253
|
},
|
|
3137
3254
|
"name": "@aws-cdk/aws-gamelift-alpha",
|
|
3138
3255
|
"readme": {
|
|
3139
|
-
"markdown": "# Amazon GameLift Construct Library\n<!--BEGIN STABILITY BANNER-->\n\n---\n\n\n\n> The APIs of higher level constructs in this module are experimental and under active development.\n> They are subject to non-backward compatible changes or removal in any future version. These are\n> not subject to the [Semantic Versioning](https://semver.org/) model and breaking changes will be\n> announced in the release notes. This means that while you may use them, you may need to update\n> your source code when upgrading to a newer version of this package.\n\n---\n\n<!--END STABILITY BANNER-->\n\n[Amazon GameLift](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-intro.html) is a service used\nto deploy, operate, and scale dedicated, low-cost servers in the cloud for session-based multiplayer games. Built\non AWS global computing infrastructure, GameLift helps deliver high-performance, high-reliability game servers\nwhile dynamically scaling your resource usage to meet worldwide player demand.\n\nGameLift is composed of three main components:\n\n* GameLift FlexMatch which is a customizable matchmaking service for\nmultiplayer games. With FlexMatch, you can\nbuild a custom set of rules that defines what a multiplayer match looks like\nfor your game, and determines how to\nevaluate and select compatible players for each match. You can also customize\nkey aspects of the matchmaking\nprocess to fit your game, including fine-tuning the matching algorithm.\n\n* GameLift hosting for custom or realtime servers which helps you deploy,\noperate, and scale dedicated game servers. It regulates the resources needed to\nhost games, finds available game servers to host new game sessions, and puts\nplayers into games.\n\n* GameLift FleetIQ to optimize the use of low-cost Amazon Elastic Compute Cloud\n(Amazon EC2) Spot Instances for cloud-based game hosting. With GameLift\nFleetIQ, you can work directly with your hosting resources in Amazon EC2 and\nAmazon EC2 Auto Scaling while taking advantage of GameLift optimizations to\ndeliver inexpensive, resilient game hosting for your players\n\nThis 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\nconfiguration or game server fleet management system.\n\n## GameLift Hosting\n\n### Defining a GameLift Fleet\n\nGameLift helps you deploy, operate, and scale dedicated game servers for\nsession-based multiplayer games. It helps you regulate the resources needed to\nhost your games, finds available game servers to host new game sessions, and\nputs players into games.\n\n### Uploading builds and scripts to GameLift\n\nBefore deploying your GameLift-enabled multiplayer game servers for hosting with the GameLift service, you need to upload\nyour game server files. This section provides guidance on preparing and uploading custom game server build\nfiles or Realtime Servers server script files. When you upload files, you create a GameLift build or script resource, which\nyou then deploy on fleets of hosting resources.\n\nTo 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).\n\n#### Upload a custom server build to GameLift\n\nBefore uploading your configured game server to GameLift for hosting, package the game build files into a build directory.\nThis directory must include all components required to run your game servers and host game sessions, including the following:\n\n* Game server binaries – The binary files required to run the game server. A build can include binaries for multiple game\nservers 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).\n\n* Dependencies – Any dependent files that your game server executables require to run. Examples include assets, configuration\nfiles, and dependent libraries.\n\n* Install script – A script file to handle tasks that are required to fully install your game build on GameLift hosting\nservers. Place this file at the root of the build directory. GameLift runs the install script as part of fleet creation.\n\nYou can set up any application in your build, including your install script, to access your resources securely on other AWS\nservices.\n\n```ts\ndeclare const bucket: s3.Bucket;\nnew gamelift.Build(this, 'Build', {\n content: gamelift.Content.fromBucket(bucket, \"sample-asset-key\")\n});\n```\n\n#### Upload a realtime server Script\n\nYour server script can include one or more files combined into a single .zip file for uploading. The .zip file must contain\nall files that your script needs to run.\n\nYou can store your zipped script files in either a local file directory or in an Amazon Simple Storage Service (Amazon S3)\nbucket or defines a directory asset which is archived as a .zip file and uploaded to S3 during deployment.\n\nAfter you create the script resource, GameLift deploys the script with a new Realtime Servers fleet. GameLift installs your\nserver script onto each instance in the fleet, placing the script files in `/local/game`.\n\n```ts\ndeclare const bucket: s3.Bucket;\nnew gamelift.Script(this, 'Script', {\n content: gamelift.Content.fromBucket(bucket, \"sample-asset-key\")\n});\n```\n"
|
|
3256
|
+
"markdown": "# Amazon GameLift Construct Library\n<!--BEGIN STABILITY BANNER-->\n\n---\n\n\n\n> The APIs of higher level constructs in this module are experimental and under active development.\n> They are subject to non-backward compatible changes or removal in any future version. These are\n> not subject to the [Semantic Versioning](https://semver.org/) model and breaking changes will be\n> announced in the release notes. This means that while you may use them, you may need to update\n> your source code when upgrading to a newer version of this package.\n\n---\n\n<!--END STABILITY BANNER-->\n\n[Amazon GameLift](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-intro.html) is a service used\nto deploy, operate, and scale dedicated, low-cost servers in the cloud for session-based multiplayer games. Built\non AWS global computing infrastructure, GameLift helps deliver high-performance, high-reliability game servers\nwhile dynamically scaling your resource usage to meet worldwide player demand.\n\nGameLift is composed of three main components:\n\n* GameLift FlexMatch which is a customizable matchmaking service for\nmultiplayer games. With FlexMatch, you can\nbuild a custom set of rules that defines what a multiplayer match looks like\nfor your game, and determines how to\nevaluate and select compatible players for each match. You can also customize\nkey aspects of the matchmaking\nprocess to fit your game, including fine-tuning the matching algorithm.\n\n* GameLift hosting for custom or realtime servers which helps you deploy,\noperate, and scale dedicated game servers. It regulates the resources needed to\nhost games, finds available game servers to host new game sessions, and puts\nplayers into games.\n\n* GameLift FleetIQ to optimize the use of low-cost Amazon Elastic Compute Cloud\n(Amazon EC2) Spot Instances for cloud-based game hosting. With GameLift\nFleetIQ, you can work directly with your hosting resources in Amazon EC2 and\nAmazon EC2 Auto Scaling while taking advantage of GameLift optimizations to\ndeliver inexpensive, resilient game hosting for your players\n\nThis 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\nconfiguration or game server fleet management system.\n\n## GameLift Hosting\n\n### Uploading builds and scripts to GameLift\n\nBefore deploying your GameLift-enabled multiplayer game servers for hosting with the GameLift service, you need to upload\nyour game server files. This section provides guidance on preparing and uploading custom game server build\nfiles or Realtime Servers server script files. When you upload files, you create a GameLift build or script resource, which\nyou then deploy on fleets of hosting resources.\n\nTo 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).\n\n#### Upload a custom server build to GameLift\n\nBefore uploading your configured game server to GameLift for hosting, package the game build files into a build directory.\nThis directory must include all components required to run your game servers and host game sessions, including the following:\n\n* Game server binaries – The binary files required to run the game server. A build can include binaries for multiple game\nservers 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).\n\n* Dependencies – Any dependent files that your game server executables require to run. Examples include assets, configuration\nfiles, and dependent libraries.\n\n* Install script – A script file to handle tasks that are required to fully install your game build on GameLift hosting\nservers. Place this file at the root of the build directory. GameLift runs the install script as part of fleet creation.\n\nYou can set up any application in your build, including your install script, to access your resources securely on other AWS\nservices.\n\n```ts\ndeclare const bucket: s3.Bucket;\nnew gamelift.Build(this, 'Build', {\n content: gamelift.Content.fromBucket(bucket, \"sample-asset-key\")\n});\n```\n\n#### Upload a realtime server Script\n\nYour server script can include one or more files combined into a single .zip file for uploading. The .zip file must contain\nall files that your script needs to run.\n\nYou can store your zipped script files in either a local file directory or in an Amazon Simple Storage Service (Amazon S3)\nbucket or defines a directory asset which is archived as a .zip file and uploaded to S3 during deployment.\n\nAfter you create the script resource, GameLift deploys the script with a new Realtime Servers fleet. GameLift installs your\nserver script onto each instance in the fleet, placing the script files in `/local/game`.\n\n```ts\ndeclare const bucket: s3.Bucket;\nnew gamelift.Script(this, 'Script', {\n content: gamelift.Content.fromBucket(bucket, \"sample-asset-key\")\n});\n```\n\n### Defining a GameLift Fleet\n\n#### Creating a custom game server fleet\n\nYour uploaded game servers are hosted on GameLift virtual computing resources,\ncalled instances. You set up your hosting resources by creating a fleet of\ninstances and deploying them to run your game servers. You can design a fleet\nto fit your game's needs.\n\n```ts\nnew gamelift.BuildFleet(this, 'Game server fleet', {\n fleetName: 'test-fleet',\n content: gamelift.Build.fromAsset(this, 'Build', path.join(__dirname, 'CustomerGameServer')),\n instanceType: ec2.InstanceType.of(ec2.InstanceClass.C4, ec2.InstanceSize.LARGE),\n runtimeConfiguration: {\n serverProcesses: [{\n launchPath: 'test-launch-path',\n }],\n },\n});\n```\n\n### Managing game servers launch configuration\n\nGameLift uses a fleet's runtime configuration to determine the type and number\nof processes to run on each instance in the fleet. At a minimum, a runtime\nconfiguration contains one server process configuration that represents one\ngame server executable. You can also define additional server process\nconfigurations to run other types of processes related to your game. Each\nserver process configuration contains the following information:\n\n* The file name and path of an executable in your game build.\n\n* Optionally Parameters to pass to the process on launch.\n\n* The number of processes to run concurrently.\n\nA GameLift instance is limited to 50 processes running concurrently.\n\n```ts\ndeclare const build: gamelift.Build;\n// Server processes can be delcared in a declarative way through the constructor\nconst fleet = new gamelift.BuildFleet(this, 'Game server fleet', {\n fleetName: 'test-fleet',\n content: build,\n instanceType: ec2.InstanceType.of(ec2.InstanceClass.C4, ec2.InstanceSize.LARGE),\n runtimeConfiguration: {\n serverProcesses: [{\n launchPath: '/local/game/GameLiftExampleServer.x86_64',\n parameters: '-logFile /local/game/logs/myserver1935.log -port 1935',\n concurrentExecutions: 100,\n }]\n }\n});\n```\n\nSee [Managing how game servers are launched for hosting](https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-multiprocess.html)\nin the *Amazon GameLift Developer Guide*.\n\n### Defining an instance type\n\nGameLift uses Amazon Elastic Compute Cloud (Amazon EC2) resources, called\ninstances, to deploy your game servers and host game sessions for your players.\nWhen setting up a new fleet, you decide what type of instances your game needs\nand how to run game server processes on them (using a runtime configuration). All instances in a fleet use the same type of resources and the same runtime\nconfiguration. You can edit a fleet's runtime configuration and other fleet\nproperties, but the type of resources cannot be changed.\n\n```ts\ndeclare const build: gamelift.Build;\nnew gamelift.BuildFleet(this, 'Game server fleet', {\n fleetName: 'test-fleet',\n content: build,\n instanceType: ec2.InstanceType.of(ec2.InstanceClass.C5, ec2.InstanceSize.LARGE),\n runtimeConfiguration: {\n serverProcesses: [{\n launchPath: '/local/game/GameLiftExampleServer.x86_64',\n }]\n }\n});\n```\n\n### Using Spot instances\n\nWhen setting up your hosting resources, you have the option of using Spot\nInstances, On-Demand Instances, or a combination.\n\nBy default, fleet are using on demand capacity.\n\n```ts\ndeclare const build: gamelift.Build;\nnew gamelift.BuildFleet(this, 'Game server fleet', {\n fleetName: 'test-fleet',\n content: build,\n instanceType: ec2.InstanceType.of(ec2.InstanceClass.C4, ec2.InstanceSize.LARGE),\n runtimeConfiguration: {\n serverProcesses: [{\n launchPath: '/local/game/GameLiftExampleServer.x86_64',\n }]\n },\n useSpot: true\n});\n```\n\n### Allowing Ingress traffic\n\nThe allowed IP address ranges and port settings that allow inbound traffic to\naccess game sessions on this fleet.\n\nNew game sessions are assigned an IP address/port number combination, which\nmust fall into the fleet's allowed ranges. Fleets with custom game builds must\nhave permissions explicitly set. For Realtime Servers fleets, GameLift\nautomatically opens two port ranges, one for TCP messaging and one for UDP.\n\n```ts\ndeclare const build: gamelift.Build;\n\nconst fleet = new gamelift.BuildFleet(this, 'Game server fleet', {\n fleetName: 'test-fleet',\n content: build,\n instanceType: ec2.InstanceType.of(ec2.InstanceClass.C4, ec2.InstanceSize.LARGE),\n runtimeConfiguration: {\n serverProcesses: [{\n launchPath: '/local/game/GameLiftExampleServer.x86_64',\n }]\n },\n ingressRules: [{\n source: gamelift.Peer.anyIpv4(),\n port: gamelift.Port.tcpRange(100, 200),\n }]\n});\n// Allowing a specific CIDR for port 1111 on UDP Protocol\nfleet.addIngressRule(gamelift.Peer.ipv4('1.2.3.4/32'), gamelift.Port.udp(1111));\n```\n\n### Managing locations\n\nA single Amazon GameLift fleet has a home Region by default (the Region you\ndeploy it to), but it can deploy resources to any number of GameLift supported\nRegions. Select Regions based on where your players are located and your\nlatency needs.\n\nBy default, home region is used as default location but we can add new locations if needed and define desired capacity\n\n```ts\ndeclare const build: gamelift.Build;\n\n// Locations can be added directly through constructor\nconst fleet = new gamelift.BuildFleet(this, 'Game server fleet', {\n fleetName: 'test-fleet',\n content: build,\n instanceType: ec2.InstanceType.of(ec2.InstanceClass.C4, ec2.InstanceSize.LARGE),\n runtimeConfiguration: {\n serverProcesses: [{\n launchPath: '/local/game/GameLiftExampleServer.x86_64',\n }]\n },\n locations: [ {\n region: 'eu-west-1',\n capacity: {\n desiredCapacity: 5,\n minSize: 2,\n maxSize: 10\n }\n }, {\n region: 'us-east-1',\n capacity: {\n desiredCapacity: 5,\n minSize: 2,\n maxSize: 10\n }\n }]\n});\n\n// Or through dedicated methods\nfleet.addLocation('ap-southeast-1', 5, 2, 10);\n```\n\n### Specifying an IAM role for a Fleet\n\nSome GameLift features require you to extend limited access to your AWS\nresources. This is done by creating an AWS IAM role. The GameLift Fleet class\nautomatically created an IAM role with all the minimum necessary permissions\nfor GameLift to access your ressources. If you wish, you may\nspecify your own IAM role.\n\n```ts\ndeclare const build: gamelift.Build;\nconst role = new iam.Role(this, 'Role', {\n assumedBy: new iam.CompositePrincipal(new iam.ServicePrincipal('gamelift.amazonaws.com'))\n});\nrole.addManagedPolicy(iam.ManagedPolicy.fromAwsManagedPolicyName('CloudWatchAgentServerPolicy'));\n\nconst fleet = new gamelift.BuildFleet(this, 'Game server fleet', {\n fleetName: 'test-fleet',\n content: build,\n instanceType: ec2.InstanceType.of(ec2.InstanceClass.C5, ec2.InstanceSize.LARGE),\n runtimeConfiguration: {\n serverProcesses: [{\n launchPath: '/local/game/GameLiftExampleServer.x86_64',\n }]\n },\n role: role\n});\n\n// Actions can also be grantted through dedicated method\nfleet.grant(role, 'gamelift:ListFleets');\n```\n\n### Monitoring your Fleet\n\nGameLift is integrated with CloudWatch, so you can monitor the performance of\nyour game servers via logs and metrics.\n\n#### Metrics\n\nGameLift Fleet sends metrics to CloudWatch so that you can collect and analyze\nthe activity of your Fleet, including game and player sessions and server\nprocesses.\n\nYou can then use CloudWatch alarms to alert you, for example, when matches has\nbeen rejected (potential matches that were rejected by at least one player\nsince the last report) exceed a certain thresold which could means that you may\nhave an issue in your matchmaking rules.\n\nCDK provides methods for accessing GameLift Fleet metrics with default configuration,\nsuch as `metricActiveInstances`, or `metricIdleInstances` (see [`IFleet`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-gamelift.IFleet.html)\nfor a full list). CDK also provides a generic `metric` method that can be used\nto produce metric configurations for any metric provided by GameLift Fleet,\nGame sessions or server processes; the configurations are pre-populated with\nthe correct dimensions for the matchmaking configuration.\n\n```ts\ndeclare const fleet: gamelift.BuildFleet;\n// Alarm that triggers when the per-second average of not used instances exceed 10%\nconst instancesUsedRatio = new cloudwatch.MathExpression({\n expression: '1 - (activeInstances / idleInstances)',\n usingMetrics: {\n activeInstances: fleet.metric('ActiveInstances', { statistic: cloudwatch.Statistic.SUM }),\n idleInstances: fleet.metricIdleInstances(),\n },\n});\nnew cloudwatch.Alarm(this, 'Alarm', {\n metric: instancesUsedRatio,\n threshold: 0.1,\n evaluationPeriods: 3,\n});\n```\n\nSee: [Monitoring Using CloudWatch Metrics](https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html)\nin the *Amazon GameLift Developer Guide*.\n\n## GameLift FleetIQ\n\nThe GameLift FleetIQ solution is a game hosting layer that supplements the full\nset of computing resource management tools that you get with Amazon EC2 and\nAuto Scaling. This solution lets you directly manage your Amazon EC2 and Auto\nScaling resources and integrate as needed with other AWS services.\n\n### Defining a Game Server Group\n\nWhen using GameLift FleetIQ, you prepare to launch Amazon EC2 instances as\nusual: make an Amazon Machine Image (AMI) with your game server software,\ncreate an Amazon EC2 launch template, and define configuration settings for an\nAuto Scaling group. However, instead of creating an Auto Scaling group\ndirectly, you create a GameLift FleetIQ game server group with your Amazon EC2\nand Auto Scaling resources and configuration. All game server groups must have\nat least two instance types defined for it.\n\nOnce a game server group and Auto Scaling group are up and running with\ninstances deployed, when updating a Game Server Group instance, only certain\nproperties in the Auto Scaling group may be overwrite. For all other Auto\nScaling group properties, such as MinSize, MaxSize, and LaunchTemplate, you can\nmodify these directly on the Auto Scaling group using the AWS Console or\ndedicated Api.\n\n```ts\ndeclare const launchTemplate: ec2.ILaunchTemplate;\ndeclare const vpc: ec2.IVpc;\n\nnew gamelift.GameServerGroup(this, 'Game server group', {\n gameServerGroupName: 'sample-gameservergroup-name',\n instanceDefinitions: [{\n instanceType: ec2.InstanceType.of(ec2.InstanceClass.C5, ec2.InstanceSize.LARGE),\n },\n {\n instanceType: ec2.InstanceType.of(ec2.InstanceClass.C4, ec2.InstanceSize.LARGE),\n }],\n launchTemplate: launchTemplate,\n vpc: vpc\n});\n```\n\nSee [Manage game server groups](https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-integrate-gameservergroup.html)\nin the *Amazon GameLift FleetIQ Developer Guide*.\n\n### Scaling Policy\n\nThe scaling policy uses the metric `PercentUtilizedGameServers` to maintain a\nbuffer of idle game servers that can immediately accommodate new games and\nplayers.\n\n```ts\ndeclare const launchTemplate: ec2.ILaunchTemplate;\ndeclare const vpc: ec2.IVpc;\n\nnew gamelift.GameServerGroup(this, 'Game server group', {\n gameServerGroupName: 'sample-gameservergroup-name',\n instanceDefinitions: [{\n instanceType: ec2.InstanceType.of(ec2.InstanceClass.C5, ec2.InstanceSize.LARGE),\n },\n {\n instanceType: ec2.InstanceType.of(ec2.InstanceClass.C4, ec2.InstanceSize.LARGE),\n }],\n launchTemplate: launchTemplate,\n vpc: vpc,\n autoScalingPolicy: {\n estimatedInstanceWarmup: Duration.minutes(5),\n targetTrackingConfiguration: 5\n }\n});\n```\n\nSee [Manage game server groups](https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-integrate-gameservergroup.html)\nin the *Amazon GameLift FleetIQ Developer Guide*.\n\n### Specifying an IAM role for GameLift\n\nThe GameLift FleetIQ class automatically creates an IAM role with all the minimum necessary\npermissions for GameLift to access your Amazon EC2 Auto Scaling groups. If you wish, you may\nspecify your own IAM role. It must have the correct permissions, or FleetIQ creation or ressource usage may fail.\n\n```ts\ndeclare const launchTemplate: ec2.ILaunchTemplate;\ndeclare const vpc: ec2.IVpc;\n\nconst role = new iam.Role(this, 'Role', {\n assumedBy: new iam.CompositePrincipal(new iam.ServicePrincipal('gamelift.amazonaws.com'),\n new iam.ServicePrincipal('autoscaling.amazonaws.com'))\n});\nrole.addManagedPolicy(iam.ManagedPolicy.fromAwsManagedPolicyName('GameLiftGameServerGroupPolicy'));\n\nnew gamelift.GameServerGroup(this, 'Game server group', {\n gameServerGroupName: 'sample-gameservergroup-name',\n instanceDefinitions: [{\n instanceType: ec2.InstanceType.of(ec2.InstanceClass.C5, ec2.InstanceSize.LARGE),\n },\n {\n instanceType: ec2.InstanceType.of(ec2.InstanceClass.C4, ec2.InstanceSize.LARGE),\n }],\n launchTemplate: launchTemplate,\n vpc: vpc,\n role: role\n});\n```\n\nSee [Controlling Access](https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-iam-permissions-roles.html)\nin the *Amazon GameLift FleetIQ Developer Guide*.\n\n### Specifying VPC Subnets\n\nGameLift FleetIQ use by default, all supported GameLift FleetIQ Availability\nZones in your chosen region. You can override this parameter to specify VPCs\nsubnets that you've set up.\n\nThis property cannot be updated after the game server group is created, and the\ncorresponding Auto Scaling group will always use the property value that is set\nwith this request, even if the Auto Scaling group is updated directly.\n\n```ts\ndeclare const launchTemplate: ec2.ILaunchTemplate;\ndeclare const vpc: ec2.IVpc;\n\nnew gamelift.GameServerGroup(this, 'GameServerGroup', {\n gameServerGroupName: 'sample-gameservergroup-name',\n instanceDefinitions: [{\n instanceType: ec2.InstanceType.of(ec2.InstanceClass.C5, ec2.InstanceSize.LARGE),\n },\n {\n instanceType: ec2.InstanceType.of(ec2.InstanceClass.C4, ec2.InstanceSize.LARGE),\n }],\n launchTemplate: launchTemplate,\n vpc: vpc,\n vpcSubnets: { subnetType: ec2.SubnetType.PUBLIC }\n});\n```\n\n### Monitoring\n\nGameLift FleetIQ sends metrics to CloudWatch so that you can collect and\nanalyze the activity of your Game server fleet, including the number of\nutilized game servers, and the number of game server interruption due to\nlimited Spot availability.\n\nYou can then use CloudWatch alarms to alert you, for example, when the portion\nof game servers that are currently supporting game executions exceed a certain\nthresold which could means that your autoscaling policy need to be adjust to\nadd more instances to match with player demand.\n\nCDK provides a generic `metric` method that can be used\nto produce metric configurations for any metric provided by GameLift FleetIQ;\nthe configurations are pre-populated with the correct dimensions for the\nmatchmaking configuration.\n\n```ts\ndeclare const gameServerGroup: gamelift.IGameServerGroup;\n// Alarm that triggers when the percent of utilized game servers exceed 90%\nnew cloudwatch.Alarm(this, 'Alarm', {\n metric: gameServerGroup.metric('UtilizedGameServers'),\n threshold: 0.9,\n evaluationPeriods: 2,\n});\n```\n\nSee: [Monitoring with CloudWatch](https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-metrics.html)\nin the *Amazon GameLift FleetIQ Developer Guide*.\n"
|
|
3140
3257
|
},
|
|
3141
3258
|
"repository": {
|
|
3142
3259
|
"directory": "packages/individual-packages/aws-gamelift",
|
|
@@ -3192,7 +3309,7 @@
|
|
|
3192
3309
|
},
|
|
3193
3310
|
"locationInModule": {
|
|
3194
3311
|
"filename": "lib/content.ts",
|
|
3195
|
-
"line":
|
|
3312
|
+
"line": 88
|
|
3196
3313
|
},
|
|
3197
3314
|
"parameters": [
|
|
3198
3315
|
{
|
|
@@ -3216,7 +3333,7 @@
|
|
|
3216
3333
|
"kind": "class",
|
|
3217
3334
|
"locationInModule": {
|
|
3218
3335
|
"filename": "lib/content.ts",
|
|
3219
|
-
"line":
|
|
3336
|
+
"line": 82
|
|
3220
3337
|
},
|
|
3221
3338
|
"methods": [
|
|
3222
3339
|
{
|
|
@@ -3226,7 +3343,7 @@
|
|
|
3226
3343
|
},
|
|
3227
3344
|
"locationInModule": {
|
|
3228
3345
|
"filename": "lib/content.ts",
|
|
3229
|
-
"line":
|
|
3346
|
+
"line": 92
|
|
3230
3347
|
},
|
|
3231
3348
|
"name": "bind",
|
|
3232
3349
|
"overrides": "@aws-cdk/aws-gamelift-alpha.Content",
|
|
@@ -3238,9 +3355,9 @@
|
|
|
3238
3355
|
}
|
|
3239
3356
|
},
|
|
3240
3357
|
{
|
|
3241
|
-
"name": "
|
|
3358
|
+
"name": "role",
|
|
3242
3359
|
"type": {
|
|
3243
|
-
"fqn": "aws-cdk-lib.aws_iam.
|
|
3360
|
+
"fqn": "aws-cdk-lib.aws_iam.IRole"
|
|
3244
3361
|
}
|
|
3245
3362
|
}
|
|
3246
3363
|
],
|
|
@@ -3261,7 +3378,7 @@
|
|
|
3261
3378
|
"immutable": true,
|
|
3262
3379
|
"locationInModule": {
|
|
3263
3380
|
"filename": "lib/content.ts",
|
|
3264
|
-
"line":
|
|
3381
|
+
"line": 88
|
|
3265
3382
|
},
|
|
3266
3383
|
"name": "path",
|
|
3267
3384
|
"type": {
|
|
@@ -3271,6 +3388,106 @@
|
|
|
3271
3388
|
],
|
|
3272
3389
|
"symbolId": "lib/content:AssetContent"
|
|
3273
3390
|
},
|
|
3391
|
+
"@aws-cdk/aws-gamelift-alpha.AutoScalingPolicy": {
|
|
3392
|
+
"assembly": "@aws-cdk/aws-gamelift-alpha",
|
|
3393
|
+
"datatype": true,
|
|
3394
|
+
"docs": {
|
|
3395
|
+
"remarks": "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.",
|
|
3396
|
+
"stability": "experimental",
|
|
3397
|
+
"summary": "Configuration settings for intelligent automatic scaling that uses target tracking.",
|
|
3398
|
+
"example": "declare const launchTemplate: ec2.ILaunchTemplate;\ndeclare const vpc: ec2.IVpc;\n\nnew gamelift.GameServerGroup(this, 'Game server group', {\n gameServerGroupName: 'sample-gameservergroup-name',\n instanceDefinitions: [{\n instanceType: ec2.InstanceType.of(ec2.InstanceClass.C5, ec2.InstanceSize.LARGE),\n },\n {\n instanceType: ec2.InstanceType.of(ec2.InstanceClass.C4, ec2.InstanceSize.LARGE),\n }],\n launchTemplate: launchTemplate,\n vpc: vpc,\n autoScalingPolicy: {\n estimatedInstanceWarmup: Duration.minutes(5),\n targetTrackingConfiguration: 5\n }\n});",
|
|
3399
|
+
"custom": {
|
|
3400
|
+
"exampleMetadata": "infused"
|
|
3401
|
+
}
|
|
3402
|
+
},
|
|
3403
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.AutoScalingPolicy",
|
|
3404
|
+
"kind": "interface",
|
|
3405
|
+
"locationInModule": {
|
|
3406
|
+
"filename": "lib/game-server-group.ts",
|
|
3407
|
+
"line": 13
|
|
3408
|
+
},
|
|
3409
|
+
"name": "AutoScalingPolicy",
|
|
3410
|
+
"properties": [
|
|
3411
|
+
{
|
|
3412
|
+
"abstract": true,
|
|
3413
|
+
"docs": {
|
|
3414
|
+
"remarks": "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.\n\nAs player usage changes, the policy triggers to adjust the game server group capacity so that the metric returns to the target value.",
|
|
3415
|
+
"stability": "experimental",
|
|
3416
|
+
"summary": "Settings for a target-based scaling policy applied to Auto Scaling group."
|
|
3417
|
+
},
|
|
3418
|
+
"immutable": true,
|
|
3419
|
+
"locationInModule": {
|
|
3420
|
+
"filename": "lib/game-server-group.ts",
|
|
3421
|
+
"line": 28
|
|
3422
|
+
},
|
|
3423
|
+
"name": "targetTrackingConfiguration",
|
|
3424
|
+
"type": {
|
|
3425
|
+
"primitive": "number"
|
|
3426
|
+
}
|
|
3427
|
+
},
|
|
3428
|
+
{
|
|
3429
|
+
"abstract": true,
|
|
3430
|
+
"docs": {
|
|
3431
|
+
"default": "no instance warmup duration settled",
|
|
3432
|
+
"remarks": "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.",
|
|
3433
|
+
"stability": "experimental",
|
|
3434
|
+
"summary": "Length of time, it takes for a new instance to start new game server processes and register with GameLift FleetIQ."
|
|
3435
|
+
},
|
|
3436
|
+
"immutable": true,
|
|
3437
|
+
"locationInModule": {
|
|
3438
|
+
"filename": "lib/game-server-group.ts",
|
|
3439
|
+
"line": 20
|
|
3440
|
+
},
|
|
3441
|
+
"name": "estimatedInstanceWarmup",
|
|
3442
|
+
"optional": true,
|
|
3443
|
+
"type": {
|
|
3444
|
+
"fqn": "aws-cdk-lib.Duration"
|
|
3445
|
+
}
|
|
3446
|
+
}
|
|
3447
|
+
],
|
|
3448
|
+
"symbolId": "lib/game-server-group:AutoScalingPolicy"
|
|
3449
|
+
},
|
|
3450
|
+
"@aws-cdk/aws-gamelift-alpha.BalancingStrategy": {
|
|
3451
|
+
"assembly": "@aws-cdk/aws-gamelift-alpha",
|
|
3452
|
+
"docs": {
|
|
3453
|
+
"stability": "experimental",
|
|
3454
|
+
"summary": "Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group."
|
|
3455
|
+
},
|
|
3456
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.BalancingStrategy",
|
|
3457
|
+
"kind": "enum",
|
|
3458
|
+
"locationInModule": {
|
|
3459
|
+
"filename": "lib/game-server-group.ts",
|
|
3460
|
+
"line": 73
|
|
3461
|
+
},
|
|
3462
|
+
"members": [
|
|
3463
|
+
{
|
|
3464
|
+
"docs": {
|
|
3465
|
+
"remarks": "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.\nUntil then, no new instances are started, and the existing nonviable Spot Instances are terminated (after current gameplay ends) and are not replaced.",
|
|
3466
|
+
"stability": "experimental",
|
|
3467
|
+
"summary": "Only Spot Instances are used in the game server group."
|
|
3468
|
+
},
|
|
3469
|
+
"name": "SPOT_ONLY"
|
|
3470
|
+
},
|
|
3471
|
+
{
|
|
3472
|
+
"docs": {
|
|
3473
|
+
"remarks": "If Spot Instances are unavailable, the game server group continues to provide hosting capacity by falling back to On-Demand Instances.\nExisting nonviable Spot Instances are terminated (after current gameplay ends) and are replaced with new On-Demand Instances.",
|
|
3474
|
+
"stability": "experimental",
|
|
3475
|
+
"summary": "Spot Instances are used whenever available in the game server group."
|
|
3476
|
+
},
|
|
3477
|
+
"name": "SPOT_PREFERRED"
|
|
3478
|
+
},
|
|
3479
|
+
{
|
|
3480
|
+
"docs": {
|
|
3481
|
+
"remarks": "No Spot Instances are used, even when available, while this balancing strategy is in force.",
|
|
3482
|
+
"stability": "experimental",
|
|
3483
|
+
"summary": "Only On-Demand Instances are used in the game server group."
|
|
3484
|
+
},
|
|
3485
|
+
"name": "ON_DEMAND_ONLY"
|
|
3486
|
+
}
|
|
3487
|
+
],
|
|
3488
|
+
"name": "BalancingStrategy",
|
|
3489
|
+
"symbolId": "lib/game-server-group:BalancingStrategy"
|
|
3490
|
+
},
|
|
3274
3491
|
"@aws-cdk/aws-gamelift-alpha.Build": {
|
|
3275
3492
|
"assembly": "@aws-cdk/aws-gamelift-alpha",
|
|
3276
3493
|
"base": "@aws-cdk/aws-gamelift-alpha.BuildBase",
|
|
@@ -3684,65 +3901,372 @@
|
|
|
3684
3901
|
],
|
|
3685
3902
|
"symbolId": "lib/build:BuildBase"
|
|
3686
3903
|
},
|
|
3687
|
-
"@aws-cdk/aws-gamelift-alpha.
|
|
3904
|
+
"@aws-cdk/aws-gamelift-alpha.BuildFleet": {
|
|
3688
3905
|
"assembly": "@aws-cdk/aws-gamelift-alpha",
|
|
3689
|
-
"
|
|
3906
|
+
"base": "@aws-cdk/aws-gamelift-alpha.FleetBase",
|
|
3690
3907
|
"docs": {
|
|
3691
|
-
"stability": "experimental",
|
|
3692
|
-
"summary": "Properties for a new build.",
|
|
3693
|
-
"example": "declare const bucket: s3.Bucket;\nnew gamelift.Build(this, 'Build', {\n content: gamelift.Content.fromBucket(bucket, \"sample-asset-key\")\n});",
|
|
3694
3908
|
"custom": {
|
|
3909
|
+
"resource": "AWS::GameLift::Fleet",
|
|
3695
3910
|
"exampleMetadata": "infused"
|
|
3696
|
-
}
|
|
3911
|
+
},
|
|
3912
|
+
"remarks": "A fleet uses the configuration and scaling logic that you define to run your game server build. You can use a fleet directly without a queue.\nYou can also associate multiple fleets with a GameLift queue.\n\nFor example, you can use Spot Instance fleets configured with your preferred locations, along with a backup On-Demand Instance fleet with the same locations.\nUsing multiple Spot Instance fleets of different instance types reduces the chance of needing On-Demand Instance placement.",
|
|
3913
|
+
"stability": "experimental",
|
|
3914
|
+
"summary": "A fleet contains Amazon Elastic Compute Cloud (Amazon EC2) instances that GameLift hosts.",
|
|
3915
|
+
"example": "declare const build: gamelift.Build;\n// Server processes can be delcared in a declarative way through the constructor\nconst fleet = new gamelift.BuildFleet(this, 'Game server fleet', {\n fleetName: 'test-fleet',\n content: build,\n instanceType: ec2.InstanceType.of(ec2.InstanceClass.C4, ec2.InstanceSize.LARGE),\n runtimeConfiguration: {\n serverProcesses: [{\n launchPath: '/local/game/GameLiftExampleServer.x86_64',\n parameters: '-logFile /local/game/logs/myserver1935.log -port 1935',\n concurrentExecutions: 100,\n }]\n }\n});"
|
|
3697
3916
|
},
|
|
3698
|
-
"fqn": "@aws-cdk/aws-gamelift-alpha.
|
|
3699
|
-
"
|
|
3917
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.BuildFleet",
|
|
3918
|
+
"initializer": {
|
|
3919
|
+
"docs": {
|
|
3920
|
+
"stability": "experimental"
|
|
3921
|
+
},
|
|
3922
|
+
"locationInModule": {
|
|
3923
|
+
"filename": "lib/build-fleet.ts",
|
|
3924
|
+
"line": 90
|
|
3925
|
+
},
|
|
3926
|
+
"parameters": [
|
|
3927
|
+
{
|
|
3928
|
+
"name": "scope",
|
|
3929
|
+
"type": {
|
|
3930
|
+
"fqn": "constructs.Construct"
|
|
3931
|
+
}
|
|
3932
|
+
},
|
|
3933
|
+
{
|
|
3934
|
+
"name": "id",
|
|
3935
|
+
"type": {
|
|
3936
|
+
"primitive": "string"
|
|
3937
|
+
}
|
|
3938
|
+
},
|
|
3939
|
+
{
|
|
3940
|
+
"name": "props",
|
|
3941
|
+
"type": {
|
|
3942
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.BuildFleetProps"
|
|
3943
|
+
}
|
|
3944
|
+
}
|
|
3945
|
+
]
|
|
3946
|
+
},
|
|
3947
|
+
"interfaces": [
|
|
3948
|
+
"@aws-cdk/aws-gamelift-alpha.IBuildFleet"
|
|
3949
|
+
],
|
|
3950
|
+
"kind": "class",
|
|
3700
3951
|
"locationInModule": {
|
|
3701
|
-
"filename": "lib/build.ts",
|
|
3702
|
-
"line":
|
|
3952
|
+
"filename": "lib/build-fleet.ts",
|
|
3953
|
+
"line": 47
|
|
3703
3954
|
},
|
|
3704
|
-
"
|
|
3705
|
-
"properties": [
|
|
3955
|
+
"methods": [
|
|
3706
3956
|
{
|
|
3707
|
-
"abstract": true,
|
|
3708
3957
|
"docs": {
|
|
3709
3958
|
"stability": "experimental",
|
|
3710
|
-
"summary": "
|
|
3959
|
+
"summary": "Import an existing fleet from its ARN."
|
|
3711
3960
|
},
|
|
3712
|
-
"immutable": true,
|
|
3713
3961
|
"locationInModule": {
|
|
3714
|
-
"filename": "lib/build.ts",
|
|
3715
|
-
"line":
|
|
3962
|
+
"filename": "lib/build-fleet.ts",
|
|
3963
|
+
"line": 59
|
|
3716
3964
|
},
|
|
3717
|
-
"name": "
|
|
3718
|
-
"
|
|
3719
|
-
|
|
3720
|
-
|
|
3965
|
+
"name": "fromBuildFleetArn",
|
|
3966
|
+
"parameters": [
|
|
3967
|
+
{
|
|
3968
|
+
"name": "scope",
|
|
3969
|
+
"type": {
|
|
3970
|
+
"fqn": "constructs.Construct"
|
|
3971
|
+
}
|
|
3972
|
+
},
|
|
3973
|
+
{
|
|
3974
|
+
"name": "id",
|
|
3975
|
+
"type": {
|
|
3976
|
+
"primitive": "string"
|
|
3977
|
+
}
|
|
3978
|
+
},
|
|
3979
|
+
{
|
|
3980
|
+
"name": "buildFleetArn",
|
|
3981
|
+
"type": {
|
|
3982
|
+
"primitive": "string"
|
|
3983
|
+
}
|
|
3984
|
+
}
|
|
3985
|
+
],
|
|
3986
|
+
"returns": {
|
|
3987
|
+
"type": {
|
|
3988
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.IBuildFleet"
|
|
3989
|
+
}
|
|
3990
|
+
},
|
|
3991
|
+
"static": true
|
|
3721
3992
|
},
|
|
3722
3993
|
{
|
|
3723
|
-
"abstract": true,
|
|
3724
3994
|
"docs": {
|
|
3725
|
-
"default": "No name",
|
|
3726
3995
|
"stability": "experimental",
|
|
3727
|
-
"summary": "
|
|
3996
|
+
"summary": "Import an existing fleet from its identifier."
|
|
3728
3997
|
},
|
|
3729
|
-
"immutable": true,
|
|
3730
3998
|
"locationInModule": {
|
|
3731
|
-
"filename": "lib/build.ts",
|
|
3732
|
-
"line":
|
|
3999
|
+
"filename": "lib/build-fleet.ts",
|
|
4000
|
+
"line": 52
|
|
3733
4001
|
},
|
|
3734
|
-
"name": "
|
|
3735
|
-
"
|
|
3736
|
-
|
|
3737
|
-
|
|
3738
|
-
|
|
4002
|
+
"name": "fromBuildFleetId",
|
|
4003
|
+
"parameters": [
|
|
4004
|
+
{
|
|
4005
|
+
"name": "scope",
|
|
4006
|
+
"type": {
|
|
4007
|
+
"fqn": "constructs.Construct"
|
|
4008
|
+
}
|
|
4009
|
+
},
|
|
4010
|
+
{
|
|
4011
|
+
"name": "id",
|
|
4012
|
+
"type": {
|
|
4013
|
+
"primitive": "string"
|
|
4014
|
+
}
|
|
4015
|
+
},
|
|
4016
|
+
{
|
|
4017
|
+
"name": "buildFleetId",
|
|
4018
|
+
"type": {
|
|
4019
|
+
"primitive": "string"
|
|
4020
|
+
}
|
|
4021
|
+
}
|
|
4022
|
+
],
|
|
4023
|
+
"returns": {
|
|
4024
|
+
"type": {
|
|
4025
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.IBuildFleet"
|
|
4026
|
+
}
|
|
4027
|
+
},
|
|
4028
|
+
"static": true
|
|
3739
4029
|
},
|
|
3740
4030
|
{
|
|
3741
|
-
"abstract": true,
|
|
3742
4031
|
"docs": {
|
|
3743
|
-
"default": "No version",
|
|
3744
4032
|
"stability": "experimental",
|
|
3745
|
-
"summary": "
|
|
4033
|
+
"summary": "Adds an ingress rule to allow inbound traffic to access game sessions on this fleet."
|
|
4034
|
+
},
|
|
4035
|
+
"locationInModule": {
|
|
4036
|
+
"filename": "lib/build-fleet.ts",
|
|
4037
|
+
"line": 177
|
|
4038
|
+
},
|
|
4039
|
+
"name": "addIngressRule",
|
|
4040
|
+
"parameters": [
|
|
4041
|
+
{
|
|
4042
|
+
"docs": {
|
|
4043
|
+
"summary": "A range of allowed IP addresses."
|
|
4044
|
+
},
|
|
4045
|
+
"name": "source",
|
|
4046
|
+
"type": {
|
|
4047
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.IPeer"
|
|
4048
|
+
}
|
|
4049
|
+
},
|
|
4050
|
+
{
|
|
4051
|
+
"docs": {
|
|
4052
|
+
"summary": "The port range used for ingress traffic."
|
|
4053
|
+
},
|
|
4054
|
+
"name": "port",
|
|
4055
|
+
"type": {
|
|
4056
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.Port"
|
|
4057
|
+
}
|
|
4058
|
+
}
|
|
4059
|
+
]
|
|
4060
|
+
}
|
|
4061
|
+
],
|
|
4062
|
+
"name": "BuildFleet",
|
|
4063
|
+
"properties": [
|
|
4064
|
+
{
|
|
4065
|
+
"docs": {
|
|
4066
|
+
"stability": "experimental",
|
|
4067
|
+
"summary": "The build content of the fleet."
|
|
4068
|
+
},
|
|
4069
|
+
"immutable": true,
|
|
4070
|
+
"locationInModule": {
|
|
4071
|
+
"filename": "lib/build-fleet.ts",
|
|
4072
|
+
"line": 76
|
|
4073
|
+
},
|
|
4074
|
+
"name": "content",
|
|
4075
|
+
"type": {
|
|
4076
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.IBuild"
|
|
4077
|
+
}
|
|
4078
|
+
},
|
|
4079
|
+
{
|
|
4080
|
+
"docs": {
|
|
4081
|
+
"stability": "experimental",
|
|
4082
|
+
"summary": "The ARN of the fleet."
|
|
4083
|
+
},
|
|
4084
|
+
"immutable": true,
|
|
4085
|
+
"locationInModule": {
|
|
4086
|
+
"filename": "lib/build-fleet.ts",
|
|
4087
|
+
"line": 71
|
|
4088
|
+
},
|
|
4089
|
+
"name": "fleetArn",
|
|
4090
|
+
"overrides": "@aws-cdk/aws-gamelift-alpha.FleetBase",
|
|
4091
|
+
"type": {
|
|
4092
|
+
"primitive": "string"
|
|
4093
|
+
}
|
|
4094
|
+
},
|
|
4095
|
+
{
|
|
4096
|
+
"docs": {
|
|
4097
|
+
"stability": "experimental",
|
|
4098
|
+
"summary": "The Identifier of the fleet."
|
|
4099
|
+
},
|
|
4100
|
+
"immutable": true,
|
|
4101
|
+
"locationInModule": {
|
|
4102
|
+
"filename": "lib/build-fleet.ts",
|
|
4103
|
+
"line": 66
|
|
4104
|
+
},
|
|
4105
|
+
"name": "fleetId",
|
|
4106
|
+
"overrides": "@aws-cdk/aws-gamelift-alpha.FleetBase",
|
|
4107
|
+
"type": {
|
|
4108
|
+
"primitive": "string"
|
|
4109
|
+
}
|
|
4110
|
+
},
|
|
4111
|
+
{
|
|
4112
|
+
"docs": {
|
|
4113
|
+
"stability": "experimental",
|
|
4114
|
+
"summary": "The principal this GameLift fleet is using."
|
|
4115
|
+
},
|
|
4116
|
+
"immutable": true,
|
|
4117
|
+
"locationInModule": {
|
|
4118
|
+
"filename": "lib/build-fleet.ts",
|
|
4119
|
+
"line": 86
|
|
4120
|
+
},
|
|
4121
|
+
"name": "grantPrincipal",
|
|
4122
|
+
"overrides": "@aws-cdk/aws-gamelift-alpha.FleetBase",
|
|
4123
|
+
"type": {
|
|
4124
|
+
"fqn": "aws-cdk-lib.aws_iam.IPrincipal"
|
|
4125
|
+
}
|
|
4126
|
+
},
|
|
4127
|
+
{
|
|
4128
|
+
"docs": {
|
|
4129
|
+
"stability": "experimental",
|
|
4130
|
+
"summary": "The IAM role GameLift assumes by fleet instances to access AWS ressources."
|
|
4131
|
+
},
|
|
4132
|
+
"immutable": true,
|
|
4133
|
+
"locationInModule": {
|
|
4134
|
+
"filename": "lib/build-fleet.ts",
|
|
4135
|
+
"line": 81
|
|
4136
|
+
},
|
|
4137
|
+
"name": "role",
|
|
4138
|
+
"type": {
|
|
4139
|
+
"fqn": "aws-cdk-lib.aws_iam.IRole"
|
|
4140
|
+
}
|
|
4141
|
+
}
|
|
4142
|
+
],
|
|
4143
|
+
"symbolId": "lib/build-fleet:BuildFleet"
|
|
4144
|
+
},
|
|
4145
|
+
"@aws-cdk/aws-gamelift-alpha.BuildFleetProps": {
|
|
4146
|
+
"assembly": "@aws-cdk/aws-gamelift-alpha",
|
|
4147
|
+
"datatype": true,
|
|
4148
|
+
"docs": {
|
|
4149
|
+
"stability": "experimental",
|
|
4150
|
+
"summary": "Properties for a new Gamelift build fleet.",
|
|
4151
|
+
"example": "declare const build: gamelift.Build;\n// Server processes can be delcared in a declarative way through the constructor\nconst fleet = new gamelift.BuildFleet(this, 'Game server fleet', {\n fleetName: 'test-fleet',\n content: build,\n instanceType: ec2.InstanceType.of(ec2.InstanceClass.C4, ec2.InstanceSize.LARGE),\n runtimeConfiguration: {\n serverProcesses: [{\n launchPath: '/local/game/GameLiftExampleServer.x86_64',\n parameters: '-logFile /local/game/logs/myserver1935.log -port 1935',\n concurrentExecutions: 100,\n }]\n }\n});",
|
|
4152
|
+
"custom": {
|
|
4153
|
+
"exampleMetadata": "infused"
|
|
4154
|
+
}
|
|
4155
|
+
},
|
|
4156
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.BuildFleetProps",
|
|
4157
|
+
"interfaces": [
|
|
4158
|
+
"@aws-cdk/aws-gamelift-alpha.FleetProps"
|
|
4159
|
+
],
|
|
4160
|
+
"kind": "interface",
|
|
4161
|
+
"locationInModule": {
|
|
4162
|
+
"filename": "lib/build-fleet.ts",
|
|
4163
|
+
"line": 17
|
|
4164
|
+
},
|
|
4165
|
+
"name": "BuildFleetProps",
|
|
4166
|
+
"properties": [
|
|
4167
|
+
{
|
|
4168
|
+
"abstract": true,
|
|
4169
|
+
"docs": {
|
|
4170
|
+
"remarks": "The build must have been successfully uploaded to Amazon GameLift and be in a `READY` status.\n\nThis fleet setting cannot be changed once the fleet is created.",
|
|
4171
|
+
"stability": "experimental",
|
|
4172
|
+
"summary": "A build to be deployed on the fleet."
|
|
4173
|
+
},
|
|
4174
|
+
"immutable": true,
|
|
4175
|
+
"locationInModule": {
|
|
4176
|
+
"filename": "lib/build-fleet.ts",
|
|
4177
|
+
"line": 25
|
|
4178
|
+
},
|
|
4179
|
+
"name": "content",
|
|
4180
|
+
"type": {
|
|
4181
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.IBuild"
|
|
4182
|
+
}
|
|
4183
|
+
},
|
|
4184
|
+
{
|
|
4185
|
+
"abstract": true,
|
|
4186
|
+
"docs": {
|
|
4187
|
+
"default": "no inbound traffic allowed",
|
|
4188
|
+
"remarks": "This property must be set before players can connect to game sessions.",
|
|
4189
|
+
"stability": "experimental",
|
|
4190
|
+
"summary": "The allowed IP address ranges and port settings that allow inbound traffic to access game sessions on this fleet."
|
|
4191
|
+
},
|
|
4192
|
+
"immutable": true,
|
|
4193
|
+
"locationInModule": {
|
|
4194
|
+
"filename": "lib/build-fleet.ts",
|
|
4195
|
+
"line": 34
|
|
4196
|
+
},
|
|
4197
|
+
"name": "ingressRules",
|
|
4198
|
+
"optional": true,
|
|
4199
|
+
"type": {
|
|
4200
|
+
"collection": {
|
|
4201
|
+
"elementtype": {
|
|
4202
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.IngressRule"
|
|
4203
|
+
},
|
|
4204
|
+
"kind": "array"
|
|
4205
|
+
}
|
|
4206
|
+
}
|
|
4207
|
+
}
|
|
4208
|
+
],
|
|
4209
|
+
"symbolId": "lib/build-fleet:BuildFleetProps"
|
|
4210
|
+
},
|
|
4211
|
+
"@aws-cdk/aws-gamelift-alpha.BuildProps": {
|
|
4212
|
+
"assembly": "@aws-cdk/aws-gamelift-alpha",
|
|
4213
|
+
"datatype": true,
|
|
4214
|
+
"docs": {
|
|
4215
|
+
"stability": "experimental",
|
|
4216
|
+
"summary": "Properties for a new build.",
|
|
4217
|
+
"example": "declare const bucket: s3.Bucket;\nnew gamelift.Build(this, 'Build', {\n content: gamelift.Content.fromBucket(bucket, \"sample-asset-key\")\n});",
|
|
4218
|
+
"custom": {
|
|
4219
|
+
"exampleMetadata": "infused"
|
|
4220
|
+
}
|
|
4221
|
+
},
|
|
4222
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.BuildProps",
|
|
4223
|
+
"kind": "interface",
|
|
4224
|
+
"locationInModule": {
|
|
4225
|
+
"filename": "lib/build.ts",
|
|
4226
|
+
"line": 68
|
|
4227
|
+
},
|
|
4228
|
+
"name": "BuildProps",
|
|
4229
|
+
"properties": [
|
|
4230
|
+
{
|
|
4231
|
+
"abstract": true,
|
|
4232
|
+
"docs": {
|
|
4233
|
+
"stability": "experimental",
|
|
4234
|
+
"summary": "The game build file storage."
|
|
4235
|
+
},
|
|
4236
|
+
"immutable": true,
|
|
4237
|
+
"locationInModule": {
|
|
4238
|
+
"filename": "lib/build.ts",
|
|
4239
|
+
"line": 93
|
|
4240
|
+
},
|
|
4241
|
+
"name": "content",
|
|
4242
|
+
"type": {
|
|
4243
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.Content"
|
|
4244
|
+
}
|
|
4245
|
+
},
|
|
4246
|
+
{
|
|
4247
|
+
"abstract": true,
|
|
4248
|
+
"docs": {
|
|
4249
|
+
"default": "No name",
|
|
4250
|
+
"stability": "experimental",
|
|
4251
|
+
"summary": "Name of this build."
|
|
4252
|
+
},
|
|
4253
|
+
"immutable": true,
|
|
4254
|
+
"locationInModule": {
|
|
4255
|
+
"filename": "lib/build.ts",
|
|
4256
|
+
"line": 74
|
|
4257
|
+
},
|
|
4258
|
+
"name": "buildName",
|
|
4259
|
+
"optional": true,
|
|
4260
|
+
"type": {
|
|
4261
|
+
"primitive": "string"
|
|
4262
|
+
}
|
|
4263
|
+
},
|
|
4264
|
+
{
|
|
4265
|
+
"abstract": true,
|
|
4266
|
+
"docs": {
|
|
4267
|
+
"default": "No version",
|
|
4268
|
+
"stability": "experimental",
|
|
4269
|
+
"summary": "Version of this build."
|
|
3746
4270
|
},
|
|
3747
4271
|
"immutable": true,
|
|
3748
4272
|
"locationInModule": {
|
|
@@ -3844,13 +4368,3084 @@
|
|
|
3844
4368
|
"name": "options",
|
|
3845
4369
|
"optional": true,
|
|
3846
4370
|
"type": {
|
|
3847
|
-
"fqn": "aws-cdk-lib.aws_s3_assets.AssetOptions"
|
|
4371
|
+
"fqn": "aws-cdk-lib.aws_s3_assets.AssetOptions"
|
|
4372
|
+
}
|
|
4373
|
+
}
|
|
4374
|
+
],
|
|
4375
|
+
"returns": {
|
|
4376
|
+
"type": {
|
|
4377
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.AssetContent"
|
|
4378
|
+
}
|
|
4379
|
+
},
|
|
4380
|
+
"static": true
|
|
4381
|
+
},
|
|
4382
|
+
{
|
|
4383
|
+
"docs": {
|
|
4384
|
+
"stability": "experimental",
|
|
4385
|
+
"summary": "Game content as an S3 object."
|
|
4386
|
+
},
|
|
4387
|
+
"locationInModule": {
|
|
4388
|
+
"filename": "lib/content.ts",
|
|
4389
|
+
"line": 18
|
|
4390
|
+
},
|
|
4391
|
+
"name": "fromBucket",
|
|
4392
|
+
"parameters": [
|
|
4393
|
+
{
|
|
4394
|
+
"docs": {
|
|
4395
|
+
"summary": "The S3 bucket."
|
|
4396
|
+
},
|
|
4397
|
+
"name": "bucket",
|
|
4398
|
+
"type": {
|
|
4399
|
+
"fqn": "aws-cdk-lib.aws_s3.IBucket"
|
|
4400
|
+
}
|
|
4401
|
+
},
|
|
4402
|
+
{
|
|
4403
|
+
"docs": {
|
|
4404
|
+
"summary": "The object key."
|
|
4405
|
+
},
|
|
4406
|
+
"name": "key",
|
|
4407
|
+
"type": {
|
|
4408
|
+
"primitive": "string"
|
|
4409
|
+
}
|
|
4410
|
+
},
|
|
4411
|
+
{
|
|
4412
|
+
"docs": {
|
|
4413
|
+
"summary": "Optional S3 ob ject version."
|
|
4414
|
+
},
|
|
4415
|
+
"name": "objectVersion",
|
|
4416
|
+
"optional": true,
|
|
4417
|
+
"type": {
|
|
4418
|
+
"primitive": "string"
|
|
4419
|
+
}
|
|
4420
|
+
}
|
|
4421
|
+
],
|
|
4422
|
+
"returns": {
|
|
4423
|
+
"type": {
|
|
4424
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.S3Content"
|
|
4425
|
+
}
|
|
4426
|
+
},
|
|
4427
|
+
"static": true
|
|
4428
|
+
},
|
|
4429
|
+
{
|
|
4430
|
+
"abstract": true,
|
|
4431
|
+
"docs": {
|
|
4432
|
+
"stability": "experimental",
|
|
4433
|
+
"summary": "Called when the Build is initialized to allow this object to bind."
|
|
4434
|
+
},
|
|
4435
|
+
"locationInModule": {
|
|
4436
|
+
"filename": "lib/content.ts",
|
|
4437
|
+
"line": 35
|
|
4438
|
+
},
|
|
4439
|
+
"name": "bind",
|
|
4440
|
+
"parameters": [
|
|
4441
|
+
{
|
|
4442
|
+
"name": "scope",
|
|
4443
|
+
"type": {
|
|
4444
|
+
"fqn": "constructs.Construct"
|
|
4445
|
+
}
|
|
4446
|
+
},
|
|
4447
|
+
{
|
|
4448
|
+
"name": "role",
|
|
4449
|
+
"type": {
|
|
4450
|
+
"fqn": "aws-cdk-lib.aws_iam.IRole"
|
|
4451
|
+
}
|
|
4452
|
+
}
|
|
4453
|
+
],
|
|
4454
|
+
"returns": {
|
|
4455
|
+
"type": {
|
|
4456
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.ContentConfig"
|
|
4457
|
+
}
|
|
4458
|
+
}
|
|
4459
|
+
}
|
|
4460
|
+
],
|
|
4461
|
+
"name": "Content",
|
|
4462
|
+
"symbolId": "lib/content:Content"
|
|
4463
|
+
},
|
|
4464
|
+
"@aws-cdk/aws-gamelift-alpha.ContentConfig": {
|
|
4465
|
+
"assembly": "@aws-cdk/aws-gamelift-alpha",
|
|
4466
|
+
"datatype": true,
|
|
4467
|
+
"docs": {
|
|
4468
|
+
"stability": "experimental",
|
|
4469
|
+
"summary": "Result of binding `Content` into a `Build`.",
|
|
4470
|
+
"example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as gamelift_alpha from '@aws-cdk/aws-gamelift-alpha';\nconst contentConfig: gamelift_alpha.ContentConfig = {\n s3Location: {\n bucketName: 'bucketName',\n objectKey: 'objectKey',\n\n // the properties below are optional\n objectVersion: 'objectVersion',\n },\n};",
|
|
4471
|
+
"custom": {
|
|
4472
|
+
"exampleMetadata": "fixture=_generated"
|
|
4473
|
+
}
|
|
4474
|
+
},
|
|
4475
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.ContentConfig",
|
|
4476
|
+
"kind": "interface",
|
|
4477
|
+
"locationInModule": {
|
|
4478
|
+
"filename": "lib/content.ts",
|
|
4479
|
+
"line": 42
|
|
4480
|
+
},
|
|
4481
|
+
"name": "ContentConfig",
|
|
4482
|
+
"properties": [
|
|
4483
|
+
{
|
|
4484
|
+
"abstract": true,
|
|
4485
|
+
"docs": {
|
|
4486
|
+
"stability": "experimental",
|
|
4487
|
+
"summary": "The location of the content in S3."
|
|
4488
|
+
},
|
|
4489
|
+
"immutable": true,
|
|
4490
|
+
"locationInModule": {
|
|
4491
|
+
"filename": "lib/content.ts",
|
|
4492
|
+
"line": 46
|
|
4493
|
+
},
|
|
4494
|
+
"name": "s3Location",
|
|
4495
|
+
"type": {
|
|
4496
|
+
"fqn": "aws-cdk-lib.aws_s3.Location"
|
|
4497
|
+
}
|
|
4498
|
+
}
|
|
4499
|
+
],
|
|
4500
|
+
"symbolId": "lib/content:ContentConfig"
|
|
4501
|
+
},
|
|
4502
|
+
"@aws-cdk/aws-gamelift-alpha.DeleteOption": {
|
|
4503
|
+
"assembly": "@aws-cdk/aws-gamelift-alpha",
|
|
4504
|
+
"docs": {
|
|
4505
|
+
"remarks": "To delete a game server group, specify the DeleteOption.",
|
|
4506
|
+
"stability": "experimental",
|
|
4507
|
+
"summary": "The type of delete to perform."
|
|
4508
|
+
},
|
|
4509
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.DeleteOption",
|
|
4510
|
+
"kind": "enum",
|
|
4511
|
+
"locationInModule": {
|
|
4512
|
+
"filename": "lib/game-server-group.ts",
|
|
4513
|
+
"line": 56
|
|
4514
|
+
},
|
|
4515
|
+
"members": [
|
|
4516
|
+
{
|
|
4517
|
+
"docs": {
|
|
4518
|
+
"stability": "experimental",
|
|
4519
|
+
"summary": "Terminates the game server group and Amazon EC2 Auto Scaling group only when it has no game servers that are in UTILIZED status."
|
|
4520
|
+
},
|
|
4521
|
+
"name": "SAFE_DELETE"
|
|
4522
|
+
},
|
|
4523
|
+
{
|
|
4524
|
+
"docs": {
|
|
4525
|
+
"stability": "experimental",
|
|
4526
|
+
"summary": "Terminates the game server group, including all active game servers regardless of their utilization status, and the Amazon EC2 Auto Scaling group."
|
|
4527
|
+
},
|
|
4528
|
+
"name": "FORCE_DELETE"
|
|
4529
|
+
},
|
|
4530
|
+
{
|
|
4531
|
+
"docs": {
|
|
4532
|
+
"stability": "experimental",
|
|
4533
|
+
"summary": "Does a safe delete of the game server group but retains the Amazon EC2 Auto Scaling group as is."
|
|
4534
|
+
},
|
|
4535
|
+
"name": "RETAIN"
|
|
4536
|
+
}
|
|
4537
|
+
],
|
|
4538
|
+
"name": "DeleteOption",
|
|
4539
|
+
"symbolId": "lib/game-server-group:DeleteOption"
|
|
4540
|
+
},
|
|
4541
|
+
"@aws-cdk/aws-gamelift-alpha.FleetAttributes": {
|
|
4542
|
+
"assembly": "@aws-cdk/aws-gamelift-alpha",
|
|
4543
|
+
"datatype": true,
|
|
4544
|
+
"docs": {
|
|
4545
|
+
"stability": "experimental",
|
|
4546
|
+
"summary": "A full specification of a fleet that can be used to import it fluently into the CDK application.",
|
|
4547
|
+
"example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as gamelift_alpha from '@aws-cdk/aws-gamelift-alpha';\nimport { aws_iam as iam } from 'aws-cdk-lib';\n\ndeclare const role: iam.Role;\nconst fleetAttributes: gamelift_alpha.FleetAttributes = {\n fleetArn: 'fleetArn',\n fleetId: 'fleetId',\n role: role,\n};",
|
|
4548
|
+
"custom": {
|
|
4549
|
+
"exampleMetadata": "fixture=_generated"
|
|
4550
|
+
}
|
|
4551
|
+
},
|
|
4552
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.FleetAttributes",
|
|
4553
|
+
"kind": "interface",
|
|
4554
|
+
"locationInModule": {
|
|
4555
|
+
"filename": "lib/fleet-base.ts",
|
|
4556
|
+
"line": 373
|
|
4557
|
+
},
|
|
4558
|
+
"name": "FleetAttributes",
|
|
4559
|
+
"properties": [
|
|
4560
|
+
{
|
|
4561
|
+
"abstract": true,
|
|
4562
|
+
"docs": {
|
|
4563
|
+
"default": "derived from `fleetId`.",
|
|
4564
|
+
"remarks": "At least one of `fleetArn` and `fleetId` must be provided.",
|
|
4565
|
+
"stability": "experimental",
|
|
4566
|
+
"summary": "The ARN of the fleet."
|
|
4567
|
+
},
|
|
4568
|
+
"immutable": true,
|
|
4569
|
+
"locationInModule": {
|
|
4570
|
+
"filename": "lib/fleet-base.ts",
|
|
4571
|
+
"line": 381
|
|
4572
|
+
},
|
|
4573
|
+
"name": "fleetArn",
|
|
4574
|
+
"optional": true,
|
|
4575
|
+
"type": {
|
|
4576
|
+
"primitive": "string"
|
|
4577
|
+
}
|
|
4578
|
+
},
|
|
4579
|
+
{
|
|
4580
|
+
"abstract": true,
|
|
4581
|
+
"docs": {
|
|
4582
|
+
"default": "derived from `fleetArn`.",
|
|
4583
|
+
"remarks": "At least one of `fleetId` and `fleetArn` must be provided.",
|
|
4584
|
+
"stability": "experimental",
|
|
4585
|
+
"summary": "The identifier of the fleet."
|
|
4586
|
+
},
|
|
4587
|
+
"immutable": true,
|
|
4588
|
+
"locationInModule": {
|
|
4589
|
+
"filename": "lib/fleet-base.ts",
|
|
4590
|
+
"line": 390
|
|
4591
|
+
},
|
|
4592
|
+
"name": "fleetId",
|
|
4593
|
+
"optional": true,
|
|
4594
|
+
"type": {
|
|
4595
|
+
"primitive": "string"
|
|
4596
|
+
}
|
|
4597
|
+
},
|
|
4598
|
+
{
|
|
4599
|
+
"abstract": true,
|
|
4600
|
+
"docs": {
|
|
4601
|
+
"default": "the imported fleet cannot be granted access to other resources as an `iam.IGrantable`.",
|
|
4602
|
+
"stability": "experimental",
|
|
4603
|
+
"summary": "The IAM role assumed by GameLift fleet instances to access AWS ressources."
|
|
4604
|
+
},
|
|
4605
|
+
"immutable": true,
|
|
4606
|
+
"locationInModule": {
|
|
4607
|
+
"filename": "lib/fleet-base.ts",
|
|
4608
|
+
"line": 397
|
|
4609
|
+
},
|
|
4610
|
+
"name": "role",
|
|
4611
|
+
"optional": true,
|
|
4612
|
+
"type": {
|
|
4613
|
+
"fqn": "aws-cdk-lib.aws_iam.IRole"
|
|
4614
|
+
}
|
|
4615
|
+
}
|
|
4616
|
+
],
|
|
4617
|
+
"symbolId": "lib/fleet-base:FleetAttributes"
|
|
4618
|
+
},
|
|
4619
|
+
"@aws-cdk/aws-gamelift-alpha.FleetBase": {
|
|
4620
|
+
"abstract": true,
|
|
4621
|
+
"assembly": "@aws-cdk/aws-gamelift-alpha",
|
|
4622
|
+
"base": "aws-cdk-lib.Resource",
|
|
4623
|
+
"docs": {
|
|
4624
|
+
"stability": "experimental",
|
|
4625
|
+
"summary": "Base class for new and imported GameLift fleet.",
|
|
4626
|
+
"example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as gamelift_alpha from '@aws-cdk/aws-gamelift-alpha';\nimport { aws_iam as iam } from 'aws-cdk-lib';\n\ndeclare const role: iam.Role;\nconst fleetBase = gamelift_alpha.FleetBase.fromFleetAttributes(this, 'MyFleetBase', {\n fleetArn: 'fleetArn',\n fleetId: 'fleetId',\n role: role,\n});",
|
|
4627
|
+
"custom": {
|
|
4628
|
+
"exampleMetadata": "fixture=_generated"
|
|
4629
|
+
}
|
|
4630
|
+
},
|
|
4631
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.FleetBase",
|
|
4632
|
+
"initializer": {
|
|
4633
|
+
"docs": {
|
|
4634
|
+
"stability": "stable"
|
|
4635
|
+
},
|
|
4636
|
+
"locationInModule": {
|
|
4637
|
+
"filename": "core/lib/resource.ts",
|
|
4638
|
+
"line": 156
|
|
4639
|
+
},
|
|
4640
|
+
"parameters": [
|
|
4641
|
+
{
|
|
4642
|
+
"name": "scope",
|
|
4643
|
+
"type": {
|
|
4644
|
+
"fqn": "constructs.Construct"
|
|
4645
|
+
}
|
|
4646
|
+
},
|
|
4647
|
+
{
|
|
4648
|
+
"name": "id",
|
|
4649
|
+
"type": {
|
|
4650
|
+
"primitive": "string"
|
|
4651
|
+
}
|
|
4652
|
+
},
|
|
4653
|
+
{
|
|
4654
|
+
"name": "props",
|
|
4655
|
+
"optional": true,
|
|
4656
|
+
"type": {
|
|
4657
|
+
"fqn": "aws-cdk-lib.ResourceProps"
|
|
4658
|
+
}
|
|
4659
|
+
}
|
|
4660
|
+
]
|
|
4661
|
+
},
|
|
4662
|
+
"interfaces": [
|
|
4663
|
+
"@aws-cdk/aws-gamelift-alpha.IFleet"
|
|
4664
|
+
],
|
|
4665
|
+
"kind": "class",
|
|
4666
|
+
"locationInModule": {
|
|
4667
|
+
"filename": "lib/fleet-base.ts",
|
|
4668
|
+
"line": 403
|
|
4669
|
+
},
|
|
4670
|
+
"methods": [
|
|
4671
|
+
{
|
|
4672
|
+
"docs": {
|
|
4673
|
+
"stability": "experimental",
|
|
4674
|
+
"summary": "Import an existing fleet from its attributes."
|
|
4675
|
+
},
|
|
4676
|
+
"locationInModule": {
|
|
4677
|
+
"filename": "lib/fleet-base.ts",
|
|
4678
|
+
"line": 408
|
|
4679
|
+
},
|
|
4680
|
+
"name": "fromFleetAttributes",
|
|
4681
|
+
"parameters": [
|
|
4682
|
+
{
|
|
4683
|
+
"name": "scope",
|
|
4684
|
+
"type": {
|
|
4685
|
+
"fqn": "constructs.Construct"
|
|
4686
|
+
}
|
|
4687
|
+
},
|
|
4688
|
+
{
|
|
4689
|
+
"name": "id",
|
|
4690
|
+
"type": {
|
|
4691
|
+
"primitive": "string"
|
|
4692
|
+
}
|
|
4693
|
+
},
|
|
4694
|
+
{
|
|
4695
|
+
"name": "attrs",
|
|
4696
|
+
"type": {
|
|
4697
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.FleetAttributes"
|
|
4698
|
+
}
|
|
4699
|
+
}
|
|
4700
|
+
],
|
|
4701
|
+
"returns": {
|
|
4702
|
+
"type": {
|
|
4703
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.IFleet"
|
|
4704
|
+
}
|
|
4705
|
+
},
|
|
4706
|
+
"static": true
|
|
4707
|
+
},
|
|
4708
|
+
{
|
|
4709
|
+
"docs": {
|
|
4710
|
+
"stability": "experimental",
|
|
4711
|
+
"summary": "Adds a remote locations to deploy additional instances to and manage as part of the fleet."
|
|
4712
|
+
},
|
|
4713
|
+
"locationInModule": {
|
|
4714
|
+
"filename": "lib/fleet-base.ts",
|
|
4715
|
+
"line": 531
|
|
4716
|
+
},
|
|
4717
|
+
"name": "addInternalLocation",
|
|
4718
|
+
"parameters": [
|
|
4719
|
+
{
|
|
4720
|
+
"docs": {
|
|
4721
|
+
"summary": "The location to add."
|
|
4722
|
+
},
|
|
4723
|
+
"name": "location",
|
|
4724
|
+
"type": {
|
|
4725
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.Location"
|
|
4726
|
+
}
|
|
4727
|
+
}
|
|
4728
|
+
]
|
|
4729
|
+
},
|
|
4730
|
+
{
|
|
4731
|
+
"docs": {
|
|
4732
|
+
"stability": "experimental",
|
|
4733
|
+
"summary": "Adds a remote locations to deploy additional instances to and manage as part of the fleet."
|
|
4734
|
+
},
|
|
4735
|
+
"locationInModule": {
|
|
4736
|
+
"filename": "lib/fleet-base.ts",
|
|
4737
|
+
"line": 515
|
|
4738
|
+
},
|
|
4739
|
+
"name": "addLocation",
|
|
4740
|
+
"parameters": [
|
|
4741
|
+
{
|
|
4742
|
+
"docs": {
|
|
4743
|
+
"summary": "The AWS region to add."
|
|
4744
|
+
},
|
|
4745
|
+
"name": "region",
|
|
4746
|
+
"type": {
|
|
4747
|
+
"primitive": "string"
|
|
4748
|
+
}
|
|
4749
|
+
},
|
|
4750
|
+
{
|
|
4751
|
+
"name": "desiredCapacity",
|
|
4752
|
+
"optional": true,
|
|
4753
|
+
"type": {
|
|
4754
|
+
"primitive": "number"
|
|
4755
|
+
}
|
|
4756
|
+
},
|
|
4757
|
+
{
|
|
4758
|
+
"name": "minSize",
|
|
4759
|
+
"optional": true,
|
|
4760
|
+
"type": {
|
|
4761
|
+
"primitive": "number"
|
|
4762
|
+
}
|
|
4763
|
+
},
|
|
4764
|
+
{
|
|
4765
|
+
"name": "maxSize",
|
|
4766
|
+
"optional": true,
|
|
4767
|
+
"type": {
|
|
4768
|
+
"primitive": "number"
|
|
4769
|
+
}
|
|
4770
|
+
}
|
|
4771
|
+
]
|
|
4772
|
+
},
|
|
4773
|
+
{
|
|
4774
|
+
"docs": {
|
|
4775
|
+
"stability": "experimental",
|
|
4776
|
+
"summary": "Grant the `grantee` identity permissions to perform `actions`."
|
|
4777
|
+
},
|
|
4778
|
+
"locationInModule": {
|
|
4779
|
+
"filename": "lib/fleet-base.ts",
|
|
4780
|
+
"line": 456
|
|
4781
|
+
},
|
|
4782
|
+
"name": "grant",
|
|
4783
|
+
"overrides": "@aws-cdk/aws-gamelift-alpha.IFleet",
|
|
4784
|
+
"parameters": [
|
|
4785
|
+
{
|
|
4786
|
+
"name": "grantee",
|
|
4787
|
+
"type": {
|
|
4788
|
+
"fqn": "aws-cdk-lib.aws_iam.IGrantable"
|
|
4789
|
+
}
|
|
4790
|
+
},
|
|
4791
|
+
{
|
|
4792
|
+
"name": "actions",
|
|
4793
|
+
"type": {
|
|
4794
|
+
"primitive": "string"
|
|
4795
|
+
},
|
|
4796
|
+
"variadic": true
|
|
4797
|
+
}
|
|
4798
|
+
],
|
|
4799
|
+
"returns": {
|
|
4800
|
+
"type": {
|
|
4801
|
+
"fqn": "aws-cdk-lib.aws_iam.Grant"
|
|
4802
|
+
}
|
|
4803
|
+
},
|
|
4804
|
+
"variadic": true
|
|
4805
|
+
},
|
|
4806
|
+
{
|
|
4807
|
+
"docs": {
|
|
4808
|
+
"stability": "experimental",
|
|
4809
|
+
"summary": "Return the given named metric for this fleet."
|
|
4810
|
+
},
|
|
4811
|
+
"locationInModule": {
|
|
4812
|
+
"filename": "lib/fleet-base.ts",
|
|
4813
|
+
"line": 464
|
|
4814
|
+
},
|
|
4815
|
+
"name": "metric",
|
|
4816
|
+
"overrides": "@aws-cdk/aws-gamelift-alpha.IFleet",
|
|
4817
|
+
"parameters": [
|
|
4818
|
+
{
|
|
4819
|
+
"name": "metricName",
|
|
4820
|
+
"type": {
|
|
4821
|
+
"primitive": "string"
|
|
4822
|
+
}
|
|
4823
|
+
},
|
|
4824
|
+
{
|
|
4825
|
+
"name": "props",
|
|
4826
|
+
"optional": true,
|
|
4827
|
+
"type": {
|
|
4828
|
+
"fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
|
|
4829
|
+
}
|
|
4830
|
+
}
|
|
4831
|
+
],
|
|
4832
|
+
"returns": {
|
|
4833
|
+
"type": {
|
|
4834
|
+
"fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
|
|
4835
|
+
}
|
|
4836
|
+
}
|
|
4837
|
+
},
|
|
4838
|
+
{
|
|
4839
|
+
"docs": {
|
|
4840
|
+
"remarks": "The count includes idle instances and those that are hosting one or more game sessions.\nThis metric measures current total instance capacity.\n\nThis metric can be used with automatic scaling.",
|
|
4841
|
+
"stability": "experimental",
|
|
4842
|
+
"summary": "Instances with `ACTIVE` status, which means they are running active server processes."
|
|
4843
|
+
},
|
|
4844
|
+
"locationInModule": {
|
|
4845
|
+
"filename": "lib/fleet-base.ts",
|
|
4846
|
+
"line": 475
|
|
4847
|
+
},
|
|
4848
|
+
"name": "metricActiveInstances",
|
|
4849
|
+
"overrides": "@aws-cdk/aws-gamelift-alpha.IFleet",
|
|
4850
|
+
"parameters": [
|
|
4851
|
+
{
|
|
4852
|
+
"name": "props",
|
|
4853
|
+
"optional": true,
|
|
4854
|
+
"type": {
|
|
4855
|
+
"fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
|
|
4856
|
+
}
|
|
4857
|
+
}
|
|
4858
|
+
],
|
|
4859
|
+
"returns": {
|
|
4860
|
+
"type": {
|
|
4861
|
+
"fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
|
|
4862
|
+
}
|
|
4863
|
+
}
|
|
4864
|
+
},
|
|
4865
|
+
{
|
|
4866
|
+
"docs": {
|
|
4867
|
+
"remarks": "With automatic scaling, this value is determined based on the scaling policies currently in force.\nWithout automatic scaling, this value is set manually.\nThis metric is not available when viewing data for fleet metric groups.",
|
|
4868
|
+
"stability": "experimental",
|
|
4869
|
+
"summary": "Target number of active instances that GameLift is working to maintain in the fleet."
|
|
4870
|
+
},
|
|
4871
|
+
"locationInModule": {
|
|
4872
|
+
"filename": "lib/fleet-base.ts",
|
|
4873
|
+
"line": 483
|
|
4874
|
+
},
|
|
4875
|
+
"name": "metricDesiredInstances",
|
|
4876
|
+
"overrides": "@aws-cdk/aws-gamelift-alpha.IFleet",
|
|
4877
|
+
"parameters": [
|
|
4878
|
+
{
|
|
4879
|
+
"name": "props",
|
|
4880
|
+
"optional": true,
|
|
4881
|
+
"type": {
|
|
4882
|
+
"fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
|
|
4883
|
+
}
|
|
4884
|
+
}
|
|
4885
|
+
],
|
|
4886
|
+
"returns": {
|
|
4887
|
+
"type": {
|
|
4888
|
+
"fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
|
|
4889
|
+
}
|
|
4890
|
+
}
|
|
4891
|
+
},
|
|
4892
|
+
{
|
|
4893
|
+
"docs": {
|
|
4894
|
+
"remarks": "This metric measures capacity that is available but unused.\nThis metric can be used with automatic scaling.",
|
|
4895
|
+
"stability": "experimental",
|
|
4896
|
+
"summary": "Active instances that are currently hosting zero (0) game sessions."
|
|
4897
|
+
},
|
|
4898
|
+
"locationInModule": {
|
|
4899
|
+
"filename": "lib/fleet-base.ts",
|
|
4900
|
+
"line": 487
|
|
4901
|
+
},
|
|
4902
|
+
"name": "metricIdleInstances",
|
|
4903
|
+
"overrides": "@aws-cdk/aws-gamelift-alpha.IFleet",
|
|
4904
|
+
"parameters": [
|
|
4905
|
+
{
|
|
4906
|
+
"name": "props",
|
|
4907
|
+
"optional": true,
|
|
4908
|
+
"type": {
|
|
4909
|
+
"fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
|
|
4910
|
+
}
|
|
4911
|
+
}
|
|
4912
|
+
],
|
|
4913
|
+
"returns": {
|
|
4914
|
+
"type": {
|
|
4915
|
+
"fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
|
|
4916
|
+
}
|
|
4917
|
+
}
|
|
4918
|
+
},
|
|
4919
|
+
{
|
|
4920
|
+
"docs": {
|
|
4921
|
+
"stability": "experimental",
|
|
4922
|
+
"summary": "Number of spot instances that have been interrupted."
|
|
4923
|
+
},
|
|
4924
|
+
"locationInModule": {
|
|
4925
|
+
"filename": "lib/fleet-base.ts",
|
|
4926
|
+
"line": 491
|
|
4927
|
+
},
|
|
4928
|
+
"name": "metricInstanceInterruptions",
|
|
4929
|
+
"overrides": "@aws-cdk/aws-gamelift-alpha.IFleet",
|
|
4930
|
+
"parameters": [
|
|
4931
|
+
{
|
|
4932
|
+
"name": "props",
|
|
4933
|
+
"optional": true,
|
|
4934
|
+
"type": {
|
|
4935
|
+
"fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
|
|
4936
|
+
}
|
|
4937
|
+
}
|
|
4938
|
+
],
|
|
4939
|
+
"returns": {
|
|
4940
|
+
"type": {
|
|
4941
|
+
"fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
|
|
4942
|
+
}
|
|
4943
|
+
}
|
|
4944
|
+
},
|
|
4945
|
+
{
|
|
4946
|
+
"docs": {
|
|
4947
|
+
"remarks": "A fleet's instance maximum determines the capacity ceiling during manual or automatic scaling up.\nThis metric is not available when viewing data for fleet metric groups.",
|
|
4948
|
+
"stability": "experimental",
|
|
4949
|
+
"summary": "Maximum number of instances that are allowed for the fleet."
|
|
4950
|
+
},
|
|
4951
|
+
"locationInModule": {
|
|
4952
|
+
"filename": "lib/fleet-base.ts",
|
|
4953
|
+
"line": 495
|
|
4954
|
+
},
|
|
4955
|
+
"name": "metricMaxInstances",
|
|
4956
|
+
"overrides": "@aws-cdk/aws-gamelift-alpha.IFleet",
|
|
4957
|
+
"parameters": [
|
|
4958
|
+
{
|
|
4959
|
+
"name": "props",
|
|
4960
|
+
"optional": true,
|
|
4961
|
+
"type": {
|
|
4962
|
+
"fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
|
|
4963
|
+
}
|
|
4964
|
+
}
|
|
4965
|
+
],
|
|
4966
|
+
"returns": {
|
|
4967
|
+
"type": {
|
|
4968
|
+
"fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
|
|
4969
|
+
}
|
|
4970
|
+
}
|
|
4971
|
+
},
|
|
4972
|
+
{
|
|
4973
|
+
"docs": {
|
|
4974
|
+
"remarks": "A fleet's instance minimum determines the capacity floor during manual or automatic scaling down.\nThis metric is not available when viewing data for fleet metric groups.",
|
|
4975
|
+
"stability": "experimental",
|
|
4976
|
+
"summary": "Minimum number of instances allowed for the fleet."
|
|
4977
|
+
},
|
|
4978
|
+
"locationInModule": {
|
|
4979
|
+
"filename": "lib/fleet-base.ts",
|
|
4980
|
+
"line": 499
|
|
4981
|
+
},
|
|
4982
|
+
"name": "metricMinInstances",
|
|
4983
|
+
"overrides": "@aws-cdk/aws-gamelift-alpha.IFleet",
|
|
4984
|
+
"parameters": [
|
|
4985
|
+
{
|
|
4986
|
+
"name": "props",
|
|
4987
|
+
"optional": true,
|
|
4988
|
+
"type": {
|
|
4989
|
+
"fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
|
|
4990
|
+
}
|
|
4991
|
+
}
|
|
4992
|
+
],
|
|
4993
|
+
"returns": {
|
|
4994
|
+
"type": {
|
|
4995
|
+
"fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
|
|
4996
|
+
}
|
|
4997
|
+
}
|
|
4998
|
+
},
|
|
4999
|
+
{
|
|
5000
|
+
"docs": {
|
|
5001
|
+
"remarks": "This metric can be used for automatic scaling.",
|
|
5002
|
+
"stability": "experimental",
|
|
5003
|
+
"summary": "Percentage of all active instances that are idle (calculated as IdleInstances / ActiveInstances)."
|
|
5004
|
+
},
|
|
5005
|
+
"locationInModule": {
|
|
5006
|
+
"filename": "lib/fleet-base.ts",
|
|
5007
|
+
"line": 479
|
|
5008
|
+
},
|
|
5009
|
+
"name": "metricPercentIdleInstances",
|
|
5010
|
+
"overrides": "@aws-cdk/aws-gamelift-alpha.IFleet",
|
|
5011
|
+
"parameters": [
|
|
5012
|
+
{
|
|
5013
|
+
"name": "props",
|
|
5014
|
+
"optional": true,
|
|
5015
|
+
"type": {
|
|
5016
|
+
"fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
|
|
5017
|
+
}
|
|
5018
|
+
}
|
|
5019
|
+
],
|
|
5020
|
+
"returns": {
|
|
5021
|
+
"type": {
|
|
5022
|
+
"fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
|
|
5023
|
+
}
|
|
5024
|
+
}
|
|
5025
|
+
},
|
|
5026
|
+
{
|
|
5027
|
+
"docs": {
|
|
5028
|
+
"stability": "experimental"
|
|
5029
|
+
},
|
|
5030
|
+
"locationInModule": {
|
|
5031
|
+
"filename": "lib/fleet-base.ts",
|
|
5032
|
+
"line": 569
|
|
5033
|
+
},
|
|
5034
|
+
"name": "parseLocationCapacity",
|
|
5035
|
+
"parameters": [
|
|
5036
|
+
{
|
|
5037
|
+
"name": "capacity",
|
|
5038
|
+
"optional": true,
|
|
5039
|
+
"type": {
|
|
5040
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.LocationCapacity"
|
|
5041
|
+
}
|
|
5042
|
+
}
|
|
5043
|
+
],
|
|
5044
|
+
"protected": true,
|
|
5045
|
+
"returns": {
|
|
5046
|
+
"optional": true,
|
|
5047
|
+
"type": {
|
|
5048
|
+
"fqn": "aws-cdk-lib.aws_gamelift.CfnFleet.LocationCapacityProperty"
|
|
5049
|
+
}
|
|
5050
|
+
}
|
|
5051
|
+
},
|
|
5052
|
+
{
|
|
5053
|
+
"docs": {
|
|
5054
|
+
"stability": "experimental"
|
|
5055
|
+
},
|
|
5056
|
+
"locationInModule": {
|
|
5057
|
+
"filename": "lib/fleet-base.ts",
|
|
5058
|
+
"line": 552
|
|
5059
|
+
},
|
|
5060
|
+
"name": "parseLocations",
|
|
5061
|
+
"protected": true,
|
|
5062
|
+
"returns": {
|
|
5063
|
+
"optional": true,
|
|
5064
|
+
"type": {
|
|
5065
|
+
"collection": {
|
|
5066
|
+
"elementtype": {
|
|
5067
|
+
"fqn": "aws-cdk-lib.aws_gamelift.CfnFleet.LocationConfigurationProperty"
|
|
5068
|
+
},
|
|
5069
|
+
"kind": "array"
|
|
5070
|
+
}
|
|
5071
|
+
}
|
|
5072
|
+
}
|
|
5073
|
+
},
|
|
5074
|
+
{
|
|
5075
|
+
"docs": {
|
|
5076
|
+
"stability": "experimental"
|
|
5077
|
+
},
|
|
5078
|
+
"locationInModule": {
|
|
5079
|
+
"filename": "lib/fleet-base.ts",
|
|
5080
|
+
"line": 539
|
|
5081
|
+
},
|
|
5082
|
+
"name": "parseResourceCreationLimitPolicy",
|
|
5083
|
+
"parameters": [
|
|
5084
|
+
{
|
|
5085
|
+
"name": "props",
|
|
5086
|
+
"type": {
|
|
5087
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.FleetProps"
|
|
5088
|
+
}
|
|
5089
|
+
}
|
|
5090
|
+
],
|
|
5091
|
+
"protected": true,
|
|
5092
|
+
"returns": {
|
|
5093
|
+
"optional": true,
|
|
5094
|
+
"type": {
|
|
5095
|
+
"fqn": "aws-cdk-lib.aws_gamelift.CfnFleet.ResourceCreationLimitPolicyProperty"
|
|
5096
|
+
}
|
|
5097
|
+
}
|
|
5098
|
+
},
|
|
5099
|
+
{
|
|
5100
|
+
"docs": {
|
|
5101
|
+
"stability": "experimental"
|
|
5102
|
+
},
|
|
5103
|
+
"locationInModule": {
|
|
5104
|
+
"filename": "lib/fleet-base.ts",
|
|
5105
|
+
"line": 584
|
|
5106
|
+
},
|
|
5107
|
+
"name": "parseRuntimeConfiguration",
|
|
5108
|
+
"parameters": [
|
|
5109
|
+
{
|
|
5110
|
+
"name": "props",
|
|
5111
|
+
"type": {
|
|
5112
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.FleetProps"
|
|
5113
|
+
}
|
|
5114
|
+
}
|
|
5115
|
+
],
|
|
5116
|
+
"protected": true,
|
|
5117
|
+
"returns": {
|
|
5118
|
+
"optional": true,
|
|
5119
|
+
"type": {
|
|
5120
|
+
"fqn": "aws-cdk-lib.aws_gamelift.CfnFleet.RuntimeConfigurationProperty"
|
|
5121
|
+
}
|
|
5122
|
+
}
|
|
5123
|
+
},
|
|
5124
|
+
{
|
|
5125
|
+
"docs": {
|
|
5126
|
+
"stability": "experimental"
|
|
5127
|
+
},
|
|
5128
|
+
"locationInModule": {
|
|
5129
|
+
"filename": "lib/fleet-base.ts",
|
|
5130
|
+
"line": 606
|
|
5131
|
+
},
|
|
5132
|
+
"name": "warnVpcPeeringAuthorizations",
|
|
5133
|
+
"parameters": [
|
|
5134
|
+
{
|
|
5135
|
+
"name": "scope",
|
|
5136
|
+
"type": {
|
|
5137
|
+
"fqn": "constructs.Construct"
|
|
5138
|
+
}
|
|
5139
|
+
}
|
|
5140
|
+
],
|
|
5141
|
+
"protected": true
|
|
5142
|
+
}
|
|
5143
|
+
],
|
|
5144
|
+
"name": "FleetBase",
|
|
5145
|
+
"properties": [
|
|
5146
|
+
{
|
|
5147
|
+
"abstract": true,
|
|
5148
|
+
"docs": {
|
|
5149
|
+
"stability": "experimental",
|
|
5150
|
+
"summary": "The ARN of the fleet."
|
|
5151
|
+
},
|
|
5152
|
+
"immutable": true,
|
|
5153
|
+
"locationInModule": {
|
|
5154
|
+
"filename": "lib/fleet-base.ts",
|
|
5155
|
+
"line": 447
|
|
5156
|
+
},
|
|
5157
|
+
"name": "fleetArn",
|
|
5158
|
+
"overrides": "@aws-cdk/aws-gamelift-alpha.IFleet",
|
|
5159
|
+
"type": {
|
|
5160
|
+
"primitive": "string"
|
|
5161
|
+
}
|
|
5162
|
+
},
|
|
5163
|
+
{
|
|
5164
|
+
"abstract": true,
|
|
5165
|
+
"docs": {
|
|
5166
|
+
"stability": "experimental",
|
|
5167
|
+
"summary": "The Identifier of the fleet."
|
|
5168
|
+
},
|
|
5169
|
+
"immutable": true,
|
|
5170
|
+
"locationInModule": {
|
|
5171
|
+
"filename": "lib/fleet-base.ts",
|
|
5172
|
+
"line": 443
|
|
5173
|
+
},
|
|
5174
|
+
"name": "fleetId",
|
|
5175
|
+
"overrides": "@aws-cdk/aws-gamelift-alpha.IFleet",
|
|
5176
|
+
"type": {
|
|
5177
|
+
"primitive": "string"
|
|
5178
|
+
}
|
|
5179
|
+
},
|
|
5180
|
+
{
|
|
5181
|
+
"abstract": true,
|
|
5182
|
+
"docs": {
|
|
5183
|
+
"stability": "experimental",
|
|
5184
|
+
"summary": "The principal this GameLift fleet is using."
|
|
5185
|
+
},
|
|
5186
|
+
"immutable": true,
|
|
5187
|
+
"locationInModule": {
|
|
5188
|
+
"filename": "lib/fleet-base.ts",
|
|
5189
|
+
"line": 452
|
|
5190
|
+
},
|
|
5191
|
+
"name": "grantPrincipal",
|
|
5192
|
+
"overrides": "aws-cdk-lib.aws_iam.IGrantable",
|
|
5193
|
+
"type": {
|
|
5194
|
+
"fqn": "aws-cdk-lib.aws_iam.IPrincipal"
|
|
5195
|
+
}
|
|
5196
|
+
}
|
|
5197
|
+
],
|
|
5198
|
+
"symbolId": "lib/fleet-base:FleetBase"
|
|
5199
|
+
},
|
|
5200
|
+
"@aws-cdk/aws-gamelift-alpha.FleetProps": {
|
|
5201
|
+
"assembly": "@aws-cdk/aws-gamelift-alpha",
|
|
5202
|
+
"datatype": true,
|
|
5203
|
+
"docs": {
|
|
5204
|
+
"stability": "experimental",
|
|
5205
|
+
"summary": "Properties for a new Gamelift fleet.",
|
|
5206
|
+
"example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as gamelift_alpha from '@aws-cdk/aws-gamelift-alpha';\nimport * as cdk from 'aws-cdk-lib';\nimport { aws_ec2 as ec2 } from 'aws-cdk-lib';\nimport { aws_iam as iam } from 'aws-cdk-lib';\n\ndeclare const instanceType: ec2.InstanceType;\ndeclare const role: iam.Role;\ndeclare const vpc: ec2.Vpc;\nconst fleetProps: gamelift_alpha.FleetProps = {\n fleetName: 'fleetName',\n instanceType: instanceType,\n runtimeConfiguration: {\n serverProcesses: [{\n launchPath: 'launchPath',\n\n // the properties below are optional\n concurrentExecutions: 123,\n parameters: 'parameters',\n }],\n\n // the properties below are optional\n gameSessionActivationTimeout: cdk.Duration.minutes(30),\n maxConcurrentGameSessionActivations: 123,\n },\n\n // the properties below are optional\n description: 'description',\n desiredCapacity: 123,\n locations: [{\n region: 'region',\n\n // the properties below are optional\n capacity: {\n desiredCapacity: 123,\n maxSize: 123,\n minSize: 123,\n },\n }],\n maxSize: 123,\n metricGroup: 'metricGroup',\n minSize: 123,\n peerVpc: vpc,\n protectNewGameSession: false,\n resourceCreationLimitPolicy: {\n newGameSessionsPerCreator: 123,\n policyPeriod: cdk.Duration.minutes(30),\n },\n role: role,\n useCertificate: false,\n useSpot: false,\n};",
|
|
5207
|
+
"custom": {
|
|
5208
|
+
"exampleMetadata": "fixture=_generated"
|
|
5209
|
+
}
|
|
5210
|
+
},
|
|
5211
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.FleetProps",
|
|
5212
|
+
"kind": "interface",
|
|
5213
|
+
"locationInModule": {
|
|
5214
|
+
"filename": "lib/fleet-base.ts",
|
|
5215
|
+
"line": 220
|
|
5216
|
+
},
|
|
5217
|
+
"name": "FleetProps",
|
|
5218
|
+
"properties": [
|
|
5219
|
+
{
|
|
5220
|
+
"abstract": true,
|
|
5221
|
+
"docs": {
|
|
5222
|
+
"remarks": "Fleet names do not need to be unique.",
|
|
5223
|
+
"stability": "experimental",
|
|
5224
|
+
"summary": "A descriptive label that is associated with a fleet."
|
|
5225
|
+
},
|
|
5226
|
+
"immutable": true,
|
|
5227
|
+
"locationInModule": {
|
|
5228
|
+
"filename": "lib/fleet-base.ts",
|
|
5229
|
+
"line": 225
|
|
5230
|
+
},
|
|
5231
|
+
"name": "fleetName",
|
|
5232
|
+
"type": {
|
|
5233
|
+
"primitive": "string"
|
|
5234
|
+
}
|
|
5235
|
+
},
|
|
5236
|
+
{
|
|
5237
|
+
"abstract": true,
|
|
5238
|
+
"docs": {
|
|
5239
|
+
"remarks": "Instance type determines the computing resources that will be used to host your game servers, including CPU, memory, storage, and networking capacity.",
|
|
5240
|
+
"see": "http://aws.amazon.com/ec2/instance-types/ for detailed descriptions of Amazon EC2 instance types.",
|
|
5241
|
+
"stability": "experimental",
|
|
5242
|
+
"summary": "The GameLift-supported Amazon EC2 instance type to use for all fleet instances."
|
|
5243
|
+
},
|
|
5244
|
+
"immutable": true,
|
|
5245
|
+
"locationInModule": {
|
|
5246
|
+
"filename": "lib/fleet-base.ts",
|
|
5247
|
+
"line": 306
|
|
5248
|
+
},
|
|
5249
|
+
"name": "instanceType",
|
|
5250
|
+
"type": {
|
|
5251
|
+
"fqn": "aws-cdk-lib.aws_ec2.InstanceType"
|
|
5252
|
+
}
|
|
5253
|
+
},
|
|
5254
|
+
{
|
|
5255
|
+
"abstract": true,
|
|
5256
|
+
"docs": {
|
|
5257
|
+
"remarks": "Server processes run either an executable in a custom game build or a Realtime Servers script.\nGameLift launches the configured processes, manages their life cycle, and replaces them as needed.\nEach instance checks regularly for an updated runtime configuration.\n\nA GameLift instance is limited to 50 processes running concurrently.\nTo calculate the total number of processes in a runtime configuration, add the values of the ConcurrentExecutions parameter for each ServerProcess.",
|
|
5258
|
+
"see": "https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-multiprocess.html",
|
|
5259
|
+
"stability": "experimental",
|
|
5260
|
+
"summary": "A collection of server process configurations that describe the set of processes to run on each instance in a fleet."
|
|
5261
|
+
},
|
|
5262
|
+
"immutable": true,
|
|
5263
|
+
"locationInModule": {
|
|
5264
|
+
"filename": "lib/fleet-base.ts",
|
|
5265
|
+
"line": 350
|
|
5266
|
+
},
|
|
5267
|
+
"name": "runtimeConfiguration",
|
|
5268
|
+
"type": {
|
|
5269
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.RuntimeConfiguration"
|
|
5270
|
+
}
|
|
5271
|
+
},
|
|
5272
|
+
{
|
|
5273
|
+
"abstract": true,
|
|
5274
|
+
"docs": {
|
|
5275
|
+
"default": "no description is provided",
|
|
5276
|
+
"stability": "experimental",
|
|
5277
|
+
"summary": "A human-readable description of the fleet."
|
|
5278
|
+
},
|
|
5279
|
+
"immutable": true,
|
|
5280
|
+
"locationInModule": {
|
|
5281
|
+
"filename": "lib/fleet-base.ts",
|
|
5282
|
+
"line": 232
|
|
5283
|
+
},
|
|
5284
|
+
"name": "description",
|
|
5285
|
+
"optional": true,
|
|
5286
|
+
"type": {
|
|
5287
|
+
"primitive": "string"
|
|
5288
|
+
}
|
|
5289
|
+
},
|
|
5290
|
+
{
|
|
5291
|
+
"abstract": true,
|
|
5292
|
+
"docs": {
|
|
5293
|
+
"default": "Default capacity is 0",
|
|
5294
|
+
"remarks": "When creating a new fleet, GameLift automatically sets this value to \"1\" and initiates a single instance.\nOnce the fleet is active, update this value to trigger GameLift to add or remove instances from the fleet.",
|
|
5295
|
+
"stability": "experimental",
|
|
5296
|
+
"summary": "The number of EC2 instances that you want this fleet to host."
|
|
5297
|
+
},
|
|
5298
|
+
"immutable": true,
|
|
5299
|
+
"locationInModule": {
|
|
5300
|
+
"filename": "lib/fleet-base.ts",
|
|
5301
|
+
"line": 315
|
|
5302
|
+
},
|
|
5303
|
+
"name": "desiredCapacity",
|
|
5304
|
+
"optional": true,
|
|
5305
|
+
"type": {
|
|
5306
|
+
"primitive": "number"
|
|
5307
|
+
}
|
|
5308
|
+
},
|
|
5309
|
+
{
|
|
5310
|
+
"abstract": true,
|
|
5311
|
+
"docs": {
|
|
5312
|
+
"default": "Create a fleet with instances in the home region only",
|
|
5313
|
+
"remarks": "This parameter can only be used when creating fleets in AWS Regions that support multiple locations.\nYou can add any GameLift-supported AWS Region as a remote location, in the form of an AWS Region code such as `us-west-2`.\nTo create a fleet with instances in the home region only, omit this parameter.",
|
|
5314
|
+
"stability": "experimental",
|
|
5315
|
+
"summary": "A set of remote locations to deploy additional instances to and manage as part of the fleet."
|
|
5316
|
+
},
|
|
5317
|
+
"immutable": true,
|
|
5318
|
+
"locationInModule": {
|
|
5319
|
+
"filename": "lib/fleet-base.ts",
|
|
5320
|
+
"line": 360
|
|
5321
|
+
},
|
|
5322
|
+
"name": "locations",
|
|
5323
|
+
"optional": true,
|
|
5324
|
+
"type": {
|
|
5325
|
+
"collection": {
|
|
5326
|
+
"elementtype": {
|
|
5327
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.Location"
|
|
5328
|
+
},
|
|
5329
|
+
"kind": "array"
|
|
5330
|
+
}
|
|
5331
|
+
}
|
|
5332
|
+
},
|
|
5333
|
+
{
|
|
5334
|
+
"abstract": true,
|
|
5335
|
+
"docs": {
|
|
5336
|
+
"default": "the default is 1",
|
|
5337
|
+
"stability": "experimental",
|
|
5338
|
+
"summary": "The maximum number of instances that are allowed in the specified fleet location."
|
|
5339
|
+
},
|
|
5340
|
+
"immutable": true,
|
|
5341
|
+
"locationInModule": {
|
|
5342
|
+
"filename": "lib/fleet-base.ts",
|
|
5343
|
+
"line": 329
|
|
5344
|
+
},
|
|
5345
|
+
"name": "maxSize",
|
|
5346
|
+
"optional": true,
|
|
5347
|
+
"type": {
|
|
5348
|
+
"primitive": "number"
|
|
5349
|
+
}
|
|
5350
|
+
},
|
|
5351
|
+
{
|
|
5352
|
+
"abstract": true,
|
|
5353
|
+
"docs": {
|
|
5354
|
+
"default": "Fleet metrics are aggregated with other fleets in the default metric group",
|
|
5355
|
+
"remarks": "A metric group is used to aggregate the metrics for multiple fleets.\nYou can specify an existing metric group name or set a new name to create a new metric group.\nA fleet can be included in only one metric group at a time.",
|
|
5356
|
+
"stability": "experimental",
|
|
5357
|
+
"summary": "The name of an AWS CloudWatch metric group to add this fleet to."
|
|
5358
|
+
},
|
|
5359
|
+
"immutable": true,
|
|
5360
|
+
"locationInModule": {
|
|
5361
|
+
"filename": "lib/fleet-base.ts",
|
|
5362
|
+
"line": 298
|
|
5363
|
+
},
|
|
5364
|
+
"name": "metricGroup",
|
|
5365
|
+
"optional": true,
|
|
5366
|
+
"type": {
|
|
5367
|
+
"primitive": "string"
|
|
5368
|
+
}
|
|
5369
|
+
},
|
|
5370
|
+
{
|
|
5371
|
+
"abstract": true,
|
|
5372
|
+
"docs": {
|
|
5373
|
+
"default": "the default is 0",
|
|
5374
|
+
"stability": "experimental",
|
|
5375
|
+
"summary": "The minimum number of instances that are allowed in the specified fleet location."
|
|
5376
|
+
},
|
|
5377
|
+
"immutable": true,
|
|
5378
|
+
"locationInModule": {
|
|
5379
|
+
"filename": "lib/fleet-base.ts",
|
|
5380
|
+
"line": 322
|
|
5381
|
+
},
|
|
5382
|
+
"name": "minSize",
|
|
5383
|
+
"optional": true,
|
|
5384
|
+
"type": {
|
|
5385
|
+
"primitive": "number"
|
|
5386
|
+
}
|
|
5387
|
+
},
|
|
5388
|
+
{
|
|
5389
|
+
"abstract": true,
|
|
5390
|
+
"docs": {
|
|
5391
|
+
"default": "no vpc peering",
|
|
5392
|
+
"remarks": "Use Amazon Virtual Private Cloud (VPC) peering connections to enable your game servers to communicate directly and privately with your other AWS resources, such as a web service or a repository.\nYou can establish VPC peering with any resources that run on AWS and are managed by an AWS account that you have access to.\nThe VPC must be in the same Region as your fleet.\n\nWarning:\nBe sure to create a VPC Peering authorization through Gamelift Service API.",
|
|
5393
|
+
"see": "https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html",
|
|
5394
|
+
"stability": "experimental",
|
|
5395
|
+
"summary": "A VPC peering connection between your GameLift-hosted game servers and your other non-GameLift resources."
|
|
5396
|
+
},
|
|
5397
|
+
"immutable": true,
|
|
5398
|
+
"locationInModule": {
|
|
5399
|
+
"filename": "lib/fleet-base.ts",
|
|
5400
|
+
"line": 288
|
|
5401
|
+
},
|
|
5402
|
+
"name": "peerVpc",
|
|
5403
|
+
"optional": true,
|
|
5404
|
+
"type": {
|
|
5405
|
+
"fqn": "aws-cdk-lib.aws_ec2.IVpc"
|
|
5406
|
+
}
|
|
5407
|
+
},
|
|
5408
|
+
{
|
|
5409
|
+
"abstract": true,
|
|
5410
|
+
"docs": {
|
|
5411
|
+
"default": "true - Game sessions in `ACTIVE` status cannot be terminated during a scale-down event.",
|
|
5412
|
+
"remarks": "By default, new game sessions are protected and cannot be terminated during a scale-down event.",
|
|
5413
|
+
"stability": "experimental",
|
|
5414
|
+
"summary": "The status of termination protection for active game sessions on the fleet."
|
|
5415
|
+
},
|
|
5416
|
+
"immutable": true,
|
|
5417
|
+
"locationInModule": {
|
|
5418
|
+
"filename": "lib/fleet-base.ts",
|
|
5419
|
+
"line": 337
|
|
5420
|
+
},
|
|
5421
|
+
"name": "protectNewGameSession",
|
|
5422
|
+
"optional": true,
|
|
5423
|
+
"type": {
|
|
5424
|
+
"primitive": "boolean"
|
|
5425
|
+
}
|
|
5426
|
+
},
|
|
5427
|
+
{
|
|
5428
|
+
"abstract": true,
|
|
5429
|
+
"docs": {
|
|
5430
|
+
"default": "No resource creation limit policy",
|
|
5431
|
+
"stability": "experimental",
|
|
5432
|
+
"summary": "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."
|
|
5433
|
+
},
|
|
5434
|
+
"immutable": true,
|
|
5435
|
+
"locationInModule": {
|
|
5436
|
+
"filename": "lib/fleet-base.ts",
|
|
5437
|
+
"line": 367
|
|
5438
|
+
},
|
|
5439
|
+
"name": "resourceCreationLimitPolicy",
|
|
5440
|
+
"optional": true,
|
|
5441
|
+
"type": {
|
|
5442
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.ResourceCreationLimitPolicy"
|
|
5443
|
+
}
|
|
5444
|
+
},
|
|
5445
|
+
{
|
|
5446
|
+
"abstract": true,
|
|
5447
|
+
"docs": {
|
|
5448
|
+
"default": "- a role will be created with default trust to Gamelift service principal.",
|
|
5449
|
+
"remarks": "With a role set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes).\nIf providing a custom role, it needs to trust the GameLift service principal (gamelift.amazonaws.com).\nNo permission is required by default.\n\nThis property cannot be changed after the fleet is created.",
|
|
5450
|
+
"see": "https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html",
|
|
5451
|
+
"stability": "experimental",
|
|
5452
|
+
"summary": "The IAM role assumed by GameLift fleet instances to access AWS ressources."
|
|
5453
|
+
},
|
|
5454
|
+
"immutable": true,
|
|
5455
|
+
"locationInModule": {
|
|
5456
|
+
"filename": "lib/fleet-base.ts",
|
|
5457
|
+
"line": 273
|
|
5458
|
+
},
|
|
5459
|
+
"name": "role",
|
|
5460
|
+
"optional": true,
|
|
5461
|
+
"type": {
|
|
5462
|
+
"fqn": "aws-cdk-lib.aws_iam.IRole"
|
|
5463
|
+
}
|
|
5464
|
+
},
|
|
5465
|
+
{
|
|
5466
|
+
"abstract": true,
|
|
5467
|
+
"docs": {
|
|
5468
|
+
"default": "TLS/SSL certificate are generated for the fleet",
|
|
5469
|
+
"remarks": "GameLift uses the certificates to encrypt traffic between game clients and the game servers running on GameLift.\n\nYou can't change this property after you create the fleet.\n\nAdditionnal info:\nAWS Certificate Manager (ACM) certificates expire after 13 months.\nCertificate expiration can cause fleets to fail, preventing players from connecting to instances in the fleet.\nWe recommend you replace fleets before 13 months, consider using fleet aliases for a smooth transition.",
|
|
5470
|
+
"stability": "experimental",
|
|
5471
|
+
"summary": "Prompts GameLift to generate a TLS/SSL certificate for the fleet."
|
|
5472
|
+
},
|
|
5473
|
+
"immutable": true,
|
|
5474
|
+
"locationInModule": {
|
|
5475
|
+
"filename": "lib/fleet-base.ts",
|
|
5476
|
+
"line": 259
|
|
5477
|
+
},
|
|
5478
|
+
"name": "useCertificate",
|
|
5479
|
+
"optional": true,
|
|
5480
|
+
"type": {
|
|
5481
|
+
"primitive": "boolean"
|
|
5482
|
+
}
|
|
5483
|
+
},
|
|
5484
|
+
{
|
|
5485
|
+
"abstract": true,
|
|
5486
|
+
"docs": {
|
|
5487
|
+
"default": "Gamelift fleet use on demand capacity",
|
|
5488
|
+
"remarks": "This property cannot be changed after the fleet is created.",
|
|
5489
|
+
"see": "https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-ec2-instances.html#gamelift-ec2-instances-spot",
|
|
5490
|
+
"stability": "experimental",
|
|
5491
|
+
"summary": "Indicates whether to use On-Demand or Spot instances for this fleet. By default, fleet use on demand capacity."
|
|
5492
|
+
},
|
|
5493
|
+
"immutable": true,
|
|
5494
|
+
"locationInModule": {
|
|
5495
|
+
"filename": "lib/fleet-base.ts",
|
|
5496
|
+
"line": 244
|
|
5497
|
+
},
|
|
5498
|
+
"name": "useSpot",
|
|
5499
|
+
"optional": true,
|
|
5500
|
+
"type": {
|
|
5501
|
+
"primitive": "boolean"
|
|
5502
|
+
}
|
|
5503
|
+
}
|
|
5504
|
+
],
|
|
5505
|
+
"symbolId": "lib/fleet-base:FleetProps"
|
|
5506
|
+
},
|
|
5507
|
+
"@aws-cdk/aws-gamelift-alpha.GameServerGroup": {
|
|
5508
|
+
"assembly": "@aws-cdk/aws-gamelift-alpha",
|
|
5509
|
+
"base": "@aws-cdk/aws-gamelift-alpha.GameServerGroupBase",
|
|
5510
|
+
"docs": {
|
|
5511
|
+
"custom": {
|
|
5512
|
+
"resource": "AWS::GameLift::GameServerGroup",
|
|
5513
|
+
"exampleMetadata": "infused"
|
|
5514
|
+
},
|
|
5515
|
+
"remarks": "This operation creates the game server group, creates an Auto Scaling group in your AWS account, and establishes a link between the two groups.\nYou can view the status of your game server groups in the GameLift console.\nGame server group metrics and events are emitted to Amazon CloudWatch.\nBefore creating a new game server group, you must have the following:\n - An Amazon EC2 launch template that specifies how to launch Amazon EC2 instances with your game server build.\n - An IAM role that extends limited access to your AWS account to allow GameLift FleetIQ to create and interact with the Auto Scaling group.\n\nTo 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.\nYou must also set initial maximum and minimum limits on the group's instance count.\nYou can optionally set an Auto Scaling policy with target tracking based on a GameLift FleetIQ metric.\n\nOnce 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.\nSeveral 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.\nKeep 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.",
|
|
5516
|
+
"see": "https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html",
|
|
5517
|
+
"stability": "experimental",
|
|
5518
|
+
"summary": "Creates a GameLift FleetIQ game server group for managing game hosting on a collection of Amazon EC2 instances for game hosting.",
|
|
5519
|
+
"example": "declare const launchTemplate: ec2.ILaunchTemplate;\ndeclare const vpc: ec2.IVpc;\n\nnew gamelift.GameServerGroup(this, 'GameServerGroup', {\n gameServerGroupName: 'sample-gameservergroup-name',\n instanceDefinitions: [{\n instanceType: ec2.InstanceType.of(ec2.InstanceClass.C5, ec2.InstanceSize.LARGE),\n },\n {\n instanceType: ec2.InstanceType.of(ec2.InstanceClass.C4, ec2.InstanceSize.LARGE),\n }],\n launchTemplate: launchTemplate,\n vpc: vpc,\n vpcSubnets: { subnetType: ec2.SubnetType.PUBLIC }\n});"
|
|
5520
|
+
},
|
|
5521
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.GameServerGroup",
|
|
5522
|
+
"initializer": {
|
|
5523
|
+
"docs": {
|
|
5524
|
+
"stability": "experimental"
|
|
5525
|
+
},
|
|
5526
|
+
"locationInModule": {
|
|
5527
|
+
"filename": "lib/game-server-group.ts",
|
|
5528
|
+
"line": 420
|
|
5529
|
+
},
|
|
5530
|
+
"parameters": [
|
|
5531
|
+
{
|
|
5532
|
+
"name": "scope",
|
|
5533
|
+
"type": {
|
|
5534
|
+
"fqn": "constructs.Construct"
|
|
5535
|
+
}
|
|
5536
|
+
},
|
|
5537
|
+
{
|
|
5538
|
+
"name": "id",
|
|
5539
|
+
"type": {
|
|
5540
|
+
"primitive": "string"
|
|
5541
|
+
}
|
|
5542
|
+
},
|
|
5543
|
+
{
|
|
5544
|
+
"name": "props",
|
|
5545
|
+
"type": {
|
|
5546
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.GameServerGroupProps"
|
|
5547
|
+
}
|
|
5548
|
+
}
|
|
5549
|
+
]
|
|
5550
|
+
},
|
|
5551
|
+
"kind": "class",
|
|
5552
|
+
"locationInModule": {
|
|
5553
|
+
"filename": "lib/game-server-group.ts",
|
|
5554
|
+
"line": 346
|
|
5555
|
+
},
|
|
5556
|
+
"methods": [
|
|
5557
|
+
{
|
|
5558
|
+
"docs": {
|
|
5559
|
+
"stability": "experimental",
|
|
5560
|
+
"summary": "Import an existing game server group from its attributes."
|
|
5561
|
+
},
|
|
5562
|
+
"locationInModule": {
|
|
5563
|
+
"filename": "lib/game-server-group.ts",
|
|
5564
|
+
"line": 351
|
|
5565
|
+
},
|
|
5566
|
+
"name": "fromGameServerGroupAttributes",
|
|
5567
|
+
"parameters": [
|
|
5568
|
+
{
|
|
5569
|
+
"name": "scope",
|
|
5570
|
+
"type": {
|
|
5571
|
+
"fqn": "constructs.Construct"
|
|
5572
|
+
}
|
|
5573
|
+
},
|
|
5574
|
+
{
|
|
5575
|
+
"name": "id",
|
|
5576
|
+
"type": {
|
|
5577
|
+
"primitive": "string"
|
|
5578
|
+
}
|
|
5579
|
+
},
|
|
5580
|
+
{
|
|
5581
|
+
"name": "attrs",
|
|
5582
|
+
"type": {
|
|
5583
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.GameServerGroupAttributes"
|
|
5584
|
+
}
|
|
5585
|
+
}
|
|
5586
|
+
],
|
|
5587
|
+
"returns": {
|
|
5588
|
+
"type": {
|
|
5589
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.IGameServerGroup"
|
|
5590
|
+
}
|
|
5591
|
+
},
|
|
5592
|
+
"static": true
|
|
5593
|
+
},
|
|
5594
|
+
{
|
|
5595
|
+
"docs": {
|
|
5596
|
+
"stability": "experimental"
|
|
5597
|
+
},
|
|
5598
|
+
"locationInModule": {
|
|
5599
|
+
"filename": "lib/game-server-group.ts",
|
|
5600
|
+
"line": 504
|
|
5601
|
+
},
|
|
5602
|
+
"name": "parseAutoScalingPolicy",
|
|
5603
|
+
"parameters": [
|
|
5604
|
+
{
|
|
5605
|
+
"name": "props",
|
|
5606
|
+
"type": {
|
|
5607
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.GameServerGroupProps"
|
|
5608
|
+
}
|
|
5609
|
+
}
|
|
5610
|
+
],
|
|
5611
|
+
"protected": true,
|
|
5612
|
+
"returns": {
|
|
5613
|
+
"optional": true,
|
|
5614
|
+
"type": {
|
|
5615
|
+
"fqn": "aws-cdk-lib.aws_gamelift.CfnGameServerGroup.AutoScalingPolicyProperty"
|
|
5616
|
+
}
|
|
5617
|
+
}
|
|
5618
|
+
},
|
|
5619
|
+
{
|
|
5620
|
+
"docs": {
|
|
5621
|
+
"stability": "experimental"
|
|
5622
|
+
},
|
|
5623
|
+
"locationInModule": {
|
|
5624
|
+
"filename": "lib/game-server-group.ts",
|
|
5625
|
+
"line": 517
|
|
5626
|
+
},
|
|
5627
|
+
"name": "parseInstanceDefinitions",
|
|
5628
|
+
"parameters": [
|
|
5629
|
+
{
|
|
5630
|
+
"name": "props",
|
|
5631
|
+
"type": {
|
|
5632
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.GameServerGroupProps"
|
|
5633
|
+
}
|
|
5634
|
+
}
|
|
5635
|
+
],
|
|
5636
|
+
"protected": true,
|
|
5637
|
+
"returns": {
|
|
5638
|
+
"type": {
|
|
5639
|
+
"collection": {
|
|
5640
|
+
"elementtype": {
|
|
5641
|
+
"fqn": "aws-cdk-lib.aws_gamelift.CfnGameServerGroup.InstanceDefinitionProperty"
|
|
5642
|
+
},
|
|
5643
|
+
"kind": "array"
|
|
5644
|
+
}
|
|
5645
|
+
}
|
|
5646
|
+
}
|
|
5647
|
+
},
|
|
5648
|
+
{
|
|
5649
|
+
"docs": {
|
|
5650
|
+
"stability": "experimental"
|
|
5651
|
+
},
|
|
5652
|
+
"locationInModule": {
|
|
5653
|
+
"filename": "lib/game-server-group.ts",
|
|
5654
|
+
"line": 496
|
|
5655
|
+
},
|
|
5656
|
+
"name": "parseLaunchTemplate",
|
|
5657
|
+
"parameters": [
|
|
5658
|
+
{
|
|
5659
|
+
"name": "props",
|
|
5660
|
+
"type": {
|
|
5661
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.GameServerGroupProps"
|
|
5662
|
+
}
|
|
5663
|
+
}
|
|
5664
|
+
],
|
|
5665
|
+
"protected": true,
|
|
5666
|
+
"returns": {
|
|
5667
|
+
"type": {
|
|
5668
|
+
"fqn": "aws-cdk-lib.aws_gamelift.CfnGameServerGroup.LaunchTemplateProperty"
|
|
5669
|
+
}
|
|
5670
|
+
}
|
|
5671
|
+
}
|
|
5672
|
+
],
|
|
5673
|
+
"name": "GameServerGroup",
|
|
5674
|
+
"properties": [
|
|
5675
|
+
{
|
|
5676
|
+
"docs": {
|
|
5677
|
+
"stability": "experimental",
|
|
5678
|
+
"summary": "The ARN of the generated AutoScaling group."
|
|
5679
|
+
},
|
|
5680
|
+
"immutable": true,
|
|
5681
|
+
"locationInModule": {
|
|
5682
|
+
"filename": "lib/game-server-group.ts",
|
|
5683
|
+
"line": 398
|
|
5684
|
+
},
|
|
5685
|
+
"name": "autoScalingGroupArn",
|
|
5686
|
+
"overrides": "@aws-cdk/aws-gamelift-alpha.GameServerGroupBase",
|
|
5687
|
+
"type": {
|
|
5688
|
+
"primitive": "string"
|
|
5689
|
+
}
|
|
5690
|
+
},
|
|
5691
|
+
{
|
|
5692
|
+
"docs": {
|
|
5693
|
+
"stability": "experimental",
|
|
5694
|
+
"summary": "The ARN of the game server group."
|
|
5695
|
+
},
|
|
5696
|
+
"immutable": true,
|
|
5697
|
+
"locationInModule": {
|
|
5698
|
+
"filename": "lib/game-server-group.ts",
|
|
5699
|
+
"line": 393
|
|
5700
|
+
},
|
|
5701
|
+
"name": "gameServerGroupArn",
|
|
5702
|
+
"overrides": "@aws-cdk/aws-gamelift-alpha.GameServerGroupBase",
|
|
5703
|
+
"type": {
|
|
5704
|
+
"primitive": "string"
|
|
5705
|
+
}
|
|
5706
|
+
},
|
|
5707
|
+
{
|
|
5708
|
+
"docs": {
|
|
5709
|
+
"stability": "experimental",
|
|
5710
|
+
"summary": "The name of the game server group."
|
|
5711
|
+
},
|
|
5712
|
+
"immutable": true,
|
|
5713
|
+
"locationInModule": {
|
|
5714
|
+
"filename": "lib/game-server-group.ts",
|
|
5715
|
+
"line": 388
|
|
5716
|
+
},
|
|
5717
|
+
"name": "gameServerGroupName",
|
|
5718
|
+
"overrides": "@aws-cdk/aws-gamelift-alpha.GameServerGroupBase",
|
|
5719
|
+
"type": {
|
|
5720
|
+
"primitive": "string"
|
|
5721
|
+
}
|
|
5722
|
+
},
|
|
5723
|
+
{
|
|
5724
|
+
"docs": {
|
|
5725
|
+
"stability": "experimental",
|
|
5726
|
+
"summary": "The principal this GameLift game server group is using."
|
|
5727
|
+
},
|
|
5728
|
+
"immutable": true,
|
|
5729
|
+
"locationInModule": {
|
|
5730
|
+
"filename": "lib/game-server-group.ts",
|
|
5731
|
+
"line": 408
|
|
5732
|
+
},
|
|
5733
|
+
"name": "grantPrincipal",
|
|
5734
|
+
"overrides": "@aws-cdk/aws-gamelift-alpha.GameServerGroupBase",
|
|
5735
|
+
"type": {
|
|
5736
|
+
"fqn": "aws-cdk-lib.aws_iam.IPrincipal"
|
|
5737
|
+
}
|
|
5738
|
+
},
|
|
5739
|
+
{
|
|
5740
|
+
"docs": {
|
|
5741
|
+
"stability": "experimental",
|
|
5742
|
+
"summary": "The IAM role that allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups."
|
|
5743
|
+
},
|
|
5744
|
+
"immutable": true,
|
|
5745
|
+
"locationInModule": {
|
|
5746
|
+
"filename": "lib/game-server-group.ts",
|
|
5747
|
+
"line": 403
|
|
5748
|
+
},
|
|
5749
|
+
"name": "role",
|
|
5750
|
+
"type": {
|
|
5751
|
+
"fqn": "aws-cdk-lib.aws_iam.IRole"
|
|
5752
|
+
}
|
|
5753
|
+
},
|
|
5754
|
+
{
|
|
5755
|
+
"docs": {
|
|
5756
|
+
"stability": "experimental",
|
|
5757
|
+
"summary": "The VPC network to place the game server group in."
|
|
5758
|
+
},
|
|
5759
|
+
"immutable": true,
|
|
5760
|
+
"locationInModule": {
|
|
5761
|
+
"filename": "lib/game-server-group.ts",
|
|
5762
|
+
"line": 413
|
|
5763
|
+
},
|
|
5764
|
+
"name": "vpc",
|
|
5765
|
+
"type": {
|
|
5766
|
+
"fqn": "aws-cdk-lib.aws_ec2.IVpc"
|
|
5767
|
+
}
|
|
5768
|
+
},
|
|
5769
|
+
{
|
|
5770
|
+
"docs": {
|
|
5771
|
+
"stability": "experimental",
|
|
5772
|
+
"summary": "The game server group's subnets."
|
|
5773
|
+
},
|
|
5774
|
+
"immutable": true,
|
|
5775
|
+
"locationInModule": {
|
|
5776
|
+
"filename": "lib/game-server-group.ts",
|
|
5777
|
+
"line": 418
|
|
5778
|
+
},
|
|
5779
|
+
"name": "vpcSubnets",
|
|
5780
|
+
"optional": true,
|
|
5781
|
+
"type": {
|
|
5782
|
+
"fqn": "aws-cdk-lib.aws_ec2.SubnetSelection"
|
|
5783
|
+
}
|
|
5784
|
+
}
|
|
5785
|
+
],
|
|
5786
|
+
"symbolId": "lib/game-server-group:GameServerGroup"
|
|
5787
|
+
},
|
|
5788
|
+
"@aws-cdk/aws-gamelift-alpha.GameServerGroupAttributes": {
|
|
5789
|
+
"assembly": "@aws-cdk/aws-gamelift-alpha",
|
|
5790
|
+
"datatype": true,
|
|
5791
|
+
"docs": {
|
|
5792
|
+
"stability": "experimental",
|
|
5793
|
+
"summary": "Represents a GameServerGroup content defined outside of this stack.",
|
|
5794
|
+
"example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as gamelift_alpha from '@aws-cdk/aws-gamelift-alpha';\nimport { aws_iam as iam } from 'aws-cdk-lib';\n\ndeclare const role: iam.Role;\nconst gameServerGroupAttributes: gamelift_alpha.GameServerGroupAttributes = {\n autoScalingGroupArn: 'autoScalingGroupArn',\n\n // the properties below are optional\n gameServerGroupArn: 'gameServerGroupArn',\n gameServerGroupName: 'gameServerGroupName',\n role: role,\n};",
|
|
5795
|
+
"custom": {
|
|
5796
|
+
"exampleMetadata": "fixture=_generated"
|
|
5797
|
+
}
|
|
5798
|
+
},
|
|
5799
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.GameServerGroupAttributes",
|
|
5800
|
+
"kind": "interface",
|
|
5801
|
+
"locationInModule": {
|
|
5802
|
+
"filename": "lib/game-server-group.ts",
|
|
5803
|
+
"line": 178
|
|
5804
|
+
},
|
|
5805
|
+
"name": "GameServerGroupAttributes",
|
|
5806
|
+
"properties": [
|
|
5807
|
+
{
|
|
5808
|
+
"abstract": true,
|
|
5809
|
+
"docs": {
|
|
5810
|
+
"default": "the imported game server group does not have autoscaling group information",
|
|
5811
|
+
"stability": "experimental",
|
|
5812
|
+
"summary": "The ARN of the generated AutoScaling group."
|
|
5813
|
+
},
|
|
5814
|
+
"immutable": true,
|
|
5815
|
+
"locationInModule": {
|
|
5816
|
+
"filename": "lib/game-server-group.ts",
|
|
5817
|
+
"line": 202
|
|
5818
|
+
},
|
|
5819
|
+
"name": "autoScalingGroupArn",
|
|
5820
|
+
"type": {
|
|
5821
|
+
"primitive": "string"
|
|
5822
|
+
}
|
|
5823
|
+
},
|
|
5824
|
+
{
|
|
5825
|
+
"abstract": true,
|
|
5826
|
+
"docs": {
|
|
5827
|
+
"default": "derived from `gameServerGroupName`.",
|
|
5828
|
+
"remarks": "At least one of `gameServerGroupArn` and `gameServerGroupName` must be provided.",
|
|
5829
|
+
"stability": "experimental",
|
|
5830
|
+
"summary": "The ARN of the game server group."
|
|
5831
|
+
},
|
|
5832
|
+
"immutable": true,
|
|
5833
|
+
"locationInModule": {
|
|
5834
|
+
"filename": "lib/game-server-group.ts",
|
|
5835
|
+
"line": 195
|
|
5836
|
+
},
|
|
5837
|
+
"name": "gameServerGroupArn",
|
|
5838
|
+
"optional": true,
|
|
5839
|
+
"type": {
|
|
5840
|
+
"primitive": "string"
|
|
5841
|
+
}
|
|
5842
|
+
},
|
|
5843
|
+
{
|
|
5844
|
+
"abstract": true,
|
|
5845
|
+
"docs": {
|
|
5846
|
+
"default": "derived from `gameServerGroupArn`.",
|
|
5847
|
+
"remarks": "At least one of `gameServerGroupArn` and `gameServerGroupName` must be provided.",
|
|
5848
|
+
"stability": "experimental",
|
|
5849
|
+
"summary": "The name of the game server group."
|
|
5850
|
+
},
|
|
5851
|
+
"immutable": true,
|
|
5852
|
+
"locationInModule": {
|
|
5853
|
+
"filename": "lib/game-server-group.ts",
|
|
5854
|
+
"line": 187
|
|
5855
|
+
},
|
|
5856
|
+
"name": "gameServerGroupName",
|
|
5857
|
+
"optional": true,
|
|
5858
|
+
"type": {
|
|
5859
|
+
"primitive": "string"
|
|
5860
|
+
}
|
|
5861
|
+
},
|
|
5862
|
+
{
|
|
5863
|
+
"abstract": true,
|
|
5864
|
+
"docs": {
|
|
5865
|
+
"default": "the imported game server group cannot be granted access to other resources as an `iam.IGrantable`.",
|
|
5866
|
+
"stability": "experimental",
|
|
5867
|
+
"summary": "The IAM role that allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups."
|
|
5868
|
+
},
|
|
5869
|
+
"immutable": true,
|
|
5870
|
+
"locationInModule": {
|
|
5871
|
+
"filename": "lib/game-server-group.ts",
|
|
5872
|
+
"line": 209
|
|
5873
|
+
},
|
|
5874
|
+
"name": "role",
|
|
5875
|
+
"optional": true,
|
|
5876
|
+
"type": {
|
|
5877
|
+
"fqn": "aws-cdk-lib.aws_iam.IRole"
|
|
5878
|
+
}
|
|
5879
|
+
}
|
|
5880
|
+
],
|
|
5881
|
+
"symbolId": "lib/game-server-group:GameServerGroupAttributes"
|
|
5882
|
+
},
|
|
5883
|
+
"@aws-cdk/aws-gamelift-alpha.GameServerGroupBase": {
|
|
5884
|
+
"abstract": true,
|
|
5885
|
+
"assembly": "@aws-cdk/aws-gamelift-alpha",
|
|
5886
|
+
"base": "aws-cdk-lib.Resource",
|
|
5887
|
+
"docs": {
|
|
5888
|
+
"stability": "experimental",
|
|
5889
|
+
"summary": "Base class for new and imported GameLift FleetIQ game server group."
|
|
5890
|
+
},
|
|
5891
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.GameServerGroupBase",
|
|
5892
|
+
"initializer": {
|
|
5893
|
+
"docs": {
|
|
5894
|
+
"stability": "stable"
|
|
5895
|
+
},
|
|
5896
|
+
"locationInModule": {
|
|
5897
|
+
"filename": "core/lib/resource.ts",
|
|
5898
|
+
"line": 156
|
|
5899
|
+
},
|
|
5900
|
+
"parameters": [
|
|
5901
|
+
{
|
|
5902
|
+
"name": "scope",
|
|
5903
|
+
"type": {
|
|
5904
|
+
"fqn": "constructs.Construct"
|
|
5905
|
+
}
|
|
5906
|
+
},
|
|
5907
|
+
{
|
|
5908
|
+
"name": "id",
|
|
5909
|
+
"type": {
|
|
5910
|
+
"primitive": "string"
|
|
5911
|
+
}
|
|
5912
|
+
},
|
|
5913
|
+
{
|
|
5914
|
+
"name": "props",
|
|
5915
|
+
"optional": true,
|
|
5916
|
+
"type": {
|
|
5917
|
+
"fqn": "aws-cdk-lib.ResourceProps"
|
|
5918
|
+
}
|
|
5919
|
+
}
|
|
5920
|
+
]
|
|
5921
|
+
},
|
|
5922
|
+
"interfaces": [
|
|
5923
|
+
"@aws-cdk/aws-gamelift-alpha.IGameServerGroup"
|
|
5924
|
+
],
|
|
5925
|
+
"kind": "class",
|
|
5926
|
+
"locationInModule": {
|
|
5927
|
+
"filename": "lib/game-server-group.ts",
|
|
5928
|
+
"line": 132
|
|
5929
|
+
},
|
|
5930
|
+
"methods": [
|
|
5931
|
+
{
|
|
5932
|
+
"docs": {
|
|
5933
|
+
"stability": "experimental",
|
|
5934
|
+
"summary": "Grant the `grantee` identity permissions to perform `actions`."
|
|
5935
|
+
},
|
|
5936
|
+
"locationInModule": {
|
|
5937
|
+
"filename": "lib/game-server-group.ts",
|
|
5938
|
+
"line": 154
|
|
5939
|
+
},
|
|
5940
|
+
"name": "grant",
|
|
5941
|
+
"overrides": "@aws-cdk/aws-gamelift-alpha.IGameServerGroup",
|
|
5942
|
+
"parameters": [
|
|
5943
|
+
{
|
|
5944
|
+
"name": "grantee",
|
|
5945
|
+
"type": {
|
|
5946
|
+
"fqn": "aws-cdk-lib.aws_iam.IGrantable"
|
|
5947
|
+
}
|
|
5948
|
+
},
|
|
5949
|
+
{
|
|
5950
|
+
"name": "actions",
|
|
5951
|
+
"type": {
|
|
5952
|
+
"primitive": "string"
|
|
5953
|
+
},
|
|
5954
|
+
"variadic": true
|
|
5955
|
+
}
|
|
5956
|
+
],
|
|
5957
|
+
"returns": {
|
|
5958
|
+
"type": {
|
|
5959
|
+
"fqn": "aws-cdk-lib.aws_iam.Grant"
|
|
5960
|
+
}
|
|
5961
|
+
},
|
|
5962
|
+
"variadic": true
|
|
5963
|
+
},
|
|
5964
|
+
{
|
|
5965
|
+
"docs": {
|
|
5966
|
+
"stability": "experimental",
|
|
5967
|
+
"summary": "Return the given named metric for this fleet."
|
|
5968
|
+
},
|
|
5969
|
+
"locationInModule": {
|
|
5970
|
+
"filename": "lib/game-server-group.ts",
|
|
5971
|
+
"line": 162
|
|
5972
|
+
},
|
|
5973
|
+
"name": "metric",
|
|
5974
|
+
"overrides": "@aws-cdk/aws-gamelift-alpha.IGameServerGroup",
|
|
5975
|
+
"parameters": [
|
|
5976
|
+
{
|
|
5977
|
+
"name": "metricName",
|
|
5978
|
+
"type": {
|
|
5979
|
+
"primitive": "string"
|
|
5980
|
+
}
|
|
5981
|
+
},
|
|
5982
|
+
{
|
|
5983
|
+
"name": "props",
|
|
5984
|
+
"optional": true,
|
|
5985
|
+
"type": {
|
|
5986
|
+
"fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
|
|
5987
|
+
}
|
|
5988
|
+
}
|
|
5989
|
+
],
|
|
5990
|
+
"returns": {
|
|
5991
|
+
"type": {
|
|
5992
|
+
"fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
|
|
5993
|
+
}
|
|
5994
|
+
}
|
|
5995
|
+
}
|
|
5996
|
+
],
|
|
5997
|
+
"name": "GameServerGroupBase",
|
|
5998
|
+
"properties": [
|
|
5999
|
+
{
|
|
6000
|
+
"abstract": true,
|
|
6001
|
+
"docs": {
|
|
6002
|
+
"stability": "experimental",
|
|
6003
|
+
"summary": "The ARN of the generated AutoScaling group."
|
|
6004
|
+
},
|
|
6005
|
+
"immutable": true,
|
|
6006
|
+
"locationInModule": {
|
|
6007
|
+
"filename": "lib/game-server-group.ts",
|
|
6008
|
+
"line": 142
|
|
6009
|
+
},
|
|
6010
|
+
"name": "autoScalingGroupArn",
|
|
6011
|
+
"overrides": "@aws-cdk/aws-gamelift-alpha.IGameServerGroup",
|
|
6012
|
+
"type": {
|
|
6013
|
+
"primitive": "string"
|
|
6014
|
+
}
|
|
6015
|
+
},
|
|
6016
|
+
{
|
|
6017
|
+
"abstract": true,
|
|
6018
|
+
"docs": {
|
|
6019
|
+
"stability": "experimental",
|
|
6020
|
+
"summary": "The ARN of the game server group."
|
|
6021
|
+
},
|
|
6022
|
+
"immutable": true,
|
|
6023
|
+
"locationInModule": {
|
|
6024
|
+
"filename": "lib/game-server-group.ts",
|
|
6025
|
+
"line": 137
|
|
6026
|
+
},
|
|
6027
|
+
"name": "gameServerGroupArn",
|
|
6028
|
+
"overrides": "@aws-cdk/aws-gamelift-alpha.IGameServerGroup",
|
|
6029
|
+
"type": {
|
|
6030
|
+
"primitive": "string"
|
|
6031
|
+
}
|
|
6032
|
+
},
|
|
6033
|
+
{
|
|
6034
|
+
"abstract": true,
|
|
6035
|
+
"docs": {
|
|
6036
|
+
"stability": "experimental",
|
|
6037
|
+
"summary": "The name of the game server group."
|
|
6038
|
+
},
|
|
6039
|
+
"immutable": true,
|
|
6040
|
+
"locationInModule": {
|
|
6041
|
+
"filename": "lib/game-server-group.ts",
|
|
6042
|
+
"line": 147
|
|
6043
|
+
},
|
|
6044
|
+
"name": "gameServerGroupName",
|
|
6045
|
+
"overrides": "@aws-cdk/aws-gamelift-alpha.IGameServerGroup",
|
|
6046
|
+
"type": {
|
|
6047
|
+
"primitive": "string"
|
|
6048
|
+
}
|
|
6049
|
+
},
|
|
6050
|
+
{
|
|
6051
|
+
"abstract": true,
|
|
6052
|
+
"docs": {
|
|
6053
|
+
"stability": "experimental",
|
|
6054
|
+
"summary": "The principal this GameLift game server group is using."
|
|
6055
|
+
},
|
|
6056
|
+
"immutable": true,
|
|
6057
|
+
"locationInModule": {
|
|
6058
|
+
"filename": "lib/game-server-group.ts",
|
|
6059
|
+
"line": 152
|
|
6060
|
+
},
|
|
6061
|
+
"name": "grantPrincipal",
|
|
6062
|
+
"overrides": "aws-cdk-lib.aws_iam.IGrantable",
|
|
6063
|
+
"type": {
|
|
6064
|
+
"fqn": "aws-cdk-lib.aws_iam.IPrincipal"
|
|
6065
|
+
}
|
|
6066
|
+
}
|
|
6067
|
+
],
|
|
6068
|
+
"symbolId": "lib/game-server-group:GameServerGroupBase"
|
|
6069
|
+
},
|
|
6070
|
+
"@aws-cdk/aws-gamelift-alpha.GameServerGroupProps": {
|
|
6071
|
+
"assembly": "@aws-cdk/aws-gamelift-alpha",
|
|
6072
|
+
"datatype": true,
|
|
6073
|
+
"docs": {
|
|
6074
|
+
"stability": "experimental",
|
|
6075
|
+
"summary": "Properties for a new Gamelift FleetIQ Game server group.",
|
|
6076
|
+
"example": "declare const launchTemplate: ec2.ILaunchTemplate;\ndeclare const vpc: ec2.IVpc;\n\nnew gamelift.GameServerGroup(this, 'GameServerGroup', {\n gameServerGroupName: 'sample-gameservergroup-name',\n instanceDefinitions: [{\n instanceType: ec2.InstanceType.of(ec2.InstanceClass.C5, ec2.InstanceSize.LARGE),\n },\n {\n instanceType: ec2.InstanceType.of(ec2.InstanceClass.C4, ec2.InstanceSize.LARGE),\n }],\n launchTemplate: launchTemplate,\n vpc: vpc,\n vpcSubnets: { subnetType: ec2.SubnetType.PUBLIC }\n});",
|
|
6077
|
+
"custom": {
|
|
6078
|
+
"exampleMetadata": "infused"
|
|
6079
|
+
}
|
|
6080
|
+
},
|
|
6081
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.GameServerGroupProps",
|
|
6082
|
+
"kind": "interface",
|
|
6083
|
+
"locationInModule": {
|
|
6084
|
+
"filename": "lib/game-server-group.ts",
|
|
6085
|
+
"line": 215
|
|
6086
|
+
},
|
|
6087
|
+
"name": "GameServerGroupProps",
|
|
6088
|
+
"properties": [
|
|
6089
|
+
{
|
|
6090
|
+
"abstract": true,
|
|
6091
|
+
"docs": {
|
|
6092
|
+
"remarks": "The name is unique for each Region in each AWS account.",
|
|
6093
|
+
"stability": "experimental",
|
|
6094
|
+
"summary": "A developer-defined identifier for the game server group."
|
|
6095
|
+
},
|
|
6096
|
+
"immutable": true,
|
|
6097
|
+
"locationInModule": {
|
|
6098
|
+
"filename": "lib/game-server-group.ts",
|
|
6099
|
+
"line": 220
|
|
6100
|
+
},
|
|
6101
|
+
"name": "gameServerGroupName",
|
|
6102
|
+
"type": {
|
|
6103
|
+
"primitive": "string"
|
|
6104
|
+
}
|
|
6105
|
+
},
|
|
6106
|
+
{
|
|
6107
|
+
"abstract": true,
|
|
6108
|
+
"docs": {
|
|
6109
|
+
"stability": "experimental",
|
|
6110
|
+
"summary": "The set of Amazon EC2 instance types that GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group."
|
|
6111
|
+
},
|
|
6112
|
+
"immutable": true,
|
|
6113
|
+
"locationInModule": {
|
|
6114
|
+
"filename": "lib/game-server-group.ts",
|
|
6115
|
+
"line": 275
|
|
6116
|
+
},
|
|
6117
|
+
"name": "instanceDefinitions",
|
|
6118
|
+
"type": {
|
|
6119
|
+
"collection": {
|
|
6120
|
+
"elementtype": {
|
|
6121
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.InstanceDefinition"
|
|
6122
|
+
},
|
|
6123
|
+
"kind": "array"
|
|
6124
|
+
}
|
|
6125
|
+
}
|
|
6126
|
+
},
|
|
6127
|
+
{
|
|
6128
|
+
"abstract": true,
|
|
6129
|
+
"docs": {
|
|
6130
|
+
"remarks": "After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs.\n\nNOTE:\nIf you specify network interfaces in your launch template, you must explicitly set the property AssociatePublicIpAddress to `true`.\nIf no network interface is specified in the launch template, GameLift FleetIQ uses your account's default VPC.",
|
|
6131
|
+
"see": "https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html",
|
|
6132
|
+
"stability": "experimental",
|
|
6133
|
+
"summary": "The Amazon EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group."
|
|
6134
|
+
},
|
|
6135
|
+
"immutable": true,
|
|
6136
|
+
"locationInModule": {
|
|
6137
|
+
"filename": "lib/game-server-group.ts",
|
|
6138
|
+
"line": 287
|
|
6139
|
+
},
|
|
6140
|
+
"name": "launchTemplate",
|
|
6141
|
+
"type": {
|
|
6142
|
+
"fqn": "aws-cdk-lib.aws_ec2.ILaunchTemplate"
|
|
6143
|
+
}
|
|
6144
|
+
},
|
|
6145
|
+
{
|
|
6146
|
+
"abstract": true,
|
|
6147
|
+
"docs": {
|
|
6148
|
+
"remarks": "By default, all GameLift FleetIQ-supported Availability Zones are used.\n\nYou can use this parameter to specify VPCs that you've set up.\n\nThis property cannot be updated after the game server group is created,\nand the corresponding Auto Scaling group will always use the property value that is set with this request,\neven if the Auto Scaling group is updated directly.",
|
|
6149
|
+
"stability": "experimental",
|
|
6150
|
+
"summary": "The VPC network to place the game server group in."
|
|
6151
|
+
},
|
|
6152
|
+
"immutable": true,
|
|
6153
|
+
"locationInModule": {
|
|
6154
|
+
"filename": "lib/game-server-group.ts",
|
|
6155
|
+
"line": 263
|
|
6156
|
+
},
|
|
6157
|
+
"name": "vpc",
|
|
6158
|
+
"type": {
|
|
6159
|
+
"fqn": "aws-cdk-lib.aws_ec2.IVpc"
|
|
6160
|
+
}
|
|
6161
|
+
},
|
|
6162
|
+
{
|
|
6163
|
+
"abstract": true,
|
|
6164
|
+
"docs": {
|
|
6165
|
+
"default": "no autoscaling policy settled",
|
|
6166
|
+
"remarks": "The scaling policy uses the metric `PercentUtilizedGameServers` to maintain a buffer of idle game servers that can immediately accommodate new games and players.\n\nAfter the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs.",
|
|
6167
|
+
"stability": "experimental",
|
|
6168
|
+
"summary": "Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting."
|
|
6169
|
+
},
|
|
6170
|
+
"immutable": true,
|
|
6171
|
+
"locationInModule": {
|
|
6172
|
+
"filename": "lib/game-server-group.ts",
|
|
6173
|
+
"line": 308
|
|
6174
|
+
},
|
|
6175
|
+
"name": "autoScalingPolicy",
|
|
6176
|
+
"optional": true,
|
|
6177
|
+
"type": {
|
|
6178
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.AutoScalingPolicy"
|
|
6179
|
+
}
|
|
6180
|
+
},
|
|
6181
|
+
{
|
|
6182
|
+
"abstract": true,
|
|
6183
|
+
"docs": {
|
|
6184
|
+
"default": "SPOT_PREFERRED",
|
|
6185
|
+
"stability": "experimental",
|
|
6186
|
+
"summary": "Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group."
|
|
6187
|
+
},
|
|
6188
|
+
"immutable": true,
|
|
6189
|
+
"locationInModule": {
|
|
6190
|
+
"filename": "lib/game-server-group.ts",
|
|
6191
|
+
"line": 322
|
|
6192
|
+
},
|
|
6193
|
+
"name": "balancingStrategy",
|
|
6194
|
+
"optional": true,
|
|
6195
|
+
"type": {
|
|
6196
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.BalancingStrategy"
|
|
6197
|
+
}
|
|
6198
|
+
},
|
|
6199
|
+
{
|
|
6200
|
+
"abstract": true,
|
|
6201
|
+
"docs": {
|
|
6202
|
+
"default": "SAFE_DELETE",
|
|
6203
|
+
"remarks": "To delete a game server group, specify the DeleteOption",
|
|
6204
|
+
"stability": "experimental",
|
|
6205
|
+
"summary": "The type of delete to perform."
|
|
6206
|
+
},
|
|
6207
|
+
"immutable": true,
|
|
6208
|
+
"locationInModule": {
|
|
6209
|
+
"filename": "lib/game-server-group.ts",
|
|
6210
|
+
"line": 315
|
|
6211
|
+
},
|
|
6212
|
+
"name": "deleteOption",
|
|
6213
|
+
"optional": true,
|
|
6214
|
+
"type": {
|
|
6215
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.DeleteOption"
|
|
6216
|
+
}
|
|
6217
|
+
},
|
|
6218
|
+
{
|
|
6219
|
+
"abstract": true,
|
|
6220
|
+
"docs": {
|
|
6221
|
+
"default": "the default is 1",
|
|
6222
|
+
"remarks": "During automatic scaling events, GameLift FleetIQ and EC2 do not scale up the group above this maximum.\n\nAfter the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs.",
|
|
6223
|
+
"stability": "experimental",
|
|
6224
|
+
"summary": "The maximum number of instances allowed in the Amazon EC2 Auto Scaling group."
|
|
6225
|
+
},
|
|
6226
|
+
"immutable": true,
|
|
6227
|
+
"locationInModule": {
|
|
6228
|
+
"filename": "lib/game-server-group.ts",
|
|
6229
|
+
"line": 250
|
|
6230
|
+
},
|
|
6231
|
+
"name": "maxSize",
|
|
6232
|
+
"optional": true,
|
|
6233
|
+
"type": {
|
|
6234
|
+
"primitive": "number"
|
|
6235
|
+
}
|
|
6236
|
+
},
|
|
6237
|
+
{
|
|
6238
|
+
"abstract": true,
|
|
6239
|
+
"docs": {
|
|
6240
|
+
"default": "the default is 0",
|
|
6241
|
+
"remarks": "During automatic scaling events, GameLift FleetIQ and Amazon EC2 do not scale down the group below this minimum.\n\nIn production, this value should be set to at least 1.\n\nAfter the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs.",
|
|
6242
|
+
"stability": "experimental",
|
|
6243
|
+
"summary": "The minimum number of instances allowed in the Amazon EC2 Auto Scaling group."
|
|
6244
|
+
},
|
|
6245
|
+
"immutable": true,
|
|
6246
|
+
"locationInModule": {
|
|
6247
|
+
"filename": "lib/game-server-group.ts",
|
|
6248
|
+
"line": 241
|
|
6249
|
+
},
|
|
6250
|
+
"name": "minSize",
|
|
6251
|
+
"optional": true,
|
|
6252
|
+
"type": {
|
|
6253
|
+
"primitive": "number"
|
|
6254
|
+
}
|
|
6255
|
+
},
|
|
6256
|
+
{
|
|
6257
|
+
"abstract": true,
|
|
6258
|
+
"docs": {
|
|
6259
|
+
"default": "game servers running might be terminated during a scale-down event",
|
|
6260
|
+
"remarks": "Unprotected instances that have active game servers running might be terminated during a scale-down event, causing players to be dropped from the game.\nProtected instances cannot be terminated while there are active game servers running except in the event of a forced game server group deletion.\n\nAn exception to this is with Spot Instances, which can be terminated by AWS regardless of protection status.",
|
|
6261
|
+
"stability": "experimental",
|
|
6262
|
+
"summary": "A flag that indicates whether instances in the game server group are protected from early termination."
|
|
6263
|
+
},
|
|
6264
|
+
"immutable": true,
|
|
6265
|
+
"locationInModule": {
|
|
6266
|
+
"filename": "lib/game-server-group.ts",
|
|
6267
|
+
"line": 298
|
|
6268
|
+
},
|
|
6269
|
+
"name": "protectGameServer",
|
|
6270
|
+
"optional": true,
|
|
6271
|
+
"type": {
|
|
6272
|
+
"primitive": "boolean"
|
|
6273
|
+
}
|
|
6274
|
+
},
|
|
6275
|
+
{
|
|
6276
|
+
"abstract": true,
|
|
6277
|
+
"docs": {
|
|
6278
|
+
"default": "- a role will be created with default trust to Gamelift and Autoscaling service principal with a default policy `GameLiftGameServerGroupPolicy` attached.",
|
|
6279
|
+
"see": "https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-iam-permissions-roles.html",
|
|
6280
|
+
"stability": "experimental",
|
|
6281
|
+
"summary": "The IAM role that allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups."
|
|
6282
|
+
},
|
|
6283
|
+
"immutable": true,
|
|
6284
|
+
"locationInModule": {
|
|
6285
|
+
"filename": "lib/game-server-group.ts",
|
|
6286
|
+
"line": 229
|
|
6287
|
+
},
|
|
6288
|
+
"name": "role",
|
|
6289
|
+
"optional": true,
|
|
6290
|
+
"type": {
|
|
6291
|
+
"fqn": "aws-cdk-lib.aws_iam.IRole"
|
|
6292
|
+
}
|
|
6293
|
+
},
|
|
6294
|
+
{
|
|
6295
|
+
"abstract": true,
|
|
6296
|
+
"docs": {
|
|
6297
|
+
"default": "all GameLift FleetIQ-supported Availability Zones are used.",
|
|
6298
|
+
"stability": "experimental",
|
|
6299
|
+
"summary": "Game server group subnet selection."
|
|
6300
|
+
},
|
|
6301
|
+
"immutable": true,
|
|
6302
|
+
"locationInModule": {
|
|
6303
|
+
"filename": "lib/game-server-group.ts",
|
|
6304
|
+
"line": 270
|
|
6305
|
+
},
|
|
6306
|
+
"name": "vpcSubnets",
|
|
6307
|
+
"optional": true,
|
|
6308
|
+
"type": {
|
|
6309
|
+
"fqn": "aws-cdk-lib.aws_ec2.SubnetSelection"
|
|
6310
|
+
}
|
|
6311
|
+
}
|
|
6312
|
+
],
|
|
6313
|
+
"symbolId": "lib/game-server-group:GameServerGroupProps"
|
|
6314
|
+
},
|
|
6315
|
+
"@aws-cdk/aws-gamelift-alpha.IBuild": {
|
|
6316
|
+
"assembly": "@aws-cdk/aws-gamelift-alpha",
|
|
6317
|
+
"docs": {
|
|
6318
|
+
"remarks": "A game build represents the set of files that run your game server on a particular operating system.\nYou can have many different builds, such as for different flavors of your game.\nThe game build must be integrated with the GameLift service.\nYou upload game build files to the GameLift service in the Regions where you plan to set up fleets.",
|
|
6319
|
+
"see": "https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-cli-uploading.html",
|
|
6320
|
+
"stability": "experimental",
|
|
6321
|
+
"summary": "Your custom-built game server software that runs on GameLift and hosts game sessions for your players."
|
|
6322
|
+
},
|
|
6323
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.IBuild",
|
|
6324
|
+
"interfaces": [
|
|
6325
|
+
"aws-cdk-lib.IResource",
|
|
6326
|
+
"aws-cdk-lib.aws_iam.IGrantable"
|
|
6327
|
+
],
|
|
6328
|
+
"kind": "interface",
|
|
6329
|
+
"locationInModule": {
|
|
6330
|
+
"filename": "lib/build.ts",
|
|
6331
|
+
"line": 18
|
|
6332
|
+
},
|
|
6333
|
+
"name": "IBuild",
|
|
6334
|
+
"properties": [
|
|
6335
|
+
{
|
|
6336
|
+
"abstract": true,
|
|
6337
|
+
"docs": {
|
|
6338
|
+
"custom": {
|
|
6339
|
+
"attribute": "true"
|
|
6340
|
+
},
|
|
6341
|
+
"stability": "experimental",
|
|
6342
|
+
"summary": "The Identifier of the build."
|
|
6343
|
+
},
|
|
6344
|
+
"immutable": true,
|
|
6345
|
+
"locationInModule": {
|
|
6346
|
+
"filename": "lib/build.ts",
|
|
6347
|
+
"line": 25
|
|
6348
|
+
},
|
|
6349
|
+
"name": "buildId",
|
|
6350
|
+
"type": {
|
|
6351
|
+
"primitive": "string"
|
|
6352
|
+
}
|
|
6353
|
+
}
|
|
6354
|
+
],
|
|
6355
|
+
"symbolId": "lib/build:IBuild"
|
|
6356
|
+
},
|
|
6357
|
+
"@aws-cdk/aws-gamelift-alpha.IBuildFleet": {
|
|
6358
|
+
"assembly": "@aws-cdk/aws-gamelift-alpha",
|
|
6359
|
+
"docs": {
|
|
6360
|
+
"stability": "experimental",
|
|
6361
|
+
"summary": "Represents a GameLift Fleet used to run a custom game build."
|
|
6362
|
+
},
|
|
6363
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.IBuildFleet",
|
|
6364
|
+
"interfaces": [
|
|
6365
|
+
"@aws-cdk/aws-gamelift-alpha.IFleet"
|
|
6366
|
+
],
|
|
6367
|
+
"kind": "interface",
|
|
6368
|
+
"locationInModule": {
|
|
6369
|
+
"filename": "lib/build-fleet.ts",
|
|
6370
|
+
"line": 12
|
|
6371
|
+
},
|
|
6372
|
+
"name": "IBuildFleet",
|
|
6373
|
+
"symbolId": "lib/build-fleet:IBuildFleet"
|
|
6374
|
+
},
|
|
6375
|
+
"@aws-cdk/aws-gamelift-alpha.IFleet": {
|
|
6376
|
+
"assembly": "@aws-cdk/aws-gamelift-alpha",
|
|
6377
|
+
"docs": {
|
|
6378
|
+
"stability": "experimental",
|
|
6379
|
+
"summary": "Represents a Gamelift fleet."
|
|
6380
|
+
},
|
|
6381
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.IFleet",
|
|
6382
|
+
"interfaces": [
|
|
6383
|
+
"aws-cdk-lib.IResource",
|
|
6384
|
+
"aws-cdk-lib.aws_iam.IGrantable"
|
|
6385
|
+
],
|
|
6386
|
+
"kind": "interface",
|
|
6387
|
+
"locationInModule": {
|
|
6388
|
+
"filename": "lib/fleet-base.ts",
|
|
6389
|
+
"line": 142
|
|
6390
|
+
},
|
|
6391
|
+
"methods": [
|
|
6392
|
+
{
|
|
6393
|
+
"abstract": true,
|
|
6394
|
+
"docs": {
|
|
6395
|
+
"stability": "experimental",
|
|
6396
|
+
"summary": "Grant the `grantee` identity permissions to perform `actions`."
|
|
6397
|
+
},
|
|
6398
|
+
"locationInModule": {
|
|
6399
|
+
"filename": "lib/fleet-base.ts",
|
|
6400
|
+
"line": 160
|
|
6401
|
+
},
|
|
6402
|
+
"name": "grant",
|
|
6403
|
+
"parameters": [
|
|
6404
|
+
{
|
|
6405
|
+
"name": "grantee",
|
|
6406
|
+
"type": {
|
|
6407
|
+
"fqn": "aws-cdk-lib.aws_iam.IGrantable"
|
|
6408
|
+
}
|
|
6409
|
+
},
|
|
6410
|
+
{
|
|
6411
|
+
"name": "actions",
|
|
6412
|
+
"type": {
|
|
6413
|
+
"primitive": "string"
|
|
6414
|
+
},
|
|
6415
|
+
"variadic": true
|
|
6416
|
+
}
|
|
6417
|
+
],
|
|
6418
|
+
"returns": {
|
|
6419
|
+
"type": {
|
|
6420
|
+
"fqn": "aws-cdk-lib.aws_iam.Grant"
|
|
6421
|
+
}
|
|
6422
|
+
},
|
|
6423
|
+
"variadic": true
|
|
6424
|
+
},
|
|
6425
|
+
{
|
|
6426
|
+
"abstract": true,
|
|
6427
|
+
"docs": {
|
|
6428
|
+
"stability": "experimental",
|
|
6429
|
+
"summary": "Return the given named metric for this fleet."
|
|
6430
|
+
},
|
|
6431
|
+
"locationInModule": {
|
|
6432
|
+
"filename": "lib/fleet-base.ts",
|
|
6433
|
+
"line": 165
|
|
6434
|
+
},
|
|
6435
|
+
"name": "metric",
|
|
6436
|
+
"parameters": [
|
|
6437
|
+
{
|
|
6438
|
+
"name": "metricName",
|
|
6439
|
+
"type": {
|
|
6440
|
+
"primitive": "string"
|
|
6441
|
+
}
|
|
6442
|
+
},
|
|
6443
|
+
{
|
|
6444
|
+
"name": "props",
|
|
6445
|
+
"optional": true,
|
|
6446
|
+
"type": {
|
|
6447
|
+
"fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
|
|
6448
|
+
}
|
|
6449
|
+
}
|
|
6450
|
+
],
|
|
6451
|
+
"returns": {
|
|
6452
|
+
"type": {
|
|
6453
|
+
"fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
|
|
6454
|
+
}
|
|
6455
|
+
}
|
|
6456
|
+
},
|
|
6457
|
+
{
|
|
6458
|
+
"abstract": true,
|
|
6459
|
+
"docs": {
|
|
6460
|
+
"remarks": "The count includes idle instances and those that are hosting one or more game sessions.\nThis metric measures current total instance capacity.\n\nThis metric can be used with automatic scaling.",
|
|
6461
|
+
"stability": "experimental",
|
|
6462
|
+
"summary": "Instances with `ACTIVE` status, which means they are running active server processes."
|
|
6463
|
+
},
|
|
6464
|
+
"locationInModule": {
|
|
6465
|
+
"filename": "lib/fleet-base.ts",
|
|
6466
|
+
"line": 174
|
|
6467
|
+
},
|
|
6468
|
+
"name": "metricActiveInstances",
|
|
6469
|
+
"parameters": [
|
|
6470
|
+
{
|
|
6471
|
+
"name": "props",
|
|
6472
|
+
"optional": true,
|
|
6473
|
+
"type": {
|
|
6474
|
+
"fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
|
|
6475
|
+
}
|
|
6476
|
+
}
|
|
6477
|
+
],
|
|
6478
|
+
"returns": {
|
|
6479
|
+
"type": {
|
|
6480
|
+
"fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
|
|
6481
|
+
}
|
|
6482
|
+
}
|
|
6483
|
+
},
|
|
6484
|
+
{
|
|
6485
|
+
"abstract": true,
|
|
6486
|
+
"docs": {
|
|
6487
|
+
"remarks": "With automatic scaling, this value is determined based on the scaling policies currently in force.\nWithout automatic scaling, this value is set manually.\nThis metric is not available when viewing data for fleet metric groups.",
|
|
6488
|
+
"stability": "experimental",
|
|
6489
|
+
"summary": "Target number of active instances that GameLift is working to maintain in the fleet."
|
|
6490
|
+
},
|
|
6491
|
+
"locationInModule": {
|
|
6492
|
+
"filename": "lib/fleet-base.ts",
|
|
6493
|
+
"line": 188
|
|
6494
|
+
},
|
|
6495
|
+
"name": "metricDesiredInstances",
|
|
6496
|
+
"parameters": [
|
|
6497
|
+
{
|
|
6498
|
+
"name": "props",
|
|
6499
|
+
"optional": true,
|
|
6500
|
+
"type": {
|
|
6501
|
+
"fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
|
|
6502
|
+
}
|
|
6503
|
+
}
|
|
6504
|
+
],
|
|
6505
|
+
"returns": {
|
|
6506
|
+
"type": {
|
|
6507
|
+
"fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
|
|
6508
|
+
}
|
|
6509
|
+
}
|
|
6510
|
+
},
|
|
6511
|
+
{
|
|
6512
|
+
"abstract": true,
|
|
6513
|
+
"docs": {
|
|
6514
|
+
"remarks": "This metric measures capacity that is available but unused.\nThis metric can be used with automatic scaling.",
|
|
6515
|
+
"stability": "experimental",
|
|
6516
|
+
"summary": "Active instances that are currently hosting zero (0) game sessions."
|
|
6517
|
+
},
|
|
6518
|
+
"locationInModule": {
|
|
6519
|
+
"filename": "lib/fleet-base.ts",
|
|
6520
|
+
"line": 195
|
|
6521
|
+
},
|
|
6522
|
+
"name": "metricIdleInstances",
|
|
6523
|
+
"parameters": [
|
|
6524
|
+
{
|
|
6525
|
+
"name": "props",
|
|
6526
|
+
"optional": true,
|
|
6527
|
+
"type": {
|
|
6528
|
+
"fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
|
|
6529
|
+
}
|
|
6530
|
+
}
|
|
6531
|
+
],
|
|
6532
|
+
"returns": {
|
|
6533
|
+
"type": {
|
|
6534
|
+
"fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
|
|
6535
|
+
}
|
|
6536
|
+
}
|
|
6537
|
+
},
|
|
6538
|
+
{
|
|
6539
|
+
"abstract": true,
|
|
6540
|
+
"docs": {
|
|
6541
|
+
"stability": "experimental",
|
|
6542
|
+
"summary": "Number of spot instances that have been interrupted."
|
|
6543
|
+
},
|
|
6544
|
+
"locationInModule": {
|
|
6545
|
+
"filename": "lib/fleet-base.ts",
|
|
6546
|
+
"line": 200
|
|
6547
|
+
},
|
|
6548
|
+
"name": "metricInstanceInterruptions",
|
|
6549
|
+
"parameters": [
|
|
6550
|
+
{
|
|
6551
|
+
"name": "props",
|
|
6552
|
+
"optional": true,
|
|
6553
|
+
"type": {
|
|
6554
|
+
"fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
|
|
6555
|
+
}
|
|
6556
|
+
}
|
|
6557
|
+
],
|
|
6558
|
+
"returns": {
|
|
6559
|
+
"type": {
|
|
6560
|
+
"fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
|
|
6561
|
+
}
|
|
6562
|
+
}
|
|
6563
|
+
},
|
|
6564
|
+
{
|
|
6565
|
+
"abstract": true,
|
|
6566
|
+
"docs": {
|
|
6567
|
+
"remarks": "A fleet's instance maximum determines the capacity ceiling during manual or automatic scaling up.\nThis metric is not available when viewing data for fleet metric groups.",
|
|
6568
|
+
"stability": "experimental",
|
|
6569
|
+
"summary": "Maximum number of instances that are allowed for the fleet."
|
|
6570
|
+
},
|
|
6571
|
+
"locationInModule": {
|
|
6572
|
+
"filename": "lib/fleet-base.ts",
|
|
6573
|
+
"line": 207
|
|
6574
|
+
},
|
|
6575
|
+
"name": "metricMaxInstances",
|
|
6576
|
+
"parameters": [
|
|
6577
|
+
{
|
|
6578
|
+
"name": "props",
|
|
6579
|
+
"optional": true,
|
|
6580
|
+
"type": {
|
|
6581
|
+
"fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
|
|
6582
|
+
}
|
|
6583
|
+
}
|
|
6584
|
+
],
|
|
6585
|
+
"returns": {
|
|
6586
|
+
"type": {
|
|
6587
|
+
"fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
|
|
6588
|
+
}
|
|
6589
|
+
}
|
|
6590
|
+
},
|
|
6591
|
+
{
|
|
6592
|
+
"abstract": true,
|
|
6593
|
+
"docs": {
|
|
6594
|
+
"remarks": "A fleet's instance minimum determines the capacity floor during manual or automatic scaling down.\nThis metric is not available when viewing data for fleet metric groups.",
|
|
6595
|
+
"stability": "experimental",
|
|
6596
|
+
"summary": "Minimum number of instances allowed for the fleet."
|
|
6597
|
+
},
|
|
6598
|
+
"locationInModule": {
|
|
6599
|
+
"filename": "lib/fleet-base.ts",
|
|
6600
|
+
"line": 214
|
|
6601
|
+
},
|
|
6602
|
+
"name": "metricMinInstances",
|
|
6603
|
+
"parameters": [
|
|
6604
|
+
{
|
|
6605
|
+
"name": "props",
|
|
6606
|
+
"optional": true,
|
|
6607
|
+
"type": {
|
|
6608
|
+
"fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
|
|
6609
|
+
}
|
|
6610
|
+
}
|
|
6611
|
+
],
|
|
6612
|
+
"returns": {
|
|
6613
|
+
"type": {
|
|
6614
|
+
"fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
|
|
6615
|
+
}
|
|
6616
|
+
}
|
|
6617
|
+
},
|
|
6618
|
+
{
|
|
6619
|
+
"abstract": true,
|
|
6620
|
+
"docs": {
|
|
6621
|
+
"remarks": "This metric can be used for automatic scaling.",
|
|
6622
|
+
"stability": "experimental",
|
|
6623
|
+
"summary": "Percentage of all active instances that are idle (calculated as IdleInstances / ActiveInstances)."
|
|
6624
|
+
},
|
|
6625
|
+
"locationInModule": {
|
|
6626
|
+
"filename": "lib/fleet-base.ts",
|
|
6627
|
+
"line": 180
|
|
6628
|
+
},
|
|
6629
|
+
"name": "metricPercentIdleInstances",
|
|
6630
|
+
"parameters": [
|
|
6631
|
+
{
|
|
6632
|
+
"name": "props",
|
|
6633
|
+
"optional": true,
|
|
6634
|
+
"type": {
|
|
6635
|
+
"fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
|
|
6636
|
+
}
|
|
6637
|
+
}
|
|
6638
|
+
],
|
|
6639
|
+
"returns": {
|
|
6640
|
+
"type": {
|
|
6641
|
+
"fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
|
|
6642
|
+
}
|
|
6643
|
+
}
|
|
6644
|
+
}
|
|
6645
|
+
],
|
|
6646
|
+
"name": "IFleet",
|
|
6647
|
+
"properties": [
|
|
6648
|
+
{
|
|
6649
|
+
"abstract": true,
|
|
6650
|
+
"docs": {
|
|
6651
|
+
"custom": {
|
|
6652
|
+
"attribute": "true"
|
|
6653
|
+
},
|
|
6654
|
+
"stability": "experimental",
|
|
6655
|
+
"summary": "The ARN of the fleet."
|
|
6656
|
+
},
|
|
6657
|
+
"immutable": true,
|
|
6658
|
+
"locationInModule": {
|
|
6659
|
+
"filename": "lib/fleet-base.ts",
|
|
6660
|
+
"line": 155
|
|
6661
|
+
},
|
|
6662
|
+
"name": "fleetArn",
|
|
6663
|
+
"type": {
|
|
6664
|
+
"primitive": "string"
|
|
6665
|
+
}
|
|
6666
|
+
},
|
|
6667
|
+
{
|
|
6668
|
+
"abstract": true,
|
|
6669
|
+
"docs": {
|
|
6670
|
+
"custom": {
|
|
6671
|
+
"attribute": "true"
|
|
6672
|
+
},
|
|
6673
|
+
"stability": "experimental",
|
|
6674
|
+
"summary": "The Identifier of the fleet."
|
|
6675
|
+
},
|
|
6676
|
+
"immutable": true,
|
|
6677
|
+
"locationInModule": {
|
|
6678
|
+
"filename": "lib/fleet-base.ts",
|
|
6679
|
+
"line": 148
|
|
6680
|
+
},
|
|
6681
|
+
"name": "fleetId",
|
|
6682
|
+
"type": {
|
|
6683
|
+
"primitive": "string"
|
|
6684
|
+
}
|
|
6685
|
+
}
|
|
6686
|
+
],
|
|
6687
|
+
"symbolId": "lib/fleet-base:IFleet"
|
|
6688
|
+
},
|
|
6689
|
+
"@aws-cdk/aws-gamelift-alpha.IGameServerGroup": {
|
|
6690
|
+
"assembly": "@aws-cdk/aws-gamelift-alpha",
|
|
6691
|
+
"docs": {
|
|
6692
|
+
"stability": "experimental",
|
|
6693
|
+
"summary": "Represent a GameLift FleetIQ game server group."
|
|
6694
|
+
},
|
|
6695
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.IGameServerGroup",
|
|
6696
|
+
"interfaces": [
|
|
6697
|
+
"aws-cdk-lib.IResource",
|
|
6698
|
+
"aws-cdk-lib.aws_iam.IGrantable"
|
|
6699
|
+
],
|
|
6700
|
+
"kind": "interface",
|
|
6701
|
+
"locationInModule": {
|
|
6702
|
+
"filename": "lib/game-server-group.ts",
|
|
6703
|
+
"line": 96
|
|
6704
|
+
},
|
|
6705
|
+
"methods": [
|
|
6706
|
+
{
|
|
6707
|
+
"abstract": true,
|
|
6708
|
+
"docs": {
|
|
6709
|
+
"stability": "experimental",
|
|
6710
|
+
"summary": "Grant the `grantee` identity permissions to perform `actions`."
|
|
6711
|
+
},
|
|
6712
|
+
"locationInModule": {
|
|
6713
|
+
"filename": "lib/game-server-group.ts",
|
|
6714
|
+
"line": 121
|
|
6715
|
+
},
|
|
6716
|
+
"name": "grant",
|
|
6717
|
+
"parameters": [
|
|
6718
|
+
{
|
|
6719
|
+
"name": "grantee",
|
|
6720
|
+
"type": {
|
|
6721
|
+
"fqn": "aws-cdk-lib.aws_iam.IGrantable"
|
|
6722
|
+
}
|
|
6723
|
+
},
|
|
6724
|
+
{
|
|
6725
|
+
"name": "actions",
|
|
6726
|
+
"type": {
|
|
6727
|
+
"primitive": "string"
|
|
6728
|
+
},
|
|
6729
|
+
"variadic": true
|
|
6730
|
+
}
|
|
6731
|
+
],
|
|
6732
|
+
"returns": {
|
|
6733
|
+
"type": {
|
|
6734
|
+
"fqn": "aws-cdk-lib.aws_iam.Grant"
|
|
6735
|
+
}
|
|
6736
|
+
},
|
|
6737
|
+
"variadic": true
|
|
6738
|
+
},
|
|
6739
|
+
{
|
|
6740
|
+
"abstract": true,
|
|
6741
|
+
"docs": {
|
|
6742
|
+
"stability": "experimental",
|
|
6743
|
+
"summary": "Return the given named metric for this fleet."
|
|
6744
|
+
},
|
|
6745
|
+
"locationInModule": {
|
|
6746
|
+
"filename": "lib/game-server-group.ts",
|
|
6747
|
+
"line": 126
|
|
6748
|
+
},
|
|
6749
|
+
"name": "metric",
|
|
6750
|
+
"parameters": [
|
|
6751
|
+
{
|
|
6752
|
+
"name": "metricName",
|
|
6753
|
+
"type": {
|
|
6754
|
+
"primitive": "string"
|
|
6755
|
+
}
|
|
6756
|
+
},
|
|
6757
|
+
{
|
|
6758
|
+
"name": "props",
|
|
6759
|
+
"optional": true,
|
|
6760
|
+
"type": {
|
|
6761
|
+
"fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
|
|
6762
|
+
}
|
|
6763
|
+
}
|
|
6764
|
+
],
|
|
6765
|
+
"returns": {
|
|
6766
|
+
"type": {
|
|
6767
|
+
"fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
|
|
6768
|
+
}
|
|
6769
|
+
}
|
|
6770
|
+
}
|
|
6771
|
+
],
|
|
6772
|
+
"name": "IGameServerGroup",
|
|
6773
|
+
"properties": [
|
|
6774
|
+
{
|
|
6775
|
+
"abstract": true,
|
|
6776
|
+
"docs": {
|
|
6777
|
+
"custom": {
|
|
6778
|
+
"attribute": "true"
|
|
6779
|
+
},
|
|
6780
|
+
"stability": "experimental",
|
|
6781
|
+
"summary": "The ARN of the generated AutoScaling group."
|
|
6782
|
+
},
|
|
6783
|
+
"immutable": true,
|
|
6784
|
+
"locationInModule": {
|
|
6785
|
+
"filename": "lib/game-server-group.ts",
|
|
6786
|
+
"line": 109
|
|
6787
|
+
},
|
|
6788
|
+
"name": "autoScalingGroupArn",
|
|
6789
|
+
"type": {
|
|
6790
|
+
"primitive": "string"
|
|
6791
|
+
}
|
|
6792
|
+
},
|
|
6793
|
+
{
|
|
6794
|
+
"abstract": true,
|
|
6795
|
+
"docs": {
|
|
6796
|
+
"custom": {
|
|
6797
|
+
"attribute": "true"
|
|
6798
|
+
},
|
|
6799
|
+
"stability": "experimental",
|
|
6800
|
+
"summary": "The ARN of the game server group."
|
|
6801
|
+
},
|
|
6802
|
+
"immutable": true,
|
|
6803
|
+
"locationInModule": {
|
|
6804
|
+
"filename": "lib/game-server-group.ts",
|
|
6805
|
+
"line": 102
|
|
6806
|
+
},
|
|
6807
|
+
"name": "gameServerGroupArn",
|
|
6808
|
+
"type": {
|
|
6809
|
+
"primitive": "string"
|
|
6810
|
+
}
|
|
6811
|
+
},
|
|
6812
|
+
{
|
|
6813
|
+
"abstract": true,
|
|
6814
|
+
"docs": {
|
|
6815
|
+
"custom": {
|
|
6816
|
+
"attribute": "true"
|
|
6817
|
+
},
|
|
6818
|
+
"stability": "experimental",
|
|
6819
|
+
"summary": "The name of the game server group."
|
|
6820
|
+
},
|
|
6821
|
+
"immutable": true,
|
|
6822
|
+
"locationInModule": {
|
|
6823
|
+
"filename": "lib/game-server-group.ts",
|
|
6824
|
+
"line": 116
|
|
6825
|
+
},
|
|
6826
|
+
"name": "gameServerGroupName",
|
|
6827
|
+
"type": {
|
|
6828
|
+
"primitive": "string"
|
|
6829
|
+
}
|
|
6830
|
+
}
|
|
6831
|
+
],
|
|
6832
|
+
"symbolId": "lib/game-server-group:IGameServerGroup"
|
|
6833
|
+
},
|
|
6834
|
+
"@aws-cdk/aws-gamelift-alpha.IPeer": {
|
|
6835
|
+
"assembly": "@aws-cdk/aws-gamelift-alpha",
|
|
6836
|
+
"docs": {
|
|
6837
|
+
"stability": "experimental",
|
|
6838
|
+
"summary": "Interface for classes that provide the peer-specification parts of an inbound permission."
|
|
6839
|
+
},
|
|
6840
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.IPeer",
|
|
6841
|
+
"kind": "interface",
|
|
6842
|
+
"locationInModule": {
|
|
6843
|
+
"filename": "lib/ingress-rule.ts",
|
|
6844
|
+
"line": 127
|
|
6845
|
+
},
|
|
6846
|
+
"methods": [
|
|
6847
|
+
{
|
|
6848
|
+
"abstract": true,
|
|
6849
|
+
"docs": {
|
|
6850
|
+
"stability": "experimental",
|
|
6851
|
+
"summary": "Produce the ingress rule JSON for the given connection."
|
|
6852
|
+
},
|
|
6853
|
+
"locationInModule": {
|
|
6854
|
+
"filename": "lib/ingress-rule.ts",
|
|
6855
|
+
"line": 137
|
|
6856
|
+
},
|
|
6857
|
+
"name": "toJson",
|
|
6858
|
+
"returns": {
|
|
6859
|
+
"type": {
|
|
6860
|
+
"primitive": "any"
|
|
6861
|
+
}
|
|
6862
|
+
}
|
|
6863
|
+
}
|
|
6864
|
+
],
|
|
6865
|
+
"name": "IPeer",
|
|
6866
|
+
"properties": [
|
|
6867
|
+
{
|
|
6868
|
+
"abstract": true,
|
|
6869
|
+
"docs": {
|
|
6870
|
+
"stability": "experimental",
|
|
6871
|
+
"summary": "A unique identifier for this connection peer."
|
|
6872
|
+
},
|
|
6873
|
+
"immutable": true,
|
|
6874
|
+
"locationInModule": {
|
|
6875
|
+
"filename": "lib/ingress-rule.ts",
|
|
6876
|
+
"line": 132
|
|
6877
|
+
},
|
|
6878
|
+
"name": "uniqueId",
|
|
6879
|
+
"type": {
|
|
6880
|
+
"primitive": "string"
|
|
6881
|
+
}
|
|
6882
|
+
}
|
|
6883
|
+
],
|
|
6884
|
+
"symbolId": "lib/ingress-rule:IPeer"
|
|
6885
|
+
},
|
|
6886
|
+
"@aws-cdk/aws-gamelift-alpha.IScript": {
|
|
6887
|
+
"assembly": "@aws-cdk/aws-gamelift-alpha",
|
|
6888
|
+
"docs": {
|
|
6889
|
+
"remarks": "Realtime Servers are provided by GameLift to use instead of a custom-built game server.\nYou configure Realtime Servers for your game clients by creating a script using JavaScript,\nand add custom game logic as appropriate to host game sessions for your players.\nYou upload the Realtime script to the GameLift service in the Regions where you plan to set up fleets.",
|
|
6890
|
+
"see": "https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-script-uploading.html",
|
|
6891
|
+
"stability": "experimental",
|
|
6892
|
+
"summary": "Your configuration and custom game logic for use with Realtime Servers."
|
|
6893
|
+
},
|
|
6894
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.IScript",
|
|
6895
|
+
"interfaces": [
|
|
6896
|
+
"aws-cdk-lib.IResource",
|
|
6897
|
+
"aws-cdk-lib.aws_iam.IGrantable"
|
|
6898
|
+
],
|
|
6899
|
+
"kind": "interface",
|
|
6900
|
+
"locationInModule": {
|
|
6901
|
+
"filename": "lib/script.ts",
|
|
6902
|
+
"line": 18
|
|
6903
|
+
},
|
|
6904
|
+
"name": "IScript",
|
|
6905
|
+
"properties": [
|
|
6906
|
+
{
|
|
6907
|
+
"abstract": true,
|
|
6908
|
+
"docs": {
|
|
6909
|
+
"custom": {
|
|
6910
|
+
"attribute": "true"
|
|
6911
|
+
},
|
|
6912
|
+
"stability": "experimental",
|
|
6913
|
+
"summary": "The ARN of the realtime server script."
|
|
6914
|
+
},
|
|
6915
|
+
"immutable": true,
|
|
6916
|
+
"locationInModule": {
|
|
6917
|
+
"filename": "lib/script.ts",
|
|
6918
|
+
"line": 32
|
|
6919
|
+
},
|
|
6920
|
+
"name": "scriptArn",
|
|
6921
|
+
"type": {
|
|
6922
|
+
"primitive": "string"
|
|
6923
|
+
}
|
|
6924
|
+
},
|
|
6925
|
+
{
|
|
6926
|
+
"abstract": true,
|
|
6927
|
+
"docs": {
|
|
6928
|
+
"custom": {
|
|
6929
|
+
"attribute": "true"
|
|
6930
|
+
},
|
|
6931
|
+
"stability": "experimental",
|
|
6932
|
+
"summary": "The Identifier of the realtime server script."
|
|
6933
|
+
},
|
|
6934
|
+
"immutable": true,
|
|
6935
|
+
"locationInModule": {
|
|
6936
|
+
"filename": "lib/script.ts",
|
|
6937
|
+
"line": 25
|
|
6938
|
+
},
|
|
6939
|
+
"name": "scriptId",
|
|
6940
|
+
"type": {
|
|
6941
|
+
"primitive": "string"
|
|
6942
|
+
}
|
|
6943
|
+
}
|
|
6944
|
+
],
|
|
6945
|
+
"symbolId": "lib/script:IScript"
|
|
6946
|
+
},
|
|
6947
|
+
"@aws-cdk/aws-gamelift-alpha.IngressRule": {
|
|
6948
|
+
"assembly": "@aws-cdk/aws-gamelift-alpha",
|
|
6949
|
+
"datatype": true,
|
|
6950
|
+
"docs": {
|
|
6951
|
+
"remarks": "New game sessions are assigned an IP address/port number combination, which must fall into the fleet's allowed ranges.\n\nFleets with custom game builds must have permissions explicitly set.\nFor Realtime Servers fleets, GameLift automatically opens two port ranges, one for TCP messaging and one for UDP.",
|
|
6952
|
+
"stability": "experimental",
|
|
6953
|
+
"summary": "A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an instance in a fleet.",
|
|
6954
|
+
"example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as gamelift_alpha from '@aws-cdk/aws-gamelift-alpha';\n\ndeclare const peer: gamelift_alpha.IPeer;\ndeclare const port: gamelift_alpha.Port;\nconst ingressRule: gamelift_alpha.IngressRule = {\n port: port,\n source: peer,\n};",
|
|
6955
|
+
"custom": {
|
|
6956
|
+
"exampleMetadata": "fixture=_generated"
|
|
6957
|
+
}
|
|
6958
|
+
},
|
|
6959
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.IngressRule",
|
|
6960
|
+
"kind": "interface",
|
|
6961
|
+
"locationInModule": {
|
|
6962
|
+
"filename": "lib/ingress-rule.ts",
|
|
6963
|
+
"line": 214
|
|
6964
|
+
},
|
|
6965
|
+
"name": "IngressRule",
|
|
6966
|
+
"properties": [
|
|
6967
|
+
{
|
|
6968
|
+
"abstract": true,
|
|
6969
|
+
"docs": {
|
|
6970
|
+
"stability": "experimental",
|
|
6971
|
+
"summary": "The port range used for ingress traffic."
|
|
6972
|
+
},
|
|
6973
|
+
"immutable": true,
|
|
6974
|
+
"locationInModule": {
|
|
6975
|
+
"filename": "lib/ingress-rule.ts",
|
|
6976
|
+
"line": 218
|
|
6977
|
+
},
|
|
6978
|
+
"name": "port",
|
|
6979
|
+
"type": {
|
|
6980
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.Port"
|
|
6981
|
+
}
|
|
6982
|
+
},
|
|
6983
|
+
{
|
|
6984
|
+
"abstract": true,
|
|
6985
|
+
"docs": {
|
|
6986
|
+
"stability": "experimental",
|
|
6987
|
+
"summary": "A range of allowed IP addresses ."
|
|
6988
|
+
},
|
|
6989
|
+
"immutable": true,
|
|
6990
|
+
"locationInModule": {
|
|
6991
|
+
"filename": "lib/ingress-rule.ts",
|
|
6992
|
+
"line": 223
|
|
6993
|
+
},
|
|
6994
|
+
"name": "source",
|
|
6995
|
+
"type": {
|
|
6996
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.IPeer"
|
|
6997
|
+
}
|
|
6998
|
+
}
|
|
6999
|
+
],
|
|
7000
|
+
"symbolId": "lib/ingress-rule:IngressRule"
|
|
7001
|
+
},
|
|
7002
|
+
"@aws-cdk/aws-gamelift-alpha.InstanceDefinition": {
|
|
7003
|
+
"assembly": "@aws-cdk/aws-gamelift-alpha",
|
|
7004
|
+
"datatype": true,
|
|
7005
|
+
"docs": {
|
|
7006
|
+
"remarks": "All game server groups must have at least two instance types defined for it.\nGameLift FleetIQ periodically evaluates each defined instance type for viability.\nIt then updates the Auto Scaling group with the list of viable instance types.",
|
|
7007
|
+
"stability": "experimental",
|
|
7008
|
+
"summary": "An allowed instance type for a game server group.",
|
|
7009
|
+
"example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as gamelift_alpha from '@aws-cdk/aws-gamelift-alpha';\nimport { aws_ec2 as ec2 } from 'aws-cdk-lib';\n\ndeclare const instanceType: ec2.InstanceType;\nconst instanceDefinition: gamelift_alpha.InstanceDefinition = {\n instanceType: instanceType,\n\n // the properties below are optional\n weight: 123,\n};",
|
|
7010
|
+
"custom": {
|
|
7011
|
+
"exampleMetadata": "fixture=_generated"
|
|
7012
|
+
}
|
|
7013
|
+
},
|
|
7014
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.InstanceDefinition",
|
|
7015
|
+
"kind": "interface",
|
|
7016
|
+
"locationInModule": {
|
|
7017
|
+
"filename": "lib/game-server-group.ts",
|
|
7018
|
+
"line": 37
|
|
7019
|
+
},
|
|
7020
|
+
"name": "InstanceDefinition",
|
|
7021
|
+
"properties": [
|
|
7022
|
+
{
|
|
7023
|
+
"abstract": true,
|
|
7024
|
+
"docs": {
|
|
7025
|
+
"stability": "experimental",
|
|
7026
|
+
"summary": "An Amazon EC2 instance type designation."
|
|
7027
|
+
},
|
|
7028
|
+
"immutable": true,
|
|
7029
|
+
"locationInModule": {
|
|
7030
|
+
"filename": "lib/game-server-group.ts",
|
|
7031
|
+
"line": 41
|
|
7032
|
+
},
|
|
7033
|
+
"name": "instanceType",
|
|
7034
|
+
"type": {
|
|
7035
|
+
"fqn": "aws-cdk-lib.aws_ec2.InstanceType"
|
|
7036
|
+
}
|
|
7037
|
+
},
|
|
7038
|
+
{
|
|
7039
|
+
"abstract": true,
|
|
7040
|
+
"docs": {
|
|
7041
|
+
"default": "default value is 1",
|
|
7042
|
+
"remarks": "Instance weights are used by GameLift FleetIQ to calculate the instance type's cost per unit hour and better identify the most cost-effective options.",
|
|
7043
|
+
"see": "https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-weighting.html",
|
|
7044
|
+
"stability": "experimental",
|
|
7045
|
+
"summary": "Instance weighting that indicates how much this instance type contributes to the total capacity of a game server group."
|
|
7046
|
+
},
|
|
7047
|
+
"immutable": true,
|
|
7048
|
+
"locationInModule": {
|
|
7049
|
+
"filename": "lib/game-server-group.ts",
|
|
7050
|
+
"line": 50
|
|
7051
|
+
},
|
|
7052
|
+
"name": "weight",
|
|
7053
|
+
"optional": true,
|
|
7054
|
+
"type": {
|
|
7055
|
+
"primitive": "number"
|
|
7056
|
+
}
|
|
7057
|
+
}
|
|
7058
|
+
],
|
|
7059
|
+
"symbolId": "lib/game-server-group:InstanceDefinition"
|
|
7060
|
+
},
|
|
7061
|
+
"@aws-cdk/aws-gamelift-alpha.Location": {
|
|
7062
|
+
"assembly": "@aws-cdk/aws-gamelift-alpha",
|
|
7063
|
+
"datatype": true,
|
|
7064
|
+
"docs": {
|
|
7065
|
+
"stability": "experimental",
|
|
7066
|
+
"summary": "A remote location where a multi-location fleet can deploy EC2 instances for game hosting.",
|
|
7067
|
+
"example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as gamelift_alpha from '@aws-cdk/aws-gamelift-alpha';\nconst location: gamelift_alpha.Location = {\n region: 'region',\n\n // the properties below are optional\n capacity: {\n desiredCapacity: 123,\n maxSize: 123,\n minSize: 123,\n },\n};",
|
|
7068
|
+
"custom": {
|
|
7069
|
+
"exampleMetadata": "fixture=_generated"
|
|
7070
|
+
}
|
|
7071
|
+
},
|
|
7072
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.Location",
|
|
7073
|
+
"kind": "interface",
|
|
7074
|
+
"locationInModule": {
|
|
7075
|
+
"filename": "lib/fleet-base.ts",
|
|
7076
|
+
"line": 39
|
|
7077
|
+
},
|
|
7078
|
+
"name": "Location",
|
|
7079
|
+
"properties": [
|
|
7080
|
+
{
|
|
7081
|
+
"abstract": true,
|
|
7082
|
+
"docs": {
|
|
7083
|
+
"stability": "experimental",
|
|
7084
|
+
"summary": "An AWS Region code."
|
|
7085
|
+
},
|
|
7086
|
+
"immutable": true,
|
|
7087
|
+
"locationInModule": {
|
|
7088
|
+
"filename": "lib/fleet-base.ts",
|
|
7089
|
+
"line": 43
|
|
7090
|
+
},
|
|
7091
|
+
"name": "region",
|
|
7092
|
+
"type": {
|
|
7093
|
+
"primitive": "string"
|
|
7094
|
+
}
|
|
7095
|
+
},
|
|
7096
|
+
{
|
|
7097
|
+
"abstract": true,
|
|
7098
|
+
"docs": {
|
|
7099
|
+
"default": "no capacity settings on the specified location",
|
|
7100
|
+
"remarks": "The location value might refer to a fleet's remote location or its home Region.",
|
|
7101
|
+
"stability": "experimental",
|
|
7102
|
+
"summary": "Current resource capacity settings in a specified fleet or location."
|
|
7103
|
+
},
|
|
7104
|
+
"immutable": true,
|
|
7105
|
+
"locationInModule": {
|
|
7106
|
+
"filename": "lib/fleet-base.ts",
|
|
7107
|
+
"line": 50
|
|
7108
|
+
},
|
|
7109
|
+
"name": "capacity",
|
|
7110
|
+
"optional": true,
|
|
7111
|
+
"type": {
|
|
7112
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.LocationCapacity"
|
|
7113
|
+
}
|
|
7114
|
+
}
|
|
7115
|
+
],
|
|
7116
|
+
"symbolId": "lib/fleet-base:Location"
|
|
7117
|
+
},
|
|
7118
|
+
"@aws-cdk/aws-gamelift-alpha.LocationCapacity": {
|
|
7119
|
+
"assembly": "@aws-cdk/aws-gamelift-alpha",
|
|
7120
|
+
"datatype": true,
|
|
7121
|
+
"docs": {
|
|
7122
|
+
"remarks": "The location value might refer to a fleet's remote location or its home Region.",
|
|
7123
|
+
"stability": "experimental",
|
|
7124
|
+
"summary": "Current resource capacity settings in a specified fleet or location.",
|
|
7125
|
+
"example": "declare const build: gamelift.Build;\n\n// Locations can be added directly through constructor\nconst fleet = new gamelift.BuildFleet(this, 'Game server fleet', {\n fleetName: 'test-fleet',\n content: build,\n instanceType: ec2.InstanceType.of(ec2.InstanceClass.C4, ec2.InstanceSize.LARGE),\n runtimeConfiguration: {\n serverProcesses: [{\n launchPath: '/local/game/GameLiftExampleServer.x86_64',\n }]\n },\n locations: [ {\n region: 'eu-west-1',\n capacity: {\n desiredCapacity: 5,\n minSize: 2,\n maxSize: 10\n }\n }, {\n region: 'us-east-1',\n capacity: {\n desiredCapacity: 5,\n minSize: 2,\n maxSize: 10\n }\n }]\n});\n\n// Or through dedicated methods\nfleet.addLocation('ap-southeast-1', 5, 2, 10);",
|
|
7126
|
+
"custom": {
|
|
7127
|
+
"exampleMetadata": "infused"
|
|
7128
|
+
}
|
|
7129
|
+
},
|
|
7130
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.LocationCapacity",
|
|
7131
|
+
"kind": "interface",
|
|
7132
|
+
"locationInModule": {
|
|
7133
|
+
"filename": "lib/fleet-base.ts",
|
|
7134
|
+
"line": 14
|
|
7135
|
+
},
|
|
7136
|
+
"name": "LocationCapacity",
|
|
7137
|
+
"properties": [
|
|
7138
|
+
{
|
|
7139
|
+
"abstract": true,
|
|
7140
|
+
"docs": {
|
|
7141
|
+
"default": "the default value is 0",
|
|
7142
|
+
"remarks": "This value must fall between the minimum and maximum size limits.",
|
|
7143
|
+
"stability": "experimental",
|
|
7144
|
+
"summary": "The number of Amazon EC2 instances you want to maintain in the specified fleet location."
|
|
7145
|
+
},
|
|
7146
|
+
"immutable": true,
|
|
7147
|
+
"locationInModule": {
|
|
7148
|
+
"filename": "lib/fleet-base.ts",
|
|
7149
|
+
"line": 21
|
|
7150
|
+
},
|
|
7151
|
+
"name": "desiredCapacity",
|
|
7152
|
+
"optional": true,
|
|
7153
|
+
"type": {
|
|
7154
|
+
"primitive": "number"
|
|
7155
|
+
}
|
|
7156
|
+
},
|
|
7157
|
+
{
|
|
7158
|
+
"abstract": true,
|
|
7159
|
+
"docs": {
|
|
7160
|
+
"default": "the default value is 1",
|
|
7161
|
+
"stability": "experimental",
|
|
7162
|
+
"summary": "The maximum number of instances that are allowed in the specified fleet location."
|
|
7163
|
+
},
|
|
7164
|
+
"immutable": true,
|
|
7165
|
+
"locationInModule": {
|
|
7166
|
+
"filename": "lib/fleet-base.ts",
|
|
7167
|
+
"line": 27
|
|
7168
|
+
},
|
|
7169
|
+
"name": "maxSize",
|
|
7170
|
+
"optional": true,
|
|
7171
|
+
"type": {
|
|
7172
|
+
"primitive": "number"
|
|
7173
|
+
}
|
|
7174
|
+
},
|
|
7175
|
+
{
|
|
7176
|
+
"abstract": true,
|
|
7177
|
+
"docs": {
|
|
7178
|
+
"default": "the default value is 0",
|
|
7179
|
+
"stability": "experimental",
|
|
7180
|
+
"summary": "The minimum number of instances that are allowed in the specified fleet location."
|
|
7181
|
+
},
|
|
7182
|
+
"immutable": true,
|
|
7183
|
+
"locationInModule": {
|
|
7184
|
+
"filename": "lib/fleet-base.ts",
|
|
7185
|
+
"line": 33
|
|
7186
|
+
},
|
|
7187
|
+
"name": "minSize",
|
|
7188
|
+
"optional": true,
|
|
7189
|
+
"type": {
|
|
7190
|
+
"primitive": "number"
|
|
7191
|
+
}
|
|
7192
|
+
}
|
|
7193
|
+
],
|
|
7194
|
+
"symbolId": "lib/fleet-base:LocationCapacity"
|
|
7195
|
+
},
|
|
7196
|
+
"@aws-cdk/aws-gamelift-alpha.OperatingSystem": {
|
|
7197
|
+
"assembly": "@aws-cdk/aws-gamelift-alpha",
|
|
7198
|
+
"docs": {
|
|
7199
|
+
"stability": "experimental",
|
|
7200
|
+
"summary": "The operating system that the game server binaries are built to run on."
|
|
7201
|
+
},
|
|
7202
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.OperatingSystem",
|
|
7203
|
+
"kind": "enum",
|
|
7204
|
+
"locationInModule": {
|
|
7205
|
+
"filename": "lib/build.ts",
|
|
7206
|
+
"line": 43
|
|
7207
|
+
},
|
|
7208
|
+
"members": [
|
|
7209
|
+
{
|
|
7210
|
+
"docs": {
|
|
7211
|
+
"stability": "experimental"
|
|
7212
|
+
},
|
|
7213
|
+
"name": "AMAZON_LINUX"
|
|
7214
|
+
},
|
|
7215
|
+
{
|
|
7216
|
+
"docs": {
|
|
7217
|
+
"stability": "experimental"
|
|
7218
|
+
},
|
|
7219
|
+
"name": "AMAZON_LINUX_2"
|
|
7220
|
+
},
|
|
7221
|
+
{
|
|
7222
|
+
"docs": {
|
|
7223
|
+
"stability": "experimental"
|
|
7224
|
+
},
|
|
7225
|
+
"name": "WINDOWS_2012"
|
|
7226
|
+
}
|
|
7227
|
+
],
|
|
7228
|
+
"name": "OperatingSystem",
|
|
7229
|
+
"symbolId": "lib/build:OperatingSystem"
|
|
7230
|
+
},
|
|
7231
|
+
"@aws-cdk/aws-gamelift-alpha.Peer": {
|
|
7232
|
+
"assembly": "@aws-cdk/aws-gamelift-alpha",
|
|
7233
|
+
"docs": {
|
|
7234
|
+
"remarks": "The static methods on this object can be used to create peer objects\nwhich represent a connection partner in inbound permission rules.\n\nUse this object if you need to represent connection partners using plain IP addresses.",
|
|
7235
|
+
"stability": "experimental",
|
|
7236
|
+
"summary": "Peer object factories.",
|
|
7237
|
+
"example": "declare const build: gamelift.Build;\n\nconst fleet = new gamelift.BuildFleet(this, 'Game server fleet', {\n fleetName: 'test-fleet',\n content: build,\n instanceType: ec2.InstanceType.of(ec2.InstanceClass.C4, ec2.InstanceSize.LARGE),\n runtimeConfiguration: {\n serverProcesses: [{\n launchPath: '/local/game/GameLiftExampleServer.x86_64',\n }]\n },\n ingressRules: [{\n source: gamelift.Peer.anyIpv4(),\n port: gamelift.Port.tcpRange(100, 200),\n }]\n});\n// Allowing a specific CIDR for port 1111 on UDP Protocol\nfleet.addIngressRule(gamelift.Peer.ipv4('1.2.3.4/32'), gamelift.Port.udp(1111));",
|
|
7238
|
+
"custom": {
|
|
7239
|
+
"exampleMetadata": "infused"
|
|
7240
|
+
}
|
|
7241
|
+
},
|
|
7242
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.Peer",
|
|
7243
|
+
"initializer": {
|
|
7244
|
+
"docs": {
|
|
7245
|
+
"stability": "experimental"
|
|
7246
|
+
},
|
|
7247
|
+
"locationInModule": {
|
|
7248
|
+
"filename": "lib/ingress-rule.ts",
|
|
7249
|
+
"line": 163
|
|
7250
|
+
}
|
|
7251
|
+
},
|
|
7252
|
+
"kind": "class",
|
|
7253
|
+
"locationInModule": {
|
|
7254
|
+
"filename": "lib/ingress-rule.ts",
|
|
7255
|
+
"line": 148
|
|
7256
|
+
},
|
|
7257
|
+
"methods": [
|
|
7258
|
+
{
|
|
7259
|
+
"docs": {
|
|
7260
|
+
"stability": "experimental",
|
|
7261
|
+
"summary": "Any IPv4 address."
|
|
7262
|
+
},
|
|
7263
|
+
"locationInModule": {
|
|
7264
|
+
"filename": "lib/ingress-rule.ts",
|
|
7265
|
+
"line": 159
|
|
7266
|
+
},
|
|
7267
|
+
"name": "anyIpv4",
|
|
7268
|
+
"returns": {
|
|
7269
|
+
"type": {
|
|
7270
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.IPeer"
|
|
7271
|
+
}
|
|
7272
|
+
},
|
|
7273
|
+
"static": true
|
|
7274
|
+
},
|
|
7275
|
+
{
|
|
7276
|
+
"docs": {
|
|
7277
|
+
"stability": "experimental",
|
|
7278
|
+
"summary": "Create an IPv4 peer from a CIDR."
|
|
7279
|
+
},
|
|
7280
|
+
"locationInModule": {
|
|
7281
|
+
"filename": "lib/ingress-rule.ts",
|
|
7282
|
+
"line": 152
|
|
7283
|
+
},
|
|
7284
|
+
"name": "ipv4",
|
|
7285
|
+
"parameters": [
|
|
7286
|
+
{
|
|
7287
|
+
"name": "cidrIp",
|
|
7288
|
+
"type": {
|
|
7289
|
+
"primitive": "string"
|
|
7290
|
+
}
|
|
7291
|
+
}
|
|
7292
|
+
],
|
|
7293
|
+
"returns": {
|
|
7294
|
+
"type": {
|
|
7295
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.IPeer"
|
|
7296
|
+
}
|
|
7297
|
+
},
|
|
7298
|
+
"static": true
|
|
7299
|
+
}
|
|
7300
|
+
],
|
|
7301
|
+
"name": "Peer",
|
|
7302
|
+
"symbolId": "lib/ingress-rule:Peer"
|
|
7303
|
+
},
|
|
7304
|
+
"@aws-cdk/aws-gamelift-alpha.Port": {
|
|
7305
|
+
"assembly": "@aws-cdk/aws-gamelift-alpha",
|
|
7306
|
+
"docs": {
|
|
7307
|
+
"stability": "experimental",
|
|
7308
|
+
"summary": "Interface for classes that provide the connection-specification parts of a security group rule.",
|
|
7309
|
+
"example": "declare const build: gamelift.Build;\n\nconst fleet = new gamelift.BuildFleet(this, 'Game server fleet', {\n fleetName: 'test-fleet',\n content: build,\n instanceType: ec2.InstanceType.of(ec2.InstanceClass.C4, ec2.InstanceSize.LARGE),\n runtimeConfiguration: {\n serverProcesses: [{\n launchPath: '/local/game/GameLiftExampleServer.x86_64',\n }]\n },\n ingressRules: [{\n source: gamelift.Peer.anyIpv4(),\n port: gamelift.Port.tcpRange(100, 200),\n }]\n});\n// Allowing a specific CIDR for port 1111 on UDP Protocol\nfleet.addIngressRule(gamelift.Peer.ipv4('1.2.3.4/32'), gamelift.Port.udp(1111));",
|
|
7310
|
+
"custom": {
|
|
7311
|
+
"exampleMetadata": "infused"
|
|
7312
|
+
}
|
|
7313
|
+
},
|
|
7314
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.Port",
|
|
7315
|
+
"initializer": {
|
|
7316
|
+
"docs": {
|
|
7317
|
+
"stability": "experimental"
|
|
7318
|
+
},
|
|
7319
|
+
"locationInModule": {
|
|
7320
|
+
"filename": "lib/ingress-rule.ts",
|
|
7321
|
+
"line": 110
|
|
7322
|
+
},
|
|
7323
|
+
"parameters": [
|
|
7324
|
+
{
|
|
7325
|
+
"name": "props",
|
|
7326
|
+
"type": {
|
|
7327
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.PortProps"
|
|
7328
|
+
}
|
|
7329
|
+
}
|
|
7330
|
+
]
|
|
7331
|
+
},
|
|
7332
|
+
"kind": "class",
|
|
7333
|
+
"locationInModule": {
|
|
7334
|
+
"filename": "lib/ingress-rule.ts",
|
|
7335
|
+
"line": 43
|
|
7336
|
+
},
|
|
7337
|
+
"methods": [
|
|
7338
|
+
{
|
|
7339
|
+
"docs": {
|
|
7340
|
+
"stability": "experimental",
|
|
7341
|
+
"summary": "Any TCP traffic."
|
|
7342
|
+
},
|
|
7343
|
+
"locationInModule": {
|
|
7344
|
+
"filename": "lib/ingress-rule.ts",
|
|
7345
|
+
"line": 69
|
|
7346
|
+
},
|
|
7347
|
+
"name": "allTcp",
|
|
7348
|
+
"returns": {
|
|
7349
|
+
"type": {
|
|
7350
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.Port"
|
|
7351
|
+
}
|
|
7352
|
+
},
|
|
7353
|
+
"static": true
|
|
7354
|
+
},
|
|
7355
|
+
{
|
|
7356
|
+
"docs": {
|
|
7357
|
+
"stability": "experimental",
|
|
7358
|
+
"summary": "Any UDP traffic."
|
|
7359
|
+
},
|
|
7360
|
+
"locationInModule": {
|
|
7361
|
+
"filename": "lib/ingress-rule.ts",
|
|
7362
|
+
"line": 102
|
|
7363
|
+
},
|
|
7364
|
+
"name": "allUdp",
|
|
7365
|
+
"returns": {
|
|
7366
|
+
"type": {
|
|
7367
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.Port"
|
|
7368
|
+
}
|
|
7369
|
+
},
|
|
7370
|
+
"static": true
|
|
7371
|
+
},
|
|
7372
|
+
{
|
|
7373
|
+
"docs": {
|
|
7374
|
+
"stability": "experimental",
|
|
7375
|
+
"summary": "A single TCP port."
|
|
7376
|
+
},
|
|
7377
|
+
"locationInModule": {
|
|
7378
|
+
"filename": "lib/ingress-rule.ts",
|
|
7379
|
+
"line": 47
|
|
7380
|
+
},
|
|
7381
|
+
"name": "tcp",
|
|
7382
|
+
"parameters": [
|
|
7383
|
+
{
|
|
7384
|
+
"name": "port",
|
|
7385
|
+
"type": {
|
|
7386
|
+
"primitive": "number"
|
|
7387
|
+
}
|
|
7388
|
+
}
|
|
7389
|
+
],
|
|
7390
|
+
"returns": {
|
|
7391
|
+
"type": {
|
|
7392
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.Port"
|
|
7393
|
+
}
|
|
7394
|
+
},
|
|
7395
|
+
"static": true
|
|
7396
|
+
},
|
|
7397
|
+
{
|
|
7398
|
+
"docs": {
|
|
7399
|
+
"stability": "experimental",
|
|
7400
|
+
"summary": "A TCP port range."
|
|
7401
|
+
},
|
|
7402
|
+
"locationInModule": {
|
|
7403
|
+
"filename": "lib/ingress-rule.ts",
|
|
7404
|
+
"line": 58
|
|
7405
|
+
},
|
|
7406
|
+
"name": "tcpRange",
|
|
7407
|
+
"parameters": [
|
|
7408
|
+
{
|
|
7409
|
+
"name": "startPort",
|
|
7410
|
+
"type": {
|
|
7411
|
+
"primitive": "number"
|
|
7412
|
+
}
|
|
7413
|
+
},
|
|
7414
|
+
{
|
|
7415
|
+
"name": "endPort",
|
|
7416
|
+
"type": {
|
|
7417
|
+
"primitive": "number"
|
|
7418
|
+
}
|
|
7419
|
+
}
|
|
7420
|
+
],
|
|
7421
|
+
"returns": {
|
|
7422
|
+
"type": {
|
|
7423
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.Port"
|
|
7424
|
+
}
|
|
7425
|
+
},
|
|
7426
|
+
"static": true
|
|
7427
|
+
},
|
|
7428
|
+
{
|
|
7429
|
+
"docs": {
|
|
7430
|
+
"stability": "experimental",
|
|
7431
|
+
"summary": "A single UDP port."
|
|
7432
|
+
},
|
|
7433
|
+
"locationInModule": {
|
|
7434
|
+
"filename": "lib/ingress-rule.ts",
|
|
7435
|
+
"line": 80
|
|
7436
|
+
},
|
|
7437
|
+
"name": "udp",
|
|
7438
|
+
"parameters": [
|
|
7439
|
+
{
|
|
7440
|
+
"name": "port",
|
|
7441
|
+
"type": {
|
|
7442
|
+
"primitive": "number"
|
|
3848
7443
|
}
|
|
3849
7444
|
}
|
|
3850
7445
|
],
|
|
3851
7446
|
"returns": {
|
|
3852
7447
|
"type": {
|
|
3853
|
-
"fqn": "@aws-cdk/aws-gamelift-alpha.
|
|
7448
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.Port"
|
|
3854
7449
|
}
|
|
3855
7450
|
},
|
|
3856
7451
|
"static": true
|
|
@@ -3858,260 +7453,299 @@
|
|
|
3858
7453
|
{
|
|
3859
7454
|
"docs": {
|
|
3860
7455
|
"stability": "experimental",
|
|
3861
|
-
"summary": "
|
|
7456
|
+
"summary": "A UDP port range."
|
|
3862
7457
|
},
|
|
3863
7458
|
"locationInModule": {
|
|
3864
|
-
"filename": "lib/
|
|
3865
|
-
"line":
|
|
7459
|
+
"filename": "lib/ingress-rule.ts",
|
|
7460
|
+
"line": 91
|
|
3866
7461
|
},
|
|
3867
|
-
"name": "
|
|
7462
|
+
"name": "udpRange",
|
|
3868
7463
|
"parameters": [
|
|
3869
7464
|
{
|
|
3870
|
-
"
|
|
3871
|
-
"summary": "The S3 bucket."
|
|
3872
|
-
},
|
|
3873
|
-
"name": "bucket",
|
|
3874
|
-
"type": {
|
|
3875
|
-
"fqn": "aws-cdk-lib.aws_s3.IBucket"
|
|
3876
|
-
}
|
|
3877
|
-
},
|
|
3878
|
-
{
|
|
3879
|
-
"docs": {
|
|
3880
|
-
"summary": "The object key."
|
|
3881
|
-
},
|
|
3882
|
-
"name": "key",
|
|
7465
|
+
"name": "startPort",
|
|
3883
7466
|
"type": {
|
|
3884
|
-
"primitive": "
|
|
7467
|
+
"primitive": "number"
|
|
3885
7468
|
}
|
|
3886
7469
|
},
|
|
3887
7470
|
{
|
|
3888
|
-
"
|
|
3889
|
-
"summary": "Optional S3 ob ject version."
|
|
3890
|
-
},
|
|
3891
|
-
"name": "objectVersion",
|
|
3892
|
-
"optional": true,
|
|
7471
|
+
"name": "endPort",
|
|
3893
7472
|
"type": {
|
|
3894
|
-
"primitive": "
|
|
7473
|
+
"primitive": "number"
|
|
3895
7474
|
}
|
|
3896
7475
|
}
|
|
3897
7476
|
],
|
|
3898
7477
|
"returns": {
|
|
3899
7478
|
"type": {
|
|
3900
|
-
"fqn": "@aws-cdk/aws-gamelift-alpha.
|
|
7479
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.Port"
|
|
3901
7480
|
}
|
|
3902
7481
|
},
|
|
3903
7482
|
"static": true
|
|
3904
7483
|
},
|
|
3905
7484
|
{
|
|
3906
|
-
"abstract": true,
|
|
3907
7485
|
"docs": {
|
|
3908
7486
|
"stability": "experimental",
|
|
3909
|
-
"summary": "
|
|
7487
|
+
"summary": "Produce the ingress rule JSON for the given connection."
|
|
3910
7488
|
},
|
|
3911
7489
|
"locationInModule": {
|
|
3912
|
-
"filename": "lib/
|
|
3913
|
-
"line":
|
|
7490
|
+
"filename": "lib/ingress-rule.ts",
|
|
7491
|
+
"line": 115
|
|
3914
7492
|
},
|
|
3915
|
-
"name": "
|
|
3916
|
-
"parameters": [
|
|
3917
|
-
{
|
|
3918
|
-
"name": "scope",
|
|
3919
|
-
"type": {
|
|
3920
|
-
"fqn": "constructs.Construct"
|
|
3921
|
-
}
|
|
3922
|
-
},
|
|
3923
|
-
{
|
|
3924
|
-
"name": "grantable",
|
|
3925
|
-
"type": {
|
|
3926
|
-
"fqn": "aws-cdk-lib.aws_iam.IGrantable"
|
|
3927
|
-
}
|
|
3928
|
-
}
|
|
3929
|
-
],
|
|
7493
|
+
"name": "toJson",
|
|
3930
7494
|
"returns": {
|
|
3931
7495
|
"type": {
|
|
3932
|
-
"
|
|
7496
|
+
"primitive": "any"
|
|
3933
7497
|
}
|
|
3934
7498
|
}
|
|
3935
7499
|
}
|
|
3936
7500
|
],
|
|
3937
|
-
"name": "
|
|
3938
|
-
"symbolId": "lib/
|
|
7501
|
+
"name": "Port",
|
|
7502
|
+
"symbolId": "lib/ingress-rule:Port"
|
|
3939
7503
|
},
|
|
3940
|
-
"@aws-cdk/aws-gamelift-alpha.
|
|
7504
|
+
"@aws-cdk/aws-gamelift-alpha.PortProps": {
|
|
3941
7505
|
"assembly": "@aws-cdk/aws-gamelift-alpha",
|
|
3942
7506
|
"datatype": true,
|
|
3943
7507
|
"docs": {
|
|
3944
7508
|
"stability": "experimental",
|
|
3945
|
-
"summary": "
|
|
3946
|
-
"example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as gamelift_alpha from '@aws-cdk/aws-gamelift-alpha';\nconst
|
|
7509
|
+
"summary": "Properties to create a port range.",
|
|
7510
|
+
"example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as gamelift_alpha from '@aws-cdk/aws-gamelift-alpha';\nconst portProps: gamelift_alpha.PortProps = {\n fromPort: 123,\n protocol: gamelift_alpha.Protocol.TCP,\n\n // the properties below are optional\n toPort: 123,\n};",
|
|
3947
7511
|
"custom": {
|
|
3948
7512
|
"exampleMetadata": "fixture=_generated"
|
|
3949
7513
|
}
|
|
3950
7514
|
},
|
|
3951
|
-
"fqn": "@aws-cdk/aws-gamelift-alpha.
|
|
7515
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.PortProps",
|
|
3952
7516
|
"kind": "interface",
|
|
3953
7517
|
"locationInModule": {
|
|
3954
|
-
"filename": "lib/
|
|
3955
|
-
"line":
|
|
7518
|
+
"filename": "lib/ingress-rule.ts",
|
|
7519
|
+
"line": 16
|
|
3956
7520
|
},
|
|
3957
|
-
"name": "
|
|
7521
|
+
"name": "PortProps",
|
|
3958
7522
|
"properties": [
|
|
3959
7523
|
{
|
|
3960
7524
|
"abstract": true,
|
|
3961
7525
|
"docs": {
|
|
7526
|
+
"remarks": "For fleets using Windows and Linux builds, only ports 1026-60000 are valid.",
|
|
3962
7527
|
"stability": "experimental",
|
|
3963
|
-
"summary": "
|
|
7528
|
+
"summary": "A starting value for a range of allowed port numbers."
|
|
3964
7529
|
},
|
|
3965
7530
|
"immutable": true,
|
|
3966
7531
|
"locationInModule": {
|
|
3967
|
-
"filename": "lib/
|
|
3968
|
-
"line":
|
|
7532
|
+
"filename": "lib/ingress-rule.ts",
|
|
7533
|
+
"line": 27
|
|
3969
7534
|
},
|
|
3970
|
-
"name": "
|
|
7535
|
+
"name": "fromPort",
|
|
3971
7536
|
"type": {
|
|
3972
|
-
"
|
|
7537
|
+
"primitive": "number"
|
|
7538
|
+
}
|
|
7539
|
+
},
|
|
7540
|
+
{
|
|
7541
|
+
"abstract": true,
|
|
7542
|
+
"docs": {
|
|
7543
|
+
"stability": "experimental",
|
|
7544
|
+
"summary": "The protocol for the range."
|
|
7545
|
+
},
|
|
7546
|
+
"immutable": true,
|
|
7547
|
+
"locationInModule": {
|
|
7548
|
+
"filename": "lib/ingress-rule.ts",
|
|
7549
|
+
"line": 20
|
|
7550
|
+
},
|
|
7551
|
+
"name": "protocol",
|
|
7552
|
+
"type": {
|
|
7553
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.Protocol"
|
|
7554
|
+
}
|
|
7555
|
+
},
|
|
7556
|
+
{
|
|
7557
|
+
"abstract": true,
|
|
7558
|
+
"docs": {
|
|
7559
|
+
"default": "the `fromPort` value",
|
|
7560
|
+
"remarks": "Port numbers are end-inclusive.\nThis value must be higher than `fromPort`.\n\nFor fleets using Windows and Linux builds, only ports 1026-60000 are valid.",
|
|
7561
|
+
"stability": "experimental",
|
|
7562
|
+
"summary": "An ending value for a range of allowed port numbers."
|
|
7563
|
+
},
|
|
7564
|
+
"immutable": true,
|
|
7565
|
+
"locationInModule": {
|
|
7566
|
+
"filename": "lib/ingress-rule.ts",
|
|
7567
|
+
"line": 37
|
|
7568
|
+
},
|
|
7569
|
+
"name": "toPort",
|
|
7570
|
+
"optional": true,
|
|
7571
|
+
"type": {
|
|
7572
|
+
"primitive": "number"
|
|
3973
7573
|
}
|
|
3974
7574
|
}
|
|
3975
7575
|
],
|
|
3976
|
-
"symbolId": "lib/
|
|
7576
|
+
"symbolId": "lib/ingress-rule:PortProps"
|
|
3977
7577
|
},
|
|
3978
|
-
"@aws-cdk/aws-gamelift-alpha.
|
|
7578
|
+
"@aws-cdk/aws-gamelift-alpha.Protocol": {
|
|
3979
7579
|
"assembly": "@aws-cdk/aws-gamelift-alpha",
|
|
3980
7580
|
"docs": {
|
|
3981
|
-
"remarks": "
|
|
3982
|
-
"see": "https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-cli-uploading.html",
|
|
7581
|
+
"remarks": "https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml",
|
|
3983
7582
|
"stability": "experimental",
|
|
3984
|
-
"summary": "
|
|
7583
|
+
"summary": "Protocol for use in Connection Rules."
|
|
3985
7584
|
},
|
|
3986
|
-
"fqn": "@aws-cdk/aws-gamelift-alpha.
|
|
3987
|
-
"
|
|
3988
|
-
"aws-cdk-lib.IResource",
|
|
3989
|
-
"aws-cdk-lib.aws_iam.IGrantable"
|
|
3990
|
-
],
|
|
3991
|
-
"kind": "interface",
|
|
7585
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.Protocol",
|
|
7586
|
+
"kind": "enum",
|
|
3992
7587
|
"locationInModule": {
|
|
3993
|
-
"filename": "lib/
|
|
3994
|
-
"line":
|
|
7588
|
+
"filename": "lib/ingress-rule.ts",
|
|
7589
|
+
"line": 8
|
|
3995
7590
|
},
|
|
3996
|
-
"
|
|
3997
|
-
"properties": [
|
|
7591
|
+
"members": [
|
|
3998
7592
|
{
|
|
3999
|
-
"abstract": true,
|
|
4000
7593
|
"docs": {
|
|
4001
|
-
"
|
|
4002
|
-
"attribute": "true"
|
|
4003
|
-
},
|
|
4004
|
-
"stability": "experimental",
|
|
4005
|
-
"summary": "The Identifier of the build."
|
|
7594
|
+
"stability": "experimental"
|
|
4006
7595
|
},
|
|
4007
|
-
"
|
|
4008
|
-
|
|
4009
|
-
|
|
4010
|
-
|
|
7596
|
+
"name": "TCP"
|
|
7597
|
+
},
|
|
7598
|
+
{
|
|
7599
|
+
"docs": {
|
|
7600
|
+
"stability": "experimental"
|
|
4011
7601
|
},
|
|
4012
|
-
"name": "
|
|
4013
|
-
"type": {
|
|
4014
|
-
"primitive": "string"
|
|
4015
|
-
}
|
|
7602
|
+
"name": "UDP"
|
|
4016
7603
|
}
|
|
4017
7604
|
],
|
|
4018
|
-
"
|
|
7605
|
+
"name": "Protocol",
|
|
7606
|
+
"symbolId": "lib/ingress-rule:Protocol"
|
|
4019
7607
|
},
|
|
4020
|
-
"@aws-cdk/aws-gamelift-alpha.
|
|
7608
|
+
"@aws-cdk/aws-gamelift-alpha.ResourceCreationLimitPolicy": {
|
|
4021
7609
|
"assembly": "@aws-cdk/aws-gamelift-alpha",
|
|
7610
|
+
"datatype": true,
|
|
4022
7611
|
"docs": {
|
|
4023
|
-
"remarks": "
|
|
4024
|
-
"see": "https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-script-uploading.html",
|
|
7612
|
+
"remarks": "This optional policy gives game owners control over how players can consume available game server resources.\nA resource creation policy makes the following statement: \"An individual player can create a maximum number of new game sessions within a specified time period\".\n\nThe policy is evaluated when a player tries to create a new game session.\nFor example, assume you have a policy of 10 new game sessions and a time period of 60 minutes.\nOn 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.",
|
|
4025
7613
|
"stability": "experimental",
|
|
4026
|
-
"summary": "
|
|
7614
|
+
"summary": "A policy that limits the number of game sessions a player can create on the same fleet.",
|
|
7615
|
+
"example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as gamelift_alpha from '@aws-cdk/aws-gamelift-alpha';\nimport * as cdk from 'aws-cdk-lib';\nconst resourceCreationLimitPolicy: gamelift_alpha.ResourceCreationLimitPolicy = {\n newGameSessionsPerCreator: 123,\n policyPeriod: cdk.Duration.minutes(30),\n};",
|
|
7616
|
+
"custom": {
|
|
7617
|
+
"exampleMetadata": "fixture=_generated"
|
|
7618
|
+
}
|
|
4027
7619
|
},
|
|
4028
|
-
"fqn": "@aws-cdk/aws-gamelift-alpha.
|
|
4029
|
-
"interfaces": [
|
|
4030
|
-
"aws-cdk-lib.IResource",
|
|
4031
|
-
"aws-cdk-lib.aws_iam.IGrantable"
|
|
4032
|
-
],
|
|
7620
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.ResourceCreationLimitPolicy",
|
|
4033
7621
|
"kind": "interface",
|
|
4034
7622
|
"locationInModule": {
|
|
4035
|
-
"filename": "lib/
|
|
4036
|
-
"line":
|
|
7623
|
+
"filename": "lib/fleet-base.ts",
|
|
7624
|
+
"line": 124
|
|
4037
7625
|
},
|
|
4038
|
-
"name": "
|
|
7626
|
+
"name": "ResourceCreationLimitPolicy",
|
|
4039
7627
|
"properties": [
|
|
4040
7628
|
{
|
|
4041
7629
|
"abstract": true,
|
|
4042
7630
|
"docs": {
|
|
4043
|
-
"
|
|
4044
|
-
"attribute": "true"
|
|
4045
|
-
},
|
|
7631
|
+
"default": "no limit on the number of game sessions that an individual can create during the policy period",
|
|
4046
7632
|
"stability": "experimental",
|
|
4047
|
-
"summary": "The
|
|
7633
|
+
"summary": "The maximum number of game sessions that an individual can create during the policy period."
|
|
4048
7634
|
},
|
|
4049
7635
|
"immutable": true,
|
|
4050
7636
|
"locationInModule": {
|
|
4051
|
-
"filename": "lib/
|
|
4052
|
-
"line":
|
|
7637
|
+
"filename": "lib/fleet-base.ts",
|
|
7638
|
+
"line": 130
|
|
4053
7639
|
},
|
|
4054
|
-
"name": "
|
|
7640
|
+
"name": "newGameSessionsPerCreator",
|
|
7641
|
+
"optional": true,
|
|
4055
7642
|
"type": {
|
|
4056
|
-
"primitive": "
|
|
7643
|
+
"primitive": "number"
|
|
4057
7644
|
}
|
|
4058
7645
|
},
|
|
4059
7646
|
{
|
|
4060
7647
|
"abstract": true,
|
|
4061
7648
|
"docs": {
|
|
4062
|
-
"
|
|
4063
|
-
"attribute": "true"
|
|
4064
|
-
},
|
|
7649
|
+
"default": "no policy period",
|
|
4065
7650
|
"stability": "experimental",
|
|
4066
|
-
"summary": "The
|
|
7651
|
+
"summary": "The time span used in evaluating the resource creation limit policy."
|
|
4067
7652
|
},
|
|
4068
7653
|
"immutable": true,
|
|
4069
7654
|
"locationInModule": {
|
|
4070
|
-
"filename": "lib/
|
|
4071
|
-
"line":
|
|
7655
|
+
"filename": "lib/fleet-base.ts",
|
|
7656
|
+
"line": 136
|
|
4072
7657
|
},
|
|
4073
|
-
"name": "
|
|
7658
|
+
"name": "policyPeriod",
|
|
7659
|
+
"optional": true,
|
|
4074
7660
|
"type": {
|
|
4075
|
-
"
|
|
7661
|
+
"fqn": "aws-cdk-lib.Duration"
|
|
4076
7662
|
}
|
|
4077
7663
|
}
|
|
4078
7664
|
],
|
|
4079
|
-
"symbolId": "lib/
|
|
7665
|
+
"symbolId": "lib/fleet-base:ResourceCreationLimitPolicy"
|
|
4080
7666
|
},
|
|
4081
|
-
"@aws-cdk/aws-gamelift-alpha.
|
|
7667
|
+
"@aws-cdk/aws-gamelift-alpha.RuntimeConfiguration": {
|
|
4082
7668
|
"assembly": "@aws-cdk/aws-gamelift-alpha",
|
|
7669
|
+
"datatype": true,
|
|
4083
7670
|
"docs": {
|
|
7671
|
+
"remarks": "Server processes run either an executable in a custom game build or a Realtime Servers script.\nGameLift launches the configured processes, manages their life cycle, and replaces them as needed.\nEach instance checks regularly for an updated runtime configuration.\n\nA GameLift instance is limited to 50 processes running concurrently.\nTo calculate the total number of processes in a runtime configuration, add the values of the `ConcurrentExecutions` parameter for each `ServerProcess`.",
|
|
7672
|
+
"see": "https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-multiprocess.html",
|
|
4084
7673
|
"stability": "experimental",
|
|
4085
|
-
"summary": "
|
|
7674
|
+
"summary": "A collection of server process configurations that describe the set of processes to run on each instance in a fleet.",
|
|
7675
|
+
"example": "declare const build: gamelift.Build;\n// Server processes can be delcared in a declarative way through the constructor\nconst fleet = new gamelift.BuildFleet(this, 'Game server fleet', {\n fleetName: 'test-fleet',\n content: build,\n instanceType: ec2.InstanceType.of(ec2.InstanceClass.C4, ec2.InstanceSize.LARGE),\n runtimeConfiguration: {\n serverProcesses: [{\n launchPath: '/local/game/GameLiftExampleServer.x86_64',\n parameters: '-logFile /local/game/logs/myserver1935.log -port 1935',\n concurrentExecutions: 100,\n }]\n }\n});",
|
|
7676
|
+
"custom": {
|
|
7677
|
+
"exampleMetadata": "infused"
|
|
7678
|
+
}
|
|
4086
7679
|
},
|
|
4087
|
-
"fqn": "@aws-cdk/aws-gamelift-alpha.
|
|
4088
|
-
"kind": "
|
|
7680
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.RuntimeConfiguration",
|
|
7681
|
+
"kind": "interface",
|
|
4089
7682
|
"locationInModule": {
|
|
4090
|
-
"filename": "lib/
|
|
4091
|
-
"line":
|
|
7683
|
+
"filename": "lib/fleet-base.ts",
|
|
7684
|
+
"line": 90
|
|
4092
7685
|
},
|
|
4093
|
-
"
|
|
7686
|
+
"name": "RuntimeConfiguration",
|
|
7687
|
+
"properties": [
|
|
4094
7688
|
{
|
|
7689
|
+
"abstract": true,
|
|
4095
7690
|
"docs": {
|
|
4096
|
-
"stability": "experimental"
|
|
7691
|
+
"stability": "experimental",
|
|
7692
|
+
"summary": "A collection of server process configurations that identify what server processes to run on each instance in a fleet."
|
|
4097
7693
|
},
|
|
4098
|
-
"
|
|
7694
|
+
"immutable": true,
|
|
7695
|
+
"locationInModule": {
|
|
7696
|
+
"filename": "lib/fleet-base.ts",
|
|
7697
|
+
"line": 112
|
|
7698
|
+
},
|
|
7699
|
+
"name": "serverProcesses",
|
|
7700
|
+
"type": {
|
|
7701
|
+
"collection": {
|
|
7702
|
+
"elementtype": {
|
|
7703
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.ServerProcess"
|
|
7704
|
+
},
|
|
7705
|
+
"kind": "array"
|
|
7706
|
+
}
|
|
7707
|
+
}
|
|
4099
7708
|
},
|
|
4100
7709
|
{
|
|
7710
|
+
"abstract": true,
|
|
4101
7711
|
"docs": {
|
|
4102
|
-
"
|
|
7712
|
+
"default": "by default game session activation timeout is 300 seconds",
|
|
7713
|
+
"remarks": "During this time, the game session is in status `ACTIVATING`.\n\nIf the game session does not become active before the timeout, it is ended and the game session status is changed to `TERMINATED`.",
|
|
7714
|
+
"stability": "experimental",
|
|
7715
|
+
"summary": "The maximum amount of time allowed to launch a new game session and have it report ready to host players."
|
|
4103
7716
|
},
|
|
4104
|
-
"
|
|
7717
|
+
"immutable": true,
|
|
7718
|
+
"locationInModule": {
|
|
7719
|
+
"filename": "lib/fleet-base.ts",
|
|
7720
|
+
"line": 99
|
|
7721
|
+
},
|
|
7722
|
+
"name": "gameSessionActivationTimeout",
|
|
7723
|
+
"optional": true,
|
|
7724
|
+
"type": {
|
|
7725
|
+
"fqn": "aws-cdk-lib.Duration"
|
|
7726
|
+
}
|
|
4105
7727
|
},
|
|
4106
7728
|
{
|
|
7729
|
+
"abstract": true,
|
|
4107
7730
|
"docs": {
|
|
4108
|
-
"
|
|
7731
|
+
"default": "no limit",
|
|
7732
|
+
"remarks": "This setting limits the instance resources that can be used for new game activations at any one time.",
|
|
7733
|
+
"stability": "experimental",
|
|
7734
|
+
"summary": "The number of game sessions in status `ACTIVATING` to allow on an instance."
|
|
4109
7735
|
},
|
|
4110
|
-
"
|
|
7736
|
+
"immutable": true,
|
|
7737
|
+
"locationInModule": {
|
|
7738
|
+
"filename": "lib/fleet-base.ts",
|
|
7739
|
+
"line": 107
|
|
7740
|
+
},
|
|
7741
|
+
"name": "maxConcurrentGameSessionActivations",
|
|
7742
|
+
"optional": true,
|
|
7743
|
+
"type": {
|
|
7744
|
+
"primitive": "number"
|
|
7745
|
+
}
|
|
4111
7746
|
}
|
|
4112
7747
|
],
|
|
4113
|
-
"
|
|
4114
|
-
"symbolId": "lib/build:OperatingSystem"
|
|
7748
|
+
"symbolId": "lib/fleet-base:RuntimeConfiguration"
|
|
4115
7749
|
},
|
|
4116
7750
|
"@aws-cdk/aws-gamelift-alpha.S3Content": {
|
|
4117
7751
|
"assembly": "@aws-cdk/aws-gamelift-alpha",
|
|
@@ -4180,9 +7814,9 @@
|
|
|
4180
7814
|
}
|
|
4181
7815
|
},
|
|
4182
7816
|
{
|
|
4183
|
-
"name": "
|
|
7817
|
+
"name": "role",
|
|
4184
7818
|
"type": {
|
|
4185
|
-
"fqn": "aws-cdk-lib.aws_iam.
|
|
7819
|
+
"fqn": "aws-cdk-lib.aws_iam.IRole"
|
|
4186
7820
|
}
|
|
4187
7821
|
}
|
|
4188
7822
|
],
|
|
@@ -4735,8 +8369,84 @@
|
|
|
4735
8369
|
}
|
|
4736
8370
|
],
|
|
4737
8371
|
"symbolId": "lib/script:ScriptProps"
|
|
8372
|
+
},
|
|
8373
|
+
"@aws-cdk/aws-gamelift-alpha.ServerProcess": {
|
|
8374
|
+
"assembly": "@aws-cdk/aws-gamelift-alpha",
|
|
8375
|
+
"datatype": true,
|
|
8376
|
+
"docs": {
|
|
8377
|
+
"stability": "experimental",
|
|
8378
|
+
"summary": "Configuration of a fleet server process.",
|
|
8379
|
+
"example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as gamelift_alpha from '@aws-cdk/aws-gamelift-alpha';\nconst serverProcess: gamelift_alpha.ServerProcess = {\n launchPath: 'launchPath',\n\n // the properties below are optional\n concurrentExecutions: 123,\n parameters: 'parameters',\n};",
|
|
8380
|
+
"custom": {
|
|
8381
|
+
"exampleMetadata": "fixture=_generated"
|
|
8382
|
+
}
|
|
8383
|
+
},
|
|
8384
|
+
"fqn": "@aws-cdk/aws-gamelift-alpha.ServerProcess",
|
|
8385
|
+
"kind": "interface",
|
|
8386
|
+
"locationInModule": {
|
|
8387
|
+
"filename": "lib/fleet-base.ts",
|
|
8388
|
+
"line": 56
|
|
8389
|
+
},
|
|
8390
|
+
"name": "ServerProcess",
|
|
8391
|
+
"properties": [
|
|
8392
|
+
{
|
|
8393
|
+
"abstract": true,
|
|
8394
|
+
"docs": {
|
|
8395
|
+
"remarks": "Game builds and Realtime scripts are installed on instances at the root:\n- Windows (custom game builds only): `C:\\game`. Example: `C:\\game\\MyGame\\server.exe`\n- Linux: `/local/game`. Examples: `/local/game/MyGame/server.exe` or `/local/game/MyRealtimeScript.js`",
|
|
8396
|
+
"stability": "experimental",
|
|
8397
|
+
"summary": "The location of a game build executable or the Realtime script file that contains the Init() function."
|
|
8398
|
+
},
|
|
8399
|
+
"immutable": true,
|
|
8400
|
+
"locationInModule": {
|
|
8401
|
+
"filename": "lib/fleet-base.ts",
|
|
8402
|
+
"line": 69
|
|
8403
|
+
},
|
|
8404
|
+
"name": "launchPath",
|
|
8405
|
+
"type": {
|
|
8406
|
+
"primitive": "string"
|
|
8407
|
+
}
|
|
8408
|
+
},
|
|
8409
|
+
{
|
|
8410
|
+
"abstract": true,
|
|
8411
|
+
"docs": {
|
|
8412
|
+
"default": "1",
|
|
8413
|
+
"remarks": "Minimum is `1`",
|
|
8414
|
+
"stability": "experimental",
|
|
8415
|
+
"summary": "The number of server processes using this configuration that run concurrently on each instance."
|
|
8416
|
+
},
|
|
8417
|
+
"immutable": true,
|
|
8418
|
+
"locationInModule": {
|
|
8419
|
+
"filename": "lib/fleet-base.ts",
|
|
8420
|
+
"line": 63
|
|
8421
|
+
},
|
|
8422
|
+
"name": "concurrentExecutions",
|
|
8423
|
+
"optional": true,
|
|
8424
|
+
"type": {
|
|
8425
|
+
"primitive": "number"
|
|
8426
|
+
}
|
|
8427
|
+
},
|
|
8428
|
+
{
|
|
8429
|
+
"abstract": true,
|
|
8430
|
+
"docs": {
|
|
8431
|
+
"default": "no parameters",
|
|
8432
|
+
"stability": "experimental",
|
|
8433
|
+
"summary": "An optional list of parameters to pass to the server executable or Realtime script on launch."
|
|
8434
|
+
},
|
|
8435
|
+
"immutable": true,
|
|
8436
|
+
"locationInModule": {
|
|
8437
|
+
"filename": "lib/fleet-base.ts",
|
|
8438
|
+
"line": 76
|
|
8439
|
+
},
|
|
8440
|
+
"name": "parameters",
|
|
8441
|
+
"optional": true,
|
|
8442
|
+
"type": {
|
|
8443
|
+
"primitive": "string"
|
|
8444
|
+
}
|
|
8445
|
+
}
|
|
8446
|
+
],
|
|
8447
|
+
"symbolId": "lib/fleet-base:ServerProcess"
|
|
4738
8448
|
}
|
|
4739
8449
|
},
|
|
4740
|
-
"version": "2.
|
|
8450
|
+
"version": "2.51.0-alpha.0",
|
|
4741
8451
|
"fingerprint": "**********"
|
|
4742
8452
|
}
|