@aws-sdk/client-redshift 3.379.1 → 3.382.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.
|
@@ -7,6 +7,7 @@ import { RedshiftServiceException as __BaseException } from "./RedshiftServiceEx
|
|
|
7
7
|
*/
|
|
8
8
|
export interface EventCategoriesMessage {
|
|
9
9
|
/**
|
|
10
|
+
* @public
|
|
10
11
|
* <p>A list of event categories descriptions.</p>
|
|
11
12
|
*/
|
|
12
13
|
EventCategoriesMapList?: EventCategoriesMap[];
|
|
@@ -32,6 +33,7 @@ export type SourceType = (typeof SourceType)[keyof typeof SourceType];
|
|
|
32
33
|
*/
|
|
33
34
|
export interface DescribeEventsMessage {
|
|
34
35
|
/**
|
|
36
|
+
* @public
|
|
35
37
|
* <p>The identifier of the event source for which events will be returned. If this
|
|
36
38
|
* parameter is not specified, then all sources are included in the response.</p>
|
|
37
39
|
* <p>Constraints:</p>
|
|
@@ -58,6 +60,7 @@ export interface DescribeEventsMessage {
|
|
|
58
60
|
*/
|
|
59
61
|
SourceIdentifier?: string;
|
|
60
62
|
/**
|
|
63
|
+
* @public
|
|
61
64
|
* <p>The event source to retrieve events for. If no value is specified, all events are
|
|
62
65
|
* returned.</p>
|
|
63
66
|
* <p>Constraints:</p>
|
|
@@ -87,6 +90,7 @@ export interface DescribeEventsMessage {
|
|
|
87
90
|
*/
|
|
88
91
|
SourceType?: SourceType | string;
|
|
89
92
|
/**
|
|
93
|
+
* @public
|
|
90
94
|
* <p>The beginning of the time interval to retrieve events for, specified in ISO 8601
|
|
91
95
|
* format. For more information about ISO 8601, go to the <a href="http://en.wikipedia.org/wiki/ISO_8601">ISO8601 Wikipedia page.</a>
|
|
92
96
|
* </p>
|
|
@@ -95,6 +99,7 @@ export interface DescribeEventsMessage {
|
|
|
95
99
|
*/
|
|
96
100
|
StartTime?: Date;
|
|
97
101
|
/**
|
|
102
|
+
* @public
|
|
98
103
|
* <p>The end of the time interval for which to retrieve events, specified in ISO 8601
|
|
99
104
|
* format. For more information about ISO 8601, go to the <a href="http://en.wikipedia.org/wiki/ISO_8601">ISO8601 Wikipedia page.</a>
|
|
100
105
|
* </p>
|
|
@@ -103,6 +108,7 @@ export interface DescribeEventsMessage {
|
|
|
103
108
|
*/
|
|
104
109
|
EndTime?: Date;
|
|
105
110
|
/**
|
|
111
|
+
* @public
|
|
106
112
|
* <p>The number of minutes prior to the time of the request for which to retrieve
|
|
107
113
|
* events. For example, if the request is sent at 18:00 and you specify a duration of 60,
|
|
108
114
|
* then only events which have occurred after 17:00 will be returned.</p>
|
|
@@ -111,6 +117,7 @@ export interface DescribeEventsMessage {
|
|
|
111
117
|
*/
|
|
112
118
|
Duration?: number;
|
|
113
119
|
/**
|
|
120
|
+
* @public
|
|
114
121
|
* <p>The maximum number of response records to return in each call. If the number of
|
|
115
122
|
* remaining response records exceeds the specified <code>MaxRecords</code> value, a value
|
|
116
123
|
* is returned in a <code>marker</code> field of the response. You can retrieve the next
|
|
@@ -121,6 +128,7 @@ export interface DescribeEventsMessage {
|
|
|
121
128
|
*/
|
|
122
129
|
MaxRecords?: number;
|
|
123
130
|
/**
|
|
131
|
+
* @public
|
|
124
132
|
* <p>An optional parameter that specifies the starting point to return a set of response
|
|
125
133
|
* records. When the results of a <a>DescribeEvents</a> request exceed the value
|
|
126
134
|
* specified in <code>MaxRecords</code>, Amazon Web Services returns a value in the <code>Marker</code>
|
|
@@ -136,32 +144,39 @@ export interface DescribeEventsMessage {
|
|
|
136
144
|
*/
|
|
137
145
|
export interface Event {
|
|
138
146
|
/**
|
|
147
|
+
* @public
|
|
139
148
|
* <p>The identifier for the source of the event.</p>
|
|
140
149
|
*/
|
|
141
150
|
SourceIdentifier?: string;
|
|
142
151
|
/**
|
|
152
|
+
* @public
|
|
143
153
|
* <p>The source type for this event.</p>
|
|
144
154
|
*/
|
|
145
155
|
SourceType?: SourceType | string;
|
|
146
156
|
/**
|
|
157
|
+
* @public
|
|
147
158
|
* <p>The text of this event.</p>
|
|
148
159
|
*/
|
|
149
160
|
Message?: string;
|
|
150
161
|
/**
|
|
162
|
+
* @public
|
|
151
163
|
* <p>A list of the event categories.</p>
|
|
152
164
|
* <p>Values: Configuration, Management, Monitoring, Security, Pending</p>
|
|
153
165
|
*/
|
|
154
166
|
EventCategories?: string[];
|
|
155
167
|
/**
|
|
168
|
+
* @public
|
|
156
169
|
* <p>The severity of the event.</p>
|
|
157
170
|
* <p>Values: ERROR, INFO</p>
|
|
158
171
|
*/
|
|
159
172
|
Severity?: string;
|
|
160
173
|
/**
|
|
174
|
+
* @public
|
|
161
175
|
* <p>The date and time of the event.</p>
|
|
162
176
|
*/
|
|
163
177
|
Date?: Date;
|
|
164
178
|
/**
|
|
179
|
+
* @public
|
|
165
180
|
* <p>The identifier of the event.</p>
|
|
166
181
|
*/
|
|
167
182
|
EventId?: string;
|
|
@@ -172,6 +187,7 @@ export interface Event {
|
|
|
172
187
|
*/
|
|
173
188
|
export interface EventsMessage {
|
|
174
189
|
/**
|
|
190
|
+
* @public
|
|
175
191
|
* <p>A value that indicates the starting point for the next set of response records in a
|
|
176
192
|
* subsequent request. If a value is returned in a response, you can retrieve the next set
|
|
177
193
|
* of records by providing this returned marker value in the <code>Marker</code> parameter
|
|
@@ -180,6 +196,7 @@ export interface EventsMessage {
|
|
|
180
196
|
*/
|
|
181
197
|
Marker?: string;
|
|
182
198
|
/**
|
|
199
|
+
* @public
|
|
183
200
|
* <p>A list of <code>Event</code> instances. </p>
|
|
184
201
|
*/
|
|
185
202
|
Events?: Event[];
|
|
@@ -190,11 +207,13 @@ export interface EventsMessage {
|
|
|
190
207
|
*/
|
|
191
208
|
export interface DescribeEventSubscriptionsMessage {
|
|
192
209
|
/**
|
|
210
|
+
* @public
|
|
193
211
|
* <p>The name of the Amazon Redshift event notification subscription to be
|
|
194
212
|
* described.</p>
|
|
195
213
|
*/
|
|
196
214
|
SubscriptionName?: string;
|
|
197
215
|
/**
|
|
216
|
+
* @public
|
|
198
217
|
* <p>The maximum number of response records to return in each call. If the number of
|
|
199
218
|
* remaining response records exceeds the specified <code>MaxRecords</code> value, a value
|
|
200
219
|
* is returned in a <code>marker</code> field of the response. You can retrieve the next
|
|
@@ -205,6 +224,7 @@ export interface DescribeEventSubscriptionsMessage {
|
|
|
205
224
|
*/
|
|
206
225
|
MaxRecords?: number;
|
|
207
226
|
/**
|
|
227
|
+
* @public
|
|
208
228
|
* <p>An optional parameter that specifies the starting point to return a set of response
|
|
209
229
|
* records. When the results of a DescribeEventSubscriptions request exceed the value
|
|
210
230
|
* specified in <code>MaxRecords</code>, Amazon Web Services returns a value in the <code>Marker</code>
|
|
@@ -214,6 +234,7 @@ export interface DescribeEventSubscriptionsMessage {
|
|
|
214
234
|
*/
|
|
215
235
|
Marker?: string;
|
|
216
236
|
/**
|
|
237
|
+
* @public
|
|
217
238
|
* <p>A tag key or keys for which you want to return all matching event notification
|
|
218
239
|
* subscriptions that are associated with the specified key or keys. For example, suppose
|
|
219
240
|
* that you have subscriptions that are tagged with keys called <code>owner</code> and
|
|
@@ -223,6 +244,7 @@ export interface DescribeEventSubscriptionsMessage {
|
|
|
223
244
|
*/
|
|
224
245
|
TagKeys?: string[];
|
|
225
246
|
/**
|
|
247
|
+
* @public
|
|
226
248
|
* <p>A tag value or values for which you want to return all matching event notification
|
|
227
249
|
* subscriptions that are associated with the specified tag value or values. For example,
|
|
228
250
|
* suppose that you have subscriptions that are tagged with values called
|
|
@@ -238,6 +260,7 @@ export interface DescribeEventSubscriptionsMessage {
|
|
|
238
260
|
*/
|
|
239
261
|
export interface EventSubscriptionsMessage {
|
|
240
262
|
/**
|
|
263
|
+
* @public
|
|
241
264
|
* <p>A value that indicates the starting point for the next set of response records in a
|
|
242
265
|
* subsequent request. If a value is returned in a response, you can retrieve the next set
|
|
243
266
|
* of records by providing this returned marker value in the <code>Marker</code> parameter
|
|
@@ -246,6 +269,7 @@ export interface EventSubscriptionsMessage {
|
|
|
246
269
|
*/
|
|
247
270
|
Marker?: string;
|
|
248
271
|
/**
|
|
272
|
+
* @public
|
|
249
273
|
* <p>A list of event subscriptions.</p>
|
|
250
274
|
*/
|
|
251
275
|
EventSubscriptionsList?: EventSubscription[];
|
|
@@ -256,12 +280,14 @@ export interface EventSubscriptionsMessage {
|
|
|
256
280
|
*/
|
|
257
281
|
export interface DescribeHsmClientCertificatesMessage {
|
|
258
282
|
/**
|
|
283
|
+
* @public
|
|
259
284
|
* <p>The identifier of a specific HSM client certificate for which you want information.
|
|
260
285
|
* If no identifier is specified, information is returned for all HSM client certificates
|
|
261
286
|
* owned by your Amazon Web Services account.</p>
|
|
262
287
|
*/
|
|
263
288
|
HsmClientCertificateIdentifier?: string;
|
|
264
289
|
/**
|
|
290
|
+
* @public
|
|
265
291
|
* <p>The maximum number of response records to return in each call. If the number of
|
|
266
292
|
* remaining response records exceeds the specified <code>MaxRecords</code> value, a value
|
|
267
293
|
* is returned in a <code>marker</code> field of the response. You can retrieve the next
|
|
@@ -272,6 +298,7 @@ export interface DescribeHsmClientCertificatesMessage {
|
|
|
272
298
|
*/
|
|
273
299
|
MaxRecords?: number;
|
|
274
300
|
/**
|
|
301
|
+
* @public
|
|
275
302
|
* <p>An optional parameter that specifies the starting point to return a set of response
|
|
276
303
|
* records. When the results of a <a>DescribeHsmClientCertificates</a> request
|
|
277
304
|
* exceed the value specified in <code>MaxRecords</code>, Amazon Web Services returns a value in the
|
|
@@ -281,6 +308,7 @@ export interface DescribeHsmClientCertificatesMessage {
|
|
|
281
308
|
*/
|
|
282
309
|
Marker?: string;
|
|
283
310
|
/**
|
|
311
|
+
* @public
|
|
284
312
|
* <p>A tag key or keys for which you want to return all matching HSM client certificates
|
|
285
313
|
* that are associated with the specified key or keys. For example, suppose that you have
|
|
286
314
|
* HSM client certificates that are tagged with keys called <code>owner</code> and
|
|
@@ -290,6 +318,7 @@ export interface DescribeHsmClientCertificatesMessage {
|
|
|
290
318
|
*/
|
|
291
319
|
TagKeys?: string[];
|
|
292
320
|
/**
|
|
321
|
+
* @public
|
|
293
322
|
* <p>A tag value or values for which you want to return all matching HSM client
|
|
294
323
|
* certificates that are associated with the specified tag value or values. For example,
|
|
295
324
|
* suppose that you have HSM client certificates that are tagged with values called
|
|
@@ -305,6 +334,7 @@ export interface DescribeHsmClientCertificatesMessage {
|
|
|
305
334
|
*/
|
|
306
335
|
export interface HsmClientCertificateMessage {
|
|
307
336
|
/**
|
|
337
|
+
* @public
|
|
308
338
|
* <p>A value that indicates the starting point for the next set of response records in a
|
|
309
339
|
* subsequent request. If a value is returned in a response, you can retrieve the next set
|
|
310
340
|
* of records by providing this returned marker value in the <code>Marker</code> parameter
|
|
@@ -313,6 +343,7 @@ export interface HsmClientCertificateMessage {
|
|
|
313
343
|
*/
|
|
314
344
|
Marker?: string;
|
|
315
345
|
/**
|
|
346
|
+
* @public
|
|
316
347
|
* <p>A list of the identifiers for one or more HSM client certificates used by Amazon Redshift
|
|
317
348
|
* clusters to store and retrieve database encryption keys in an HSM.</p>
|
|
318
349
|
*/
|
|
@@ -324,12 +355,14 @@ export interface HsmClientCertificateMessage {
|
|
|
324
355
|
*/
|
|
325
356
|
export interface DescribeHsmConfigurationsMessage {
|
|
326
357
|
/**
|
|
358
|
+
* @public
|
|
327
359
|
* <p>The identifier of a specific Amazon Redshift HSM configuration to be described. If no
|
|
328
360
|
* identifier is specified, information is returned for all HSM configurations owned by
|
|
329
361
|
* your Amazon Web Services account.</p>
|
|
330
362
|
*/
|
|
331
363
|
HsmConfigurationIdentifier?: string;
|
|
332
364
|
/**
|
|
365
|
+
* @public
|
|
333
366
|
* <p>The maximum number of response records to return in each call. If the number of
|
|
334
367
|
* remaining response records exceeds the specified <code>MaxRecords</code> value, a value
|
|
335
368
|
* is returned in a <code>marker</code> field of the response. You can retrieve the next
|
|
@@ -340,6 +373,7 @@ export interface DescribeHsmConfigurationsMessage {
|
|
|
340
373
|
*/
|
|
341
374
|
MaxRecords?: number;
|
|
342
375
|
/**
|
|
376
|
+
* @public
|
|
343
377
|
* <p>An optional parameter that specifies the starting point to return a set of response
|
|
344
378
|
* records. When the results of a <a>DescribeHsmConfigurations</a> request
|
|
345
379
|
* exceed the value specified in <code>MaxRecords</code>, Amazon Web Services returns a value in the
|
|
@@ -349,6 +383,7 @@ export interface DescribeHsmConfigurationsMessage {
|
|
|
349
383
|
*/
|
|
350
384
|
Marker?: string;
|
|
351
385
|
/**
|
|
386
|
+
* @public
|
|
352
387
|
* <p>A tag key or keys for which you want to return all matching HSM configurations that
|
|
353
388
|
* are associated with the specified key or keys. For example, suppose that you have HSM
|
|
354
389
|
* configurations that are tagged with keys called <code>owner</code> and
|
|
@@ -358,6 +393,7 @@ export interface DescribeHsmConfigurationsMessage {
|
|
|
358
393
|
*/
|
|
359
394
|
TagKeys?: string[];
|
|
360
395
|
/**
|
|
396
|
+
* @public
|
|
361
397
|
* <p>A tag value or values for which you want to return all matching HSM configurations
|
|
362
398
|
* that are associated with the specified tag value or values. For example, suppose that
|
|
363
399
|
* you have HSM configurations that are tagged with values called <code>admin</code> and
|
|
@@ -373,6 +409,7 @@ export interface DescribeHsmConfigurationsMessage {
|
|
|
373
409
|
*/
|
|
374
410
|
export interface HsmConfigurationMessage {
|
|
375
411
|
/**
|
|
412
|
+
* @public
|
|
376
413
|
* <p>A value that indicates the starting point for the next set of response records in a
|
|
377
414
|
* subsequent request. If a value is returned in a response, you can retrieve the next set
|
|
378
415
|
* of records by providing this returned marker value in the <code>Marker</code> parameter
|
|
@@ -381,6 +418,7 @@ export interface HsmConfigurationMessage {
|
|
|
381
418
|
*/
|
|
382
419
|
Marker?: string;
|
|
383
420
|
/**
|
|
421
|
+
* @public
|
|
384
422
|
* <p>A list of <code>HsmConfiguration</code> objects.</p>
|
|
385
423
|
*/
|
|
386
424
|
HsmConfigurations?: HsmConfiguration[];
|
|
@@ -391,6 +429,7 @@ export interface HsmConfigurationMessage {
|
|
|
391
429
|
*/
|
|
392
430
|
export interface DescribeLoggingStatusMessage {
|
|
393
431
|
/**
|
|
432
|
+
* @public
|
|
394
433
|
* <p>The identifier of the cluster from which to get the logging status.</p>
|
|
395
434
|
* <p>Example: <code>examplecluster</code>
|
|
396
435
|
* </p>
|
|
@@ -415,35 +454,43 @@ export type LogDestinationType = (typeof LogDestinationType)[keyof typeof LogDes
|
|
|
415
454
|
*/
|
|
416
455
|
export interface LoggingStatus {
|
|
417
456
|
/**
|
|
457
|
+
* @public
|
|
418
458
|
* <p>
|
|
419
459
|
* <code>true</code> if logging is on, <code>false</code> if logging is off.</p>
|
|
420
460
|
*/
|
|
421
461
|
LoggingEnabled?: boolean;
|
|
422
462
|
/**
|
|
463
|
+
* @public
|
|
423
464
|
* <p>The name of the S3 bucket where the log files are stored.</p>
|
|
424
465
|
*/
|
|
425
466
|
BucketName?: string;
|
|
426
467
|
/**
|
|
468
|
+
* @public
|
|
427
469
|
* <p>The prefix applied to the log file names.</p>
|
|
428
470
|
*/
|
|
429
471
|
S3KeyPrefix?: string;
|
|
430
472
|
/**
|
|
473
|
+
* @public
|
|
431
474
|
* <p>The last time that logs were delivered.</p>
|
|
432
475
|
*/
|
|
433
476
|
LastSuccessfulDeliveryTime?: Date;
|
|
434
477
|
/**
|
|
478
|
+
* @public
|
|
435
479
|
* <p>The last time when logs failed to be delivered.</p>
|
|
436
480
|
*/
|
|
437
481
|
LastFailureTime?: Date;
|
|
438
482
|
/**
|
|
483
|
+
* @public
|
|
439
484
|
* <p>The message indicating that logs failed to be delivered.</p>
|
|
440
485
|
*/
|
|
441
486
|
LastFailureMessage?: string;
|
|
442
487
|
/**
|
|
488
|
+
* @public
|
|
443
489
|
* <p>The log destination type. An enum with possible values of <code>s3</code> and <code>cloudwatch</code>.</p>
|
|
444
490
|
*/
|
|
445
491
|
LogDestinationType?: LogDestinationType | string;
|
|
446
492
|
/**
|
|
493
|
+
* @public
|
|
447
494
|
* <p>The collection of exported log types. Possible values are <code>connectionlog</code>, <code>useractivitylog</code>, and
|
|
448
495
|
* <code>userlog</code>.</p>
|
|
449
496
|
*/
|
|
@@ -486,10 +533,12 @@ export type OperatorType = (typeof OperatorType)[keyof typeof OperatorType];
|
|
|
486
533
|
*/
|
|
487
534
|
export interface NodeConfigurationOptionsFilter {
|
|
488
535
|
/**
|
|
536
|
+
* @public
|
|
489
537
|
* <p>The name of the element to filter.</p>
|
|
490
538
|
*/
|
|
491
539
|
Name?: NodeConfigurationOptionsFilterName | string;
|
|
492
540
|
/**
|
|
541
|
+
* @public
|
|
493
542
|
* <p>The filter operator.
|
|
494
543
|
* If filter Name is NodeType only the 'in' operator is supported.
|
|
495
544
|
* Provide one value to evaluate for 'eq', 'lt', 'le', 'gt', and 'ge'.
|
|
@@ -498,6 +547,7 @@ export interface NodeConfigurationOptionsFilter {
|
|
|
498
547
|
*/
|
|
499
548
|
Operator?: OperatorType | string;
|
|
500
549
|
/**
|
|
550
|
+
* @public
|
|
501
551
|
* <p>List of values. Compare Name using Operator to Values.
|
|
502
552
|
* If filter Name is NumberOfNodes, then values can range from 0 to 200.
|
|
503
553
|
* If filter Name is EstimatedDiskUtilizationPercent, then values can range from 0 to 100.
|
|
@@ -510,6 +560,7 @@ export interface NodeConfigurationOptionsFilter {
|
|
|
510
560
|
*/
|
|
511
561
|
export interface DescribeNodeConfigurationOptionsMessage {
|
|
512
562
|
/**
|
|
563
|
+
* @public
|
|
513
564
|
* <p>The action type to evaluate for possible node configurations.
|
|
514
565
|
* Specify "restore-cluster" to get configuration combinations based on an existing snapshot.
|
|
515
566
|
* Specify "recommend-node-config" to get configuration recommendations based on an existing cluster or snapshot.
|
|
@@ -518,28 +569,34 @@ export interface DescribeNodeConfigurationOptionsMessage {
|
|
|
518
569
|
*/
|
|
519
570
|
ActionType: ActionType | string | undefined;
|
|
520
571
|
/**
|
|
572
|
+
* @public
|
|
521
573
|
* <p>The identifier of the cluster to evaluate for possible node configurations.</p>
|
|
522
574
|
*/
|
|
523
575
|
ClusterIdentifier?: string;
|
|
524
576
|
/**
|
|
577
|
+
* @public
|
|
525
578
|
* <p>The identifier of the snapshot to evaluate for possible node configurations.</p>
|
|
526
579
|
*/
|
|
527
580
|
SnapshotIdentifier?: string;
|
|
528
581
|
/**
|
|
582
|
+
* @public
|
|
529
583
|
* <p>The Amazon Resource Name (ARN) of the snapshot associated with the message to describe node configuration.</p>
|
|
530
584
|
*/
|
|
531
585
|
SnapshotArn?: string;
|
|
532
586
|
/**
|
|
587
|
+
* @public
|
|
533
588
|
* <p>The Amazon Web Services account used to create or copy the snapshot.
|
|
534
589
|
* Required if you are restoring a snapshot you do not own,
|
|
535
590
|
* optional if you own the snapshot.</p>
|
|
536
591
|
*/
|
|
537
592
|
OwnerAccount?: string;
|
|
538
593
|
/**
|
|
594
|
+
* @public
|
|
539
595
|
* <p>A set of name, operator, and value items to filter the results.</p>
|
|
540
596
|
*/
|
|
541
597
|
Filters?: NodeConfigurationOptionsFilter[];
|
|
542
598
|
/**
|
|
599
|
+
* @public
|
|
543
600
|
* <p>An optional parameter that specifies the starting point to return a set of response
|
|
544
601
|
* records. When the results of a <a>DescribeNodeConfigurationOptions</a> request
|
|
545
602
|
* exceed the value specified in <code>MaxRecords</code>, Amazon Web Services returns a value in the
|
|
@@ -549,6 +606,7 @@ export interface DescribeNodeConfigurationOptionsMessage {
|
|
|
549
606
|
*/
|
|
550
607
|
Marker?: string;
|
|
551
608
|
/**
|
|
609
|
+
* @public
|
|
552
610
|
* <p>The maximum number of response records to return in each call. If the number of
|
|
553
611
|
* remaining response records exceeds the specified <code>MaxRecords</code> value, a value
|
|
554
612
|
* is returned in a <code>marker</code> field of the response. You can retrieve the next
|
|
@@ -577,18 +635,22 @@ export type Mode = (typeof Mode)[keyof typeof Mode];
|
|
|
577
635
|
*/
|
|
578
636
|
export interface NodeConfigurationOption {
|
|
579
637
|
/**
|
|
638
|
+
* @public
|
|
580
639
|
* <p>The node type, such as, "ds2.8xlarge".</p>
|
|
581
640
|
*/
|
|
582
641
|
NodeType?: string;
|
|
583
642
|
/**
|
|
643
|
+
* @public
|
|
584
644
|
* <p>The number of nodes.</p>
|
|
585
645
|
*/
|
|
586
646
|
NumberOfNodes?: number;
|
|
587
647
|
/**
|
|
648
|
+
* @public
|
|
588
649
|
* <p>The estimated disk utilizaton percentage.</p>
|
|
589
650
|
*/
|
|
590
651
|
EstimatedDiskUtilizationPercent?: number;
|
|
591
652
|
/**
|
|
653
|
+
* @public
|
|
592
654
|
* <p>The category of the node configuration recommendation.</p>
|
|
593
655
|
*/
|
|
594
656
|
Mode?: Mode | string;
|
|
@@ -598,10 +660,12 @@ export interface NodeConfigurationOption {
|
|
|
598
660
|
*/
|
|
599
661
|
export interface NodeConfigurationOptionsMessage {
|
|
600
662
|
/**
|
|
663
|
+
* @public
|
|
601
664
|
* <p>A list of valid node configurations.</p>
|
|
602
665
|
*/
|
|
603
666
|
NodeConfigurationOptionList?: NodeConfigurationOption[];
|
|
604
667
|
/**
|
|
668
|
+
* @public
|
|
605
669
|
* <p>A value that indicates the starting point for the next set of response records in a
|
|
606
670
|
* subsequent request. If a value is returned in a response, you can retrieve the next set
|
|
607
671
|
* of records by providing this returned marker value in the <code>Marker</code> parameter
|
|
@@ -616,6 +680,7 @@ export interface NodeConfigurationOptionsMessage {
|
|
|
616
680
|
*/
|
|
617
681
|
export interface DescribeOrderableClusterOptionsMessage {
|
|
618
682
|
/**
|
|
683
|
+
* @public
|
|
619
684
|
* <p>The version filter value. Specify this parameter to show only the available
|
|
620
685
|
* offerings matching the specified version.</p>
|
|
621
686
|
* <p>Default: All versions.</p>
|
|
@@ -623,11 +688,13 @@ export interface DescribeOrderableClusterOptionsMessage {
|
|
|
623
688
|
*/
|
|
624
689
|
ClusterVersion?: string;
|
|
625
690
|
/**
|
|
691
|
+
* @public
|
|
626
692
|
* <p>The node type filter value. Specify this parameter to show only the available
|
|
627
693
|
* offerings matching the specified node type.</p>
|
|
628
694
|
*/
|
|
629
695
|
NodeType?: string;
|
|
630
696
|
/**
|
|
697
|
+
* @public
|
|
631
698
|
* <p>The maximum number of response records to return in each call. If the number of
|
|
632
699
|
* remaining response records exceeds the specified <code>MaxRecords</code> value, a value
|
|
633
700
|
* is returned in a <code>marker</code> field of the response. You can retrieve the next
|
|
@@ -638,6 +705,7 @@ export interface DescribeOrderableClusterOptionsMessage {
|
|
|
638
705
|
*/
|
|
639
706
|
MaxRecords?: number;
|
|
640
707
|
/**
|
|
708
|
+
* @public
|
|
641
709
|
* <p>An optional parameter that specifies the starting point to return a set of response
|
|
642
710
|
* records. When the results of a <a>DescribeOrderableClusterOptions</a> request
|
|
643
711
|
* exceed the value specified in <code>MaxRecords</code>, Amazon Web Services returns a value in the
|
|
@@ -653,18 +721,22 @@ export interface DescribeOrderableClusterOptionsMessage {
|
|
|
653
721
|
*/
|
|
654
722
|
export interface OrderableClusterOption {
|
|
655
723
|
/**
|
|
724
|
+
* @public
|
|
656
725
|
* <p>The version of the orderable cluster.</p>
|
|
657
726
|
*/
|
|
658
727
|
ClusterVersion?: string;
|
|
659
728
|
/**
|
|
729
|
+
* @public
|
|
660
730
|
* <p>The cluster type, for example <code>multi-node</code>. </p>
|
|
661
731
|
*/
|
|
662
732
|
ClusterType?: string;
|
|
663
733
|
/**
|
|
734
|
+
* @public
|
|
664
735
|
* <p>The node type for the orderable cluster.</p>
|
|
665
736
|
*/
|
|
666
737
|
NodeType?: string;
|
|
667
738
|
/**
|
|
739
|
+
* @public
|
|
668
740
|
* <p>A list of availability zones for the orderable cluster.</p>
|
|
669
741
|
*/
|
|
670
742
|
AvailabilityZones?: AvailabilityZone[];
|
|
@@ -676,11 +748,13 @@ export interface OrderableClusterOption {
|
|
|
676
748
|
*/
|
|
677
749
|
export interface OrderableClusterOptionsMessage {
|
|
678
750
|
/**
|
|
751
|
+
* @public
|
|
679
752
|
* <p>An <code>OrderableClusterOption</code> structure containing information about
|
|
680
753
|
* orderable options for the cluster.</p>
|
|
681
754
|
*/
|
|
682
755
|
OrderableClusterOptions?: OrderableClusterOption[];
|
|
683
756
|
/**
|
|
757
|
+
* @public
|
|
684
758
|
* <p>A value that indicates the starting point for the next set of response records in a
|
|
685
759
|
* subsequent request. If a value is returned in a response, you can retrieve the next set
|
|
686
760
|
* of records by providing this returned marker value in the <code>Marker</code> parameter
|
|
@@ -694,18 +768,22 @@ export interface OrderableClusterOptionsMessage {
|
|
|
694
768
|
*/
|
|
695
769
|
export interface DescribePartnersInputMessage {
|
|
696
770
|
/**
|
|
771
|
+
* @public
|
|
697
772
|
* <p>The Amazon Web Services account ID that owns the cluster.</p>
|
|
698
773
|
*/
|
|
699
774
|
AccountId: string | undefined;
|
|
700
775
|
/**
|
|
776
|
+
* @public
|
|
701
777
|
* <p>The cluster identifier of the cluster whose partner integration is being described.</p>
|
|
702
778
|
*/
|
|
703
779
|
ClusterIdentifier: string | undefined;
|
|
704
780
|
/**
|
|
781
|
+
* @public
|
|
705
782
|
* <p>The name of the database whose partner integration is being described. If database name is not specified, then all databases in the cluster are described.</p>
|
|
706
783
|
*/
|
|
707
784
|
DatabaseName?: string;
|
|
708
785
|
/**
|
|
786
|
+
* @public
|
|
709
787
|
* <p>The name of the partner that is being described. If partner name is not specified, then all partner integrations are described.</p>
|
|
710
788
|
*/
|
|
711
789
|
PartnerName?: string;
|
|
@@ -730,26 +808,32 @@ export type PartnerIntegrationStatus = (typeof PartnerIntegrationStatus)[keyof t
|
|
|
730
808
|
*/
|
|
731
809
|
export interface PartnerIntegrationInfo {
|
|
732
810
|
/**
|
|
811
|
+
* @public
|
|
733
812
|
* <p>The name of the database that receives data from a partner.</p>
|
|
734
813
|
*/
|
|
735
814
|
DatabaseName?: string;
|
|
736
815
|
/**
|
|
816
|
+
* @public
|
|
737
817
|
* <p>The name of the partner.</p>
|
|
738
818
|
*/
|
|
739
819
|
PartnerName?: string;
|
|
740
820
|
/**
|
|
821
|
+
* @public
|
|
741
822
|
* <p>The partner integration status.</p>
|
|
742
823
|
*/
|
|
743
824
|
Status?: PartnerIntegrationStatus | string;
|
|
744
825
|
/**
|
|
826
|
+
* @public
|
|
745
827
|
* <p>The status message provided by the partner.</p>
|
|
746
828
|
*/
|
|
747
829
|
StatusMessage?: string;
|
|
748
830
|
/**
|
|
831
|
+
* @public
|
|
749
832
|
* <p>The date (UTC) that the partner integration was created.</p>
|
|
750
833
|
*/
|
|
751
834
|
CreatedAt?: Date;
|
|
752
835
|
/**
|
|
836
|
+
* @public
|
|
753
837
|
* <p>The date (UTC) that the partner integration status was last updated by the partner.</p>
|
|
754
838
|
*/
|
|
755
839
|
UpdatedAt?: Date;
|
|
@@ -759,6 +843,7 @@ export interface PartnerIntegrationInfo {
|
|
|
759
843
|
*/
|
|
760
844
|
export interface DescribePartnersOutputMessage {
|
|
761
845
|
/**
|
|
846
|
+
* @public
|
|
762
847
|
* <p>A list of partner integrations.</p>
|
|
763
848
|
*/
|
|
764
849
|
PartnerIntegrationInfoList?: PartnerIntegrationInfo[];
|
|
@@ -768,14 +853,17 @@ export interface DescribePartnersOutputMessage {
|
|
|
768
853
|
*/
|
|
769
854
|
export interface DescribeReservedNodeExchangeStatusInputMessage {
|
|
770
855
|
/**
|
|
856
|
+
* @public
|
|
771
857
|
* <p>The identifier of the source reserved node in a reserved-node exchange request.</p>
|
|
772
858
|
*/
|
|
773
859
|
ReservedNodeId?: string;
|
|
774
860
|
/**
|
|
861
|
+
* @public
|
|
775
862
|
* <p>The identifier of the reserved-node exchange request.</p>
|
|
776
863
|
*/
|
|
777
864
|
ReservedNodeExchangeRequestId?: string;
|
|
778
865
|
/**
|
|
866
|
+
* @public
|
|
779
867
|
* <p>The maximum number of response records to return in each call. If the number of
|
|
780
868
|
* remaining response records exceeds the specified <code>MaxRecords</code> value, a value
|
|
781
869
|
* is returned in a <code>Marker</code> field of the response. You can retrieve the next
|
|
@@ -783,6 +871,7 @@ export interface DescribeReservedNodeExchangeStatusInputMessage {
|
|
|
783
871
|
*/
|
|
784
872
|
MaxRecords?: number;
|
|
785
873
|
/**
|
|
874
|
+
* @public
|
|
786
875
|
* <p>An optional pagination token provided by a previous <code>DescribeReservedNodeExchangeStatus</code> request. If this
|
|
787
876
|
* parameter is specified, the response includes only records beyond the marker, up to the value
|
|
788
877
|
* specified by the <code>MaxRecords</code> parameter. You can retrieve the next set of response
|
|
@@ -796,11 +885,13 @@ export interface DescribeReservedNodeExchangeStatusInputMessage {
|
|
|
796
885
|
*/
|
|
797
886
|
export interface DescribeReservedNodeExchangeStatusOutputMessage {
|
|
798
887
|
/**
|
|
888
|
+
* @public
|
|
799
889
|
* <p>The details of the reserved-node exchange request, including the status, request
|
|
800
890
|
* time, source reserved-node identifier, and additional details.</p>
|
|
801
891
|
*/
|
|
802
892
|
ReservedNodeExchangeStatusDetails?: ReservedNodeExchangeStatus[];
|
|
803
893
|
/**
|
|
894
|
+
* @public
|
|
804
895
|
* <p>A pagination token provided by a previous <code>DescribeReservedNodeExchangeStatus</code> request.</p>
|
|
805
896
|
*/
|
|
806
897
|
Marker?: string;
|
|
@@ -823,10 +914,12 @@ export declare class ReservedNodeExchangeNotFoundFault extends __BaseException {
|
|
|
823
914
|
*/
|
|
824
915
|
export interface DescribeReservedNodeOfferingsMessage {
|
|
825
916
|
/**
|
|
917
|
+
* @public
|
|
826
918
|
* <p>The unique identifier for the offering.</p>
|
|
827
919
|
*/
|
|
828
920
|
ReservedNodeOfferingId?: string;
|
|
829
921
|
/**
|
|
922
|
+
* @public
|
|
830
923
|
* <p>The maximum number of response records to return in each call. If the number of
|
|
831
924
|
* remaining response records exceeds the specified <code>MaxRecords</code> value, a value
|
|
832
925
|
* is returned in a <code>marker</code> field of the response. You can retrieve the next
|
|
@@ -837,6 +930,7 @@ export interface DescribeReservedNodeOfferingsMessage {
|
|
|
837
930
|
*/
|
|
838
931
|
MaxRecords?: number;
|
|
839
932
|
/**
|
|
933
|
+
* @public
|
|
840
934
|
* <p>An optional parameter that specifies the starting point to return a set of response
|
|
841
935
|
* records. When the results of a <a>DescribeReservedNodeOfferings</a> request
|
|
842
936
|
* exceed the value specified in <code>MaxRecords</code>, Amazon Web Services returns a value in the
|
|
@@ -852,43 +946,52 @@ export interface DescribeReservedNodeOfferingsMessage {
|
|
|
852
946
|
*/
|
|
853
947
|
export interface ReservedNodeOffering {
|
|
854
948
|
/**
|
|
949
|
+
* @public
|
|
855
950
|
* <p>The offering identifier.</p>
|
|
856
951
|
*/
|
|
857
952
|
ReservedNodeOfferingId?: string;
|
|
858
953
|
/**
|
|
954
|
+
* @public
|
|
859
955
|
* <p>The node type offered by the reserved node offering.</p>
|
|
860
956
|
*/
|
|
861
957
|
NodeType?: string;
|
|
862
958
|
/**
|
|
959
|
+
* @public
|
|
863
960
|
* <p>The duration, in seconds, for which the offering will reserve the node.</p>
|
|
864
961
|
*/
|
|
865
962
|
Duration?: number;
|
|
866
963
|
/**
|
|
964
|
+
* @public
|
|
867
965
|
* <p>The upfront fixed charge you will pay to purchase the specific reserved node
|
|
868
966
|
* offering.</p>
|
|
869
967
|
*/
|
|
870
968
|
FixedPrice?: number;
|
|
871
969
|
/**
|
|
970
|
+
* @public
|
|
872
971
|
* <p>The rate you are charged for each hour the cluster that is using the offering is
|
|
873
972
|
* running.</p>
|
|
874
973
|
*/
|
|
875
974
|
UsagePrice?: number;
|
|
876
975
|
/**
|
|
976
|
+
* @public
|
|
877
977
|
* <p>The currency code for the compute nodes offering.</p>
|
|
878
978
|
*/
|
|
879
979
|
CurrencyCode?: string;
|
|
880
980
|
/**
|
|
981
|
+
* @public
|
|
881
982
|
* <p>The anticipated utilization of the reserved node, as defined in the reserved node
|
|
882
983
|
* offering.</p>
|
|
883
984
|
*/
|
|
884
985
|
OfferingType?: string;
|
|
885
986
|
/**
|
|
987
|
+
* @public
|
|
886
988
|
* <p>The charge to your account regardless of whether you are creating any clusters
|
|
887
989
|
* using the node offering. Recurring charges are only in effect for heavy-utilization
|
|
888
990
|
* reserved nodes.</p>
|
|
889
991
|
*/
|
|
890
992
|
RecurringCharges?: RecurringCharge[];
|
|
891
993
|
/**
|
|
994
|
+
* @public
|
|
892
995
|
* <p></p>
|
|
893
996
|
*/
|
|
894
997
|
ReservedNodeOfferingType?: ReservedNodeOfferingType | string;
|
|
@@ -899,6 +1002,7 @@ export interface ReservedNodeOffering {
|
|
|
899
1002
|
*/
|
|
900
1003
|
export interface ReservedNodeOfferingsMessage {
|
|
901
1004
|
/**
|
|
1005
|
+
* @public
|
|
902
1006
|
* <p>A value that indicates the starting point for the next set of response records in a
|
|
903
1007
|
* subsequent request. If a value is returned in a response, you can retrieve the next set
|
|
904
1008
|
* of records by providing this returned marker value in the <code>Marker</code> parameter
|
|
@@ -907,6 +1011,7 @@ export interface ReservedNodeOfferingsMessage {
|
|
|
907
1011
|
*/
|
|
908
1012
|
Marker?: string;
|
|
909
1013
|
/**
|
|
1014
|
+
* @public
|
|
910
1015
|
* <p>A list of <code>ReservedNodeOffering</code> objects.</p>
|
|
911
1016
|
*/
|
|
912
1017
|
ReservedNodeOfferings?: ReservedNodeOffering[];
|
|
@@ -917,10 +1022,12 @@ export interface ReservedNodeOfferingsMessage {
|
|
|
917
1022
|
*/
|
|
918
1023
|
export interface DescribeReservedNodesMessage {
|
|
919
1024
|
/**
|
|
1025
|
+
* @public
|
|
920
1026
|
* <p>Identifier for the node reservation.</p>
|
|
921
1027
|
*/
|
|
922
1028
|
ReservedNodeId?: string;
|
|
923
1029
|
/**
|
|
1030
|
+
* @public
|
|
924
1031
|
* <p>The maximum number of response records to return in each call. If the number of
|
|
925
1032
|
* remaining response records exceeds the specified <code>MaxRecords</code> value, a value
|
|
926
1033
|
* is returned in a <code>marker</code> field of the response. You can retrieve the next
|
|
@@ -931,6 +1038,7 @@ export interface DescribeReservedNodesMessage {
|
|
|
931
1038
|
*/
|
|
932
1039
|
MaxRecords?: number;
|
|
933
1040
|
/**
|
|
1041
|
+
* @public
|
|
934
1042
|
* <p>An optional parameter that specifies the starting point to return a set of response
|
|
935
1043
|
* records. When the results of a <a>DescribeReservedNodes</a> request exceed
|
|
936
1044
|
* the value specified in <code>MaxRecords</code>, Amazon Web Services returns a value in the
|
|
@@ -946,6 +1054,7 @@ export interface DescribeReservedNodesMessage {
|
|
|
946
1054
|
*/
|
|
947
1055
|
export interface ReservedNodesMessage {
|
|
948
1056
|
/**
|
|
1057
|
+
* @public
|
|
949
1058
|
* <p>A value that indicates the starting point for the next set of response records in a
|
|
950
1059
|
* subsequent request. If a value is returned in a response, you can retrieve the next set
|
|
951
1060
|
* of records by providing this returned marker value in the <code>Marker</code> parameter
|
|
@@ -954,6 +1063,7 @@ export interface ReservedNodesMessage {
|
|
|
954
1063
|
*/
|
|
955
1064
|
Marker?: string;
|
|
956
1065
|
/**
|
|
1066
|
+
* @public
|
|
957
1067
|
* <p>The list of <code>ReservedNode</code> objects.</p>
|
|
958
1068
|
*/
|
|
959
1069
|
ReservedNodes?: ReservedNode[];
|
|
@@ -964,6 +1074,7 @@ export interface ReservedNodesMessage {
|
|
|
964
1074
|
*/
|
|
965
1075
|
export interface DescribeResizeMessage {
|
|
966
1076
|
/**
|
|
1077
|
+
* @public
|
|
967
1078
|
* <p>The unique identifier of a cluster whose resize progress you are requesting. This
|
|
968
1079
|
* parameter is case-sensitive.</p>
|
|
969
1080
|
* <p>By default, resize operations for all clusters defined for an Amazon Web Services account are
|
|
@@ -989,10 +1100,12 @@ export type ScheduledActionFilterName = (typeof ScheduledActionFilterName)[keyof
|
|
|
989
1100
|
*/
|
|
990
1101
|
export interface ScheduledActionFilter {
|
|
991
1102
|
/**
|
|
1103
|
+
* @public
|
|
992
1104
|
* <p>The type of element to filter. </p>
|
|
993
1105
|
*/
|
|
994
1106
|
Name: ScheduledActionFilterName | string | undefined;
|
|
995
1107
|
/**
|
|
1108
|
+
* @public
|
|
996
1109
|
* <p>List of values. Compare if the value (of type defined by <code>Name</code>) equals an item in the list of scheduled actions. </p>
|
|
997
1110
|
*/
|
|
998
1111
|
Values: string[] | undefined;
|
|
@@ -1015,33 +1128,40 @@ export type ScheduledActionTypeValues = (typeof ScheduledActionTypeValues)[keyof
|
|
|
1015
1128
|
*/
|
|
1016
1129
|
export interface DescribeScheduledActionsMessage {
|
|
1017
1130
|
/**
|
|
1131
|
+
* @public
|
|
1018
1132
|
* <p>The name of the scheduled action to retrieve. </p>
|
|
1019
1133
|
*/
|
|
1020
1134
|
ScheduledActionName?: string;
|
|
1021
1135
|
/**
|
|
1136
|
+
* @public
|
|
1022
1137
|
* <p>The type of the scheduled actions to retrieve. </p>
|
|
1023
1138
|
*/
|
|
1024
1139
|
TargetActionType?: ScheduledActionTypeValues | string;
|
|
1025
1140
|
/**
|
|
1141
|
+
* @public
|
|
1026
1142
|
* <p>The start time in UTC of the scheduled actions to retrieve.
|
|
1027
1143
|
* Only active scheduled actions that have invocations after this time are retrieved.</p>
|
|
1028
1144
|
*/
|
|
1029
1145
|
StartTime?: Date;
|
|
1030
1146
|
/**
|
|
1147
|
+
* @public
|
|
1031
1148
|
* <p>The end time in UTC of the scheduled action to retrieve.
|
|
1032
1149
|
* Only active scheduled actions that have invocations before this time are retrieved.</p>
|
|
1033
1150
|
*/
|
|
1034
1151
|
EndTime?: Date;
|
|
1035
1152
|
/**
|
|
1153
|
+
* @public
|
|
1036
1154
|
* <p>If true, retrieve only active scheduled actions.
|
|
1037
1155
|
* If false, retrieve only disabled scheduled actions. </p>
|
|
1038
1156
|
*/
|
|
1039
1157
|
Active?: boolean;
|
|
1040
1158
|
/**
|
|
1159
|
+
* @public
|
|
1041
1160
|
* <p>List of scheduled action filters. </p>
|
|
1042
1161
|
*/
|
|
1043
1162
|
Filters?: ScheduledActionFilter[];
|
|
1044
1163
|
/**
|
|
1164
|
+
* @public
|
|
1045
1165
|
* <p>An optional parameter that specifies the starting point to return a set of response
|
|
1046
1166
|
* records. When the results of a <a>DescribeScheduledActions</a> request
|
|
1047
1167
|
* exceed the value specified in <code>MaxRecords</code>, Amazon Web Services returns a value in the
|
|
@@ -1051,6 +1171,7 @@ export interface DescribeScheduledActionsMessage {
|
|
|
1051
1171
|
*/
|
|
1052
1172
|
Marker?: string;
|
|
1053
1173
|
/**
|
|
1174
|
+
* @public
|
|
1054
1175
|
* <p>The maximum number of response records to return in each call. If the number of
|
|
1055
1176
|
* remaining response records exceeds the specified <code>MaxRecords</code> value, a value
|
|
1056
1177
|
* is returned in a <code>marker</code> field of the response. You can retrieve the next
|
|
@@ -1066,6 +1187,7 @@ export interface DescribeScheduledActionsMessage {
|
|
|
1066
1187
|
*/
|
|
1067
1188
|
export interface ScheduledActionsMessage {
|
|
1068
1189
|
/**
|
|
1190
|
+
* @public
|
|
1069
1191
|
* <p>An optional parameter that specifies the starting point to return a set of response
|
|
1070
1192
|
* records. When the results of a <a>DescribeScheduledActions</a> request
|
|
1071
1193
|
* exceed the value specified in <code>MaxRecords</code>, Amazon Web Services returns a value in the
|
|
@@ -1075,6 +1197,7 @@ export interface ScheduledActionsMessage {
|
|
|
1075
1197
|
*/
|
|
1076
1198
|
Marker?: string;
|
|
1077
1199
|
/**
|
|
1200
|
+
* @public
|
|
1078
1201
|
* <p>List of retrieved scheduled actions. </p>
|
|
1079
1202
|
*/
|
|
1080
1203
|
ScheduledActions?: ScheduledAction[];
|
|
@@ -1085,10 +1208,12 @@ export interface ScheduledActionsMessage {
|
|
|
1085
1208
|
*/
|
|
1086
1209
|
export interface DescribeSnapshotCopyGrantsMessage {
|
|
1087
1210
|
/**
|
|
1211
|
+
* @public
|
|
1088
1212
|
* <p>The name of the snapshot copy grant.</p>
|
|
1089
1213
|
*/
|
|
1090
1214
|
SnapshotCopyGrantName?: string;
|
|
1091
1215
|
/**
|
|
1216
|
+
* @public
|
|
1092
1217
|
* <p>The maximum number of response records to return in each call. If the number of
|
|
1093
1218
|
* remaining response records exceeds the specified <code>MaxRecords</code> value, a value
|
|
1094
1219
|
* is returned in a <code>marker</code> field of the response. You can retrieve the next
|
|
@@ -1099,6 +1224,7 @@ export interface DescribeSnapshotCopyGrantsMessage {
|
|
|
1099
1224
|
*/
|
|
1100
1225
|
MaxRecords?: number;
|
|
1101
1226
|
/**
|
|
1227
|
+
* @public
|
|
1102
1228
|
* <p>An optional parameter that specifies the starting point to return a set of response
|
|
1103
1229
|
* records. When the results of a <code>DescribeSnapshotCopyGrant</code> request exceed the
|
|
1104
1230
|
* value specified in <code>MaxRecords</code>, Amazon Web Services returns a value in the
|
|
@@ -1109,6 +1235,7 @@ export interface DescribeSnapshotCopyGrantsMessage {
|
|
|
1109
1235
|
*/
|
|
1110
1236
|
Marker?: string;
|
|
1111
1237
|
/**
|
|
1238
|
+
* @public
|
|
1112
1239
|
* <p>A tag key or keys for which you want to return all matching resources that are
|
|
1113
1240
|
* associated with the specified key or keys. For example, suppose that you have resources
|
|
1114
1241
|
* tagged with keys called <code>owner</code> and <code>environment</code>. If you specify
|
|
@@ -1117,6 +1244,7 @@ export interface DescribeSnapshotCopyGrantsMessage {
|
|
|
1117
1244
|
*/
|
|
1118
1245
|
TagKeys?: string[];
|
|
1119
1246
|
/**
|
|
1247
|
+
* @public
|
|
1120
1248
|
* <p>A tag value or values for which you want to return all matching resources that are
|
|
1121
1249
|
* associated with the specified value or values. For example, suppose that you have
|
|
1122
1250
|
* resources tagged with values called <code>admin</code> and <code>test</code>. If you
|
|
@@ -1131,6 +1259,7 @@ export interface DescribeSnapshotCopyGrantsMessage {
|
|
|
1131
1259
|
*/
|
|
1132
1260
|
export interface SnapshotCopyGrantMessage {
|
|
1133
1261
|
/**
|
|
1262
|
+
* @public
|
|
1134
1263
|
* <p>An optional parameter that specifies the starting point to return a set of response
|
|
1135
1264
|
* records. When the results of a <code>DescribeSnapshotCopyGrant</code> request exceed the
|
|
1136
1265
|
* value specified in <code>MaxRecords</code>, Amazon Web Services returns a value in the
|
|
@@ -1141,6 +1270,7 @@ export interface SnapshotCopyGrantMessage {
|
|
|
1141
1270
|
*/
|
|
1142
1271
|
Marker?: string;
|
|
1143
1272
|
/**
|
|
1273
|
+
* @public
|
|
1144
1274
|
* <p>The list of <code>SnapshotCopyGrant</code> objects.</p>
|
|
1145
1275
|
*/
|
|
1146
1276
|
SnapshotCopyGrants?: SnapshotCopyGrant[];
|
|
@@ -1150,23 +1280,28 @@ export interface SnapshotCopyGrantMessage {
|
|
|
1150
1280
|
*/
|
|
1151
1281
|
export interface DescribeSnapshotSchedulesMessage {
|
|
1152
1282
|
/**
|
|
1283
|
+
* @public
|
|
1153
1284
|
* <p>The unique identifier for the cluster whose snapshot schedules you want to
|
|
1154
1285
|
* view.</p>
|
|
1155
1286
|
*/
|
|
1156
1287
|
ClusterIdentifier?: string;
|
|
1157
1288
|
/**
|
|
1289
|
+
* @public
|
|
1158
1290
|
* <p>A unique identifier for a snapshot schedule.</p>
|
|
1159
1291
|
*/
|
|
1160
1292
|
ScheduleIdentifier?: string;
|
|
1161
1293
|
/**
|
|
1294
|
+
* @public
|
|
1162
1295
|
* <p>The key value for a snapshot schedule tag.</p>
|
|
1163
1296
|
*/
|
|
1164
1297
|
TagKeys?: string[];
|
|
1165
1298
|
/**
|
|
1299
|
+
* @public
|
|
1166
1300
|
* <p>The value corresponding to the key of the snapshot schedule tag.</p>
|
|
1167
1301
|
*/
|
|
1168
1302
|
TagValues?: string[];
|
|
1169
1303
|
/**
|
|
1304
|
+
* @public
|
|
1170
1305
|
* <p>A value that indicates the starting point for the next set of response records in a
|
|
1171
1306
|
* subsequent request. If a value is returned in a response, you can retrieve the next set
|
|
1172
1307
|
* of records by providing this returned marker value in the <code>marker</code> parameter
|
|
@@ -1175,6 +1310,7 @@ export interface DescribeSnapshotSchedulesMessage {
|
|
|
1175
1310
|
*/
|
|
1176
1311
|
Marker?: string;
|
|
1177
1312
|
/**
|
|
1313
|
+
* @public
|
|
1178
1314
|
* <p>The maximum number or response records to return in each call. If the number of
|
|
1179
1315
|
* remaining response records exceeds the specified <code>MaxRecords</code> value, a value
|
|
1180
1316
|
* is returned in a <code>marker</code> field of the response. You can retrieve the next
|
|
@@ -1188,10 +1324,12 @@ export interface DescribeSnapshotSchedulesMessage {
|
|
|
1188
1324
|
*/
|
|
1189
1325
|
export interface DescribeSnapshotSchedulesOutputMessage {
|
|
1190
1326
|
/**
|
|
1327
|
+
* @public
|
|
1191
1328
|
* <p>A list of SnapshotSchedules.</p>
|
|
1192
1329
|
*/
|
|
1193
1330
|
SnapshotSchedules?: SnapshotSchedule[];
|
|
1194
1331
|
/**
|
|
1332
|
+
* @public
|
|
1195
1333
|
* <p>A value that indicates the starting point for the next set of response records in a
|
|
1196
1334
|
* subsequent request. If a value is returned in a response, you can retrieve the next set
|
|
1197
1335
|
* of records by providing this returned marker value in the <code>marker</code> parameter
|
|
@@ -1206,10 +1344,12 @@ export interface DescribeSnapshotSchedulesOutputMessage {
|
|
|
1206
1344
|
*/
|
|
1207
1345
|
export interface DescribeTableRestoreStatusMessage {
|
|
1208
1346
|
/**
|
|
1347
|
+
* @public
|
|
1209
1348
|
* <p>The Amazon Redshift cluster that the table is being restored to.</p>
|
|
1210
1349
|
*/
|
|
1211
1350
|
ClusterIdentifier?: string;
|
|
1212
1351
|
/**
|
|
1352
|
+
* @public
|
|
1213
1353
|
* <p>The identifier of the table restore request to return status for. If you don't
|
|
1214
1354
|
* specify a <code>TableRestoreRequestId</code> value, then
|
|
1215
1355
|
* <code>DescribeTableRestoreStatus</code> returns the status of all in-progress table
|
|
@@ -1217,12 +1357,14 @@ export interface DescribeTableRestoreStatusMessage {
|
|
|
1217
1357
|
*/
|
|
1218
1358
|
TableRestoreRequestId?: string;
|
|
1219
1359
|
/**
|
|
1360
|
+
* @public
|
|
1220
1361
|
* <p>The maximum number of records to include in the response. If more records exist
|
|
1221
1362
|
* than the specified <code>MaxRecords</code> value, a pagination token called a marker is
|
|
1222
1363
|
* included in the response so that the remaining results can be retrieved.</p>
|
|
1223
1364
|
*/
|
|
1224
1365
|
MaxRecords?: number;
|
|
1225
1366
|
/**
|
|
1367
|
+
* @public
|
|
1226
1368
|
* <p>An optional pagination token provided by a previous
|
|
1227
1369
|
* <code>DescribeTableRestoreStatus</code> request. If this parameter is specified, the
|
|
1228
1370
|
* response includes only records beyond the marker, up to the value specified by the
|
|
@@ -1264,10 +1406,12 @@ export type TableRestoreStatusType = (typeof TableRestoreStatusType)[keyof typeo
|
|
|
1264
1406
|
*/
|
|
1265
1407
|
export interface TableRestoreStatus {
|
|
1266
1408
|
/**
|
|
1409
|
+
* @public
|
|
1267
1410
|
* <p>The unique identifier for the table restore request.</p>
|
|
1268
1411
|
*/
|
|
1269
1412
|
TableRestoreRequestId?: string;
|
|
1270
1413
|
/**
|
|
1414
|
+
* @public
|
|
1271
1415
|
* <p>A value that describes the current state of the table restore request.</p>
|
|
1272
1416
|
* <p>Valid Values: <code>SUCCEEDED</code>, <code>FAILED</code>, <code>CANCELED</code>,
|
|
1273
1417
|
* <code>PENDING</code>, <code>IN_PROGRESS</code>
|
|
@@ -1275,54 +1419,66 @@ export interface TableRestoreStatus {
|
|
|
1275
1419
|
*/
|
|
1276
1420
|
Status?: TableRestoreStatusType | string;
|
|
1277
1421
|
/**
|
|
1422
|
+
* @public
|
|
1278
1423
|
* <p>A description of the status of the table restore request. Status values include
|
|
1279
1424
|
* <code>SUCCEEDED</code>, <code>FAILED</code>, <code>CANCELED</code>,
|
|
1280
1425
|
* <code>PENDING</code>, <code>IN_PROGRESS</code>.</p>
|
|
1281
1426
|
*/
|
|
1282
1427
|
Message?: string;
|
|
1283
1428
|
/**
|
|
1429
|
+
* @public
|
|
1284
1430
|
* <p>The time that the table restore request was made, in Universal Coordinated Time
|
|
1285
1431
|
* (UTC).</p>
|
|
1286
1432
|
*/
|
|
1287
1433
|
RequestTime?: Date;
|
|
1288
1434
|
/**
|
|
1435
|
+
* @public
|
|
1289
1436
|
* <p>The amount of data restored to the new table so far, in megabytes (MB).</p>
|
|
1290
1437
|
*/
|
|
1291
1438
|
ProgressInMegaBytes?: number;
|
|
1292
1439
|
/**
|
|
1440
|
+
* @public
|
|
1293
1441
|
* <p>The total amount of data to restore to the new table, in megabytes (MB).</p>
|
|
1294
1442
|
*/
|
|
1295
1443
|
TotalDataInMegaBytes?: number;
|
|
1296
1444
|
/**
|
|
1445
|
+
* @public
|
|
1297
1446
|
* <p>The identifier of the Amazon Redshift cluster that the table is being restored
|
|
1298
1447
|
* to.</p>
|
|
1299
1448
|
*/
|
|
1300
1449
|
ClusterIdentifier?: string;
|
|
1301
1450
|
/**
|
|
1451
|
+
* @public
|
|
1302
1452
|
* <p>The identifier of the snapshot that the table is being restored from.</p>
|
|
1303
1453
|
*/
|
|
1304
1454
|
SnapshotIdentifier?: string;
|
|
1305
1455
|
/**
|
|
1456
|
+
* @public
|
|
1306
1457
|
* <p>The name of the source database that contains the table being restored.</p>
|
|
1307
1458
|
*/
|
|
1308
1459
|
SourceDatabaseName?: string;
|
|
1309
1460
|
/**
|
|
1461
|
+
* @public
|
|
1310
1462
|
* <p>The name of the source schema that contains the table being restored.</p>
|
|
1311
1463
|
*/
|
|
1312
1464
|
SourceSchemaName?: string;
|
|
1313
1465
|
/**
|
|
1466
|
+
* @public
|
|
1314
1467
|
* <p>The name of the source table being restored.</p>
|
|
1315
1468
|
*/
|
|
1316
1469
|
SourceTableName?: string;
|
|
1317
1470
|
/**
|
|
1471
|
+
* @public
|
|
1318
1472
|
* <p>The name of the database to restore the table to.</p>
|
|
1319
1473
|
*/
|
|
1320
1474
|
TargetDatabaseName?: string;
|
|
1321
1475
|
/**
|
|
1476
|
+
* @public
|
|
1322
1477
|
* <p>The name of the schema to restore the table to.</p>
|
|
1323
1478
|
*/
|
|
1324
1479
|
TargetSchemaName?: string;
|
|
1325
1480
|
/**
|
|
1481
|
+
* @public
|
|
1326
1482
|
* <p>The name of the table to create as a result of the table restore request.</p>
|
|
1327
1483
|
*/
|
|
1328
1484
|
NewTableName?: string;
|
|
@@ -1333,10 +1489,12 @@ export interface TableRestoreStatus {
|
|
|
1333
1489
|
*/
|
|
1334
1490
|
export interface TableRestoreStatusMessage {
|
|
1335
1491
|
/**
|
|
1492
|
+
* @public
|
|
1336
1493
|
* <p>A list of status details for one or more table restore requests.</p>
|
|
1337
1494
|
*/
|
|
1338
1495
|
TableRestoreStatusDetails?: TableRestoreStatus[];
|
|
1339
1496
|
/**
|
|
1497
|
+
* @public
|
|
1340
1498
|
* <p>A pagination token that can be used in a subsequent <a>DescribeTableRestoreStatus</a> request.</p>
|
|
1341
1499
|
*/
|
|
1342
1500
|
Marker?: string;
|
|
@@ -1347,11 +1505,13 @@ export interface TableRestoreStatusMessage {
|
|
|
1347
1505
|
*/
|
|
1348
1506
|
export interface DescribeTagsMessage {
|
|
1349
1507
|
/**
|
|
1508
|
+
* @public
|
|
1350
1509
|
* <p>The Amazon Resource Name (ARN) for which you want to describe the tag or tags. For
|
|
1351
1510
|
* example, <code>arn:aws:redshift:us-east-2:123456789:cluster:t1</code>. </p>
|
|
1352
1511
|
*/
|
|
1353
1512
|
ResourceName?: string;
|
|
1354
1513
|
/**
|
|
1514
|
+
* @public
|
|
1355
1515
|
* <p>The type of resource with which you want to view tags. Valid resource types are: </p>
|
|
1356
1516
|
* <ul>
|
|
1357
1517
|
* <li>
|
|
@@ -1391,6 +1551,7 @@ export interface DescribeTagsMessage {
|
|
|
1391
1551
|
*/
|
|
1392
1552
|
ResourceType?: string;
|
|
1393
1553
|
/**
|
|
1554
|
+
* @public
|
|
1394
1555
|
* <p>The maximum number or response records to return in each call. If the number of
|
|
1395
1556
|
* remaining response records exceeds the specified <code>MaxRecords</code> value, a value
|
|
1396
1557
|
* is returned in a <code>marker</code> field of the response. You can retrieve the next
|
|
@@ -1399,6 +1560,7 @@ export interface DescribeTagsMessage {
|
|
|
1399
1560
|
*/
|
|
1400
1561
|
MaxRecords?: number;
|
|
1401
1562
|
/**
|
|
1563
|
+
* @public
|
|
1402
1564
|
* <p>A value that indicates the starting point for the next set of response records in a
|
|
1403
1565
|
* subsequent request. If a value is returned in a response, you can retrieve the next set
|
|
1404
1566
|
* of records by providing this returned marker value in the <code>marker</code> parameter
|
|
@@ -1407,6 +1569,7 @@ export interface DescribeTagsMessage {
|
|
|
1407
1569
|
*/
|
|
1408
1570
|
Marker?: string;
|
|
1409
1571
|
/**
|
|
1572
|
+
* @public
|
|
1410
1573
|
* <p>A tag key or keys for which you want to return all matching resources that are
|
|
1411
1574
|
* associated with the specified key or keys. For example, suppose that you have resources
|
|
1412
1575
|
* tagged with keys called <code>owner</code> and <code>environment</code>. If you specify
|
|
@@ -1415,6 +1578,7 @@ export interface DescribeTagsMessage {
|
|
|
1415
1578
|
*/
|
|
1416
1579
|
TagKeys?: string[];
|
|
1417
1580
|
/**
|
|
1581
|
+
* @public
|
|
1418
1582
|
* <p>A tag value or values for which you want to return all matching resources that are
|
|
1419
1583
|
* associated with the specified value or values. For example, suppose that you have
|
|
1420
1584
|
* resources tagged with values called <code>admin</code> and <code>test</code>. If you
|
|
@@ -1429,15 +1593,18 @@ export interface DescribeTagsMessage {
|
|
|
1429
1593
|
*/
|
|
1430
1594
|
export interface TaggedResource {
|
|
1431
1595
|
/**
|
|
1596
|
+
* @public
|
|
1432
1597
|
* <p>The tag for the resource.</p>
|
|
1433
1598
|
*/
|
|
1434
1599
|
Tag?: Tag;
|
|
1435
1600
|
/**
|
|
1601
|
+
* @public
|
|
1436
1602
|
* <p>The Amazon Resource Name (ARN) with which the tag is associated, for example:
|
|
1437
1603
|
* <code>arn:aws:redshift:us-east-2:123456789:cluster:t1</code>.</p>
|
|
1438
1604
|
*/
|
|
1439
1605
|
ResourceName?: string;
|
|
1440
1606
|
/**
|
|
1607
|
+
* @public
|
|
1441
1608
|
* <p>The type of resource with which the tag is associated. Valid resource types are: </p>
|
|
1442
1609
|
* <ul>
|
|
1443
1610
|
* <li>
|
|
@@ -1480,10 +1647,12 @@ export interface TaggedResource {
|
|
|
1480
1647
|
*/
|
|
1481
1648
|
export interface TaggedResourceListMessage {
|
|
1482
1649
|
/**
|
|
1650
|
+
* @public
|
|
1483
1651
|
* <p>A list of tags with their associated resources.</p>
|
|
1484
1652
|
*/
|
|
1485
1653
|
TaggedResources?: TaggedResource[];
|
|
1486
1654
|
/**
|
|
1655
|
+
* @public
|
|
1487
1656
|
* <p>A value that indicates the starting point for the next set of response records in a
|
|
1488
1657
|
* subsequent request. If a value is returned in a response, you can retrieve the next set
|
|
1489
1658
|
* of records by providing this returned marker value in the <code>Marker</code> parameter
|
|
@@ -1497,18 +1666,22 @@ export interface TaggedResourceListMessage {
|
|
|
1497
1666
|
*/
|
|
1498
1667
|
export interface DescribeUsageLimitsMessage {
|
|
1499
1668
|
/**
|
|
1669
|
+
* @public
|
|
1500
1670
|
* <p>The identifier of the usage limit to describe.</p>
|
|
1501
1671
|
*/
|
|
1502
1672
|
UsageLimitId?: string;
|
|
1503
1673
|
/**
|
|
1674
|
+
* @public
|
|
1504
1675
|
* <p>The identifier of the cluster for which you want to describe usage limits.</p>
|
|
1505
1676
|
*/
|
|
1506
1677
|
ClusterIdentifier?: string;
|
|
1507
1678
|
/**
|
|
1679
|
+
* @public
|
|
1508
1680
|
* <p>The feature type for which you want to describe usage limits.</p>
|
|
1509
1681
|
*/
|
|
1510
1682
|
FeatureType?: UsageLimitFeatureType | string;
|
|
1511
1683
|
/**
|
|
1684
|
+
* @public
|
|
1512
1685
|
* <p>The maximum number of response records to return in each call. If the number of
|
|
1513
1686
|
* remaining response records exceeds the specified <code>MaxRecords</code> value, a value
|
|
1514
1687
|
* is returned in a <code>marker</code> field of the response. You can retrieve the next
|
|
@@ -1519,6 +1692,7 @@ export interface DescribeUsageLimitsMessage {
|
|
|
1519
1692
|
*/
|
|
1520
1693
|
MaxRecords?: number;
|
|
1521
1694
|
/**
|
|
1695
|
+
* @public
|
|
1522
1696
|
* <p>An optional parameter that specifies the starting point to return a set of response
|
|
1523
1697
|
* records. When the results of a <a>DescribeUsageLimits</a> request
|
|
1524
1698
|
* exceed the value specified in <code>MaxRecords</code>, Amazon Web Services returns a value in the
|
|
@@ -1528,6 +1702,7 @@ export interface DescribeUsageLimitsMessage {
|
|
|
1528
1702
|
*/
|
|
1529
1703
|
Marker?: string;
|
|
1530
1704
|
/**
|
|
1705
|
+
* @public
|
|
1531
1706
|
* <p>A tag key or keys for which you want to return all matching usage limit objects
|
|
1532
1707
|
* that are associated with the specified key or keys. For example, suppose that you
|
|
1533
1708
|
* have parameter groups that are tagged with keys called <code>owner</code> and
|
|
@@ -1537,6 +1712,7 @@ export interface DescribeUsageLimitsMessage {
|
|
|
1537
1712
|
*/
|
|
1538
1713
|
TagKeys?: string[];
|
|
1539
1714
|
/**
|
|
1715
|
+
* @public
|
|
1540
1716
|
* <p>A tag value or values for which you want to return all matching usage limit objects
|
|
1541
1717
|
* that are associated with the specified tag value or values. For example, suppose
|
|
1542
1718
|
* that you have parameter groups that are tagged with values called <code>admin</code> and
|
|
@@ -1551,11 +1727,13 @@ export interface DescribeUsageLimitsMessage {
|
|
|
1551
1727
|
*/
|
|
1552
1728
|
export interface UsageLimitList {
|
|
1553
1729
|
/**
|
|
1730
|
+
* @public
|
|
1554
1731
|
* <p>Contains the output from the <a>DescribeUsageLimits</a>
|
|
1555
1732
|
* action. </p>
|
|
1556
1733
|
*/
|
|
1557
1734
|
UsageLimits?: UsageLimit[];
|
|
1558
1735
|
/**
|
|
1736
|
+
* @public
|
|
1559
1737
|
* <p>A value that indicates the starting point for the next set of response records in a
|
|
1560
1738
|
* subsequent request. If a value is returned in a response, you can retrieve the next set
|
|
1561
1739
|
* of records by providing this returned marker value in the <code>Marker</code> parameter
|
|
@@ -1570,6 +1748,7 @@ export interface UsageLimitList {
|
|
|
1570
1748
|
*/
|
|
1571
1749
|
export interface DisableLoggingMessage {
|
|
1572
1750
|
/**
|
|
1751
|
+
* @public
|
|
1573
1752
|
* <p>The identifier of the cluster on which logging is to be stopped.</p>
|
|
1574
1753
|
* <p>Example: <code>examplecluster</code>
|
|
1575
1754
|
* </p>
|
|
@@ -1582,6 +1761,7 @@ export interface DisableLoggingMessage {
|
|
|
1582
1761
|
*/
|
|
1583
1762
|
export interface DisableSnapshotCopyMessage {
|
|
1584
1763
|
/**
|
|
1764
|
+
* @public
|
|
1585
1765
|
* <p>The unique identifier of the source cluster that you want to disable copying of
|
|
1586
1766
|
* snapshots to a destination region.</p>
|
|
1587
1767
|
* <p>Constraints: Must be the valid name of an existing cluster that has cross-region
|
|
@@ -1594,6 +1774,7 @@ export interface DisableSnapshotCopyMessage {
|
|
|
1594
1774
|
*/
|
|
1595
1775
|
export interface DisableSnapshotCopyResult {
|
|
1596
1776
|
/**
|
|
1777
|
+
* @public
|
|
1597
1778
|
* <p>Describes a cluster.</p>
|
|
1598
1779
|
*/
|
|
1599
1780
|
Cluster?: Cluster;
|
|
@@ -1615,20 +1796,24 @@ export declare class SnapshotCopyAlreadyDisabledFault extends __BaseException {
|
|
|
1615
1796
|
*/
|
|
1616
1797
|
export interface DisassociateDataShareConsumerMessage {
|
|
1617
1798
|
/**
|
|
1799
|
+
* @public
|
|
1618
1800
|
* <p>The Amazon Resource Name (ARN) of the datashare to remove association for. </p>
|
|
1619
1801
|
*/
|
|
1620
1802
|
DataShareArn: string | undefined;
|
|
1621
1803
|
/**
|
|
1804
|
+
* @public
|
|
1622
1805
|
* <p>A value that specifies whether association for the datashare is removed from the
|
|
1623
1806
|
* entire account.</p>
|
|
1624
1807
|
*/
|
|
1625
1808
|
DisassociateEntireAccount?: boolean;
|
|
1626
1809
|
/**
|
|
1810
|
+
* @public
|
|
1627
1811
|
* <p>The Amazon Resource Name (ARN) of the consumer that association for
|
|
1628
1812
|
* the datashare is removed from.</p>
|
|
1629
1813
|
*/
|
|
1630
1814
|
ConsumerArn?: string;
|
|
1631
1815
|
/**
|
|
1816
|
+
* @public
|
|
1632
1817
|
* <p>From a datashare consumer account, removes association of a datashare from all the existing and future namespaces in the specified Amazon Web Services Region.</p>
|
|
1633
1818
|
*/
|
|
1634
1819
|
ConsumerRegion?: string;
|
|
@@ -1639,12 +1824,14 @@ export interface DisassociateDataShareConsumerMessage {
|
|
|
1639
1824
|
*/
|
|
1640
1825
|
export interface EnableLoggingMessage {
|
|
1641
1826
|
/**
|
|
1827
|
+
* @public
|
|
1642
1828
|
* <p>The identifier of the cluster on which logging is to be started.</p>
|
|
1643
1829
|
* <p>Example: <code>examplecluster</code>
|
|
1644
1830
|
* </p>
|
|
1645
1831
|
*/
|
|
1646
1832
|
ClusterIdentifier: string | undefined;
|
|
1647
1833
|
/**
|
|
1834
|
+
* @public
|
|
1648
1835
|
* <p>The name of an existing S3 bucket where the log files are to be stored.</p>
|
|
1649
1836
|
* <p>Constraints:</p>
|
|
1650
1837
|
* <ul>
|
|
@@ -1658,6 +1845,7 @@ export interface EnableLoggingMessage {
|
|
|
1658
1845
|
*/
|
|
1659
1846
|
BucketName?: string;
|
|
1660
1847
|
/**
|
|
1848
|
+
* @public
|
|
1661
1849
|
* <p>The prefix applied to the log file names.</p>
|
|
1662
1850
|
* <p>Constraints:</p>
|
|
1663
1851
|
* <ul>
|
|
@@ -1689,10 +1877,12 @@ export interface EnableLoggingMessage {
|
|
|
1689
1877
|
*/
|
|
1690
1878
|
S3KeyPrefix?: string;
|
|
1691
1879
|
/**
|
|
1880
|
+
* @public
|
|
1692
1881
|
* <p>The log destination type. An enum with possible values of <code>s3</code> and <code>cloudwatch</code>.</p>
|
|
1693
1882
|
*/
|
|
1694
1883
|
LogDestinationType?: LogDestinationType | string;
|
|
1695
1884
|
/**
|
|
1885
|
+
* @public
|
|
1696
1886
|
* <p>The collection of exported log types. Possible values are <code>connectionlog</code>, <code>useractivitylog</code>, and <code>userlog</code>.</p>
|
|
1697
1887
|
*/
|
|
1698
1888
|
LogExports?: string[];
|
|
@@ -1744,12 +1934,14 @@ export declare class InvalidS3KeyPrefixFault extends __BaseException {
|
|
|
1744
1934
|
*/
|
|
1745
1935
|
export interface EnableSnapshotCopyMessage {
|
|
1746
1936
|
/**
|
|
1937
|
+
* @public
|
|
1747
1938
|
* <p>The unique identifier of the source cluster to copy snapshots from.</p>
|
|
1748
1939
|
* <p>Constraints: Must be the valid name of an existing cluster that does not already
|
|
1749
1940
|
* have cross-region snapshot copy enabled.</p>
|
|
1750
1941
|
*/
|
|
1751
1942
|
ClusterIdentifier: string | undefined;
|
|
1752
1943
|
/**
|
|
1944
|
+
* @public
|
|
1753
1945
|
* <p>The destination Amazon Web Services Region that you want to copy snapshots to.</p>
|
|
1754
1946
|
* <p>Constraints: Must be the name of a valid Amazon Web Services Region. For more information, see
|
|
1755
1947
|
* <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#redshift_region">Regions and Endpoints</a> in the Amazon Web Services General Reference.
|
|
@@ -1757,6 +1949,7 @@ export interface EnableSnapshotCopyMessage {
|
|
|
1757
1949
|
*/
|
|
1758
1950
|
DestinationRegion: string | undefined;
|
|
1759
1951
|
/**
|
|
1952
|
+
* @public
|
|
1760
1953
|
* <p>The number of days to retain automated snapshots in the destination region after
|
|
1761
1954
|
* they are copied from the source region.</p>
|
|
1762
1955
|
* <p>Default: 7.</p>
|
|
@@ -1764,11 +1957,13 @@ export interface EnableSnapshotCopyMessage {
|
|
|
1764
1957
|
*/
|
|
1765
1958
|
RetentionPeriod?: number;
|
|
1766
1959
|
/**
|
|
1960
|
+
* @public
|
|
1767
1961
|
* <p>The name of the snapshot copy grant to use when snapshots of an Amazon Web Services KMS-encrypted
|
|
1768
1962
|
* cluster are copied to the destination region.</p>
|
|
1769
1963
|
*/
|
|
1770
1964
|
SnapshotCopyGrantName?: string;
|
|
1771
1965
|
/**
|
|
1966
|
+
* @public
|
|
1772
1967
|
* <p>The number of days to retain newly copied snapshots in the destination Amazon Web Services Region
|
|
1773
1968
|
* after they are copied from the source Amazon Web Services Region. If the value is -1, the manual
|
|
1774
1969
|
* snapshot is retained indefinitely. </p>
|
|
@@ -1781,6 +1976,7 @@ export interface EnableSnapshotCopyMessage {
|
|
|
1781
1976
|
*/
|
|
1782
1977
|
export interface EnableSnapshotCopyResult {
|
|
1783
1978
|
/**
|
|
1979
|
+
* @public
|
|
1784
1980
|
* <p>Describes a cluster.</p>
|
|
1785
1981
|
*/
|
|
1786
1982
|
Cluster?: Cluster;
|
|
@@ -1839,6 +2035,7 @@ export declare class EndpointAuthorizationNotFoundFault extends __BaseException
|
|
|
1839
2035
|
*/
|
|
1840
2036
|
export interface GetClusterCredentialsMessage {
|
|
1841
2037
|
/**
|
|
2038
|
+
* @public
|
|
1842
2039
|
* <p>The name of a database user. If a user name matching <code>DbUser</code> exists in
|
|
1843
2040
|
* the database, the temporary user credentials have the same permissions as the existing
|
|
1844
2041
|
* user. If <code>DbUser</code> doesn't exist in the database and <code>Autocreate</code>
|
|
@@ -1873,6 +2070,7 @@ export interface GetClusterCredentialsMessage {
|
|
|
1873
2070
|
*/
|
|
1874
2071
|
DbUser: string | undefined;
|
|
1875
2072
|
/**
|
|
2073
|
+
* @public
|
|
1876
2074
|
* <p>The name of a database that <code>DbUser</code> is authorized to log on to. If
|
|
1877
2075
|
* <code>DbName</code> is not specified, <code>DbUser</code> can log on to any existing
|
|
1878
2076
|
* database.</p>
|
|
@@ -1899,22 +2097,26 @@ export interface GetClusterCredentialsMessage {
|
|
|
1899
2097
|
*/
|
|
1900
2098
|
DbName?: string;
|
|
1901
2099
|
/**
|
|
2100
|
+
* @public
|
|
1902
2101
|
* <p>The unique identifier of the cluster that contains the database for which you are
|
|
1903
2102
|
* requesting credentials. This parameter is case sensitive.</p>
|
|
1904
2103
|
*/
|
|
1905
2104
|
ClusterIdentifier?: string;
|
|
1906
2105
|
/**
|
|
2106
|
+
* @public
|
|
1907
2107
|
* <p>The number of seconds until the returned temporary password expires.</p>
|
|
1908
2108
|
* <p>Constraint: minimum 900, maximum 3600.</p>
|
|
1909
2109
|
* <p>Default: 900</p>
|
|
1910
2110
|
*/
|
|
1911
2111
|
DurationSeconds?: number;
|
|
1912
2112
|
/**
|
|
2113
|
+
* @public
|
|
1913
2114
|
* <p>Create a database user with the name specified for the user named in
|
|
1914
2115
|
* <code>DbUser</code> if one does not exist.</p>
|
|
1915
2116
|
*/
|
|
1916
2117
|
AutoCreate?: boolean;
|
|
1917
2118
|
/**
|
|
2119
|
+
* @public
|
|
1918
2120
|
* <p>A list of the names of existing database groups that the user named in
|
|
1919
2121
|
* <code>DbUser</code> will join for the current session, in addition to any group
|
|
1920
2122
|
* memberships for an existing user. If not specified, a new user is added only to
|
|
@@ -1942,6 +2144,7 @@ export interface GetClusterCredentialsMessage {
|
|
|
1942
2144
|
*/
|
|
1943
2145
|
DbGroups?: string[];
|
|
1944
2146
|
/**
|
|
2147
|
+
* @public
|
|
1945
2148
|
* <p>The custom domain name for the cluster credentials.</p>
|
|
1946
2149
|
*/
|
|
1947
2150
|
CustomDomainName?: string;
|
|
@@ -1951,22 +2154,26 @@ export interface GetClusterCredentialsMessage {
|
|
|
1951
2154
|
*/
|
|
1952
2155
|
export interface GetClusterCredentialsWithIAMMessage {
|
|
1953
2156
|
/**
|
|
2157
|
+
* @public
|
|
1954
2158
|
* <p>The name of the database for which you are requesting credentials.
|
|
1955
2159
|
* If the database name is specified, the IAM policy must allow access to the resource <code>dbname</code> for the specified database name.
|
|
1956
2160
|
* If the database name is not specified, access to all databases is allowed.</p>
|
|
1957
2161
|
*/
|
|
1958
2162
|
DbName?: string;
|
|
1959
2163
|
/**
|
|
2164
|
+
* @public
|
|
1960
2165
|
* <p>The unique identifier of the cluster that contains the database for which you are
|
|
1961
2166
|
* requesting credentials. </p>
|
|
1962
2167
|
*/
|
|
1963
2168
|
ClusterIdentifier?: string;
|
|
1964
2169
|
/**
|
|
2170
|
+
* @public
|
|
1965
2171
|
* <p>The number of seconds until the returned temporary password expires.</p>
|
|
1966
2172
|
* <p>Range: 900-3600. Default: 900.</p>
|
|
1967
2173
|
*/
|
|
1968
2174
|
DurationSeconds?: number;
|
|
1969
2175
|
/**
|
|
2176
|
+
* @public
|
|
1970
2177
|
* <p>The custom domain name for the IAM message cluster credentials.</p>
|
|
1971
2178
|
*/
|
|
1972
2179
|
CustomDomainName?: string;
|
|
@@ -1988,18 +2195,22 @@ export type ReservedNodeExchangeActionType = (typeof ReservedNodeExchangeActionT
|
|
|
1988
2195
|
*/
|
|
1989
2196
|
export interface GetReservedNodeExchangeConfigurationOptionsInputMessage {
|
|
1990
2197
|
/**
|
|
2198
|
+
* @public
|
|
1991
2199
|
* <p>The action type of the reserved-node configuration. The action type can be an exchange initiated from either a snapshot or a resize.</p>
|
|
1992
2200
|
*/
|
|
1993
2201
|
ActionType: ReservedNodeExchangeActionType | string | undefined;
|
|
1994
2202
|
/**
|
|
2203
|
+
* @public
|
|
1995
2204
|
* <p>The identifier for the cluster that is the source for a reserved-node exchange.</p>
|
|
1996
2205
|
*/
|
|
1997
2206
|
ClusterIdentifier?: string;
|
|
1998
2207
|
/**
|
|
2208
|
+
* @public
|
|
1999
2209
|
* <p>The identifier for the snapshot that is the source for the reserved-node exchange.</p>
|
|
2000
2210
|
*/
|
|
2001
2211
|
SnapshotIdentifier?: string;
|
|
2002
2212
|
/**
|
|
2213
|
+
* @public
|
|
2003
2214
|
* <p>The maximum number of response records to return in each call. If the number of
|
|
2004
2215
|
* remaining response records exceeds the specified <code>MaxRecords</code> value, a value
|
|
2005
2216
|
* is returned in a <code>Marker</code> field of the response. You can retrieve the next
|
|
@@ -2007,6 +2218,7 @@ export interface GetReservedNodeExchangeConfigurationOptionsInputMessage {
|
|
|
2007
2218
|
*/
|
|
2008
2219
|
MaxRecords?: number;
|
|
2009
2220
|
/**
|
|
2221
|
+
* @public
|
|
2010
2222
|
* <p>An optional pagination token provided by a previous <code>GetReservedNodeExchangeConfigurationOptions</code> request. If this
|
|
2011
2223
|
* parameter is specified, the response includes only records beyond the marker, up to the value
|
|
2012
2224
|
* specified by the <code>MaxRecords</code> parameter. You can retrieve the next set of response
|
|
@@ -2022,15 +2234,18 @@ export interface GetReservedNodeExchangeConfigurationOptionsInputMessage {
|
|
|
2022
2234
|
*/
|
|
2023
2235
|
export interface ReservedNodeConfigurationOption {
|
|
2024
2236
|
/**
|
|
2237
|
+
* @public
|
|
2025
2238
|
* <p>Describes a reserved node. You can call the <a>DescribeReservedNodeOfferings</a> API to obtain the available reserved node
|
|
2026
2239
|
* offerings. </p>
|
|
2027
2240
|
*/
|
|
2028
2241
|
SourceReservedNode?: ReservedNode;
|
|
2029
2242
|
/**
|
|
2243
|
+
* @public
|
|
2030
2244
|
* <p>The target reserved-node count.</p>
|
|
2031
2245
|
*/
|
|
2032
2246
|
TargetReservedNodeCount?: number;
|
|
2033
2247
|
/**
|
|
2248
|
+
* @public
|
|
2034
2249
|
* <p>Describes a reserved node offering.</p>
|
|
2035
2250
|
*/
|
|
2036
2251
|
TargetReservedNodeOffering?: ReservedNodeOffering;
|
|
@@ -2040,10 +2255,12 @@ export interface ReservedNodeConfigurationOption {
|
|
|
2040
2255
|
*/
|
|
2041
2256
|
export interface GetReservedNodeExchangeConfigurationOptionsOutputMessage {
|
|
2042
2257
|
/**
|
|
2258
|
+
* @public
|
|
2043
2259
|
* <p>A pagination token provided by a previous <code>GetReservedNodeExchangeConfigurationOptions</code> request.</p>
|
|
2044
2260
|
*/
|
|
2045
2261
|
Marker?: string;
|
|
2046
2262
|
/**
|
|
2263
|
+
* @public
|
|
2047
2264
|
* <p>the configuration options for the reserved-node
|
|
2048
2265
|
* exchange. These options include information about the source reserved node and target reserved
|
|
2049
2266
|
* node. Details include the node type, the price, the node count, and the offering
|
|
@@ -2057,16 +2274,19 @@ export interface GetReservedNodeExchangeConfigurationOptionsOutputMessage {
|
|
|
2057
2274
|
*/
|
|
2058
2275
|
export interface GetReservedNodeExchangeOfferingsInputMessage {
|
|
2059
2276
|
/**
|
|
2277
|
+
* @public
|
|
2060
2278
|
* <p>A string representing the node identifier for the DC1 Reserved Node to be
|
|
2061
2279
|
* exchanged.</p>
|
|
2062
2280
|
*/
|
|
2063
2281
|
ReservedNodeId: string | undefined;
|
|
2064
2282
|
/**
|
|
2283
|
+
* @public
|
|
2065
2284
|
* <p>An integer setting the maximum number of ReservedNodeOfferings to
|
|
2066
2285
|
* retrieve.</p>
|
|
2067
2286
|
*/
|
|
2068
2287
|
MaxRecords?: number;
|
|
2069
2288
|
/**
|
|
2289
|
+
* @public
|
|
2070
2290
|
* <p>A value that indicates the starting point for the next set of
|
|
2071
2291
|
* ReservedNodeOfferings.</p>
|
|
2072
2292
|
*/
|
|
@@ -2077,6 +2297,7 @@ export interface GetReservedNodeExchangeOfferingsInputMessage {
|
|
|
2077
2297
|
*/
|
|
2078
2298
|
export interface GetReservedNodeExchangeOfferingsOutputMessage {
|
|
2079
2299
|
/**
|
|
2300
|
+
* @public
|
|
2080
2301
|
* <p>An optional parameter that specifies the starting point for returning a set of
|
|
2081
2302
|
* response records. When the results of a <code>GetReservedNodeExchangeOfferings</code>
|
|
2082
2303
|
* request exceed the value specified in MaxRecords, Amazon Redshift returns a value in the
|
|
@@ -2086,6 +2307,7 @@ export interface GetReservedNodeExchangeOfferingsOutputMessage {
|
|
|
2086
2307
|
*/
|
|
2087
2308
|
Marker?: string;
|
|
2088
2309
|
/**
|
|
2310
|
+
* @public
|
|
2089
2311
|
* <p>Returns an array of <a>ReservedNodeOffering</a> objects.</p>
|
|
2090
2312
|
*/
|
|
2091
2313
|
ReservedNodeOfferings?: ReservedNodeOffering[];
|
|
@@ -2134,10 +2356,12 @@ export declare class InvalidTableRestoreArgumentFault extends __BaseException {
|
|
|
2134
2356
|
*/
|
|
2135
2357
|
export interface ModifyAquaInputMessage {
|
|
2136
2358
|
/**
|
|
2359
|
+
* @public
|
|
2137
2360
|
* <p>The identifier of the cluster to be modified.</p>
|
|
2138
2361
|
*/
|
|
2139
2362
|
ClusterIdentifier: string | undefined;
|
|
2140
2363
|
/**
|
|
2364
|
+
* @public
|
|
2141
2365
|
* <p>This parameter is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).</p>
|
|
2142
2366
|
*/
|
|
2143
2367
|
AquaConfigurationStatus?: AquaConfigurationStatus | string;
|
|
@@ -2147,6 +2371,7 @@ export interface ModifyAquaInputMessage {
|
|
|
2147
2371
|
*/
|
|
2148
2372
|
export interface ModifyAquaOutputMessage {
|
|
2149
2373
|
/**
|
|
2374
|
+
* @public
|
|
2150
2375
|
* <p>This parameter is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator). </p>
|
|
2151
2376
|
*/
|
|
2152
2377
|
AquaConfiguration?: AquaConfiguration;
|
|
@@ -2156,10 +2381,12 @@ export interface ModifyAquaOutputMessage {
|
|
|
2156
2381
|
*/
|
|
2157
2382
|
export interface ModifyAuthenticationProfileMessage {
|
|
2158
2383
|
/**
|
|
2384
|
+
* @public
|
|
2159
2385
|
* <p>The name of the authentication profile to replace.</p>
|
|
2160
2386
|
*/
|
|
2161
2387
|
AuthenticationProfileName: string | undefined;
|
|
2162
2388
|
/**
|
|
2389
|
+
* @public
|
|
2163
2390
|
* <p>The new content of the authentication profile in JSON format.
|
|
2164
2391
|
* The maximum length of the JSON string is determined by a quota for your account.</p>
|
|
2165
2392
|
*/
|
|
@@ -2170,10 +2397,12 @@ export interface ModifyAuthenticationProfileMessage {
|
|
|
2170
2397
|
*/
|
|
2171
2398
|
export interface ModifyAuthenticationProfileResult {
|
|
2172
2399
|
/**
|
|
2400
|
+
* @public
|
|
2173
2401
|
* <p>The name of the authentication profile that was replaced.</p>
|
|
2174
2402
|
*/
|
|
2175
2403
|
AuthenticationProfileName?: string;
|
|
2176
2404
|
/**
|
|
2405
|
+
* @public
|
|
2177
2406
|
* <p>The updated content of the authentication profile in JSON format.</p>
|
|
2178
2407
|
*/
|
|
2179
2408
|
AuthenticationProfileContent?: string;
|
|
@@ -2184,12 +2413,14 @@ export interface ModifyAuthenticationProfileResult {
|
|
|
2184
2413
|
*/
|
|
2185
2414
|
export interface ModifyClusterMessage {
|
|
2186
2415
|
/**
|
|
2416
|
+
* @public
|
|
2187
2417
|
* <p>The unique identifier of the cluster to be modified.</p>
|
|
2188
2418
|
* <p>Example: <code>examplecluster</code>
|
|
2189
2419
|
* </p>
|
|
2190
2420
|
*/
|
|
2191
2421
|
ClusterIdentifier: string | undefined;
|
|
2192
2422
|
/**
|
|
2423
|
+
* @public
|
|
2193
2424
|
* <p>The new cluster type.</p>
|
|
2194
2425
|
* <p>When you submit your cluster resize request, your existing cluster goes into a
|
|
2195
2426
|
* read-only mode. After Amazon Redshift provisions a new cluster based on your resize
|
|
@@ -2200,6 +2431,7 @@ export interface ModifyClusterMessage {
|
|
|
2200
2431
|
*/
|
|
2201
2432
|
ClusterType?: string;
|
|
2202
2433
|
/**
|
|
2434
|
+
* @public
|
|
2203
2435
|
* <p>The new node type of the cluster. If you specify a new node type, you must also
|
|
2204
2436
|
* specify the number of nodes parameter.</p>
|
|
2205
2437
|
* <p>
|
|
@@ -2214,6 +2446,7 @@ export interface ModifyClusterMessage {
|
|
|
2214
2446
|
*/
|
|
2215
2447
|
NodeType?: string;
|
|
2216
2448
|
/**
|
|
2449
|
+
* @public
|
|
2217
2450
|
* <p>The new number of nodes of the cluster. If you specify a new number of nodes, you
|
|
2218
2451
|
* must also specify the node type parameter.</p>
|
|
2219
2452
|
* <p>
|
|
@@ -2224,6 +2457,7 @@ export interface ModifyClusterMessage {
|
|
|
2224
2457
|
*/
|
|
2225
2458
|
NumberOfNodes?: number;
|
|
2226
2459
|
/**
|
|
2460
|
+
* @public
|
|
2227
2461
|
* <p>A list of cluster security groups to be authorized on this cluster. This change is
|
|
2228
2462
|
* asynchronously applied as soon as possible.</p>
|
|
2229
2463
|
* <p>Security groups currently associated with the cluster, and not in the list of
|
|
@@ -2243,11 +2477,13 @@ export interface ModifyClusterMessage {
|
|
|
2243
2477
|
*/
|
|
2244
2478
|
ClusterSecurityGroups?: string[];
|
|
2245
2479
|
/**
|
|
2480
|
+
* @public
|
|
2246
2481
|
* <p>A list of virtual private cloud (VPC) security groups to be associated with the
|
|
2247
2482
|
* cluster. This change is asynchronously applied as soon as possible.</p>
|
|
2248
2483
|
*/
|
|
2249
2484
|
VpcSecurityGroupIds?: string[];
|
|
2250
2485
|
/**
|
|
2486
|
+
* @public
|
|
2251
2487
|
* <p>The new password for the cluster admin user. This change is asynchronously applied
|
|
2252
2488
|
* as soon as possible. Between the time of the request and the completion of the request,
|
|
2253
2489
|
* the <code>MasterUserPassword</code> element exists in the
|
|
@@ -2280,6 +2516,7 @@ export interface ModifyClusterMessage {
|
|
|
2280
2516
|
*/
|
|
2281
2517
|
MasterUserPassword?: string;
|
|
2282
2518
|
/**
|
|
2519
|
+
* @public
|
|
2283
2520
|
* <p>The name of the cluster parameter group to apply to this cluster. This change is
|
|
2284
2521
|
* applied only after the cluster is rebooted. To reboot a cluster use <a>RebootCluster</a>. </p>
|
|
2285
2522
|
* <p>Default: Uses existing setting.</p>
|
|
@@ -2288,6 +2525,7 @@ export interface ModifyClusterMessage {
|
|
|
2288
2525
|
*/
|
|
2289
2526
|
ClusterParameterGroupName?: string;
|
|
2290
2527
|
/**
|
|
2528
|
+
* @public
|
|
2291
2529
|
* <p>The number of days that automated snapshots are retained. If the value is 0,
|
|
2292
2530
|
* automated snapshots are disabled. Even if automated snapshots are disabled, you can
|
|
2293
2531
|
* still create manual snapshots when you want with <a>CreateClusterSnapshot</a>. </p>
|
|
@@ -2300,6 +2538,7 @@ export interface ModifyClusterMessage {
|
|
|
2300
2538
|
*/
|
|
2301
2539
|
AutomatedSnapshotRetentionPeriod?: number;
|
|
2302
2540
|
/**
|
|
2541
|
+
* @public
|
|
2303
2542
|
* <p>The default for number of days that a newly created manual snapshot is retained. If
|
|
2304
2543
|
* the value is -1, the manual snapshot is retained indefinitely. This value doesn't
|
|
2305
2544
|
* retroactively change the retention periods of existing manual snapshots.</p>
|
|
@@ -2308,6 +2547,7 @@ export interface ModifyClusterMessage {
|
|
|
2308
2547
|
*/
|
|
2309
2548
|
ManualSnapshotRetentionPeriod?: number;
|
|
2310
2549
|
/**
|
|
2550
|
+
* @public
|
|
2311
2551
|
* <p>The weekly time range (in UTC) during which system maintenance can occur, if
|
|
2312
2552
|
* necessary. If system maintenance is necessary during the window, it may result in an
|
|
2313
2553
|
* outage.</p>
|
|
@@ -2322,6 +2562,7 @@ export interface ModifyClusterMessage {
|
|
|
2322
2562
|
*/
|
|
2323
2563
|
PreferredMaintenanceWindow?: string;
|
|
2324
2564
|
/**
|
|
2565
|
+
* @public
|
|
2325
2566
|
* <p>The new version number of the Amazon Redshift engine to upgrade to.</p>
|
|
2326
2567
|
* <p>For major version upgrades, if a non-default cluster parameter group is currently
|
|
2327
2568
|
* in use, a new cluster parameter group in the cluster parameter group family for the new
|
|
@@ -2335,6 +2576,7 @@ export interface ModifyClusterMessage {
|
|
|
2335
2576
|
*/
|
|
2336
2577
|
ClusterVersion?: string;
|
|
2337
2578
|
/**
|
|
2579
|
+
* @public
|
|
2338
2580
|
* <p>If <code>true</code>, major version upgrades will be applied automatically to the
|
|
2339
2581
|
* cluster during the maintenance window. </p>
|
|
2340
2582
|
* <p>Default: <code>false</code>
|
|
@@ -2342,16 +2584,19 @@ export interface ModifyClusterMessage {
|
|
|
2342
2584
|
*/
|
|
2343
2585
|
AllowVersionUpgrade?: boolean;
|
|
2344
2586
|
/**
|
|
2587
|
+
* @public
|
|
2345
2588
|
* <p>Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to
|
|
2346
2589
|
* retrieve the data encryption keys stored in an HSM.</p>
|
|
2347
2590
|
*/
|
|
2348
2591
|
HsmClientCertificateIdentifier?: string;
|
|
2349
2592
|
/**
|
|
2593
|
+
* @public
|
|
2350
2594
|
* <p>Specifies the name of the HSM configuration that contains the information the
|
|
2351
2595
|
* Amazon Redshift cluster can use to retrieve and store keys in an HSM.</p>
|
|
2352
2596
|
*/
|
|
2353
2597
|
HsmConfigurationIdentifier?: string;
|
|
2354
2598
|
/**
|
|
2599
|
+
* @public
|
|
2355
2600
|
* <p>The new identifier for the cluster.</p>
|
|
2356
2601
|
* <p>Constraints:</p>
|
|
2357
2602
|
* <ul>
|
|
@@ -2376,11 +2621,13 @@ export interface ModifyClusterMessage {
|
|
|
2376
2621
|
*/
|
|
2377
2622
|
NewClusterIdentifier?: string;
|
|
2378
2623
|
/**
|
|
2624
|
+
* @public
|
|
2379
2625
|
* <p>If <code>true</code>, the cluster can be accessed from a public network. Only
|
|
2380
2626
|
* clusters in VPCs can be set to be publicly available.</p>
|
|
2381
2627
|
*/
|
|
2382
2628
|
PubliclyAccessible?: boolean;
|
|
2383
2629
|
/**
|
|
2630
|
+
* @public
|
|
2384
2631
|
* <p>The Elastic IP (EIP) address for the cluster.</p>
|
|
2385
2632
|
* <p>Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible
|
|
2386
2633
|
* through an Internet gateway. For more information about provisioning clusters in
|
|
@@ -2389,6 +2636,7 @@ export interface ModifyClusterMessage {
|
|
|
2389
2636
|
*/
|
|
2390
2637
|
ElasticIp?: string;
|
|
2391
2638
|
/**
|
|
2639
|
+
* @public
|
|
2392
2640
|
* <p>An option that specifies whether to create the cluster with enhanced VPC routing
|
|
2393
2641
|
* enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a
|
|
2394
2642
|
* VPC. For more information, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html">Enhanced VPC Routing</a> in
|
|
@@ -2398,6 +2646,7 @@ export interface ModifyClusterMessage {
|
|
|
2398
2646
|
*/
|
|
2399
2647
|
EnhancedVpcRouting?: boolean;
|
|
2400
2648
|
/**
|
|
2649
|
+
* @public
|
|
2401
2650
|
* <p>The name for the maintenance track that you want to assign for the cluster. This name
|
|
2402
2651
|
* change is asynchronous. The new track name stays in the
|
|
2403
2652
|
* <code>PendingModifiedValues</code> for the cluster until the next maintenance
|
|
@@ -2407,6 +2656,7 @@ export interface ModifyClusterMessage {
|
|
|
2407
2656
|
*/
|
|
2408
2657
|
MaintenanceTrackName?: string;
|
|
2409
2658
|
/**
|
|
2659
|
+
* @public
|
|
2410
2660
|
* <p>Indicates whether the cluster is encrypted. If the value is encrypted (true) and you
|
|
2411
2661
|
* provide a value for the <code>KmsKeyId</code> parameter, we encrypt the cluster
|
|
2412
2662
|
* with the provided <code>KmsKeyId</code>. If you don't provide a <code>KmsKeyId</code>,
|
|
@@ -2415,19 +2665,23 @@ export interface ModifyClusterMessage {
|
|
|
2415
2665
|
*/
|
|
2416
2666
|
Encrypted?: boolean;
|
|
2417
2667
|
/**
|
|
2668
|
+
* @public
|
|
2418
2669
|
* <p>The Key Management Service (KMS) key ID of the encryption key that you want to use
|
|
2419
2670
|
* to encrypt data in the cluster.</p>
|
|
2420
2671
|
*/
|
|
2421
2672
|
KmsKeyId?: string;
|
|
2422
2673
|
/**
|
|
2674
|
+
* @public
|
|
2423
2675
|
* <p>The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete.</p>
|
|
2424
2676
|
*/
|
|
2425
2677
|
AvailabilityZoneRelocation?: boolean;
|
|
2426
2678
|
/**
|
|
2679
|
+
* @public
|
|
2427
2680
|
* <p>The option to initiate relocation for an Amazon Redshift cluster to the target Availability Zone.</p>
|
|
2428
2681
|
*/
|
|
2429
2682
|
AvailabilityZone?: string;
|
|
2430
2683
|
/**
|
|
2684
|
+
* @public
|
|
2431
2685
|
* <p>The option to change the port of an Amazon Redshift cluster.</p>
|
|
2432
2686
|
*/
|
|
2433
2687
|
Port?: number;
|
|
@@ -2437,6 +2691,7 @@ export interface ModifyClusterMessage {
|
|
|
2437
2691
|
*/
|
|
2438
2692
|
export interface ModifyClusterResult {
|
|
2439
2693
|
/**
|
|
2694
|
+
* @public
|
|
2440
2695
|
* <p>Describes a cluster.</p>
|
|
2441
2696
|
*/
|
|
2442
2697
|
Cluster?: Cluster;
|
|
@@ -2471,12 +2726,14 @@ export declare class UnsupportedOptionFault extends __BaseException {
|
|
|
2471
2726
|
*/
|
|
2472
2727
|
export interface ModifyClusterDbRevisionMessage {
|
|
2473
2728
|
/**
|
|
2729
|
+
* @public
|
|
2474
2730
|
* <p>The unique identifier of a cluster whose database revision you want to modify. </p>
|
|
2475
2731
|
* <p>Example: <code>examplecluster</code>
|
|
2476
2732
|
* </p>
|
|
2477
2733
|
*/
|
|
2478
2734
|
ClusterIdentifier: string | undefined;
|
|
2479
2735
|
/**
|
|
2736
|
+
* @public
|
|
2480
2737
|
* <p>The identifier of the database revision. You can retrieve this value from the
|
|
2481
2738
|
* response to the <a>DescribeClusterDbRevisions</a> request.</p>
|
|
2482
2739
|
*/
|
|
@@ -2487,6 +2744,7 @@ export interface ModifyClusterDbRevisionMessage {
|
|
|
2487
2744
|
*/
|
|
2488
2745
|
export interface ModifyClusterDbRevisionResult {
|
|
2489
2746
|
/**
|
|
2747
|
+
* @public
|
|
2490
2748
|
* <p>Describes a cluster.</p>
|
|
2491
2749
|
*/
|
|
2492
2750
|
Cluster?: Cluster;
|
|
@@ -2497,20 +2755,24 @@ export interface ModifyClusterDbRevisionResult {
|
|
|
2497
2755
|
*/
|
|
2498
2756
|
export interface ModifyClusterIamRolesMessage {
|
|
2499
2757
|
/**
|
|
2758
|
+
* @public
|
|
2500
2759
|
* <p>The unique identifier of the cluster for which you want to associate or
|
|
2501
2760
|
* disassociate IAM roles.</p>
|
|
2502
2761
|
*/
|
|
2503
2762
|
ClusterIdentifier: string | undefined;
|
|
2504
2763
|
/**
|
|
2764
|
+
* @public
|
|
2505
2765
|
* <p>Zero or more IAM roles to associate with the cluster. The roles must be in their
|
|
2506
2766
|
* Amazon Resource Name (ARN) format. </p>
|
|
2507
2767
|
*/
|
|
2508
2768
|
AddIamRoles?: string[];
|
|
2509
2769
|
/**
|
|
2770
|
+
* @public
|
|
2510
2771
|
* <p>Zero or more IAM roles in ARN format to disassociate from the cluster. </p>
|
|
2511
2772
|
*/
|
|
2512
2773
|
RemoveIamRoles?: string[];
|
|
2513
2774
|
/**
|
|
2775
|
+
* @public
|
|
2514
2776
|
* <p>The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was last modified.</p>
|
|
2515
2777
|
*/
|
|
2516
2778
|
DefaultIamRoleArn?: string;
|
|
@@ -2520,6 +2782,7 @@ export interface ModifyClusterIamRolesMessage {
|
|
|
2520
2782
|
*/
|
|
2521
2783
|
export interface ModifyClusterIamRolesResult {
|
|
2522
2784
|
/**
|
|
2785
|
+
* @public
|
|
2523
2786
|
* <p>Describes a cluster.</p>
|
|
2524
2787
|
*/
|
|
2525
2788
|
Cluster?: Cluster;
|
|
@@ -2529,27 +2792,33 @@ export interface ModifyClusterIamRolesResult {
|
|
|
2529
2792
|
*/
|
|
2530
2793
|
export interface ModifyClusterMaintenanceMessage {
|
|
2531
2794
|
/**
|
|
2795
|
+
* @public
|
|
2532
2796
|
* <p>A unique identifier for the cluster.</p>
|
|
2533
2797
|
*/
|
|
2534
2798
|
ClusterIdentifier: string | undefined;
|
|
2535
2799
|
/**
|
|
2800
|
+
* @public
|
|
2536
2801
|
* <p>A boolean indicating whether to enable the deferred maintenance window. </p>
|
|
2537
2802
|
*/
|
|
2538
2803
|
DeferMaintenance?: boolean;
|
|
2539
2804
|
/**
|
|
2805
|
+
* @public
|
|
2540
2806
|
* <p>A unique identifier for the deferred maintenance window.</p>
|
|
2541
2807
|
*/
|
|
2542
2808
|
DeferMaintenanceIdentifier?: string;
|
|
2543
2809
|
/**
|
|
2810
|
+
* @public
|
|
2544
2811
|
* <p>A timestamp indicating the start time for the deferred maintenance window.</p>
|
|
2545
2812
|
*/
|
|
2546
2813
|
DeferMaintenanceStartTime?: Date;
|
|
2547
2814
|
/**
|
|
2815
|
+
* @public
|
|
2548
2816
|
* <p>A timestamp indicating end time for the deferred maintenance window. If you specify an
|
|
2549
2817
|
* end time, you can't specify a duration.</p>
|
|
2550
2818
|
*/
|
|
2551
2819
|
DeferMaintenanceEndTime?: Date;
|
|
2552
2820
|
/**
|
|
2821
|
+
* @public
|
|
2553
2822
|
* <p>An integer indicating the duration of the maintenance window in days. If you specify a
|
|
2554
2823
|
* duration, you can't specify an end time. The duration must be 45 days or less.</p>
|
|
2555
2824
|
*/
|
|
@@ -2560,6 +2829,7 @@ export interface ModifyClusterMaintenanceMessage {
|
|
|
2560
2829
|
*/
|
|
2561
2830
|
export interface ModifyClusterMaintenanceResult {
|
|
2562
2831
|
/**
|
|
2832
|
+
* @public
|
|
2563
2833
|
* <p>Describes a cluster.</p>
|
|
2564
2834
|
*/
|
|
2565
2835
|
Cluster?: Cluster;
|
|
@@ -2570,10 +2840,12 @@ export interface ModifyClusterMaintenanceResult {
|
|
|
2570
2840
|
*/
|
|
2571
2841
|
export interface ModifyClusterParameterGroupMessage {
|
|
2572
2842
|
/**
|
|
2843
|
+
* @public
|
|
2573
2844
|
* <p>The name of the parameter group to be modified.</p>
|
|
2574
2845
|
*/
|
|
2575
2846
|
ParameterGroupName: string | undefined;
|
|
2576
2847
|
/**
|
|
2848
|
+
* @public
|
|
2577
2849
|
* <p>An array of parameters to be modified. A maximum of 20 parameters can be modified
|
|
2578
2850
|
* in a single request.</p>
|
|
2579
2851
|
* <p>For each parameter to be modified, you must supply at least the parameter name and
|
|
@@ -2588,10 +2860,12 @@ export interface ModifyClusterParameterGroupMessage {
|
|
|
2588
2860
|
*/
|
|
2589
2861
|
export interface ModifyClusterSnapshotMessage {
|
|
2590
2862
|
/**
|
|
2863
|
+
* @public
|
|
2591
2864
|
* <p>The identifier of the snapshot whose setting you want to modify.</p>
|
|
2592
2865
|
*/
|
|
2593
2866
|
SnapshotIdentifier: string | undefined;
|
|
2594
2867
|
/**
|
|
2868
|
+
* @public
|
|
2595
2869
|
* <p>The number of days that a manual snapshot is retained. If the value is -1, the manual
|
|
2596
2870
|
* snapshot is retained indefinitely.</p>
|
|
2597
2871
|
* <p>If the manual snapshot falls outside of the new retention period, you can specify the
|
|
@@ -2600,6 +2874,7 @@ export interface ModifyClusterSnapshotMessage {
|
|
|
2600
2874
|
*/
|
|
2601
2875
|
ManualSnapshotRetentionPeriod?: number;
|
|
2602
2876
|
/**
|
|
2877
|
+
* @public
|
|
2603
2878
|
* <p>A Boolean option to override an exception if the retention period has already
|
|
2604
2879
|
* passed.</p>
|
|
2605
2880
|
*/
|
|
@@ -2610,6 +2885,7 @@ export interface ModifyClusterSnapshotMessage {
|
|
|
2610
2885
|
*/
|
|
2611
2886
|
export interface ModifyClusterSnapshotResult {
|
|
2612
2887
|
/**
|
|
2888
|
+
* @public
|
|
2613
2889
|
* <p>Describes a snapshot.</p>
|
|
2614
2890
|
*/
|
|
2615
2891
|
Snapshot?: Snapshot;
|
|
@@ -2619,16 +2895,19 @@ export interface ModifyClusterSnapshotResult {
|
|
|
2619
2895
|
*/
|
|
2620
2896
|
export interface ModifyClusterSnapshotScheduleMessage {
|
|
2621
2897
|
/**
|
|
2898
|
+
* @public
|
|
2622
2899
|
* <p>A unique identifier for the cluster whose snapshot schedule you want to modify.
|
|
2623
2900
|
* </p>
|
|
2624
2901
|
*/
|
|
2625
2902
|
ClusterIdentifier: string | undefined;
|
|
2626
2903
|
/**
|
|
2904
|
+
* @public
|
|
2627
2905
|
* <p>A unique alphanumeric identifier for the schedule that you want to associate with the
|
|
2628
2906
|
* cluster.</p>
|
|
2629
2907
|
*/
|
|
2630
2908
|
ScheduleIdentifier?: string;
|
|
2631
2909
|
/**
|
|
2910
|
+
* @public
|
|
2632
2911
|
* <p>A boolean to indicate whether to remove the assoiciation between the cluster and the
|
|
2633
2912
|
* schedule.</p>
|
|
2634
2913
|
*/
|
|
@@ -2640,14 +2919,17 @@ export interface ModifyClusterSnapshotScheduleMessage {
|
|
|
2640
2919
|
*/
|
|
2641
2920
|
export interface ModifyClusterSubnetGroupMessage {
|
|
2642
2921
|
/**
|
|
2922
|
+
* @public
|
|
2643
2923
|
* <p>The name of the subnet group to be modified.</p>
|
|
2644
2924
|
*/
|
|
2645
2925
|
ClusterSubnetGroupName: string | undefined;
|
|
2646
2926
|
/**
|
|
2927
|
+
* @public
|
|
2647
2928
|
* <p>A text description of the subnet group to be modified.</p>
|
|
2648
2929
|
*/
|
|
2649
2930
|
Description?: string;
|
|
2650
2931
|
/**
|
|
2932
|
+
* @public
|
|
2651
2933
|
* <p>An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single
|
|
2652
2934
|
* request.</p>
|
|
2653
2935
|
*/
|
|
@@ -2658,6 +2940,7 @@ export interface ModifyClusterSubnetGroupMessage {
|
|
|
2658
2940
|
*/
|
|
2659
2941
|
export interface ModifyClusterSubnetGroupResult {
|
|
2660
2942
|
/**
|
|
2943
|
+
* @public
|
|
2661
2944
|
* <p>Describes a subnet group.</p>
|
|
2662
2945
|
*/
|
|
2663
2946
|
ClusterSubnetGroup?: ClusterSubnetGroup;
|
|
@@ -2679,14 +2962,17 @@ export declare class SubnetAlreadyInUse extends __BaseException {
|
|
|
2679
2962
|
*/
|
|
2680
2963
|
export interface ModifyCustomDomainAssociationMessage {
|
|
2681
2964
|
/**
|
|
2965
|
+
* @public
|
|
2682
2966
|
* <p>The custom domain name for a changed custom domain association.</p>
|
|
2683
2967
|
*/
|
|
2684
2968
|
CustomDomainName?: string;
|
|
2685
2969
|
/**
|
|
2970
|
+
* @public
|
|
2686
2971
|
* <p>The certificate Amazon Resource Name (ARN) for the changed custom domain association.</p>
|
|
2687
2972
|
*/
|
|
2688
2973
|
CustomDomainCertificateArn?: string;
|
|
2689
2974
|
/**
|
|
2975
|
+
* @public
|
|
2690
2976
|
* <p>The identifier of the cluster to change a custom domain association for.</p>
|
|
2691
2977
|
*/
|
|
2692
2978
|
ClusterIdentifier: string | undefined;
|
|
@@ -2696,18 +2982,22 @@ export interface ModifyCustomDomainAssociationMessage {
|
|
|
2696
2982
|
*/
|
|
2697
2983
|
export interface ModifyCustomDomainAssociationResult {
|
|
2698
2984
|
/**
|
|
2985
|
+
* @public
|
|
2699
2986
|
* <p>The custom domain name associated with the result for the changed custom domain association.</p>
|
|
2700
2987
|
*/
|
|
2701
2988
|
CustomDomainName?: string;
|
|
2702
2989
|
/**
|
|
2990
|
+
* @public
|
|
2703
2991
|
* <p>The certificate Amazon Resource Name (ARN) associated with the result for the changed custom domain association.</p>
|
|
2704
2992
|
*/
|
|
2705
2993
|
CustomDomainCertificateArn?: string;
|
|
2706
2994
|
/**
|
|
2995
|
+
* @public
|
|
2707
2996
|
* <p>The identifier of the cluster associated with the result for the changed custom domain association.</p>
|
|
2708
2997
|
*/
|
|
2709
2998
|
ClusterIdentifier?: string;
|
|
2710
2999
|
/**
|
|
3000
|
+
* @public
|
|
2711
3001
|
* <p>The certificate expiration time associated with the result for the changed custom domain association.</p>
|
|
2712
3002
|
*/
|
|
2713
3003
|
CustomDomainCertExpiryTime?: string;
|
|
@@ -2717,10 +3007,12 @@ export interface ModifyCustomDomainAssociationResult {
|
|
|
2717
3007
|
*/
|
|
2718
3008
|
export interface ModifyEndpointAccessMessage {
|
|
2719
3009
|
/**
|
|
3010
|
+
* @public
|
|
2720
3011
|
* <p>The endpoint to be modified.</p>
|
|
2721
3012
|
*/
|
|
2722
3013
|
EndpointName: string | undefined;
|
|
2723
3014
|
/**
|
|
3015
|
+
* @public
|
|
2724
3016
|
* <p>The complete list of VPC security groups associated with the endpoint after the endpoint is modified.</p>
|
|
2725
3017
|
*/
|
|
2726
3018
|
VpcSecurityGroupIds?: string[];
|
|
@@ -2731,15 +3023,18 @@ export interface ModifyEndpointAccessMessage {
|
|
|
2731
3023
|
*/
|
|
2732
3024
|
export interface ModifyEventSubscriptionMessage {
|
|
2733
3025
|
/**
|
|
3026
|
+
* @public
|
|
2734
3027
|
* <p>The name of the modified Amazon Redshift event notification subscription.</p>
|
|
2735
3028
|
*/
|
|
2736
3029
|
SubscriptionName: string | undefined;
|
|
2737
3030
|
/**
|
|
3031
|
+
* @public
|
|
2738
3032
|
* <p>The Amazon Resource Name (ARN) of the SNS topic to be used by the event
|
|
2739
3033
|
* notification subscription.</p>
|
|
2740
3034
|
*/
|
|
2741
3035
|
SnsTopicArn?: string;
|
|
2742
3036
|
/**
|
|
3037
|
+
* @public
|
|
2743
3038
|
* <p>The type of source that will be generating the events. For example, if you want to
|
|
2744
3039
|
* be notified of events generated by a cluster, you would set this parameter to cluster.
|
|
2745
3040
|
* If this value is not specified, events are returned for all Amazon Redshift objects in your
|
|
@@ -2748,6 +3043,7 @@ export interface ModifyEventSubscriptionMessage {
|
|
|
2748
3043
|
*/
|
|
2749
3044
|
SourceType?: string;
|
|
2750
3045
|
/**
|
|
3046
|
+
* @public
|
|
2751
3047
|
* <p>A list of one or more identifiers of Amazon Redshift source objects. All of the objects
|
|
2752
3048
|
* must be of the same type as was specified in the source type parameter. The event
|
|
2753
3049
|
* subscription will return only events generated by the specified objects. If not
|
|
@@ -2758,18 +3054,21 @@ export interface ModifyEventSubscriptionMessage {
|
|
|
2758
3054
|
*/
|
|
2759
3055
|
SourceIds?: string[];
|
|
2760
3056
|
/**
|
|
3057
|
+
* @public
|
|
2761
3058
|
* <p>Specifies the Amazon Redshift event categories to be published by the event notification
|
|
2762
3059
|
* subscription.</p>
|
|
2763
3060
|
* <p>Values: configuration, management, monitoring, security, pending</p>
|
|
2764
3061
|
*/
|
|
2765
3062
|
EventCategories?: string[];
|
|
2766
3063
|
/**
|
|
3064
|
+
* @public
|
|
2767
3065
|
* <p>Specifies the Amazon Redshift event severity to be published by the event notification
|
|
2768
3066
|
* subscription.</p>
|
|
2769
3067
|
* <p>Values: ERROR, INFO</p>
|
|
2770
3068
|
*/
|
|
2771
3069
|
Severity?: string;
|
|
2772
3070
|
/**
|
|
3071
|
+
* @public
|
|
2773
3072
|
* <p>A Boolean value indicating if the subscription is enabled. <code>true</code>
|
|
2774
3073
|
* indicates the subscription is enabled </p>
|
|
2775
3074
|
*/
|
|
@@ -2780,6 +3079,7 @@ export interface ModifyEventSubscriptionMessage {
|
|
|
2780
3079
|
*/
|
|
2781
3080
|
export interface ModifyEventSubscriptionResult {
|
|
2782
3081
|
/**
|
|
3082
|
+
* @public
|
|
2783
3083
|
* <p>Describes event subscriptions.</p>
|
|
2784
3084
|
*/
|
|
2785
3085
|
EventSubscription?: EventSubscription;
|
|
@@ -2789,39 +3089,47 @@ export interface ModifyEventSubscriptionResult {
|
|
|
2789
3089
|
*/
|
|
2790
3090
|
export interface ModifyScheduledActionMessage {
|
|
2791
3091
|
/**
|
|
3092
|
+
* @public
|
|
2792
3093
|
* <p>The name of the scheduled action to modify. </p>
|
|
2793
3094
|
*/
|
|
2794
3095
|
ScheduledActionName: string | undefined;
|
|
2795
3096
|
/**
|
|
3097
|
+
* @public
|
|
2796
3098
|
* <p>A modified JSON format of the scheduled action.
|
|
2797
3099
|
* For more information about this parameter, see <a>ScheduledAction</a>. </p>
|
|
2798
3100
|
*/
|
|
2799
3101
|
TargetAction?: ScheduledActionType;
|
|
2800
3102
|
/**
|
|
3103
|
+
* @public
|
|
2801
3104
|
* <p>A modified schedule in either <code>at( )</code> or <code>cron( )</code> format.
|
|
2802
3105
|
* For more information about this parameter, see <a>ScheduledAction</a>.</p>
|
|
2803
3106
|
*/
|
|
2804
3107
|
Schedule?: string;
|
|
2805
3108
|
/**
|
|
3109
|
+
* @public
|
|
2806
3110
|
* <p>A different IAM role to assume to run the target action.
|
|
2807
3111
|
* For more information about this parameter, see <a>ScheduledAction</a>.</p>
|
|
2808
3112
|
*/
|
|
2809
3113
|
IamRole?: string;
|
|
2810
3114
|
/**
|
|
3115
|
+
* @public
|
|
2811
3116
|
* <p>A modified description of the scheduled action. </p>
|
|
2812
3117
|
*/
|
|
2813
3118
|
ScheduledActionDescription?: string;
|
|
2814
3119
|
/**
|
|
3120
|
+
* @public
|
|
2815
3121
|
* <p>A modified start time of the scheduled action.
|
|
2816
3122
|
* For more information about this parameter, see <a>ScheduledAction</a>. </p>
|
|
2817
3123
|
*/
|
|
2818
3124
|
StartTime?: Date;
|
|
2819
3125
|
/**
|
|
3126
|
+
* @public
|
|
2820
3127
|
* <p>A modified end time of the scheduled action.
|
|
2821
3128
|
* For more information about this parameter, see <a>ScheduledAction</a>. </p>
|
|
2822
3129
|
*/
|
|
2823
3130
|
EndTime?: Date;
|
|
2824
3131
|
/**
|
|
3132
|
+
* @public
|
|
2825
3133
|
* <p>A modified enable flag of the scheduled action. If true, the scheduled action is active. If false, the scheduled action is disabled. </p>
|
|
2826
3134
|
*/
|
|
2827
3135
|
Enable?: boolean;
|
|
@@ -2832,6 +3140,7 @@ export interface ModifyScheduledActionMessage {
|
|
|
2832
3140
|
*/
|
|
2833
3141
|
export interface ModifySnapshotCopyRetentionPeriodMessage {
|
|
2834
3142
|
/**
|
|
3143
|
+
* @public
|
|
2835
3144
|
* <p>The unique identifier of the cluster for which you want to change the retention
|
|
2836
3145
|
* period for either automated or manual snapshots that are copied to a destination Amazon Web Services Region.</p>
|
|
2837
3146
|
* <p>Constraints: Must be the valid name of an existing cluster that has cross-region
|
|
@@ -2839,6 +3148,7 @@ export interface ModifySnapshotCopyRetentionPeriodMessage {
|
|
|
2839
3148
|
*/
|
|
2840
3149
|
ClusterIdentifier: string | undefined;
|
|
2841
3150
|
/**
|
|
3151
|
+
* @public
|
|
2842
3152
|
* <p>The number of days to retain automated snapshots in the destination Amazon Web Services Region
|
|
2843
3153
|
* after they are copied from the source Amazon Web Services Region.</p>
|
|
2844
3154
|
* <p>By default, this only changes the retention period of copied automated snapshots. </p>
|
|
@@ -2856,6 +3166,7 @@ export interface ModifySnapshotCopyRetentionPeriodMessage {
|
|
|
2856
3166
|
*/
|
|
2857
3167
|
RetentionPeriod: number | undefined;
|
|
2858
3168
|
/**
|
|
3169
|
+
* @public
|
|
2859
3170
|
* <p>Indicates whether to apply the snapshot retention period to newly copied manual
|
|
2860
3171
|
* snapshots instead of automated snapshots.</p>
|
|
2861
3172
|
*/
|
|
@@ -2866,6 +3177,7 @@ export interface ModifySnapshotCopyRetentionPeriodMessage {
|
|
|
2866
3177
|
*/
|
|
2867
3178
|
export interface ModifySnapshotCopyRetentionPeriodResult {
|
|
2868
3179
|
/**
|
|
3180
|
+
* @public
|
|
2869
3181
|
* <p>Describes a cluster.</p>
|
|
2870
3182
|
*/
|
|
2871
3183
|
Cluster?: Cluster;
|
|
@@ -2888,10 +3200,12 @@ export declare class SnapshotCopyDisabledFault extends __BaseException {
|
|
|
2888
3200
|
*/
|
|
2889
3201
|
export interface ModifySnapshotScheduleMessage {
|
|
2890
3202
|
/**
|
|
3203
|
+
* @public
|
|
2891
3204
|
* <p>A unique alphanumeric identifier of the schedule to modify.</p>
|
|
2892
3205
|
*/
|
|
2893
3206
|
ScheduleIdentifier: string | undefined;
|
|
2894
3207
|
/**
|
|
3208
|
+
* @public
|
|
2895
3209
|
* <p>An updated list of schedule definitions. A schedule definition is made up of schedule
|
|
2896
3210
|
* expressions, for example, "cron(30 12 *)" or "rate(12 hours)".</p>
|
|
2897
3211
|
*/
|
|
@@ -2914,15 +3228,18 @@ export declare class SnapshotScheduleUpdateInProgressFault extends __BaseExcepti
|
|
|
2914
3228
|
*/
|
|
2915
3229
|
export interface ModifyUsageLimitMessage {
|
|
2916
3230
|
/**
|
|
3231
|
+
* @public
|
|
2917
3232
|
* <p>The identifier of the usage limit to modify.</p>
|
|
2918
3233
|
*/
|
|
2919
3234
|
UsageLimitId: string | undefined;
|
|
2920
3235
|
/**
|
|
3236
|
+
* @public
|
|
2921
3237
|
* <p>The new limit amount.
|
|
2922
3238
|
* For more information about this parameter, see <a>UsageLimit</a>. </p>
|
|
2923
3239
|
*/
|
|
2924
3240
|
Amount?: number;
|
|
2925
3241
|
/**
|
|
3242
|
+
* @public
|
|
2926
3243
|
* <p>The new action that Amazon Redshift takes when the limit is reached.
|
|
2927
3244
|
* For more information about this parameter, see <a>UsageLimit</a>. </p>
|
|
2928
3245
|
*/
|
|
@@ -2933,6 +3250,7 @@ export interface ModifyUsageLimitMessage {
|
|
|
2933
3250
|
*/
|
|
2934
3251
|
export interface PauseClusterResult {
|
|
2935
3252
|
/**
|
|
3253
|
+
* @public
|
|
2936
3254
|
* <p>Describes a cluster.</p>
|
|
2937
3255
|
*/
|
|
2938
3256
|
Cluster?: Cluster;
|
|
@@ -2943,10 +3261,12 @@ export interface PauseClusterResult {
|
|
|
2943
3261
|
*/
|
|
2944
3262
|
export interface PurchaseReservedNodeOfferingMessage {
|
|
2945
3263
|
/**
|
|
3264
|
+
* @public
|
|
2946
3265
|
* <p>The unique identifier of the reserved node offering you want to purchase.</p>
|
|
2947
3266
|
*/
|
|
2948
3267
|
ReservedNodeOfferingId: string | undefined;
|
|
2949
3268
|
/**
|
|
3269
|
+
* @public
|
|
2950
3270
|
* <p>The number of reserved nodes that you want to purchase.</p>
|
|
2951
3271
|
* <p>Default: <code>1</code>
|
|
2952
3272
|
* </p>
|
|
@@ -2958,6 +3278,7 @@ export interface PurchaseReservedNodeOfferingMessage {
|
|
|
2958
3278
|
*/
|
|
2959
3279
|
export interface PurchaseReservedNodeOfferingResult {
|
|
2960
3280
|
/**
|
|
3281
|
+
* @public
|
|
2961
3282
|
* <p>Describes a reserved node. You can call the <a>DescribeReservedNodeOfferings</a> API to obtain the available reserved node
|
|
2962
3283
|
* offerings. </p>
|
|
2963
3284
|
*/
|
|
@@ -2984,6 +3305,7 @@ export declare class ReservedNodeQuotaExceededFault extends __BaseException {
|
|
|
2984
3305
|
*/
|
|
2985
3306
|
export interface RebootClusterMessage {
|
|
2986
3307
|
/**
|
|
3308
|
+
* @public
|
|
2987
3309
|
* <p>The cluster identifier.</p>
|
|
2988
3310
|
*/
|
|
2989
3311
|
ClusterIdentifier: string | undefined;
|
|
@@ -2993,6 +3315,7 @@ export interface RebootClusterMessage {
|
|
|
2993
3315
|
*/
|
|
2994
3316
|
export interface RebootClusterResult {
|
|
2995
3317
|
/**
|
|
3318
|
+
* @public
|
|
2996
3319
|
* <p>Describes a cluster.</p>
|
|
2997
3320
|
*/
|
|
2998
3321
|
Cluster?: Cluster;
|
|
@@ -3002,6 +3325,7 @@ export interface RebootClusterResult {
|
|
|
3002
3325
|
*/
|
|
3003
3326
|
export interface RejectDataShareMessage {
|
|
3004
3327
|
/**
|
|
3328
|
+
* @public
|
|
3005
3329
|
* <p>The Amazon Resource Name (ARN) of the datashare to reject.</p>
|
|
3006
3330
|
*/
|
|
3007
3331
|
DataShareArn: string | undefined;
|
|
@@ -3012,10 +3336,12 @@ export interface RejectDataShareMessage {
|
|
|
3012
3336
|
*/
|
|
3013
3337
|
export interface ResetClusterParameterGroupMessage {
|
|
3014
3338
|
/**
|
|
3339
|
+
* @public
|
|
3015
3340
|
* <p>The name of the cluster parameter group to be reset.</p>
|
|
3016
3341
|
*/
|
|
3017
3342
|
ParameterGroupName: string | undefined;
|
|
3018
3343
|
/**
|
|
3344
|
+
* @public
|
|
3019
3345
|
* <p>If <code>true</code>, all parameters in the specified parameter group will be reset
|
|
3020
3346
|
* to their default values. </p>
|
|
3021
3347
|
* <p>Default: <code>true</code>
|
|
@@ -3023,6 +3349,7 @@ export interface ResetClusterParameterGroupMessage {
|
|
|
3023
3349
|
*/
|
|
3024
3350
|
ResetAllParameters?: boolean;
|
|
3025
3351
|
/**
|
|
3352
|
+
* @public
|
|
3026
3353
|
* <p>An array of names of parameters to be reset. If
|
|
3027
3354
|
* <i>ResetAllParameters</i> option is not used, then at least one
|
|
3028
3355
|
* parameter name must be supplied. </p>
|
|
@@ -3035,6 +3362,7 @@ export interface ResetClusterParameterGroupMessage {
|
|
|
3035
3362
|
*/
|
|
3036
3363
|
export interface ResizeClusterResult {
|
|
3037
3364
|
/**
|
|
3365
|
+
* @public
|
|
3038
3366
|
* <p>Describes a cluster.</p>
|
|
3039
3367
|
*/
|
|
3040
3368
|
Cluster?: Cluster;
|
|
@@ -3045,6 +3373,7 @@ export interface ResizeClusterResult {
|
|
|
3045
3373
|
*/
|
|
3046
3374
|
export interface RestoreFromClusterSnapshotMessage {
|
|
3047
3375
|
/**
|
|
3376
|
+
* @public
|
|
3048
3377
|
* <p>The identifier of the cluster that will be created from restoring the
|
|
3049
3378
|
* snapshot.</p>
|
|
3050
3379
|
* <p>Constraints:</p>
|
|
@@ -3068,6 +3397,7 @@ export interface RestoreFromClusterSnapshotMessage {
|
|
|
3068
3397
|
*/
|
|
3069
3398
|
ClusterIdentifier: string | undefined;
|
|
3070
3399
|
/**
|
|
3400
|
+
* @public
|
|
3071
3401
|
* <p>The name of the snapshot from which to create the new cluster. This parameter isn't
|
|
3072
3402
|
* case sensitive. You must specify this parameter or <code>snapshotArn</code>, but not both.</p>
|
|
3073
3403
|
* <p>Example: <code>my-snapshot-id</code>
|
|
@@ -3075,23 +3405,27 @@ export interface RestoreFromClusterSnapshotMessage {
|
|
|
3075
3405
|
*/
|
|
3076
3406
|
SnapshotIdentifier?: string;
|
|
3077
3407
|
/**
|
|
3408
|
+
* @public
|
|
3078
3409
|
* <p>The Amazon Resource Name (ARN) of the snapshot associated with the message to restore from a cluster. You must specify
|
|
3079
3410
|
* this parameter or <code>snapshotIdentifier</code>, but not both.</p>
|
|
3080
3411
|
*/
|
|
3081
3412
|
SnapshotArn?: string;
|
|
3082
3413
|
/**
|
|
3414
|
+
* @public
|
|
3083
3415
|
* <p>The name of the cluster the source snapshot was created from. This parameter is
|
|
3084
3416
|
* required if your IAM user has a policy containing a snapshot resource element that
|
|
3085
3417
|
* specifies anything other than * for the cluster name.</p>
|
|
3086
3418
|
*/
|
|
3087
3419
|
SnapshotClusterIdentifier?: string;
|
|
3088
3420
|
/**
|
|
3421
|
+
* @public
|
|
3089
3422
|
* <p>The port number on which the cluster accepts connections.</p>
|
|
3090
3423
|
* <p>Default: The same port as the original cluster.</p>
|
|
3091
3424
|
* <p>Constraints: Must be between <code>1115</code> and <code>65535</code>.</p>
|
|
3092
3425
|
*/
|
|
3093
3426
|
Port?: number;
|
|
3094
3427
|
/**
|
|
3428
|
+
* @public
|
|
3095
3429
|
* <p>The Amazon EC2 Availability Zone in which to restore the cluster.</p>
|
|
3096
3430
|
* <p>Default: A random, system-chosen Availability Zone.</p>
|
|
3097
3431
|
* <p>Example: <code>us-east-2a</code>
|
|
@@ -3099,6 +3433,7 @@ export interface RestoreFromClusterSnapshotMessage {
|
|
|
3099
3433
|
*/
|
|
3100
3434
|
AvailabilityZone?: string;
|
|
3101
3435
|
/**
|
|
3436
|
+
* @public
|
|
3102
3437
|
* <p>If <code>true</code>, major version upgrades can be applied during the maintenance
|
|
3103
3438
|
* window to the Amazon Redshift engine that is running on the cluster. </p>
|
|
3104
3439
|
* <p>Default: <code>true</code>
|
|
@@ -3106,36 +3441,43 @@ export interface RestoreFromClusterSnapshotMessage {
|
|
|
3106
3441
|
*/
|
|
3107
3442
|
AllowVersionUpgrade?: boolean;
|
|
3108
3443
|
/**
|
|
3444
|
+
* @public
|
|
3109
3445
|
* <p>The name of the subnet group where you want to cluster restored.</p>
|
|
3110
3446
|
* <p>A snapshot of cluster in VPC can be restored only in VPC. Therefore, you must
|
|
3111
3447
|
* provide subnet group name where you want the cluster restored.</p>
|
|
3112
3448
|
*/
|
|
3113
3449
|
ClusterSubnetGroupName?: string;
|
|
3114
3450
|
/**
|
|
3451
|
+
* @public
|
|
3115
3452
|
* <p>If <code>true</code>, the cluster can be accessed from a public network. </p>
|
|
3116
3453
|
*/
|
|
3117
3454
|
PubliclyAccessible?: boolean;
|
|
3118
3455
|
/**
|
|
3456
|
+
* @public
|
|
3119
3457
|
* <p>The Amazon Web Services account used to create or copy the snapshot. Required if you are
|
|
3120
3458
|
* restoring a snapshot you do not own, optional if you own the snapshot.</p>
|
|
3121
3459
|
*/
|
|
3122
3460
|
OwnerAccount?: string;
|
|
3123
3461
|
/**
|
|
3462
|
+
* @public
|
|
3124
3463
|
* <p>Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to
|
|
3125
3464
|
* retrieve the data encryption keys stored in an HSM.</p>
|
|
3126
3465
|
*/
|
|
3127
3466
|
HsmClientCertificateIdentifier?: string;
|
|
3128
3467
|
/**
|
|
3468
|
+
* @public
|
|
3129
3469
|
* <p>Specifies the name of the HSM configuration that contains the information the
|
|
3130
3470
|
* Amazon Redshift cluster can use to retrieve and store keys in an HSM.</p>
|
|
3131
3471
|
*/
|
|
3132
3472
|
HsmConfigurationIdentifier?: string;
|
|
3133
3473
|
/**
|
|
3474
|
+
* @public
|
|
3134
3475
|
* <p>The Elastic IP (EIP) address for the cluster. Don't specify the Elastic IP address for a publicly
|
|
3135
3476
|
* accessible cluster with availability zone relocation turned on.</p>
|
|
3136
3477
|
*/
|
|
3137
3478
|
ElasticIp?: string;
|
|
3138
3479
|
/**
|
|
3480
|
+
* @public
|
|
3139
3481
|
* <p>The name of the parameter group to be associated with this cluster.</p>
|
|
3140
3482
|
* <p>Default: The default Amazon Redshift cluster parameter group. For information about the
|
|
3141
3483
|
* default parameter group, go to <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html">Working with Amazon
|
|
@@ -3155,12 +3497,14 @@ export interface RestoreFromClusterSnapshotMessage {
|
|
|
3155
3497
|
*/
|
|
3156
3498
|
ClusterParameterGroupName?: string;
|
|
3157
3499
|
/**
|
|
3500
|
+
* @public
|
|
3158
3501
|
* <p>A list of security groups to be associated with this cluster.</p>
|
|
3159
3502
|
* <p>Default: The default cluster security group for Amazon Redshift.</p>
|
|
3160
3503
|
* <p>Cluster security groups only apply to clusters outside of VPCs.</p>
|
|
3161
3504
|
*/
|
|
3162
3505
|
ClusterSecurityGroups?: string[];
|
|
3163
3506
|
/**
|
|
3507
|
+
* @public
|
|
3164
3508
|
* <p>A list of Virtual Private Cloud (VPC) security groups to be associated with the
|
|
3165
3509
|
* cluster.</p>
|
|
3166
3510
|
* <p>Default: The default VPC security group is associated with the cluster.</p>
|
|
@@ -3168,6 +3512,7 @@ export interface RestoreFromClusterSnapshotMessage {
|
|
|
3168
3512
|
*/
|
|
3169
3513
|
VpcSecurityGroupIds?: string[];
|
|
3170
3514
|
/**
|
|
3515
|
+
* @public
|
|
3171
3516
|
* <p>The weekly time range (in UTC) during which automated cluster maintenance can
|
|
3172
3517
|
* occur.</p>
|
|
3173
3518
|
* <p> Format: <code>ddd:hh24:mi-ddd:hh24:mi</code>
|
|
@@ -3179,6 +3524,7 @@ export interface RestoreFromClusterSnapshotMessage {
|
|
|
3179
3524
|
*/
|
|
3180
3525
|
PreferredMaintenanceWindow?: string;
|
|
3181
3526
|
/**
|
|
3527
|
+
* @public
|
|
3182
3528
|
* <p>The number of days that automated snapshots are retained. If the value is 0,
|
|
3183
3529
|
* automated snapshots are disabled. Even if automated snapshots are disabled, you can
|
|
3184
3530
|
* still create manual snapshots when you want with <a>CreateClusterSnapshot</a>. </p>
|
|
@@ -3189,6 +3535,7 @@ export interface RestoreFromClusterSnapshotMessage {
|
|
|
3189
3535
|
*/
|
|
3190
3536
|
AutomatedSnapshotRetentionPeriod?: number;
|
|
3191
3537
|
/**
|
|
3538
|
+
* @public
|
|
3192
3539
|
* <p>The default number of days to retain a manual snapshot. If the value is -1, the
|
|
3193
3540
|
* snapshot is retained indefinitely. This setting doesn't change the retention period
|
|
3194
3541
|
* of existing snapshots.</p>
|
|
@@ -3196,6 +3543,7 @@ export interface RestoreFromClusterSnapshotMessage {
|
|
|
3196
3543
|
*/
|
|
3197
3544
|
ManualSnapshotRetentionPeriod?: number;
|
|
3198
3545
|
/**
|
|
3546
|
+
* @public
|
|
3199
3547
|
* <p>The Key Management Service (KMS) key ID of the encryption key that encrypts data in the cluster
|
|
3200
3548
|
* restored from a shared snapshot. You can also provide
|
|
3201
3549
|
* the key ID when you restore from an unencrypted snapshot to an encrypted cluster in
|
|
@@ -3205,6 +3553,7 @@ export interface RestoreFromClusterSnapshotMessage {
|
|
|
3205
3553
|
*/
|
|
3206
3554
|
KmsKeyId?: string;
|
|
3207
3555
|
/**
|
|
3556
|
+
* @public
|
|
3208
3557
|
* <p>The node type that the restored cluster will be provisioned with.</p>
|
|
3209
3558
|
* <p>Default: The node type of the cluster from which the snapshot was taken. You can
|
|
3210
3559
|
* modify this if you are using any DS node type. In that case, you can choose to restore
|
|
@@ -3219,6 +3568,7 @@ export interface RestoreFromClusterSnapshotMessage {
|
|
|
3219
3568
|
*/
|
|
3220
3569
|
NodeType?: string;
|
|
3221
3570
|
/**
|
|
3571
|
+
* @public
|
|
3222
3572
|
* <p>An option that specifies whether to create the cluster with enhanced VPC routing
|
|
3223
3573
|
* enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a
|
|
3224
3574
|
* VPC. For more information, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html">Enhanced VPC Routing</a> in
|
|
@@ -3228,10 +3578,12 @@ export interface RestoreFromClusterSnapshotMessage {
|
|
|
3228
3578
|
*/
|
|
3229
3579
|
EnhancedVpcRouting?: boolean;
|
|
3230
3580
|
/**
|
|
3581
|
+
* @public
|
|
3231
3582
|
* <p>Reserved.</p>
|
|
3232
3583
|
*/
|
|
3233
3584
|
AdditionalInfo?: string;
|
|
3234
3585
|
/**
|
|
3586
|
+
* @public
|
|
3235
3587
|
* <p>A list of Identity and Access Management (IAM) roles that can be used by the
|
|
3236
3588
|
* cluster to access other Amazon Web Services services. You must supply the IAM roles in their Amazon
|
|
3237
3589
|
* Resource Name (ARN) format. </p>
|
|
@@ -3241,6 +3593,7 @@ export interface RestoreFromClusterSnapshotMessage {
|
|
|
3241
3593
|
*/
|
|
3242
3594
|
IamRoles?: string[];
|
|
3243
3595
|
/**
|
|
3596
|
+
* @public
|
|
3244
3597
|
* <p>The name of the maintenance track for the restored cluster. When you take a snapshot,
|
|
3245
3598
|
* the snapshot inherits the <code>MaintenanceTrack</code> value from the cluster. The
|
|
3246
3599
|
* snapshot might be on a different track than the cluster that was the source for the
|
|
@@ -3250,34 +3603,42 @@ export interface RestoreFromClusterSnapshotMessage {
|
|
|
3250
3603
|
*/
|
|
3251
3604
|
MaintenanceTrackName?: string;
|
|
3252
3605
|
/**
|
|
3606
|
+
* @public
|
|
3253
3607
|
* <p>A unique identifier for the snapshot schedule.</p>
|
|
3254
3608
|
*/
|
|
3255
3609
|
SnapshotScheduleIdentifier?: string;
|
|
3256
3610
|
/**
|
|
3611
|
+
* @public
|
|
3257
3612
|
* <p>The number of nodes specified when provisioning the restored cluster.</p>
|
|
3258
3613
|
*/
|
|
3259
3614
|
NumberOfNodes?: number;
|
|
3260
3615
|
/**
|
|
3616
|
+
* @public
|
|
3261
3617
|
* <p>The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is restored.</p>
|
|
3262
3618
|
*/
|
|
3263
3619
|
AvailabilityZoneRelocation?: boolean;
|
|
3264
3620
|
/**
|
|
3621
|
+
* @public
|
|
3265
3622
|
* <p>This parameter is retired. It does not set the AQUA configuration status. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).</p>
|
|
3266
3623
|
*/
|
|
3267
3624
|
AquaConfigurationStatus?: AquaConfigurationStatus | string;
|
|
3268
3625
|
/**
|
|
3626
|
+
* @public
|
|
3269
3627
|
* <p>The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was last modified while it was restored from a snapshot.</p>
|
|
3270
3628
|
*/
|
|
3271
3629
|
DefaultIamRoleArn?: string;
|
|
3272
3630
|
/**
|
|
3631
|
+
* @public
|
|
3273
3632
|
* <p>The identifier of the target reserved node offering.</p>
|
|
3274
3633
|
*/
|
|
3275
3634
|
ReservedNodeId?: string;
|
|
3276
3635
|
/**
|
|
3636
|
+
* @public
|
|
3277
3637
|
* <p>The identifier of the target reserved node offering.</p>
|
|
3278
3638
|
*/
|
|
3279
3639
|
TargetReservedNodeOfferingId?: string;
|
|
3280
3640
|
/**
|
|
3641
|
+
* @public
|
|
3281
3642
|
* <p>Enables support for restoring an unencrypted snapshot to a cluster encrypted
|
|
3282
3643
|
* with Key Management Service (KMS) and a customer managed key.</p>
|
|
3283
3644
|
*/
|
|
@@ -3288,6 +3649,7 @@ export interface RestoreFromClusterSnapshotMessage {
|
|
|
3288
3649
|
*/
|
|
3289
3650
|
export interface RestoreFromClusterSnapshotResult {
|
|
3290
3651
|
/**
|
|
3652
|
+
* @public
|
|
3291
3653
|
* <p>Describes a cluster.</p>
|
|
3292
3654
|
*/
|
|
3293
3655
|
Cluster?: Cluster;
|
|
@@ -3298,42 +3660,51 @@ export interface RestoreFromClusterSnapshotResult {
|
|
|
3298
3660
|
*/
|
|
3299
3661
|
export interface RestoreTableFromClusterSnapshotMessage {
|
|
3300
3662
|
/**
|
|
3663
|
+
* @public
|
|
3301
3664
|
* <p>The identifier of the Amazon Redshift cluster to restore the table to.</p>
|
|
3302
3665
|
*/
|
|
3303
3666
|
ClusterIdentifier: string | undefined;
|
|
3304
3667
|
/**
|
|
3668
|
+
* @public
|
|
3305
3669
|
* <p>The identifier of the snapshot to restore the table from. This snapshot must have
|
|
3306
3670
|
* been created from the Amazon Redshift cluster specified by the
|
|
3307
3671
|
* <code>ClusterIdentifier</code> parameter.</p>
|
|
3308
3672
|
*/
|
|
3309
3673
|
SnapshotIdentifier: string | undefined;
|
|
3310
3674
|
/**
|
|
3675
|
+
* @public
|
|
3311
3676
|
* <p>The name of the source database that contains the table to restore from.</p>
|
|
3312
3677
|
*/
|
|
3313
3678
|
SourceDatabaseName: string | undefined;
|
|
3314
3679
|
/**
|
|
3680
|
+
* @public
|
|
3315
3681
|
* <p>The name of the source schema that contains the table to restore from. If you do
|
|
3316
3682
|
* not specify a <code>SourceSchemaName</code> value, the default is
|
|
3317
3683
|
* <code>public</code>.</p>
|
|
3318
3684
|
*/
|
|
3319
3685
|
SourceSchemaName?: string;
|
|
3320
3686
|
/**
|
|
3687
|
+
* @public
|
|
3321
3688
|
* <p>The name of the source table to restore from.</p>
|
|
3322
3689
|
*/
|
|
3323
3690
|
SourceTableName: string | undefined;
|
|
3324
3691
|
/**
|
|
3692
|
+
* @public
|
|
3325
3693
|
* <p>The name of the database to restore the table to.</p>
|
|
3326
3694
|
*/
|
|
3327
3695
|
TargetDatabaseName?: string;
|
|
3328
3696
|
/**
|
|
3697
|
+
* @public
|
|
3329
3698
|
* <p>The name of the schema to restore the table to.</p>
|
|
3330
3699
|
*/
|
|
3331
3700
|
TargetSchemaName?: string;
|
|
3332
3701
|
/**
|
|
3702
|
+
* @public
|
|
3333
3703
|
* <p>The name of the table to create as a result of the current request.</p>
|
|
3334
3704
|
*/
|
|
3335
3705
|
NewTableName: string | undefined;
|
|
3336
3706
|
/**
|
|
3707
|
+
* @public
|
|
3337
3708
|
* <p>Indicates whether name identifiers for database, schema, and table are case sensitive.
|
|
3338
3709
|
* If <code>true</code>, the names are case sensitive.
|
|
3339
3710
|
* If <code>false</code> (default), the names are not case sensitive.</p>
|
|
@@ -3345,6 +3716,7 @@ export interface RestoreTableFromClusterSnapshotMessage {
|
|
|
3345
3716
|
*/
|
|
3346
3717
|
export interface RestoreTableFromClusterSnapshotResult {
|
|
3347
3718
|
/**
|
|
3719
|
+
* @public
|
|
3348
3720
|
* <p>Describes the status of a <a>RestoreTableFromClusterSnapshot</a>
|
|
3349
3721
|
* operation.</p>
|
|
3350
3722
|
*/
|
|
@@ -3355,6 +3727,7 @@ export interface RestoreTableFromClusterSnapshotResult {
|
|
|
3355
3727
|
*/
|
|
3356
3728
|
export interface ResumeClusterResult {
|
|
3357
3729
|
/**
|
|
3730
|
+
* @public
|
|
3358
3731
|
* <p>Describes a cluster.</p>
|
|
3359
3732
|
*/
|
|
3360
3733
|
Cluster?: Cluster;
|
|
@@ -3365,10 +3738,12 @@ export interface ResumeClusterResult {
|
|
|
3365
3738
|
*/
|
|
3366
3739
|
export interface RevokeClusterSecurityGroupIngressMessage {
|
|
3367
3740
|
/**
|
|
3741
|
+
* @public
|
|
3368
3742
|
* <p>The name of the security Group from which to revoke the ingress rule.</p>
|
|
3369
3743
|
*/
|
|
3370
3744
|
ClusterSecurityGroupName: string | undefined;
|
|
3371
3745
|
/**
|
|
3746
|
+
* @public
|
|
3372
3747
|
* <p>The IP range for which to revoke access. This range must be a valid Classless
|
|
3373
3748
|
* Inter-Domain Routing (CIDR) block of IP addresses. If <code>CIDRIP</code> is specified,
|
|
3374
3749
|
* <code>EC2SecurityGroupName</code> and <code>EC2SecurityGroupOwnerId</code> cannot be
|
|
@@ -3376,12 +3751,14 @@ export interface RevokeClusterSecurityGroupIngressMessage {
|
|
|
3376
3751
|
*/
|
|
3377
3752
|
CIDRIP?: string;
|
|
3378
3753
|
/**
|
|
3754
|
+
* @public
|
|
3379
3755
|
* <p>The name of the EC2 Security Group whose access is to be revoked. If
|
|
3380
3756
|
* <code>EC2SecurityGroupName</code> is specified, <code>EC2SecurityGroupOwnerId</code>
|
|
3381
3757
|
* must also be provided and <code>CIDRIP</code> cannot be provided. </p>
|
|
3382
3758
|
*/
|
|
3383
3759
|
EC2SecurityGroupName?: string;
|
|
3384
3760
|
/**
|
|
3761
|
+
* @public
|
|
3385
3762
|
* <p>The Amazon Web Services account number of the owner of the security group specified in the
|
|
3386
3763
|
* <code>EC2SecurityGroupName</code> parameter. The Amazon Web Services access key ID is not an
|
|
3387
3764
|
* acceptable value. If <code>EC2SecurityGroupOwnerId</code> is specified,
|
|
@@ -3397,6 +3774,7 @@ export interface RevokeClusterSecurityGroupIngressMessage {
|
|
|
3397
3774
|
*/
|
|
3398
3775
|
export interface RevokeClusterSecurityGroupIngressResult {
|
|
3399
3776
|
/**
|
|
3777
|
+
* @public
|
|
3400
3778
|
* <p>Describes a security group.</p>
|
|
3401
3779
|
*/
|
|
3402
3780
|
ClusterSecurityGroup?: ClusterSecurityGroup;
|
|
@@ -3406,18 +3784,22 @@ export interface RevokeClusterSecurityGroupIngressResult {
|
|
|
3406
3784
|
*/
|
|
3407
3785
|
export interface RevokeEndpointAccessMessage {
|
|
3408
3786
|
/**
|
|
3787
|
+
* @public
|
|
3409
3788
|
* <p>The cluster to revoke access from.</p>
|
|
3410
3789
|
*/
|
|
3411
3790
|
ClusterIdentifier?: string;
|
|
3412
3791
|
/**
|
|
3792
|
+
* @public
|
|
3413
3793
|
* <p>The Amazon Web Services account ID whose access is to be revoked.</p>
|
|
3414
3794
|
*/
|
|
3415
3795
|
Account?: string;
|
|
3416
3796
|
/**
|
|
3797
|
+
* @public
|
|
3417
3798
|
* <p>The virtual private cloud (VPC) identifiers for which access is to be revoked.</p>
|
|
3418
3799
|
*/
|
|
3419
3800
|
VpcIds?: string[];
|
|
3420
3801
|
/**
|
|
3802
|
+
* @public
|
|
3421
3803
|
* <p>Indicates whether to force the revoke action.
|
|
3422
3804
|
* If true, the Redshift-managed VPC endpoints associated with the endpoint authorization are also deleted.</p>
|
|
3423
3805
|
*/
|
|
@@ -3429,20 +3811,24 @@ export interface RevokeEndpointAccessMessage {
|
|
|
3429
3811
|
*/
|
|
3430
3812
|
export interface RevokeSnapshotAccessMessage {
|
|
3431
3813
|
/**
|
|
3814
|
+
* @public
|
|
3432
3815
|
* <p>The identifier of the snapshot that the account can no longer access.</p>
|
|
3433
3816
|
*/
|
|
3434
3817
|
SnapshotIdentifier?: string;
|
|
3435
3818
|
/**
|
|
3819
|
+
* @public
|
|
3436
3820
|
* <p>The Amazon Resource Name (ARN) of the snapshot associated with the message to revoke access.</p>
|
|
3437
3821
|
*/
|
|
3438
3822
|
SnapshotArn?: string;
|
|
3439
3823
|
/**
|
|
3824
|
+
* @public
|
|
3440
3825
|
* <p>The identifier of the cluster the snapshot was created from. This parameter is
|
|
3441
3826
|
* required if your IAM user has a policy containing a snapshot resource element that
|
|
3442
3827
|
* specifies anything other than * for the cluster name.</p>
|
|
3443
3828
|
*/
|
|
3444
3829
|
SnapshotClusterIdentifier?: string;
|
|
3445
3830
|
/**
|
|
3831
|
+
* @public
|
|
3446
3832
|
* <p>The identifier of the Amazon Web Services account that can no longer restore the specified
|
|
3447
3833
|
* snapshot.</p>
|
|
3448
3834
|
*/
|
|
@@ -3453,6 +3839,7 @@ export interface RevokeSnapshotAccessMessage {
|
|
|
3453
3839
|
*/
|
|
3454
3840
|
export interface RevokeSnapshotAccessResult {
|
|
3455
3841
|
/**
|
|
3842
|
+
* @public
|
|
3456
3843
|
* <p>Describes a snapshot.</p>
|
|
3457
3844
|
*/
|
|
3458
3845
|
Snapshot?: Snapshot;
|
|
@@ -3463,6 +3850,7 @@ export interface RevokeSnapshotAccessResult {
|
|
|
3463
3850
|
*/
|
|
3464
3851
|
export interface RotateEncryptionKeyMessage {
|
|
3465
3852
|
/**
|
|
3853
|
+
* @public
|
|
3466
3854
|
* <p>The unique identifier of the cluster that you want to rotate the encryption keys
|
|
3467
3855
|
* for.</p>
|
|
3468
3856
|
* <p>Constraints: Must be the name of valid cluster that has encryption
|
|
@@ -3475,6 +3863,7 @@ export interface RotateEncryptionKeyMessage {
|
|
|
3475
3863
|
*/
|
|
3476
3864
|
export interface RotateEncryptionKeyResult {
|
|
3477
3865
|
/**
|
|
3866
|
+
* @public
|
|
3478
3867
|
* <p>Describes a cluster.</p>
|
|
3479
3868
|
*/
|
|
3480
3869
|
Cluster?: Cluster;
|
|
@@ -3484,26 +3873,32 @@ export interface RotateEncryptionKeyResult {
|
|
|
3484
3873
|
*/
|
|
3485
3874
|
export interface UpdatePartnerStatusInputMessage {
|
|
3486
3875
|
/**
|
|
3876
|
+
* @public
|
|
3487
3877
|
* <p>The Amazon Web Services account ID that owns the cluster.</p>
|
|
3488
3878
|
*/
|
|
3489
3879
|
AccountId: string | undefined;
|
|
3490
3880
|
/**
|
|
3881
|
+
* @public
|
|
3491
3882
|
* <p>The cluster identifier of the cluster whose partner integration status is being updated.</p>
|
|
3492
3883
|
*/
|
|
3493
3884
|
ClusterIdentifier: string | undefined;
|
|
3494
3885
|
/**
|
|
3886
|
+
* @public
|
|
3495
3887
|
* <p>The name of the database whose partner integration status is being updated.</p>
|
|
3496
3888
|
*/
|
|
3497
3889
|
DatabaseName: string | undefined;
|
|
3498
3890
|
/**
|
|
3891
|
+
* @public
|
|
3499
3892
|
* <p>The name of the partner whose integration status is being updated.</p>
|
|
3500
3893
|
*/
|
|
3501
3894
|
PartnerName: string | undefined;
|
|
3502
3895
|
/**
|
|
3896
|
+
* @public
|
|
3503
3897
|
* <p>The value of the updated status.</p>
|
|
3504
3898
|
*/
|
|
3505
3899
|
Status: PartnerIntegrationStatus | string | undefined;
|
|
3506
3900
|
/**
|
|
3901
|
+
* @public
|
|
3507
3902
|
* <p>The status message provided by the partner.</p>
|
|
3508
3903
|
*/
|
|
3509
3904
|
StatusMessage?: string;
|