@aws-sdk/client-elastic-beanstalk 3.379.1 → 3.385.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-types/models/models_0.d.ts +480 -0
- package/package.json +5 -5
|
@@ -6,11 +6,13 @@ import { ElasticBeanstalkServiceException as __BaseException } from "./ElasticBe
|
|
|
6
6
|
*/
|
|
7
7
|
export interface AbortEnvironmentUpdateMessage {
|
|
8
8
|
/**
|
|
9
|
+
* @public
|
|
9
10
|
* <p>This specifies the ID of the environment with the in-progress update that you want to
|
|
10
11
|
* cancel.</p>
|
|
11
12
|
*/
|
|
12
13
|
EnvironmentId?: string;
|
|
13
14
|
/**
|
|
15
|
+
* @public
|
|
14
16
|
* <p>This specifies the name of the environment with the in-progress update that you want to
|
|
15
17
|
* cancel.</p>
|
|
16
18
|
*/
|
|
@@ -76,15 +78,18 @@ export type ActionType = (typeof ActionType)[keyof typeof ActionType];
|
|
|
76
78
|
*/
|
|
77
79
|
export interface MaxAgeRule {
|
|
78
80
|
/**
|
|
81
|
+
* @public
|
|
79
82
|
* <p>Specify <code>true</code> to apply the rule, or <code>false</code> to disable
|
|
80
83
|
* it.</p>
|
|
81
84
|
*/
|
|
82
85
|
Enabled: boolean | undefined;
|
|
83
86
|
/**
|
|
87
|
+
* @public
|
|
84
88
|
* <p>Specify the number of days to retain an application versions.</p>
|
|
85
89
|
*/
|
|
86
90
|
MaxAgeInDays?: number;
|
|
87
91
|
/**
|
|
92
|
+
* @public
|
|
88
93
|
* <p>Set to <code>true</code> to delete a version's source bundle from Amazon S3 when
|
|
89
94
|
* Elastic Beanstalk deletes the application version.</p>
|
|
90
95
|
*/
|
|
@@ -97,15 +102,18 @@ export interface MaxAgeRule {
|
|
|
97
102
|
*/
|
|
98
103
|
export interface MaxCountRule {
|
|
99
104
|
/**
|
|
105
|
+
* @public
|
|
100
106
|
* <p>Specify <code>true</code> to apply the rule, or <code>false</code> to disable
|
|
101
107
|
* it.</p>
|
|
102
108
|
*/
|
|
103
109
|
Enabled: boolean | undefined;
|
|
104
110
|
/**
|
|
111
|
+
* @public
|
|
105
112
|
* <p>Specify the maximum number of application versions to retain.</p>
|
|
106
113
|
*/
|
|
107
114
|
MaxCount?: number;
|
|
108
115
|
/**
|
|
116
|
+
* @public
|
|
109
117
|
* <p>Set to <code>true</code> to delete a version's source bundle from Amazon S3 when
|
|
110
118
|
* Elastic Beanstalk deletes the application version.</p>
|
|
111
119
|
*/
|
|
@@ -122,11 +130,13 @@ export interface MaxCountRule {
|
|
|
122
130
|
*/
|
|
123
131
|
export interface ApplicationVersionLifecycleConfig {
|
|
124
132
|
/**
|
|
133
|
+
* @public
|
|
125
134
|
* <p>Specify a max count rule to restrict the number of application versions that are
|
|
126
135
|
* retained for an application.</p>
|
|
127
136
|
*/
|
|
128
137
|
MaxCountRule?: MaxCountRule;
|
|
129
138
|
/**
|
|
139
|
+
* @public
|
|
130
140
|
* <p>Specify a max age rule to restrict the length of time that application versions are
|
|
131
141
|
* retained for an application.</p>
|
|
132
142
|
*/
|
|
@@ -141,6 +151,7 @@ export interface ApplicationVersionLifecycleConfig {
|
|
|
141
151
|
*/
|
|
142
152
|
export interface ApplicationResourceLifecycleConfig {
|
|
143
153
|
/**
|
|
154
|
+
* @public
|
|
144
155
|
* <p>The ARN of an IAM service role that Elastic Beanstalk has permission to
|
|
145
156
|
* assume.</p>
|
|
146
157
|
* <p>The <code>ServiceRole</code> property is required the first time that you provide a
|
|
@@ -153,6 +164,7 @@ export interface ApplicationResourceLifecycleConfig {
|
|
|
153
164
|
*/
|
|
154
165
|
ServiceRole?: string;
|
|
155
166
|
/**
|
|
167
|
+
* @public
|
|
156
168
|
* <p>Defines lifecycle settings for application versions.</p>
|
|
157
169
|
*/
|
|
158
170
|
VersionLifecycleConfig?: ApplicationVersionLifecycleConfig;
|
|
@@ -163,34 +175,42 @@ export interface ApplicationResourceLifecycleConfig {
|
|
|
163
175
|
*/
|
|
164
176
|
export interface ApplicationDescription {
|
|
165
177
|
/**
|
|
178
|
+
* @public
|
|
166
179
|
* <p>The Amazon Resource Name (ARN) of the application.</p>
|
|
167
180
|
*/
|
|
168
181
|
ApplicationArn?: string;
|
|
169
182
|
/**
|
|
183
|
+
* @public
|
|
170
184
|
* <p>The name of the application.</p>
|
|
171
185
|
*/
|
|
172
186
|
ApplicationName?: string;
|
|
173
187
|
/**
|
|
188
|
+
* @public
|
|
174
189
|
* <p>User-defined description of the application.</p>
|
|
175
190
|
*/
|
|
176
191
|
Description?: string;
|
|
177
192
|
/**
|
|
193
|
+
* @public
|
|
178
194
|
* <p>The date when the application was created.</p>
|
|
179
195
|
*/
|
|
180
196
|
DateCreated?: Date;
|
|
181
197
|
/**
|
|
198
|
+
* @public
|
|
182
199
|
* <p>The date when the application was last modified.</p>
|
|
183
200
|
*/
|
|
184
201
|
DateUpdated?: Date;
|
|
185
202
|
/**
|
|
203
|
+
* @public
|
|
186
204
|
* <p>The names of the versions for this application.</p>
|
|
187
205
|
*/
|
|
188
206
|
Versions?: string[];
|
|
189
207
|
/**
|
|
208
|
+
* @public
|
|
190
209
|
* <p>The names of the configuration templates associated with this application.</p>
|
|
191
210
|
*/
|
|
192
211
|
ConfigurationTemplates?: string[];
|
|
193
212
|
/**
|
|
213
|
+
* @public
|
|
194
214
|
* <p>The lifecycle settings for the application.</p>
|
|
195
215
|
*/
|
|
196
216
|
ResourceLifecycleConfig?: ApplicationResourceLifecycleConfig;
|
|
@@ -201,6 +221,7 @@ export interface ApplicationDescription {
|
|
|
201
221
|
*/
|
|
202
222
|
export interface ApplicationDescriptionMessage {
|
|
203
223
|
/**
|
|
224
|
+
* @public
|
|
204
225
|
* <p> The <a>ApplicationDescription</a> of the application. </p>
|
|
205
226
|
*/
|
|
206
227
|
Application?: ApplicationDescription;
|
|
@@ -211,6 +232,7 @@ export interface ApplicationDescriptionMessage {
|
|
|
211
232
|
*/
|
|
212
233
|
export interface ApplicationDescriptionsMessage {
|
|
213
234
|
/**
|
|
235
|
+
* @public
|
|
214
236
|
* <p>This parameter contains a list of <a>ApplicationDescription</a>.</p>
|
|
215
237
|
*/
|
|
216
238
|
Applications?: ApplicationDescription[];
|
|
@@ -222,41 +244,49 @@ export interface ApplicationDescriptionsMessage {
|
|
|
222
244
|
*/
|
|
223
245
|
export interface Latency {
|
|
224
246
|
/**
|
|
247
|
+
* @public
|
|
225
248
|
* <p>The average latency for the slowest 0.1 percent of requests over the last 10
|
|
226
249
|
* seconds.</p>
|
|
227
250
|
*/
|
|
228
251
|
P999?: number;
|
|
229
252
|
/**
|
|
253
|
+
* @public
|
|
230
254
|
* <p>The average latency for the slowest 1 percent of requests over the last 10
|
|
231
255
|
* seconds.</p>
|
|
232
256
|
*/
|
|
233
257
|
P99?: number;
|
|
234
258
|
/**
|
|
259
|
+
* @public
|
|
235
260
|
* <p>The average latency for the slowest 5 percent of requests over the last 10
|
|
236
261
|
* seconds.</p>
|
|
237
262
|
*/
|
|
238
263
|
P95?: number;
|
|
239
264
|
/**
|
|
265
|
+
* @public
|
|
240
266
|
* <p>The average latency for the slowest 10 percent of requests over the last 10
|
|
241
267
|
* seconds.</p>
|
|
242
268
|
*/
|
|
243
269
|
P90?: number;
|
|
244
270
|
/**
|
|
271
|
+
* @public
|
|
245
272
|
* <p>The average latency for the slowest 15 percent of requests over the last 10
|
|
246
273
|
* seconds.</p>
|
|
247
274
|
*/
|
|
248
275
|
P85?: number;
|
|
249
276
|
/**
|
|
277
|
+
* @public
|
|
250
278
|
* <p>The average latency for the slowest 25 percent of requests over the last 10
|
|
251
279
|
* seconds.</p>
|
|
252
280
|
*/
|
|
253
281
|
P75?: number;
|
|
254
282
|
/**
|
|
283
|
+
* @public
|
|
255
284
|
* <p>The average latency for the slowest 50 percent of requests over the last 10
|
|
256
285
|
* seconds.</p>
|
|
257
286
|
*/
|
|
258
287
|
P50?: number;
|
|
259
288
|
/**
|
|
289
|
+
* @public
|
|
260
290
|
* <p>The average latency for the slowest 90 percent of requests over the last 10
|
|
261
291
|
* seconds.</p>
|
|
262
292
|
*/
|
|
@@ -270,21 +300,25 @@ export interface Latency {
|
|
|
270
300
|
*/
|
|
271
301
|
export interface StatusCodes {
|
|
272
302
|
/**
|
|
303
|
+
* @public
|
|
273
304
|
* <p>The percentage of requests over the last 10 seconds that resulted in a 2xx (200, 201,
|
|
274
305
|
* etc.) status code.</p>
|
|
275
306
|
*/
|
|
276
307
|
Status2xx?: number;
|
|
277
308
|
/**
|
|
309
|
+
* @public
|
|
278
310
|
* <p>The percentage of requests over the last 10 seconds that resulted in a 3xx (300, 301,
|
|
279
311
|
* etc.) status code.</p>
|
|
280
312
|
*/
|
|
281
313
|
Status3xx?: number;
|
|
282
314
|
/**
|
|
315
|
+
* @public
|
|
283
316
|
* <p>The percentage of requests over the last 10 seconds that resulted in a 4xx (400, 401,
|
|
284
317
|
* etc.) status code.</p>
|
|
285
318
|
*/
|
|
286
319
|
Status4xx?: number;
|
|
287
320
|
/**
|
|
321
|
+
* @public
|
|
288
322
|
* <p>The percentage of requests over the last 10 seconds that resulted in a 5xx (500, 501,
|
|
289
323
|
* etc.) status code.</p>
|
|
290
324
|
*/
|
|
@@ -296,22 +330,26 @@ export interface StatusCodes {
|
|
|
296
330
|
*/
|
|
297
331
|
export interface ApplicationMetrics {
|
|
298
332
|
/**
|
|
333
|
+
* @public
|
|
299
334
|
* <p>The amount of time that the metrics cover (usually 10 seconds). For example, you might
|
|
300
335
|
* have 5 requests (<code>request_count</code>) within the most recent time slice of 10 seconds
|
|
301
336
|
* (<code>duration</code>).</p>
|
|
302
337
|
*/
|
|
303
338
|
Duration?: number;
|
|
304
339
|
/**
|
|
340
|
+
* @public
|
|
305
341
|
* <p>Average number of requests handled by the web server per second over the last 10
|
|
306
342
|
* seconds.</p>
|
|
307
343
|
*/
|
|
308
344
|
RequestCount?: number;
|
|
309
345
|
/**
|
|
346
|
+
* @public
|
|
310
347
|
* <p>Represents the percentage of requests over the last 10 seconds that resulted in each
|
|
311
348
|
* type of status code response.</p>
|
|
312
349
|
*/
|
|
313
350
|
StatusCodes?: StatusCodes;
|
|
314
351
|
/**
|
|
352
|
+
* @public
|
|
315
353
|
* <p>Represents the average latency for the slowest X percent of requests over the last 10
|
|
316
354
|
* seconds. Latencies are in seconds with one millisecond resolution.</p>
|
|
317
355
|
*/
|
|
@@ -322,10 +360,12 @@ export interface ApplicationMetrics {
|
|
|
322
360
|
*/
|
|
323
361
|
export interface ApplicationResourceLifecycleDescriptionMessage {
|
|
324
362
|
/**
|
|
363
|
+
* @public
|
|
325
364
|
* <p>The name of the application.</p>
|
|
326
365
|
*/
|
|
327
366
|
ApplicationName?: string;
|
|
328
367
|
/**
|
|
368
|
+
* @public
|
|
329
369
|
* <p>The lifecycle configuration.</p>
|
|
330
370
|
*/
|
|
331
371
|
ResourceLifecycleConfig?: ApplicationResourceLifecycleConfig;
|
|
@@ -360,6 +400,7 @@ export type SourceType = (typeof SourceType)[keyof typeof SourceType];
|
|
|
360
400
|
*/
|
|
361
401
|
export interface SourceBuildInformation {
|
|
362
402
|
/**
|
|
403
|
+
* @public
|
|
363
404
|
* <p>The type of repository.</p>
|
|
364
405
|
* <ul>
|
|
365
406
|
* <li>
|
|
@@ -376,6 +417,7 @@ export interface SourceBuildInformation {
|
|
|
376
417
|
*/
|
|
377
418
|
SourceType: SourceType | string | undefined;
|
|
378
419
|
/**
|
|
420
|
+
* @public
|
|
379
421
|
* <p>Location where the repository is stored.</p>
|
|
380
422
|
* <ul>
|
|
381
423
|
* <li>
|
|
@@ -392,6 +434,7 @@ export interface SourceBuildInformation {
|
|
|
392
434
|
*/
|
|
393
435
|
SourceRepository: SourceRepository | string | undefined;
|
|
394
436
|
/**
|
|
437
|
+
* @public
|
|
395
438
|
* <p>The location of the source code, as a formatted string, depending on the value of <code>SourceRepository</code>
|
|
396
439
|
* </p>
|
|
397
440
|
* <ul>
|
|
@@ -417,10 +460,12 @@ export interface SourceBuildInformation {
|
|
|
417
460
|
*/
|
|
418
461
|
export interface S3Location {
|
|
419
462
|
/**
|
|
463
|
+
* @public
|
|
420
464
|
* <p>The Amazon S3 bucket where the data is located.</p>
|
|
421
465
|
*/
|
|
422
466
|
S3Bucket?: string;
|
|
423
467
|
/**
|
|
468
|
+
* @public
|
|
424
469
|
* <p>The Amazon S3 key where the data is located.</p>
|
|
425
470
|
*/
|
|
426
471
|
S3Key?: string;
|
|
@@ -446,43 +491,53 @@ export type ApplicationVersionStatus = (typeof ApplicationVersionStatus)[keyof t
|
|
|
446
491
|
*/
|
|
447
492
|
export interface ApplicationVersionDescription {
|
|
448
493
|
/**
|
|
494
|
+
* @public
|
|
449
495
|
* <p>The Amazon Resource Name (ARN) of the application version.</p>
|
|
450
496
|
*/
|
|
451
497
|
ApplicationVersionArn?: string;
|
|
452
498
|
/**
|
|
499
|
+
* @public
|
|
453
500
|
* <p>The name of the application to which the application version belongs.</p>
|
|
454
501
|
*/
|
|
455
502
|
ApplicationName?: string;
|
|
456
503
|
/**
|
|
504
|
+
* @public
|
|
457
505
|
* <p>The description of the application version.</p>
|
|
458
506
|
*/
|
|
459
507
|
Description?: string;
|
|
460
508
|
/**
|
|
509
|
+
* @public
|
|
461
510
|
* <p>A unique identifier for the application version.</p>
|
|
462
511
|
*/
|
|
463
512
|
VersionLabel?: string;
|
|
464
513
|
/**
|
|
514
|
+
* @public
|
|
465
515
|
* <p>If the version's source code was retrieved from AWS CodeCommit, the location of the
|
|
466
516
|
* source code for the application version.</p>
|
|
467
517
|
*/
|
|
468
518
|
SourceBuildInformation?: SourceBuildInformation;
|
|
469
519
|
/**
|
|
520
|
+
* @public
|
|
470
521
|
* <p>Reference to the artifact from the AWS CodeBuild build.</p>
|
|
471
522
|
*/
|
|
472
523
|
BuildArn?: string;
|
|
473
524
|
/**
|
|
525
|
+
* @public
|
|
474
526
|
* <p>The storage location of the application version's source bundle in Amazon S3.</p>
|
|
475
527
|
*/
|
|
476
528
|
SourceBundle?: S3Location;
|
|
477
529
|
/**
|
|
530
|
+
* @public
|
|
478
531
|
* <p>The creation date of the application version.</p>
|
|
479
532
|
*/
|
|
480
533
|
DateCreated?: Date;
|
|
481
534
|
/**
|
|
535
|
+
* @public
|
|
482
536
|
* <p>The last modified date of the application version.</p>
|
|
483
537
|
*/
|
|
484
538
|
DateUpdated?: Date;
|
|
485
539
|
/**
|
|
540
|
+
* @public
|
|
486
541
|
* <p>The processing status of the application version. Reflects the state of the application
|
|
487
542
|
* version during its creation. Many of the values are only applicable if you specified
|
|
488
543
|
* <code>True</code> for the <code>Process</code> parameter of the
|
|
@@ -522,6 +577,7 @@ export interface ApplicationVersionDescription {
|
|
|
522
577
|
*/
|
|
523
578
|
export interface ApplicationVersionDescriptionMessage {
|
|
524
579
|
/**
|
|
580
|
+
* @public
|
|
525
581
|
* <p> The <a>ApplicationVersionDescription</a> of the application version.
|
|
526
582
|
* </p>
|
|
527
583
|
*/
|
|
@@ -533,11 +589,13 @@ export interface ApplicationVersionDescriptionMessage {
|
|
|
533
589
|
*/
|
|
534
590
|
export interface ApplicationVersionDescriptionsMessage {
|
|
535
591
|
/**
|
|
592
|
+
* @public
|
|
536
593
|
* <p>List of <code>ApplicationVersionDescription</code> objects sorted in order of
|
|
537
594
|
* creation.</p>
|
|
538
595
|
*/
|
|
539
596
|
ApplicationVersions?: ApplicationVersionDescription[];
|
|
540
597
|
/**
|
|
598
|
+
* @public
|
|
541
599
|
* <p>In a paginated request, the token that you can pass in a subsequent request to get the
|
|
542
600
|
* next response page.</p>
|
|
543
601
|
*/
|
|
@@ -549,14 +607,17 @@ export interface ApplicationVersionDescriptionsMessage {
|
|
|
549
607
|
*/
|
|
550
608
|
export interface ApplyEnvironmentManagedActionRequest {
|
|
551
609
|
/**
|
|
610
|
+
* @public
|
|
552
611
|
* <p>The name of the target environment.</p>
|
|
553
612
|
*/
|
|
554
613
|
EnvironmentName?: string;
|
|
555
614
|
/**
|
|
615
|
+
* @public
|
|
556
616
|
* <p>The environment ID of the target environment.</p>
|
|
557
617
|
*/
|
|
558
618
|
EnvironmentId?: string;
|
|
559
619
|
/**
|
|
620
|
+
* @public
|
|
560
621
|
* <p>The action ID of the scheduled managed action to execute.</p>
|
|
561
622
|
*/
|
|
562
623
|
ActionId: string | undefined;
|
|
@@ -567,18 +628,22 @@ export interface ApplyEnvironmentManagedActionRequest {
|
|
|
567
628
|
*/
|
|
568
629
|
export interface ApplyEnvironmentManagedActionResult {
|
|
569
630
|
/**
|
|
631
|
+
* @public
|
|
570
632
|
* <p>The action ID of the managed action.</p>
|
|
571
633
|
*/
|
|
572
634
|
ActionId?: string;
|
|
573
635
|
/**
|
|
636
|
+
* @public
|
|
574
637
|
* <p>A description of the managed action.</p>
|
|
575
638
|
*/
|
|
576
639
|
ActionDescription?: string;
|
|
577
640
|
/**
|
|
641
|
+
* @public
|
|
578
642
|
* <p>The type of managed action.</p>
|
|
579
643
|
*/
|
|
580
644
|
ActionType?: ActionType | string;
|
|
581
645
|
/**
|
|
646
|
+
* @public
|
|
582
647
|
* <p>The status of the managed action.</p>
|
|
583
648
|
*/
|
|
584
649
|
Status?: string;
|
|
@@ -613,10 +678,12 @@ export declare class ManagedActionInvalidStateException extends __BaseException
|
|
|
613
678
|
*/
|
|
614
679
|
export interface AssociateEnvironmentOperationsRoleMessage {
|
|
615
680
|
/**
|
|
681
|
+
* @public
|
|
616
682
|
* <p>The name of the environment to which to set the operations role.</p>
|
|
617
683
|
*/
|
|
618
684
|
EnvironmentName: string | undefined;
|
|
619
685
|
/**
|
|
686
|
+
* @public
|
|
620
687
|
* <p>The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's
|
|
621
688
|
* operations role.</p>
|
|
622
689
|
*/
|
|
@@ -628,6 +695,7 @@ export interface AssociateEnvironmentOperationsRoleMessage {
|
|
|
628
695
|
*/
|
|
629
696
|
export interface AutoScalingGroup {
|
|
630
697
|
/**
|
|
698
|
+
* @public
|
|
631
699
|
* <p>The name of the <code>AutoScalingGroup</code> . </p>
|
|
632
700
|
*/
|
|
633
701
|
Name?: string;
|
|
@@ -638,10 +706,12 @@ export interface AutoScalingGroup {
|
|
|
638
706
|
*/
|
|
639
707
|
export interface SolutionStackDescription {
|
|
640
708
|
/**
|
|
709
|
+
* @public
|
|
641
710
|
* <p>The name of the solution stack.</p>
|
|
642
711
|
*/
|
|
643
712
|
SolutionStackName?: string;
|
|
644
713
|
/**
|
|
714
|
+
* @public
|
|
645
715
|
* <p>The permitted file types allowed for a solution stack.</p>
|
|
646
716
|
*/
|
|
647
717
|
PermittedFileTypes?: string[];
|
|
@@ -652,6 +722,7 @@ export interface SolutionStackDescription {
|
|
|
652
722
|
*/
|
|
653
723
|
export interface CheckDNSAvailabilityMessage {
|
|
654
724
|
/**
|
|
725
|
+
* @public
|
|
655
726
|
* <p>The prefix used when this CNAME is reserved.</p>
|
|
656
727
|
*/
|
|
657
728
|
CNAMEPrefix: string | undefined;
|
|
@@ -662,6 +733,7 @@ export interface CheckDNSAvailabilityMessage {
|
|
|
662
733
|
*/
|
|
663
734
|
export interface CheckDNSAvailabilityResultMessage {
|
|
664
735
|
/**
|
|
736
|
+
* @public
|
|
665
737
|
* <p>Indicates if the specified CNAME is available:</p>
|
|
666
738
|
* <ul>
|
|
667
739
|
* <li>
|
|
@@ -676,6 +748,7 @@ export interface CheckDNSAvailabilityResultMessage {
|
|
|
676
748
|
*/
|
|
677
749
|
Available?: boolean;
|
|
678
750
|
/**
|
|
751
|
+
* @public
|
|
679
752
|
* <p>The fully qualified CNAME to reserve when <a>CreateEnvironment</a> is called
|
|
680
753
|
* with the provided prefix.</p>
|
|
681
754
|
*/
|
|
@@ -687,10 +760,12 @@ export interface CheckDNSAvailabilityResultMessage {
|
|
|
687
760
|
*/
|
|
688
761
|
export interface ComposeEnvironmentsMessage {
|
|
689
762
|
/**
|
|
763
|
+
* @public
|
|
690
764
|
* <p>The name of the application to which the specified source bundles belong.</p>
|
|
691
765
|
*/
|
|
692
766
|
ApplicationName?: string;
|
|
693
767
|
/**
|
|
768
|
+
* @public
|
|
694
769
|
* <p>The name of the group to which the target environments belong. Specify a group name
|
|
695
770
|
* only if the environment name defined in each target environment's manifest ends with a +
|
|
696
771
|
* (plus) character. See <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-manifest.html">Environment Manifest
|
|
@@ -698,6 +773,7 @@ export interface ComposeEnvironmentsMessage {
|
|
|
698
773
|
*/
|
|
699
774
|
GroupName?: string;
|
|
700
775
|
/**
|
|
776
|
+
* @public
|
|
701
777
|
* <p>A list of version labels, specifying one or more application source bundles that belong
|
|
702
778
|
* to the target application. Each source bundle must include an environment manifest that
|
|
703
779
|
* specifies the name of the environment and the name of the solution stack to use, and
|
|
@@ -714,10 +790,12 @@ export interface ComposeEnvironmentsMessage {
|
|
|
714
790
|
*/
|
|
715
791
|
export interface EnvironmentLink {
|
|
716
792
|
/**
|
|
793
|
+
* @public
|
|
717
794
|
* <p>The name of the link.</p>
|
|
718
795
|
*/
|
|
719
796
|
LinkName?: string;
|
|
720
797
|
/**
|
|
798
|
+
* @public
|
|
721
799
|
* <p>The name of the linked environment (the dependency).</p>
|
|
722
800
|
*/
|
|
723
801
|
EnvironmentName?: string;
|
|
@@ -761,10 +839,12 @@ export type EnvironmentHealthStatus = (typeof EnvironmentHealthStatus)[keyof typ
|
|
|
761
839
|
*/
|
|
762
840
|
export interface Listener {
|
|
763
841
|
/**
|
|
842
|
+
* @public
|
|
764
843
|
* <p>The protocol that is used by the Listener.</p>
|
|
765
844
|
*/
|
|
766
845
|
Protocol?: string;
|
|
767
846
|
/**
|
|
847
|
+
* @public
|
|
768
848
|
* <p>The port that is used by the Listener.</p>
|
|
769
849
|
*/
|
|
770
850
|
Port?: number;
|
|
@@ -775,14 +855,17 @@ export interface Listener {
|
|
|
775
855
|
*/
|
|
776
856
|
export interface LoadBalancerDescription {
|
|
777
857
|
/**
|
|
858
|
+
* @public
|
|
778
859
|
* <p>The name of the LoadBalancer.</p>
|
|
779
860
|
*/
|
|
780
861
|
LoadBalancerName?: string;
|
|
781
862
|
/**
|
|
863
|
+
* @public
|
|
782
864
|
* <p>The domain name of the LoadBalancer.</p>
|
|
783
865
|
*/
|
|
784
866
|
Domain?: string;
|
|
785
867
|
/**
|
|
868
|
+
* @public
|
|
786
869
|
* <p>A list of Listeners used by the LoadBalancer.</p>
|
|
787
870
|
*/
|
|
788
871
|
Listeners?: Listener[];
|
|
@@ -794,6 +877,7 @@ export interface LoadBalancerDescription {
|
|
|
794
877
|
*/
|
|
795
878
|
export interface EnvironmentResourcesDescription {
|
|
796
879
|
/**
|
|
880
|
+
* @public
|
|
797
881
|
* <p>Describes the LoadBalancer.</p>
|
|
798
882
|
*/
|
|
799
883
|
LoadBalancer?: LoadBalancerDescription;
|
|
@@ -822,6 +906,7 @@ export type EnvironmentStatus = (typeof EnvironmentStatus)[keyof typeof Environm
|
|
|
822
906
|
*/
|
|
823
907
|
export interface EnvironmentTier {
|
|
824
908
|
/**
|
|
909
|
+
* @public
|
|
825
910
|
* <p>The name of this environment tier.</p>
|
|
826
911
|
* <p>Valid values:</p>
|
|
827
912
|
* <ul>
|
|
@@ -837,6 +922,7 @@ export interface EnvironmentTier {
|
|
|
837
922
|
*/
|
|
838
923
|
Name?: string;
|
|
839
924
|
/**
|
|
925
|
+
* @public
|
|
840
926
|
* <p>The type of this environment tier.</p>
|
|
841
927
|
* <p>Valid values:</p>
|
|
842
928
|
* <ul>
|
|
@@ -852,6 +938,7 @@ export interface EnvironmentTier {
|
|
|
852
938
|
*/
|
|
853
939
|
Type?: string;
|
|
854
940
|
/**
|
|
941
|
+
* @public
|
|
855
942
|
* <p>The version of this environment tier. When you don't set a value to it, Elastic Beanstalk uses the
|
|
856
943
|
* latest compatible worker tier version.</p>
|
|
857
944
|
* <note>
|
|
@@ -867,56 +954,69 @@ export interface EnvironmentTier {
|
|
|
867
954
|
*/
|
|
868
955
|
export interface EnvironmentDescription {
|
|
869
956
|
/**
|
|
957
|
+
* @public
|
|
870
958
|
* <p>The name of this environment.</p>
|
|
871
959
|
*/
|
|
872
960
|
EnvironmentName?: string;
|
|
873
961
|
/**
|
|
962
|
+
* @public
|
|
874
963
|
* <p>The ID of this environment.</p>
|
|
875
964
|
*/
|
|
876
965
|
EnvironmentId?: string;
|
|
877
966
|
/**
|
|
967
|
+
* @public
|
|
878
968
|
* <p>The name of the application associated with this environment.</p>
|
|
879
969
|
*/
|
|
880
970
|
ApplicationName?: string;
|
|
881
971
|
/**
|
|
972
|
+
* @public
|
|
882
973
|
* <p>The application version deployed in this environment.</p>
|
|
883
974
|
*/
|
|
884
975
|
VersionLabel?: string;
|
|
885
976
|
/**
|
|
977
|
+
* @public
|
|
886
978
|
* <p> The name of the <code>SolutionStack</code> deployed with this environment. </p>
|
|
887
979
|
*/
|
|
888
980
|
SolutionStackName?: string;
|
|
889
981
|
/**
|
|
982
|
+
* @public
|
|
890
983
|
* <p>The ARN of the platform version.</p>
|
|
891
984
|
*/
|
|
892
985
|
PlatformArn?: string;
|
|
893
986
|
/**
|
|
987
|
+
* @public
|
|
894
988
|
* <p>The name of the configuration template used to originally launch this
|
|
895
989
|
* environment.</p>
|
|
896
990
|
*/
|
|
897
991
|
TemplateName?: string;
|
|
898
992
|
/**
|
|
993
|
+
* @public
|
|
899
994
|
* <p>Describes this environment.</p>
|
|
900
995
|
*/
|
|
901
996
|
Description?: string;
|
|
902
997
|
/**
|
|
998
|
+
* @public
|
|
903
999
|
* <p>For load-balanced, autoscaling environments, the URL to the LoadBalancer. For
|
|
904
1000
|
* single-instance environments, the IP address of the instance.</p>
|
|
905
1001
|
*/
|
|
906
1002
|
EndpointURL?: string;
|
|
907
1003
|
/**
|
|
1004
|
+
* @public
|
|
908
1005
|
* <p>The URL to the CNAME for this environment.</p>
|
|
909
1006
|
*/
|
|
910
1007
|
CNAME?: string;
|
|
911
1008
|
/**
|
|
1009
|
+
* @public
|
|
912
1010
|
* <p>The creation date for this environment.</p>
|
|
913
1011
|
*/
|
|
914
1012
|
DateCreated?: Date;
|
|
915
1013
|
/**
|
|
1014
|
+
* @public
|
|
916
1015
|
* <p>The last modified date for this environment.</p>
|
|
917
1016
|
*/
|
|
918
1017
|
DateUpdated?: Date;
|
|
919
1018
|
/**
|
|
1019
|
+
* @public
|
|
920
1020
|
* <p>The current operational status of the environment:</p>
|
|
921
1021
|
* <ul>
|
|
922
1022
|
* <li>
|
|
@@ -945,6 +1045,7 @@ export interface EnvironmentDescription {
|
|
|
945
1045
|
*/
|
|
946
1046
|
Status?: EnvironmentStatus | string;
|
|
947
1047
|
/**
|
|
1048
|
+
* @public
|
|
948
1049
|
* <p>Indicates if there is an in-progress environment configuration update or application
|
|
949
1050
|
* version deployment that you can cancel.</p>
|
|
950
1051
|
* <p>
|
|
@@ -954,6 +1055,7 @@ export interface EnvironmentDescription {
|
|
|
954
1055
|
*/
|
|
955
1056
|
AbortableOperationInProgress?: boolean;
|
|
956
1057
|
/**
|
|
1058
|
+
* @public
|
|
957
1059
|
* <p>Describes the health status of the environment. AWS Elastic Beanstalk indicates the
|
|
958
1060
|
* failure levels for a running environment:</p>
|
|
959
1061
|
* <ul>
|
|
@@ -983,28 +1085,34 @@ export interface EnvironmentDescription {
|
|
|
983
1085
|
*/
|
|
984
1086
|
Health?: EnvironmentHealth | string;
|
|
985
1087
|
/**
|
|
1088
|
+
* @public
|
|
986
1089
|
* <p>Returns the health status of the application running in your environment. For more
|
|
987
1090
|
* information, see <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html">Health Colors and
|
|
988
1091
|
* Statuses</a>.</p>
|
|
989
1092
|
*/
|
|
990
1093
|
HealthStatus?: EnvironmentHealthStatus | string;
|
|
991
1094
|
/**
|
|
1095
|
+
* @public
|
|
992
1096
|
* <p>The description of the AWS resources used by this environment.</p>
|
|
993
1097
|
*/
|
|
994
1098
|
Resources?: EnvironmentResourcesDescription;
|
|
995
1099
|
/**
|
|
1100
|
+
* @public
|
|
996
1101
|
* <p>Describes the current tier of this environment.</p>
|
|
997
1102
|
*/
|
|
998
1103
|
Tier?: EnvironmentTier;
|
|
999
1104
|
/**
|
|
1105
|
+
* @public
|
|
1000
1106
|
* <p>A list of links to other environments in the same group.</p>
|
|
1001
1107
|
*/
|
|
1002
1108
|
EnvironmentLinks?: EnvironmentLink[];
|
|
1003
1109
|
/**
|
|
1110
|
+
* @public
|
|
1004
1111
|
* <p>The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.</p>
|
|
1005
1112
|
*/
|
|
1006
1113
|
EnvironmentArn?: string;
|
|
1007
1114
|
/**
|
|
1115
|
+
* @public
|
|
1008
1116
|
* <p>The Amazon Resource Name (ARN) of the environment's operations role. For more information,
|
|
1009
1117
|
* see <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/iam-operationsrole.html">Operations roles</a> in the <i>AWS Elastic Beanstalk Developer Guide</i>.</p>
|
|
1010
1118
|
*/
|
|
@@ -1016,10 +1124,12 @@ export interface EnvironmentDescription {
|
|
|
1016
1124
|
*/
|
|
1017
1125
|
export interface EnvironmentDescriptionsMessage {
|
|
1018
1126
|
/**
|
|
1127
|
+
* @public
|
|
1019
1128
|
* <p> Returns an <a>EnvironmentDescription</a> list. </p>
|
|
1020
1129
|
*/
|
|
1021
1130
|
Environments?: EnvironmentDescription[];
|
|
1022
1131
|
/**
|
|
1132
|
+
* @public
|
|
1023
1133
|
* <p>In a paginated request, the token that you can pass in a subsequent request to get the
|
|
1024
1134
|
* next response page.</p>
|
|
1025
1135
|
*/
|
|
@@ -1043,10 +1153,12 @@ export declare class TooManyEnvironmentsException extends __BaseException {
|
|
|
1043
1153
|
*/
|
|
1044
1154
|
export interface Tag {
|
|
1045
1155
|
/**
|
|
1156
|
+
* @public
|
|
1046
1157
|
* <p>The key of the tag.</p>
|
|
1047
1158
|
*/
|
|
1048
1159
|
Key?: string;
|
|
1049
1160
|
/**
|
|
1161
|
+
* @public
|
|
1050
1162
|
* <p>The value of the tag.</p>
|
|
1051
1163
|
*/
|
|
1052
1164
|
Value?: string;
|
|
@@ -1057,19 +1169,23 @@ export interface Tag {
|
|
|
1057
1169
|
*/
|
|
1058
1170
|
export interface CreateApplicationMessage {
|
|
1059
1171
|
/**
|
|
1172
|
+
* @public
|
|
1060
1173
|
* <p>The name of the application. Must be unique within your account.</p>
|
|
1061
1174
|
*/
|
|
1062
1175
|
ApplicationName: string | undefined;
|
|
1063
1176
|
/**
|
|
1177
|
+
* @public
|
|
1064
1178
|
* <p>Your description of the application.</p>
|
|
1065
1179
|
*/
|
|
1066
1180
|
Description?: string;
|
|
1067
1181
|
/**
|
|
1182
|
+
* @public
|
|
1068
1183
|
* <p>Specifies an application resource lifecycle configuration to prevent your application
|
|
1069
1184
|
* from accumulating too many versions.</p>
|
|
1070
1185
|
*/
|
|
1071
1186
|
ResourceLifecycleConfig?: ApplicationResourceLifecycleConfig;
|
|
1072
1187
|
/**
|
|
1188
|
+
* @public
|
|
1073
1189
|
* <p>Specifies the tags applied to the application.</p>
|
|
1074
1190
|
* <p>Elastic Beanstalk applies these tags only to the application. Environments that you create in the
|
|
1075
1191
|
* application don't inherit the tags.</p>
|
|
@@ -1119,6 +1235,7 @@ export type ComputeType = (typeof ComputeType)[keyof typeof ComputeType];
|
|
|
1119
1235
|
*/
|
|
1120
1236
|
export interface BuildConfiguration {
|
|
1121
1237
|
/**
|
|
1238
|
+
* @public
|
|
1122
1239
|
* <p>The name of the artifact of the CodeBuild build.
|
|
1123
1240
|
* If provided, Elastic Beanstalk stores the build artifact in the S3 location
|
|
1124
1241
|
* <i>S3-bucket</i>/resources/<i>application-name</i>/codebuild/codebuild-<i>version-label</i>-<i>artifact-name</i>.zip.
|
|
@@ -1128,10 +1245,12 @@ export interface BuildConfiguration {
|
|
|
1128
1245
|
*/
|
|
1129
1246
|
ArtifactName?: string;
|
|
1130
1247
|
/**
|
|
1248
|
+
* @public
|
|
1131
1249
|
* <p>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.</p>
|
|
1132
1250
|
*/
|
|
1133
1251
|
CodeBuildServiceRole: string | undefined;
|
|
1134
1252
|
/**
|
|
1253
|
+
* @public
|
|
1135
1254
|
* <p>Information about the compute resources the build project will use.</p>
|
|
1136
1255
|
* <ul>
|
|
1137
1256
|
* <li>
|
|
@@ -1153,10 +1272,12 @@ export interface BuildConfiguration {
|
|
|
1153
1272
|
*/
|
|
1154
1273
|
ComputeType?: ComputeType | string;
|
|
1155
1274
|
/**
|
|
1275
|
+
* @public
|
|
1156
1276
|
* <p>The ID of the Docker image to use for this build project.</p>
|
|
1157
1277
|
*/
|
|
1158
1278
|
Image: string | undefined;
|
|
1159
1279
|
/**
|
|
1280
|
+
* @public
|
|
1160
1281
|
* <p>How long in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait until timing out any related build that does not get marked as completed. The default is 60 minutes.</p>
|
|
1161
1282
|
*/
|
|
1162
1283
|
TimeoutInMinutes?: number;
|
|
@@ -1167,12 +1288,14 @@ export interface BuildConfiguration {
|
|
|
1167
1288
|
*/
|
|
1168
1289
|
export interface CreateApplicationVersionMessage {
|
|
1169
1290
|
/**
|
|
1291
|
+
* @public
|
|
1170
1292
|
* <p> The name of the application. If no application is found with this name, and
|
|
1171
1293
|
* <code>AutoCreateApplication</code> is <code>false</code>, returns an
|
|
1172
1294
|
* <code>InvalidParameterValue</code> error. </p>
|
|
1173
1295
|
*/
|
|
1174
1296
|
ApplicationName: string | undefined;
|
|
1175
1297
|
/**
|
|
1298
|
+
* @public
|
|
1176
1299
|
* <p>A label identifying this version.</p>
|
|
1177
1300
|
* <p>Constraint: Must be unique per application. If an application version already exists
|
|
1178
1301
|
* with this label for the specified application, AWS Elastic Beanstalk returns an
|
|
@@ -1180,15 +1303,18 @@ export interface CreateApplicationVersionMessage {
|
|
|
1180
1303
|
*/
|
|
1181
1304
|
VersionLabel: string | undefined;
|
|
1182
1305
|
/**
|
|
1306
|
+
* @public
|
|
1183
1307
|
* <p>A description of this application version.</p>
|
|
1184
1308
|
*/
|
|
1185
1309
|
Description?: string;
|
|
1186
1310
|
/**
|
|
1311
|
+
* @public
|
|
1187
1312
|
* <p>Specify a commit in an AWS CodeCommit Git repository to use as the source code for the
|
|
1188
1313
|
* application version.</p>
|
|
1189
1314
|
*/
|
|
1190
1315
|
SourceBuildInformation?: SourceBuildInformation;
|
|
1191
1316
|
/**
|
|
1317
|
+
* @public
|
|
1192
1318
|
* <p>The Amazon S3 bucket and key that identify the location of the source bundle for this
|
|
1193
1319
|
* version.</p>
|
|
1194
1320
|
* <note>
|
|
@@ -1202,15 +1328,18 @@ export interface CreateApplicationVersionMessage {
|
|
|
1202
1328
|
*/
|
|
1203
1329
|
SourceBundle?: S3Location;
|
|
1204
1330
|
/**
|
|
1331
|
+
* @public
|
|
1205
1332
|
* <p>Settings for an AWS CodeBuild build.</p>
|
|
1206
1333
|
*/
|
|
1207
1334
|
BuildConfiguration?: BuildConfiguration;
|
|
1208
1335
|
/**
|
|
1336
|
+
* @public
|
|
1209
1337
|
* <p>Set to <code>true</code> to create an application with the specified name if it doesn't
|
|
1210
1338
|
* already exist.</p>
|
|
1211
1339
|
*/
|
|
1212
1340
|
AutoCreateApplication?: boolean;
|
|
1213
1341
|
/**
|
|
1342
|
+
* @public
|
|
1214
1343
|
* <p>Pre-processes and validates the environment manifest (<code>env.yaml</code>) and
|
|
1215
1344
|
* configuration files (<code>*.config</code> files in the <code>.ebextensions</code> folder) in
|
|
1216
1345
|
* the source bundle. Validating configuration files can identify issues prior to deploying the
|
|
@@ -1226,6 +1355,7 @@ export interface CreateApplicationVersionMessage {
|
|
|
1226
1355
|
*/
|
|
1227
1356
|
Process?: boolean;
|
|
1228
1357
|
/**
|
|
1358
|
+
* @public
|
|
1229
1359
|
* <p>Specifies the tags applied to the application version.</p>
|
|
1230
1360
|
* <p>Elastic Beanstalk applies these tags only to the application version. Environments that use the
|
|
1231
1361
|
* application version don't inherit the tags.</p>
|
|
@@ -1289,18 +1419,22 @@ export type ConfigurationDeploymentStatus = (typeof ConfigurationDeploymentStatu
|
|
|
1289
1419
|
*/
|
|
1290
1420
|
export interface ConfigurationOptionSetting {
|
|
1291
1421
|
/**
|
|
1422
|
+
* @public
|
|
1292
1423
|
* <p>A unique resource name for the option setting. Use it for a time–based scaling configuration option.</p>
|
|
1293
1424
|
*/
|
|
1294
1425
|
ResourceName?: string;
|
|
1295
1426
|
/**
|
|
1427
|
+
* @public
|
|
1296
1428
|
* <p>A unique namespace that identifies the option's associated AWS resource.</p>
|
|
1297
1429
|
*/
|
|
1298
1430
|
Namespace?: string;
|
|
1299
1431
|
/**
|
|
1432
|
+
* @public
|
|
1300
1433
|
* <p>The name of the configuration option.</p>
|
|
1301
1434
|
*/
|
|
1302
1435
|
OptionName?: string;
|
|
1303
1436
|
/**
|
|
1437
|
+
* @public
|
|
1304
1438
|
* <p>The current value for the configuration option.</p>
|
|
1305
1439
|
*/
|
|
1306
1440
|
Value?: string;
|
|
@@ -1311,32 +1445,39 @@ export interface ConfigurationOptionSetting {
|
|
|
1311
1445
|
*/
|
|
1312
1446
|
export interface ConfigurationSettingsDescription {
|
|
1313
1447
|
/**
|
|
1448
|
+
* @public
|
|
1314
1449
|
* <p>The name of the solution stack this configuration set uses.</p>
|
|
1315
1450
|
*/
|
|
1316
1451
|
SolutionStackName?: string;
|
|
1317
1452
|
/**
|
|
1453
|
+
* @public
|
|
1318
1454
|
* <p>The ARN of the platform version.</p>
|
|
1319
1455
|
*/
|
|
1320
1456
|
PlatformArn?: string;
|
|
1321
1457
|
/**
|
|
1458
|
+
* @public
|
|
1322
1459
|
* <p>The name of the application associated with this configuration set.</p>
|
|
1323
1460
|
*/
|
|
1324
1461
|
ApplicationName?: string;
|
|
1325
1462
|
/**
|
|
1463
|
+
* @public
|
|
1326
1464
|
* <p> If not <code>null</code>, the name of the configuration template for this
|
|
1327
1465
|
* configuration set. </p>
|
|
1328
1466
|
*/
|
|
1329
1467
|
TemplateName?: string;
|
|
1330
1468
|
/**
|
|
1469
|
+
* @public
|
|
1331
1470
|
* <p>Describes this configuration set.</p>
|
|
1332
1471
|
*/
|
|
1333
1472
|
Description?: string;
|
|
1334
1473
|
/**
|
|
1474
|
+
* @public
|
|
1335
1475
|
* <p> If not <code>null</code>, the name of the environment for this configuration set.
|
|
1336
1476
|
* </p>
|
|
1337
1477
|
*/
|
|
1338
1478
|
EnvironmentName?: string;
|
|
1339
1479
|
/**
|
|
1480
|
+
* @public
|
|
1340
1481
|
* <p> If this configuration set is associated with an environment, the
|
|
1341
1482
|
* <code>DeploymentStatus</code> parameter indicates the deployment status of this
|
|
1342
1483
|
* configuration set: </p>
|
|
@@ -1365,14 +1506,17 @@ export interface ConfigurationSettingsDescription {
|
|
|
1365
1506
|
*/
|
|
1366
1507
|
DeploymentStatus?: ConfigurationDeploymentStatus | string;
|
|
1367
1508
|
/**
|
|
1509
|
+
* @public
|
|
1368
1510
|
* <p>The date (in UTC time) when this configuration set was created.</p>
|
|
1369
1511
|
*/
|
|
1370
1512
|
DateCreated?: Date;
|
|
1371
1513
|
/**
|
|
1514
|
+
* @public
|
|
1372
1515
|
* <p>The date (in UTC time) when this configuration set was last modified.</p>
|
|
1373
1516
|
*/
|
|
1374
1517
|
DateUpdated?: Date;
|
|
1375
1518
|
/**
|
|
1519
|
+
* @public
|
|
1376
1520
|
* <p>A list of the configuration options and their values in this configuration
|
|
1377
1521
|
* set.</p>
|
|
1378
1522
|
*/
|
|
@@ -1384,10 +1528,12 @@ export interface ConfigurationSettingsDescription {
|
|
|
1384
1528
|
*/
|
|
1385
1529
|
export interface SourceConfiguration {
|
|
1386
1530
|
/**
|
|
1531
|
+
* @public
|
|
1387
1532
|
* <p>The name of the application associated with the configuration.</p>
|
|
1388
1533
|
*/
|
|
1389
1534
|
ApplicationName?: string;
|
|
1390
1535
|
/**
|
|
1536
|
+
* @public
|
|
1391
1537
|
* <p>The name of the configuration template.</p>
|
|
1392
1538
|
*/
|
|
1393
1539
|
TemplateName?: string;
|
|
@@ -1398,16 +1544,19 @@ export interface SourceConfiguration {
|
|
|
1398
1544
|
*/
|
|
1399
1545
|
export interface CreateConfigurationTemplateMessage {
|
|
1400
1546
|
/**
|
|
1547
|
+
* @public
|
|
1401
1548
|
* <p>The name of the Elastic Beanstalk application to associate with this configuration
|
|
1402
1549
|
* template.</p>
|
|
1403
1550
|
*/
|
|
1404
1551
|
ApplicationName: string | undefined;
|
|
1405
1552
|
/**
|
|
1553
|
+
* @public
|
|
1406
1554
|
* <p>The name of the configuration template.</p>
|
|
1407
1555
|
* <p>Constraint: This name must be unique per application.</p>
|
|
1408
1556
|
*/
|
|
1409
1557
|
TemplateName: string | undefined;
|
|
1410
1558
|
/**
|
|
1559
|
+
* @public
|
|
1411
1560
|
* <p>The name of an Elastic Beanstalk solution stack (platform version) that this configuration uses. For
|
|
1412
1561
|
* example, <code>64bit Amazon Linux 2013.09 running Tomcat 7 Java 7</code>. A solution stack
|
|
1413
1562
|
* specifies the operating system, runtime, and application server for a configuration template.
|
|
@@ -1424,6 +1573,7 @@ export interface CreateConfigurationTemplateMessage {
|
|
|
1424
1573
|
*/
|
|
1425
1574
|
SolutionStackName?: string;
|
|
1426
1575
|
/**
|
|
1576
|
+
* @public
|
|
1427
1577
|
* <p>The Amazon Resource Name (ARN) of the custom platform. For more information, see <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/custom-platforms.html"> Custom
|
|
1428
1578
|
* Platforms</a> in the <i>AWS Elastic Beanstalk Developer Guide</i>.</p>
|
|
1429
1579
|
* <note>
|
|
@@ -1433,6 +1583,7 @@ export interface CreateConfigurationTemplateMessage {
|
|
|
1433
1583
|
*/
|
|
1434
1584
|
PlatformArn?: string;
|
|
1435
1585
|
/**
|
|
1586
|
+
* @public
|
|
1436
1587
|
* <p>An Elastic Beanstalk configuration template to base this one on. If specified, Elastic Beanstalk uses the configuration values from the specified
|
|
1437
1588
|
* configuration template to create a new configuration.</p>
|
|
1438
1589
|
* <p>Values specified in <code>OptionSettings</code> override any values obtained from the
|
|
@@ -1446,6 +1597,7 @@ export interface CreateConfigurationTemplateMessage {
|
|
|
1446
1597
|
*/
|
|
1447
1598
|
SourceConfiguration?: SourceConfiguration;
|
|
1448
1599
|
/**
|
|
1600
|
+
* @public
|
|
1449
1601
|
* <p>The ID of an environment whose settings you want to use to create the configuration
|
|
1450
1602
|
* template. You must specify <code>EnvironmentId</code> if you don't specify
|
|
1451
1603
|
* <code>PlatformArn</code>, <code>SolutionStackName</code>, or
|
|
@@ -1453,10 +1605,12 @@ export interface CreateConfigurationTemplateMessage {
|
|
|
1453
1605
|
*/
|
|
1454
1606
|
EnvironmentId?: string;
|
|
1455
1607
|
/**
|
|
1608
|
+
* @public
|
|
1456
1609
|
* <p>An optional description for this configuration.</p>
|
|
1457
1610
|
*/
|
|
1458
1611
|
Description?: string;
|
|
1459
1612
|
/**
|
|
1613
|
+
* @public
|
|
1460
1614
|
* <p>Option values for the Elastic Beanstalk configuration, such as the instance type. If specified, these
|
|
1461
1615
|
* values override the values obtained from the solution stack or the source configuration
|
|
1462
1616
|
* template. For a complete list of Elastic Beanstalk configuration options, see <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html">Option Values</a> in the
|
|
@@ -1464,6 +1618,7 @@ export interface CreateConfigurationTemplateMessage {
|
|
|
1464
1618
|
*/
|
|
1465
1619
|
OptionSettings?: ConfigurationOptionSetting[];
|
|
1466
1620
|
/**
|
|
1621
|
+
* @public
|
|
1467
1622
|
* <p>Specifies the tags applied to the configuration template.</p>
|
|
1468
1623
|
*/
|
|
1469
1624
|
Tags?: Tag[];
|
|
@@ -1498,14 +1653,17 @@ export declare class TooManyConfigurationTemplatesException extends __BaseExcept
|
|
|
1498
1653
|
*/
|
|
1499
1654
|
export interface OptionSpecification {
|
|
1500
1655
|
/**
|
|
1656
|
+
* @public
|
|
1501
1657
|
* <p>A unique resource name for a time-based scaling configuration option.</p>
|
|
1502
1658
|
*/
|
|
1503
1659
|
ResourceName?: string;
|
|
1504
1660
|
/**
|
|
1661
|
+
* @public
|
|
1505
1662
|
* <p>A unique namespace identifying the option's associated AWS resource.</p>
|
|
1506
1663
|
*/
|
|
1507
1664
|
Namespace?: string;
|
|
1508
1665
|
/**
|
|
1666
|
+
* @public
|
|
1509
1667
|
* <p>The name of the configuration option.</p>
|
|
1510
1668
|
*/
|
|
1511
1669
|
OptionName?: string;
|
|
@@ -1516,10 +1674,12 @@ export interface OptionSpecification {
|
|
|
1516
1674
|
*/
|
|
1517
1675
|
export interface CreateEnvironmentMessage {
|
|
1518
1676
|
/**
|
|
1677
|
+
* @public
|
|
1519
1678
|
* <p>The name of the application that is associated with this environment.</p>
|
|
1520
1679
|
*/
|
|
1521
1680
|
ApplicationName: string | undefined;
|
|
1522
1681
|
/**
|
|
1682
|
+
* @public
|
|
1523
1683
|
* <p>A unique name for the environment.</p>
|
|
1524
1684
|
* <p>Constraint: Must be from 4 to 40 characters in length. The name can contain only
|
|
1525
1685
|
* letters, numbers, and hyphens. It can't start or end with a hyphen. This name must be unique
|
|
@@ -1530,6 +1690,7 @@ export interface CreateEnvironmentMessage {
|
|
|
1530
1690
|
*/
|
|
1531
1691
|
EnvironmentName?: string;
|
|
1532
1692
|
/**
|
|
1693
|
+
* @public
|
|
1533
1694
|
* <p>The name of the group to which the target environment belongs. Specify a group name
|
|
1534
1695
|
* only if the environment's name is specified in an environment manifest and not with the
|
|
1535
1696
|
* environment name parameter. See <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-manifest.html">Environment Manifest
|
|
@@ -1537,31 +1698,37 @@ export interface CreateEnvironmentMessage {
|
|
|
1537
1698
|
*/
|
|
1538
1699
|
GroupName?: string;
|
|
1539
1700
|
/**
|
|
1701
|
+
* @public
|
|
1540
1702
|
* <p>Your description for this environment.</p>
|
|
1541
1703
|
*/
|
|
1542
1704
|
Description?: string;
|
|
1543
1705
|
/**
|
|
1706
|
+
* @public
|
|
1544
1707
|
* <p>If specified, the environment attempts to use this value as the prefix for the CNAME in
|
|
1545
1708
|
* your Elastic Beanstalk environment URL. If not specified, the CNAME is generated automatically by
|
|
1546
1709
|
* appending a random alphanumeric string to the environment name.</p>
|
|
1547
1710
|
*/
|
|
1548
1711
|
CNAMEPrefix?: string;
|
|
1549
1712
|
/**
|
|
1713
|
+
* @public
|
|
1550
1714
|
* <p>Specifies the tier to use in creating this environment. The environment tier that you
|
|
1551
1715
|
* choose determines whether Elastic Beanstalk provisions resources to support a web application that handles
|
|
1552
1716
|
* HTTP(S) requests or a web application that handles background-processing tasks.</p>
|
|
1553
1717
|
*/
|
|
1554
1718
|
Tier?: EnvironmentTier;
|
|
1555
1719
|
/**
|
|
1720
|
+
* @public
|
|
1556
1721
|
* <p>Specifies the tags applied to resources in the environment.</p>
|
|
1557
1722
|
*/
|
|
1558
1723
|
Tags?: Tag[];
|
|
1559
1724
|
/**
|
|
1725
|
+
* @public
|
|
1560
1726
|
* <p>The name of the application version to deploy.</p>
|
|
1561
1727
|
* <p>Default: If not specified, Elastic Beanstalk attempts to deploy the sample application.</p>
|
|
1562
1728
|
*/
|
|
1563
1729
|
VersionLabel?: string;
|
|
1564
1730
|
/**
|
|
1731
|
+
* @public
|
|
1565
1732
|
* <p>The name of the Elastic Beanstalk configuration template to use with the environment.</p>
|
|
1566
1733
|
* <note>
|
|
1567
1734
|
* <p>If you specify <code>TemplateName</code>, then don't specify
|
|
@@ -1570,6 +1737,7 @@ export interface CreateEnvironmentMessage {
|
|
|
1570
1737
|
*/
|
|
1571
1738
|
TemplateName?: string;
|
|
1572
1739
|
/**
|
|
1740
|
+
* @public
|
|
1573
1741
|
* <p>The name of an Elastic Beanstalk solution stack (platform version) to use with the environment. If
|
|
1574
1742
|
* specified, Elastic Beanstalk sets the configuration values to the default values associated with the
|
|
1575
1743
|
* specified solution stack. For a list of current solution stacks, see <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/platforms/platforms-supported.html">Elastic Beanstalk Supported Platforms</a> in the <i>AWS Elastic Beanstalk
|
|
@@ -1581,6 +1749,7 @@ export interface CreateEnvironmentMessage {
|
|
|
1581
1749
|
*/
|
|
1582
1750
|
SolutionStackName?: string;
|
|
1583
1751
|
/**
|
|
1752
|
+
* @public
|
|
1584
1753
|
* <p>The Amazon Resource Name (ARN) of the custom platform to use with the environment. For
|
|
1585
1754
|
* more information, see <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/custom-platforms.html">Custom Platforms</a> in the
|
|
1586
1755
|
* <i>AWS Elastic Beanstalk Developer Guide</i>.</p>
|
|
@@ -1591,17 +1760,20 @@ export interface CreateEnvironmentMessage {
|
|
|
1591
1760
|
*/
|
|
1592
1761
|
PlatformArn?: string;
|
|
1593
1762
|
/**
|
|
1763
|
+
* @public
|
|
1594
1764
|
* <p>If specified, AWS Elastic Beanstalk sets the specified configuration options to the
|
|
1595
1765
|
* requested value in the configuration set for the new environment. These override the values
|
|
1596
1766
|
* obtained from the solution stack or the configuration template.</p>
|
|
1597
1767
|
*/
|
|
1598
1768
|
OptionSettings?: ConfigurationOptionSetting[];
|
|
1599
1769
|
/**
|
|
1770
|
+
* @public
|
|
1600
1771
|
* <p>A list of custom user-defined configuration options to remove from the configuration
|
|
1601
1772
|
* set for this new environment.</p>
|
|
1602
1773
|
*/
|
|
1603
1774
|
OptionsToRemove?: OptionSpecification[];
|
|
1604
1775
|
/**
|
|
1776
|
+
* @public
|
|
1605
1777
|
* <p>The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's
|
|
1606
1778
|
* operations role. If specified, Elastic Beanstalk uses the operations role for permissions to downstream
|
|
1607
1779
|
* services during this call and during subsequent calls acting on this environment. To specify
|
|
@@ -1617,26 +1789,32 @@ export interface CreateEnvironmentMessage {
|
|
|
1617
1789
|
*/
|
|
1618
1790
|
export interface CreatePlatformVersionRequest {
|
|
1619
1791
|
/**
|
|
1792
|
+
* @public
|
|
1620
1793
|
* <p>The name of your custom platform.</p>
|
|
1621
1794
|
*/
|
|
1622
1795
|
PlatformName: string | undefined;
|
|
1623
1796
|
/**
|
|
1797
|
+
* @public
|
|
1624
1798
|
* <p>The number, such as 1.0.2, for the new platform version.</p>
|
|
1625
1799
|
*/
|
|
1626
1800
|
PlatformVersion: string | undefined;
|
|
1627
1801
|
/**
|
|
1802
|
+
* @public
|
|
1628
1803
|
* <p>The location of the platform definition archive in Amazon S3.</p>
|
|
1629
1804
|
*/
|
|
1630
1805
|
PlatformDefinitionBundle: S3Location | undefined;
|
|
1631
1806
|
/**
|
|
1807
|
+
* @public
|
|
1632
1808
|
* <p>The name of the builder environment.</p>
|
|
1633
1809
|
*/
|
|
1634
1810
|
EnvironmentName?: string;
|
|
1635
1811
|
/**
|
|
1812
|
+
* @public
|
|
1636
1813
|
* <p>The configuration option settings to apply to the builder environment.</p>
|
|
1637
1814
|
*/
|
|
1638
1815
|
OptionSettings?: ConfigurationOptionSetting[];
|
|
1639
1816
|
/**
|
|
1817
|
+
* @public
|
|
1640
1818
|
* <p>Specifies the tags applied to the new platform version.</p>
|
|
1641
1819
|
* <p>Elastic Beanstalk applies these tags only to the platform version. Environments that you create using
|
|
1642
1820
|
* the platform version don't inherit the tags.</p>
|
|
@@ -1649,6 +1827,7 @@ export interface CreatePlatformVersionRequest {
|
|
|
1649
1827
|
*/
|
|
1650
1828
|
export interface Builder {
|
|
1651
1829
|
/**
|
|
1830
|
+
* @public
|
|
1652
1831
|
* <p>The ARN of the builder.</p>
|
|
1653
1832
|
*/
|
|
1654
1833
|
ARN?: string;
|
|
@@ -1674,39 +1853,48 @@ export type PlatformStatus = (typeof PlatformStatus)[keyof typeof PlatformStatus
|
|
|
1674
1853
|
*/
|
|
1675
1854
|
export interface PlatformSummary {
|
|
1676
1855
|
/**
|
|
1856
|
+
* @public
|
|
1677
1857
|
* <p>The ARN of the platform version.</p>
|
|
1678
1858
|
*/
|
|
1679
1859
|
PlatformArn?: string;
|
|
1680
1860
|
/**
|
|
1861
|
+
* @public
|
|
1681
1862
|
* <p>The AWS account ID of the person who created the platform version.</p>
|
|
1682
1863
|
*/
|
|
1683
1864
|
PlatformOwner?: string;
|
|
1684
1865
|
/**
|
|
1866
|
+
* @public
|
|
1685
1867
|
* <p>The status of the platform version. You can create an environment from the platform
|
|
1686
1868
|
* version once it is ready.</p>
|
|
1687
1869
|
*/
|
|
1688
1870
|
PlatformStatus?: PlatformStatus | string;
|
|
1689
1871
|
/**
|
|
1872
|
+
* @public
|
|
1690
1873
|
* <p>The category of platform version.</p>
|
|
1691
1874
|
*/
|
|
1692
1875
|
PlatformCategory?: string;
|
|
1693
1876
|
/**
|
|
1877
|
+
* @public
|
|
1694
1878
|
* <p>The operating system used by the platform version.</p>
|
|
1695
1879
|
*/
|
|
1696
1880
|
OperatingSystemName?: string;
|
|
1697
1881
|
/**
|
|
1882
|
+
* @public
|
|
1698
1883
|
* <p>The version of the operating system used by the platform version.</p>
|
|
1699
1884
|
*/
|
|
1700
1885
|
OperatingSystemVersion?: string;
|
|
1701
1886
|
/**
|
|
1887
|
+
* @public
|
|
1702
1888
|
* <p>The tiers in which the platform version runs.</p>
|
|
1703
1889
|
*/
|
|
1704
1890
|
SupportedTierList?: string[];
|
|
1705
1891
|
/**
|
|
1892
|
+
* @public
|
|
1706
1893
|
* <p>The additions associated with the platform version.</p>
|
|
1707
1894
|
*/
|
|
1708
1895
|
SupportedAddonList?: string[];
|
|
1709
1896
|
/**
|
|
1897
|
+
* @public
|
|
1710
1898
|
* <p>The state of the platform version in its lifecycle.</p>
|
|
1711
1899
|
* <p>Possible values: <code>recommended</code> | empty</p>
|
|
1712
1900
|
* <p>If an empty value is returned, the platform version is supported but isn't the recommended
|
|
@@ -1714,14 +1902,17 @@ export interface PlatformSummary {
|
|
|
1714
1902
|
*/
|
|
1715
1903
|
PlatformLifecycleState?: string;
|
|
1716
1904
|
/**
|
|
1905
|
+
* @public
|
|
1717
1906
|
* <p>The version string of the platform version.</p>
|
|
1718
1907
|
*/
|
|
1719
1908
|
PlatformVersion?: string;
|
|
1720
1909
|
/**
|
|
1910
|
+
* @public
|
|
1721
1911
|
* <p>The platform branch to which the platform version belongs.</p>
|
|
1722
1912
|
*/
|
|
1723
1913
|
PlatformBranchName?: string;
|
|
1724
1914
|
/**
|
|
1915
|
+
* @public
|
|
1725
1916
|
* <p>The state of the platform version's branch in its lifecycle.</p>
|
|
1726
1917
|
* <p>Possible values: <code>beta</code> | <code>supported</code> | <code>deprecated</code> |
|
|
1727
1918
|
* <code>retired</code>
|
|
@@ -1734,10 +1925,12 @@ export interface PlatformSummary {
|
|
|
1734
1925
|
*/
|
|
1735
1926
|
export interface CreatePlatformVersionResult {
|
|
1736
1927
|
/**
|
|
1928
|
+
* @public
|
|
1737
1929
|
* <p>Detailed information about the new version of the custom platform.</p>
|
|
1738
1930
|
*/
|
|
1739
1931
|
PlatformSummary?: PlatformSummary;
|
|
1740
1932
|
/**
|
|
1933
|
+
* @public
|
|
1741
1934
|
* <p>The builder used to create the custom platform.</p>
|
|
1742
1935
|
*/
|
|
1743
1936
|
Builder?: Builder;
|
|
@@ -1760,6 +1953,7 @@ export declare class TooManyPlatformsException extends __BaseException {
|
|
|
1760
1953
|
*/
|
|
1761
1954
|
export interface CreateStorageLocationResultMessage {
|
|
1762
1955
|
/**
|
|
1956
|
+
* @public
|
|
1763
1957
|
* <p>The name of the Amazon S3 bucket created.</p>
|
|
1764
1958
|
*/
|
|
1765
1959
|
S3Bucket?: string;
|
|
@@ -1782,10 +1976,12 @@ export declare class S3SubscriptionRequiredException extends __BaseException {
|
|
|
1782
1976
|
*/
|
|
1783
1977
|
export interface DeleteApplicationMessage {
|
|
1784
1978
|
/**
|
|
1979
|
+
* @public
|
|
1785
1980
|
* <p>The name of the application to delete.</p>
|
|
1786
1981
|
*/
|
|
1787
1982
|
ApplicationName: string | undefined;
|
|
1788
1983
|
/**
|
|
1984
|
+
* @public
|
|
1789
1985
|
* <p>When set to true, running environments will be terminated before deleting the
|
|
1790
1986
|
* application.</p>
|
|
1791
1987
|
*/
|
|
@@ -1810,14 +2006,17 @@ export declare class OperationInProgressException extends __BaseException {
|
|
|
1810
2006
|
*/
|
|
1811
2007
|
export interface DeleteApplicationVersionMessage {
|
|
1812
2008
|
/**
|
|
2009
|
+
* @public
|
|
1813
2010
|
* <p>The name of the application to which the version belongs.</p>
|
|
1814
2011
|
*/
|
|
1815
2012
|
ApplicationName: string | undefined;
|
|
1816
2013
|
/**
|
|
2014
|
+
* @public
|
|
1817
2015
|
* <p>The label of the version to delete.</p>
|
|
1818
2016
|
*/
|
|
1819
2017
|
VersionLabel: string | undefined;
|
|
1820
2018
|
/**
|
|
2019
|
+
* @public
|
|
1821
2020
|
* <p>Set to <code>true</code> to delete the source bundle from your storage bucket.
|
|
1822
2021
|
* Otherwise, the application version is deleted only from Elastic Beanstalk and the source
|
|
1823
2022
|
* bundle remains in Amazon S3.</p>
|
|
@@ -1843,10 +2042,12 @@ export declare class SourceBundleDeletionException extends __BaseException {
|
|
|
1843
2042
|
*/
|
|
1844
2043
|
export interface DeleteConfigurationTemplateMessage {
|
|
1845
2044
|
/**
|
|
2045
|
+
* @public
|
|
1846
2046
|
* <p>The name of the application to delete the configuration template from.</p>
|
|
1847
2047
|
*/
|
|
1848
2048
|
ApplicationName: string | undefined;
|
|
1849
2049
|
/**
|
|
2050
|
+
* @public
|
|
1850
2051
|
* <p>The name of the configuration template to delete.</p>
|
|
1851
2052
|
*/
|
|
1852
2053
|
TemplateName: string | undefined;
|
|
@@ -1857,10 +2058,12 @@ export interface DeleteConfigurationTemplateMessage {
|
|
|
1857
2058
|
*/
|
|
1858
2059
|
export interface DeleteEnvironmentConfigurationMessage {
|
|
1859
2060
|
/**
|
|
2061
|
+
* @public
|
|
1860
2062
|
* <p>The name of the application the environment is associated with.</p>
|
|
1861
2063
|
*/
|
|
1862
2064
|
ApplicationName: string | undefined;
|
|
1863
2065
|
/**
|
|
2066
|
+
* @public
|
|
1864
2067
|
* <p>The name of the environment to delete the draft configuration from.</p>
|
|
1865
2068
|
*/
|
|
1866
2069
|
EnvironmentName: string | undefined;
|
|
@@ -1870,6 +2073,7 @@ export interface DeleteEnvironmentConfigurationMessage {
|
|
|
1870
2073
|
*/
|
|
1871
2074
|
export interface DeletePlatformVersionRequest {
|
|
1872
2075
|
/**
|
|
2076
|
+
* @public
|
|
1873
2077
|
* <p>The ARN of the version of the custom platform.</p>
|
|
1874
2078
|
*/
|
|
1875
2079
|
PlatformArn?: string;
|
|
@@ -1879,6 +2083,7 @@ export interface DeletePlatformVersionRequest {
|
|
|
1879
2083
|
*/
|
|
1880
2084
|
export interface DeletePlatformVersionResult {
|
|
1881
2085
|
/**
|
|
2086
|
+
* @public
|
|
1882
2087
|
* <p>Detailed information about the version of the custom platform.</p>
|
|
1883
2088
|
*/
|
|
1884
2089
|
PlatformSummary?: PlatformSummary;
|
|
@@ -1902,6 +2107,7 @@ export declare class PlatformVersionStillReferencedException extends __BaseExcep
|
|
|
1902
2107
|
*/
|
|
1903
2108
|
export interface ResourceQuota {
|
|
1904
2109
|
/**
|
|
2110
|
+
* @public
|
|
1905
2111
|
* <p>The maximum number of instances of this Elastic Beanstalk resource type that an AWS account can
|
|
1906
2112
|
* use.</p>
|
|
1907
2113
|
*/
|
|
@@ -1914,22 +2120,27 @@ export interface ResourceQuota {
|
|
|
1914
2120
|
*/
|
|
1915
2121
|
export interface ResourceQuotas {
|
|
1916
2122
|
/**
|
|
2123
|
+
* @public
|
|
1917
2124
|
* <p>The quota for applications in the AWS account.</p>
|
|
1918
2125
|
*/
|
|
1919
2126
|
ApplicationQuota?: ResourceQuota;
|
|
1920
2127
|
/**
|
|
2128
|
+
* @public
|
|
1921
2129
|
* <p>The quota for application versions in the AWS account.</p>
|
|
1922
2130
|
*/
|
|
1923
2131
|
ApplicationVersionQuota?: ResourceQuota;
|
|
1924
2132
|
/**
|
|
2133
|
+
* @public
|
|
1925
2134
|
* <p>The quota for environments in the AWS account.</p>
|
|
1926
2135
|
*/
|
|
1927
2136
|
EnvironmentQuota?: ResourceQuota;
|
|
1928
2137
|
/**
|
|
2138
|
+
* @public
|
|
1929
2139
|
* <p>The quota for configuration templates in the AWS account.</p>
|
|
1930
2140
|
*/
|
|
1931
2141
|
ConfigurationTemplateQuota?: ResourceQuota;
|
|
1932
2142
|
/**
|
|
2143
|
+
* @public
|
|
1933
2144
|
* <p>The quota for custom platforms in the AWS account.</p>
|
|
1934
2145
|
*/
|
|
1935
2146
|
CustomPlatformQuota?: ResourceQuota;
|
|
@@ -1939,6 +2150,7 @@ export interface ResourceQuotas {
|
|
|
1939
2150
|
*/
|
|
1940
2151
|
export interface DescribeAccountAttributesResult {
|
|
1941
2152
|
/**
|
|
2153
|
+
* @public
|
|
1942
2154
|
* <p>The Elastic Beanstalk resource quotas associated with the calling AWS account.</p>
|
|
1943
2155
|
*/
|
|
1944
2156
|
ResourceQuotas?: ResourceQuotas;
|
|
@@ -1949,6 +2161,7 @@ export interface DescribeAccountAttributesResult {
|
|
|
1949
2161
|
*/
|
|
1950
2162
|
export interface DescribeApplicationsMessage {
|
|
1951
2163
|
/**
|
|
2164
|
+
* @public
|
|
1952
2165
|
* <p>If specified, AWS Elastic Beanstalk restricts the returned descriptions to only include
|
|
1953
2166
|
* those with the specified names.</p>
|
|
1954
2167
|
*/
|
|
@@ -1960,15 +2173,18 @@ export interface DescribeApplicationsMessage {
|
|
|
1960
2173
|
*/
|
|
1961
2174
|
export interface DescribeApplicationVersionsMessage {
|
|
1962
2175
|
/**
|
|
2176
|
+
* @public
|
|
1963
2177
|
* <p>Specify an application name to show only application versions for that
|
|
1964
2178
|
* application.</p>
|
|
1965
2179
|
*/
|
|
1966
2180
|
ApplicationName?: string;
|
|
1967
2181
|
/**
|
|
2182
|
+
* @public
|
|
1968
2183
|
* <p>Specify a version label to show a specific application version.</p>
|
|
1969
2184
|
*/
|
|
1970
2185
|
VersionLabels?: string[];
|
|
1971
2186
|
/**
|
|
2187
|
+
* @public
|
|
1972
2188
|
* <p>For a paginated request. Specify a maximum number of application versions to include in
|
|
1973
2189
|
* each response.</p>
|
|
1974
2190
|
* <p>If no <code>MaxRecords</code> is specified, all available application versions are
|
|
@@ -1976,6 +2192,7 @@ export interface DescribeApplicationVersionsMessage {
|
|
|
1976
2192
|
*/
|
|
1977
2193
|
MaxRecords?: number;
|
|
1978
2194
|
/**
|
|
2195
|
+
* @public
|
|
1979
2196
|
* <p>For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other
|
|
1980
2197
|
* parameter values must be identical to the ones specified in the initial request.</p>
|
|
1981
2198
|
* <p>If no <code>NextToken</code> is specified, the first page is retrieved.</p>
|
|
@@ -1989,11 +2206,13 @@ export interface DescribeApplicationVersionsMessage {
|
|
|
1989
2206
|
*/
|
|
1990
2207
|
export interface OptionRestrictionRegex {
|
|
1991
2208
|
/**
|
|
2209
|
+
* @public
|
|
1992
2210
|
* <p>The regular expression pattern that a string configuration option value with this
|
|
1993
2211
|
* restriction must match.</p>
|
|
1994
2212
|
*/
|
|
1995
2213
|
Pattern?: string;
|
|
1996
2214
|
/**
|
|
2215
|
+
* @public
|
|
1997
2216
|
* <p>A unique name representing this regular expression.</p>
|
|
1998
2217
|
*/
|
|
1999
2218
|
Label?: string;
|
|
@@ -2016,18 +2235,22 @@ export type ConfigurationOptionValueType = (typeof ConfigurationOptionValueType)
|
|
|
2016
2235
|
*/
|
|
2017
2236
|
export interface ConfigurationOptionDescription {
|
|
2018
2237
|
/**
|
|
2238
|
+
* @public
|
|
2019
2239
|
* <p>A unique namespace identifying the option's associated AWS resource.</p>
|
|
2020
2240
|
*/
|
|
2021
2241
|
Namespace?: string;
|
|
2022
2242
|
/**
|
|
2243
|
+
* @public
|
|
2023
2244
|
* <p>The name of the configuration option.</p>
|
|
2024
2245
|
*/
|
|
2025
2246
|
Name?: string;
|
|
2026
2247
|
/**
|
|
2248
|
+
* @public
|
|
2027
2249
|
* <p>The default value for this configuration option.</p>
|
|
2028
2250
|
*/
|
|
2029
2251
|
DefaultValue?: string;
|
|
2030
2252
|
/**
|
|
2253
|
+
* @public
|
|
2031
2254
|
* <p>An indication of which action is required if the value for this configuration option
|
|
2032
2255
|
* changes:</p>
|
|
2033
2256
|
* <ul>
|
|
@@ -2052,6 +2275,7 @@ export interface ConfigurationOptionDescription {
|
|
|
2052
2275
|
*/
|
|
2053
2276
|
ChangeSeverity?: string;
|
|
2054
2277
|
/**
|
|
2278
|
+
* @public
|
|
2055
2279
|
* <p>An indication of whether the user defined this configuration option:</p>
|
|
2056
2280
|
* <ul>
|
|
2057
2281
|
* <li>
|
|
@@ -2071,6 +2295,7 @@ export interface ConfigurationOptionDescription {
|
|
|
2071
2295
|
*/
|
|
2072
2296
|
UserDefined?: boolean;
|
|
2073
2297
|
/**
|
|
2298
|
+
* @public
|
|
2074
2299
|
* <p>An indication of which type of values this option has and whether it is allowable to
|
|
2075
2300
|
* select one or more than one of the possible values:</p>
|
|
2076
2301
|
* <ul>
|
|
@@ -2099,26 +2324,31 @@ export interface ConfigurationOptionDescription {
|
|
|
2099
2324
|
*/
|
|
2100
2325
|
ValueType?: ConfigurationOptionValueType | string;
|
|
2101
2326
|
/**
|
|
2327
|
+
* @public
|
|
2102
2328
|
* <p>If specified, values for the configuration option are selected from this
|
|
2103
2329
|
* list.</p>
|
|
2104
2330
|
*/
|
|
2105
2331
|
ValueOptions?: string[];
|
|
2106
2332
|
/**
|
|
2333
|
+
* @public
|
|
2107
2334
|
* <p>If specified, the configuration option must be a numeric value greater than this
|
|
2108
2335
|
* value.</p>
|
|
2109
2336
|
*/
|
|
2110
2337
|
MinValue?: number;
|
|
2111
2338
|
/**
|
|
2339
|
+
* @public
|
|
2112
2340
|
* <p>If specified, the configuration option must be a numeric value less than this
|
|
2113
2341
|
* value.</p>
|
|
2114
2342
|
*/
|
|
2115
2343
|
MaxValue?: number;
|
|
2116
2344
|
/**
|
|
2345
|
+
* @public
|
|
2117
2346
|
* <p>If specified, the configuration option must be a string value no longer than this
|
|
2118
2347
|
* value.</p>
|
|
2119
2348
|
*/
|
|
2120
2349
|
MaxLength?: number;
|
|
2121
2350
|
/**
|
|
2351
|
+
* @public
|
|
2122
2352
|
* <p>If specified, the configuration option must be a string value that satisfies this
|
|
2123
2353
|
* regular expression.</p>
|
|
2124
2354
|
*/
|
|
@@ -2130,14 +2360,17 @@ export interface ConfigurationOptionDescription {
|
|
|
2130
2360
|
*/
|
|
2131
2361
|
export interface ConfigurationOptionsDescription {
|
|
2132
2362
|
/**
|
|
2363
|
+
* @public
|
|
2133
2364
|
* <p>The name of the solution stack these configuration options belong to.</p>
|
|
2134
2365
|
*/
|
|
2135
2366
|
SolutionStackName?: string;
|
|
2136
2367
|
/**
|
|
2368
|
+
* @public
|
|
2137
2369
|
* <p>The ARN of the platform version.</p>
|
|
2138
2370
|
*/
|
|
2139
2371
|
PlatformArn?: string;
|
|
2140
2372
|
/**
|
|
2373
|
+
* @public
|
|
2141
2374
|
* <p> A list of <a>ConfigurationOptionDescription</a>. </p>
|
|
2142
2375
|
*/
|
|
2143
2376
|
Options?: ConfigurationOptionDescription[];
|
|
@@ -2148,30 +2381,36 @@ export interface ConfigurationOptionsDescription {
|
|
|
2148
2381
|
*/
|
|
2149
2382
|
export interface DescribeConfigurationOptionsMessage {
|
|
2150
2383
|
/**
|
|
2384
|
+
* @public
|
|
2151
2385
|
* <p>The name of the application associated with the configuration template or environment.
|
|
2152
2386
|
* Only needed if you want to describe the configuration options associated with either the
|
|
2153
2387
|
* configuration template or environment.</p>
|
|
2154
2388
|
*/
|
|
2155
2389
|
ApplicationName?: string;
|
|
2156
2390
|
/**
|
|
2391
|
+
* @public
|
|
2157
2392
|
* <p>The name of the configuration template whose configuration options you want to
|
|
2158
2393
|
* describe.</p>
|
|
2159
2394
|
*/
|
|
2160
2395
|
TemplateName?: string;
|
|
2161
2396
|
/**
|
|
2397
|
+
* @public
|
|
2162
2398
|
* <p>The name of the environment whose configuration options you want to describe.</p>
|
|
2163
2399
|
*/
|
|
2164
2400
|
EnvironmentName?: string;
|
|
2165
2401
|
/**
|
|
2402
|
+
* @public
|
|
2166
2403
|
* <p>The name of the solution stack whose configuration options you want to
|
|
2167
2404
|
* describe.</p>
|
|
2168
2405
|
*/
|
|
2169
2406
|
SolutionStackName?: string;
|
|
2170
2407
|
/**
|
|
2408
|
+
* @public
|
|
2171
2409
|
* <p>The ARN of the custom platform.</p>
|
|
2172
2410
|
*/
|
|
2173
2411
|
PlatformArn?: string;
|
|
2174
2412
|
/**
|
|
2413
|
+
* @public
|
|
2175
2414
|
* <p>If specified, restricts the descriptions to only the specified options.</p>
|
|
2176
2415
|
*/
|
|
2177
2416
|
Options?: OptionSpecification[];
|
|
@@ -2183,6 +2422,7 @@ export interface DescribeConfigurationOptionsMessage {
|
|
|
2183
2422
|
*/
|
|
2184
2423
|
export interface ConfigurationSettingsDescriptions {
|
|
2185
2424
|
/**
|
|
2425
|
+
* @public
|
|
2186
2426
|
* <p> A list of <a>ConfigurationSettingsDescription</a>. </p>
|
|
2187
2427
|
*/
|
|
2188
2428
|
ConfigurationSettings?: ConfigurationSettingsDescription[];
|
|
@@ -2194,10 +2434,12 @@ export interface ConfigurationSettingsDescriptions {
|
|
|
2194
2434
|
*/
|
|
2195
2435
|
export interface DescribeConfigurationSettingsMessage {
|
|
2196
2436
|
/**
|
|
2437
|
+
* @public
|
|
2197
2438
|
* <p>The application for the environment or configuration template.</p>
|
|
2198
2439
|
*/
|
|
2199
2440
|
ApplicationName: string | undefined;
|
|
2200
2441
|
/**
|
|
2442
|
+
* @public
|
|
2201
2443
|
* <p>The name of the configuration template to describe.</p>
|
|
2202
2444
|
* <p> Conditional: You must specify either this parameter or an EnvironmentName, but not
|
|
2203
2445
|
* both. If you specify both, AWS Elastic Beanstalk returns an
|
|
@@ -2206,6 +2448,7 @@ export interface DescribeConfigurationSettingsMessage {
|
|
|
2206
2448
|
*/
|
|
2207
2449
|
TemplateName?: string;
|
|
2208
2450
|
/**
|
|
2451
|
+
* @public
|
|
2209
2452
|
* <p>The name of the environment to describe.</p>
|
|
2210
2453
|
* <p> Condition: You must specify either this or a TemplateName, but not both. If you
|
|
2211
2454
|
* specify both, AWS Elastic Beanstalk returns an <code>InvalidParameterCombination</code> error.
|
|
@@ -2238,16 +2481,19 @@ export type EnvironmentHealthAttribute = (typeof EnvironmentHealthAttribute)[key
|
|
|
2238
2481
|
*/
|
|
2239
2482
|
export interface DescribeEnvironmentHealthRequest {
|
|
2240
2483
|
/**
|
|
2484
|
+
* @public
|
|
2241
2485
|
* <p>Specify the environment by name.</p>
|
|
2242
2486
|
* <p>You must specify either this or an EnvironmentName, or both.</p>
|
|
2243
2487
|
*/
|
|
2244
2488
|
EnvironmentName?: string;
|
|
2245
2489
|
/**
|
|
2490
|
+
* @public
|
|
2246
2491
|
* <p>Specify the environment by ID.</p>
|
|
2247
2492
|
* <p>You must specify either this or an EnvironmentName, or both.</p>
|
|
2248
2493
|
*/
|
|
2249
2494
|
EnvironmentId?: string;
|
|
2250
2495
|
/**
|
|
2496
|
+
* @public
|
|
2251
2497
|
* <p>Specify the response elements to return. To retrieve all attributes, set to
|
|
2252
2498
|
* <code>All</code>. If no attribute names are specified, returns the name of the
|
|
2253
2499
|
* environment.</p>
|
|
@@ -2261,47 +2507,55 @@ export interface DescribeEnvironmentHealthRequest {
|
|
|
2261
2507
|
*/
|
|
2262
2508
|
export interface InstanceHealthSummary {
|
|
2263
2509
|
/**
|
|
2510
|
+
* @public
|
|
2264
2511
|
* <p>
|
|
2265
2512
|
* <b>Grey.</b> AWS Elastic Beanstalk and the health agent are
|
|
2266
2513
|
* reporting no data on an instance.</p>
|
|
2267
2514
|
*/
|
|
2268
2515
|
NoData?: number;
|
|
2269
2516
|
/**
|
|
2517
|
+
* @public
|
|
2270
2518
|
* <p>
|
|
2271
2519
|
* <b>Grey.</b> AWS Elastic Beanstalk and the health agent are
|
|
2272
2520
|
* reporting an insufficient amount of data on an instance.</p>
|
|
2273
2521
|
*/
|
|
2274
2522
|
Unknown?: number;
|
|
2275
2523
|
/**
|
|
2524
|
+
* @public
|
|
2276
2525
|
* <p>
|
|
2277
2526
|
* <b>Grey.</b> An operation is in progress on an instance within the
|
|
2278
2527
|
* command timeout.</p>
|
|
2279
2528
|
*/
|
|
2280
2529
|
Pending?: number;
|
|
2281
2530
|
/**
|
|
2531
|
+
* @public
|
|
2282
2532
|
* <p>
|
|
2283
2533
|
* <b>Green.</b> An instance is passing health checks and the health
|
|
2284
2534
|
* agent is not reporting any problems.</p>
|
|
2285
2535
|
*/
|
|
2286
2536
|
Ok?: number;
|
|
2287
2537
|
/**
|
|
2538
|
+
* @public
|
|
2288
2539
|
* <p>
|
|
2289
2540
|
* <b>Green.</b> An operation is in progress on an instance.</p>
|
|
2290
2541
|
*/
|
|
2291
2542
|
Info?: number;
|
|
2292
2543
|
/**
|
|
2544
|
+
* @public
|
|
2293
2545
|
* <p>
|
|
2294
2546
|
* <b>Yellow.</b> The health agent is reporting a moderate number of
|
|
2295
2547
|
* request failures or other issues for an instance or environment.</p>
|
|
2296
2548
|
*/
|
|
2297
2549
|
Warning?: number;
|
|
2298
2550
|
/**
|
|
2551
|
+
* @public
|
|
2299
2552
|
* <p>
|
|
2300
2553
|
* <b>Red.</b> The health agent is reporting a high number of request
|
|
2301
2554
|
* failures or other issues for an instance or environment.</p>
|
|
2302
2555
|
*/
|
|
2303
2556
|
Degraded?: number;
|
|
2304
2557
|
/**
|
|
2558
|
+
* @public
|
|
2305
2559
|
* <p>
|
|
2306
2560
|
* <b>Red.</b> The health agent is reporting a very high number of
|
|
2307
2561
|
* request failures or other issues for an instance or environment.</p>
|
|
@@ -2314,38 +2568,46 @@ export interface InstanceHealthSummary {
|
|
|
2314
2568
|
*/
|
|
2315
2569
|
export interface DescribeEnvironmentHealthResult {
|
|
2316
2570
|
/**
|
|
2571
|
+
* @public
|
|
2317
2572
|
* <p>The environment's name.</p>
|
|
2318
2573
|
*/
|
|
2319
2574
|
EnvironmentName?: string;
|
|
2320
2575
|
/**
|
|
2576
|
+
* @public
|
|
2321
2577
|
* <p>The <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html">health status</a> of the
|
|
2322
2578
|
* environment. For example, <code>Ok</code>.</p>
|
|
2323
2579
|
*/
|
|
2324
2580
|
HealthStatus?: string;
|
|
2325
2581
|
/**
|
|
2582
|
+
* @public
|
|
2326
2583
|
* <p>The environment's operational status. <code>Ready</code>, <code>Launching</code>,
|
|
2327
2584
|
* <code>Updating</code>, <code>Terminating</code>, or <code>Terminated</code>.</p>
|
|
2328
2585
|
*/
|
|
2329
2586
|
Status?: EnvironmentHealth | string;
|
|
2330
2587
|
/**
|
|
2588
|
+
* @public
|
|
2331
2589
|
* <p>The <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html">health color</a> of the
|
|
2332
2590
|
* environment.</p>
|
|
2333
2591
|
*/
|
|
2334
2592
|
Color?: string;
|
|
2335
2593
|
/**
|
|
2594
|
+
* @public
|
|
2336
2595
|
* <p>Descriptions of the data that contributed to the environment's current health
|
|
2337
2596
|
* status.</p>
|
|
2338
2597
|
*/
|
|
2339
2598
|
Causes?: string[];
|
|
2340
2599
|
/**
|
|
2600
|
+
* @public
|
|
2341
2601
|
* <p>Application request metrics for the environment.</p>
|
|
2342
2602
|
*/
|
|
2343
2603
|
ApplicationMetrics?: ApplicationMetrics;
|
|
2344
2604
|
/**
|
|
2605
|
+
* @public
|
|
2345
2606
|
* <p>Summary health information for the instances in the environment.</p>
|
|
2346
2607
|
*/
|
|
2347
2608
|
InstancesHealth?: InstanceHealthSummary;
|
|
2348
2609
|
/**
|
|
2610
|
+
* @public
|
|
2349
2611
|
* <p>The date and time that the health information was retrieved.</p>
|
|
2350
2612
|
*/
|
|
2351
2613
|
RefreshedAt?: Date;
|
|
@@ -2369,18 +2631,22 @@ export declare class InvalidRequestException extends __BaseException {
|
|
|
2369
2631
|
*/
|
|
2370
2632
|
export interface DescribeEnvironmentManagedActionHistoryRequest {
|
|
2371
2633
|
/**
|
|
2634
|
+
* @public
|
|
2372
2635
|
* <p>The environment ID of the target environment.</p>
|
|
2373
2636
|
*/
|
|
2374
2637
|
EnvironmentId?: string;
|
|
2375
2638
|
/**
|
|
2639
|
+
* @public
|
|
2376
2640
|
* <p>The name of the target environment.</p>
|
|
2377
2641
|
*/
|
|
2378
2642
|
EnvironmentName?: string;
|
|
2379
2643
|
/**
|
|
2644
|
+
* @public
|
|
2380
2645
|
* <p>The pagination token returned by a previous request.</p>
|
|
2381
2646
|
*/
|
|
2382
2647
|
NextToken?: string;
|
|
2383
2648
|
/**
|
|
2649
|
+
* @public
|
|
2384
2650
|
* <p>The maximum number of items to return for a single request.</p>
|
|
2385
2651
|
*/
|
|
2386
2652
|
MaxItems?: number;
|
|
@@ -2408,34 +2674,42 @@ export type FailureType = (typeof FailureType)[keyof typeof FailureType];
|
|
|
2408
2674
|
*/
|
|
2409
2675
|
export interface ManagedActionHistoryItem {
|
|
2410
2676
|
/**
|
|
2677
|
+
* @public
|
|
2411
2678
|
* <p>A unique identifier for the managed action.</p>
|
|
2412
2679
|
*/
|
|
2413
2680
|
ActionId?: string;
|
|
2414
2681
|
/**
|
|
2682
|
+
* @public
|
|
2415
2683
|
* <p>The type of the managed action.</p>
|
|
2416
2684
|
*/
|
|
2417
2685
|
ActionType?: ActionType | string;
|
|
2418
2686
|
/**
|
|
2687
|
+
* @public
|
|
2419
2688
|
* <p>A description of the managed action.</p>
|
|
2420
2689
|
*/
|
|
2421
2690
|
ActionDescription?: string;
|
|
2422
2691
|
/**
|
|
2692
|
+
* @public
|
|
2423
2693
|
* <p>If the action failed, the type of failure.</p>
|
|
2424
2694
|
*/
|
|
2425
2695
|
FailureType?: FailureType | string;
|
|
2426
2696
|
/**
|
|
2697
|
+
* @public
|
|
2427
2698
|
* <p>The status of the action.</p>
|
|
2428
2699
|
*/
|
|
2429
2700
|
Status?: ActionHistoryStatus | string;
|
|
2430
2701
|
/**
|
|
2702
|
+
* @public
|
|
2431
2703
|
* <p>If the action failed, a description of the failure.</p>
|
|
2432
2704
|
*/
|
|
2433
2705
|
FailureDescription?: string;
|
|
2434
2706
|
/**
|
|
2707
|
+
* @public
|
|
2435
2708
|
* <p>The date and time that the action started executing.</p>
|
|
2436
2709
|
*/
|
|
2437
2710
|
ExecutedTime?: Date;
|
|
2438
2711
|
/**
|
|
2712
|
+
* @public
|
|
2439
2713
|
* <p>The date and time that the action finished executing.</p>
|
|
2440
2714
|
*/
|
|
2441
2715
|
FinishedTime?: Date;
|
|
@@ -2446,10 +2720,12 @@ export interface ManagedActionHistoryItem {
|
|
|
2446
2720
|
*/
|
|
2447
2721
|
export interface DescribeEnvironmentManagedActionHistoryResult {
|
|
2448
2722
|
/**
|
|
2723
|
+
* @public
|
|
2449
2724
|
* <p>A list of completed and failed managed actions.</p>
|
|
2450
2725
|
*/
|
|
2451
2726
|
ManagedActionHistoryItems?: ManagedActionHistoryItem[];
|
|
2452
2727
|
/**
|
|
2728
|
+
* @public
|
|
2453
2729
|
* <p>A pagination token that you pass to <a>DescribeEnvironmentManagedActionHistory</a> to get the next page of
|
|
2454
2730
|
* results.</p>
|
|
2455
2731
|
*/
|
|
@@ -2461,14 +2737,17 @@ export interface DescribeEnvironmentManagedActionHistoryResult {
|
|
|
2461
2737
|
*/
|
|
2462
2738
|
export interface DescribeEnvironmentManagedActionsRequest {
|
|
2463
2739
|
/**
|
|
2740
|
+
* @public
|
|
2464
2741
|
* <p>The name of the target environment.</p>
|
|
2465
2742
|
*/
|
|
2466
2743
|
EnvironmentName?: string;
|
|
2467
2744
|
/**
|
|
2745
|
+
* @public
|
|
2468
2746
|
* <p>The environment ID of the target environment.</p>
|
|
2469
2747
|
*/
|
|
2470
2748
|
EnvironmentId?: string;
|
|
2471
2749
|
/**
|
|
2750
|
+
* @public
|
|
2472
2751
|
* <p>To show only actions with a particular status, specify a status.</p>
|
|
2473
2752
|
*/
|
|
2474
2753
|
Status?: ActionStatus | string;
|
|
@@ -2479,23 +2758,28 @@ export interface DescribeEnvironmentManagedActionsRequest {
|
|
|
2479
2758
|
*/
|
|
2480
2759
|
export interface ManagedAction {
|
|
2481
2760
|
/**
|
|
2761
|
+
* @public
|
|
2482
2762
|
* <p>A unique identifier for the managed action.</p>
|
|
2483
2763
|
*/
|
|
2484
2764
|
ActionId?: string;
|
|
2485
2765
|
/**
|
|
2766
|
+
* @public
|
|
2486
2767
|
* <p>A description of the managed action.</p>
|
|
2487
2768
|
*/
|
|
2488
2769
|
ActionDescription?: string;
|
|
2489
2770
|
/**
|
|
2771
|
+
* @public
|
|
2490
2772
|
* <p>The type of managed action.</p>
|
|
2491
2773
|
*/
|
|
2492
2774
|
ActionType?: ActionType | string;
|
|
2493
2775
|
/**
|
|
2776
|
+
* @public
|
|
2494
2777
|
* <p>The status of the managed action. If the action is <code>Scheduled</code>, you can
|
|
2495
2778
|
* apply it immediately with <a>ApplyEnvironmentManagedAction</a>.</p>
|
|
2496
2779
|
*/
|
|
2497
2780
|
Status?: ActionStatus | string;
|
|
2498
2781
|
/**
|
|
2782
|
+
* @public
|
|
2499
2783
|
* <p>The start time of the maintenance window in which the managed action will
|
|
2500
2784
|
* execute.</p>
|
|
2501
2785
|
*/
|
|
@@ -2507,6 +2791,7 @@ export interface ManagedAction {
|
|
|
2507
2791
|
*/
|
|
2508
2792
|
export interface DescribeEnvironmentManagedActionsResult {
|
|
2509
2793
|
/**
|
|
2794
|
+
* @public
|
|
2510
2795
|
* <p>A list of upcoming and in-progress managed actions.</p>
|
|
2511
2796
|
*/
|
|
2512
2797
|
ManagedActions?: ManagedAction[];
|
|
@@ -2517,6 +2802,7 @@ export interface DescribeEnvironmentManagedActionsResult {
|
|
|
2517
2802
|
*/
|
|
2518
2803
|
export interface DescribeEnvironmentResourcesMessage {
|
|
2519
2804
|
/**
|
|
2805
|
+
* @public
|
|
2520
2806
|
* <p>The ID of the environment to retrieve AWS resource usage data.</p>
|
|
2521
2807
|
* <p> Condition: You must specify either this or an EnvironmentName, or both. If you do not
|
|
2522
2808
|
* specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error.
|
|
@@ -2524,6 +2810,7 @@ export interface DescribeEnvironmentResourcesMessage {
|
|
|
2524
2810
|
*/
|
|
2525
2811
|
EnvironmentId?: string;
|
|
2526
2812
|
/**
|
|
2813
|
+
* @public
|
|
2527
2814
|
* <p>The name of the environment to retrieve AWS resource usage data.</p>
|
|
2528
2815
|
* <p> Condition: You must specify either this or an EnvironmentId, or both. If you do not
|
|
2529
2816
|
* specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error.
|
|
@@ -2537,6 +2824,7 @@ export interface DescribeEnvironmentResourcesMessage {
|
|
|
2537
2824
|
*/
|
|
2538
2825
|
export interface Instance {
|
|
2539
2826
|
/**
|
|
2827
|
+
* @public
|
|
2540
2828
|
* <p>The ID of the Amazon EC2 instance.</p>
|
|
2541
2829
|
*/
|
|
2542
2830
|
Id?: string;
|
|
@@ -2547,6 +2835,7 @@ export interface Instance {
|
|
|
2547
2835
|
*/
|
|
2548
2836
|
export interface LaunchConfiguration {
|
|
2549
2837
|
/**
|
|
2838
|
+
* @public
|
|
2550
2839
|
* <p>The name of the launch configuration.</p>
|
|
2551
2840
|
*/
|
|
2552
2841
|
Name?: string;
|
|
@@ -2557,6 +2846,7 @@ export interface LaunchConfiguration {
|
|
|
2557
2846
|
*/
|
|
2558
2847
|
export interface LaunchTemplate {
|
|
2559
2848
|
/**
|
|
2849
|
+
* @public
|
|
2560
2850
|
* <p>The ID of the launch template.</p>
|
|
2561
2851
|
*/
|
|
2562
2852
|
Id?: string;
|
|
@@ -2567,6 +2857,7 @@ export interface LaunchTemplate {
|
|
|
2567
2857
|
*/
|
|
2568
2858
|
export interface LoadBalancer {
|
|
2569
2859
|
/**
|
|
2860
|
+
* @public
|
|
2570
2861
|
* <p>The name of the LoadBalancer.</p>
|
|
2571
2862
|
*/
|
|
2572
2863
|
Name?: string;
|
|
@@ -2577,10 +2868,12 @@ export interface LoadBalancer {
|
|
|
2577
2868
|
*/
|
|
2578
2869
|
export interface Queue {
|
|
2579
2870
|
/**
|
|
2871
|
+
* @public
|
|
2580
2872
|
* <p>The name of the queue.</p>
|
|
2581
2873
|
*/
|
|
2582
2874
|
Name?: string;
|
|
2583
2875
|
/**
|
|
2876
|
+
* @public
|
|
2584
2877
|
* <p>The URL of the queue.</p>
|
|
2585
2878
|
*/
|
|
2586
2879
|
URL?: string;
|
|
@@ -2591,6 +2884,7 @@ export interface Queue {
|
|
|
2591
2884
|
*/
|
|
2592
2885
|
export interface Trigger {
|
|
2593
2886
|
/**
|
|
2887
|
+
* @public
|
|
2594
2888
|
* <p>The name of the trigger.</p>
|
|
2595
2889
|
*/
|
|
2596
2890
|
Name?: string;
|
|
@@ -2601,34 +2895,42 @@ export interface Trigger {
|
|
|
2601
2895
|
*/
|
|
2602
2896
|
export interface EnvironmentResourceDescription {
|
|
2603
2897
|
/**
|
|
2898
|
+
* @public
|
|
2604
2899
|
* <p>The name of the environment.</p>
|
|
2605
2900
|
*/
|
|
2606
2901
|
EnvironmentName?: string;
|
|
2607
2902
|
/**
|
|
2903
|
+
* @public
|
|
2608
2904
|
* <p> The <code>AutoScalingGroups</code> used by this environment. </p>
|
|
2609
2905
|
*/
|
|
2610
2906
|
AutoScalingGroups?: AutoScalingGroup[];
|
|
2611
2907
|
/**
|
|
2908
|
+
* @public
|
|
2612
2909
|
* <p>The Amazon EC2 instances used by this environment.</p>
|
|
2613
2910
|
*/
|
|
2614
2911
|
Instances?: Instance[];
|
|
2615
2912
|
/**
|
|
2913
|
+
* @public
|
|
2616
2914
|
* <p>The Auto Scaling launch configurations in use by this environment.</p>
|
|
2617
2915
|
*/
|
|
2618
2916
|
LaunchConfigurations?: LaunchConfiguration[];
|
|
2619
2917
|
/**
|
|
2918
|
+
* @public
|
|
2620
2919
|
* <p>The Amazon EC2 launch templates in use by this environment.</p>
|
|
2621
2920
|
*/
|
|
2622
2921
|
LaunchTemplates?: LaunchTemplate[];
|
|
2623
2922
|
/**
|
|
2923
|
+
* @public
|
|
2624
2924
|
* <p>The LoadBalancers in use by this environment.</p>
|
|
2625
2925
|
*/
|
|
2626
2926
|
LoadBalancers?: LoadBalancer[];
|
|
2627
2927
|
/**
|
|
2928
|
+
* @public
|
|
2628
2929
|
* <p>The <code>AutoScaling</code> triggers in use by this environment. </p>
|
|
2629
2930
|
*/
|
|
2630
2931
|
Triggers?: Trigger[];
|
|
2631
2932
|
/**
|
|
2933
|
+
* @public
|
|
2632
2934
|
* <p>The queues used by this environment.</p>
|
|
2633
2935
|
*/
|
|
2634
2936
|
Queues?: Queue[];
|
|
@@ -2639,6 +2941,7 @@ export interface EnvironmentResourceDescription {
|
|
|
2639
2941
|
*/
|
|
2640
2942
|
export interface EnvironmentResourceDescriptionsMessage {
|
|
2641
2943
|
/**
|
|
2944
|
+
* @public
|
|
2642
2945
|
* <p> A list of <a>EnvironmentResourceDescription</a>. </p>
|
|
2643
2946
|
*/
|
|
2644
2947
|
EnvironmentResources?: EnvironmentResourceDescription;
|
|
@@ -2649,26 +2952,31 @@ export interface EnvironmentResourceDescriptionsMessage {
|
|
|
2649
2952
|
*/
|
|
2650
2953
|
export interface DescribeEnvironmentsMessage {
|
|
2651
2954
|
/**
|
|
2955
|
+
* @public
|
|
2652
2956
|
* <p>If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only
|
|
2653
2957
|
* those that are associated with this application.</p>
|
|
2654
2958
|
*/
|
|
2655
2959
|
ApplicationName?: string;
|
|
2656
2960
|
/**
|
|
2961
|
+
* @public
|
|
2657
2962
|
* <p>If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only
|
|
2658
2963
|
* those that are associated with this application version.</p>
|
|
2659
2964
|
*/
|
|
2660
2965
|
VersionLabel?: string;
|
|
2661
2966
|
/**
|
|
2967
|
+
* @public
|
|
2662
2968
|
* <p>If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only
|
|
2663
2969
|
* those that have the specified IDs.</p>
|
|
2664
2970
|
*/
|
|
2665
2971
|
EnvironmentIds?: string[];
|
|
2666
2972
|
/**
|
|
2973
|
+
* @public
|
|
2667
2974
|
* <p>If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only
|
|
2668
2975
|
* those that have the specified names.</p>
|
|
2669
2976
|
*/
|
|
2670
2977
|
EnvironmentNames?: string[];
|
|
2671
2978
|
/**
|
|
2979
|
+
* @public
|
|
2672
2980
|
* <p>Indicates whether to include deleted environments:</p>
|
|
2673
2981
|
* <p>
|
|
2674
2982
|
* <code>true</code>: Environments that have been deleted after
|
|
@@ -2678,11 +2986,13 @@ export interface DescribeEnvironmentsMessage {
|
|
|
2678
2986
|
*/
|
|
2679
2987
|
IncludeDeleted?: boolean;
|
|
2680
2988
|
/**
|
|
2989
|
+
* @public
|
|
2681
2990
|
* <p> If specified when <code>IncludeDeleted</code> is set to <code>true</code>, then
|
|
2682
2991
|
* environments deleted after this date are displayed. </p>
|
|
2683
2992
|
*/
|
|
2684
2993
|
IncludedDeletedBackTo?: Date;
|
|
2685
2994
|
/**
|
|
2995
|
+
* @public
|
|
2686
2996
|
* <p>For a paginated request. Specify a maximum number of environments to include in
|
|
2687
2997
|
* each response.</p>
|
|
2688
2998
|
* <p>If no <code>MaxRecords</code> is specified, all available environments are
|
|
@@ -2690,6 +3000,7 @@ export interface DescribeEnvironmentsMessage {
|
|
|
2690
3000
|
*/
|
|
2691
3001
|
MaxRecords?: number;
|
|
2692
3002
|
/**
|
|
3003
|
+
* @public
|
|
2693
3004
|
* <p>For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other
|
|
2694
3005
|
* parameter values must be identical to the ones specified in the initial request.</p>
|
|
2695
3006
|
* <p>If no <code>NextToken</code> is specified, the first page is retrieved.</p>
|
|
@@ -2718,61 +3029,73 @@ export type EventSeverity = (typeof EventSeverity)[keyof typeof EventSeverity];
|
|
|
2718
3029
|
*/
|
|
2719
3030
|
export interface DescribeEventsMessage {
|
|
2720
3031
|
/**
|
|
3032
|
+
* @public
|
|
2721
3033
|
* <p>If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only
|
|
2722
3034
|
* those associated with this application.</p>
|
|
2723
3035
|
*/
|
|
2724
3036
|
ApplicationName?: string;
|
|
2725
3037
|
/**
|
|
3038
|
+
* @public
|
|
2726
3039
|
* <p>If specified, AWS Elastic Beanstalk restricts the returned descriptions to those
|
|
2727
3040
|
* associated with this application version.</p>
|
|
2728
3041
|
*/
|
|
2729
3042
|
VersionLabel?: string;
|
|
2730
3043
|
/**
|
|
3044
|
+
* @public
|
|
2731
3045
|
* <p>If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that
|
|
2732
3046
|
* are associated with this environment configuration.</p>
|
|
2733
3047
|
*/
|
|
2734
3048
|
TemplateName?: string;
|
|
2735
3049
|
/**
|
|
3050
|
+
* @public
|
|
2736
3051
|
* <p>If specified, AWS Elastic Beanstalk restricts the returned descriptions to those
|
|
2737
3052
|
* associated with this environment.</p>
|
|
2738
3053
|
*/
|
|
2739
3054
|
EnvironmentId?: string;
|
|
2740
3055
|
/**
|
|
3056
|
+
* @public
|
|
2741
3057
|
* <p>If specified, AWS Elastic Beanstalk restricts the returned descriptions to those
|
|
2742
3058
|
* associated with this environment.</p>
|
|
2743
3059
|
*/
|
|
2744
3060
|
EnvironmentName?: string;
|
|
2745
3061
|
/**
|
|
3062
|
+
* @public
|
|
2746
3063
|
* <p>The ARN of a custom platform version. If specified, AWS Elastic Beanstalk restricts the
|
|
2747
3064
|
* returned descriptions to those associated with this custom platform version.</p>
|
|
2748
3065
|
*/
|
|
2749
3066
|
PlatformArn?: string;
|
|
2750
3067
|
/**
|
|
3068
|
+
* @public
|
|
2751
3069
|
* <p>If specified, AWS Elastic Beanstalk restricts the described events to include only
|
|
2752
3070
|
* those associated with this request ID.</p>
|
|
2753
3071
|
*/
|
|
2754
3072
|
RequestId?: string;
|
|
2755
3073
|
/**
|
|
3074
|
+
* @public
|
|
2756
3075
|
* <p>If specified, limits the events returned from this call to include only those with the
|
|
2757
3076
|
* specified severity or higher.</p>
|
|
2758
3077
|
*/
|
|
2759
3078
|
Severity?: EventSeverity | string;
|
|
2760
3079
|
/**
|
|
3080
|
+
* @public
|
|
2761
3081
|
* <p>If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that
|
|
2762
3082
|
* occur on or after this time.</p>
|
|
2763
3083
|
*/
|
|
2764
3084
|
StartTime?: Date;
|
|
2765
3085
|
/**
|
|
3086
|
+
* @public
|
|
2766
3087
|
* <p> If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that
|
|
2767
3088
|
* occur up to, but not including, the <code>EndTime</code>. </p>
|
|
2768
3089
|
*/
|
|
2769
3090
|
EndTime?: Date;
|
|
2770
3091
|
/**
|
|
3092
|
+
* @public
|
|
2771
3093
|
* <p>Specifies the maximum number of events that can be returned, beginning with the most
|
|
2772
3094
|
* recent event.</p>
|
|
2773
3095
|
*/
|
|
2774
3096
|
MaxRecords?: number;
|
|
2775
3097
|
/**
|
|
3098
|
+
* @public
|
|
2776
3099
|
* <p>Pagination token. If specified, the events return the next batch of results.</p>
|
|
2777
3100
|
*/
|
|
2778
3101
|
NextToken?: string;
|
|
@@ -2783,38 +3106,47 @@ export interface DescribeEventsMessage {
|
|
|
2783
3106
|
*/
|
|
2784
3107
|
export interface EventDescription {
|
|
2785
3108
|
/**
|
|
3109
|
+
* @public
|
|
2786
3110
|
* <p>The date when the event occurred.</p>
|
|
2787
3111
|
*/
|
|
2788
3112
|
EventDate?: Date;
|
|
2789
3113
|
/**
|
|
3114
|
+
* @public
|
|
2790
3115
|
* <p>The event message.</p>
|
|
2791
3116
|
*/
|
|
2792
3117
|
Message?: string;
|
|
2793
3118
|
/**
|
|
3119
|
+
* @public
|
|
2794
3120
|
* <p>The application associated with the event.</p>
|
|
2795
3121
|
*/
|
|
2796
3122
|
ApplicationName?: string;
|
|
2797
3123
|
/**
|
|
3124
|
+
* @public
|
|
2798
3125
|
* <p>The release label for the application version associated with this event.</p>
|
|
2799
3126
|
*/
|
|
2800
3127
|
VersionLabel?: string;
|
|
2801
3128
|
/**
|
|
3129
|
+
* @public
|
|
2802
3130
|
* <p>The name of the configuration associated with this event.</p>
|
|
2803
3131
|
*/
|
|
2804
3132
|
TemplateName?: string;
|
|
2805
3133
|
/**
|
|
3134
|
+
* @public
|
|
2806
3135
|
* <p>The name of the environment associated with this event.</p>
|
|
2807
3136
|
*/
|
|
2808
3137
|
EnvironmentName?: string;
|
|
2809
3138
|
/**
|
|
3139
|
+
* @public
|
|
2810
3140
|
* <p>The ARN of the platform version.</p>
|
|
2811
3141
|
*/
|
|
2812
3142
|
PlatformArn?: string;
|
|
2813
3143
|
/**
|
|
3144
|
+
* @public
|
|
2814
3145
|
* <p>The web service request ID for the activity of this event.</p>
|
|
2815
3146
|
*/
|
|
2816
3147
|
RequestId?: string;
|
|
2817
3148
|
/**
|
|
3149
|
+
* @public
|
|
2818
3150
|
* <p>The severity level of this event.</p>
|
|
2819
3151
|
*/
|
|
2820
3152
|
Severity?: EventSeverity | string;
|
|
@@ -2825,10 +3157,12 @@ export interface EventDescription {
|
|
|
2825
3157
|
*/
|
|
2826
3158
|
export interface EventDescriptionsMessage {
|
|
2827
3159
|
/**
|
|
3160
|
+
* @public
|
|
2828
3161
|
* <p> A list of <a>EventDescription</a>. </p>
|
|
2829
3162
|
*/
|
|
2830
3163
|
Events?: EventDescription[];
|
|
2831
3164
|
/**
|
|
3165
|
+
* @public
|
|
2832
3166
|
* <p> If returned, this indicates that there are more results to obtain. Use this token in
|
|
2833
3167
|
* the next <a>DescribeEvents</a> call to get the next batch of events. </p>
|
|
2834
3168
|
*/
|
|
@@ -2861,20 +3195,24 @@ export type InstancesHealthAttribute = (typeof InstancesHealthAttribute)[keyof t
|
|
|
2861
3195
|
*/
|
|
2862
3196
|
export interface DescribeInstancesHealthRequest {
|
|
2863
3197
|
/**
|
|
3198
|
+
* @public
|
|
2864
3199
|
* <p>Specify the AWS Elastic Beanstalk environment by name.</p>
|
|
2865
3200
|
*/
|
|
2866
3201
|
EnvironmentName?: string;
|
|
2867
3202
|
/**
|
|
3203
|
+
* @public
|
|
2868
3204
|
* <p>Specify the AWS Elastic Beanstalk environment by ID.</p>
|
|
2869
3205
|
*/
|
|
2870
3206
|
EnvironmentId?: string;
|
|
2871
3207
|
/**
|
|
3208
|
+
* @public
|
|
2872
3209
|
* <p>Specifies the response elements you wish to receive. To retrieve all attributes, set to
|
|
2873
3210
|
* <code>All</code>. If no attribute names are specified, returns a list of
|
|
2874
3211
|
* instances.</p>
|
|
2875
3212
|
*/
|
|
2876
3213
|
AttributeNames?: (InstancesHealthAttribute | string)[];
|
|
2877
3214
|
/**
|
|
3215
|
+
* @public
|
|
2878
3216
|
* <p>Specify the pagination token returned by a previous call.</p>
|
|
2879
3217
|
*/
|
|
2880
3218
|
NextToken?: string;
|
|
@@ -2885,15 +3223,18 @@ export interface DescribeInstancesHealthRequest {
|
|
|
2885
3223
|
*/
|
|
2886
3224
|
export interface Deployment {
|
|
2887
3225
|
/**
|
|
3226
|
+
* @public
|
|
2888
3227
|
* <p>The version label of the application version in the deployment.</p>
|
|
2889
3228
|
*/
|
|
2890
3229
|
VersionLabel?: string;
|
|
2891
3230
|
/**
|
|
3231
|
+
* @public
|
|
2892
3232
|
* <p>The ID of the deployment. This number increases by one each time that you deploy source
|
|
2893
3233
|
* code or change instance configuration settings.</p>
|
|
2894
3234
|
*/
|
|
2895
3235
|
DeploymentId?: number;
|
|
2896
3236
|
/**
|
|
3237
|
+
* @public
|
|
2897
3238
|
* <p>The status of the deployment:</p>
|
|
2898
3239
|
* <ul>
|
|
2899
3240
|
* <li>
|
|
@@ -2912,6 +3253,7 @@ export interface Deployment {
|
|
|
2912
3253
|
*/
|
|
2913
3254
|
Status?: string;
|
|
2914
3255
|
/**
|
|
3256
|
+
* @public
|
|
2915
3257
|
* <p>For in-progress deployments, the time that the deployment started.</p>
|
|
2916
3258
|
* <p>For completed deployments, the time that the deployment ended.</p>
|
|
2917
3259
|
*/
|
|
@@ -2923,46 +3265,54 @@ export interface Deployment {
|
|
|
2923
3265
|
*/
|
|
2924
3266
|
export interface CPUUtilization {
|
|
2925
3267
|
/**
|
|
3268
|
+
* @public
|
|
2926
3269
|
* <p>Percentage of time that the CPU has spent in the <code>User</code> state over the last
|
|
2927
3270
|
* 10 seconds.</p>
|
|
2928
3271
|
*/
|
|
2929
3272
|
User?: number;
|
|
2930
3273
|
/**
|
|
3274
|
+
* @public
|
|
2931
3275
|
* <p>Available on Linux environments only.</p>
|
|
2932
3276
|
* <p>Percentage of time that the CPU has spent in the <code>Nice</code> state over the last
|
|
2933
3277
|
* 10 seconds.</p>
|
|
2934
3278
|
*/
|
|
2935
3279
|
Nice?: number;
|
|
2936
3280
|
/**
|
|
3281
|
+
* @public
|
|
2937
3282
|
* <p>Available on Linux environments only.</p>
|
|
2938
3283
|
* <p>Percentage of time that the CPU has spent in the <code>System</code> state over the
|
|
2939
3284
|
* last 10 seconds.</p>
|
|
2940
3285
|
*/
|
|
2941
3286
|
System?: number;
|
|
2942
3287
|
/**
|
|
3288
|
+
* @public
|
|
2943
3289
|
* <p>Percentage of time that the CPU has spent in the <code>Idle</code> state over the last
|
|
2944
3290
|
* 10 seconds.</p>
|
|
2945
3291
|
*/
|
|
2946
3292
|
Idle?: number;
|
|
2947
3293
|
/**
|
|
3294
|
+
* @public
|
|
2948
3295
|
* <p>Available on Linux environments only.</p>
|
|
2949
3296
|
* <p>Percentage of time that the CPU has spent in the <code>I/O Wait</code> state over the
|
|
2950
3297
|
* last 10 seconds.</p>
|
|
2951
3298
|
*/
|
|
2952
3299
|
IOWait?: number;
|
|
2953
3300
|
/**
|
|
3301
|
+
* @public
|
|
2954
3302
|
* <p>Available on Linux environments only.</p>
|
|
2955
3303
|
* <p>Percentage of time that the CPU has spent in the <code>IRQ</code> state over the last
|
|
2956
3304
|
* 10 seconds.</p>
|
|
2957
3305
|
*/
|
|
2958
3306
|
IRQ?: number;
|
|
2959
3307
|
/**
|
|
3308
|
+
* @public
|
|
2960
3309
|
* <p>Available on Linux environments only.</p>
|
|
2961
3310
|
* <p>Percentage of time that the CPU has spent in the <code>SoftIRQ</code> state over the
|
|
2962
3311
|
* last 10 seconds.</p>
|
|
2963
3312
|
*/
|
|
2964
3313
|
SoftIRQ?: number;
|
|
2965
3314
|
/**
|
|
3315
|
+
* @public
|
|
2966
3316
|
* <p>Available on Windows environments only.</p>
|
|
2967
3317
|
* <p>Percentage of time that the CPU has spent in the <code>Privileged</code> state over the
|
|
2968
3318
|
* last 10 seconds.</p>
|
|
@@ -2975,10 +3325,12 @@ export interface CPUUtilization {
|
|
|
2975
3325
|
*/
|
|
2976
3326
|
export interface SystemStatus {
|
|
2977
3327
|
/**
|
|
3328
|
+
* @public
|
|
2978
3329
|
* <p>CPU utilization metrics for the instance.</p>
|
|
2979
3330
|
*/
|
|
2980
3331
|
CPUUtilization?: CPUUtilization;
|
|
2981
3332
|
/**
|
|
3333
|
+
* @public
|
|
2982
3334
|
* <p>Load average in the last 1-minute, 5-minute, and 15-minute periods.
|
|
2983
3335
|
* For more information, see
|
|
2984
3336
|
* <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-metrics.html#health-enhanced-metrics-os">Operating System Metrics</a>.</p>
|
|
@@ -2992,46 +3344,56 @@ export interface SystemStatus {
|
|
|
2992
3344
|
*/
|
|
2993
3345
|
export interface SingleInstanceHealth {
|
|
2994
3346
|
/**
|
|
3347
|
+
* @public
|
|
2995
3348
|
* <p>The ID of the Amazon EC2 instance.</p>
|
|
2996
3349
|
*/
|
|
2997
3350
|
InstanceId?: string;
|
|
2998
3351
|
/**
|
|
3352
|
+
* @public
|
|
2999
3353
|
* <p>Returns the health status of the specified instance. For more information, see <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html">Health
|
|
3000
3354
|
* Colors and Statuses</a>.</p>
|
|
3001
3355
|
*/
|
|
3002
3356
|
HealthStatus?: string;
|
|
3003
3357
|
/**
|
|
3358
|
+
* @public
|
|
3004
3359
|
* <p>Represents the color indicator that gives you information about the health of the EC2
|
|
3005
3360
|
* instance. For more information, see <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html">Health Colors and
|
|
3006
3361
|
* Statuses</a>.</p>
|
|
3007
3362
|
*/
|
|
3008
3363
|
Color?: string;
|
|
3009
3364
|
/**
|
|
3365
|
+
* @public
|
|
3010
3366
|
* <p>Represents the causes, which provide more information about the current health
|
|
3011
3367
|
* status.</p>
|
|
3012
3368
|
*/
|
|
3013
3369
|
Causes?: string[];
|
|
3014
3370
|
/**
|
|
3371
|
+
* @public
|
|
3015
3372
|
* <p>The time at which the EC2 instance was launched.</p>
|
|
3016
3373
|
*/
|
|
3017
3374
|
LaunchedAt?: Date;
|
|
3018
3375
|
/**
|
|
3376
|
+
* @public
|
|
3019
3377
|
* <p>Request metrics from your application.</p>
|
|
3020
3378
|
*/
|
|
3021
3379
|
ApplicationMetrics?: ApplicationMetrics;
|
|
3022
3380
|
/**
|
|
3381
|
+
* @public
|
|
3023
3382
|
* <p>Operating system metrics from the instance.</p>
|
|
3024
3383
|
*/
|
|
3025
3384
|
System?: SystemStatus;
|
|
3026
3385
|
/**
|
|
3386
|
+
* @public
|
|
3027
3387
|
* <p>Information about the most recent deployment to an instance.</p>
|
|
3028
3388
|
*/
|
|
3029
3389
|
Deployment?: Deployment;
|
|
3030
3390
|
/**
|
|
3391
|
+
* @public
|
|
3031
3392
|
* <p>The availability zone in which the instance runs.</p>
|
|
3032
3393
|
*/
|
|
3033
3394
|
AvailabilityZone?: string;
|
|
3034
3395
|
/**
|
|
3396
|
+
* @public
|
|
3035
3397
|
* <p>The instance's type.</p>
|
|
3036
3398
|
*/
|
|
3037
3399
|
InstanceType?: string;
|
|
@@ -3043,16 +3405,19 @@ export interface SingleInstanceHealth {
|
|
|
3043
3405
|
*/
|
|
3044
3406
|
export interface DescribeInstancesHealthResult {
|
|
3045
3407
|
/**
|
|
3408
|
+
* @public
|
|
3046
3409
|
* <p>Detailed health information about each instance.</p>
|
|
3047
3410
|
* <p>The output differs slightly between Linux and Windows environments. There is a difference
|
|
3048
3411
|
* in the members that are supported under the <code><CPUUtilization></code> type.</p>
|
|
3049
3412
|
*/
|
|
3050
3413
|
InstanceHealthList?: SingleInstanceHealth[];
|
|
3051
3414
|
/**
|
|
3415
|
+
* @public
|
|
3052
3416
|
* <p>The date and time that the health information was retrieved.</p>
|
|
3053
3417
|
*/
|
|
3054
3418
|
RefreshedAt?: Date;
|
|
3055
3419
|
/**
|
|
3420
|
+
* @public
|
|
3056
3421
|
* <p>Pagination token for the next page of results, if available.</p>
|
|
3057
3422
|
*/
|
|
3058
3423
|
NextToken?: string;
|
|
@@ -3062,6 +3427,7 @@ export interface DescribeInstancesHealthResult {
|
|
|
3062
3427
|
*/
|
|
3063
3428
|
export interface DescribePlatformVersionRequest {
|
|
3064
3429
|
/**
|
|
3430
|
+
* @public
|
|
3065
3431
|
* <p>The ARN of the platform version.</p>
|
|
3066
3432
|
*/
|
|
3067
3433
|
PlatformArn?: string;
|
|
@@ -3072,10 +3438,12 @@ export interface DescribePlatformVersionRequest {
|
|
|
3072
3438
|
*/
|
|
3073
3439
|
export interface CustomAmi {
|
|
3074
3440
|
/**
|
|
3441
|
+
* @public
|
|
3075
3442
|
* <p>The type of virtualization used to create the custom AMI.</p>
|
|
3076
3443
|
*/
|
|
3077
3444
|
VirtualizationType?: string;
|
|
3078
3445
|
/**
|
|
3446
|
+
* @public
|
|
3079
3447
|
* <p>THe ID of the image used to create the custom AMI.</p>
|
|
3080
3448
|
*/
|
|
3081
3449
|
ImageId?: string;
|
|
@@ -3086,10 +3454,12 @@ export interface CustomAmi {
|
|
|
3086
3454
|
*/
|
|
3087
3455
|
export interface PlatformFramework {
|
|
3088
3456
|
/**
|
|
3457
|
+
* @public
|
|
3089
3458
|
* <p>The name of the framework.</p>
|
|
3090
3459
|
*/
|
|
3091
3460
|
Name?: string;
|
|
3092
3461
|
/**
|
|
3462
|
+
* @public
|
|
3093
3463
|
* <p>The version of the framework.</p>
|
|
3094
3464
|
*/
|
|
3095
3465
|
Version?: string;
|
|
@@ -3100,10 +3470,12 @@ export interface PlatformFramework {
|
|
|
3100
3470
|
*/
|
|
3101
3471
|
export interface PlatformProgrammingLanguage {
|
|
3102
3472
|
/**
|
|
3473
|
+
* @public
|
|
3103
3474
|
* <p>The name of the programming language.</p>
|
|
3104
3475
|
*/
|
|
3105
3476
|
Name?: string;
|
|
3106
3477
|
/**
|
|
3478
|
+
* @public
|
|
3107
3479
|
* <p>The version of the programming language.</p>
|
|
3108
3480
|
*/
|
|
3109
3481
|
Version?: string;
|
|
@@ -3114,78 +3486,97 @@ export interface PlatformProgrammingLanguage {
|
|
|
3114
3486
|
*/
|
|
3115
3487
|
export interface PlatformDescription {
|
|
3116
3488
|
/**
|
|
3489
|
+
* @public
|
|
3117
3490
|
* <p>The ARN of the platform version.</p>
|
|
3118
3491
|
*/
|
|
3119
3492
|
PlatformArn?: string;
|
|
3120
3493
|
/**
|
|
3494
|
+
* @public
|
|
3121
3495
|
* <p>The AWS account ID of the person who created the platform version.</p>
|
|
3122
3496
|
*/
|
|
3123
3497
|
PlatformOwner?: string;
|
|
3124
3498
|
/**
|
|
3499
|
+
* @public
|
|
3125
3500
|
* <p>The name of the platform version.</p>
|
|
3126
3501
|
*/
|
|
3127
3502
|
PlatformName?: string;
|
|
3128
3503
|
/**
|
|
3504
|
+
* @public
|
|
3129
3505
|
* <p>The version of the platform version.</p>
|
|
3130
3506
|
*/
|
|
3131
3507
|
PlatformVersion?: string;
|
|
3132
3508
|
/**
|
|
3509
|
+
* @public
|
|
3133
3510
|
* <p>The name of the solution stack used by the platform version.</p>
|
|
3134
3511
|
*/
|
|
3135
3512
|
SolutionStackName?: string;
|
|
3136
3513
|
/**
|
|
3514
|
+
* @public
|
|
3137
3515
|
* <p>The status of the platform version.</p>
|
|
3138
3516
|
*/
|
|
3139
3517
|
PlatformStatus?: PlatformStatus | string;
|
|
3140
3518
|
/**
|
|
3519
|
+
* @public
|
|
3141
3520
|
* <p>The date when the platform version was created.</p>
|
|
3142
3521
|
*/
|
|
3143
3522
|
DateCreated?: Date;
|
|
3144
3523
|
/**
|
|
3524
|
+
* @public
|
|
3145
3525
|
* <p>The date when the platform version was last updated.</p>
|
|
3146
3526
|
*/
|
|
3147
3527
|
DateUpdated?: Date;
|
|
3148
3528
|
/**
|
|
3529
|
+
* @public
|
|
3149
3530
|
* <p>The category of the platform version.</p>
|
|
3150
3531
|
*/
|
|
3151
3532
|
PlatformCategory?: string;
|
|
3152
3533
|
/**
|
|
3534
|
+
* @public
|
|
3153
3535
|
* <p>The description of the platform version.</p>
|
|
3154
3536
|
*/
|
|
3155
3537
|
Description?: string;
|
|
3156
3538
|
/**
|
|
3539
|
+
* @public
|
|
3157
3540
|
* <p>Information about the maintainer of the platform version.</p>
|
|
3158
3541
|
*/
|
|
3159
3542
|
Maintainer?: string;
|
|
3160
3543
|
/**
|
|
3544
|
+
* @public
|
|
3161
3545
|
* <p>The operating system used by the platform version.</p>
|
|
3162
3546
|
*/
|
|
3163
3547
|
OperatingSystemName?: string;
|
|
3164
3548
|
/**
|
|
3549
|
+
* @public
|
|
3165
3550
|
* <p>The version of the operating system used by the platform version.</p>
|
|
3166
3551
|
*/
|
|
3167
3552
|
OperatingSystemVersion?: string;
|
|
3168
3553
|
/**
|
|
3554
|
+
* @public
|
|
3169
3555
|
* <p>The programming languages supported by the platform version.</p>
|
|
3170
3556
|
*/
|
|
3171
3557
|
ProgrammingLanguages?: PlatformProgrammingLanguage[];
|
|
3172
3558
|
/**
|
|
3559
|
+
* @public
|
|
3173
3560
|
* <p>The frameworks supported by the platform version.</p>
|
|
3174
3561
|
*/
|
|
3175
3562
|
Frameworks?: PlatformFramework[];
|
|
3176
3563
|
/**
|
|
3564
|
+
* @public
|
|
3177
3565
|
* <p>The custom AMIs supported by the platform version.</p>
|
|
3178
3566
|
*/
|
|
3179
3567
|
CustomAmiList?: CustomAmi[];
|
|
3180
3568
|
/**
|
|
3569
|
+
* @public
|
|
3181
3570
|
* <p>The tiers supported by the platform version.</p>
|
|
3182
3571
|
*/
|
|
3183
3572
|
SupportedTierList?: string[];
|
|
3184
3573
|
/**
|
|
3574
|
+
* @public
|
|
3185
3575
|
* <p>The additions supported by the platform version.</p>
|
|
3186
3576
|
*/
|
|
3187
3577
|
SupportedAddonList?: string[];
|
|
3188
3578
|
/**
|
|
3579
|
+
* @public
|
|
3189
3580
|
* <p>The state of the platform version in its lifecycle.</p>
|
|
3190
3581
|
* <p>Possible values: <code>Recommended</code> | <code>null</code>
|
|
3191
3582
|
* </p>
|
|
@@ -3195,10 +3586,12 @@ export interface PlatformDescription {
|
|
|
3195
3586
|
*/
|
|
3196
3587
|
PlatformLifecycleState?: string;
|
|
3197
3588
|
/**
|
|
3589
|
+
* @public
|
|
3198
3590
|
* <p>The platform branch to which the platform version belongs.</p>
|
|
3199
3591
|
*/
|
|
3200
3592
|
PlatformBranchName?: string;
|
|
3201
3593
|
/**
|
|
3594
|
+
* @public
|
|
3202
3595
|
* <p>The state of the platform version's branch in its lifecycle.</p>
|
|
3203
3596
|
* <p>Possible values: <code>Beta</code> | <code>Supported</code> | <code>Deprecated</code> |
|
|
3204
3597
|
* <code>Retired</code>
|
|
@@ -3211,6 +3604,7 @@ export interface PlatformDescription {
|
|
|
3211
3604
|
*/
|
|
3212
3605
|
export interface DescribePlatformVersionResult {
|
|
3213
3606
|
/**
|
|
3607
|
+
* @public
|
|
3214
3608
|
* <p>Detailed information about the platform version.</p>
|
|
3215
3609
|
*/
|
|
3216
3610
|
PlatformDescription?: PlatformDescription;
|
|
@@ -3221,6 +3615,7 @@ export interface DescribePlatformVersionResult {
|
|
|
3221
3615
|
*/
|
|
3222
3616
|
export interface DisassociateEnvironmentOperationsRoleMessage {
|
|
3223
3617
|
/**
|
|
3618
|
+
* @public
|
|
3224
3619
|
* <p>The name of the environment from which to disassociate the operations role.</p>
|
|
3225
3620
|
*/
|
|
3226
3621
|
EnvironmentName: string | undefined;
|
|
@@ -3231,10 +3626,12 @@ export interface DisassociateEnvironmentOperationsRoleMessage {
|
|
|
3231
3626
|
*/
|
|
3232
3627
|
export interface ListAvailableSolutionStacksResultMessage {
|
|
3233
3628
|
/**
|
|
3629
|
+
* @public
|
|
3234
3630
|
* <p>A list of available solution stacks.</p>
|
|
3235
3631
|
*/
|
|
3236
3632
|
SolutionStacks?: string[];
|
|
3237
3633
|
/**
|
|
3634
|
+
* @public
|
|
3238
3635
|
* <p> A list of available solution stacks and their <a>SolutionStackDescription</a>. </p>
|
|
3239
3636
|
*/
|
|
3240
3637
|
SolutionStackDetails?: SolutionStackDescription[];
|
|
@@ -3256,16 +3653,19 @@ export interface ListAvailableSolutionStacksResultMessage {
|
|
|
3256
3653
|
*/
|
|
3257
3654
|
export interface SearchFilter {
|
|
3258
3655
|
/**
|
|
3656
|
+
* @public
|
|
3259
3657
|
* <p>The result attribute to which the filter values are applied. Valid values vary by API
|
|
3260
3658
|
* action.</p>
|
|
3261
3659
|
*/
|
|
3262
3660
|
Attribute?: string;
|
|
3263
3661
|
/**
|
|
3662
|
+
* @public
|
|
3264
3663
|
* <p>The operator to apply to the <code>Attribute</code> with each of the <code>Values</code>.
|
|
3265
3664
|
* Valid values vary by <code>Attribute</code>.</p>
|
|
3266
3665
|
*/
|
|
3267
3666
|
Operator?: string;
|
|
3268
3667
|
/**
|
|
3668
|
+
* @public
|
|
3269
3669
|
* <p>The list of values applied to the <code>Attribute</code> and <code>Operator</code>
|
|
3270
3670
|
* attributes. Number of values and valid values vary by <code>Attribute</code>.</p>
|
|
3271
3671
|
*/
|
|
@@ -3276,6 +3676,7 @@ export interface SearchFilter {
|
|
|
3276
3676
|
*/
|
|
3277
3677
|
export interface ListPlatformBranchesRequest {
|
|
3278
3678
|
/**
|
|
3679
|
+
* @public
|
|
3279
3680
|
* <p>Criteria for restricting the resulting list of platform branches. The filter is evaluated
|
|
3280
3681
|
* as a logical conjunction (AND) of the separate <code>SearchFilter</code> terms.</p>
|
|
3281
3682
|
* <p>The following list shows valid attribute values for each of the <code>SearchFilter</code>
|
|
@@ -3349,10 +3750,12 @@ export interface ListPlatformBranchesRequest {
|
|
|
3349
3750
|
*/
|
|
3350
3751
|
Filters?: SearchFilter[];
|
|
3351
3752
|
/**
|
|
3753
|
+
* @public
|
|
3352
3754
|
* <p>The maximum number of platform branch values returned in one call.</p>
|
|
3353
3755
|
*/
|
|
3354
3756
|
MaxRecords?: number;
|
|
3355
3757
|
/**
|
|
3758
|
+
* @public
|
|
3356
3759
|
* <p>For a paginated request. Specify a token from a previous response page to retrieve the
|
|
3357
3760
|
* next response page. All other parameter values must be identical to the ones specified in the
|
|
3358
3761
|
* initial request.</p>
|
|
@@ -3366,14 +3769,17 @@ export interface ListPlatformBranchesRequest {
|
|
|
3366
3769
|
*/
|
|
3367
3770
|
export interface PlatformBranchSummary {
|
|
3368
3771
|
/**
|
|
3772
|
+
* @public
|
|
3369
3773
|
* <p>The name of the platform to which this platform branch belongs.</p>
|
|
3370
3774
|
*/
|
|
3371
3775
|
PlatformName?: string;
|
|
3372
3776
|
/**
|
|
3777
|
+
* @public
|
|
3373
3778
|
* <p>The name of the platform branch.</p>
|
|
3374
3779
|
*/
|
|
3375
3780
|
BranchName?: string;
|
|
3376
3781
|
/**
|
|
3782
|
+
* @public
|
|
3377
3783
|
* <p>The support life cycle state of the platform branch.</p>
|
|
3378
3784
|
* <p>Possible values: <code>beta</code> | <code>supported</code> | <code>deprecated</code> |
|
|
3379
3785
|
* <code>retired</code>
|
|
@@ -3381,6 +3787,7 @@ export interface PlatformBranchSummary {
|
|
|
3381
3787
|
*/
|
|
3382
3788
|
LifecycleState?: string;
|
|
3383
3789
|
/**
|
|
3790
|
+
* @public
|
|
3384
3791
|
* <p>An ordinal number that designates the order in which platform branches have been added to
|
|
3385
3792
|
* a platform. This can be helpful, for example, if your code calls the
|
|
3386
3793
|
* <code>ListPlatformBranches</code> action and then displays a list of platform
|
|
@@ -3390,6 +3797,7 @@ export interface PlatformBranchSummary {
|
|
|
3390
3797
|
*/
|
|
3391
3798
|
BranchOrder?: number;
|
|
3392
3799
|
/**
|
|
3800
|
+
* @public
|
|
3393
3801
|
* <p>The environment tiers that platform versions in this branch support.</p>
|
|
3394
3802
|
* <p>Possible values: <code>WebServer/Standard</code> | <code>Worker/SQS/HTTP</code>
|
|
3395
3803
|
* </p>
|
|
@@ -3401,10 +3809,12 @@ export interface PlatformBranchSummary {
|
|
|
3401
3809
|
*/
|
|
3402
3810
|
export interface ListPlatformBranchesResult {
|
|
3403
3811
|
/**
|
|
3812
|
+
* @public
|
|
3404
3813
|
* <p>Summary information about the platform branches.</p>
|
|
3405
3814
|
*/
|
|
3406
3815
|
PlatformBranchSummaryList?: PlatformBranchSummary[];
|
|
3407
3816
|
/**
|
|
3817
|
+
* @public
|
|
3408
3818
|
* <p>In a paginated request, if this value isn't <code>null</code>, it's the token that you can
|
|
3409
3819
|
* pass in a subsequent request to get the next response page.</p>
|
|
3410
3820
|
*/
|
|
@@ -3418,6 +3828,7 @@ export interface ListPlatformBranchesResult {
|
|
|
3418
3828
|
*/
|
|
3419
3829
|
export interface PlatformFilter {
|
|
3420
3830
|
/**
|
|
3831
|
+
* @public
|
|
3421
3832
|
* <p>The platform version attribute to which the filter values are applied.</p>
|
|
3422
3833
|
* <p>Valid values: <code>PlatformName</code> | <code>PlatformVersion</code> |
|
|
3423
3834
|
* <code>PlatformStatus</code> | <code>PlatformBranchName</code> |
|
|
@@ -3428,6 +3839,7 @@ export interface PlatformFilter {
|
|
|
3428
3839
|
*/
|
|
3429
3840
|
Type?: string;
|
|
3430
3841
|
/**
|
|
3842
|
+
* @public
|
|
3431
3843
|
* <p>The operator to apply to the <code>Type</code> with each of the
|
|
3432
3844
|
* <code>Values</code>.</p>
|
|
3433
3845
|
* <p>Valid values: <code>=</code> | <code>!=</code> |
|
|
@@ -3438,6 +3850,7 @@ export interface PlatformFilter {
|
|
|
3438
3850
|
*/
|
|
3439
3851
|
Operator?: string;
|
|
3440
3852
|
/**
|
|
3853
|
+
* @public
|
|
3441
3854
|
* <p>The list of values applied to the filtering platform version attribute. Only one value is supported
|
|
3442
3855
|
* for all current operators.</p>
|
|
3443
3856
|
* <p>The following list shows valid filter values for some filter attributes.</p>
|
|
@@ -3474,16 +3887,19 @@ export interface PlatformFilter {
|
|
|
3474
3887
|
*/
|
|
3475
3888
|
export interface ListPlatformVersionsRequest {
|
|
3476
3889
|
/**
|
|
3890
|
+
* @public
|
|
3477
3891
|
* <p>Criteria for restricting the resulting list of platform versions. The filter is
|
|
3478
3892
|
* interpreted as a logical conjunction (AND) of the separate <code>PlatformFilter</code>
|
|
3479
3893
|
* terms.</p>
|
|
3480
3894
|
*/
|
|
3481
3895
|
Filters?: PlatformFilter[];
|
|
3482
3896
|
/**
|
|
3897
|
+
* @public
|
|
3483
3898
|
* <p>The maximum number of platform version values returned in one call.</p>
|
|
3484
3899
|
*/
|
|
3485
3900
|
MaxRecords?: number;
|
|
3486
3901
|
/**
|
|
3902
|
+
* @public
|
|
3487
3903
|
* <p>For a paginated request. Specify a token from a previous response page to retrieve the
|
|
3488
3904
|
* next response page. All other parameter values must be identical to the ones specified in the
|
|
3489
3905
|
* initial request.</p>
|
|
@@ -3496,10 +3912,12 @@ export interface ListPlatformVersionsRequest {
|
|
|
3496
3912
|
*/
|
|
3497
3913
|
export interface ListPlatformVersionsResult {
|
|
3498
3914
|
/**
|
|
3915
|
+
* @public
|
|
3499
3916
|
* <p>Summary information about the platform versions.</p>
|
|
3500
3917
|
*/
|
|
3501
3918
|
PlatformSummaryList?: PlatformSummary[];
|
|
3502
3919
|
/**
|
|
3920
|
+
* @public
|
|
3503
3921
|
* <p>In a paginated request, if this value isn't <code>null</code>, it's the token that you can
|
|
3504
3922
|
* pass in a subsequent request to get the next response page.</p>
|
|
3505
3923
|
*/
|
|
@@ -3510,6 +3928,7 @@ export interface ListPlatformVersionsResult {
|
|
|
3510
3928
|
*/
|
|
3511
3929
|
export interface ListTagsForResourceMessage {
|
|
3512
3930
|
/**
|
|
3931
|
+
* @public
|
|
3513
3932
|
* <p>The Amazon Resource Name (ARN) of the resouce for which a tag list is requested.</p>
|
|
3514
3933
|
* <p>Must be the ARN of an Elastic Beanstalk resource.</p>
|
|
3515
3934
|
*/
|
|
@@ -3532,10 +3951,12 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
3532
3951
|
*/
|
|
3533
3952
|
export interface ResourceTagsDescriptionMessage {
|
|
3534
3953
|
/**
|
|
3954
|
+
* @public
|
|
3535
3955
|
* <p>The Amazon Resource Name (ARN) of the resource for which a tag list was requested.</p>
|
|
3536
3956
|
*/
|
|
3537
3957
|
ResourceArn?: string;
|
|
3538
3958
|
/**
|
|
3959
|
+
* @public
|
|
3539
3960
|
* <p>A list of tag key-value pairs.</p>
|
|
3540
3961
|
*/
|
|
3541
3962
|
ResourceTags?: Tag[];
|
|
@@ -3558,6 +3979,7 @@ export declare class ResourceTypeNotSupportedException extends __BaseException {
|
|
|
3558
3979
|
*/
|
|
3559
3980
|
export interface RebuildEnvironmentMessage {
|
|
3560
3981
|
/**
|
|
3982
|
+
* @public
|
|
3561
3983
|
* <p>The ID of the environment to rebuild.</p>
|
|
3562
3984
|
* <p> Condition: You must specify either this or an EnvironmentName, or both. If you do not
|
|
3563
3985
|
* specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error.
|
|
@@ -3565,6 +3987,7 @@ export interface RebuildEnvironmentMessage {
|
|
|
3565
3987
|
*/
|
|
3566
3988
|
EnvironmentId?: string;
|
|
3567
3989
|
/**
|
|
3990
|
+
* @public
|
|
3568
3991
|
* <p>The name of the environment to rebuild.</p>
|
|
3569
3992
|
* <p> Condition: You must specify either this or an EnvironmentId, or both. If you do not
|
|
3570
3993
|
* specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error.
|
|
@@ -3591,6 +4014,7 @@ export type EnvironmentInfoType = (typeof EnvironmentInfoType)[keyof typeof Envi
|
|
|
3591
4014
|
*/
|
|
3592
4015
|
export interface RequestEnvironmentInfoMessage {
|
|
3593
4016
|
/**
|
|
4017
|
+
* @public
|
|
3594
4018
|
* <p>The ID of the environment of the requested data.</p>
|
|
3595
4019
|
* <p>If no such environment is found, <code>RequestEnvironmentInfo</code> returns an
|
|
3596
4020
|
* <code>InvalidParameterValue</code> error. </p>
|
|
@@ -3600,6 +4024,7 @@ export interface RequestEnvironmentInfoMessage {
|
|
|
3600
4024
|
*/
|
|
3601
4025
|
EnvironmentId?: string;
|
|
3602
4026
|
/**
|
|
4027
|
+
* @public
|
|
3603
4028
|
* <p>The name of the environment of the requested data.</p>
|
|
3604
4029
|
* <p>If no such environment is found, <code>RequestEnvironmentInfo</code> returns an
|
|
3605
4030
|
* <code>InvalidParameterValue</code> error. </p>
|
|
@@ -3609,6 +4034,7 @@ export interface RequestEnvironmentInfoMessage {
|
|
|
3609
4034
|
*/
|
|
3610
4035
|
EnvironmentName?: string;
|
|
3611
4036
|
/**
|
|
4037
|
+
* @public
|
|
3612
4038
|
* <p>The type of information to request.</p>
|
|
3613
4039
|
*/
|
|
3614
4040
|
InfoType: EnvironmentInfoType | string | undefined;
|
|
@@ -3619,6 +4045,7 @@ export interface RequestEnvironmentInfoMessage {
|
|
|
3619
4045
|
*/
|
|
3620
4046
|
export interface RestartAppServerMessage {
|
|
3621
4047
|
/**
|
|
4048
|
+
* @public
|
|
3622
4049
|
* <p>The ID of the environment to restart the server for.</p>
|
|
3623
4050
|
* <p> Condition: You must specify either this or an EnvironmentName, or both. If you do not
|
|
3624
4051
|
* specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error.
|
|
@@ -3626,6 +4053,7 @@ export interface RestartAppServerMessage {
|
|
|
3626
4053
|
*/
|
|
3627
4054
|
EnvironmentId?: string;
|
|
3628
4055
|
/**
|
|
4056
|
+
* @public
|
|
3629
4057
|
* <p>The name of the environment to restart the server for.</p>
|
|
3630
4058
|
* <p> Condition: You must specify either this or an EnvironmentId, or both. If you do not
|
|
3631
4059
|
* specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error.
|
|
@@ -3639,6 +4067,7 @@ export interface RestartAppServerMessage {
|
|
|
3639
4067
|
*/
|
|
3640
4068
|
export interface RetrieveEnvironmentInfoMessage {
|
|
3641
4069
|
/**
|
|
4070
|
+
* @public
|
|
3642
4071
|
* <p>The ID of the data's environment.</p>
|
|
3643
4072
|
* <p>If no such environment is found, returns an <code>InvalidParameterValue</code>
|
|
3644
4073
|
* error.</p>
|
|
@@ -3648,6 +4077,7 @@ export interface RetrieveEnvironmentInfoMessage {
|
|
|
3648
4077
|
*/
|
|
3649
4078
|
EnvironmentId?: string;
|
|
3650
4079
|
/**
|
|
4080
|
+
* @public
|
|
3651
4081
|
* <p>The name of the data's environment.</p>
|
|
3652
4082
|
* <p> If no such environment is found, returns an <code>InvalidParameterValue</code> error. </p>
|
|
3653
4083
|
* <p> Condition: You must specify either this or an EnvironmentId, or both. If you do not
|
|
@@ -3656,6 +4086,7 @@ export interface RetrieveEnvironmentInfoMessage {
|
|
|
3656
4086
|
*/
|
|
3657
4087
|
EnvironmentName?: string;
|
|
3658
4088
|
/**
|
|
4089
|
+
* @public
|
|
3659
4090
|
* <p>The type of information to retrieve.</p>
|
|
3660
4091
|
*/
|
|
3661
4092
|
InfoType: EnvironmentInfoType | string | undefined;
|
|
@@ -3666,18 +4097,22 @@ export interface RetrieveEnvironmentInfoMessage {
|
|
|
3666
4097
|
*/
|
|
3667
4098
|
export interface EnvironmentInfoDescription {
|
|
3668
4099
|
/**
|
|
4100
|
+
* @public
|
|
3669
4101
|
* <p>The type of information retrieved.</p>
|
|
3670
4102
|
*/
|
|
3671
4103
|
InfoType?: EnvironmentInfoType | string;
|
|
3672
4104
|
/**
|
|
4105
|
+
* @public
|
|
3673
4106
|
* <p>The Amazon EC2 Instance ID for this information.</p>
|
|
3674
4107
|
*/
|
|
3675
4108
|
Ec2InstanceId?: string;
|
|
3676
4109
|
/**
|
|
4110
|
+
* @public
|
|
3677
4111
|
* <p>The time stamp when this information was retrieved.</p>
|
|
3678
4112
|
*/
|
|
3679
4113
|
SampleTimestamp?: Date;
|
|
3680
4114
|
/**
|
|
4115
|
+
* @public
|
|
3681
4116
|
* <p>The retrieved information. Currently contains a presigned Amazon S3 URL. The files are
|
|
3682
4117
|
* deleted after 15 minutes.</p>
|
|
3683
4118
|
* <p>Anyone in possession of this URL can access the files before they are deleted. Make the
|
|
@@ -3691,6 +4126,7 @@ export interface EnvironmentInfoDescription {
|
|
|
3691
4126
|
*/
|
|
3692
4127
|
export interface RetrieveEnvironmentInfoResultMessage {
|
|
3693
4128
|
/**
|
|
4129
|
+
* @public
|
|
3694
4130
|
* <p> The <a>EnvironmentInfoDescription</a> of the environment. </p>
|
|
3695
4131
|
*/
|
|
3696
4132
|
EnvironmentInfo?: EnvironmentInfoDescription[];
|
|
@@ -3701,6 +4137,7 @@ export interface RetrieveEnvironmentInfoResultMessage {
|
|
|
3701
4137
|
*/
|
|
3702
4138
|
export interface SwapEnvironmentCNAMEsMessage {
|
|
3703
4139
|
/**
|
|
4140
|
+
* @public
|
|
3704
4141
|
* <p>The ID of the source environment.</p>
|
|
3705
4142
|
* <p> Condition: You must specify at least the <code>SourceEnvironmentID</code> or the
|
|
3706
4143
|
* <code>SourceEnvironmentName</code>. You may also specify both. If you specify the
|
|
@@ -3709,6 +4146,7 @@ export interface SwapEnvironmentCNAMEsMessage {
|
|
|
3709
4146
|
*/
|
|
3710
4147
|
SourceEnvironmentId?: string;
|
|
3711
4148
|
/**
|
|
4149
|
+
* @public
|
|
3712
4150
|
* <p>The name of the source environment.</p>
|
|
3713
4151
|
* <p> Condition: You must specify at least the <code>SourceEnvironmentID</code> or the
|
|
3714
4152
|
* <code>SourceEnvironmentName</code>. You may also specify both. If you specify the
|
|
@@ -3717,6 +4155,7 @@ export interface SwapEnvironmentCNAMEsMessage {
|
|
|
3717
4155
|
*/
|
|
3718
4156
|
SourceEnvironmentName?: string;
|
|
3719
4157
|
/**
|
|
4158
|
+
* @public
|
|
3720
4159
|
* <p>The ID of the destination environment.</p>
|
|
3721
4160
|
* <p> Condition: You must specify at least the <code>DestinationEnvironmentID</code> or the
|
|
3722
4161
|
* <code>DestinationEnvironmentName</code>. You may also specify both. You must specify the
|
|
@@ -3724,6 +4163,7 @@ export interface SwapEnvironmentCNAMEsMessage {
|
|
|
3724
4163
|
*/
|
|
3725
4164
|
DestinationEnvironmentId?: string;
|
|
3726
4165
|
/**
|
|
4166
|
+
* @public
|
|
3727
4167
|
* <p>The name of the destination environment.</p>
|
|
3728
4168
|
* <p> Condition: You must specify at least the <code>DestinationEnvironmentID</code> or the
|
|
3729
4169
|
* <code>DestinationEnvironmentName</code>. You may also specify both. You must specify the
|
|
@@ -3738,6 +4178,7 @@ export interface SwapEnvironmentCNAMEsMessage {
|
|
|
3738
4178
|
*/
|
|
3739
4179
|
export interface TerminateEnvironmentMessage {
|
|
3740
4180
|
/**
|
|
4181
|
+
* @public
|
|
3741
4182
|
* <p>The ID of the environment to terminate.</p>
|
|
3742
4183
|
* <p> Condition: You must specify either this or an EnvironmentName, or both. If you do not
|
|
3743
4184
|
* specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error.
|
|
@@ -3745,6 +4186,7 @@ export interface TerminateEnvironmentMessage {
|
|
|
3745
4186
|
*/
|
|
3746
4187
|
EnvironmentId?: string;
|
|
3747
4188
|
/**
|
|
4189
|
+
* @public
|
|
3748
4190
|
* <p>The name of the environment to terminate.</p>
|
|
3749
4191
|
* <p> Condition: You must specify either this or an EnvironmentId, or both. If you do not
|
|
3750
4192
|
* specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error.
|
|
@@ -3752,6 +4194,7 @@ export interface TerminateEnvironmentMessage {
|
|
|
3752
4194
|
*/
|
|
3753
4195
|
EnvironmentName?: string;
|
|
3754
4196
|
/**
|
|
4197
|
+
* @public
|
|
3755
4198
|
* <p>Indicates whether the associated AWS resources should shut down when the environment is
|
|
3756
4199
|
* terminated:</p>
|
|
3757
4200
|
* <ul>
|
|
@@ -3775,6 +4218,7 @@ export interface TerminateEnvironmentMessage {
|
|
|
3775
4218
|
*/
|
|
3776
4219
|
TerminateResources?: boolean;
|
|
3777
4220
|
/**
|
|
4221
|
+
* @public
|
|
3778
4222
|
* <p>Terminates the target environment even if another environment in the same group is
|
|
3779
4223
|
* dependent on it.</p>
|
|
3780
4224
|
*/
|
|
@@ -3786,12 +4230,14 @@ export interface TerminateEnvironmentMessage {
|
|
|
3786
4230
|
*/
|
|
3787
4231
|
export interface UpdateApplicationMessage {
|
|
3788
4232
|
/**
|
|
4233
|
+
* @public
|
|
3789
4234
|
* <p>The name of the application to update. If no such application is found,
|
|
3790
4235
|
* <code>UpdateApplication</code> returns an <code>InvalidParameterValue</code> error.
|
|
3791
4236
|
* </p>
|
|
3792
4237
|
*/
|
|
3793
4238
|
ApplicationName: string | undefined;
|
|
3794
4239
|
/**
|
|
4240
|
+
* @public
|
|
3795
4241
|
* <p>A new description for the application.</p>
|
|
3796
4242
|
* <p>Default: If not specified, AWS Elastic Beanstalk does not update the
|
|
3797
4243
|
* description.</p>
|
|
@@ -3803,10 +4249,12 @@ export interface UpdateApplicationMessage {
|
|
|
3803
4249
|
*/
|
|
3804
4250
|
export interface UpdateApplicationResourceLifecycleMessage {
|
|
3805
4251
|
/**
|
|
4252
|
+
* @public
|
|
3806
4253
|
* <p>The name of the application.</p>
|
|
3807
4254
|
*/
|
|
3808
4255
|
ApplicationName: string | undefined;
|
|
3809
4256
|
/**
|
|
4257
|
+
* @public
|
|
3810
4258
|
* <p>The lifecycle configuration.</p>
|
|
3811
4259
|
*/
|
|
3812
4260
|
ResourceLifecycleConfig: ApplicationResourceLifecycleConfig | undefined;
|
|
@@ -3817,18 +4265,21 @@ export interface UpdateApplicationResourceLifecycleMessage {
|
|
|
3817
4265
|
*/
|
|
3818
4266
|
export interface UpdateApplicationVersionMessage {
|
|
3819
4267
|
/**
|
|
4268
|
+
* @public
|
|
3820
4269
|
* <p>The name of the application associated with this version.</p>
|
|
3821
4270
|
* <p> If no application is found with this name, <code>UpdateApplication</code> returns an
|
|
3822
4271
|
* <code>InvalidParameterValue</code> error.</p>
|
|
3823
4272
|
*/
|
|
3824
4273
|
ApplicationName: string | undefined;
|
|
3825
4274
|
/**
|
|
4275
|
+
* @public
|
|
3826
4276
|
* <p>The name of the version to update.</p>
|
|
3827
4277
|
* <p>If no application version is found with this label, <code>UpdateApplication</code>
|
|
3828
4278
|
* returns an <code>InvalidParameterValue</code> error. </p>
|
|
3829
4279
|
*/
|
|
3830
4280
|
VersionLabel: string | undefined;
|
|
3831
4281
|
/**
|
|
4282
|
+
* @public
|
|
3832
4283
|
* <p>A new description for this version.</p>
|
|
3833
4284
|
*/
|
|
3834
4285
|
Description?: string;
|
|
@@ -3839,6 +4290,7 @@ export interface UpdateApplicationVersionMessage {
|
|
|
3839
4290
|
*/
|
|
3840
4291
|
export interface UpdateConfigurationTemplateMessage {
|
|
3841
4292
|
/**
|
|
4293
|
+
* @public
|
|
3842
4294
|
* <p>The name of the application associated with the configuration template to
|
|
3843
4295
|
* update.</p>
|
|
3844
4296
|
* <p> If no application is found with this name, <code>UpdateConfigurationTemplate</code>
|
|
@@ -3846,6 +4298,7 @@ export interface UpdateConfigurationTemplateMessage {
|
|
|
3846
4298
|
*/
|
|
3847
4299
|
ApplicationName: string | undefined;
|
|
3848
4300
|
/**
|
|
4301
|
+
* @public
|
|
3849
4302
|
* <p>The name of the configuration template to update.</p>
|
|
3850
4303
|
* <p> If no configuration template is found with this name,
|
|
3851
4304
|
* <code>UpdateConfigurationTemplate</code> returns an <code>InvalidParameterValue</code>
|
|
@@ -3853,15 +4306,18 @@ export interface UpdateConfigurationTemplateMessage {
|
|
|
3853
4306
|
*/
|
|
3854
4307
|
TemplateName: string | undefined;
|
|
3855
4308
|
/**
|
|
4309
|
+
* @public
|
|
3856
4310
|
* <p>A new description for the configuration.</p>
|
|
3857
4311
|
*/
|
|
3858
4312
|
Description?: string;
|
|
3859
4313
|
/**
|
|
4314
|
+
* @public
|
|
3860
4315
|
* <p>A list of configuration option settings to update with the new specified option
|
|
3861
4316
|
* value.</p>
|
|
3862
4317
|
*/
|
|
3863
4318
|
OptionSettings?: ConfigurationOptionSetting[];
|
|
3864
4319
|
/**
|
|
4320
|
+
* @public
|
|
3865
4321
|
* <p>A list of configuration options to remove from the configuration set.</p>
|
|
3866
4322
|
* <p> Constraint: You can remove only <code>UserDefined</code> configuration options.
|
|
3867
4323
|
* </p>
|
|
@@ -3874,10 +4330,12 @@ export interface UpdateConfigurationTemplateMessage {
|
|
|
3874
4330
|
*/
|
|
3875
4331
|
export interface UpdateEnvironmentMessage {
|
|
3876
4332
|
/**
|
|
4333
|
+
* @public
|
|
3877
4334
|
* <p>The name of the application with which the environment is associated.</p>
|
|
3878
4335
|
*/
|
|
3879
4336
|
ApplicationName?: string;
|
|
3880
4337
|
/**
|
|
4338
|
+
* @public
|
|
3881
4339
|
* <p>The ID of the environment to update.</p>
|
|
3882
4340
|
* <p>If no environment with this ID exists, AWS Elastic Beanstalk returns an
|
|
3883
4341
|
* <code>InvalidParameterValue</code> error.</p>
|
|
@@ -3887,6 +4345,7 @@ export interface UpdateEnvironmentMessage {
|
|
|
3887
4345
|
*/
|
|
3888
4346
|
EnvironmentId?: string;
|
|
3889
4347
|
/**
|
|
4348
|
+
* @public
|
|
3890
4349
|
* <p>The name of the environment to update. If no environment with this name exists, AWS
|
|
3891
4350
|
* Elastic Beanstalk returns an <code>InvalidParameterValue</code> error. </p>
|
|
3892
4351
|
* <p>Condition: You must specify either this or an EnvironmentId, or both. If you do not
|
|
@@ -3895,6 +4354,7 @@ export interface UpdateEnvironmentMessage {
|
|
|
3895
4354
|
*/
|
|
3896
4355
|
EnvironmentName?: string;
|
|
3897
4356
|
/**
|
|
4357
|
+
* @public
|
|
3898
4358
|
* <p>The name of the group to which the target environment belongs. Specify a group name
|
|
3899
4359
|
* only if the environment's name is specified in an environment manifest and not with the
|
|
3900
4360
|
* environment name or environment ID parameters. See <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-manifest.html">Environment Manifest
|
|
@@ -3902,44 +4362,52 @@ export interface UpdateEnvironmentMessage {
|
|
|
3902
4362
|
*/
|
|
3903
4363
|
GroupName?: string;
|
|
3904
4364
|
/**
|
|
4365
|
+
* @public
|
|
3905
4366
|
* <p>If this parameter is specified, AWS Elastic Beanstalk updates the description of this
|
|
3906
4367
|
* environment.</p>
|
|
3907
4368
|
*/
|
|
3908
4369
|
Description?: string;
|
|
3909
4370
|
/**
|
|
4371
|
+
* @public
|
|
3910
4372
|
* <p>This specifies the tier to use to update the environment.</p>
|
|
3911
4373
|
* <p>Condition: At this time, if you change the tier version, name, or type, AWS Elastic
|
|
3912
4374
|
* Beanstalk returns <code>InvalidParameterValue</code> error. </p>
|
|
3913
4375
|
*/
|
|
3914
4376
|
Tier?: EnvironmentTier;
|
|
3915
4377
|
/**
|
|
4378
|
+
* @public
|
|
3916
4379
|
* <p>If this parameter is specified, AWS Elastic Beanstalk deploys the named application
|
|
3917
4380
|
* version to the environment. If no such application version is found, returns an
|
|
3918
4381
|
* <code>InvalidParameterValue</code> error. </p>
|
|
3919
4382
|
*/
|
|
3920
4383
|
VersionLabel?: string;
|
|
3921
4384
|
/**
|
|
4385
|
+
* @public
|
|
3922
4386
|
* <p>If this parameter is specified, AWS Elastic Beanstalk deploys this configuration
|
|
3923
4387
|
* template to the environment. If no such configuration template is found, AWS Elastic Beanstalk
|
|
3924
4388
|
* returns an <code>InvalidParameterValue</code> error. </p>
|
|
3925
4389
|
*/
|
|
3926
4390
|
TemplateName?: string;
|
|
3927
4391
|
/**
|
|
4392
|
+
* @public
|
|
3928
4393
|
* <p>This specifies the platform version that the environment will run after the environment
|
|
3929
4394
|
* is updated.</p>
|
|
3930
4395
|
*/
|
|
3931
4396
|
SolutionStackName?: string;
|
|
3932
4397
|
/**
|
|
4398
|
+
* @public
|
|
3933
4399
|
* <p>The ARN of the platform, if used.</p>
|
|
3934
4400
|
*/
|
|
3935
4401
|
PlatformArn?: string;
|
|
3936
4402
|
/**
|
|
4403
|
+
* @public
|
|
3937
4404
|
* <p>If specified, AWS Elastic Beanstalk updates the configuration set associated with the
|
|
3938
4405
|
* running environment and sets the specified configuration options to the requested
|
|
3939
4406
|
* value.</p>
|
|
3940
4407
|
*/
|
|
3941
4408
|
OptionSettings?: ConfigurationOptionSetting[];
|
|
3942
4409
|
/**
|
|
4410
|
+
* @public
|
|
3943
4411
|
* <p>A list of custom user-defined configuration options to remove from the configuration
|
|
3944
4412
|
* set for this environment.</p>
|
|
3945
4413
|
*/
|
|
@@ -3965,11 +4433,13 @@ export declare class TooManyTagsException extends __BaseException {
|
|
|
3965
4433
|
*/
|
|
3966
4434
|
export interface UpdateTagsForResourceMessage {
|
|
3967
4435
|
/**
|
|
4436
|
+
* @public
|
|
3968
4437
|
* <p>The Amazon Resource Name (ARN) of the resouce to be updated.</p>
|
|
3969
4438
|
* <p>Must be the ARN of an Elastic Beanstalk resource.</p>
|
|
3970
4439
|
*/
|
|
3971
4440
|
ResourceArn: string | undefined;
|
|
3972
4441
|
/**
|
|
4442
|
+
* @public
|
|
3973
4443
|
* <p>A list of tags to add or update. If a key of an existing tag is added, the tag's value is
|
|
3974
4444
|
* updated.</p>
|
|
3975
4445
|
* <p>Specify at least one of these parameters: <code>TagsToAdd</code>,
|
|
@@ -3977,6 +4447,7 @@ export interface UpdateTagsForResourceMessage {
|
|
|
3977
4447
|
*/
|
|
3978
4448
|
TagsToAdd?: Tag[];
|
|
3979
4449
|
/**
|
|
4450
|
+
* @public
|
|
3980
4451
|
* <p>A list of tag keys to remove. If a tag key doesn't exist, it is silently ignored.</p>
|
|
3981
4452
|
* <p>Specify at least one of these parameters: <code>TagsToAdd</code>,
|
|
3982
4453
|
* <code>TagsToRemove</code>.</p>
|
|
@@ -4001,10 +4472,12 @@ export type ValidationSeverity = (typeof ValidationSeverity)[keyof typeof Valida
|
|
|
4001
4472
|
*/
|
|
4002
4473
|
export interface ValidationMessage {
|
|
4003
4474
|
/**
|
|
4475
|
+
* @public
|
|
4004
4476
|
* <p>A message describing the error or warning.</p>
|
|
4005
4477
|
*/
|
|
4006
4478
|
Message?: string;
|
|
4007
4479
|
/**
|
|
4480
|
+
* @public
|
|
4008
4481
|
* <p>An indication of the severity of this message:</p>
|
|
4009
4482
|
* <ul>
|
|
4010
4483
|
* <li>
|
|
@@ -4021,10 +4494,12 @@ export interface ValidationMessage {
|
|
|
4021
4494
|
*/
|
|
4022
4495
|
Severity?: ValidationSeverity | string;
|
|
4023
4496
|
/**
|
|
4497
|
+
* @public
|
|
4024
4498
|
* <p>The namespace to which the option belongs.</p>
|
|
4025
4499
|
*/
|
|
4026
4500
|
Namespace?: string;
|
|
4027
4501
|
/**
|
|
4502
|
+
* @public
|
|
4028
4503
|
* <p>The name of the option.</p>
|
|
4029
4504
|
*/
|
|
4030
4505
|
OptionName?: string;
|
|
@@ -4035,6 +4510,7 @@ export interface ValidationMessage {
|
|
|
4035
4510
|
*/
|
|
4036
4511
|
export interface ConfigurationSettingsValidationMessages {
|
|
4037
4512
|
/**
|
|
4513
|
+
* @public
|
|
4038
4514
|
* <p> A list of <a>ValidationMessage</a>. </p>
|
|
4039
4515
|
*/
|
|
4040
4516
|
Messages?: ValidationMessage[];
|
|
@@ -4045,21 +4521,25 @@ export interface ConfigurationSettingsValidationMessages {
|
|
|
4045
4521
|
*/
|
|
4046
4522
|
export interface ValidateConfigurationSettingsMessage {
|
|
4047
4523
|
/**
|
|
4524
|
+
* @public
|
|
4048
4525
|
* <p>The name of the application that the configuration template or environment belongs
|
|
4049
4526
|
* to.</p>
|
|
4050
4527
|
*/
|
|
4051
4528
|
ApplicationName: string | undefined;
|
|
4052
4529
|
/**
|
|
4530
|
+
* @public
|
|
4053
4531
|
* <p>The name of the configuration template to validate the settings against.</p>
|
|
4054
4532
|
* <p>Condition: You cannot specify both this and an environment name.</p>
|
|
4055
4533
|
*/
|
|
4056
4534
|
TemplateName?: string;
|
|
4057
4535
|
/**
|
|
4536
|
+
* @public
|
|
4058
4537
|
* <p>The name of the environment to validate the settings against.</p>
|
|
4059
4538
|
* <p>Condition: You cannot specify both this and a configuration template name.</p>
|
|
4060
4539
|
*/
|
|
4061
4540
|
EnvironmentName?: string;
|
|
4062
4541
|
/**
|
|
4542
|
+
* @public
|
|
4063
4543
|
* <p>A list of the options and desired values to evaluate.</p>
|
|
4064
4544
|
*/
|
|
4065
4545
|
OptionSettings: ConfigurationOptionSetting[] | undefined;
|