@aws-sdk/client-gamelift 3.554.0 → 3.562.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/README.md +32 -0
- package/dist-cjs/index.js +453 -72
- package/dist-es/GameLift.js +8 -0
- package/dist-es/commands/CreateContainerGroupDefinitionCommand.js +25 -0
- package/dist-es/commands/CreateFleetCommand.js +2 -2
- package/dist-es/commands/DeleteContainerGroupDefinitionCommand.js +24 -0
- package/dist-es/commands/DescribeContainerGroupDefinitionCommand.js +25 -0
- package/dist-es/commands/DescribeFleetAttributesCommand.js +2 -1
- package/dist-es/commands/ListContainerGroupDefinitionsCommand.js +25 -0
- package/dist-es/commands/SearchGameSessionsCommand.js +1 -1
- package/dist-es/commands/StartGameSessionPlacementCommand.js +1 -1
- package/dist-es/commands/StartMatchBackfillCommand.js +1 -1
- package/dist-es/commands/StartMatchmakingCommand.js +1 -1
- package/dist-es/commands/StopGameSessionPlacementCommand.js +1 -1
- package/dist-es/commands/index.js +4 -0
- package/dist-es/models/models_0.js +124 -45
- package/dist-es/models/models_1.js +42 -1
- package/dist-es/pagination/ListContainerGroupDefinitionsPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_json1_1.js +129 -1
- package/dist-types/GameLift.d.ts +29 -0
- package/dist-types/GameLiftClient.d.ts +6 -2
- package/dist-types/commands/CreateContainerGroupDefinitionCommand.d.ts +262 -0
- package/dist-types/commands/CreateFleetCommand.d.ts +169 -29
- package/dist-types/commands/CreateFleetLocationsCommand.d.ts +14 -6
- package/dist-types/commands/DeleteContainerGroupDefinitionCommand.d.ts +94 -0
- package/dist-types/commands/DeleteFleetCommand.d.ts +5 -6
- package/dist-types/commands/DeregisterComputeCommand.d.ts +10 -2
- package/dist-types/commands/DescribeComputeCommand.d.ts +35 -6
- package/dist-types/commands/DescribeContainerGroupDefinitionCommand.d.ts +152 -0
- package/dist-types/commands/DescribeFleetAttributesCommand.d.ts +25 -7
- package/dist-types/commands/DescribeFleetCapacityCommand.d.ts +17 -7
- package/dist-types/commands/DescribeFleetEventsCommand.d.ts +1 -0
- package/dist-types/commands/DescribeFleetLocationCapacityCommand.d.ts +11 -3
- package/dist-types/commands/DescribeFleetPortSettingsCommand.d.ts +10 -9
- package/dist-types/commands/DescribeRuntimeConfigurationCommand.d.ts +7 -4
- package/dist-types/commands/GetComputeAccessCommand.d.ts +39 -14
- package/dist-types/commands/GetComputeAuthTokenCommand.d.ts +20 -6
- package/dist-types/commands/ListComputeCommand.d.ts +38 -8
- package/dist-types/commands/ListContainerGroupDefinitionsCommand.d.ts +156 -0
- package/dist-types/commands/ListFleetsCommand.d.ts +20 -19
- package/dist-types/commands/RegisterComputeCommand.d.ts +31 -8
- package/dist-types/commands/RequestUploadCredentialsCommand.d.ts +1 -1
- package/dist-types/commands/ResolveAliasCommand.d.ts +5 -1
- package/dist-types/commands/ResumeGameServerGroupCommand.d.ts +2 -1
- package/dist-types/commands/SearchGameSessionsCommand.d.ts +2 -2
- package/dist-types/commands/StartFleetActionsCommand.d.ts +1 -1
- package/dist-types/commands/StartGameSessionPlacementCommand.d.ts +1 -1
- package/dist-types/commands/StartMatchBackfillCommand.d.ts +1 -1
- package/dist-types/commands/StartMatchmakingCommand.d.ts +1 -1
- package/dist-types/commands/StopFleetActionsCommand.d.ts +3 -2
- package/dist-types/commands/StopGameSessionPlacementCommand.d.ts +1 -1
- package/dist-types/commands/StopMatchmakingCommand.d.ts +1 -1
- package/dist-types/commands/SuspendGameServerGroupCommand.d.ts +1 -1
- package/dist-types/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAliasCommand.d.ts +4 -5
- package/dist-types/commands/UpdateBuildCommand.d.ts +1 -1
- package/dist-types/commands/UpdateFleetAttributesCommand.d.ts +3 -4
- package/dist-types/commands/UpdateFleetCapacityCommand.d.ts +27 -30
- package/dist-types/commands/UpdateFleetPortSettingsCommand.d.ts +4 -2
- package/dist-types/commands/UpdateRuntimeConfigurationCommand.d.ts +16 -9
- package/dist-types/commands/index.d.ts +4 -0
- package/dist-types/models/models_0.d.ts +5561 -4910
- package/dist-types/models/models_1.d.ts +685 -7
- package/dist-types/pagination/ListContainerGroupDefinitionsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_json1_1.d.ts +36 -0
- package/dist-types/ts3.4/GameLift.d.ts +69 -0
- package/dist-types/ts3.4/GameLiftClient.d.ts +24 -0
- package/dist-types/ts3.4/commands/CreateContainerGroupDefinitionCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/DeleteContainerGroupDefinitionCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/DescribeContainerGroupDefinitionCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ListContainerGroupDefinitionsCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ResumeGameServerGroupCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/SearchGameSessionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartFleetActionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartGameSessionPlacementCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartMatchBackfillCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartMatchmakingCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StopFleetActionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StopGameSessionPlacementCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StopMatchmakingCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SuspendGameServerGroupCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateAliasCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateBuildCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateFleetAttributesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/index.d.ts +4 -0
- package/dist-types/ts3.4/models/models_0.d.ts +232 -150
- package/dist-types/ts3.4/models/models_1.d.ts +158 -0
- package/dist-types/ts3.4/pagination/ListContainerGroupDefinitionsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +48 -0
- package/package.json +4 -4
|
@@ -0,0 +1,262 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { GameLiftClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GameLiftClient";
|
|
4
|
+
import { CreateContainerGroupDefinitionInput, CreateContainerGroupDefinitionOutput } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export { __MetadataBearer, $Command };
|
|
9
|
+
/**
|
|
10
|
+
* @public
|
|
11
|
+
*
|
|
12
|
+
* The input for {@link CreateContainerGroupDefinitionCommand}.
|
|
13
|
+
*/
|
|
14
|
+
export interface CreateContainerGroupDefinitionCommandInput extends CreateContainerGroupDefinitionInput {
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* @public
|
|
18
|
+
*
|
|
19
|
+
* The output of {@link CreateContainerGroupDefinitionCommand}.
|
|
20
|
+
*/
|
|
21
|
+
export interface CreateContainerGroupDefinitionCommandOutput extends CreateContainerGroupDefinitionOutput, __MetadataBearer {
|
|
22
|
+
}
|
|
23
|
+
declare const CreateContainerGroupDefinitionCommand_base: {
|
|
24
|
+
new (input: CreateContainerGroupDefinitionCommandInput): import("@smithy/smithy-client").CommandImpl<CreateContainerGroupDefinitionCommandInput, CreateContainerGroupDefinitionCommandOutput, GameLiftClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: CreateContainerGroupDefinitionCommandInput): import("@smithy/smithy-client").CommandImpl<CreateContainerGroupDefinitionCommandInput, CreateContainerGroupDefinitionCommandOutput, GameLiftClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
|
+
};
|
|
28
|
+
/**
|
|
29
|
+
* <p>
|
|
30
|
+
* <b>This operation is used with the Amazon GameLift containers feature, which is currently in public preview. </b>
|
|
31
|
+
* </p>
|
|
32
|
+
* <p>Creates a <code>ContainerGroupDefinition</code> resource that describes a set of
|
|
33
|
+
* containers for hosting your game server with Amazon GameLift managed EC2 hosting. An Amazon GameLift container
|
|
34
|
+
* group is similar to a container "task" and "pod". Each container group can have one or more
|
|
35
|
+
* containers. </p>
|
|
36
|
+
* <p>Use container group definitions when you create a container fleet. Container group
|
|
37
|
+
* definitions determine how Amazon GameLift deploys your containers to each instance in a container
|
|
38
|
+
* fleet. </p>
|
|
39
|
+
* <p>You can create two types of container groups, based on scheduling strategy:</p>
|
|
40
|
+
* <ul>
|
|
41
|
+
* <li>
|
|
42
|
+
* <p>A <b>replica container group</b> manages the containers that run
|
|
43
|
+
* your game server application and supporting software. Replica container groups might be
|
|
44
|
+
* replicated multiple times on each fleet instance, depending on instance resources. </p>
|
|
45
|
+
* </li>
|
|
46
|
+
* <li>
|
|
47
|
+
* <p>A <b>daemon container group</b> manages containers that run other
|
|
48
|
+
* software, such as background services, logging, or test processes. You might use a daemon
|
|
49
|
+
* container group for processes that need to run only once per fleet instance, or processes
|
|
50
|
+
* that need to persist independently of the replica container group. </p>
|
|
51
|
+
* </li>
|
|
52
|
+
* </ul>
|
|
53
|
+
* <p>To create a container group definition, specify a group name, a list of container
|
|
54
|
+
* definitions, and maximum total CPU and memory requirements for the container group. Specify an
|
|
55
|
+
* operating system and scheduling strategy or use the default values. When using the Amazon Web Services CLI
|
|
56
|
+
* tool, you can pass in your container definitions as a JSON file.</p>
|
|
57
|
+
* <note>
|
|
58
|
+
* <p>This operation requires Identity and Access Management (IAM) permissions to access container images in
|
|
59
|
+
* Amazon ECR repositories. See <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-iam-policy-examples.html"> IAM permissions
|
|
60
|
+
* for Amazon GameLift</a> for help setting the appropriate permissions.</p>
|
|
61
|
+
* </note>
|
|
62
|
+
* <p>If successful, this operation creates a new <code>ContainerGroupDefinition</code> resource
|
|
63
|
+
* with an ARN value assigned. You can't change the properties of a container group definition.
|
|
64
|
+
* Instead, create a new one. </p>
|
|
65
|
+
* <p>
|
|
66
|
+
* <b>Learn more</b>
|
|
67
|
+
* </p>
|
|
68
|
+
* <ul>
|
|
69
|
+
* <li>
|
|
70
|
+
* <p>
|
|
71
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-create-groups.html">Create a container group definition</a>
|
|
72
|
+
* </p>
|
|
73
|
+
* </li>
|
|
74
|
+
* <li>
|
|
75
|
+
* <p>
|
|
76
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-design-fleet.html">Container fleet design guide</a>
|
|
77
|
+
* </p>
|
|
78
|
+
* </li>
|
|
79
|
+
* <li>
|
|
80
|
+
* <p>
|
|
81
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-definitions.html#containers-definitions-create">Create a container definition as a JSON file</a>
|
|
82
|
+
* </p>
|
|
83
|
+
* </li>
|
|
84
|
+
* </ul>
|
|
85
|
+
* @example
|
|
86
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
87
|
+
* ```javascript
|
|
88
|
+
* import { GameLiftClient, CreateContainerGroupDefinitionCommand } from "@aws-sdk/client-gamelift"; // ES Modules import
|
|
89
|
+
* // const { GameLiftClient, CreateContainerGroupDefinitionCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import
|
|
90
|
+
* const client = new GameLiftClient(config);
|
|
91
|
+
* const input = { // CreateContainerGroupDefinitionInput
|
|
92
|
+
* Name: "STRING_VALUE", // required
|
|
93
|
+
* SchedulingStrategy: "REPLICA" || "DAEMON",
|
|
94
|
+
* TotalMemoryLimit: Number("int"), // required
|
|
95
|
+
* TotalCpuLimit: Number("int"), // required
|
|
96
|
+
* ContainerDefinitions: [ // ContainerDefinitionInputList // required
|
|
97
|
+
* { // ContainerDefinitionInput
|
|
98
|
+
* ContainerName: "STRING_VALUE", // required
|
|
99
|
+
* ImageUri: "STRING_VALUE", // required
|
|
100
|
+
* MemoryLimits: { // ContainerMemoryLimits
|
|
101
|
+
* SoftLimit: Number("int"),
|
|
102
|
+
* HardLimit: Number("int"),
|
|
103
|
+
* },
|
|
104
|
+
* PortConfiguration: { // ContainerPortConfiguration
|
|
105
|
+
* ContainerPortRanges: [ // ContainerPortRangeList // required
|
|
106
|
+
* { // ContainerPortRange
|
|
107
|
+
* FromPort: Number("int"), // required
|
|
108
|
+
* ToPort: Number("int"), // required
|
|
109
|
+
* Protocol: "TCP" || "UDP", // required
|
|
110
|
+
* },
|
|
111
|
+
* ],
|
|
112
|
+
* },
|
|
113
|
+
* Cpu: Number("int"),
|
|
114
|
+
* HealthCheck: { // ContainerHealthCheck
|
|
115
|
+
* Command: [ // ContainerCommandStringList // required
|
|
116
|
+
* "STRING_VALUE",
|
|
117
|
+
* ],
|
|
118
|
+
* Interval: Number("int"),
|
|
119
|
+
* Timeout: Number("int"),
|
|
120
|
+
* Retries: Number("int"),
|
|
121
|
+
* StartPeriod: Number("int"),
|
|
122
|
+
* },
|
|
123
|
+
* Command: [
|
|
124
|
+
* "STRING_VALUE",
|
|
125
|
+
* ],
|
|
126
|
+
* Essential: true || false,
|
|
127
|
+
* EntryPoint: [ // ContainerEntryPointList
|
|
128
|
+
* "STRING_VALUE",
|
|
129
|
+
* ],
|
|
130
|
+
* WorkingDirectory: "STRING_VALUE",
|
|
131
|
+
* Environment: [ // ContainerEnvironmentList
|
|
132
|
+
* { // ContainerEnvironment
|
|
133
|
+
* Name: "STRING_VALUE", // required
|
|
134
|
+
* Value: "STRING_VALUE", // required
|
|
135
|
+
* },
|
|
136
|
+
* ],
|
|
137
|
+
* DependsOn: [ // ContainerDependencyList
|
|
138
|
+
* { // ContainerDependency
|
|
139
|
+
* ContainerName: "STRING_VALUE", // required
|
|
140
|
+
* Condition: "START" || "COMPLETE" || "SUCCESS" || "HEALTHY", // required
|
|
141
|
+
* },
|
|
142
|
+
* ],
|
|
143
|
+
* },
|
|
144
|
+
* ],
|
|
145
|
+
* OperatingSystem: "AMAZON_LINUX_2023", // required
|
|
146
|
+
* Tags: [ // TagList
|
|
147
|
+
* { // Tag
|
|
148
|
+
* Key: "STRING_VALUE", // required
|
|
149
|
+
* Value: "STRING_VALUE", // required
|
|
150
|
+
* },
|
|
151
|
+
* ],
|
|
152
|
+
* };
|
|
153
|
+
* const command = new CreateContainerGroupDefinitionCommand(input);
|
|
154
|
+
* const response = await client.send(command);
|
|
155
|
+
* // { // CreateContainerGroupDefinitionOutput
|
|
156
|
+
* // ContainerGroupDefinition: { // ContainerGroupDefinition
|
|
157
|
+
* // ContainerGroupDefinitionArn: "STRING_VALUE",
|
|
158
|
+
* // CreationTime: new Date("TIMESTAMP"),
|
|
159
|
+
* // OperatingSystem: "AMAZON_LINUX_2023",
|
|
160
|
+
* // Name: "STRING_VALUE",
|
|
161
|
+
* // SchedulingStrategy: "REPLICA" || "DAEMON",
|
|
162
|
+
* // TotalMemoryLimit: Number("int"),
|
|
163
|
+
* // TotalCpuLimit: Number("int"),
|
|
164
|
+
* // ContainerDefinitions: [ // ContainerDefinitionList
|
|
165
|
+
* // { // ContainerDefinition
|
|
166
|
+
* // ContainerName: "STRING_VALUE", // required
|
|
167
|
+
* // ImageUri: "STRING_VALUE", // required
|
|
168
|
+
* // ResolvedImageDigest: "STRING_VALUE",
|
|
169
|
+
* // MemoryLimits: { // ContainerMemoryLimits
|
|
170
|
+
* // SoftLimit: Number("int"),
|
|
171
|
+
* // HardLimit: Number("int"),
|
|
172
|
+
* // },
|
|
173
|
+
* // PortConfiguration: { // ContainerPortConfiguration
|
|
174
|
+
* // ContainerPortRanges: [ // ContainerPortRangeList // required
|
|
175
|
+
* // { // ContainerPortRange
|
|
176
|
+
* // FromPort: Number("int"), // required
|
|
177
|
+
* // ToPort: Number("int"), // required
|
|
178
|
+
* // Protocol: "TCP" || "UDP", // required
|
|
179
|
+
* // },
|
|
180
|
+
* // ],
|
|
181
|
+
* // },
|
|
182
|
+
* // Cpu: Number("int"),
|
|
183
|
+
* // HealthCheck: { // ContainerHealthCheck
|
|
184
|
+
* // Command: [ // ContainerCommandStringList // required
|
|
185
|
+
* // "STRING_VALUE",
|
|
186
|
+
* // ],
|
|
187
|
+
* // Interval: Number("int"),
|
|
188
|
+
* // Timeout: Number("int"),
|
|
189
|
+
* // Retries: Number("int"),
|
|
190
|
+
* // StartPeriod: Number("int"),
|
|
191
|
+
* // },
|
|
192
|
+
* // Command: [
|
|
193
|
+
* // "STRING_VALUE",
|
|
194
|
+
* // ],
|
|
195
|
+
* // Essential: true || false,
|
|
196
|
+
* // EntryPoint: [ // ContainerEntryPointList
|
|
197
|
+
* // "STRING_VALUE",
|
|
198
|
+
* // ],
|
|
199
|
+
* // WorkingDirectory: "STRING_VALUE",
|
|
200
|
+
* // Environment: [ // ContainerEnvironmentList
|
|
201
|
+
* // { // ContainerEnvironment
|
|
202
|
+
* // Name: "STRING_VALUE", // required
|
|
203
|
+
* // Value: "STRING_VALUE", // required
|
|
204
|
+
* // },
|
|
205
|
+
* // ],
|
|
206
|
+
* // DependsOn: [ // ContainerDependencyList
|
|
207
|
+
* // { // ContainerDependency
|
|
208
|
+
* // ContainerName: "STRING_VALUE", // required
|
|
209
|
+
* // Condition: "START" || "COMPLETE" || "SUCCESS" || "HEALTHY", // required
|
|
210
|
+
* // },
|
|
211
|
+
* // ],
|
|
212
|
+
* // },
|
|
213
|
+
* // ],
|
|
214
|
+
* // Status: "READY" || "COPYING" || "FAILED",
|
|
215
|
+
* // StatusReason: "STRING_VALUE",
|
|
216
|
+
* // },
|
|
217
|
+
* // };
|
|
218
|
+
*
|
|
219
|
+
* ```
|
|
220
|
+
*
|
|
221
|
+
* @param CreateContainerGroupDefinitionCommandInput - {@link CreateContainerGroupDefinitionCommandInput}
|
|
222
|
+
* @returns {@link CreateContainerGroupDefinitionCommandOutput}
|
|
223
|
+
* @see {@link CreateContainerGroupDefinitionCommandInput} for command's `input` shape.
|
|
224
|
+
* @see {@link CreateContainerGroupDefinitionCommandOutput} for command's `response` shape.
|
|
225
|
+
* @see {@link GameLiftClientResolvedConfig | config} for GameLiftClient's `config` shape.
|
|
226
|
+
*
|
|
227
|
+
* @throws {@link ConflictException} (client fault)
|
|
228
|
+
* <p>The requested operation would cause a conflict with the current state of a service
|
|
229
|
+
* resource associated with the request. Resolve the conflict before retrying this
|
|
230
|
+
* request.</p>
|
|
231
|
+
* <p></p>
|
|
232
|
+
*
|
|
233
|
+
* @throws {@link InternalServiceException} (server fault)
|
|
234
|
+
* <p>The service encountered an unrecoverable internal failure while processing the
|
|
235
|
+
* request. Clients can retry such requests immediately or after a waiting period.</p>
|
|
236
|
+
*
|
|
237
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
238
|
+
* <p>One or more parameter values in the request are invalid. Correct the invalid parameter
|
|
239
|
+
* values before retrying.</p>
|
|
240
|
+
*
|
|
241
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
242
|
+
* <p>The requested operation would cause the resource to exceed the allowed service limit.
|
|
243
|
+
* Resolve the issue before retrying.</p>
|
|
244
|
+
*
|
|
245
|
+
* @throws {@link TaggingFailedException} (client fault)
|
|
246
|
+
* <p>The requested tagging operation did not succeed. This may be due to invalid tag format
|
|
247
|
+
* or the maximum tag limit may have been exceeded. Resolve the issue before
|
|
248
|
+
* retrying.</p>
|
|
249
|
+
*
|
|
250
|
+
* @throws {@link UnauthorizedException} (client fault)
|
|
251
|
+
* <p>The client failed authentication. Clients should not retry such requests.</p>
|
|
252
|
+
*
|
|
253
|
+
* @throws {@link UnsupportedRegionException} (client fault)
|
|
254
|
+
* <p>The requested operation is not supported in the Region specified.</p>
|
|
255
|
+
*
|
|
256
|
+
* @throws {@link GameLiftServiceException}
|
|
257
|
+
* <p>Base exception class for all service exceptions from GameLift service.</p>
|
|
258
|
+
*
|
|
259
|
+
* @public
|
|
260
|
+
*/
|
|
261
|
+
export declare class CreateContainerGroupDefinitionCommand extends CreateContainerGroupDefinitionCommand_base {
|
|
262
|
+
}
|
|
@@ -26,33 +26,139 @@ declare const CreateFleetCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
* <p>
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
* <p>
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
*
|
|
41
|
-
*
|
|
42
|
-
*
|
|
43
|
-
*
|
|
44
|
-
*
|
|
45
|
-
*
|
|
46
|
-
*
|
|
47
|
-
*
|
|
48
|
-
*
|
|
49
|
-
*
|
|
50
|
-
*
|
|
51
|
-
*
|
|
52
|
-
*
|
|
53
|
-
*
|
|
54
|
-
*
|
|
55
|
-
*
|
|
29
|
+
* <p>
|
|
30
|
+
* <b>This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.</b>
|
|
31
|
+
* </p>
|
|
32
|
+
* <p>Creates a fleet of compute resources to host your game servers. Use this operation to
|
|
33
|
+
* set up the following types of fleets based on compute type: </p>
|
|
34
|
+
* <p>
|
|
35
|
+
* <b>Managed EC2 fleet</b>
|
|
36
|
+
* </p>
|
|
37
|
+
* <p>An EC2 fleet is a set of Amazon Elastic Compute Cloud (Amazon EC2) instances. Your game server build is
|
|
38
|
+
* deployed to each fleet instance. Amazon GameLift manages the fleet's instances and controls the
|
|
39
|
+
* lifecycle of game server processes, which host game sessions for players. EC2 fleets can
|
|
40
|
+
* have instances in multiple locations. Each instance in the fleet is designated a
|
|
41
|
+
* <code>Compute</code>.</p>
|
|
42
|
+
* <p>To create an EC2 fleet, provide these required parameters:</p>
|
|
43
|
+
* <ul>
|
|
44
|
+
* <li>
|
|
45
|
+
* <p>Either <code>BuildId</code> or <code>ScriptId</code>
|
|
46
|
+
* </p>
|
|
47
|
+
* </li>
|
|
48
|
+
* <li>
|
|
49
|
+
* <p>
|
|
50
|
+
* <code>ComputeType</code> set to <code>EC2</code> (the default value)</p>
|
|
51
|
+
* </li>
|
|
52
|
+
* <li>
|
|
53
|
+
* <p>
|
|
54
|
+
* <code>EC2InboundPermissions</code>
|
|
55
|
+
* </p>
|
|
56
|
+
* </li>
|
|
57
|
+
* <li>
|
|
58
|
+
* <p>
|
|
59
|
+
* <code>EC2InstanceType</code>
|
|
60
|
+
* </p>
|
|
61
|
+
* </li>
|
|
62
|
+
* <li>
|
|
63
|
+
* <p>
|
|
64
|
+
* <code>FleetType</code>
|
|
65
|
+
* </p>
|
|
66
|
+
* </li>
|
|
67
|
+
* <li>
|
|
68
|
+
* <p>
|
|
69
|
+
* <code>Name</code>
|
|
70
|
+
* </p>
|
|
71
|
+
* </li>
|
|
72
|
+
* <li>
|
|
73
|
+
* <p>
|
|
74
|
+
* <code>RuntimeConfiguration</code> with at least one <code>ServerProcesses</code>
|
|
75
|
+
* configuration</p>
|
|
76
|
+
* </li>
|
|
77
|
+
* </ul>
|
|
78
|
+
* <p>If successful, this operation creates a new fleet resource and places it in
|
|
79
|
+
* <code>NEW</code> status while Amazon GameLift initiates the <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-all.html#fleets-creation-workflow">fleet creation workflow</a>. To debug your fleet, fetch logs, view performance
|
|
80
|
+
* metrics or other actions on the fleet, create a development fleet with port 22/3389
|
|
81
|
+
* open. As a best practice, we recommend opening ports for remote access only when you
|
|
82
|
+
* need them and closing them when you're finished. </p>
|
|
83
|
+
* <p>When the fleet status is ACTIVE, you can adjust capacity settings and turn autoscaling
|
|
84
|
+
* on/off for each location.</p>
|
|
85
|
+
* <p>
|
|
86
|
+
* <b>Managed container fleet</b>
|
|
87
|
+
* </p>
|
|
88
|
+
* <p>A container fleet is a set of Amazon Elastic Compute Cloud (Amazon EC2) instances. Your container architecture
|
|
89
|
+
* is deployed to each fleet instance based on the fleet configuration. Amazon GameLift manages the
|
|
90
|
+
* containers on each fleet instance and controls the lifecycle of game server processes,
|
|
91
|
+
* which host game sessions for players. Container fleets can have instances in multiple
|
|
92
|
+
* locations. Each container on an instance that runs game server processes is registered
|
|
93
|
+
* as a <code>Compute</code>.</p>
|
|
94
|
+
* <p>To create a container fleet, provide these required parameters:</p>
|
|
95
|
+
* <ul>
|
|
96
|
+
* <li>
|
|
97
|
+
* <p>
|
|
98
|
+
* <code>ComputeType</code> set to <code>CONTAINER</code>
|
|
99
|
+
* </p>
|
|
100
|
+
* </li>
|
|
101
|
+
* <li>
|
|
102
|
+
* <p>
|
|
103
|
+
* <code>ContainerGroupsConfiguration</code>
|
|
104
|
+
* </p>
|
|
105
|
+
* </li>
|
|
106
|
+
* <li>
|
|
107
|
+
* <p>
|
|
108
|
+
* <code>EC2InboundPermissions</code>
|
|
109
|
+
* </p>
|
|
110
|
+
* </li>
|
|
111
|
+
* <li>
|
|
112
|
+
* <p>
|
|
113
|
+
* <code>EC2InstanceType</code>
|
|
114
|
+
* </p>
|
|
115
|
+
* </li>
|
|
116
|
+
* <li>
|
|
117
|
+
* <p>
|
|
118
|
+
* <code>FleetType</code> set to <code>ON_DEMAND</code>
|
|
119
|
+
* </p>
|
|
120
|
+
* </li>
|
|
121
|
+
* <li>
|
|
122
|
+
* <p>
|
|
123
|
+
* <code>Name</code>
|
|
124
|
+
* </p>
|
|
125
|
+
* </li>
|
|
126
|
+
* <li>
|
|
127
|
+
* <p>
|
|
128
|
+
* <code>RuntimeConfiguration</code> with at least one <code>ServerProcesses</code>
|
|
129
|
+
* configuration</p>
|
|
130
|
+
* </li>
|
|
131
|
+
* </ul>
|
|
132
|
+
* <p>If successful, this operation creates a new fleet resource and places it in
|
|
133
|
+
* <code>NEW</code> status while Amazon GameLift initiates the <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-all.html#fleets-creation-workflow">fleet creation workflow</a>. </p>
|
|
134
|
+
* <p>When the fleet status is ACTIVE, you can adjust capacity settings and turn autoscaling
|
|
135
|
+
* on/off for each location.</p>
|
|
136
|
+
* <p>
|
|
137
|
+
* <b>Anywhere fleet</b>
|
|
138
|
+
* </p>
|
|
139
|
+
* <p>An Anywhere fleet represents compute resources that are not owned or managed by
|
|
140
|
+
* Amazon GameLift. You might create an Anywhere fleet with your local machine for testing, or use
|
|
141
|
+
* one to host game servers with on-premises hardware or other game hosting solutions. </p>
|
|
142
|
+
* <p>To create an Anywhere fleet, provide these required parameters:</p>
|
|
143
|
+
* <ul>
|
|
144
|
+
* <li>
|
|
145
|
+
* <p>
|
|
146
|
+
* <code>ComputeType</code> set to <code>ANYWHERE</code>
|
|
147
|
+
* </p>
|
|
148
|
+
* </li>
|
|
149
|
+
* <li>
|
|
150
|
+
* <p>
|
|
151
|
+
* <code>Locations</code> specifying a custom location</p>
|
|
152
|
+
* </li>
|
|
153
|
+
* <li>
|
|
154
|
+
* <p>
|
|
155
|
+
* <code>Name</code>
|
|
156
|
+
* </p>
|
|
157
|
+
* </li>
|
|
158
|
+
* </ul>
|
|
159
|
+
* <p>If successful, this operation creates a new fleet resource and places it in
|
|
160
|
+
* <code>ACTIVE</code> status. You can register computes with a fleet in
|
|
161
|
+
* <code>ACTIVE</code> status. </p>
|
|
56
162
|
* <p>
|
|
57
163
|
* <b>Learn more</b>
|
|
58
164
|
* </p>
|
|
@@ -61,6 +167,9 @@ declare const CreateFleetCommand_base: {
|
|
|
61
167
|
* fleets</a>
|
|
62
168
|
* </p>
|
|
63
169
|
* <p>
|
|
170
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-build-fleet.html">Setting up a container fleet</a>
|
|
171
|
+
* </p>
|
|
172
|
+
* <p>
|
|
64
173
|
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html#fleets-creating-debug-creation">Debug fleet creation issues</a>
|
|
65
174
|
* </p>
|
|
66
175
|
* <p>
|
|
@@ -128,11 +237,21 @@ declare const CreateFleetCommand_base: {
|
|
|
128
237
|
* Value: "STRING_VALUE", // required
|
|
129
238
|
* },
|
|
130
239
|
* ],
|
|
131
|
-
* ComputeType: "EC2" || "ANYWHERE",
|
|
240
|
+
* ComputeType: "EC2" || "ANYWHERE" || "CONTAINER",
|
|
132
241
|
* AnywhereConfiguration: { // AnywhereConfiguration
|
|
133
242
|
* Cost: "STRING_VALUE", // required
|
|
134
243
|
* },
|
|
135
244
|
* InstanceRoleCredentialsProvider: "SHARED_CREDENTIAL_FILE",
|
|
245
|
+
* ContainerGroupsConfiguration: { // ContainerGroupsConfiguration
|
|
246
|
+
* ContainerGroupDefinitionNames: [ // ContainerGroupDefinitionNameOrArnLimitedList // required
|
|
247
|
+
* "STRING_VALUE",
|
|
248
|
+
* ],
|
|
249
|
+
* ConnectionPortRange: { // ConnectionPortRange
|
|
250
|
+
* FromPort: Number("int"), // required
|
|
251
|
+
* ToPort: Number("int"), // required
|
|
252
|
+
* },
|
|
253
|
+
* DesiredReplicaContainerGroupsPerInstance: Number("int"),
|
|
254
|
+
* },
|
|
136
255
|
* };
|
|
137
256
|
* const command = new CreateFleetCommand(input);
|
|
138
257
|
* const response = await client.send(command);
|
|
@@ -172,11 +291,27 @@ declare const CreateFleetCommand_base: {
|
|
|
172
291
|
* // CertificateConfiguration: { // CertificateConfiguration
|
|
173
292
|
* // CertificateType: "DISABLED" || "GENERATED", // required
|
|
174
293
|
* // },
|
|
175
|
-
* // ComputeType: "EC2" || "ANYWHERE",
|
|
294
|
+
* // ComputeType: "EC2" || "ANYWHERE" || "CONTAINER",
|
|
176
295
|
* // AnywhereConfiguration: { // AnywhereConfiguration
|
|
177
296
|
* // Cost: "STRING_VALUE", // required
|
|
178
297
|
* // },
|
|
179
298
|
* // InstanceRoleCredentialsProvider: "SHARED_CREDENTIAL_FILE",
|
|
299
|
+
* // ContainerGroupsAttributes: { // ContainerGroupsAttributes
|
|
300
|
+
* // ContainerGroupDefinitionProperties: [ // ContainerGroupDefinitionPropertiesList
|
|
301
|
+
* // { // ContainerGroupDefinitionProperty
|
|
302
|
+
* // SchedulingStrategy: "REPLICA" || "DAEMON",
|
|
303
|
+
* // ContainerGroupDefinitionName: "STRING_VALUE",
|
|
304
|
+
* // },
|
|
305
|
+
* // ],
|
|
306
|
+
* // ConnectionPortRange: { // ConnectionPortRange
|
|
307
|
+
* // FromPort: Number("int"), // required
|
|
308
|
+
* // ToPort: Number("int"), // required
|
|
309
|
+
* // },
|
|
310
|
+
* // ContainerGroupsPerInstance: { // ContainerGroupsPerInstance
|
|
311
|
+
* // DesiredReplicaContainerGroupsPerInstance: Number("int"),
|
|
312
|
+
* // MaxReplicaContainerGroupsPerInstance: Number("int"),
|
|
313
|
+
* // },
|
|
314
|
+
* // },
|
|
180
315
|
* // },
|
|
181
316
|
* // LocationStates: [ // LocationStateList
|
|
182
317
|
* // { // LocationState
|
|
@@ -215,6 +350,11 @@ declare const CreateFleetCommand_base: {
|
|
|
215
350
|
* @throws {@link NotFoundException} (client fault)
|
|
216
351
|
* <p>THe requested resources was not found. The resource was either not created yet or deleted.</p>
|
|
217
352
|
*
|
|
353
|
+
* @throws {@link NotReadyException} (client fault)
|
|
354
|
+
* <p> The operation failed because Amazon GameLift has not yet finished validating this compute. We
|
|
355
|
+
* recommend attempting 8 to 10 retries over 3 to 5 minutes with <a href="http://aws.amazon.com/blogs/https:/aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/">exponential
|
|
356
|
+
* backoffs and jitter</a>. </p>
|
|
357
|
+
*
|
|
218
358
|
* @throws {@link TaggingFailedException} (client fault)
|
|
219
359
|
* <p>The requested tagging operation did not succeed. This may be due to invalid tag format
|
|
220
360
|
* or the maximum tag limit may have been exceeded. Resolve the issue before
|
|
@@ -26,13 +26,16 @@ declare const CreateFleetLocationsCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
* <p>
|
|
30
|
-
*
|
|
31
|
-
*
|
|
29
|
+
* <p>
|
|
30
|
+
* <b>This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.</b>
|
|
31
|
+
* </p>
|
|
32
|
+
* <p>Adds remote locations to an EC2 or container fleet and begins populating the new
|
|
33
|
+
* locations with instances. The new instances conform to the fleet's instance type,
|
|
34
|
+
* auto-scaling, and other configuration settings.</p>
|
|
32
35
|
* <note>
|
|
33
|
-
* <p>
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
+
* <p>You can't add remote locations to a fleet that resides in an Amazon Web Services Region that
|
|
37
|
+
* doesn't support multiple locations. Fleets created prior to March 2021 can't support
|
|
38
|
+
* multiple locations.</p>
|
|
36
39
|
* </note>
|
|
37
40
|
* <p>To add fleet locations, specify the fleet to be updated and provide a list of one or
|
|
38
41
|
* more locations. </p>
|
|
@@ -111,6 +114,11 @@ declare const CreateFleetLocationsCommand_base: {
|
|
|
111
114
|
* @throws {@link NotFoundException} (client fault)
|
|
112
115
|
* <p>THe requested resources was not found. The resource was either not created yet or deleted.</p>
|
|
113
116
|
*
|
|
117
|
+
* @throws {@link NotReadyException} (client fault)
|
|
118
|
+
* <p> The operation failed because Amazon GameLift has not yet finished validating this compute. We
|
|
119
|
+
* recommend attempting 8 to 10 retries over 3 to 5 minutes with <a href="http://aws.amazon.com/blogs/https:/aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/">exponential
|
|
120
|
+
* backoffs and jitter</a>. </p>
|
|
121
|
+
*
|
|
114
122
|
* @throws {@link UnauthorizedException} (client fault)
|
|
115
123
|
* <p>The client failed authentication. Clients should not retry such requests.</p>
|
|
116
124
|
*
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { GameLiftClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GameLiftClient";
|
|
4
|
+
import { DeleteContainerGroupDefinitionInput } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export { __MetadataBearer, $Command };
|
|
9
|
+
/**
|
|
10
|
+
* @public
|
|
11
|
+
*
|
|
12
|
+
* The input for {@link DeleteContainerGroupDefinitionCommand}.
|
|
13
|
+
*/
|
|
14
|
+
export interface DeleteContainerGroupDefinitionCommandInput extends DeleteContainerGroupDefinitionInput {
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* @public
|
|
18
|
+
*
|
|
19
|
+
* The output of {@link DeleteContainerGroupDefinitionCommand}.
|
|
20
|
+
*/
|
|
21
|
+
export interface DeleteContainerGroupDefinitionCommandOutput extends __MetadataBearer {
|
|
22
|
+
}
|
|
23
|
+
declare const DeleteContainerGroupDefinitionCommand_base: {
|
|
24
|
+
new (input: DeleteContainerGroupDefinitionCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteContainerGroupDefinitionCommandInput, DeleteContainerGroupDefinitionCommandOutput, GameLiftClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: DeleteContainerGroupDefinitionCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteContainerGroupDefinitionCommandInput, DeleteContainerGroupDefinitionCommandOutput, GameLiftClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
|
+
};
|
|
28
|
+
/**
|
|
29
|
+
* <p>
|
|
30
|
+
* <b>This operation is used with the Amazon GameLift containers feature, which is currently in public preview. </b>
|
|
31
|
+
* </p>
|
|
32
|
+
* <p>Deletes a container group definition resource. You can delete a container group definition
|
|
33
|
+
* if there are no fleets using the definition. </p>
|
|
34
|
+
* <p>To delete a container group definition, identify the resource to delete.</p>
|
|
35
|
+
* <p>
|
|
36
|
+
* <b>Learn more</b>
|
|
37
|
+
* </p>
|
|
38
|
+
* <ul>
|
|
39
|
+
* <li>
|
|
40
|
+
* <p>
|
|
41
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-create-groups.html">Manage a container group definition</a>
|
|
42
|
+
* </p>
|
|
43
|
+
* </li>
|
|
44
|
+
* </ul>
|
|
45
|
+
* @example
|
|
46
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
47
|
+
* ```javascript
|
|
48
|
+
* import { GameLiftClient, DeleteContainerGroupDefinitionCommand } from "@aws-sdk/client-gamelift"; // ES Modules import
|
|
49
|
+
* // const { GameLiftClient, DeleteContainerGroupDefinitionCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import
|
|
50
|
+
* const client = new GameLiftClient(config);
|
|
51
|
+
* const input = { // DeleteContainerGroupDefinitionInput
|
|
52
|
+
* Name: "STRING_VALUE", // required
|
|
53
|
+
* };
|
|
54
|
+
* const command = new DeleteContainerGroupDefinitionCommand(input);
|
|
55
|
+
* const response = await client.send(command);
|
|
56
|
+
* // {};
|
|
57
|
+
*
|
|
58
|
+
* ```
|
|
59
|
+
*
|
|
60
|
+
* @param DeleteContainerGroupDefinitionCommandInput - {@link DeleteContainerGroupDefinitionCommandInput}
|
|
61
|
+
* @returns {@link DeleteContainerGroupDefinitionCommandOutput}
|
|
62
|
+
* @see {@link DeleteContainerGroupDefinitionCommandInput} for command's `input` shape.
|
|
63
|
+
* @see {@link DeleteContainerGroupDefinitionCommandOutput} for command's `response` shape.
|
|
64
|
+
* @see {@link GameLiftClientResolvedConfig | config} for GameLiftClient's `config` shape.
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link InternalServiceException} (server fault)
|
|
67
|
+
* <p>The service encountered an unrecoverable internal failure while processing the
|
|
68
|
+
* request. Clients can retry such requests immediately or after a waiting period.</p>
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
71
|
+
* <p>One or more parameter values in the request are invalid. Correct the invalid parameter
|
|
72
|
+
* values before retrying.</p>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link NotFoundException} (client fault)
|
|
75
|
+
* <p>THe requested resources was not found. The resource was either not created yet or deleted.</p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link TaggingFailedException} (client fault)
|
|
78
|
+
* <p>The requested tagging operation did not succeed. This may be due to invalid tag format
|
|
79
|
+
* or the maximum tag limit may have been exceeded. Resolve the issue before
|
|
80
|
+
* retrying.</p>
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link UnauthorizedException} (client fault)
|
|
83
|
+
* <p>The client failed authentication. Clients should not retry such requests.</p>
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link UnsupportedRegionException} (client fault)
|
|
86
|
+
* <p>The requested operation is not supported in the Region specified.</p>
|
|
87
|
+
*
|
|
88
|
+
* @throws {@link GameLiftServiceException}
|
|
89
|
+
* <p>Base exception class for all service exceptions from GameLift service.</p>
|
|
90
|
+
*
|
|
91
|
+
* @public
|
|
92
|
+
*/
|
|
93
|
+
export declare class DeleteContainerGroupDefinitionCommand extends DeleteContainerGroupDefinitionCommand_base {
|
|
94
|
+
}
|