@aws-sdk/client-lightsail 3.934.0 → 3.935.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/dist-cjs/index.js +643 -643
- package/dist-es/index.js +2 -1
- package/dist-es/models/enums.js +639 -0
- package/dist-es/models/errors.js +145 -0
- package/dist-es/models/models_0.js +1 -617
- package/dist-es/models/models_1.js +1 -167
- package/dist-es/schemas/schemas_0.js +1 -1
- package/dist-types/commands/GetContainerServiceMetricDataCommand.d.ts +1 -1
- package/dist-types/commands/GetContainerServicePowersCommand.d.ts +1 -1
- package/dist-types/commands/GetContainerServicesCommand.d.ts +1 -2
- package/dist-types/commands/GetCostEstimateCommand.d.ts +1 -1
- package/dist-types/commands/GetDiskCommand.d.ts +1 -1
- package/dist-types/commands/GetDiskSnapshotCommand.d.ts +1 -1
- package/dist-types/commands/GetDiskSnapshotsCommand.d.ts +1 -1
- package/dist-types/commands/GetDisksCommand.d.ts +1 -1
- package/dist-types/commands/GetDistributionBundlesCommand.d.ts +1 -1
- package/dist-types/commands/GetDistributionLatestCacheResetCommand.d.ts +1 -1
- package/dist-types/commands/GetDistributionMetricDataCommand.d.ts +1 -1
- package/dist-types/commands/GetDistributionsCommand.d.ts +1 -1
- package/dist-types/commands/GetDomainCommand.d.ts +1 -1
- package/dist-types/commands/GetDomainsCommand.d.ts +1 -1
- package/dist-types/commands/GetExportSnapshotRecordsCommand.d.ts +1 -1
- package/dist-types/commands/GetInstanceAccessDetailsCommand.d.ts +1 -1
- package/dist-types/commands/GetInstanceCommand.d.ts +1 -1
- package/dist-types/commands/GetInstanceMetricDataCommand.d.ts +1 -1
- package/dist-types/commands/GetInstancePortStatesCommand.d.ts +1 -1
- package/dist-types/commands/GetInstanceSnapshotCommand.d.ts +1 -1
- package/dist-types/commands/GetInstanceSnapshotsCommand.d.ts +1 -1
- package/dist-types/commands/GetInstanceStateCommand.d.ts +1 -1
- package/dist-types/commands/GetInstancesCommand.d.ts +1 -1
- package/dist-types/commands/GetKeyPairCommand.d.ts +1 -1
- package/dist-types/commands/GetKeyPairsCommand.d.ts +1 -1
- package/dist-types/commands/GetLoadBalancerCommand.d.ts +2 -1
- package/dist-types/index.d.ts +4 -1
- package/dist-types/models/enums.d.ts +1287 -0
- package/dist-types/models/errors.d.ts +143 -0
- package/dist-types/models/models_0.d.ts +1969 -1055
- package/dist-types/models/models_1.d.ts +2 -2344
- package/dist-types/ts3.4/commands/GetContainerServiceMetricDataCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetContainerServicePowersCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetContainerServicesCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/GetCostEstimateCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetDiskCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetDiskSnapshotCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetDiskSnapshotsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetDisksCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetDistributionBundlesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetDistributionLatestCacheResetCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetDistributionMetricDataCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetDistributionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetDomainCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetDomainsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetExportSnapshotRecordsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetInstanceAccessDetailsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetInstanceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetInstanceMetricDataCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetInstancePortStatesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetInstanceSnapshotCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetInstanceSnapshotsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetInstanceStateCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetInstancesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetKeyPairCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetKeyPairsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetLoadBalancerCommand.d.ts +2 -4
- package/dist-types/ts3.4/index.d.ts +4 -1
- package/dist-types/ts3.4/models/enums.d.ts +776 -0
- package/dist-types/ts3.4/models/errors.d.ts +81 -0
- package/dist-types/ts3.4/models/models_0.d.ts +363 -642
- package/dist-types/ts3.4/models/models_1.d.ts +36 -542
- package/package.json +12 -12
- package/dist-es/models/index.js +0 -2
- package/dist-types/models/index.d.ts +0 -2
- package/dist-types/ts3.4/models/index.d.ts +0 -2
|
@@ -1,2140 +1,5 @@
|
|
|
1
|
-
import {
|
|
2
|
-
|
|
3
|
-
* @public
|
|
4
|
-
*/
|
|
5
|
-
export interface GetContainerServiceMetricDataRequest {
|
|
6
|
-
/**
|
|
7
|
-
* <p>The name of the container service for which to get metric data.</p>
|
|
8
|
-
* @public
|
|
9
|
-
*/
|
|
10
|
-
serviceName: string | undefined;
|
|
11
|
-
/**
|
|
12
|
-
* <p>The metric for which you want to return information.</p>
|
|
13
|
-
* <p>Valid container service metric names are listed below, along with the most useful
|
|
14
|
-
* statistics to include in your request, and the published unit value.</p>
|
|
15
|
-
* <ul>
|
|
16
|
-
* <li>
|
|
17
|
-
* <p>
|
|
18
|
-
* <code>CPUUtilization</code> - The average percentage of compute units that are
|
|
19
|
-
* currently in use across all nodes of the container service. This metric identifies the
|
|
20
|
-
* processing power required to run containers on each node of the container service.</p>
|
|
21
|
-
* <p>Statistics: The most useful statistics are <code>Maximum</code> and
|
|
22
|
-
* <code>Average</code>.</p>
|
|
23
|
-
* <p>Unit: The published unit is <code>Percent</code>.</p>
|
|
24
|
-
* </li>
|
|
25
|
-
* <li>
|
|
26
|
-
* <p>
|
|
27
|
-
* <code>MemoryUtilization</code> - The average percentage of available memory that is
|
|
28
|
-
* currently in use across all nodes of the container service. This metric identifies the
|
|
29
|
-
* memory required to run containers on each node of the container service.</p>
|
|
30
|
-
* <p>Statistics: The most useful statistics are <code>Maximum</code> and
|
|
31
|
-
* <code>Average</code>.</p>
|
|
32
|
-
* <p>Unit: The published unit is <code>Percent</code>.</p>
|
|
33
|
-
* </li>
|
|
34
|
-
* </ul>
|
|
35
|
-
* @public
|
|
36
|
-
*/
|
|
37
|
-
metricName: ContainerServiceMetricName | undefined;
|
|
38
|
-
/**
|
|
39
|
-
* <p>The start time of the time period.</p>
|
|
40
|
-
* @public
|
|
41
|
-
*/
|
|
42
|
-
startTime: Date | undefined;
|
|
43
|
-
/**
|
|
44
|
-
* <p>The end time of the time period.</p>
|
|
45
|
-
* @public
|
|
46
|
-
*/
|
|
47
|
-
endTime: Date | undefined;
|
|
48
|
-
/**
|
|
49
|
-
* <p>The granularity, in seconds, of the returned data points.</p>
|
|
50
|
-
* <p>All container service metric data is available in 5-minute (300 seconds)
|
|
51
|
-
* granularity.</p>
|
|
52
|
-
* @public
|
|
53
|
-
*/
|
|
54
|
-
period: number | undefined;
|
|
55
|
-
/**
|
|
56
|
-
* <p>The statistic for the metric.</p>
|
|
57
|
-
* <p>The following statistics are available:</p>
|
|
58
|
-
* <ul>
|
|
59
|
-
* <li>
|
|
60
|
-
* <p>
|
|
61
|
-
* <code>Minimum</code> - The lowest value observed during the specified period. Use this
|
|
62
|
-
* value to determine low volumes of activity for your application.</p>
|
|
63
|
-
* </li>
|
|
64
|
-
* <li>
|
|
65
|
-
* <p>
|
|
66
|
-
* <code>Maximum</code> - The highest value observed during the specified period. Use
|
|
67
|
-
* this value to determine high volumes of activity for your application.</p>
|
|
68
|
-
* </li>
|
|
69
|
-
* <li>
|
|
70
|
-
* <p>
|
|
71
|
-
* <code>Sum</code> - All values submitted for the matching metric added together. You
|
|
72
|
-
* can use this statistic to determine the total volume of a metric.</p>
|
|
73
|
-
* </li>
|
|
74
|
-
* <li>
|
|
75
|
-
* <p>
|
|
76
|
-
* <code>Average</code> - The value of <code>Sum</code> / <code>SampleCount</code> during
|
|
77
|
-
* the specified period. By comparing this statistic with the <code>Minimum</code> and
|
|
78
|
-
* <code>Maximum</code> values, you can determine the full scope of a metric and how close
|
|
79
|
-
* the average use is to the <code>Minimum</code> and <code>Maximum</code> values. This
|
|
80
|
-
* comparison helps you to know when to increase or decrease your resources.</p>
|
|
81
|
-
* </li>
|
|
82
|
-
* <li>
|
|
83
|
-
* <p>
|
|
84
|
-
* <code>SampleCount</code> - The count, or number, of data points used for the
|
|
85
|
-
* statistical calculation.</p>
|
|
86
|
-
* </li>
|
|
87
|
-
* </ul>
|
|
88
|
-
* @public
|
|
89
|
-
*/
|
|
90
|
-
statistics: MetricStatistic[] | undefined;
|
|
91
|
-
}
|
|
92
|
-
/**
|
|
93
|
-
* @public
|
|
94
|
-
*/
|
|
95
|
-
export interface GetContainerServiceMetricDataResult {
|
|
96
|
-
/**
|
|
97
|
-
* <p>The name of the metric returned. </p>
|
|
98
|
-
* @public
|
|
99
|
-
*/
|
|
100
|
-
metricName?: ContainerServiceMetricName | undefined;
|
|
101
|
-
/**
|
|
102
|
-
* <p>An array of objects that describe the metric data returned.</p>
|
|
103
|
-
* @public
|
|
104
|
-
*/
|
|
105
|
-
metricData?: MetricDatapoint[] | undefined;
|
|
106
|
-
}
|
|
107
|
-
/**
|
|
108
|
-
* @public
|
|
109
|
-
*/
|
|
110
|
-
export interface GetContainerServicePowersRequest {
|
|
111
|
-
}
|
|
112
|
-
/**
|
|
113
|
-
* @public
|
|
114
|
-
*/
|
|
115
|
-
export interface GetContainerServicePowersResult {
|
|
116
|
-
/**
|
|
117
|
-
* <p>An array of objects that describe the powers that can be specified for a container
|
|
118
|
-
* service.</p>
|
|
119
|
-
* @public
|
|
120
|
-
*/
|
|
121
|
-
powers?: ContainerServicePower[] | undefined;
|
|
122
|
-
}
|
|
123
|
-
/**
|
|
124
|
-
* @public
|
|
125
|
-
*/
|
|
126
|
-
export interface GetContainerServicesRequest {
|
|
127
|
-
/**
|
|
128
|
-
* <p>The name of the container service for which to return information.</p>
|
|
129
|
-
* <p>When omitted, the response includes all of your container services in the Amazon Web Services Region where the request is made.</p>
|
|
130
|
-
* @public
|
|
131
|
-
*/
|
|
132
|
-
serviceName?: string | undefined;
|
|
133
|
-
}
|
|
134
|
-
/**
|
|
135
|
-
* @public
|
|
136
|
-
*/
|
|
137
|
-
export interface GetCostEstimateRequest {
|
|
138
|
-
/**
|
|
139
|
-
* <p>The resource name.</p>
|
|
140
|
-
* @public
|
|
141
|
-
*/
|
|
142
|
-
resourceName: string | undefined;
|
|
143
|
-
/**
|
|
144
|
-
* <p>The cost estimate start time.</p>
|
|
145
|
-
* <p>Constraints:</p>
|
|
146
|
-
* <ul>
|
|
147
|
-
* <li>
|
|
148
|
-
* <p>Specified in Coordinated Universal Time (UTC).</p>
|
|
149
|
-
* </li>
|
|
150
|
-
* <li>
|
|
151
|
-
* <p>Specified in the Unix time format.</p>
|
|
152
|
-
* <p>For example, if you want to use a start time of October 1, 2018, at 8 PM UTC, specify
|
|
153
|
-
* <code>1538424000</code> as the start time.</p>
|
|
154
|
-
* </li>
|
|
155
|
-
* </ul>
|
|
156
|
-
* <p>You can convert a human-friendly time to Unix time format using a converter like <a href="https://www.epochconverter.com/">Epoch converter</a>.</p>
|
|
157
|
-
* @public
|
|
158
|
-
*/
|
|
159
|
-
startTime: Date | undefined;
|
|
160
|
-
/**
|
|
161
|
-
* <p>The cost estimate end time.</p>
|
|
162
|
-
* <p>Constraints:</p>
|
|
163
|
-
* <ul>
|
|
164
|
-
* <li>
|
|
165
|
-
* <p>Specified in Coordinated Universal Time (UTC).</p>
|
|
166
|
-
* </li>
|
|
167
|
-
* <li>
|
|
168
|
-
* <p>Specified in the Unix time format.</p>
|
|
169
|
-
* <p>For example, if you want to use an end time of October 1, 2018, at 9 PM UTC, specify
|
|
170
|
-
* <code>1538427600</code> as the end time.</p>
|
|
171
|
-
* </li>
|
|
172
|
-
* </ul>
|
|
173
|
-
* <p>You can convert a human-friendly time to Unix time format using a converter like <a href="https://www.epochconverter.com/">Epoch converter</a>.</p>
|
|
174
|
-
* @public
|
|
175
|
-
*/
|
|
176
|
-
endTime: Date | undefined;
|
|
177
|
-
}
|
|
178
|
-
/**
|
|
179
|
-
* <p>Describes the estimated cost or usage that a budget tracks.</p>
|
|
180
|
-
* @public
|
|
181
|
-
*/
|
|
182
|
-
export interface ResourceBudgetEstimate {
|
|
183
|
-
/**
|
|
184
|
-
* <p>The resource name.</p>
|
|
185
|
-
* @public
|
|
186
|
-
*/
|
|
187
|
-
resourceName?: string | undefined;
|
|
188
|
-
/**
|
|
189
|
-
* <p>The type of resource the budget will track.</p>
|
|
190
|
-
* @public
|
|
191
|
-
*/
|
|
192
|
-
resourceType?: ResourceType | undefined;
|
|
193
|
-
/**
|
|
194
|
-
* <p>The cost estimate for the specified budget.</p>
|
|
195
|
-
* @public
|
|
196
|
-
*/
|
|
197
|
-
costEstimates?: CostEstimate[] | undefined;
|
|
198
|
-
/**
|
|
199
|
-
* <p>The estimate start time.</p>
|
|
200
|
-
* @public
|
|
201
|
-
*/
|
|
202
|
-
startTime?: Date | undefined;
|
|
203
|
-
/**
|
|
204
|
-
* <p>The estimate end time.</p>
|
|
205
|
-
* @public
|
|
206
|
-
*/
|
|
207
|
-
endTime?: Date | undefined;
|
|
208
|
-
}
|
|
209
|
-
/**
|
|
210
|
-
* @public
|
|
211
|
-
*/
|
|
212
|
-
export interface GetCostEstimateResult {
|
|
213
|
-
/**
|
|
214
|
-
* <p>Returns the estimate's forecasted cost or usage.</p>
|
|
215
|
-
* @public
|
|
216
|
-
*/
|
|
217
|
-
resourcesBudgetEstimate?: ResourceBudgetEstimate[] | undefined;
|
|
218
|
-
}
|
|
219
|
-
/**
|
|
220
|
-
* @public
|
|
221
|
-
*/
|
|
222
|
-
export interface GetDiskRequest {
|
|
223
|
-
/**
|
|
224
|
-
* <p>The name of the disk (<code>my-disk</code>).</p>
|
|
225
|
-
* @public
|
|
226
|
-
*/
|
|
227
|
-
diskName: string | undefined;
|
|
228
|
-
}
|
|
229
|
-
/**
|
|
230
|
-
* @public
|
|
231
|
-
*/
|
|
232
|
-
export interface GetDiskResult {
|
|
233
|
-
/**
|
|
234
|
-
* <p>An object containing information about the disk.</p>
|
|
235
|
-
* @public
|
|
236
|
-
*/
|
|
237
|
-
disk?: Disk | undefined;
|
|
238
|
-
}
|
|
239
|
-
/**
|
|
240
|
-
* @public
|
|
241
|
-
*/
|
|
242
|
-
export interface GetDisksRequest {
|
|
243
|
-
/**
|
|
244
|
-
* <p>The token to advance to the next page of results from your request.</p>
|
|
245
|
-
* <p>To get a page token, perform an initial <code>GetDisks</code> request. If your results are
|
|
246
|
-
* paginated, the response will return a next page token that you can specify as the page token
|
|
247
|
-
* in a subsequent request.</p>
|
|
248
|
-
* @public
|
|
249
|
-
*/
|
|
250
|
-
pageToken?: string | undefined;
|
|
251
|
-
}
|
|
252
|
-
/**
|
|
253
|
-
* @public
|
|
254
|
-
*/
|
|
255
|
-
export interface GetDisksResult {
|
|
256
|
-
/**
|
|
257
|
-
* <p>An array of objects containing information about all block storage disks.</p>
|
|
258
|
-
* @public
|
|
259
|
-
*/
|
|
260
|
-
disks?: Disk[] | undefined;
|
|
261
|
-
/**
|
|
262
|
-
* <p>The token to advance to the next page of results from your request.</p>
|
|
263
|
-
* <p>A next page token is not returned if there are no more results to display.</p>
|
|
264
|
-
* <p>To get the next page of results, perform another <code>GetDisks</code> request and specify
|
|
265
|
-
* the next page token using the <code>pageToken</code> parameter.</p>
|
|
266
|
-
* @public
|
|
267
|
-
*/
|
|
268
|
-
nextPageToken?: string | undefined;
|
|
269
|
-
}
|
|
270
|
-
/**
|
|
271
|
-
* @public
|
|
272
|
-
*/
|
|
273
|
-
export interface GetDiskSnapshotRequest {
|
|
274
|
-
/**
|
|
275
|
-
* <p>The name of the disk snapshot (<code>my-disk-snapshot</code>).</p>
|
|
276
|
-
* @public
|
|
277
|
-
*/
|
|
278
|
-
diskSnapshotName: string | undefined;
|
|
279
|
-
}
|
|
280
|
-
/**
|
|
281
|
-
* @public
|
|
282
|
-
*/
|
|
283
|
-
export interface GetDiskSnapshotResult {
|
|
284
|
-
/**
|
|
285
|
-
* <p>An object containing information about the disk snapshot.</p>
|
|
286
|
-
* @public
|
|
287
|
-
*/
|
|
288
|
-
diskSnapshot?: DiskSnapshot | undefined;
|
|
289
|
-
}
|
|
290
|
-
/**
|
|
291
|
-
* @public
|
|
292
|
-
*/
|
|
293
|
-
export interface GetDiskSnapshotsRequest {
|
|
294
|
-
/**
|
|
295
|
-
* <p>The token to advance to the next page of results from your request.</p>
|
|
296
|
-
* <p>To get a page token, perform an initial <code>GetDiskSnapshots</code> request. If your
|
|
297
|
-
* results are paginated, the response will return a next page token that you can specify as the
|
|
298
|
-
* page token in a subsequent request.</p>
|
|
299
|
-
* @public
|
|
300
|
-
*/
|
|
301
|
-
pageToken?: string | undefined;
|
|
302
|
-
}
|
|
303
|
-
/**
|
|
304
|
-
* @public
|
|
305
|
-
*/
|
|
306
|
-
export interface GetDiskSnapshotsResult {
|
|
307
|
-
/**
|
|
308
|
-
* <p>An array of objects containing information about all block storage disk snapshots.</p>
|
|
309
|
-
* @public
|
|
310
|
-
*/
|
|
311
|
-
diskSnapshots?: DiskSnapshot[] | undefined;
|
|
312
|
-
/**
|
|
313
|
-
* <p>The token to advance to the next page of results from your request.</p>
|
|
314
|
-
* <p>A next page token is not returned if there are no more results to display.</p>
|
|
315
|
-
* <p>To get the next page of results, perform another <code>GetDiskSnapshots</code> request and
|
|
316
|
-
* specify the next page token using the <code>pageToken</code> parameter.</p>
|
|
317
|
-
* @public
|
|
318
|
-
*/
|
|
319
|
-
nextPageToken?: string | undefined;
|
|
320
|
-
}
|
|
321
|
-
/**
|
|
322
|
-
* @public
|
|
323
|
-
*/
|
|
324
|
-
export interface GetDistributionBundlesRequest {
|
|
325
|
-
}
|
|
326
|
-
/**
|
|
327
|
-
* @public
|
|
328
|
-
*/
|
|
329
|
-
export interface GetDistributionBundlesResult {
|
|
330
|
-
/**
|
|
331
|
-
* <p>An object that describes a distribution bundle.</p>
|
|
332
|
-
* @public
|
|
333
|
-
*/
|
|
334
|
-
bundles?: DistributionBundle[] | undefined;
|
|
335
|
-
}
|
|
336
|
-
/**
|
|
337
|
-
* @public
|
|
338
|
-
*/
|
|
339
|
-
export interface GetDistributionLatestCacheResetRequest {
|
|
340
|
-
/**
|
|
341
|
-
* <p>The name of the distribution for which to return the timestamp of the last cache
|
|
342
|
-
* reset.</p>
|
|
343
|
-
* <p>Use the <code>GetDistributions</code> action to get a list of distribution names that you
|
|
344
|
-
* can specify.</p>
|
|
345
|
-
* <p>When omitted, the response includes the latest cache reset timestamp of all your
|
|
346
|
-
* distributions.</p>
|
|
347
|
-
* @public
|
|
348
|
-
*/
|
|
349
|
-
distributionName?: string | undefined;
|
|
350
|
-
}
|
|
351
|
-
/**
|
|
352
|
-
* @public
|
|
353
|
-
*/
|
|
354
|
-
export interface GetDistributionLatestCacheResetResult {
|
|
355
|
-
/**
|
|
356
|
-
* <p>The status of the last cache reset.</p>
|
|
357
|
-
* @public
|
|
358
|
-
*/
|
|
359
|
-
status?: string | undefined;
|
|
360
|
-
/**
|
|
361
|
-
* <p>The timestamp of the last cache reset (<code>1479734909.17</code>) in Unix time
|
|
362
|
-
* format.</p>
|
|
363
|
-
* @public
|
|
364
|
-
*/
|
|
365
|
-
createTime?: Date | undefined;
|
|
366
|
-
}
|
|
367
|
-
/**
|
|
368
|
-
* @public
|
|
369
|
-
*/
|
|
370
|
-
export interface GetDistributionMetricDataRequest {
|
|
371
|
-
/**
|
|
372
|
-
* <p>The name of the distribution for which to get metric data.</p>
|
|
373
|
-
* <p>Use the <code>GetDistributions</code> action to get a list of distribution names that you
|
|
374
|
-
* can specify.</p>
|
|
375
|
-
* @public
|
|
376
|
-
*/
|
|
377
|
-
distributionName: string | undefined;
|
|
378
|
-
/**
|
|
379
|
-
* <p>The metric for which you want to return information.</p>
|
|
380
|
-
* <p>Valid distribution metric names are listed below, along with the most useful
|
|
381
|
-
* <code>statistics</code> to include in your request, and the published <code>unit</code>
|
|
382
|
-
* value.</p>
|
|
383
|
-
* <ul>
|
|
384
|
-
* <li>
|
|
385
|
-
* <p>
|
|
386
|
-
* <b>
|
|
387
|
-
* <code>Requests</code>
|
|
388
|
-
* </b> - The total number of viewer
|
|
389
|
-
* requests received by your Lightsail distribution, for all HTTP methods, and for both
|
|
390
|
-
* HTTP and HTTPS requests.</p>
|
|
391
|
-
* <p>
|
|
392
|
-
* <code>Statistics</code>: The most useful statistic is <code>Sum</code>.</p>
|
|
393
|
-
* <p>
|
|
394
|
-
* <code>Unit</code>: The published unit is <code>None</code>.</p>
|
|
395
|
-
* </li>
|
|
396
|
-
* <li>
|
|
397
|
-
* <p>
|
|
398
|
-
* <b>
|
|
399
|
-
* <code>BytesDownloaded</code>
|
|
400
|
-
* </b> - The number of bytes
|
|
401
|
-
* downloaded by viewers for GET, HEAD, and OPTIONS requests.</p>
|
|
402
|
-
* <p>
|
|
403
|
-
* <code>Statistics</code>: The most useful statistic is <code>Sum</code>.</p>
|
|
404
|
-
* <p>
|
|
405
|
-
* <code>Unit</code>: The published unit is <code>None</code>.</p>
|
|
406
|
-
* </li>
|
|
407
|
-
* <li>
|
|
408
|
-
* <p>
|
|
409
|
-
* <b>
|
|
410
|
-
* <code>BytesUploaded </code>
|
|
411
|
-
* </b> - The number of bytes
|
|
412
|
-
* uploaded to your origin by your Lightsail distribution, using POST and PUT
|
|
413
|
-
* requests.</p>
|
|
414
|
-
* <p>
|
|
415
|
-
* <code>Statistics</code>: The most useful statistic is <code>Sum</code>.</p>
|
|
416
|
-
* <p>
|
|
417
|
-
* <code>Unit</code>: The published unit is <code>None</code>.</p>
|
|
418
|
-
* </li>
|
|
419
|
-
* <li>
|
|
420
|
-
* <p>
|
|
421
|
-
* <b>
|
|
422
|
-
* <code>TotalErrorRate</code>
|
|
423
|
-
* </b> - The percentage of all
|
|
424
|
-
* viewer requests for which the response's HTTP status code was 4xx or 5xx.</p>
|
|
425
|
-
* <p>
|
|
426
|
-
* <code>Statistics</code>: The most useful statistic is <code>Average</code>.</p>
|
|
427
|
-
* <p>
|
|
428
|
-
* <code>Unit</code>: The published unit is <code>Percent</code>.</p>
|
|
429
|
-
* </li>
|
|
430
|
-
* <li>
|
|
431
|
-
* <p>
|
|
432
|
-
* <b>
|
|
433
|
-
* <code>4xxErrorRate</code>
|
|
434
|
-
* </b> - The percentage of all
|
|
435
|
-
* viewer requests for which the response's HTTP status cod was 4xx. In these cases, the
|
|
436
|
-
* client or client viewer may have made an error. For example, a status code of 404 (Not
|
|
437
|
-
* Found) means that the client requested an object that could not be found.</p>
|
|
438
|
-
* <p>
|
|
439
|
-
* <code>Statistics</code>: The most useful statistic is <code>Average</code>.</p>
|
|
440
|
-
* <p>
|
|
441
|
-
* <code>Unit</code>: The published unit is <code>Percent</code>.</p>
|
|
442
|
-
* </li>
|
|
443
|
-
* <li>
|
|
444
|
-
* <p>
|
|
445
|
-
* <b>
|
|
446
|
-
* <code>5xxErrorRate</code>
|
|
447
|
-
* </b> - The percentage of all
|
|
448
|
-
* viewer requests for which the response's HTTP status code was 5xx. In these cases, the
|
|
449
|
-
* origin server did not satisfy the requests. For example, a status code of 503 (Service
|
|
450
|
-
* Unavailable) means that the origin server is currently unavailable.</p>
|
|
451
|
-
* <p>
|
|
452
|
-
* <code>Statistics</code>: The most useful statistic is <code>Average</code>.</p>
|
|
453
|
-
* <p>
|
|
454
|
-
* <code>Unit</code>: The published unit is <code>Percent</code>.</p>
|
|
455
|
-
* </li>
|
|
456
|
-
* </ul>
|
|
457
|
-
* @public
|
|
458
|
-
*/
|
|
459
|
-
metricName: DistributionMetricName | undefined;
|
|
460
|
-
/**
|
|
461
|
-
* <p>The start of the time interval for which to get metric data.</p>
|
|
462
|
-
* <p>Constraints:</p>
|
|
463
|
-
* <ul>
|
|
464
|
-
* <li>
|
|
465
|
-
* <p>Specified in Coordinated Universal Time (UTC).</p>
|
|
466
|
-
* </li>
|
|
467
|
-
* <li>
|
|
468
|
-
* <p>Specified in the Unix time format.</p>
|
|
469
|
-
* <p>For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, specify
|
|
470
|
-
* <code>1538424000</code> as the start time.</p>
|
|
471
|
-
* </li>
|
|
472
|
-
* </ul>
|
|
473
|
-
* <p>You can convert a human-friendly time to Unix time format using a converter like <a href="https://www.epochconverter.com/">Epoch converter</a>.</p>
|
|
474
|
-
* @public
|
|
475
|
-
*/
|
|
476
|
-
startTime: Date | undefined;
|
|
477
|
-
/**
|
|
478
|
-
* <p>The end of the time interval for which to get metric data.</p>
|
|
479
|
-
* <p>Constraints:</p>
|
|
480
|
-
* <ul>
|
|
481
|
-
* <li>
|
|
482
|
-
* <p>Specified in Coordinated Universal Time (UTC).</p>
|
|
483
|
-
* </li>
|
|
484
|
-
* <li>
|
|
485
|
-
* <p>Specified in the Unix time format.</p>
|
|
486
|
-
* <p>For example, if you wish to use an end time of October 1, 2018, at 9 PM UTC, specify
|
|
487
|
-
* <code>1538427600</code> as the end time.</p>
|
|
488
|
-
* </li>
|
|
489
|
-
* </ul>
|
|
490
|
-
* <p>You can convert a human-friendly time to Unix time format using a converter like <a href="https://www.epochconverter.com/">Epoch converter</a>.</p>
|
|
491
|
-
* @public
|
|
492
|
-
*/
|
|
493
|
-
endTime: Date | undefined;
|
|
494
|
-
/**
|
|
495
|
-
* <p>The granularity, in seconds, for the metric data points that will be returned.</p>
|
|
496
|
-
* @public
|
|
497
|
-
*/
|
|
498
|
-
period: number | undefined;
|
|
499
|
-
/**
|
|
500
|
-
* <p>The unit for the metric data request.</p>
|
|
501
|
-
* <p>Valid units depend on the metric data being requested. For the valid units with each
|
|
502
|
-
* available metric, see the <code>metricName</code> parameter.</p>
|
|
503
|
-
* @public
|
|
504
|
-
*/
|
|
505
|
-
unit: MetricUnit | undefined;
|
|
506
|
-
/**
|
|
507
|
-
* <p>The statistic for the metric.</p>
|
|
508
|
-
* <p>The following statistics are available:</p>
|
|
509
|
-
* <ul>
|
|
510
|
-
* <li>
|
|
511
|
-
* <p>
|
|
512
|
-
* <code>Minimum</code> - The lowest value observed during the specified period. Use this
|
|
513
|
-
* value to determine low volumes of activity for your application.</p>
|
|
514
|
-
* </li>
|
|
515
|
-
* <li>
|
|
516
|
-
* <p>
|
|
517
|
-
* <code>Maximum</code> - The highest value observed during the specified period. Use
|
|
518
|
-
* this value to determine high volumes of activity for your application.</p>
|
|
519
|
-
* </li>
|
|
520
|
-
* <li>
|
|
521
|
-
* <p>
|
|
522
|
-
* <code>Sum</code> - All values submitted for the matching metric added together. You
|
|
523
|
-
* can use this statistic to determine the total volume of a metric.</p>
|
|
524
|
-
* </li>
|
|
525
|
-
* <li>
|
|
526
|
-
* <p>
|
|
527
|
-
* <code>Average</code> - The value of Sum / SampleCount during the specified period. By
|
|
528
|
-
* comparing this statistic with the Minimum and Maximum values, you can determine the full
|
|
529
|
-
* scope of a metric and how close the average use is to the Minimum and Maximum values. This
|
|
530
|
-
* comparison helps you to know when to increase or decrease your resources.</p>
|
|
531
|
-
* </li>
|
|
532
|
-
* <li>
|
|
533
|
-
* <p>
|
|
534
|
-
* <code>SampleCount</code> - The count, or number, of data points used for the
|
|
535
|
-
* statistical calculation.</p>
|
|
536
|
-
* </li>
|
|
537
|
-
* </ul>
|
|
538
|
-
* @public
|
|
539
|
-
*/
|
|
540
|
-
statistics: MetricStatistic[] | undefined;
|
|
541
|
-
}
|
|
542
|
-
/**
|
|
543
|
-
* @public
|
|
544
|
-
*/
|
|
545
|
-
export interface GetDistributionMetricDataResult {
|
|
546
|
-
/**
|
|
547
|
-
* <p>The name of the metric returned.</p>
|
|
548
|
-
* @public
|
|
549
|
-
*/
|
|
550
|
-
metricName?: DistributionMetricName | undefined;
|
|
551
|
-
/**
|
|
552
|
-
* <p>An array of objects that describe the metric data returned.</p>
|
|
553
|
-
* @public
|
|
554
|
-
*/
|
|
555
|
-
metricData?: MetricDatapoint[] | undefined;
|
|
556
|
-
}
|
|
557
|
-
/**
|
|
558
|
-
* @public
|
|
559
|
-
*/
|
|
560
|
-
export interface GetDistributionsRequest {
|
|
561
|
-
/**
|
|
562
|
-
* <p>The name of the distribution for which to return information.</p>
|
|
563
|
-
* <p>When omitted, the response includes all of your distributions in the Amazon Web Services
|
|
564
|
-
* Region where the request is made.</p>
|
|
565
|
-
* @public
|
|
566
|
-
*/
|
|
567
|
-
distributionName?: string | undefined;
|
|
568
|
-
/**
|
|
569
|
-
* <p>The token to advance to the next page of results from your request.</p>
|
|
570
|
-
* <p>To get a page token, perform an initial <code>GetDistributions</code> request. If your
|
|
571
|
-
* results are paginated, the response will return a next page token that you can specify as the
|
|
572
|
-
* page token in a subsequent request.</p>
|
|
573
|
-
* @public
|
|
574
|
-
*/
|
|
575
|
-
pageToken?: string | undefined;
|
|
576
|
-
}
|
|
577
|
-
/**
|
|
578
|
-
* @public
|
|
579
|
-
*/
|
|
580
|
-
export interface GetDistributionsResult {
|
|
581
|
-
/**
|
|
582
|
-
* <p>An array of objects that describe your distributions.</p>
|
|
583
|
-
* @public
|
|
584
|
-
*/
|
|
585
|
-
distributions?: LightsailDistribution[] | undefined;
|
|
586
|
-
/**
|
|
587
|
-
* <p>The token to advance to the next page of results from your request.</p>
|
|
588
|
-
* <p>A next page token is not returned if there are no more results to display.</p>
|
|
589
|
-
* <p>To get the next page of results, perform another <code>GetDistributions</code> request and
|
|
590
|
-
* specify the next page token using the <code>pageToken</code> parameter.</p>
|
|
591
|
-
* @public
|
|
592
|
-
*/
|
|
593
|
-
nextPageToken?: string | undefined;
|
|
594
|
-
}
|
|
595
|
-
/**
|
|
596
|
-
* @public
|
|
597
|
-
*/
|
|
598
|
-
export interface GetDomainRequest {
|
|
599
|
-
/**
|
|
600
|
-
* <p>The domain name for which your want to return information about.</p>
|
|
601
|
-
* @public
|
|
602
|
-
*/
|
|
603
|
-
domainName: string | undefined;
|
|
604
|
-
}
|
|
605
|
-
/**
|
|
606
|
-
* @public
|
|
607
|
-
*/
|
|
608
|
-
export interface GetDomainResult {
|
|
609
|
-
/**
|
|
610
|
-
* <p>An array of key-value pairs containing information about your get domain request.</p>
|
|
611
|
-
* @public
|
|
612
|
-
*/
|
|
613
|
-
domain?: Domain | undefined;
|
|
614
|
-
}
|
|
615
|
-
/**
|
|
616
|
-
* @public
|
|
617
|
-
*/
|
|
618
|
-
export interface GetDomainsRequest {
|
|
619
|
-
/**
|
|
620
|
-
* <p>The token to advance to the next page of results from your request.</p>
|
|
621
|
-
* <p>To get a page token, perform an initial <code>GetDomains</code> request. If your results
|
|
622
|
-
* are paginated, the response will return a next page token that you can specify as the page
|
|
623
|
-
* token in a subsequent request.</p>
|
|
624
|
-
* @public
|
|
625
|
-
*/
|
|
626
|
-
pageToken?: string | undefined;
|
|
627
|
-
}
|
|
628
|
-
/**
|
|
629
|
-
* @public
|
|
630
|
-
*/
|
|
631
|
-
export interface GetDomainsResult {
|
|
632
|
-
/**
|
|
633
|
-
* <p>An array of key-value pairs containing information about each of the domain entries in the
|
|
634
|
-
* user's account.</p>
|
|
635
|
-
* @public
|
|
636
|
-
*/
|
|
637
|
-
domains?: Domain[] | undefined;
|
|
638
|
-
/**
|
|
639
|
-
* <p>The token to advance to the next page of results from your request.</p>
|
|
640
|
-
* <p>A next page token is not returned if there are no more results to display.</p>
|
|
641
|
-
* <p>To get the next page of results, perform another <code>GetDomains</code> request and
|
|
642
|
-
* specify the next page token using the <code>pageToken</code> parameter.</p>
|
|
643
|
-
* @public
|
|
644
|
-
*/
|
|
645
|
-
nextPageToken?: string | undefined;
|
|
646
|
-
}
|
|
647
|
-
/**
|
|
648
|
-
* @public
|
|
649
|
-
*/
|
|
650
|
-
export interface GetExportSnapshotRecordsRequest {
|
|
651
|
-
/**
|
|
652
|
-
* <p>The token to advance to the next page of results from your request.</p>
|
|
653
|
-
* <p>To get a page token, perform an initial <code>GetExportSnapshotRecords</code> request. If
|
|
654
|
-
* your results are paginated, the response will return a next page token that you can specify as
|
|
655
|
-
* the page token in a subsequent request.</p>
|
|
656
|
-
* @public
|
|
657
|
-
*/
|
|
658
|
-
pageToken?: string | undefined;
|
|
659
|
-
}
|
|
660
|
-
/**
|
|
661
|
-
* @public
|
|
662
|
-
*/
|
|
663
|
-
export interface GetExportSnapshotRecordsResult {
|
|
664
|
-
/**
|
|
665
|
-
* <p>A list of objects describing the export snapshot records.</p>
|
|
666
|
-
* @public
|
|
667
|
-
*/
|
|
668
|
-
exportSnapshotRecords?: ExportSnapshotRecord[] | undefined;
|
|
669
|
-
/**
|
|
670
|
-
* <p>The token to advance to the next page of results from your request.</p>
|
|
671
|
-
* <p>A next page token is not returned if there are no more results to display.</p>
|
|
672
|
-
* <p>To get the next page of results, perform another <code>GetExportSnapshotRecords</code>
|
|
673
|
-
* request and specify the next page token using the <code>pageToken</code> parameter.</p>
|
|
674
|
-
* @public
|
|
675
|
-
*/
|
|
676
|
-
nextPageToken?: string | undefined;
|
|
677
|
-
}
|
|
678
|
-
/**
|
|
679
|
-
* @public
|
|
680
|
-
*/
|
|
681
|
-
export interface GetInstanceRequest {
|
|
682
|
-
/**
|
|
683
|
-
* <p>The name of the instance.</p>
|
|
684
|
-
* @public
|
|
685
|
-
*/
|
|
686
|
-
instanceName: string | undefined;
|
|
687
|
-
}
|
|
688
|
-
/**
|
|
689
|
-
* <p>Describes the hardware for the instance.</p>
|
|
690
|
-
* @public
|
|
691
|
-
*/
|
|
692
|
-
export interface InstanceHardware {
|
|
693
|
-
/**
|
|
694
|
-
* <p>The number of vCPUs the instance has.</p>
|
|
695
|
-
* @public
|
|
696
|
-
*/
|
|
697
|
-
cpuCount?: number | undefined;
|
|
698
|
-
/**
|
|
699
|
-
* <p>The disks attached to the instance.</p>
|
|
700
|
-
* @public
|
|
701
|
-
*/
|
|
702
|
-
disks?: Disk[] | undefined;
|
|
703
|
-
/**
|
|
704
|
-
* <p>The amount of RAM in GB on the instance (<code>1.0</code>).</p>
|
|
705
|
-
* @public
|
|
706
|
-
*/
|
|
707
|
-
ramSizeInGb?: number | undefined;
|
|
708
|
-
}
|
|
709
|
-
/**
|
|
710
|
-
* @public
|
|
711
|
-
* @enum
|
|
712
|
-
*/
|
|
713
|
-
export declare const HttpEndpoint: {
|
|
714
|
-
readonly disabled: "disabled";
|
|
715
|
-
readonly enabled: "enabled";
|
|
716
|
-
};
|
|
717
|
-
/**
|
|
718
|
-
* @public
|
|
719
|
-
*/
|
|
720
|
-
export type HttpEndpoint = (typeof HttpEndpoint)[keyof typeof HttpEndpoint];
|
|
721
|
-
/**
|
|
722
|
-
* @public
|
|
723
|
-
* @enum
|
|
724
|
-
*/
|
|
725
|
-
export declare const HttpProtocolIpv6: {
|
|
726
|
-
readonly disabled: "disabled";
|
|
727
|
-
readonly enabled: "enabled";
|
|
728
|
-
};
|
|
729
|
-
/**
|
|
730
|
-
* @public
|
|
731
|
-
*/
|
|
732
|
-
export type HttpProtocolIpv6 = (typeof HttpProtocolIpv6)[keyof typeof HttpProtocolIpv6];
|
|
733
|
-
/**
|
|
734
|
-
* @public
|
|
735
|
-
* @enum
|
|
736
|
-
*/
|
|
737
|
-
export declare const HttpTokens: {
|
|
738
|
-
readonly optional: "optional";
|
|
739
|
-
readonly required: "required";
|
|
740
|
-
};
|
|
741
|
-
/**
|
|
742
|
-
* @public
|
|
743
|
-
*/
|
|
744
|
-
export type HttpTokens = (typeof HttpTokens)[keyof typeof HttpTokens];
|
|
745
|
-
/**
|
|
746
|
-
* @public
|
|
747
|
-
* @enum
|
|
748
|
-
*/
|
|
749
|
-
export declare const InstanceMetadataState: {
|
|
750
|
-
readonly applied: "applied";
|
|
751
|
-
readonly pending: "pending";
|
|
752
|
-
};
|
|
753
|
-
/**
|
|
754
|
-
* @public
|
|
755
|
-
*/
|
|
756
|
-
export type InstanceMetadataState = (typeof InstanceMetadataState)[keyof typeof InstanceMetadataState];
|
|
757
|
-
/**
|
|
758
|
-
* <p>The metadata options for the instance.</p>
|
|
759
|
-
* @public
|
|
760
|
-
*/
|
|
761
|
-
export interface InstanceMetadataOptions {
|
|
762
|
-
/**
|
|
763
|
-
* <p>The state of the metadata option changes.</p>
|
|
764
|
-
* <p>The following states are possible:</p>
|
|
765
|
-
* <ul>
|
|
766
|
-
* <li>
|
|
767
|
-
* <p>
|
|
768
|
-
* <code>pending</code> - The metadata options are being updated. The instance is not yet
|
|
769
|
-
* ready to process metadata traffic with the new selection.</p>
|
|
770
|
-
* </li>
|
|
771
|
-
* <li>
|
|
772
|
-
* <p>
|
|
773
|
-
* <code>applied</code> - The metadata options have been successfully applied to the
|
|
774
|
-
* instance.</p>
|
|
775
|
-
* </li>
|
|
776
|
-
* </ul>
|
|
777
|
-
* @public
|
|
778
|
-
*/
|
|
779
|
-
state?: InstanceMetadataState | undefined;
|
|
780
|
-
/**
|
|
781
|
-
* <p>The state of token usage for your instance metadata requests.</p>
|
|
782
|
-
* <p>If the state is <code>optional</code>, you can choose whether to retrieve instance
|
|
783
|
-
* metadata with a signed token header on your request. If you retrieve the IAM role credentials
|
|
784
|
-
* without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role
|
|
785
|
-
* credentials by using a valid signed token, the version 2.0 role credentials are
|
|
786
|
-
* returned.</p>
|
|
787
|
-
* <p>If the state is <code>required</code>, you must send a signed token header with all
|
|
788
|
-
* instance metadata retrieval requests. In this state, retrieving the IAM role credential always
|
|
789
|
-
* returns the version 2.0 credentials. The version 1.0 credentials are not available.</p>
|
|
790
|
-
* <important>
|
|
791
|
-
* <p>Not all instance blueprints in Lightsail support version 2.0 credentials.
|
|
792
|
-
* Use the <code>MetadataNoToken</code> instance metric to track the number of calls to the
|
|
793
|
-
* instance metadata service that are using version 1.0 credentials. For more information, see
|
|
794
|
-
* <a href="https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-viewing-instance-health-metrics">Viewing instance metrics in Amazon Lightsail</a> in the <i>Amazon Lightsail Developer Guide</i>.</p>
|
|
795
|
-
* </important>
|
|
796
|
-
* @public
|
|
797
|
-
*/
|
|
798
|
-
httpTokens?: HttpTokens | undefined;
|
|
799
|
-
/**
|
|
800
|
-
* <p>Indicates whether the HTTP metadata endpoint on your instances is enabled or
|
|
801
|
-
* disabled.</p>
|
|
802
|
-
* <p>If the value is <code>disabled</code>, you cannot access your instance metadata.</p>
|
|
803
|
-
* @public
|
|
804
|
-
*/
|
|
805
|
-
httpEndpoint?: HttpEndpoint | undefined;
|
|
806
|
-
/**
|
|
807
|
-
* <p>The desired HTTP PUT response hop limit for instance metadata requests. A larger number
|
|
808
|
-
* means that the instance metadata requests can travel farther.</p>
|
|
809
|
-
* @public
|
|
810
|
-
*/
|
|
811
|
-
httpPutResponseHopLimit?: number | undefined;
|
|
812
|
-
/**
|
|
813
|
-
* <p>Indicates whether the IPv6 endpoint for the instance metadata service is enabled or
|
|
814
|
-
* disabled.</p>
|
|
815
|
-
* @public
|
|
816
|
-
*/
|
|
817
|
-
httpProtocolIpv6?: HttpProtocolIpv6 | undefined;
|
|
818
|
-
}
|
|
819
|
-
/**
|
|
820
|
-
* <p>Describes the monthly data transfer in and out of your virtual private server (or
|
|
821
|
-
* <i>instance</i>).</p>
|
|
822
|
-
* @public
|
|
823
|
-
*/
|
|
824
|
-
export interface MonthlyTransfer {
|
|
825
|
-
/**
|
|
826
|
-
* <p>The amount allocated per month (in GB).</p>
|
|
827
|
-
* @public
|
|
828
|
-
*/
|
|
829
|
-
gbPerMonthAllocated?: number | undefined;
|
|
830
|
-
}
|
|
831
|
-
/**
|
|
832
|
-
* @public
|
|
833
|
-
* @enum
|
|
834
|
-
*/
|
|
835
|
-
export declare const PortAccessType: {
|
|
836
|
-
readonly Private: "Private";
|
|
837
|
-
readonly Public: "Public";
|
|
838
|
-
};
|
|
839
|
-
/**
|
|
840
|
-
* @public
|
|
841
|
-
*/
|
|
842
|
-
export type PortAccessType = (typeof PortAccessType)[keyof typeof PortAccessType];
|
|
843
|
-
/**
|
|
844
|
-
* <p>Describes information about ports for an Amazon Lightsail instance.</p>
|
|
845
|
-
* @public
|
|
846
|
-
*/
|
|
847
|
-
export interface InstancePortInfo {
|
|
848
|
-
/**
|
|
849
|
-
* <p>The first port in a range of open ports on an instance.</p>
|
|
850
|
-
* <p>Allowed ports:</p>
|
|
851
|
-
* <ul>
|
|
852
|
-
* <li>
|
|
853
|
-
* <p>TCP and UDP - <code>0</code> to <code>65535</code>
|
|
854
|
-
* </p>
|
|
855
|
-
* </li>
|
|
856
|
-
* <li>
|
|
857
|
-
* <p>ICMP - The ICMP type for IPv4 addresses. For example, specify <code>8</code> as the
|
|
858
|
-
* <code>fromPort</code> (ICMP type), and <code>-1</code> as the <code>toPort</code> (ICMP
|
|
859
|
-
* code), to enable ICMP Ping. For more information, see <a href="https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol#Control_messages">Control Messages</a> on <i>Wikipedia</i>.</p>
|
|
860
|
-
* </li>
|
|
861
|
-
* <li>
|
|
862
|
-
* <p>ICMPv6 - The ICMP type for IPv6 addresses. For example, specify <code>128</code> as
|
|
863
|
-
* the <code>fromPort</code> (ICMPv6 type), and <code>0</code> as <code>toPort</code> (ICMPv6
|
|
864
|
-
* code). For more information, see <a href="https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol_for_IPv6">Internet
|
|
865
|
-
* Control Message Protocol for IPv6</a>.</p>
|
|
866
|
-
* </li>
|
|
867
|
-
* </ul>
|
|
868
|
-
* @public
|
|
869
|
-
*/
|
|
870
|
-
fromPort?: number | undefined;
|
|
871
|
-
/**
|
|
872
|
-
* <p>The last port in a range of open ports on an instance.</p>
|
|
873
|
-
* <p>Allowed ports:</p>
|
|
874
|
-
* <ul>
|
|
875
|
-
* <li>
|
|
876
|
-
* <p>TCP and UDP - <code>0</code> to <code>65535</code>
|
|
877
|
-
* </p>
|
|
878
|
-
* </li>
|
|
879
|
-
* <li>
|
|
880
|
-
* <p>ICMP - The ICMP code for IPv4 addresses. For example, specify <code>8</code> as the
|
|
881
|
-
* <code>fromPort</code> (ICMP type), and <code>-1</code> as the <code>toPort</code> (ICMP
|
|
882
|
-
* code), to enable ICMP Ping. For more information, see <a href="https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol#Control_messages">Control Messages</a> on <i>Wikipedia</i>.</p>
|
|
883
|
-
* </li>
|
|
884
|
-
* <li>
|
|
885
|
-
* <p>ICMPv6 - The ICMP code for IPv6 addresses. For example, specify <code>128</code> as
|
|
886
|
-
* the <code>fromPort</code> (ICMPv6 type), and <code>0</code> as <code>toPort</code> (ICMPv6
|
|
887
|
-
* code). For more information, see <a href="https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol_for_IPv6">Internet
|
|
888
|
-
* Control Message Protocol for IPv6</a>.</p>
|
|
889
|
-
* </li>
|
|
890
|
-
* </ul>
|
|
891
|
-
* @public
|
|
892
|
-
*/
|
|
893
|
-
toPort?: number | undefined;
|
|
894
|
-
/**
|
|
895
|
-
* <p>The IP protocol name.</p>
|
|
896
|
-
* <p>The name can be one of the following:</p>
|
|
897
|
-
* <ul>
|
|
898
|
-
* <li>
|
|
899
|
-
* <p>
|
|
900
|
-
* <code>tcp</code> - Transmission Control Protocol (TCP) provides reliable, ordered, and
|
|
901
|
-
* error-checked delivery of streamed data between applications running on hosts
|
|
902
|
-
* communicating by an IP network. If you have an application that doesn't require reliable
|
|
903
|
-
* data stream service, use UDP instead.</p>
|
|
904
|
-
* </li>
|
|
905
|
-
* <li>
|
|
906
|
-
* <p>
|
|
907
|
-
* <code>all</code> - All transport layer protocol types. For more general information,
|
|
908
|
-
* see <a href="https://en.wikipedia.org/wiki/Transport_layer">Transport layer</a> on
|
|
909
|
-
* <i>Wikipedia</i>.</p>
|
|
910
|
-
* </li>
|
|
911
|
-
* <li>
|
|
912
|
-
* <p>
|
|
913
|
-
* <code>udp</code> - With User Datagram Protocol (UDP), computer applications can send
|
|
914
|
-
* messages (or datagrams) to other hosts on an Internet Protocol (IP) network. Prior
|
|
915
|
-
* communications are not required to set up transmission channels or data paths.
|
|
916
|
-
* Applications that don't require reliable data stream service can use UDP, which provides a
|
|
917
|
-
* connectionless datagram service that emphasizes reduced latency over reliability. If you
|
|
918
|
-
* do require reliable data stream service, use TCP instead.</p>
|
|
919
|
-
* </li>
|
|
920
|
-
* <li>
|
|
921
|
-
* <p>
|
|
922
|
-
* <code>icmp</code> - Internet Control Message Protocol (ICMP) is used to send error
|
|
923
|
-
* messages and operational information indicating success or failure when communicating with
|
|
924
|
-
* an instance. For example, an error is indicated when an instance could not be reached.
|
|
925
|
-
* When you specify <code>icmp</code> as the <code>protocol</code>, you must specify the ICMP
|
|
926
|
-
* type using the <code>fromPort</code> parameter, and ICMP code using the
|
|
927
|
-
* <code>toPort</code> parameter.</p>
|
|
928
|
-
* </li>
|
|
929
|
-
* <li>
|
|
930
|
-
* <p>
|
|
931
|
-
* <code>icmp6</code> - Internet Control Message Protocol (ICMP) for IPv6. When you
|
|
932
|
-
* specify <code>icmp6</code> as the <code>protocol</code>, you must specify the ICMP type
|
|
933
|
-
* using the <code>fromPort</code> parameter, and ICMP code using the <code>toPort</code>
|
|
934
|
-
* parameter.</p>
|
|
935
|
-
* </li>
|
|
936
|
-
* </ul>
|
|
937
|
-
* @public
|
|
938
|
-
*/
|
|
939
|
-
protocol?: NetworkProtocol | undefined;
|
|
940
|
-
/**
|
|
941
|
-
* <p>The location from which access is allowed. For example, <code>Anywhere (0.0.0.0/0)</code>,
|
|
942
|
-
* or <code>Custom</code> if a specific IP address or range of IP addresses is allowed.</p>
|
|
943
|
-
* @public
|
|
944
|
-
*/
|
|
945
|
-
accessFrom?: string | undefined;
|
|
946
|
-
/**
|
|
947
|
-
* <p>The type of access (<code>Public</code> or <code>Private</code>).</p>
|
|
948
|
-
* @public
|
|
949
|
-
*/
|
|
950
|
-
accessType?: PortAccessType | undefined;
|
|
951
|
-
/**
|
|
952
|
-
* <p>The common name of the port information.</p>
|
|
953
|
-
* @public
|
|
954
|
-
*/
|
|
955
|
-
commonName?: string | undefined;
|
|
956
|
-
/**
|
|
957
|
-
* <p>The access direction (<code>inbound</code> or <code>outbound</code>).</p>
|
|
958
|
-
* <note>
|
|
959
|
-
* <p>Lightsail currently supports only <code>inbound</code> access direction.</p>
|
|
960
|
-
* </note>
|
|
961
|
-
* @public
|
|
962
|
-
*/
|
|
963
|
-
accessDirection?: AccessDirection | undefined;
|
|
964
|
-
/**
|
|
965
|
-
* <p>The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are allowed to
|
|
966
|
-
* connect to an instance through the ports, and the protocol.</p>
|
|
967
|
-
* <note>
|
|
968
|
-
* <p>The <code>ipv6Cidrs</code> parameter lists the IPv6 addresses that are allowed to
|
|
969
|
-
* connect to an instance.</p>
|
|
970
|
-
* </note>
|
|
971
|
-
* <p>For more information about CIDR block notation, see <a href="https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation">Classless
|
|
972
|
-
* Inter-Domain Routing</a> on <i>Wikipedia</i>.</p>
|
|
973
|
-
* @public
|
|
974
|
-
*/
|
|
975
|
-
cidrs?: string[] | undefined;
|
|
976
|
-
/**
|
|
977
|
-
* <p>The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are allowed to
|
|
978
|
-
* connect to an instance through the ports, and the protocol. Only devices with an IPv6 address
|
|
979
|
-
* can connect to an instance through IPv6; otherwise, IPv4 should be used.</p>
|
|
980
|
-
* <note>
|
|
981
|
-
* <p>The <code>cidrs</code> parameter lists the IPv4 addresses that are allowed to connect to
|
|
982
|
-
* an instance.</p>
|
|
983
|
-
* </note>
|
|
984
|
-
* <p>For more information about CIDR block notation, see <a href="https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation">Classless
|
|
985
|
-
* Inter-Domain Routing</a> on <i>Wikipedia</i>.</p>
|
|
986
|
-
* @public
|
|
987
|
-
*/
|
|
988
|
-
ipv6Cidrs?: string[] | undefined;
|
|
989
|
-
/**
|
|
990
|
-
* <p>An alias that defines access for a preconfigured range of IP addresses.</p>
|
|
991
|
-
* <p>The only alias currently supported is <code>lightsail-connect</code>, which allows IP
|
|
992
|
-
* addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your
|
|
993
|
-
* instance.</p>
|
|
994
|
-
* @public
|
|
995
|
-
*/
|
|
996
|
-
cidrListAliases?: string[] | undefined;
|
|
997
|
-
}
|
|
998
|
-
/**
|
|
999
|
-
* <p>Describes monthly data transfer rates and port information for an instance.</p>
|
|
1000
|
-
* @public
|
|
1001
|
-
*/
|
|
1002
|
-
export interface InstanceNetworking {
|
|
1003
|
-
/**
|
|
1004
|
-
* <p>The amount of data in GB allocated for monthly data transfers.</p>
|
|
1005
|
-
* @public
|
|
1006
|
-
*/
|
|
1007
|
-
monthlyTransfer?: MonthlyTransfer | undefined;
|
|
1008
|
-
/**
|
|
1009
|
-
* <p>An array of key-value pairs containing information about the ports on the instance.</p>
|
|
1010
|
-
* @public
|
|
1011
|
-
*/
|
|
1012
|
-
ports?: InstancePortInfo[] | undefined;
|
|
1013
|
-
}
|
|
1014
|
-
/**
|
|
1015
|
-
* <p>Describes the virtual private server (or <i>instance</i>) status.</p>
|
|
1016
|
-
* @public
|
|
1017
|
-
*/
|
|
1018
|
-
export interface InstanceState {
|
|
1019
|
-
/**
|
|
1020
|
-
* <p>The status code for the instance.</p>
|
|
1021
|
-
* @public
|
|
1022
|
-
*/
|
|
1023
|
-
code?: number | undefined;
|
|
1024
|
-
/**
|
|
1025
|
-
* <p>The state of the instance (<code>running</code> or <code>pending</code>).</p>
|
|
1026
|
-
* @public
|
|
1027
|
-
*/
|
|
1028
|
-
name?: string | undefined;
|
|
1029
|
-
}
|
|
1030
|
-
/**
|
|
1031
|
-
* <p>Describes an instance (a virtual private server).</p>
|
|
1032
|
-
* @public
|
|
1033
|
-
*/
|
|
1034
|
-
export interface Instance {
|
|
1035
|
-
/**
|
|
1036
|
-
* <p>The name the user gave the instance (<code>Amazon_Linux_2023-1</code>).</p>
|
|
1037
|
-
* @public
|
|
1038
|
-
*/
|
|
1039
|
-
name?: string | undefined;
|
|
1040
|
-
/**
|
|
1041
|
-
* <p>The Amazon Resource Name (ARN) of the instance
|
|
1042
|
-
* (<code>arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE</code>).</p>
|
|
1043
|
-
* @public
|
|
1044
|
-
*/
|
|
1045
|
-
arn?: string | undefined;
|
|
1046
|
-
/**
|
|
1047
|
-
* <p>The support code. Include this code in your email to support when you have questions about
|
|
1048
|
-
* an instance or another resource in Lightsail. This code enables our support team to look up
|
|
1049
|
-
* your Lightsail information more easily.</p>
|
|
1050
|
-
* @public
|
|
1051
|
-
*/
|
|
1052
|
-
supportCode?: string | undefined;
|
|
1053
|
-
/**
|
|
1054
|
-
* <p>The timestamp when the instance was created (<code>1479734909.17</code>) in Unix time
|
|
1055
|
-
* format.</p>
|
|
1056
|
-
* @public
|
|
1057
|
-
*/
|
|
1058
|
-
createdAt?: Date | undefined;
|
|
1059
|
-
/**
|
|
1060
|
-
* <p>The region name and Availability Zone where the instance is located.</p>
|
|
1061
|
-
* @public
|
|
1062
|
-
*/
|
|
1063
|
-
location?: ResourceLocation | undefined;
|
|
1064
|
-
/**
|
|
1065
|
-
* <p>The type of resource (usually <code>Instance</code>).</p>
|
|
1066
|
-
* @public
|
|
1067
|
-
*/
|
|
1068
|
-
resourceType?: ResourceType | undefined;
|
|
1069
|
-
/**
|
|
1070
|
-
* <p>The tag keys and optional values for the resource. For more information about tags in
|
|
1071
|
-
* Lightsail, see the <a href="https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-tags">Amazon Lightsail Developer Guide</a>.</p>
|
|
1072
|
-
* @public
|
|
1073
|
-
*/
|
|
1074
|
-
tags?: Tag[] | undefined;
|
|
1075
|
-
/**
|
|
1076
|
-
* <p>The blueprint ID (<code>amazon_linux_2023</code>).</p>
|
|
1077
|
-
* @public
|
|
1078
|
-
*/
|
|
1079
|
-
blueprintId?: string | undefined;
|
|
1080
|
-
/**
|
|
1081
|
-
* <p>The friendly name of the blueprint (<code>Amazon Linux 2023</code>).</p>
|
|
1082
|
-
* @public
|
|
1083
|
-
*/
|
|
1084
|
-
blueprintName?: string | undefined;
|
|
1085
|
-
/**
|
|
1086
|
-
* <p>The bundle for the instance (<code>micro_x_x</code>).</p>
|
|
1087
|
-
* @public
|
|
1088
|
-
*/
|
|
1089
|
-
bundleId?: string | undefined;
|
|
1090
|
-
/**
|
|
1091
|
-
* <p>An array of objects representing the add-ons enabled on the instance.</p>
|
|
1092
|
-
* @public
|
|
1093
|
-
*/
|
|
1094
|
-
addOns?: AddOn[] | undefined;
|
|
1095
|
-
/**
|
|
1096
|
-
* <p>A Boolean value indicating whether this instance has a static IP assigned to it.</p>
|
|
1097
|
-
* @public
|
|
1098
|
-
*/
|
|
1099
|
-
isStaticIp?: boolean | undefined;
|
|
1100
|
-
/**
|
|
1101
|
-
* <p>The private IP address of the instance.</p>
|
|
1102
|
-
* @public
|
|
1103
|
-
*/
|
|
1104
|
-
privateIpAddress?: string | undefined;
|
|
1105
|
-
/**
|
|
1106
|
-
* <p>The public IP address of the instance.</p>
|
|
1107
|
-
* @public
|
|
1108
|
-
*/
|
|
1109
|
-
publicIpAddress?: string | undefined;
|
|
1110
|
-
/**
|
|
1111
|
-
* <p>The IPv6 addresses of the instance.</p>
|
|
1112
|
-
* @public
|
|
1113
|
-
*/
|
|
1114
|
-
ipv6Addresses?: string[] | undefined;
|
|
1115
|
-
/**
|
|
1116
|
-
* <p>The IP address type of the instance.</p>
|
|
1117
|
-
* <p>The possible values are <code>ipv4</code> for IPv4 only, <code>ipv6</code> for IPv6 only,
|
|
1118
|
-
* and <code>dualstack</code> for IPv4 and IPv6.</p>
|
|
1119
|
-
* @public
|
|
1120
|
-
*/
|
|
1121
|
-
ipAddressType?: IpAddressType | undefined;
|
|
1122
|
-
/**
|
|
1123
|
-
* <p>The size of the vCPU and the amount of RAM for the instance.</p>
|
|
1124
|
-
* @public
|
|
1125
|
-
*/
|
|
1126
|
-
hardware?: InstanceHardware | undefined;
|
|
1127
|
-
/**
|
|
1128
|
-
* <p>Information about the public ports and monthly data transfer rates for the
|
|
1129
|
-
* instance.</p>
|
|
1130
|
-
* @public
|
|
1131
|
-
*/
|
|
1132
|
-
networking?: InstanceNetworking | undefined;
|
|
1133
|
-
/**
|
|
1134
|
-
* <p>The status code and the state (<code>running</code>) for the instance.</p>
|
|
1135
|
-
* @public
|
|
1136
|
-
*/
|
|
1137
|
-
state?: InstanceState | undefined;
|
|
1138
|
-
/**
|
|
1139
|
-
* <p>The user name for connecting to the instance (<code>ec2-user</code>).</p>
|
|
1140
|
-
* @public
|
|
1141
|
-
*/
|
|
1142
|
-
username?: string | undefined;
|
|
1143
|
-
/**
|
|
1144
|
-
* <p>The name of the SSH key being used to connect to the instance
|
|
1145
|
-
* (<code>LightsailDefaultKeyPair</code>).</p>
|
|
1146
|
-
* @public
|
|
1147
|
-
*/
|
|
1148
|
-
sshKeyName?: string | undefined;
|
|
1149
|
-
/**
|
|
1150
|
-
* <p>The metadata options for the Amazon Lightsail instance.</p>
|
|
1151
|
-
* @public
|
|
1152
|
-
*/
|
|
1153
|
-
metadataOptions?: InstanceMetadataOptions | undefined;
|
|
1154
|
-
}
|
|
1155
|
-
/**
|
|
1156
|
-
* @public
|
|
1157
|
-
*/
|
|
1158
|
-
export interface GetInstanceResult {
|
|
1159
|
-
/**
|
|
1160
|
-
* <p>An array of key-value pairs containing information about the specified instance.</p>
|
|
1161
|
-
* @public
|
|
1162
|
-
*/
|
|
1163
|
-
instance?: Instance | undefined;
|
|
1164
|
-
}
|
|
1165
|
-
/**
|
|
1166
|
-
* @public
|
|
1167
|
-
* @enum
|
|
1168
|
-
*/
|
|
1169
|
-
export declare const InstanceAccessProtocol: {
|
|
1170
|
-
readonly rdp: "rdp";
|
|
1171
|
-
readonly ssh: "ssh";
|
|
1172
|
-
};
|
|
1173
|
-
/**
|
|
1174
|
-
* @public
|
|
1175
|
-
*/
|
|
1176
|
-
export type InstanceAccessProtocol = (typeof InstanceAccessProtocol)[keyof typeof InstanceAccessProtocol];
|
|
1177
|
-
/**
|
|
1178
|
-
* @public
|
|
1179
|
-
*/
|
|
1180
|
-
export interface GetInstanceAccessDetailsRequest {
|
|
1181
|
-
/**
|
|
1182
|
-
* <p>The name of the instance to access.</p>
|
|
1183
|
-
* @public
|
|
1184
|
-
*/
|
|
1185
|
-
instanceName: string | undefined;
|
|
1186
|
-
/**
|
|
1187
|
-
* <p>The protocol to use to connect to your instance. Defaults to <code>ssh</code>.</p>
|
|
1188
|
-
* @public
|
|
1189
|
-
*/
|
|
1190
|
-
protocol?: InstanceAccessProtocol | undefined;
|
|
1191
|
-
}
|
|
1192
|
-
/**
|
|
1193
|
-
* <p>Describes the public SSH host keys or the RDP certificate.</p>
|
|
1194
|
-
* @public
|
|
1195
|
-
*/
|
|
1196
|
-
export interface HostKeyAttributes {
|
|
1197
|
-
/**
|
|
1198
|
-
* <p>The SSH host key algorithm or the RDP certificate format.</p>
|
|
1199
|
-
* <p>For SSH host keys, the algorithm may be <code>ssh-rsa</code>,
|
|
1200
|
-
* <code>ecdsa-sha2-nistp256</code>, <code>ssh-ed25519</code>, etc. For RDP certificates, the
|
|
1201
|
-
* algorithm is always <code>x509-cert</code>.</p>
|
|
1202
|
-
* @public
|
|
1203
|
-
*/
|
|
1204
|
-
algorithm?: string | undefined;
|
|
1205
|
-
/**
|
|
1206
|
-
* <p>The public SSH host key or the RDP certificate.</p>
|
|
1207
|
-
* @public
|
|
1208
|
-
*/
|
|
1209
|
-
publicKey?: string | undefined;
|
|
1210
|
-
/**
|
|
1211
|
-
* <p>The time that the SSH host key or RDP certificate was recorded by Lightsail.</p>
|
|
1212
|
-
* @public
|
|
1213
|
-
*/
|
|
1214
|
-
witnessedAt?: Date | undefined;
|
|
1215
|
-
/**
|
|
1216
|
-
* <p>The SHA-1 fingerprint of the returned SSH host key or RDP certificate.</p>
|
|
1217
|
-
* <ul>
|
|
1218
|
-
* <li>
|
|
1219
|
-
* <p>Example of an SHA-1 SSH fingerprint:</p>
|
|
1220
|
-
* <p>
|
|
1221
|
-
* <code>SHA1:1CHH6FaAaXjtFOsR/t83vf91SR0</code>
|
|
1222
|
-
* </p>
|
|
1223
|
-
* </li>
|
|
1224
|
-
* <li>
|
|
1225
|
-
* <p>Example of an SHA-1 RDP fingerprint:</p>
|
|
1226
|
-
* <p>
|
|
1227
|
-
* <code>af:34:51:fe:09:f0:e0:da:b8:4e:56:ca:60:c2:10:ff:38:06:db:45</code>
|
|
1228
|
-
* </p>
|
|
1229
|
-
* </li>
|
|
1230
|
-
* </ul>
|
|
1231
|
-
* @public
|
|
1232
|
-
*/
|
|
1233
|
-
fingerprintSHA1?: string | undefined;
|
|
1234
|
-
/**
|
|
1235
|
-
* <p>The SHA-256 fingerprint of the returned SSH host key or RDP certificate.</p>
|
|
1236
|
-
* <ul>
|
|
1237
|
-
* <li>
|
|
1238
|
-
* <p>Example of an SHA-256 SSH fingerprint:</p>
|
|
1239
|
-
* <p>
|
|
1240
|
-
* <code>SHA256:KTsMnRBh1IhD17HpdfsbzeGA4jOijm5tyXsMjKVbB8o</code>
|
|
1241
|
-
* </p>
|
|
1242
|
-
* </li>
|
|
1243
|
-
* <li>
|
|
1244
|
-
* <p>Example of an SHA-256 RDP fingerprint:</p>
|
|
1245
|
-
* <p>
|
|
1246
|
-
* <code>03:9b:36:9f:4b:de:4e:61:70:fc:7c:c9:78:e7:d2:1a:1c:25:a8:0c:91:f6:7c:e4:d6:a0:85:c8:b4:53:99:68</code>
|
|
1247
|
-
* </p>
|
|
1248
|
-
* </li>
|
|
1249
|
-
* </ul>
|
|
1250
|
-
* @public
|
|
1251
|
-
*/
|
|
1252
|
-
fingerprintSHA256?: string | undefined;
|
|
1253
|
-
/**
|
|
1254
|
-
* <p>The returned RDP certificate is valid after this point in time.</p>
|
|
1255
|
-
* <p>This value is listed only for RDP certificates.</p>
|
|
1256
|
-
* @public
|
|
1257
|
-
*/
|
|
1258
|
-
notValidBefore?: Date | undefined;
|
|
1259
|
-
/**
|
|
1260
|
-
* <p>The returned RDP certificate is not valid after this point in time.</p>
|
|
1261
|
-
* <p>This value is listed only for RDP certificates.</p>
|
|
1262
|
-
* @public
|
|
1263
|
-
*/
|
|
1264
|
-
notValidAfter?: Date | undefined;
|
|
1265
|
-
}
|
|
1266
|
-
/**
|
|
1267
|
-
* <p>The password data for the Windows Server-based instance, including the ciphertext and the
|
|
1268
|
-
* key pair name.</p>
|
|
1269
|
-
* @public
|
|
1270
|
-
*/
|
|
1271
|
-
export interface PasswordData {
|
|
1272
|
-
/**
|
|
1273
|
-
* <p>The encrypted password. Ciphertext will be an empty string if access to your new instance
|
|
1274
|
-
* is not ready yet. When you create an instance, it can take up to 15 minutes for the instance
|
|
1275
|
-
* to be ready.</p>
|
|
1276
|
-
* <note>
|
|
1277
|
-
* <p>If you use the default key pair (<code>LightsailDefaultKeyPair</code>), the decrypted
|
|
1278
|
-
* password will be available in the password field.</p>
|
|
1279
|
-
* <p>If you are using a custom key pair, you need to use your own means of decryption.</p>
|
|
1280
|
-
* <p>If you change the Administrator password on the instance, Lightsail will continue to
|
|
1281
|
-
* return the original ciphertext value. When accessing the instance using RDP, you need to
|
|
1282
|
-
* manually enter the Administrator password after changing it from the default.</p>
|
|
1283
|
-
* </note>
|
|
1284
|
-
* @public
|
|
1285
|
-
*/
|
|
1286
|
-
ciphertext?: string | undefined;
|
|
1287
|
-
/**
|
|
1288
|
-
* <p>The name of the key pair that you used when creating your instance. If no key pair name
|
|
1289
|
-
* was specified when creating the instance, Lightsail uses the default key pair
|
|
1290
|
-
* (<code>LightsailDefaultKeyPair</code>).</p>
|
|
1291
|
-
* <p>If you are using a custom key pair, you need to use your own means of decrypting your
|
|
1292
|
-
* password using the <code>ciphertext</code>. Lightsail creates the ciphertext by encrypting
|
|
1293
|
-
* your password with the public key part of this key pair.</p>
|
|
1294
|
-
* @public
|
|
1295
|
-
*/
|
|
1296
|
-
keyPairName?: string | undefined;
|
|
1297
|
-
}
|
|
1298
|
-
/**
|
|
1299
|
-
* <p>The parameters for gaining temporary access to one of your Amazon Lightsail
|
|
1300
|
-
* instances.</p>
|
|
1301
|
-
* @public
|
|
1302
|
-
*/
|
|
1303
|
-
export interface InstanceAccessDetails {
|
|
1304
|
-
/**
|
|
1305
|
-
* <p>For SSH access, the public key to use when accessing your instance For OpenSSH clients
|
|
1306
|
-
* (command line SSH), you should save this value to <code>tempkey-cert.pub</code>.</p>
|
|
1307
|
-
* @public
|
|
1308
|
-
*/
|
|
1309
|
-
certKey?: string | undefined;
|
|
1310
|
-
/**
|
|
1311
|
-
* <p>For SSH access, the date on which the temporary keys expire.</p>
|
|
1312
|
-
* @public
|
|
1313
|
-
*/
|
|
1314
|
-
expiresAt?: Date | undefined;
|
|
1315
|
-
/**
|
|
1316
|
-
* <p>The public IP address of the Amazon Lightsail instance.</p>
|
|
1317
|
-
* @public
|
|
1318
|
-
*/
|
|
1319
|
-
ipAddress?: string | undefined;
|
|
1320
|
-
/**
|
|
1321
|
-
* <p>The IPv6 address of the Amazon Lightsail instance.</p>
|
|
1322
|
-
* @public
|
|
1323
|
-
*/
|
|
1324
|
-
ipv6Addresses?: string[] | undefined;
|
|
1325
|
-
/**
|
|
1326
|
-
* <p>For RDP access, the password for your Amazon Lightsail instance. Password will be an empty
|
|
1327
|
-
* string if the password for your new instance is not ready yet. When you create an instance, it
|
|
1328
|
-
* can take up to 15 minutes for the instance to be ready.</p>
|
|
1329
|
-
* <note>
|
|
1330
|
-
* <p>If you create an instance using any key pair other than the default
|
|
1331
|
-
* (<code>LightsailDefaultKeyPair</code>), <code>password</code> will always be an empty
|
|
1332
|
-
* string.</p>
|
|
1333
|
-
* <p>If you change the Administrator password on the instance, Lightsail will continue to
|
|
1334
|
-
* return the original password value. When accessing the instance using RDP, you need to
|
|
1335
|
-
* manually enter the Administrator password after changing it from the default.</p>
|
|
1336
|
-
* </note>
|
|
1337
|
-
* @public
|
|
1338
|
-
*/
|
|
1339
|
-
password?: string | undefined;
|
|
1340
|
-
/**
|
|
1341
|
-
* <p>For a Windows Server-based instance, an object with the data you can use to retrieve your
|
|
1342
|
-
* password. This is only needed if <code>password</code> is empty and the instance is not new
|
|
1343
|
-
* (and therefore the password is not ready yet). When you create an instance, it can take up to
|
|
1344
|
-
* 15 minutes for the instance to be ready.</p>
|
|
1345
|
-
* @public
|
|
1346
|
-
*/
|
|
1347
|
-
passwordData?: PasswordData | undefined;
|
|
1348
|
-
/**
|
|
1349
|
-
* <p>For SSH access, the temporary private key. For OpenSSH clients (command line SSH), you
|
|
1350
|
-
* should save this value to <code>tempkey</code>).</p>
|
|
1351
|
-
* @public
|
|
1352
|
-
*/
|
|
1353
|
-
privateKey?: string | undefined;
|
|
1354
|
-
/**
|
|
1355
|
-
* <p>The protocol for these Amazon Lightsail instance access details.</p>
|
|
1356
|
-
* @public
|
|
1357
|
-
*/
|
|
1358
|
-
protocol?: InstanceAccessProtocol | undefined;
|
|
1359
|
-
/**
|
|
1360
|
-
* <p>The name of this Amazon Lightsail instance.</p>
|
|
1361
|
-
* @public
|
|
1362
|
-
*/
|
|
1363
|
-
instanceName?: string | undefined;
|
|
1364
|
-
/**
|
|
1365
|
-
* <p>The user name to use when logging in to the Amazon Lightsail instance.</p>
|
|
1366
|
-
* @public
|
|
1367
|
-
*/
|
|
1368
|
-
username?: string | undefined;
|
|
1369
|
-
/**
|
|
1370
|
-
* <p>Describes the public SSH host keys or the RDP certificate.</p>
|
|
1371
|
-
* @public
|
|
1372
|
-
*/
|
|
1373
|
-
hostKeys?: HostKeyAttributes[] | undefined;
|
|
1374
|
-
}
|
|
1375
|
-
/**
|
|
1376
|
-
* @public
|
|
1377
|
-
*/
|
|
1378
|
-
export interface GetInstanceAccessDetailsResult {
|
|
1379
|
-
/**
|
|
1380
|
-
* <p>An array of key-value pairs containing information about a get instance access
|
|
1381
|
-
* request.</p>
|
|
1382
|
-
* @public
|
|
1383
|
-
*/
|
|
1384
|
-
accessDetails?: InstanceAccessDetails | undefined;
|
|
1385
|
-
}
|
|
1386
|
-
/**
|
|
1387
|
-
* @public
|
|
1388
|
-
* @enum
|
|
1389
|
-
*/
|
|
1390
|
-
export declare const InstanceMetricName: {
|
|
1391
|
-
readonly BurstCapacityPercentage: "BurstCapacityPercentage";
|
|
1392
|
-
readonly BurstCapacityTime: "BurstCapacityTime";
|
|
1393
|
-
readonly CPUUtilization: "CPUUtilization";
|
|
1394
|
-
readonly MetadataNoToken: "MetadataNoToken";
|
|
1395
|
-
readonly NetworkIn: "NetworkIn";
|
|
1396
|
-
readonly NetworkOut: "NetworkOut";
|
|
1397
|
-
readonly StatusCheckFailed: "StatusCheckFailed";
|
|
1398
|
-
readonly StatusCheckFailed_Instance: "StatusCheckFailed_Instance";
|
|
1399
|
-
readonly StatusCheckFailed_System: "StatusCheckFailed_System";
|
|
1400
|
-
};
|
|
1401
|
-
/**
|
|
1402
|
-
* @public
|
|
1403
|
-
*/
|
|
1404
|
-
export type InstanceMetricName = (typeof InstanceMetricName)[keyof typeof InstanceMetricName];
|
|
1405
|
-
/**
|
|
1406
|
-
* @public
|
|
1407
|
-
*/
|
|
1408
|
-
export interface GetInstanceMetricDataRequest {
|
|
1409
|
-
/**
|
|
1410
|
-
* <p>The name of the instance for which you want to get metrics data.</p>
|
|
1411
|
-
* @public
|
|
1412
|
-
*/
|
|
1413
|
-
instanceName: string | undefined;
|
|
1414
|
-
/**
|
|
1415
|
-
* <p>The metric for which you want to return information.</p>
|
|
1416
|
-
* <p>Valid instance metric names are listed below, along with the most useful
|
|
1417
|
-
* <code>statistics</code> to include in your request, and the published <code>unit</code>
|
|
1418
|
-
* value.</p>
|
|
1419
|
-
* <ul>
|
|
1420
|
-
* <li>
|
|
1421
|
-
* <p>
|
|
1422
|
-
* <b>
|
|
1423
|
-
* <code>BurstCapacityPercentage</code>
|
|
1424
|
-
* </b> - The percentage
|
|
1425
|
-
* of CPU performance available for your instance to burst above its baseline. Your instance
|
|
1426
|
-
* continuously accrues and consumes burst capacity. Burst capacity stops accruing when your
|
|
1427
|
-
* instance's <code>BurstCapacityPercentage</code> reaches 100%. For more information, see
|
|
1428
|
-
* <a href="https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-viewing-instance-burst-capacity">Viewing instance burst capacity in Amazon Lightsail</a>.</p>
|
|
1429
|
-
* <p>
|
|
1430
|
-
* <code>Statistics</code>: The most useful statistics are <code>Maximum</code> and
|
|
1431
|
-
* <code>Average</code>.</p>
|
|
1432
|
-
* <p>
|
|
1433
|
-
* <code>Unit</code>: The published unit is <code>Percent</code>.</p>
|
|
1434
|
-
* </li>
|
|
1435
|
-
* <li>
|
|
1436
|
-
* <p>
|
|
1437
|
-
* <b>
|
|
1438
|
-
* <code>BurstCapacityTime</code>
|
|
1439
|
-
* </b> - The available amount
|
|
1440
|
-
* of time for your instance to burst at 100% CPU utilization. Your instance continuously
|
|
1441
|
-
* accrues and consumes burst capacity. Burst capacity time stops accruing when your
|
|
1442
|
-
* instance's <code>BurstCapacityPercentage</code> metric reaches 100%.</p>
|
|
1443
|
-
* <p>Burst capacity time is consumed at the full rate only when your instance operates at
|
|
1444
|
-
* 100% CPU utilization. For example, if your instance operates at 50% CPU utilization in the
|
|
1445
|
-
* burstable zone for a 5-minute period, then it consumes CPU burst capacity minutes at a 50%
|
|
1446
|
-
* rate in that period. Your instance consumed 2 minutes and 30 seconds of CPU burst capacity
|
|
1447
|
-
* minutes in the 5-minute period. For more information, see <a href="https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-viewing-instance-burst-capacity">Viewing instance burst capacity in Amazon Lightsail</a>.</p>
|
|
1448
|
-
* <p>
|
|
1449
|
-
* <code>Statistics</code>: The most useful statistics are <code>Maximum</code> and
|
|
1450
|
-
* <code>Average</code>.</p>
|
|
1451
|
-
* <p>
|
|
1452
|
-
* <code>Unit</code>: The published unit is <code>Seconds</code>.</p>
|
|
1453
|
-
* </li>
|
|
1454
|
-
* <li>
|
|
1455
|
-
* <p>
|
|
1456
|
-
* <b>
|
|
1457
|
-
* <code>CPUUtilization</code>
|
|
1458
|
-
* </b> - The percentage of
|
|
1459
|
-
* allocated compute units that are currently in use on the instance. This metric identifies
|
|
1460
|
-
* the processing power to run the applications on the instance. Tools in your operating
|
|
1461
|
-
* system can show a lower percentage than Lightsail when the instance is not allocated a
|
|
1462
|
-
* full processor core.</p>
|
|
1463
|
-
* <p>
|
|
1464
|
-
* <code>Statistics</code>: The most useful statistics are <code>Maximum</code> and
|
|
1465
|
-
* <code>Average</code>.</p>
|
|
1466
|
-
* <p>
|
|
1467
|
-
* <code>Unit</code>: The published unit is <code>Percent</code>.</p>
|
|
1468
|
-
* </li>
|
|
1469
|
-
* <li>
|
|
1470
|
-
* <p>
|
|
1471
|
-
* <b>
|
|
1472
|
-
* <code>NetworkIn</code>
|
|
1473
|
-
* </b> - The number of bytes received
|
|
1474
|
-
* on all network interfaces by the instance. This metric identifies the volume of incoming
|
|
1475
|
-
* network traffic to the instance. The number reported is the number of bytes received
|
|
1476
|
-
* during the period. Because this metric is reported in 5-minute intervals, divide the
|
|
1477
|
-
* reported number by 300 to find Bytes/second.</p>
|
|
1478
|
-
* <p>
|
|
1479
|
-
* <code>Statistics</code>: The most useful statistic is <code>Sum</code>.</p>
|
|
1480
|
-
* <p>
|
|
1481
|
-
* <code>Unit</code>: The published unit is <code>Bytes</code>.</p>
|
|
1482
|
-
* </li>
|
|
1483
|
-
* <li>
|
|
1484
|
-
* <p>
|
|
1485
|
-
* <b>
|
|
1486
|
-
* <code>NetworkOut</code>
|
|
1487
|
-
* </b> - The number of bytes sent
|
|
1488
|
-
* out on all network interfaces by the instance. This metric identifies the volume of
|
|
1489
|
-
* outgoing network traffic from the instance. The number reported is the number of bytes
|
|
1490
|
-
* sent during the period. Because this metric is reported in 5-minute intervals, divide the
|
|
1491
|
-
* reported number by 300 to find Bytes/second.</p>
|
|
1492
|
-
* <p>
|
|
1493
|
-
* <code>Statistics</code>: The most useful statistic is <code>Sum</code>.</p>
|
|
1494
|
-
* <p>
|
|
1495
|
-
* <code>Unit</code>: The published unit is <code>Bytes</code>.</p>
|
|
1496
|
-
* </li>
|
|
1497
|
-
* <li>
|
|
1498
|
-
* <p>
|
|
1499
|
-
* <b>
|
|
1500
|
-
* <code>StatusCheckFailed</code>
|
|
1501
|
-
* </b> - Reports whether the
|
|
1502
|
-
* instance passed or failed both the instance status check and the system status check. This
|
|
1503
|
-
* metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute
|
|
1504
|
-
* (60 seconds) granularity.</p>
|
|
1505
|
-
* <p>
|
|
1506
|
-
* <code>Statistics</code>: The most useful statistic is <code>Sum</code>.</p>
|
|
1507
|
-
* <p>
|
|
1508
|
-
* <code>Unit</code>: The published unit is <code>Count</code>.</p>
|
|
1509
|
-
* </li>
|
|
1510
|
-
* <li>
|
|
1511
|
-
* <p>
|
|
1512
|
-
* <b>
|
|
1513
|
-
* <code>StatusCheckFailed_Instance</code>
|
|
1514
|
-
* </b> - Reports
|
|
1515
|
-
* whether the instance passed or failed the instance status check. This metric can be either
|
|
1516
|
-
* 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds)
|
|
1517
|
-
* granularity.</p>
|
|
1518
|
-
* <p>
|
|
1519
|
-
* <code>Statistics</code>: The most useful statistic is <code>Sum</code>.</p>
|
|
1520
|
-
* <p>
|
|
1521
|
-
* <code>Unit</code>: The published unit is <code>Count</code>.</p>
|
|
1522
|
-
* </li>
|
|
1523
|
-
* <li>
|
|
1524
|
-
* <p>
|
|
1525
|
-
* <b>
|
|
1526
|
-
* <code>StatusCheckFailed_System</code>
|
|
1527
|
-
* </b> - Reports
|
|
1528
|
-
* whether the instance passed or failed the system status check. This metric can be either 0
|
|
1529
|
-
* (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds)
|
|
1530
|
-
* granularity.</p>
|
|
1531
|
-
* <p>
|
|
1532
|
-
* <code>Statistics</code>: The most useful statistic is <code>Sum</code>.</p>
|
|
1533
|
-
* <p>
|
|
1534
|
-
* <code>Unit</code>: The published unit is <code>Count</code>.</p>
|
|
1535
|
-
* </li>
|
|
1536
|
-
* <li>
|
|
1537
|
-
* <p>
|
|
1538
|
-
* <b>
|
|
1539
|
-
* <code>MetadataNoToken</code>
|
|
1540
|
-
* </b> - Reports the number of
|
|
1541
|
-
* times that the instance metadata service was successfully accessed without a token. This
|
|
1542
|
-
* metric determines if there are any processes accessing instance metadata by using Instance
|
|
1543
|
-
* Metadata Service Version 1, which doesn't use a token. If all requests use token-backed
|
|
1544
|
-
* sessions, such as Instance Metadata Service Version 2, then the value is 0.</p>
|
|
1545
|
-
* <p>
|
|
1546
|
-
* <code>Statistics</code>: The most useful statistic is <code>Sum</code>.</p>
|
|
1547
|
-
* <p>
|
|
1548
|
-
* <code>Unit</code>: The published unit is <code>Count</code>.</p>
|
|
1549
|
-
* </li>
|
|
1550
|
-
* </ul>
|
|
1551
|
-
* @public
|
|
1552
|
-
*/
|
|
1553
|
-
metricName: InstanceMetricName | undefined;
|
|
1554
|
-
/**
|
|
1555
|
-
* <p>The granularity, in seconds, of the returned data points.</p>
|
|
1556
|
-
* <p>The <code>StatusCheckFailed</code>, <code>StatusCheckFailed_Instance</code>, and
|
|
1557
|
-
* <code>StatusCheckFailed_System</code> instance metric data is available in 1-minute (60
|
|
1558
|
-
* seconds) granularity. All other instance metric data is available in 5-minute (300 seconds)
|
|
1559
|
-
* granularity.</p>
|
|
1560
|
-
* @public
|
|
1561
|
-
*/
|
|
1562
|
-
period: number | undefined;
|
|
1563
|
-
/**
|
|
1564
|
-
* <p>The start time of the time period.</p>
|
|
1565
|
-
* @public
|
|
1566
|
-
*/
|
|
1567
|
-
startTime: Date | undefined;
|
|
1568
|
-
/**
|
|
1569
|
-
* <p>The end time of the time period.</p>
|
|
1570
|
-
* @public
|
|
1571
|
-
*/
|
|
1572
|
-
endTime: Date | undefined;
|
|
1573
|
-
/**
|
|
1574
|
-
* <p>The unit for the metric data request. Valid units depend on the metric data being
|
|
1575
|
-
* requested. For the valid units to specify with each available metric, see the
|
|
1576
|
-
* <code>metricName</code> parameter.</p>
|
|
1577
|
-
* @public
|
|
1578
|
-
*/
|
|
1579
|
-
unit: MetricUnit | undefined;
|
|
1580
|
-
/**
|
|
1581
|
-
* <p>The statistic for the metric.</p>
|
|
1582
|
-
* <p>The following statistics are available:</p>
|
|
1583
|
-
* <ul>
|
|
1584
|
-
* <li>
|
|
1585
|
-
* <p>
|
|
1586
|
-
* <code>Minimum</code> - The lowest value observed during the specified period. Use this
|
|
1587
|
-
* value to determine low volumes of activity for your application.</p>
|
|
1588
|
-
* </li>
|
|
1589
|
-
* <li>
|
|
1590
|
-
* <p>
|
|
1591
|
-
* <code>Maximum</code> - The highest value observed during the specified period. Use
|
|
1592
|
-
* this value to determine high volumes of activity for your application.</p>
|
|
1593
|
-
* </li>
|
|
1594
|
-
* <li>
|
|
1595
|
-
* <p>
|
|
1596
|
-
* <code>Sum</code> - All values submitted for the matching metric added together. You
|
|
1597
|
-
* can use this statistic to determine the total volume of a metric.</p>
|
|
1598
|
-
* </li>
|
|
1599
|
-
* <li>
|
|
1600
|
-
* <p>
|
|
1601
|
-
* <code>Average</code> - The value of Sum / SampleCount during the specified period. By
|
|
1602
|
-
* comparing this statistic with the Minimum and Maximum values, you can determine the full
|
|
1603
|
-
* scope of a metric and how close the average use is to the Minimum and Maximum values. This
|
|
1604
|
-
* comparison helps you to know when to increase or decrease your resources.</p>
|
|
1605
|
-
* </li>
|
|
1606
|
-
* <li>
|
|
1607
|
-
* <p>
|
|
1608
|
-
* <code>SampleCount</code> - The count, or number, of data points used for the
|
|
1609
|
-
* statistical calculation.</p>
|
|
1610
|
-
* </li>
|
|
1611
|
-
* </ul>
|
|
1612
|
-
* @public
|
|
1613
|
-
*/
|
|
1614
|
-
statistics: MetricStatistic[] | undefined;
|
|
1615
|
-
}
|
|
1616
|
-
/**
|
|
1617
|
-
* @public
|
|
1618
|
-
*/
|
|
1619
|
-
export interface GetInstanceMetricDataResult {
|
|
1620
|
-
/**
|
|
1621
|
-
* <p>The name of the metric returned.</p>
|
|
1622
|
-
* @public
|
|
1623
|
-
*/
|
|
1624
|
-
metricName?: InstanceMetricName | undefined;
|
|
1625
|
-
/**
|
|
1626
|
-
* <p>An array of objects that describe the metric data returned.</p>
|
|
1627
|
-
* @public
|
|
1628
|
-
*/
|
|
1629
|
-
metricData?: MetricDatapoint[] | undefined;
|
|
1630
|
-
}
|
|
1631
|
-
/**
|
|
1632
|
-
* @public
|
|
1633
|
-
*/
|
|
1634
|
-
export interface GetInstancePortStatesRequest {
|
|
1635
|
-
/**
|
|
1636
|
-
* <p>The name of the instance for which to return firewall port states.</p>
|
|
1637
|
-
* @public
|
|
1638
|
-
*/
|
|
1639
|
-
instanceName: string | undefined;
|
|
1640
|
-
}
|
|
1641
|
-
/**
|
|
1642
|
-
* @public
|
|
1643
|
-
* @enum
|
|
1644
|
-
*/
|
|
1645
|
-
export declare const PortState: {
|
|
1646
|
-
readonly Closed: "closed";
|
|
1647
|
-
readonly Open: "open";
|
|
1648
|
-
};
|
|
1649
|
-
/**
|
|
1650
|
-
* @public
|
|
1651
|
-
*/
|
|
1652
|
-
export type PortState = (typeof PortState)[keyof typeof PortState];
|
|
1653
|
-
/**
|
|
1654
|
-
* <p>Describes open ports on an instance, the IP addresses allowed to connect to the instance
|
|
1655
|
-
* through the ports, and the protocol.</p>
|
|
1656
|
-
* @public
|
|
1657
|
-
*/
|
|
1658
|
-
export interface InstancePortState {
|
|
1659
|
-
/**
|
|
1660
|
-
* <p>The first port in a range of open ports on an instance.</p>
|
|
1661
|
-
* <p>Allowed ports:</p>
|
|
1662
|
-
* <ul>
|
|
1663
|
-
* <li>
|
|
1664
|
-
* <p>TCP and UDP - <code>0</code> to <code>65535</code>
|
|
1665
|
-
* </p>
|
|
1666
|
-
* </li>
|
|
1667
|
-
* <li>
|
|
1668
|
-
* <p>ICMP - The ICMP type for IPv4 addresses. For example, specify <code>8</code> as the
|
|
1669
|
-
* <code>fromPort</code> (ICMP type), and <code>-1</code> as the <code>toPort</code> (ICMP
|
|
1670
|
-
* code), to enable ICMP Ping. For more information, see <a href="https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol#Control_messages">Control Messages</a> on <i>Wikipedia</i>.</p>
|
|
1671
|
-
* </li>
|
|
1672
|
-
* <li>
|
|
1673
|
-
* <p>ICMPv6 - The ICMP type for IPv6 addresses. For example, specify <code>128</code> as
|
|
1674
|
-
* the <code>fromPort</code> (ICMPv6 type), and <code>0</code> as <code>toPort</code> (ICMPv6
|
|
1675
|
-
* code). For more information, see <a href="https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol_for_IPv6">Internet
|
|
1676
|
-
* Control Message Protocol for IPv6</a>.</p>
|
|
1677
|
-
* </li>
|
|
1678
|
-
* </ul>
|
|
1679
|
-
* @public
|
|
1680
|
-
*/
|
|
1681
|
-
fromPort?: number | undefined;
|
|
1682
|
-
/**
|
|
1683
|
-
* <p>The last port in a range of open ports on an instance.</p>
|
|
1684
|
-
* <p>Allowed ports:</p>
|
|
1685
|
-
* <ul>
|
|
1686
|
-
* <li>
|
|
1687
|
-
* <p>TCP and UDP - <code>0</code> to <code>65535</code>
|
|
1688
|
-
* </p>
|
|
1689
|
-
* </li>
|
|
1690
|
-
* <li>
|
|
1691
|
-
* <p>ICMP - The ICMP code for IPv4 addresses. For example, specify <code>8</code> as the
|
|
1692
|
-
* <code>fromPort</code> (ICMP type), and <code>-1</code> as the <code>toPort</code> (ICMP
|
|
1693
|
-
* code), to enable ICMP Ping. For more information, see <a href="https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol#Control_messages">Control Messages</a> on <i>Wikipedia</i>.</p>
|
|
1694
|
-
* </li>
|
|
1695
|
-
* <li>
|
|
1696
|
-
* <p>ICMPv6 - The ICMP code for IPv6 addresses. For example, specify <code>128</code> as
|
|
1697
|
-
* the <code>fromPort</code> (ICMPv6 type), and <code>0</code> as <code>toPort</code> (ICMPv6
|
|
1698
|
-
* code). For more information, see <a href="https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol_for_IPv6">Internet
|
|
1699
|
-
* Control Message Protocol for IPv6</a>.</p>
|
|
1700
|
-
* </li>
|
|
1701
|
-
* </ul>
|
|
1702
|
-
* @public
|
|
1703
|
-
*/
|
|
1704
|
-
toPort?: number | undefined;
|
|
1705
|
-
/**
|
|
1706
|
-
* <p>The IP protocol name.</p>
|
|
1707
|
-
* <p>The name can be one of the following:</p>
|
|
1708
|
-
* <ul>
|
|
1709
|
-
* <li>
|
|
1710
|
-
* <p>
|
|
1711
|
-
* <code>tcp</code> - Transmission Control Protocol (TCP) provides reliable, ordered, and
|
|
1712
|
-
* error-checked delivery of streamed data between applications running on hosts
|
|
1713
|
-
* communicating by an IP network. If you have an application that doesn't require reliable
|
|
1714
|
-
* data stream service, use UDP instead.</p>
|
|
1715
|
-
* </li>
|
|
1716
|
-
* <li>
|
|
1717
|
-
* <p>
|
|
1718
|
-
* <code>all</code> - All transport layer protocol types. For more general information,
|
|
1719
|
-
* see <a href="https://en.wikipedia.org/wiki/Transport_layer">Transport layer</a> on
|
|
1720
|
-
* <i>Wikipedia</i>.</p>
|
|
1721
|
-
* </li>
|
|
1722
|
-
* <li>
|
|
1723
|
-
* <p>
|
|
1724
|
-
* <code>udp</code> - With User Datagram Protocol (UDP), computer applications can send
|
|
1725
|
-
* messages (or datagrams) to other hosts on an Internet Protocol (IP) network. Prior
|
|
1726
|
-
* communications are not required to set up transmission channels or data paths.
|
|
1727
|
-
* Applications that don't require reliable data stream service can use UDP, which provides a
|
|
1728
|
-
* connectionless datagram service that emphasizes reduced latency over reliability. If you
|
|
1729
|
-
* do require reliable data stream service, use TCP instead.</p>
|
|
1730
|
-
* </li>
|
|
1731
|
-
* <li>
|
|
1732
|
-
* <p>
|
|
1733
|
-
* <code>icmp</code> - Internet Control Message Protocol (ICMP) is used to send error
|
|
1734
|
-
* messages and operational information indicating success or failure when communicating with
|
|
1735
|
-
* an instance. For example, an error is indicated when an instance could not be reached.
|
|
1736
|
-
* When you specify <code>icmp</code> as the <code>protocol</code>, you must specify the ICMP
|
|
1737
|
-
* type using the <code>fromPort</code> parameter, and ICMP code using the
|
|
1738
|
-
* <code>toPort</code> parameter.</p>
|
|
1739
|
-
* </li>
|
|
1740
|
-
* <li>
|
|
1741
|
-
* <p>
|
|
1742
|
-
* <code>icmp6</code> - Internet Control Message Protocol (ICMP) for IPv6. When you
|
|
1743
|
-
* specify <code>icmp6</code> as the <code>protocol</code>, you must specify the ICMP type
|
|
1744
|
-
* using the <code>fromPort</code> parameter, and ICMP code using the <code>toPort</code>
|
|
1745
|
-
* parameter.</p>
|
|
1746
|
-
* </li>
|
|
1747
|
-
* </ul>
|
|
1748
|
-
* @public
|
|
1749
|
-
*/
|
|
1750
|
-
protocol?: NetworkProtocol | undefined;
|
|
1751
|
-
/**
|
|
1752
|
-
* <p>Specifies whether the instance port is <code>open</code> or <code>closed</code>.</p>
|
|
1753
|
-
* <note>
|
|
1754
|
-
* <p>The port state for Lightsail instances is always <code>open</code>.</p>
|
|
1755
|
-
* </note>
|
|
1756
|
-
* @public
|
|
1757
|
-
*/
|
|
1758
|
-
state?: PortState | undefined;
|
|
1759
|
-
/**
|
|
1760
|
-
* <p>The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are allowed to
|
|
1761
|
-
* connect to an instance through the ports, and the protocol.</p>
|
|
1762
|
-
* <note>
|
|
1763
|
-
* <p>The <code>ipv6Cidrs</code> parameter lists the IPv6 addresses that are allowed to
|
|
1764
|
-
* connect to an instance.</p>
|
|
1765
|
-
* </note>
|
|
1766
|
-
* <p>For more information about CIDR block notation, see <a href="https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation">Classless
|
|
1767
|
-
* Inter-Domain Routing</a> on <i>Wikipedia</i>.</p>
|
|
1768
|
-
* @public
|
|
1769
|
-
*/
|
|
1770
|
-
cidrs?: string[] | undefined;
|
|
1771
|
-
/**
|
|
1772
|
-
* <p>The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are allowed to
|
|
1773
|
-
* connect to an instance through the ports, and the protocol. Only devices with an IPv6 address
|
|
1774
|
-
* can connect to an instance through IPv6; otherwise, IPv4 should be used.</p>
|
|
1775
|
-
* <note>
|
|
1776
|
-
* <p>The <code>cidrs</code> parameter lists the IPv4 addresses that are allowed to connect to
|
|
1777
|
-
* an instance.</p>
|
|
1778
|
-
* </note>
|
|
1779
|
-
* <p>For more information about CIDR block notation, see <a href="https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation">Classless
|
|
1780
|
-
* Inter-Domain Routing</a> on <i>Wikipedia</i>.</p>
|
|
1781
|
-
* @public
|
|
1782
|
-
*/
|
|
1783
|
-
ipv6Cidrs?: string[] | undefined;
|
|
1784
|
-
/**
|
|
1785
|
-
* <p>An alias that defines access for a preconfigured range of IP addresses.</p>
|
|
1786
|
-
* <p>The only alias currently supported is <code>lightsail-connect</code>, which allows IP
|
|
1787
|
-
* addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your
|
|
1788
|
-
* instance.</p>
|
|
1789
|
-
* @public
|
|
1790
|
-
*/
|
|
1791
|
-
cidrListAliases?: string[] | undefined;
|
|
1792
|
-
}
|
|
1793
|
-
/**
|
|
1794
|
-
* @public
|
|
1795
|
-
*/
|
|
1796
|
-
export interface GetInstancePortStatesResult {
|
|
1797
|
-
/**
|
|
1798
|
-
* <p>An array of objects that describe the firewall port states for the specified
|
|
1799
|
-
* instance.</p>
|
|
1800
|
-
* @public
|
|
1801
|
-
*/
|
|
1802
|
-
portStates?: InstancePortState[] | undefined;
|
|
1803
|
-
}
|
|
1804
|
-
/**
|
|
1805
|
-
* @public
|
|
1806
|
-
*/
|
|
1807
|
-
export interface GetInstancesRequest {
|
|
1808
|
-
/**
|
|
1809
|
-
* <p>The token to advance to the next page of results from your request.</p>
|
|
1810
|
-
* <p>To get a page token, perform an initial <code>GetInstances</code> request. If your results
|
|
1811
|
-
* are paginated, the response will return a next page token that you can specify as the page
|
|
1812
|
-
* token in a subsequent request.</p>
|
|
1813
|
-
* @public
|
|
1814
|
-
*/
|
|
1815
|
-
pageToken?: string | undefined;
|
|
1816
|
-
}
|
|
1817
|
-
/**
|
|
1818
|
-
* @public
|
|
1819
|
-
*/
|
|
1820
|
-
export interface GetInstancesResult {
|
|
1821
|
-
/**
|
|
1822
|
-
* <p>An array of key-value pairs containing information about your instances.</p>
|
|
1823
|
-
* @public
|
|
1824
|
-
*/
|
|
1825
|
-
instances?: Instance[] | undefined;
|
|
1826
|
-
/**
|
|
1827
|
-
* <p>The token to advance to the next page of results from your request.</p>
|
|
1828
|
-
* <p>A next page token is not returned if there are no more results to display.</p>
|
|
1829
|
-
* <p>To get the next page of results, perform another <code>GetInstances</code> request and
|
|
1830
|
-
* specify the next page token using the <code>pageToken</code> parameter.</p>
|
|
1831
|
-
* @public
|
|
1832
|
-
*/
|
|
1833
|
-
nextPageToken?: string | undefined;
|
|
1834
|
-
}
|
|
1835
|
-
/**
|
|
1836
|
-
* @public
|
|
1837
|
-
*/
|
|
1838
|
-
export interface GetInstanceSnapshotRequest {
|
|
1839
|
-
/**
|
|
1840
|
-
* <p>The name of the snapshot for which you are requesting information.</p>
|
|
1841
|
-
* @public
|
|
1842
|
-
*/
|
|
1843
|
-
instanceSnapshotName: string | undefined;
|
|
1844
|
-
}
|
|
1845
|
-
/**
|
|
1846
|
-
* @public
|
|
1847
|
-
* @enum
|
|
1848
|
-
*/
|
|
1849
|
-
export declare const InstanceSnapshotState: {
|
|
1850
|
-
readonly Available: "available";
|
|
1851
|
-
readonly Error: "error";
|
|
1852
|
-
readonly Pending: "pending";
|
|
1853
|
-
};
|
|
1854
|
-
/**
|
|
1855
|
-
* @public
|
|
1856
|
-
*/
|
|
1857
|
-
export type InstanceSnapshotState = (typeof InstanceSnapshotState)[keyof typeof InstanceSnapshotState];
|
|
1858
|
-
/**
|
|
1859
|
-
* <p>Describes an instance snapshot.</p>
|
|
1860
|
-
* @public
|
|
1861
|
-
*/
|
|
1862
|
-
export interface InstanceSnapshot {
|
|
1863
|
-
/**
|
|
1864
|
-
* <p>The name of the snapshot.</p>
|
|
1865
|
-
* @public
|
|
1866
|
-
*/
|
|
1867
|
-
name?: string | undefined;
|
|
1868
|
-
/**
|
|
1869
|
-
* <p>The Amazon Resource Name (ARN) of the snapshot
|
|
1870
|
-
* (<code>arn:aws:lightsail:us-east-2:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-12345EXAMPLE</code>).</p>
|
|
1871
|
-
* @public
|
|
1872
|
-
*/
|
|
1873
|
-
arn?: string | undefined;
|
|
1874
|
-
/**
|
|
1875
|
-
* <p>The support code. Include this code in your email to support when you have questions about
|
|
1876
|
-
* an instance or another resource in Lightsail. This code enables our support team to look up
|
|
1877
|
-
* your Lightsail information more easily.</p>
|
|
1878
|
-
* @public
|
|
1879
|
-
*/
|
|
1880
|
-
supportCode?: string | undefined;
|
|
1881
|
-
/**
|
|
1882
|
-
* <p>The timestamp when the snapshot was created (<code>1479907467.024</code>).</p>
|
|
1883
|
-
* @public
|
|
1884
|
-
*/
|
|
1885
|
-
createdAt?: Date | undefined;
|
|
1886
|
-
/**
|
|
1887
|
-
* <p>The region name and Availability Zone where you created the snapshot.</p>
|
|
1888
|
-
* @public
|
|
1889
|
-
*/
|
|
1890
|
-
location?: ResourceLocation | undefined;
|
|
1891
|
-
/**
|
|
1892
|
-
* <p>The type of resource (usually <code>InstanceSnapshot</code>).</p>
|
|
1893
|
-
* @public
|
|
1894
|
-
*/
|
|
1895
|
-
resourceType?: ResourceType | undefined;
|
|
1896
|
-
/**
|
|
1897
|
-
* <p>The tag keys and optional values for the resource. For more information about tags in
|
|
1898
|
-
* Lightsail, see the <a href="https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-tags">Amazon Lightsail Developer Guide</a>.</p>
|
|
1899
|
-
* @public
|
|
1900
|
-
*/
|
|
1901
|
-
tags?: Tag[] | undefined;
|
|
1902
|
-
/**
|
|
1903
|
-
* <p>The state the snapshot is in.</p>
|
|
1904
|
-
* @public
|
|
1905
|
-
*/
|
|
1906
|
-
state?: InstanceSnapshotState | undefined;
|
|
1907
|
-
/**
|
|
1908
|
-
* <p>The progress of the snapshot.</p>
|
|
1909
|
-
* <note>
|
|
1910
|
-
* <p>This is populated only for disk snapshots, and is <code>null</code> for instance
|
|
1911
|
-
* snapshots.</p>
|
|
1912
|
-
* </note>
|
|
1913
|
-
* @public
|
|
1914
|
-
*/
|
|
1915
|
-
progress?: string | undefined;
|
|
1916
|
-
/**
|
|
1917
|
-
* <p>An array of disk objects containing information about all block storage disks.</p>
|
|
1918
|
-
* @public
|
|
1919
|
-
*/
|
|
1920
|
-
fromAttachedDisks?: Disk[] | undefined;
|
|
1921
|
-
/**
|
|
1922
|
-
* <p>The instance from which the snapshot was created.</p>
|
|
1923
|
-
* @public
|
|
1924
|
-
*/
|
|
1925
|
-
fromInstanceName?: string | undefined;
|
|
1926
|
-
/**
|
|
1927
|
-
* <p>The Amazon Resource Name (ARN) of the instance from which the snapshot was created
|
|
1928
|
-
* (<code>arn:aws:lightsail:us-east-2:123456789101:Instance/64b8404c-ccb1-430b-8daf-12345EXAMPLE</code>).</p>
|
|
1929
|
-
* @public
|
|
1930
|
-
*/
|
|
1931
|
-
fromInstanceArn?: string | undefined;
|
|
1932
|
-
/**
|
|
1933
|
-
* <p>The blueprint ID from which you created the snapshot (<code>amazon_linux_2023</code>). A
|
|
1934
|
-
* blueprint is a virtual private server (or <i>instance</i>) image used to create
|
|
1935
|
-
* instances quickly.</p>
|
|
1936
|
-
* @public
|
|
1937
|
-
*/
|
|
1938
|
-
fromBlueprintId?: string | undefined;
|
|
1939
|
-
/**
|
|
1940
|
-
* <p>The bundle ID from which you created the snapshot (<code>micro_x_x</code>).</p>
|
|
1941
|
-
* @public
|
|
1942
|
-
*/
|
|
1943
|
-
fromBundleId?: string | undefined;
|
|
1944
|
-
/**
|
|
1945
|
-
* <p>A Boolean value indicating whether the snapshot was created from an automatic
|
|
1946
|
-
* snapshot.</p>
|
|
1947
|
-
* @public
|
|
1948
|
-
*/
|
|
1949
|
-
isFromAutoSnapshot?: boolean | undefined;
|
|
1950
|
-
/**
|
|
1951
|
-
* <p>The size in GB of the SSD.</p>
|
|
1952
|
-
* @public
|
|
1953
|
-
*/
|
|
1954
|
-
sizeInGb?: number | undefined;
|
|
1955
|
-
}
|
|
1956
|
-
/**
|
|
1957
|
-
* @public
|
|
1958
|
-
*/
|
|
1959
|
-
export interface GetInstanceSnapshotResult {
|
|
1960
|
-
/**
|
|
1961
|
-
* <p>An array of key-value pairs containing information about the results of your get instance
|
|
1962
|
-
* snapshot request.</p>
|
|
1963
|
-
* @public
|
|
1964
|
-
*/
|
|
1965
|
-
instanceSnapshot?: InstanceSnapshot | undefined;
|
|
1966
|
-
}
|
|
1967
|
-
/**
|
|
1968
|
-
* @public
|
|
1969
|
-
*/
|
|
1970
|
-
export interface GetInstanceSnapshotsRequest {
|
|
1971
|
-
/**
|
|
1972
|
-
* <p>The token to advance to the next page of results from your request.</p>
|
|
1973
|
-
* <p>To get a page token, perform an initial <code>GetInstanceSnapshots</code> request. If your
|
|
1974
|
-
* results are paginated, the response will return a next page token that you can specify as the
|
|
1975
|
-
* page token in a subsequent request.</p>
|
|
1976
|
-
* @public
|
|
1977
|
-
*/
|
|
1978
|
-
pageToken?: string | undefined;
|
|
1979
|
-
}
|
|
1980
|
-
/**
|
|
1981
|
-
* @public
|
|
1982
|
-
*/
|
|
1983
|
-
export interface GetInstanceSnapshotsResult {
|
|
1984
|
-
/**
|
|
1985
|
-
* <p>An array of key-value pairs containing information about the results of your get instance
|
|
1986
|
-
* snapshots request.</p>
|
|
1987
|
-
* @public
|
|
1988
|
-
*/
|
|
1989
|
-
instanceSnapshots?: InstanceSnapshot[] | undefined;
|
|
1990
|
-
/**
|
|
1991
|
-
* <p>The token to advance to the next page of results from your request.</p>
|
|
1992
|
-
* <p>A next page token is not returned if there are no more results to display.</p>
|
|
1993
|
-
* <p>To get the next page of results, perform another <code>GetInstanceSnapshots</code> request
|
|
1994
|
-
* and specify the next page token using the <code>pageToken</code> parameter.</p>
|
|
1995
|
-
* @public
|
|
1996
|
-
*/
|
|
1997
|
-
nextPageToken?: string | undefined;
|
|
1998
|
-
}
|
|
1999
|
-
/**
|
|
2000
|
-
* @public
|
|
2001
|
-
*/
|
|
2002
|
-
export interface GetInstanceStateRequest {
|
|
2003
|
-
/**
|
|
2004
|
-
* <p>The name of the instance to get state information about.</p>
|
|
2005
|
-
* @public
|
|
2006
|
-
*/
|
|
2007
|
-
instanceName: string | undefined;
|
|
2008
|
-
}
|
|
2009
|
-
/**
|
|
2010
|
-
* @public
|
|
2011
|
-
*/
|
|
2012
|
-
export interface GetInstanceStateResult {
|
|
2013
|
-
/**
|
|
2014
|
-
* <p>The state of the instance.</p>
|
|
2015
|
-
* @public
|
|
2016
|
-
*/
|
|
2017
|
-
state?: InstanceState | undefined;
|
|
2018
|
-
}
|
|
2019
|
-
/**
|
|
2020
|
-
* @public
|
|
2021
|
-
*/
|
|
2022
|
-
export interface GetKeyPairRequest {
|
|
2023
|
-
/**
|
|
2024
|
-
* <p>The name of the key pair for which you are requesting information.</p>
|
|
2025
|
-
* @public
|
|
2026
|
-
*/
|
|
2027
|
-
keyPairName: string | undefined;
|
|
2028
|
-
}
|
|
2029
|
-
/**
|
|
2030
|
-
* @public
|
|
2031
|
-
*/
|
|
2032
|
-
export interface GetKeyPairResult {
|
|
2033
|
-
/**
|
|
2034
|
-
* <p>An array of key-value pairs containing information about the key pair.</p>
|
|
2035
|
-
* @public
|
|
2036
|
-
*/
|
|
2037
|
-
keyPair?: KeyPair | undefined;
|
|
2038
|
-
}
|
|
2039
|
-
/**
|
|
2040
|
-
* @public
|
|
2041
|
-
*/
|
|
2042
|
-
export interface GetKeyPairsRequest {
|
|
2043
|
-
/**
|
|
2044
|
-
* <p>The token to advance to the next page of results from your request.</p>
|
|
2045
|
-
* <p>To get a page token, perform an initial <code>GetKeyPairs</code> request. If your results
|
|
2046
|
-
* are paginated, the response will return a next page token that you can specify as the page
|
|
2047
|
-
* token in a subsequent request.</p>
|
|
2048
|
-
* @public
|
|
2049
|
-
*/
|
|
2050
|
-
pageToken?: string | undefined;
|
|
2051
|
-
/**
|
|
2052
|
-
* <p>A Boolean value that indicates whether to include the default key pair in the response of
|
|
2053
|
-
* your request.</p>
|
|
2054
|
-
* @public
|
|
2055
|
-
*/
|
|
2056
|
-
includeDefaultKeyPair?: boolean | undefined;
|
|
2057
|
-
}
|
|
2058
|
-
/**
|
|
2059
|
-
* @public
|
|
2060
|
-
*/
|
|
2061
|
-
export interface GetKeyPairsResult {
|
|
2062
|
-
/**
|
|
2063
|
-
* <p>An array of key-value pairs containing information about the key pairs.</p>
|
|
2064
|
-
* @public
|
|
2065
|
-
*/
|
|
2066
|
-
keyPairs?: KeyPair[] | undefined;
|
|
2067
|
-
/**
|
|
2068
|
-
* <p>The token to advance to the next page of results from your request.</p>
|
|
2069
|
-
* <p>A next page token is not returned if there are no more results to display.</p>
|
|
2070
|
-
* <p>To get the next page of results, perform another <code>GetKeyPairs</code> request and
|
|
2071
|
-
* specify the next page token using the <code>pageToken</code> parameter.</p>
|
|
2072
|
-
* @public
|
|
2073
|
-
*/
|
|
2074
|
-
nextPageToken?: string | undefined;
|
|
2075
|
-
}
|
|
2076
|
-
/**
|
|
2077
|
-
* @public
|
|
2078
|
-
*/
|
|
2079
|
-
export interface GetLoadBalancerRequest {
|
|
2080
|
-
/**
|
|
2081
|
-
* <p>The name of the load balancer.</p>
|
|
2082
|
-
* @public
|
|
2083
|
-
*/
|
|
2084
|
-
loadBalancerName: string | undefined;
|
|
2085
|
-
}
|
|
2086
|
-
/**
|
|
2087
|
-
* @public
|
|
2088
|
-
* @enum
|
|
2089
|
-
*/
|
|
2090
|
-
export declare const LoadBalancerAttributeName: {
|
|
2091
|
-
readonly HealthCheckPath: "HealthCheckPath";
|
|
2092
|
-
readonly HttpsRedirectionEnabled: "HttpsRedirectionEnabled";
|
|
2093
|
-
readonly SessionStickinessEnabled: "SessionStickinessEnabled";
|
|
2094
|
-
readonly SessionStickiness_LB_CookieDurationSeconds: "SessionStickiness_LB_CookieDurationSeconds";
|
|
2095
|
-
readonly TlsPolicyName: "TlsPolicyName";
|
|
2096
|
-
};
|
|
2097
|
-
/**
|
|
2098
|
-
* @public
|
|
2099
|
-
*/
|
|
2100
|
-
export type LoadBalancerAttributeName = (typeof LoadBalancerAttributeName)[keyof typeof LoadBalancerAttributeName];
|
|
2101
|
-
/**
|
|
2102
|
-
* @public
|
|
2103
|
-
* @enum
|
|
2104
|
-
*/
|
|
2105
|
-
export declare const InstanceHealthState: {
|
|
2106
|
-
readonly Draining: "draining";
|
|
2107
|
-
readonly Healthy: "healthy";
|
|
2108
|
-
readonly Initial: "initial";
|
|
2109
|
-
readonly Unavailable: "unavailable";
|
|
2110
|
-
readonly Unhealthy: "unhealthy";
|
|
2111
|
-
readonly Unused: "unused";
|
|
2112
|
-
};
|
|
2113
|
-
/**
|
|
2114
|
-
* @public
|
|
2115
|
-
*/
|
|
2116
|
-
export type InstanceHealthState = (typeof InstanceHealthState)[keyof typeof InstanceHealthState];
|
|
2117
|
-
/**
|
|
2118
|
-
* @public
|
|
2119
|
-
* @enum
|
|
2120
|
-
*/
|
|
2121
|
-
export declare const InstanceHealthReason: {
|
|
2122
|
-
readonly InstanceDeregistrationInProgress: "Instance.DeregistrationInProgress";
|
|
2123
|
-
readonly InstanceFailedHealthChecks: "Instance.FailedHealthChecks";
|
|
2124
|
-
readonly InstanceInvalidState: "Instance.InvalidState";
|
|
2125
|
-
readonly InstanceIpUnusable: "Instance.IpUnusable";
|
|
2126
|
-
readonly InstanceNotInUse: "Instance.NotInUse";
|
|
2127
|
-
readonly InstanceNotRegistered: "Instance.NotRegistered";
|
|
2128
|
-
readonly InstanceResponseCodeMismatch: "Instance.ResponseCodeMismatch";
|
|
2129
|
-
readonly InstanceTimeout: "Instance.Timeout";
|
|
2130
|
-
readonly LbInitialHealthChecking: "Lb.InitialHealthChecking";
|
|
2131
|
-
readonly LbInternalError: "Lb.InternalError";
|
|
2132
|
-
readonly LbRegistrationInProgress: "Lb.RegistrationInProgress";
|
|
2133
|
-
};
|
|
2134
|
-
/**
|
|
2135
|
-
* @public
|
|
2136
|
-
*/
|
|
2137
|
-
export type InstanceHealthReason = (typeof InstanceHealthReason)[keyof typeof InstanceHealthReason];
|
|
1
|
+
import { AlarmState, CertificateProvider, ComparisonOperator, ContactMethodVerificationProtocol, ContactProtocol, ContainerServicePowerName, HttpEndpoint, HttpProtocolIpv6, HttpTokens, InstanceHealthReason, InstanceHealthState, IpAddressType, LoadBalancerAttributeName, LoadBalancerMetricName, LoadBalancerProtocol, LoadBalancerState, LoadBalancerTlsCertificateDnsRecordCreationStateCode, LoadBalancerTlsCertificateDomainStatus, LoadBalancerTlsCertificateFailureReason, LoadBalancerTlsCertificateRenewalStatus, LoadBalancerTlsCertificateRevocationReason, LoadBalancerTlsCertificateStatus, MetricName, MetricStatistic, MetricUnit, RegionName, RelationalDatabaseEngine, RelationalDatabaseMetricName, RelationalDatabasePasswordVersion, ResourceBucketAccess, ResourceType, SetupStatus, TreatMissingData, ViewerMinimumTlsProtocolVersionEnum } from "./enums";
|
|
2
|
+
import { AccessRules, AvailabilityZone, Bucket, BucketAccessLogConfig, BucketCorsConfig, CacheBehavior, CacheBehaviorPerPath, CacheSettings, ContainerImage, ContainerService, DomainEntry, InputOrigin, MetricDatapoint, Operation, PortInfo, PrivateRegistryAccessRequest, ResourceLocation, Tag } from "./models_0";
|
|
2138
3
|
/**
|
|
2139
4
|
* <p>Describes information about the health of the instance.</p>
|
|
2140
5
|
* @public
|
|
@@ -2277,33 +142,6 @@ export interface InstanceHealthSummary {
|
|
|
2277
142
|
*/
|
|
2278
143
|
instanceHealthReason?: InstanceHealthReason | undefined;
|
|
2279
144
|
}
|
|
2280
|
-
/**
|
|
2281
|
-
* @public
|
|
2282
|
-
* @enum
|
|
2283
|
-
*/
|
|
2284
|
-
export declare const LoadBalancerProtocol: {
|
|
2285
|
-
readonly HTTP: "HTTP";
|
|
2286
|
-
readonly HTTP_HTTPS: "HTTP_HTTPS";
|
|
2287
|
-
};
|
|
2288
|
-
/**
|
|
2289
|
-
* @public
|
|
2290
|
-
*/
|
|
2291
|
-
export type LoadBalancerProtocol = (typeof LoadBalancerProtocol)[keyof typeof LoadBalancerProtocol];
|
|
2292
|
-
/**
|
|
2293
|
-
* @public
|
|
2294
|
-
* @enum
|
|
2295
|
-
*/
|
|
2296
|
-
export declare const LoadBalancerState: {
|
|
2297
|
-
readonly Active: "active";
|
|
2298
|
-
readonly ActiveImpaired: "active_impaired";
|
|
2299
|
-
readonly Failed: "failed";
|
|
2300
|
-
readonly Provisioning: "provisioning";
|
|
2301
|
-
readonly Unknown: "unknown";
|
|
2302
|
-
};
|
|
2303
|
-
/**
|
|
2304
|
-
* @public
|
|
2305
|
-
*/
|
|
2306
|
-
export type LoadBalancerState = (typeof LoadBalancerState)[keyof typeof LoadBalancerState];
|
|
2307
145
|
/**
|
|
2308
146
|
* <p>Provides a summary of SSL/TLS certificate metadata.</p>
|
|
2309
147
|
* @public
|
|
@@ -2448,28 +286,6 @@ export interface GetLoadBalancerResult {
|
|
|
2448
286
|
*/
|
|
2449
287
|
loadBalancer?: LoadBalancer | undefined;
|
|
2450
288
|
}
|
|
2451
|
-
/**
|
|
2452
|
-
* @public
|
|
2453
|
-
* @enum
|
|
2454
|
-
*/
|
|
2455
|
-
export declare const LoadBalancerMetricName: {
|
|
2456
|
-
readonly ClientTLSNegotiationErrorCount: "ClientTLSNegotiationErrorCount";
|
|
2457
|
-
readonly HTTPCode_Instance_2XX_Count: "HTTPCode_Instance_2XX_Count";
|
|
2458
|
-
readonly HTTPCode_Instance_3XX_Count: "HTTPCode_Instance_3XX_Count";
|
|
2459
|
-
readonly HTTPCode_Instance_4XX_Count: "HTTPCode_Instance_4XX_Count";
|
|
2460
|
-
readonly HTTPCode_Instance_5XX_Count: "HTTPCode_Instance_5XX_Count";
|
|
2461
|
-
readonly HTTPCode_LB_4XX_Count: "HTTPCode_LB_4XX_Count";
|
|
2462
|
-
readonly HTTPCode_LB_5XX_Count: "HTTPCode_LB_5XX_Count";
|
|
2463
|
-
readonly HealthyHostCount: "HealthyHostCount";
|
|
2464
|
-
readonly InstanceResponseTime: "InstanceResponseTime";
|
|
2465
|
-
readonly RejectedConnectionCount: "RejectedConnectionCount";
|
|
2466
|
-
readonly RequestCount: "RequestCount";
|
|
2467
|
-
readonly UnhealthyHostCount: "UnhealthyHostCount";
|
|
2468
|
-
};
|
|
2469
|
-
/**
|
|
2470
|
-
* @public
|
|
2471
|
-
*/
|
|
2472
|
-
export type LoadBalancerMetricName = (typeof LoadBalancerMetricName)[keyof typeof LoadBalancerMetricName];
|
|
2473
289
|
/**
|
|
2474
290
|
* @public
|
|
2475
291
|
*/
|
|
@@ -2766,19 +582,6 @@ export interface GetLoadBalancerTlsCertificatesRequest {
|
|
|
2766
582
|
*/
|
|
2767
583
|
loadBalancerName: string | undefined;
|
|
2768
584
|
}
|
|
2769
|
-
/**
|
|
2770
|
-
* @public
|
|
2771
|
-
* @enum
|
|
2772
|
-
*/
|
|
2773
|
-
export declare const LoadBalancerTlsCertificateDnsRecordCreationStateCode: {
|
|
2774
|
-
readonly Failed: "FAILED";
|
|
2775
|
-
readonly Started: "STARTED";
|
|
2776
|
-
readonly Succeeded: "SUCCEEDED";
|
|
2777
|
-
};
|
|
2778
|
-
/**
|
|
2779
|
-
* @public
|
|
2780
|
-
*/
|
|
2781
|
-
export type LoadBalancerTlsCertificateDnsRecordCreationStateCode = (typeof LoadBalancerTlsCertificateDnsRecordCreationStateCode)[keyof typeof LoadBalancerTlsCertificateDnsRecordCreationStateCode];
|
|
2782
585
|
/**
|
|
2783
586
|
* <p>An object that describes the state of the canonical name (CNAME) records that are
|
|
2784
587
|
* automatically added by Lightsail to the DNS of the domain to validate domain
|
|
@@ -2812,19 +615,6 @@ export interface LoadBalancerTlsCertificateDnsRecordCreationState {
|
|
|
2812
615
|
*/
|
|
2813
616
|
message?: string | undefined;
|
|
2814
617
|
}
|
|
2815
|
-
/**
|
|
2816
|
-
* @public
|
|
2817
|
-
* @enum
|
|
2818
|
-
*/
|
|
2819
|
-
export declare const LoadBalancerTlsCertificateDomainStatus: {
|
|
2820
|
-
readonly Failed: "FAILED";
|
|
2821
|
-
readonly PendingValidation: "PENDING_VALIDATION";
|
|
2822
|
-
readonly Success: "SUCCESS";
|
|
2823
|
-
};
|
|
2824
|
-
/**
|
|
2825
|
-
* @public
|
|
2826
|
-
*/
|
|
2827
|
-
export type LoadBalancerTlsCertificateDomainStatus = (typeof LoadBalancerTlsCertificateDomainStatus)[keyof typeof LoadBalancerTlsCertificateDomainStatus];
|
|
2828
618
|
/**
|
|
2829
619
|
* <p>Describes the validation record of each domain name in the SSL/TLS certificate.</p>
|
|
2830
620
|
* @public
|
|
@@ -2865,21 +655,6 @@ export interface LoadBalancerTlsCertificateDomainValidationRecord {
|
|
|
2865
655
|
*/
|
|
2866
656
|
dnsRecordCreationState?: LoadBalancerTlsCertificateDnsRecordCreationState | undefined;
|
|
2867
657
|
}
|
|
2868
|
-
/**
|
|
2869
|
-
* @public
|
|
2870
|
-
* @enum
|
|
2871
|
-
*/
|
|
2872
|
-
export declare const LoadBalancerTlsCertificateFailureReason: {
|
|
2873
|
-
readonly AdditionalVerificationRequired: "ADDITIONAL_VERIFICATION_REQUIRED";
|
|
2874
|
-
readonly DomainNotAllowed: "DOMAIN_NOT_ALLOWED";
|
|
2875
|
-
readonly InvalidPublicDomain: "INVALID_PUBLIC_DOMAIN";
|
|
2876
|
-
readonly NoAvailableContacts: "NO_AVAILABLE_CONTACTS";
|
|
2877
|
-
readonly Other: "OTHER";
|
|
2878
|
-
};
|
|
2879
|
-
/**
|
|
2880
|
-
* @public
|
|
2881
|
-
*/
|
|
2882
|
-
export type LoadBalancerTlsCertificateFailureReason = (typeof LoadBalancerTlsCertificateFailureReason)[keyof typeof LoadBalancerTlsCertificateFailureReason];
|
|
2883
658
|
/**
|
|
2884
659
|
* <p>Contains information about the domain names on an SSL/TLS certificate that you will use to
|
|
2885
660
|
* validate domain ownership.</p>
|
|
@@ -2897,20 +672,6 @@ export interface LoadBalancerTlsCertificateDomainValidationOption {
|
|
|
2897
672
|
*/
|
|
2898
673
|
validationStatus?: LoadBalancerTlsCertificateDomainStatus | undefined;
|
|
2899
674
|
}
|
|
2900
|
-
/**
|
|
2901
|
-
* @public
|
|
2902
|
-
* @enum
|
|
2903
|
-
*/
|
|
2904
|
-
export declare const LoadBalancerTlsCertificateRenewalStatus: {
|
|
2905
|
-
readonly Failed: "FAILED";
|
|
2906
|
-
readonly PendingAutoRenewal: "PENDING_AUTO_RENEWAL";
|
|
2907
|
-
readonly PendingValidation: "PENDING_VALIDATION";
|
|
2908
|
-
readonly Success: "SUCCESS";
|
|
2909
|
-
};
|
|
2910
|
-
/**
|
|
2911
|
-
* @public
|
|
2912
|
-
*/
|
|
2913
|
-
export type LoadBalancerTlsCertificateRenewalStatus = (typeof LoadBalancerTlsCertificateRenewalStatus)[keyof typeof LoadBalancerTlsCertificateRenewalStatus];
|
|
2914
675
|
/**
|
|
2915
676
|
* <p>Contains information about the status of Lightsail's managed renewal for the
|
|
2916
677
|
* certificate.</p>
|
|
@@ -3007,44 +768,6 @@ export interface LoadBalancerTlsCertificateRenewalSummary {
|
|
|
3007
768
|
*/
|
|
3008
769
|
domainValidationOptions?: LoadBalancerTlsCertificateDomainValidationOption[] | undefined;
|
|
3009
770
|
}
|
|
3010
|
-
/**
|
|
3011
|
-
* @public
|
|
3012
|
-
* @enum
|
|
3013
|
-
*/
|
|
3014
|
-
export declare const LoadBalancerTlsCertificateRevocationReason: {
|
|
3015
|
-
readonly AACompromise: "A_A_COMPROMISE";
|
|
3016
|
-
readonly AffiliationChanged: "AFFILIATION_CHANGED";
|
|
3017
|
-
readonly CaCompromise: "CA_COMPROMISE";
|
|
3018
|
-
readonly CertificateHold: "CERTIFICATE_HOLD";
|
|
3019
|
-
readonly CessationOfOperation: "CESSATION_OF_OPERATION";
|
|
3020
|
-
readonly KeyCompromise: "KEY_COMPROMISE";
|
|
3021
|
-
readonly PrivilegeWithdrawn: "PRIVILEGE_WITHDRAWN";
|
|
3022
|
-
readonly RemoveFromCrl: "REMOVE_FROM_CRL";
|
|
3023
|
-
readonly Superceded: "SUPERCEDED";
|
|
3024
|
-
readonly Unspecified: "UNSPECIFIED";
|
|
3025
|
-
};
|
|
3026
|
-
/**
|
|
3027
|
-
* @public
|
|
3028
|
-
*/
|
|
3029
|
-
export type LoadBalancerTlsCertificateRevocationReason = (typeof LoadBalancerTlsCertificateRevocationReason)[keyof typeof LoadBalancerTlsCertificateRevocationReason];
|
|
3030
|
-
/**
|
|
3031
|
-
* @public
|
|
3032
|
-
* @enum
|
|
3033
|
-
*/
|
|
3034
|
-
export declare const LoadBalancerTlsCertificateStatus: {
|
|
3035
|
-
readonly Expired: "EXPIRED";
|
|
3036
|
-
readonly Failed: "FAILED";
|
|
3037
|
-
readonly Inactive: "INACTIVE";
|
|
3038
|
-
readonly Issued: "ISSUED";
|
|
3039
|
-
readonly PendingValidation: "PENDING_VALIDATION";
|
|
3040
|
-
readonly Revoked: "REVOKED";
|
|
3041
|
-
readonly Unknown: "UNKNOWN";
|
|
3042
|
-
readonly ValidationTimedOut: "VALIDATION_TIMED_OUT";
|
|
3043
|
-
};
|
|
3044
|
-
/**
|
|
3045
|
-
* @public
|
|
3046
|
-
*/
|
|
3047
|
-
export type LoadBalancerTlsCertificateStatus = (typeof LoadBalancerTlsCertificateStatus)[keyof typeof LoadBalancerTlsCertificateStatus];
|
|
3048
771
|
/**
|
|
3049
772
|
* <p>Describes a load balancer SSL/TLS certificate.</p>
|
|
3050
773
|
* <p>TLS is just an updated, more secure version of Secure Socket Layer (SSL).</p>
|
|
@@ -3828,17 +1551,6 @@ export interface GetRelationalDatabaseBlueprintsRequest {
|
|
|
3828
1551
|
*/
|
|
3829
1552
|
pageToken?: string | undefined;
|
|
3830
1553
|
}
|
|
3831
|
-
/**
|
|
3832
|
-
* @public
|
|
3833
|
-
* @enum
|
|
3834
|
-
*/
|
|
3835
|
-
export declare const RelationalDatabaseEngine: {
|
|
3836
|
-
readonly MYSQL: "mysql";
|
|
3837
|
-
};
|
|
3838
|
-
/**
|
|
3839
|
-
* @public
|
|
3840
|
-
*/
|
|
3841
|
-
export type RelationalDatabaseEngine = (typeof RelationalDatabaseEngine)[keyof typeof RelationalDatabaseEngine];
|
|
3842
1554
|
/**
|
|
3843
1555
|
* <p>Describes a database image, or blueprint. A blueprint describes the major engine version
|
|
3844
1556
|
* of a database.</p>
|
|
@@ -4184,19 +1896,6 @@ export interface GetRelationalDatabaseLogStreamsResult {
|
|
|
4184
1896
|
*/
|
|
4185
1897
|
logStreams?: string[] | undefined;
|
|
4186
1898
|
}
|
|
4187
|
-
/**
|
|
4188
|
-
* @public
|
|
4189
|
-
* @enum
|
|
4190
|
-
*/
|
|
4191
|
-
export declare const RelationalDatabasePasswordVersion: {
|
|
4192
|
-
readonly CURRENT: "CURRENT";
|
|
4193
|
-
readonly PENDING: "PENDING";
|
|
4194
|
-
readonly PREVIOUS: "PREVIOUS";
|
|
4195
|
-
};
|
|
4196
|
-
/**
|
|
4197
|
-
* @public
|
|
4198
|
-
*/
|
|
4199
|
-
export type RelationalDatabasePasswordVersion = (typeof RelationalDatabasePasswordVersion)[keyof typeof RelationalDatabasePasswordVersion];
|
|
4200
1899
|
/**
|
|
4201
1900
|
* @public
|
|
4202
1901
|
*/
|
|
@@ -4234,22 +1933,6 @@ export interface GetRelationalDatabaseMasterUserPasswordResult {
|
|
|
4234
1933
|
*/
|
|
4235
1934
|
createdAt?: Date | undefined;
|
|
4236
1935
|
}
|
|
4237
|
-
/**
|
|
4238
|
-
* @public
|
|
4239
|
-
* @enum
|
|
4240
|
-
*/
|
|
4241
|
-
export declare const RelationalDatabaseMetricName: {
|
|
4242
|
-
readonly CPUUtilization: "CPUUtilization";
|
|
4243
|
-
readonly DatabaseConnections: "DatabaseConnections";
|
|
4244
|
-
readonly DiskQueueDepth: "DiskQueueDepth";
|
|
4245
|
-
readonly FreeStorageSpace: "FreeStorageSpace";
|
|
4246
|
-
readonly NetworkReceiveThroughput: "NetworkReceiveThroughput";
|
|
4247
|
-
readonly NetworkTransmitThroughput: "NetworkTransmitThroughput";
|
|
4248
|
-
};
|
|
4249
|
-
/**
|
|
4250
|
-
* @public
|
|
4251
|
-
*/
|
|
4252
|
-
export type RelationalDatabaseMetricName = (typeof RelationalDatabaseMetricName)[keyof typeof RelationalDatabaseMetricName];
|
|
4253
1936
|
/**
|
|
4254
1937
|
* @public
|
|
4255
1938
|
*/
|
|
@@ -4710,19 +2393,6 @@ export interface GetSetupHistoryRequest {
|
|
|
4710
2393
|
*/
|
|
4711
2394
|
pageToken?: string | undefined;
|
|
4712
2395
|
}
|
|
4713
|
-
/**
|
|
4714
|
-
* @public
|
|
4715
|
-
* @enum
|
|
4716
|
-
*/
|
|
4717
|
-
export declare const SetupStatus: {
|
|
4718
|
-
readonly Failed: "failed";
|
|
4719
|
-
readonly InProgress: "inProgress";
|
|
4720
|
-
readonly Succeeded: "succeeded";
|
|
4721
|
-
};
|
|
4722
|
-
/**
|
|
4723
|
-
* @public
|
|
4724
|
-
*/
|
|
4725
|
-
export type SetupStatus = (typeof SetupStatus)[keyof typeof SetupStatus];
|
|
4726
2396
|
/**
|
|
4727
2397
|
* <p>Returns details about the commands that were run.</p>
|
|
4728
2398
|
* @public
|
|
@@ -5493,18 +3163,6 @@ export interface SetIpAddressTypeResult {
|
|
|
5493
3163
|
*/
|
|
5494
3164
|
operations?: Operation[] | undefined;
|
|
5495
3165
|
}
|
|
5496
|
-
/**
|
|
5497
|
-
* @public
|
|
5498
|
-
* @enum
|
|
5499
|
-
*/
|
|
5500
|
-
export declare const ResourceBucketAccess: {
|
|
5501
|
-
readonly Allow: "allow";
|
|
5502
|
-
readonly Deny: "deny";
|
|
5503
|
-
};
|
|
5504
|
-
/**
|
|
5505
|
-
* @public
|
|
5506
|
-
*/
|
|
5507
|
-
export type ResourceBucketAccess = (typeof ResourceBucketAccess)[keyof typeof ResourceBucketAccess];
|
|
5508
3166
|
/**
|
|
5509
3167
|
* @public
|
|
5510
3168
|
*/
|