@aws-sdk/client-firehose 3.379.1 → 3.385.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-types/models/models_0.d.ts +435 -0
- package/package.json +5 -5
|
@@ -7,11 +7,13 @@ import { FirehoseServiceException as __BaseException } from "./FirehoseServiceEx
|
|
|
7
7
|
*/
|
|
8
8
|
export interface AmazonOpenSearchServerlessBufferingHints {
|
|
9
9
|
/**
|
|
10
|
+
* @public
|
|
10
11
|
* <p>Buffer incoming data for the specified period of time, in seconds, before delivering it
|
|
11
12
|
* to the destination. The default value is 300 (5 minutes).</p>
|
|
12
13
|
*/
|
|
13
14
|
IntervalInSeconds?: number;
|
|
14
15
|
/**
|
|
16
|
+
* @public
|
|
15
17
|
* <p>Buffer incoming data to the specified size, in MBs, before delivering it to the
|
|
16
18
|
* destination. The default value is 5. </p>
|
|
17
19
|
* <p>We recommend setting this parameter to a value greater than the amount of data you
|
|
@@ -26,15 +28,18 @@ export interface AmazonOpenSearchServerlessBufferingHints {
|
|
|
26
28
|
*/
|
|
27
29
|
export interface CloudWatchLoggingOptions {
|
|
28
30
|
/**
|
|
31
|
+
* @public
|
|
29
32
|
* <p>Enables or disables CloudWatch logging.</p>
|
|
30
33
|
*/
|
|
31
34
|
Enabled?: boolean;
|
|
32
35
|
/**
|
|
36
|
+
* @public
|
|
33
37
|
* <p>The CloudWatch group name for logging. This value is required if CloudWatch logging
|
|
34
38
|
* is enabled.</p>
|
|
35
39
|
*/
|
|
36
40
|
LogGroupName?: string;
|
|
37
41
|
/**
|
|
42
|
+
* @public
|
|
38
43
|
* <p>The CloudWatch log stream name for logging. This value is required if CloudWatch
|
|
39
44
|
* logging is enabled.</p>
|
|
40
45
|
*/
|
|
@@ -65,6 +70,7 @@ export type ProcessorParameterName = (typeof ProcessorParameterName)[keyof typeo
|
|
|
65
70
|
*/
|
|
66
71
|
export interface ProcessorParameter {
|
|
67
72
|
/**
|
|
73
|
+
* @public
|
|
68
74
|
* <p>The name of the parameter. Currently the following default values are supported: 3
|
|
69
75
|
* for <code>NumberOfRetries</code> and 60 for the <code>BufferIntervalInSeconds</code>. The
|
|
70
76
|
* <code>BufferSizeInMBs</code> ranges between 0.2 MB and up to 3MB. The default buffering
|
|
@@ -73,6 +79,7 @@ export interface ProcessorParameter {
|
|
|
73
79
|
*/
|
|
74
80
|
ParameterName: ProcessorParameterName | string | undefined;
|
|
75
81
|
/**
|
|
82
|
+
* @public
|
|
76
83
|
* <p>The parameter value.</p>
|
|
77
84
|
*/
|
|
78
85
|
ParameterValue: string | undefined;
|
|
@@ -97,10 +104,12 @@ export type ProcessorType = (typeof ProcessorType)[keyof typeof ProcessorType];
|
|
|
97
104
|
*/
|
|
98
105
|
export interface Processor {
|
|
99
106
|
/**
|
|
107
|
+
* @public
|
|
100
108
|
* <p>The type of processor.</p>
|
|
101
109
|
*/
|
|
102
110
|
Type: ProcessorType | string | undefined;
|
|
103
111
|
/**
|
|
112
|
+
* @public
|
|
104
113
|
* <p>The processor parameters.</p>
|
|
105
114
|
*/
|
|
106
115
|
Parameters?: ProcessorParameter[];
|
|
@@ -111,10 +120,12 @@ export interface Processor {
|
|
|
111
120
|
*/
|
|
112
121
|
export interface ProcessingConfiguration {
|
|
113
122
|
/**
|
|
123
|
+
* @public
|
|
114
124
|
* <p>Enables or disables data processing.</p>
|
|
115
125
|
*/
|
|
116
126
|
Enabled?: boolean;
|
|
117
127
|
/**
|
|
128
|
+
* @public
|
|
118
129
|
* <p>The data processors.</p>
|
|
119
130
|
*/
|
|
120
131
|
Processors?: Processor[];
|
|
@@ -126,6 +137,7 @@ export interface ProcessingConfiguration {
|
|
|
126
137
|
*/
|
|
127
138
|
export interface AmazonOpenSearchServerlessRetryOptions {
|
|
128
139
|
/**
|
|
140
|
+
* @public
|
|
129
141
|
* <p>After an initial failure to deliver to the Serverless offering for Amazon OpenSearch
|
|
130
142
|
* Service, the total amount of time during which Kinesis Data Firehose retries delivery
|
|
131
143
|
* (including the first attempt). After this time has elapsed, the failed documents are
|
|
@@ -156,6 +168,7 @@ export type AmazonOpenSearchServerlessS3BackupMode = (typeof AmazonOpenSearchSer
|
|
|
156
168
|
*/
|
|
157
169
|
export interface BufferingHints {
|
|
158
170
|
/**
|
|
171
|
+
* @public
|
|
159
172
|
* <p>Buffer incoming data to the specified size, in MiBs, before delivering it to the
|
|
160
173
|
* destination. The default value is 5. This parameter is optional but if you specify a value
|
|
161
174
|
* for it, you must also specify a value for <code>IntervalInSeconds</code>, and vice
|
|
@@ -166,6 +179,7 @@ export interface BufferingHints {
|
|
|
166
179
|
*/
|
|
167
180
|
SizeInMBs?: number;
|
|
168
181
|
/**
|
|
182
|
+
* @public
|
|
169
183
|
* <p>Buffer incoming data for the specified period of time, in seconds, before delivering
|
|
170
184
|
* it to the destination. The default value is 300. This parameter is optional but if you
|
|
171
185
|
* specify a value for it, you must also specify a value for <code>SizeInMBs</code>, and vice
|
|
@@ -194,6 +208,7 @@ export type CompressionFormat = (typeof CompressionFormat)[keyof typeof Compress
|
|
|
194
208
|
*/
|
|
195
209
|
export interface KMSEncryptionConfig {
|
|
196
210
|
/**
|
|
211
|
+
* @public
|
|
197
212
|
* <p>The Amazon Resource Name (ARN) of the encryption key. Must belong to the same Amazon Web Services Region as the destination Amazon S3 bucket. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
|
|
198
213
|
* Resource Names (ARNs) and Amazon Web Services Service Namespaces</a>.</p>
|
|
199
214
|
*/
|
|
@@ -216,11 +231,13 @@ export type NoEncryptionConfig = (typeof NoEncryptionConfig)[keyof typeof NoEncr
|
|
|
216
231
|
*/
|
|
217
232
|
export interface EncryptionConfiguration {
|
|
218
233
|
/**
|
|
234
|
+
* @public
|
|
219
235
|
* <p>Specifically override existing encryption information to ensure that no encryption is
|
|
220
236
|
* used.</p>
|
|
221
237
|
*/
|
|
222
238
|
NoEncryptionConfig?: NoEncryptionConfig | string;
|
|
223
239
|
/**
|
|
240
|
+
* @public
|
|
224
241
|
* <p>The encryption key.</p>
|
|
225
242
|
*/
|
|
226
243
|
KMSEncryptionConfig?: KMSEncryptionConfig;
|
|
@@ -231,23 +248,27 @@ export interface EncryptionConfiguration {
|
|
|
231
248
|
*/
|
|
232
249
|
export interface S3DestinationConfiguration {
|
|
233
250
|
/**
|
|
251
|
+
* @public
|
|
234
252
|
* <p>The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more
|
|
235
253
|
* information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and
|
|
236
254
|
* Amazon Web Services Service Namespaces</a>.</p>
|
|
237
255
|
*/
|
|
238
256
|
RoleARN: string | undefined;
|
|
239
257
|
/**
|
|
258
|
+
* @public
|
|
240
259
|
* <p>The ARN of the S3 bucket. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and
|
|
241
260
|
* Amazon Web Services Service Namespaces</a>.</p>
|
|
242
261
|
*/
|
|
243
262
|
BucketARN: string | undefined;
|
|
244
263
|
/**
|
|
264
|
+
* @public
|
|
245
265
|
* <p>The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3
|
|
246
266
|
* files. You can also specify a custom prefix, as described in <a href="https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html">Custom Prefixes for Amazon S3
|
|
247
267
|
* Objects</a>.</p>
|
|
248
268
|
*/
|
|
249
269
|
Prefix?: string;
|
|
250
270
|
/**
|
|
271
|
+
* @public
|
|
251
272
|
* <p>A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing
|
|
252
273
|
* them to S3. This prefix appears immediately following the bucket name. For information
|
|
253
274
|
* about how to specify this prefix, see <a href="https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html">Custom Prefixes for Amazon S3
|
|
@@ -255,11 +276,13 @@ export interface S3DestinationConfiguration {
|
|
|
255
276
|
*/
|
|
256
277
|
ErrorOutputPrefix?: string;
|
|
257
278
|
/**
|
|
279
|
+
* @public
|
|
258
280
|
* <p>The buffering option. If no value is specified, <code>BufferingHints</code> object
|
|
259
281
|
* default values are used.</p>
|
|
260
282
|
*/
|
|
261
283
|
BufferingHints?: BufferingHints;
|
|
262
284
|
/**
|
|
285
|
+
* @public
|
|
263
286
|
* <p>The compression format. If no value is specified, the default is
|
|
264
287
|
* <code>UNCOMPRESSED</code>.</p>
|
|
265
288
|
* <p>The compression formats <code>SNAPPY</code> or <code>ZIP</code> cannot be specified
|
|
@@ -268,11 +291,13 @@ export interface S3DestinationConfiguration {
|
|
|
268
291
|
*/
|
|
269
292
|
CompressionFormat?: CompressionFormat | string;
|
|
270
293
|
/**
|
|
294
|
+
* @public
|
|
271
295
|
* <p>The encryption configuration. If no value is specified, the default is no
|
|
272
296
|
* encryption.</p>
|
|
273
297
|
*/
|
|
274
298
|
EncryptionConfiguration?: EncryptionConfiguration;
|
|
275
299
|
/**
|
|
300
|
+
* @public
|
|
276
301
|
* <p>The CloudWatch logging options for your delivery stream.</p>
|
|
277
302
|
*/
|
|
278
303
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
|
@@ -283,6 +308,7 @@ export interface S3DestinationConfiguration {
|
|
|
283
308
|
*/
|
|
284
309
|
export interface VpcConfiguration {
|
|
285
310
|
/**
|
|
311
|
+
* @public
|
|
286
312
|
* <p>The IDs of the subnets that you want Kinesis Data Firehose to use to create ENIs in the
|
|
287
313
|
* VPC of the Amazon ES destination. Make sure that the routing tables and inbound and
|
|
288
314
|
* outbound rules allow traffic to flow from the subnets whose IDs are specified here to the
|
|
@@ -299,6 +325,7 @@ export interface VpcConfiguration {
|
|
|
299
325
|
*/
|
|
300
326
|
SubnetIds: string[] | undefined;
|
|
301
327
|
/**
|
|
328
|
+
* @public
|
|
302
329
|
* <p>The ARN of the IAM role that you want the delivery stream to use to create endpoints in
|
|
303
330
|
* the destination VPC. You can use your existing Kinesis Data Firehose delivery role or you
|
|
304
331
|
* can specify a new role. In either case, make sure that the role trusts the Kinesis Data
|
|
@@ -351,6 +378,7 @@ export interface VpcConfiguration {
|
|
|
351
378
|
*/
|
|
352
379
|
RoleARN: string | undefined;
|
|
353
380
|
/**
|
|
381
|
+
* @public
|
|
354
382
|
* <p>The IDs of the security groups that you want Kinesis Data Firehose to use when it
|
|
355
383
|
* creates ENIs in the VPC of the Amazon ES destination. You can use the same security group
|
|
356
384
|
* that the Amazon ES domain uses or different ones. If you specify different security groups
|
|
@@ -370,32 +398,38 @@ export interface VpcConfiguration {
|
|
|
370
398
|
*/
|
|
371
399
|
export interface AmazonOpenSearchServerlessDestinationConfiguration {
|
|
372
400
|
/**
|
|
401
|
+
* @public
|
|
373
402
|
* <p>The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose
|
|
374
403
|
* for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for
|
|
375
404
|
* indexing documents.</p>
|
|
376
405
|
*/
|
|
377
406
|
RoleARN: string | undefined;
|
|
378
407
|
/**
|
|
408
|
+
* @public
|
|
379
409
|
* <p>The endpoint to use when communicating with the collection in the Serverless offering
|
|
380
410
|
* for Amazon OpenSearch Service.</p>
|
|
381
411
|
*/
|
|
382
412
|
CollectionEndpoint?: string;
|
|
383
413
|
/**
|
|
414
|
+
* @public
|
|
384
415
|
* <p>The Serverless offering for Amazon OpenSearch Service index name.</p>
|
|
385
416
|
*/
|
|
386
417
|
IndexName: string | undefined;
|
|
387
418
|
/**
|
|
419
|
+
* @public
|
|
388
420
|
* <p>The buffering options. If no value is specified, the default values for
|
|
389
421
|
* AmazonopensearchserviceBufferingHints are used.</p>
|
|
390
422
|
*/
|
|
391
423
|
BufferingHints?: AmazonOpenSearchServerlessBufferingHints;
|
|
392
424
|
/**
|
|
425
|
+
* @public
|
|
393
426
|
* <p>The retry behavior in case Kinesis Data Firehose is unable to deliver documents to the
|
|
394
427
|
* Serverless offering for Amazon OpenSearch Service. The default value is 300 (5
|
|
395
428
|
* minutes).</p>
|
|
396
429
|
*/
|
|
397
430
|
RetryOptions?: AmazonOpenSearchServerlessRetryOptions;
|
|
398
431
|
/**
|
|
432
|
+
* @public
|
|
399
433
|
* <p>Defines how documents should be delivered to Amazon S3. When it is set to
|
|
400
434
|
* FailedDocumentsOnly, Kinesis Data Firehose writes any documents that could not be indexed
|
|
401
435
|
* to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to
|
|
@@ -405,18 +439,22 @@ export interface AmazonOpenSearchServerlessDestinationConfiguration {
|
|
|
405
439
|
*/
|
|
406
440
|
S3BackupMode?: AmazonOpenSearchServerlessS3BackupMode | string;
|
|
407
441
|
/**
|
|
442
|
+
* @public
|
|
408
443
|
* <p>Describes the configuration of a destination in Amazon S3.</p>
|
|
409
444
|
*/
|
|
410
445
|
S3Configuration: S3DestinationConfiguration | undefined;
|
|
411
446
|
/**
|
|
447
|
+
* @public
|
|
412
448
|
* <p>Describes a data processing configuration.</p>
|
|
413
449
|
*/
|
|
414
450
|
ProcessingConfiguration?: ProcessingConfiguration;
|
|
415
451
|
/**
|
|
452
|
+
* @public
|
|
416
453
|
* <p>Describes the Amazon CloudWatch logging options for your delivery stream.</p>
|
|
417
454
|
*/
|
|
418
455
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
|
419
456
|
/**
|
|
457
|
+
* @public
|
|
420
458
|
* <p>The details of the VPC of the Amazon ES destination.</p>
|
|
421
459
|
*/
|
|
422
460
|
VpcConfiguration?: VpcConfiguration;
|
|
@@ -427,23 +465,27 @@ export interface AmazonOpenSearchServerlessDestinationConfiguration {
|
|
|
427
465
|
*/
|
|
428
466
|
export interface S3DestinationDescription {
|
|
429
467
|
/**
|
|
468
|
+
* @public
|
|
430
469
|
* <p>The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more
|
|
431
470
|
* information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and
|
|
432
471
|
* Amazon Web Services Service Namespaces</a>.</p>
|
|
433
472
|
*/
|
|
434
473
|
RoleARN: string | undefined;
|
|
435
474
|
/**
|
|
475
|
+
* @public
|
|
436
476
|
* <p>The ARN of the S3 bucket. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and
|
|
437
477
|
* Amazon Web Services Service Namespaces</a>.</p>
|
|
438
478
|
*/
|
|
439
479
|
BucketARN: string | undefined;
|
|
440
480
|
/**
|
|
481
|
+
* @public
|
|
441
482
|
* <p>The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3
|
|
442
483
|
* files. You can also specify a custom prefix, as described in <a href="https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html">Custom Prefixes for Amazon S3
|
|
443
484
|
* Objects</a>.</p>
|
|
444
485
|
*/
|
|
445
486
|
Prefix?: string;
|
|
446
487
|
/**
|
|
488
|
+
* @public
|
|
447
489
|
* <p>A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing
|
|
448
490
|
* them to S3. This prefix appears immediately following the bucket name. For information
|
|
449
491
|
* about how to specify this prefix, see <a href="https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html">Custom Prefixes for Amazon S3
|
|
@@ -451,21 +493,25 @@ export interface S3DestinationDescription {
|
|
|
451
493
|
*/
|
|
452
494
|
ErrorOutputPrefix?: string;
|
|
453
495
|
/**
|
|
496
|
+
* @public
|
|
454
497
|
* <p>The buffering option. If no value is specified, <code>BufferingHints</code> object
|
|
455
498
|
* default values are used.</p>
|
|
456
499
|
*/
|
|
457
500
|
BufferingHints: BufferingHints | undefined;
|
|
458
501
|
/**
|
|
502
|
+
* @public
|
|
459
503
|
* <p>The compression format. If no value is specified, the default is
|
|
460
504
|
* <code>UNCOMPRESSED</code>.</p>
|
|
461
505
|
*/
|
|
462
506
|
CompressionFormat: CompressionFormat | string | undefined;
|
|
463
507
|
/**
|
|
508
|
+
* @public
|
|
464
509
|
* <p>The encryption configuration. If no value is specified, the default is no
|
|
465
510
|
* encryption.</p>
|
|
466
511
|
*/
|
|
467
512
|
EncryptionConfiguration: EncryptionConfiguration | undefined;
|
|
468
513
|
/**
|
|
514
|
+
* @public
|
|
469
515
|
* <p>The Amazon CloudWatch logging options for your delivery stream.</p>
|
|
470
516
|
*/
|
|
471
517
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
|
@@ -476,6 +522,7 @@ export interface S3DestinationDescription {
|
|
|
476
522
|
*/
|
|
477
523
|
export interface VpcConfigurationDescription {
|
|
478
524
|
/**
|
|
525
|
+
* @public
|
|
479
526
|
* <p>The IDs of the subnets that Kinesis Data Firehose uses to create ENIs in the VPC of the
|
|
480
527
|
* Amazon ES destination. Make sure that the routing tables and inbound and outbound rules
|
|
481
528
|
* allow traffic to flow from the subnets whose IDs are specified here to the subnets that
|
|
@@ -491,6 +538,7 @@ export interface VpcConfigurationDescription {
|
|
|
491
538
|
*/
|
|
492
539
|
SubnetIds: string[] | undefined;
|
|
493
540
|
/**
|
|
541
|
+
* @public
|
|
494
542
|
* <p>The ARN of the IAM role that the delivery stream uses to create endpoints in the
|
|
495
543
|
* destination VPC. You can use your existing Kinesis Data Firehose delivery role or you can
|
|
496
544
|
* specify a new role. In either case, make sure that the role trusts the Kinesis Data
|
|
@@ -543,6 +591,7 @@ export interface VpcConfigurationDescription {
|
|
|
543
591
|
*/
|
|
544
592
|
RoleARN: string | undefined;
|
|
545
593
|
/**
|
|
594
|
+
* @public
|
|
546
595
|
* <p>The IDs of the security groups that Kinesis Data Firehose uses when it creates ENIs in
|
|
547
596
|
* the VPC of the Amazon ES destination. You can use the same security group that the Amazon
|
|
548
597
|
* ES domain uses or different ones. If you specify different security groups, ensure that
|
|
@@ -555,6 +604,7 @@ export interface VpcConfigurationDescription {
|
|
|
555
604
|
*/
|
|
556
605
|
SecurityGroupIds: string[] | undefined;
|
|
557
606
|
/**
|
|
607
|
+
* @public
|
|
558
608
|
* <p>The ID of the Amazon ES destination's VPC.</p>
|
|
559
609
|
*/
|
|
560
610
|
VpcId: string | undefined;
|
|
@@ -566,43 +616,53 @@ export interface VpcConfigurationDescription {
|
|
|
566
616
|
*/
|
|
567
617
|
export interface AmazonOpenSearchServerlessDestinationDescription {
|
|
568
618
|
/**
|
|
619
|
+
* @public
|
|
569
620
|
* <p>The Amazon Resource Name (ARN) of the AWS credentials.</p>
|
|
570
621
|
*/
|
|
571
622
|
RoleARN?: string;
|
|
572
623
|
/**
|
|
624
|
+
* @public
|
|
573
625
|
* <p>The endpoint to use when communicating with the collection in the Serverless offering
|
|
574
626
|
* for Amazon OpenSearch Service.</p>
|
|
575
627
|
*/
|
|
576
628
|
CollectionEndpoint?: string;
|
|
577
629
|
/**
|
|
630
|
+
* @public
|
|
578
631
|
* <p>The Serverless offering for Amazon OpenSearch Service index name.</p>
|
|
579
632
|
*/
|
|
580
633
|
IndexName?: string;
|
|
581
634
|
/**
|
|
635
|
+
* @public
|
|
582
636
|
* <p>The buffering options.</p>
|
|
583
637
|
*/
|
|
584
638
|
BufferingHints?: AmazonOpenSearchServerlessBufferingHints;
|
|
585
639
|
/**
|
|
640
|
+
* @public
|
|
586
641
|
* <p>The Serverless offering for Amazon OpenSearch Service retry options.</p>
|
|
587
642
|
*/
|
|
588
643
|
RetryOptions?: AmazonOpenSearchServerlessRetryOptions;
|
|
589
644
|
/**
|
|
645
|
+
* @public
|
|
590
646
|
* <p>The Amazon S3 backup mode.</p>
|
|
591
647
|
*/
|
|
592
648
|
S3BackupMode?: AmazonOpenSearchServerlessS3BackupMode | string;
|
|
593
649
|
/**
|
|
650
|
+
* @public
|
|
594
651
|
* <p>Describes a destination in Amazon S3.</p>
|
|
595
652
|
*/
|
|
596
653
|
S3DestinationDescription?: S3DestinationDescription;
|
|
597
654
|
/**
|
|
655
|
+
* @public
|
|
598
656
|
* <p>Describes a data processing configuration.</p>
|
|
599
657
|
*/
|
|
600
658
|
ProcessingConfiguration?: ProcessingConfiguration;
|
|
601
659
|
/**
|
|
660
|
+
* @public
|
|
602
661
|
* <p>Describes the Amazon CloudWatch logging options for your delivery stream.</p>
|
|
603
662
|
*/
|
|
604
663
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
|
605
664
|
/**
|
|
665
|
+
* @public
|
|
606
666
|
* <p>The details of the VPC of the Amazon ES destination.</p>
|
|
607
667
|
*/
|
|
608
668
|
VpcConfigurationDescription?: VpcConfigurationDescription;
|
|
@@ -613,23 +673,27 @@ export interface AmazonOpenSearchServerlessDestinationDescription {
|
|
|
613
673
|
*/
|
|
614
674
|
export interface S3DestinationUpdate {
|
|
615
675
|
/**
|
|
676
|
+
* @public
|
|
616
677
|
* <p>The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more
|
|
617
678
|
* information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and
|
|
618
679
|
* Amazon Web Services Service Namespaces</a>.</p>
|
|
619
680
|
*/
|
|
620
681
|
RoleARN?: string;
|
|
621
682
|
/**
|
|
683
|
+
* @public
|
|
622
684
|
* <p>The ARN of the S3 bucket. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and
|
|
623
685
|
* Amazon Web Services Service Namespaces</a>.</p>
|
|
624
686
|
*/
|
|
625
687
|
BucketARN?: string;
|
|
626
688
|
/**
|
|
689
|
+
* @public
|
|
627
690
|
* <p>The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3
|
|
628
691
|
* files. You can also specify a custom prefix, as described in <a href="https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html">Custom Prefixes for Amazon S3
|
|
629
692
|
* Objects</a>.</p>
|
|
630
693
|
*/
|
|
631
694
|
Prefix?: string;
|
|
632
695
|
/**
|
|
696
|
+
* @public
|
|
633
697
|
* <p>A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing
|
|
634
698
|
* them to S3. This prefix appears immediately following the bucket name. For information
|
|
635
699
|
* about how to specify this prefix, see <a href="https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html">Custom Prefixes for Amazon S3
|
|
@@ -637,11 +701,13 @@ export interface S3DestinationUpdate {
|
|
|
637
701
|
*/
|
|
638
702
|
ErrorOutputPrefix?: string;
|
|
639
703
|
/**
|
|
704
|
+
* @public
|
|
640
705
|
* <p>The buffering option. If no value is specified, <code>BufferingHints</code> object
|
|
641
706
|
* default values are used.</p>
|
|
642
707
|
*/
|
|
643
708
|
BufferingHints?: BufferingHints;
|
|
644
709
|
/**
|
|
710
|
+
* @public
|
|
645
711
|
* <p>The compression format. If no value is specified, the default is
|
|
646
712
|
* <code>UNCOMPRESSED</code>.</p>
|
|
647
713
|
* <p>The compression formats <code>SNAPPY</code> or <code>ZIP</code> cannot be specified
|
|
@@ -650,11 +716,13 @@ export interface S3DestinationUpdate {
|
|
|
650
716
|
*/
|
|
651
717
|
CompressionFormat?: CompressionFormat | string;
|
|
652
718
|
/**
|
|
719
|
+
* @public
|
|
653
720
|
* <p>The encryption configuration. If no value is specified, the default is no
|
|
654
721
|
* encryption.</p>
|
|
655
722
|
*/
|
|
656
723
|
EncryptionConfiguration?: EncryptionConfiguration;
|
|
657
724
|
/**
|
|
725
|
+
* @public
|
|
658
726
|
* <p>The CloudWatch logging options for your delivery stream.</p>
|
|
659
727
|
*/
|
|
660
728
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
|
@@ -666,40 +734,48 @@ export interface S3DestinationUpdate {
|
|
|
666
734
|
*/
|
|
667
735
|
export interface AmazonOpenSearchServerlessDestinationUpdate {
|
|
668
736
|
/**
|
|
737
|
+
* @public
|
|
669
738
|
* <p>The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose
|
|
670
739
|
* for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for
|
|
671
740
|
* indexing documents.</p>
|
|
672
741
|
*/
|
|
673
742
|
RoleARN?: string;
|
|
674
743
|
/**
|
|
744
|
+
* @public
|
|
675
745
|
* <p>The endpoint to use when communicating with the collection in the Serverless offering
|
|
676
746
|
* for Amazon OpenSearch Service.</p>
|
|
677
747
|
*/
|
|
678
748
|
CollectionEndpoint?: string;
|
|
679
749
|
/**
|
|
750
|
+
* @public
|
|
680
751
|
* <p>The Serverless offering for Amazon OpenSearch Service index name.</p>
|
|
681
752
|
*/
|
|
682
753
|
IndexName?: string;
|
|
683
754
|
/**
|
|
755
|
+
* @public
|
|
684
756
|
* <p>The buffering options. If no value is specified, AmazonopensearchBufferingHints object
|
|
685
757
|
* default values are used.</p>
|
|
686
758
|
*/
|
|
687
759
|
BufferingHints?: AmazonOpenSearchServerlessBufferingHints;
|
|
688
760
|
/**
|
|
761
|
+
* @public
|
|
689
762
|
* <p>The retry behavior in case Kinesis Data Firehose is unable to deliver documents to the
|
|
690
763
|
* Serverless offering for Amazon OpenSearch Service. The default value is 300 (5
|
|
691
764
|
* minutes).</p>
|
|
692
765
|
*/
|
|
693
766
|
RetryOptions?: AmazonOpenSearchServerlessRetryOptions;
|
|
694
767
|
/**
|
|
768
|
+
* @public
|
|
695
769
|
* <p>Describes an update for a destination in Amazon S3.</p>
|
|
696
770
|
*/
|
|
697
771
|
S3Update?: S3DestinationUpdate;
|
|
698
772
|
/**
|
|
773
|
+
* @public
|
|
699
774
|
* <p>Describes a data processing configuration.</p>
|
|
700
775
|
*/
|
|
701
776
|
ProcessingConfiguration?: ProcessingConfiguration;
|
|
702
777
|
/**
|
|
778
|
+
* @public
|
|
703
779
|
* <p>Describes the Amazon CloudWatch logging options for your delivery stream.</p>
|
|
704
780
|
*/
|
|
705
781
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
|
@@ -711,11 +787,13 @@ export interface AmazonOpenSearchServerlessDestinationUpdate {
|
|
|
711
787
|
*/
|
|
712
788
|
export interface AmazonopensearchserviceBufferingHints {
|
|
713
789
|
/**
|
|
790
|
+
* @public
|
|
714
791
|
* <p>Buffer incoming data for the specified period of time, in seconds, before delivering it
|
|
715
792
|
* to the destination. The default value is 300 (5 minutes). </p>
|
|
716
793
|
*/
|
|
717
794
|
IntervalInSeconds?: number;
|
|
718
795
|
/**
|
|
796
|
+
* @public
|
|
719
797
|
* <p>Buffer incoming data to the specified size, in MBs, before delivering it to the
|
|
720
798
|
* destination. The default value is 5.</p>
|
|
721
799
|
* <p>We recommend setting this parameter to a value greater than the amount of data you
|
|
@@ -746,6 +824,7 @@ export type AmazonopensearchserviceIndexRotationPeriod = (typeof Amazonopensearc
|
|
|
746
824
|
*/
|
|
747
825
|
export interface AmazonopensearchserviceRetryOptions {
|
|
748
826
|
/**
|
|
827
|
+
* @public
|
|
749
828
|
* <p>After an initial failure to deliver to Amazon OpenSearch Service, the total amount of
|
|
750
829
|
* time during which Kinesis Data Firehose retries delivery (including the first attempt).
|
|
751
830
|
* After this time has elapsed, the failed documents are written to Amazon S3. Default value
|
|
@@ -771,48 +850,57 @@ export type AmazonopensearchserviceS3BackupMode = (typeof Amazonopensearchservic
|
|
|
771
850
|
*/
|
|
772
851
|
export interface AmazonopensearchserviceDestinationConfiguration {
|
|
773
852
|
/**
|
|
853
|
+
* @public
|
|
774
854
|
* <p>The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose
|
|
775
855
|
* for calling the Amazon OpenSearch Service Configuration API and for indexing
|
|
776
856
|
* documents.</p>
|
|
777
857
|
*/
|
|
778
858
|
RoleARN: string | undefined;
|
|
779
859
|
/**
|
|
860
|
+
* @public
|
|
780
861
|
* <p>The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions for
|
|
781
862
|
* DescribeElasticsearchDomain, DescribeElasticsearchDomains, and
|
|
782
863
|
* DescribeElasticsearchDomainConfig after assuming the role specified in RoleARN. </p>
|
|
783
864
|
*/
|
|
784
865
|
DomainARN?: string;
|
|
785
866
|
/**
|
|
867
|
+
* @public
|
|
786
868
|
* <p>The endpoint to use when communicating with the cluster. Specify either this
|
|
787
869
|
* ClusterEndpoint or the DomainARN field. </p>
|
|
788
870
|
*/
|
|
789
871
|
ClusterEndpoint?: string;
|
|
790
872
|
/**
|
|
873
|
+
* @public
|
|
791
874
|
* <p>The ElasticsearAmazon OpenSearch Service index name.</p>
|
|
792
875
|
*/
|
|
793
876
|
IndexName: string | undefined;
|
|
794
877
|
/**
|
|
878
|
+
* @public
|
|
795
879
|
* <p>The Amazon OpenSearch Service type name. For Elasticsearch 6.x, there can be only one
|
|
796
880
|
* type per index. If you try to specify a new type for an existing index that already has
|
|
797
881
|
* another type, Kinesis Data Firehose returns an error during run time. </p>
|
|
798
882
|
*/
|
|
799
883
|
TypeName?: string;
|
|
800
884
|
/**
|
|
885
|
+
* @public
|
|
801
886
|
* <p>The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp
|
|
802
887
|
* to the IndexName to facilitate the expiration of old data.</p>
|
|
803
888
|
*/
|
|
804
889
|
IndexRotationPeriod?: AmazonopensearchserviceIndexRotationPeriod | string;
|
|
805
890
|
/**
|
|
891
|
+
* @public
|
|
806
892
|
* <p>The buffering options. If no value is specified, the default values for
|
|
807
893
|
* AmazonopensearchserviceBufferingHints are used. </p>
|
|
808
894
|
*/
|
|
809
895
|
BufferingHints?: AmazonopensearchserviceBufferingHints;
|
|
810
896
|
/**
|
|
897
|
+
* @public
|
|
811
898
|
* <p>The retry behavior in case Kinesis Data Firehose is unable to deliver documents to
|
|
812
899
|
* Amazon OpenSearch Service. The default value is 300 (5 minutes). </p>
|
|
813
900
|
*/
|
|
814
901
|
RetryOptions?: AmazonopensearchserviceRetryOptions;
|
|
815
902
|
/**
|
|
903
|
+
* @public
|
|
816
904
|
* <p>Defines how documents should be delivered to Amazon S3. When it is set to
|
|
817
905
|
* FailedDocumentsOnly, Kinesis Data Firehose writes any documents that could not be indexed
|
|
818
906
|
* to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to
|
|
@@ -822,18 +910,22 @@ export interface AmazonopensearchserviceDestinationConfiguration {
|
|
|
822
910
|
*/
|
|
823
911
|
S3BackupMode?: AmazonopensearchserviceS3BackupMode | string;
|
|
824
912
|
/**
|
|
913
|
+
* @public
|
|
825
914
|
* <p>Describes the configuration of a destination in Amazon S3.</p>
|
|
826
915
|
*/
|
|
827
916
|
S3Configuration: S3DestinationConfiguration | undefined;
|
|
828
917
|
/**
|
|
918
|
+
* @public
|
|
829
919
|
* <p>Describes a data processing configuration.</p>
|
|
830
920
|
*/
|
|
831
921
|
ProcessingConfiguration?: ProcessingConfiguration;
|
|
832
922
|
/**
|
|
923
|
+
* @public
|
|
833
924
|
* <p>Describes the Amazon CloudWatch logging options for your delivery stream.</p>
|
|
834
925
|
*/
|
|
835
926
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
|
836
927
|
/**
|
|
928
|
+
* @public
|
|
837
929
|
* <p>The details of the VPC of the Amazon ES destination.</p>
|
|
838
930
|
*/
|
|
839
931
|
VpcConfiguration?: VpcConfiguration;
|
|
@@ -844,57 +936,70 @@ export interface AmazonopensearchserviceDestinationConfiguration {
|
|
|
844
936
|
*/
|
|
845
937
|
export interface AmazonopensearchserviceDestinationDescription {
|
|
846
938
|
/**
|
|
939
|
+
* @public
|
|
847
940
|
* <p>The Amazon Resource Name (ARN) of the Amazon Web Services credentials. </p>
|
|
848
941
|
*/
|
|
849
942
|
RoleARN?: string;
|
|
850
943
|
/**
|
|
944
|
+
* @public
|
|
851
945
|
* <p>The ARN of the Amazon OpenSearch Service domain.</p>
|
|
852
946
|
*/
|
|
853
947
|
DomainARN?: string;
|
|
854
948
|
/**
|
|
949
|
+
* @public
|
|
855
950
|
* <p>The endpoint to use when communicating with the cluster. Kinesis Data Firehose uses
|
|
856
951
|
* either this ClusterEndpoint or the DomainARN field to send data to Amazon OpenSearch
|
|
857
952
|
* Service. </p>
|
|
858
953
|
*/
|
|
859
954
|
ClusterEndpoint?: string;
|
|
860
955
|
/**
|
|
956
|
+
* @public
|
|
861
957
|
* <p>The Amazon OpenSearch Service index name.</p>
|
|
862
958
|
*/
|
|
863
959
|
IndexName?: string;
|
|
864
960
|
/**
|
|
961
|
+
* @public
|
|
865
962
|
* <p>The Amazon OpenSearch Service type name. This applies to Elasticsearch 6.x and lower
|
|
866
963
|
* versions. For Elasticsearch 7.x and OpenSearch Service 1.x, there's no value for TypeName. </p>
|
|
867
964
|
*/
|
|
868
965
|
TypeName?: string;
|
|
869
966
|
/**
|
|
967
|
+
* @public
|
|
870
968
|
* <p>The Amazon OpenSearch Service index rotation period</p>
|
|
871
969
|
*/
|
|
872
970
|
IndexRotationPeriod?: AmazonopensearchserviceIndexRotationPeriod | string;
|
|
873
971
|
/**
|
|
972
|
+
* @public
|
|
874
973
|
* <p>The buffering options.</p>
|
|
875
974
|
*/
|
|
876
975
|
BufferingHints?: AmazonopensearchserviceBufferingHints;
|
|
877
976
|
/**
|
|
977
|
+
* @public
|
|
878
978
|
* <p>The Amazon OpenSearch Service retry options.</p>
|
|
879
979
|
*/
|
|
880
980
|
RetryOptions?: AmazonopensearchserviceRetryOptions;
|
|
881
981
|
/**
|
|
982
|
+
* @public
|
|
882
983
|
* <p>The Amazon S3 backup mode.</p>
|
|
883
984
|
*/
|
|
884
985
|
S3BackupMode?: AmazonopensearchserviceS3BackupMode | string;
|
|
885
986
|
/**
|
|
987
|
+
* @public
|
|
886
988
|
* <p>Describes a destination in Amazon S3.</p>
|
|
887
989
|
*/
|
|
888
990
|
S3DestinationDescription?: S3DestinationDescription;
|
|
889
991
|
/**
|
|
992
|
+
* @public
|
|
890
993
|
* <p>Describes a data processing configuration.</p>
|
|
891
994
|
*/
|
|
892
995
|
ProcessingConfiguration?: ProcessingConfiguration;
|
|
893
996
|
/**
|
|
997
|
+
* @public
|
|
894
998
|
* <p>Describes the Amazon CloudWatch logging options for your delivery stream.</p>
|
|
895
999
|
*/
|
|
896
1000
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
|
897
1001
|
/**
|
|
1002
|
+
* @public
|
|
898
1003
|
* <p>The details of the VPC of the Amazon ES destination.</p>
|
|
899
1004
|
*/
|
|
900
1005
|
VpcConfigurationDescription?: VpcConfigurationDescription;
|
|
@@ -905,27 +1010,32 @@ export interface AmazonopensearchserviceDestinationDescription {
|
|
|
905
1010
|
*/
|
|
906
1011
|
export interface AmazonopensearchserviceDestinationUpdate {
|
|
907
1012
|
/**
|
|
1013
|
+
* @public
|
|
908
1014
|
* <p>The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose
|
|
909
1015
|
* for calling the Amazon OpenSearch Service Configuration API and for indexing documents.
|
|
910
1016
|
* </p>
|
|
911
1017
|
*/
|
|
912
1018
|
RoleARN?: string;
|
|
913
1019
|
/**
|
|
1020
|
+
* @public
|
|
914
1021
|
* <p>The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions for
|
|
915
1022
|
* DescribeDomain, DescribeDomains, and DescribeDomainConfig after assuming the IAM role
|
|
916
1023
|
* specified in RoleARN.</p>
|
|
917
1024
|
*/
|
|
918
1025
|
DomainARN?: string;
|
|
919
1026
|
/**
|
|
1027
|
+
* @public
|
|
920
1028
|
* <p>The endpoint to use when communicating with the cluster. Specify either this
|
|
921
1029
|
* ClusterEndpoint or the DomainARN field. </p>
|
|
922
1030
|
*/
|
|
923
1031
|
ClusterEndpoint?: string;
|
|
924
1032
|
/**
|
|
1033
|
+
* @public
|
|
925
1034
|
* <p>The Amazon OpenSearch Service index name.</p>
|
|
926
1035
|
*/
|
|
927
1036
|
IndexName?: string;
|
|
928
1037
|
/**
|
|
1038
|
+
* @public
|
|
929
1039
|
* <p>The Amazon OpenSearch Service type name. For Elasticsearch 6.x, there can be only one
|
|
930
1040
|
* type per index. If you try to specify a new type for an existing index that already has
|
|
931
1041
|
* another type, Kinesis Data Firehose returns an error during runtime. </p>
|
|
@@ -936,29 +1046,35 @@ export interface AmazonopensearchserviceDestinationUpdate {
|
|
|
936
1046
|
*/
|
|
937
1047
|
TypeName?: string;
|
|
938
1048
|
/**
|
|
1049
|
+
* @public
|
|
939
1050
|
* <p>The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp
|
|
940
1051
|
* to IndexName to facilitate the expiration of old data.</p>
|
|
941
1052
|
*/
|
|
942
1053
|
IndexRotationPeriod?: AmazonopensearchserviceIndexRotationPeriod | string;
|
|
943
1054
|
/**
|
|
1055
|
+
* @public
|
|
944
1056
|
* <p>The buffering options. If no value is specified, AmazonopensearchBufferingHints object
|
|
945
1057
|
* default values are used. </p>
|
|
946
1058
|
*/
|
|
947
1059
|
BufferingHints?: AmazonopensearchserviceBufferingHints;
|
|
948
1060
|
/**
|
|
1061
|
+
* @public
|
|
949
1062
|
* <p>The retry behavior in case Kinesis Data Firehose is unable to deliver documents to
|
|
950
1063
|
* Amazon OpenSearch Service. The default value is 300 (5 minutes). </p>
|
|
951
1064
|
*/
|
|
952
1065
|
RetryOptions?: AmazonopensearchserviceRetryOptions;
|
|
953
1066
|
/**
|
|
1067
|
+
* @public
|
|
954
1068
|
* <p>Describes an update for a destination in Amazon S3.</p>
|
|
955
1069
|
*/
|
|
956
1070
|
S3Update?: S3DestinationUpdate;
|
|
957
1071
|
/**
|
|
1072
|
+
* @public
|
|
958
1073
|
* <p>Describes a data processing configuration.</p>
|
|
959
1074
|
*/
|
|
960
1075
|
ProcessingConfiguration?: ProcessingConfiguration;
|
|
961
1076
|
/**
|
|
1077
|
+
* @public
|
|
962
1078
|
* <p>Describes the Amazon CloudWatch logging options for your delivery stream.</p>
|
|
963
1079
|
*/
|
|
964
1080
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
|
@@ -994,14 +1110,17 @@ export type ContentEncoding = (typeof ContentEncoding)[keyof typeof ContentEncod
|
|
|
994
1110
|
*/
|
|
995
1111
|
export interface CopyCommand {
|
|
996
1112
|
/**
|
|
1113
|
+
* @public
|
|
997
1114
|
* <p>The name of the target table. The table must already exist in the database.</p>
|
|
998
1115
|
*/
|
|
999
1116
|
DataTableName: string | undefined;
|
|
1000
1117
|
/**
|
|
1118
|
+
* @public
|
|
1001
1119
|
* <p>A comma-separated list of column names.</p>
|
|
1002
1120
|
*/
|
|
1003
1121
|
DataTableColumns?: string;
|
|
1004
1122
|
/**
|
|
1123
|
+
* @public
|
|
1005
1124
|
* <p>Optional parameters to use with the Amazon Redshift <code>COPY</code> command. For
|
|
1006
1125
|
* more information, see the "Optional Parameters" section of <a href="https://docs.aws.amazon.com/redshift/latest/dg/r_COPY.html">Amazon Redshift COPY command</a>. Some possible
|
|
1007
1126
|
* examples that would apply to Kinesis Data Firehose are as follows:</p>
|
|
@@ -1044,11 +1163,13 @@ export type KeyType = (typeof KeyType)[keyof typeof KeyType];
|
|
|
1044
1163
|
*/
|
|
1045
1164
|
export interface DeliveryStreamEncryptionConfigurationInput {
|
|
1046
1165
|
/**
|
|
1166
|
+
* @public
|
|
1047
1167
|
* <p>If you set <code>KeyType</code> to <code>CUSTOMER_MANAGED_CMK</code>, you must specify
|
|
1048
1168
|
* the Amazon Resource Name (ARN) of the CMK. If you set <code>KeyType</code> to <code>Amazon Web Services_OWNED_CMK</code>, Kinesis Data Firehose uses a service-account CMK.</p>
|
|
1049
1169
|
*/
|
|
1050
1170
|
KeyARN?: string;
|
|
1051
1171
|
/**
|
|
1172
|
+
* @public
|
|
1052
1173
|
* <p>Indicates the type of customer master key (CMK) to use for encryption. The default
|
|
1053
1174
|
* setting is <code>Amazon Web Services_OWNED_CMK</code>. For more information about CMKs, see
|
|
1054
1175
|
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys">Customer Master Keys (CMKs)</a>. When you invoke <a>CreateDeliveryStream</a> or <a>StartDeliveryStreamEncryption</a> with
|
|
@@ -1091,11 +1212,13 @@ export type DeliveryStreamType = (typeof DeliveryStreamType)[keyof typeof Delive
|
|
|
1091
1212
|
*/
|
|
1092
1213
|
export interface ElasticsearchBufferingHints {
|
|
1093
1214
|
/**
|
|
1215
|
+
* @public
|
|
1094
1216
|
* <p>Buffer incoming data for the specified period of time, in seconds, before delivering
|
|
1095
1217
|
* it to the destination. The default value is 300 (5 minutes).</p>
|
|
1096
1218
|
*/
|
|
1097
1219
|
IntervalInSeconds?: number;
|
|
1098
1220
|
/**
|
|
1221
|
+
* @public
|
|
1099
1222
|
* <p>Buffer incoming data to the specified size, in MBs, before delivering it to the
|
|
1100
1223
|
* destination. The default value is 5.</p>
|
|
1101
1224
|
* <p>We recommend setting this parameter to a value greater than the amount of data you
|
|
@@ -1126,6 +1249,7 @@ export type ElasticsearchIndexRotationPeriod = (typeof ElasticsearchIndexRotatio
|
|
|
1126
1249
|
*/
|
|
1127
1250
|
export interface ElasticsearchRetryOptions {
|
|
1128
1251
|
/**
|
|
1252
|
+
* @public
|
|
1129
1253
|
* <p>After an initial failure to deliver to Amazon ES, the total amount of time during
|
|
1130
1254
|
* which Kinesis Data Firehose retries delivery (including the first attempt). After this time
|
|
1131
1255
|
* has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds (5
|
|
@@ -1151,6 +1275,7 @@ export type ElasticsearchS3BackupMode = (typeof ElasticsearchS3BackupMode)[keyof
|
|
|
1151
1275
|
*/
|
|
1152
1276
|
export interface ElasticsearchDestinationConfiguration {
|
|
1153
1277
|
/**
|
|
1278
|
+
* @public
|
|
1154
1279
|
* <p>The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose
|
|
1155
1280
|
* for calling the Amazon ES Configuration API and for indexing documents. For more
|
|
1156
1281
|
* information, see <a href="https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3">Grant Kinesis Data
|
|
@@ -1159,6 +1284,7 @@ export interface ElasticsearchDestinationConfiguration {
|
|
|
1159
1284
|
*/
|
|
1160
1285
|
RoleARN: string | undefined;
|
|
1161
1286
|
/**
|
|
1287
|
+
* @public
|
|
1162
1288
|
* <p>The ARN of the Amazon ES domain. The IAM role must have permissions
|
|
1163
1289
|
* for <code>DescribeDomain</code>, <code>DescribeDomains</code>, and
|
|
1164
1290
|
* <code>DescribeDomainConfig</code> after assuming the role specified in <b>RoleARN</b>. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and
|
|
@@ -1168,15 +1294,18 @@ export interface ElasticsearchDestinationConfiguration {
|
|
|
1168
1294
|
*/
|
|
1169
1295
|
DomainARN?: string;
|
|
1170
1296
|
/**
|
|
1297
|
+
* @public
|
|
1171
1298
|
* <p>The endpoint to use when communicating with the cluster. Specify either this
|
|
1172
1299
|
* <code>ClusterEndpoint</code> or the <code>DomainARN</code> field.</p>
|
|
1173
1300
|
*/
|
|
1174
1301
|
ClusterEndpoint?: string;
|
|
1175
1302
|
/**
|
|
1303
|
+
* @public
|
|
1176
1304
|
* <p>The Elasticsearch index name.</p>
|
|
1177
1305
|
*/
|
|
1178
1306
|
IndexName: string | undefined;
|
|
1179
1307
|
/**
|
|
1308
|
+
* @public
|
|
1180
1309
|
* <p>The Elasticsearch type name. For Elasticsearch 6.x, there can be only one type per
|
|
1181
1310
|
* index. If you try to specify a new type for an existing index that already has another
|
|
1182
1311
|
* type, Kinesis Data Firehose returns an error during run time.</p>
|
|
@@ -1185,6 +1314,7 @@ export interface ElasticsearchDestinationConfiguration {
|
|
|
1185
1314
|
*/
|
|
1186
1315
|
TypeName?: string;
|
|
1187
1316
|
/**
|
|
1317
|
+
* @public
|
|
1188
1318
|
* <p>The Elasticsearch index rotation period. Index rotation appends a timestamp to the
|
|
1189
1319
|
* <code>IndexName</code> to facilitate the expiration of old data. For more information,
|
|
1190
1320
|
* see <a href="https://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-index-rotation">Index Rotation for the
|
|
@@ -1192,16 +1322,19 @@ export interface ElasticsearchDestinationConfiguration {
|
|
|
1192
1322
|
*/
|
|
1193
1323
|
IndexRotationPeriod?: ElasticsearchIndexRotationPeriod | string;
|
|
1194
1324
|
/**
|
|
1325
|
+
* @public
|
|
1195
1326
|
* <p>The buffering options. If no value is specified, the default values for
|
|
1196
1327
|
* <code>ElasticsearchBufferingHints</code> are used.</p>
|
|
1197
1328
|
*/
|
|
1198
1329
|
BufferingHints?: ElasticsearchBufferingHints;
|
|
1199
1330
|
/**
|
|
1331
|
+
* @public
|
|
1200
1332
|
* <p>The retry behavior in case Kinesis Data Firehose is unable to deliver documents to
|
|
1201
1333
|
* Amazon ES. The default value is 300 (5 minutes).</p>
|
|
1202
1334
|
*/
|
|
1203
1335
|
RetryOptions?: ElasticsearchRetryOptions;
|
|
1204
1336
|
/**
|
|
1337
|
+
* @public
|
|
1205
1338
|
* <p>Defines how documents should be delivered to Amazon S3. When it is set to
|
|
1206
1339
|
* <code>FailedDocumentsOnly</code>, Kinesis Data Firehose writes any documents that could
|
|
1207
1340
|
* not be indexed to the configured Amazon S3 destination, with
|
|
@@ -1215,18 +1348,22 @@ export interface ElasticsearchDestinationConfiguration {
|
|
|
1215
1348
|
*/
|
|
1216
1349
|
S3BackupMode?: ElasticsearchS3BackupMode | string;
|
|
1217
1350
|
/**
|
|
1351
|
+
* @public
|
|
1218
1352
|
* <p>The configuration for the backup Amazon S3 location.</p>
|
|
1219
1353
|
*/
|
|
1220
1354
|
S3Configuration: S3DestinationConfiguration | undefined;
|
|
1221
1355
|
/**
|
|
1356
|
+
* @public
|
|
1222
1357
|
* <p>The data processing configuration.</p>
|
|
1223
1358
|
*/
|
|
1224
1359
|
ProcessingConfiguration?: ProcessingConfiguration;
|
|
1225
1360
|
/**
|
|
1361
|
+
* @public
|
|
1226
1362
|
* <p>The Amazon CloudWatch logging options for your delivery stream.</p>
|
|
1227
1363
|
*/
|
|
1228
1364
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
|
1229
1365
|
/**
|
|
1366
|
+
* @public
|
|
1230
1367
|
* <p>The details of the VPC of the Amazon ES destination.</p>
|
|
1231
1368
|
*/
|
|
1232
1369
|
VpcConfiguration?: VpcConfiguration;
|
|
@@ -1240,6 +1377,7 @@ export interface ElasticsearchDestinationConfiguration {
|
|
|
1240
1377
|
*/
|
|
1241
1378
|
export interface HiveJsonSerDe {
|
|
1242
1379
|
/**
|
|
1380
|
+
* @public
|
|
1243
1381
|
* <p>Indicates how you want Kinesis Data Firehose to parse the date and timestamps that
|
|
1244
1382
|
* may be present in your input data JSON. To specify these format strings, follow the pattern
|
|
1245
1383
|
* syntax of JodaTime's DateTimeFormat format strings. For more information, see <a href="https://www.joda.org/joda-time/apidocs/org/joda/time/format/DateTimeFormat.html">Class DateTimeFormat</a>. You can also use the special value <code>millis</code> to
|
|
@@ -1257,6 +1395,7 @@ export interface HiveJsonSerDe {
|
|
|
1257
1395
|
*/
|
|
1258
1396
|
export interface OpenXJsonSerDe {
|
|
1259
1397
|
/**
|
|
1398
|
+
* @public
|
|
1260
1399
|
* <p>When set to <code>true</code>, specifies that the names of the keys include dots and
|
|
1261
1400
|
* that you want Kinesis Data Firehose to replace them with underscores. This is useful
|
|
1262
1401
|
* because Apache Hive does not allow dots in column names. For example, if the JSON contains
|
|
@@ -1266,11 +1405,13 @@ export interface OpenXJsonSerDe {
|
|
|
1266
1405
|
*/
|
|
1267
1406
|
ConvertDotsInJsonKeysToUnderscores?: boolean;
|
|
1268
1407
|
/**
|
|
1408
|
+
* @public
|
|
1269
1409
|
* <p>When set to <code>true</code>, which is the default, Kinesis Data Firehose converts
|
|
1270
1410
|
* JSON keys to lowercase before deserializing them.</p>
|
|
1271
1411
|
*/
|
|
1272
1412
|
CaseInsensitive?: boolean;
|
|
1273
1413
|
/**
|
|
1414
|
+
* @public
|
|
1274
1415
|
* <p>Maps column names to JSON keys that aren't identical to the column names. This is
|
|
1275
1416
|
* useful when the JSON contains keys that are Hive keywords. For example,
|
|
1276
1417
|
* <code>timestamp</code> is a Hive keyword. If you have a JSON key named
|
|
@@ -1288,6 +1429,7 @@ export interface OpenXJsonSerDe {
|
|
|
1288
1429
|
*/
|
|
1289
1430
|
export interface Deserializer {
|
|
1290
1431
|
/**
|
|
1432
|
+
* @public
|
|
1291
1433
|
* <p>The OpenX SerDe. Used by Kinesis Data Firehose for deserializing data, which means
|
|
1292
1434
|
* converting it from the JSON format in preparation for serializing it to the Parquet or ORC
|
|
1293
1435
|
* format. This is one of two deserializers you can choose, depending on which one offers the
|
|
@@ -1295,6 +1437,7 @@ export interface Deserializer {
|
|
|
1295
1437
|
*/
|
|
1296
1438
|
OpenXJsonSerDe?: OpenXJsonSerDe;
|
|
1297
1439
|
/**
|
|
1440
|
+
* @public
|
|
1298
1441
|
* <p>The native Hive / HCatalog JsonSerDe. Used by Kinesis Data Firehose for deserializing
|
|
1299
1442
|
* data, which means converting it from the JSON format in preparation for serializing it to
|
|
1300
1443
|
* the Parquet or ORC format. This is one of two deserializers you can choose, depending on
|
|
@@ -1309,6 +1452,7 @@ export interface Deserializer {
|
|
|
1309
1452
|
*/
|
|
1310
1453
|
export interface InputFormatConfiguration {
|
|
1311
1454
|
/**
|
|
1455
|
+
* @public
|
|
1312
1456
|
* <p>Specifies which deserializer to use. You can choose either the Apache Hive JSON SerDe
|
|
1313
1457
|
* or the OpenX JSON SerDe. If both are non-null, the server rejects the request.</p>
|
|
1314
1458
|
*/
|
|
@@ -1347,28 +1491,33 @@ export type OrcFormatVersion = (typeof OrcFormatVersion)[keyof typeof OrcFormatV
|
|
|
1347
1491
|
*/
|
|
1348
1492
|
export interface OrcSerDe {
|
|
1349
1493
|
/**
|
|
1494
|
+
* @public
|
|
1350
1495
|
* <p>The number of bytes in each stripe. The default is 64 MiB and the minimum is 8
|
|
1351
1496
|
* MiB.</p>
|
|
1352
1497
|
*/
|
|
1353
1498
|
StripeSizeBytes?: number;
|
|
1354
1499
|
/**
|
|
1500
|
+
* @public
|
|
1355
1501
|
* <p>The Hadoop Distributed File System (HDFS) block size. This is useful if you intend to
|
|
1356
1502
|
* copy the data from Amazon S3 to HDFS before querying. The default is 256 MiB and the
|
|
1357
1503
|
* minimum is 64 MiB. Kinesis Data Firehose uses this value for padding calculations.</p>
|
|
1358
1504
|
*/
|
|
1359
1505
|
BlockSizeBytes?: number;
|
|
1360
1506
|
/**
|
|
1507
|
+
* @public
|
|
1361
1508
|
* <p>The number of rows between index entries. The default is 10,000 and the minimum is
|
|
1362
1509
|
* 1,000.</p>
|
|
1363
1510
|
*/
|
|
1364
1511
|
RowIndexStride?: number;
|
|
1365
1512
|
/**
|
|
1513
|
+
* @public
|
|
1366
1514
|
* <p>Set this to <code>true</code> to indicate that you want stripes to be padded to the HDFS
|
|
1367
1515
|
* block boundaries. This is useful if you intend to copy the data from Amazon S3 to HDFS
|
|
1368
1516
|
* before querying. The default is <code>false</code>.</p>
|
|
1369
1517
|
*/
|
|
1370
1518
|
EnablePadding?: boolean;
|
|
1371
1519
|
/**
|
|
1520
|
+
* @public
|
|
1372
1521
|
* <p>A number between 0 and 1 that defines the tolerance for block padding as a decimal
|
|
1373
1522
|
* fraction of stripe size. The default value is 0.05, which means 5 percent of stripe
|
|
1374
1523
|
* size.</p>
|
|
@@ -1381,26 +1530,31 @@ export interface OrcSerDe {
|
|
|
1381
1530
|
*/
|
|
1382
1531
|
PaddingTolerance?: number;
|
|
1383
1532
|
/**
|
|
1533
|
+
* @public
|
|
1384
1534
|
* <p>The compression code to use over data blocks. The default is <code>SNAPPY</code>.</p>
|
|
1385
1535
|
*/
|
|
1386
1536
|
Compression?: OrcCompression | string;
|
|
1387
1537
|
/**
|
|
1538
|
+
* @public
|
|
1388
1539
|
* <p>The column names for which you want Kinesis Data Firehose to create bloom filters. The
|
|
1389
1540
|
* default is <code>null</code>.</p>
|
|
1390
1541
|
*/
|
|
1391
1542
|
BloomFilterColumns?: string[];
|
|
1392
1543
|
/**
|
|
1544
|
+
* @public
|
|
1393
1545
|
* <p>The Bloom filter false positive probability (FPP). The lower the FPP, the bigger the
|
|
1394
1546
|
* Bloom filter. The default value is 0.05, the minimum is 0, and the maximum is 1.</p>
|
|
1395
1547
|
*/
|
|
1396
1548
|
BloomFilterFalsePositiveProbability?: number;
|
|
1397
1549
|
/**
|
|
1550
|
+
* @public
|
|
1398
1551
|
* <p>Represents the fraction of the total number of non-null rows. To turn off dictionary
|
|
1399
1552
|
* encoding, set this fraction to a number that is less than the number of distinct keys in a
|
|
1400
1553
|
* dictionary. To always use dictionary encoding, set this threshold to 1.</p>
|
|
1401
1554
|
*/
|
|
1402
1555
|
DictionaryKeyThreshold?: number;
|
|
1403
1556
|
/**
|
|
1557
|
+
* @public
|
|
1404
1558
|
* <p>The version of the file to write. The possible values are <code>V0_11</code> and
|
|
1405
1559
|
* <code>V0_12</code>. The default is <code>V0_12</code>.</p>
|
|
1406
1560
|
*/
|
|
@@ -1438,18 +1592,21 @@ export type ParquetWriterVersion = (typeof ParquetWriterVersion)[keyof typeof Pa
|
|
|
1438
1592
|
*/
|
|
1439
1593
|
export interface ParquetSerDe {
|
|
1440
1594
|
/**
|
|
1595
|
+
* @public
|
|
1441
1596
|
* <p>The Hadoop Distributed File System (HDFS) block size. This is useful if you intend to
|
|
1442
1597
|
* copy the data from Amazon S3 to HDFS before querying. The default is 256 MiB and the
|
|
1443
1598
|
* minimum is 64 MiB. Kinesis Data Firehose uses this value for padding calculations.</p>
|
|
1444
1599
|
*/
|
|
1445
1600
|
BlockSizeBytes?: number;
|
|
1446
1601
|
/**
|
|
1602
|
+
* @public
|
|
1447
1603
|
* <p>The Parquet page size. Column chunks are divided into pages. A page is conceptually an
|
|
1448
1604
|
* indivisible unit (in terms of compression and encoding). The minimum value is 64 KiB and
|
|
1449
1605
|
* the default is 1 MiB.</p>
|
|
1450
1606
|
*/
|
|
1451
1607
|
PageSizeBytes?: number;
|
|
1452
1608
|
/**
|
|
1609
|
+
* @public
|
|
1453
1610
|
* <p>The compression code to use over data blocks. The possible values are
|
|
1454
1611
|
* <code>UNCOMPRESSED</code>, <code>SNAPPY</code>, and <code>GZIP</code>, with the default
|
|
1455
1612
|
* being <code>SNAPPY</code>. Use <code>SNAPPY</code> for higher decompression speed. Use
|
|
@@ -1457,15 +1614,18 @@ export interface ParquetSerDe {
|
|
|
1457
1614
|
*/
|
|
1458
1615
|
Compression?: ParquetCompression | string;
|
|
1459
1616
|
/**
|
|
1617
|
+
* @public
|
|
1460
1618
|
* <p>Indicates whether to enable dictionary compression.</p>
|
|
1461
1619
|
*/
|
|
1462
1620
|
EnableDictionaryCompression?: boolean;
|
|
1463
1621
|
/**
|
|
1622
|
+
* @public
|
|
1464
1623
|
* <p>The maximum amount of padding to apply. This is useful if you intend to copy the data
|
|
1465
1624
|
* from Amazon S3 to HDFS before querying. The default is 0.</p>
|
|
1466
1625
|
*/
|
|
1467
1626
|
MaxPaddingBytes?: number;
|
|
1468
1627
|
/**
|
|
1628
|
+
* @public
|
|
1469
1629
|
* <p>Indicates the version of row format to output. The possible values are <code>V1</code>
|
|
1470
1630
|
* and <code>V2</code>. The default is <code>V1</code>.</p>
|
|
1471
1631
|
*/
|
|
@@ -1479,11 +1639,13 @@ export interface ParquetSerDe {
|
|
|
1479
1639
|
*/
|
|
1480
1640
|
export interface Serializer {
|
|
1481
1641
|
/**
|
|
1642
|
+
* @public
|
|
1482
1643
|
* <p>A serializer to use for converting data to the Parquet format before storing it in
|
|
1483
1644
|
* Amazon S3. For more information, see <a href="https://parquet.apache.org/documentation/latest/">Apache Parquet</a>.</p>
|
|
1484
1645
|
*/
|
|
1485
1646
|
ParquetSerDe?: ParquetSerDe;
|
|
1486
1647
|
/**
|
|
1648
|
+
* @public
|
|
1487
1649
|
* <p>A serializer to use for converting data to the ORC format before storing it in Amazon
|
|
1488
1650
|
* S3. For more information, see <a href="https://orc.apache.org/docs/">Apache
|
|
1489
1651
|
* ORC</a>.</p>
|
|
@@ -1498,6 +1660,7 @@ export interface Serializer {
|
|
|
1498
1660
|
*/
|
|
1499
1661
|
export interface OutputFormatConfiguration {
|
|
1500
1662
|
/**
|
|
1663
|
+
* @public
|
|
1501
1664
|
* <p>Specifies which serializer to use. You can choose either the ORC SerDe or the Parquet
|
|
1502
1665
|
* SerDe. If both are non-null, the server rejects the request.</p>
|
|
1503
1666
|
*/
|
|
@@ -1511,6 +1674,7 @@ export interface OutputFormatConfiguration {
|
|
|
1511
1674
|
*/
|
|
1512
1675
|
export interface SchemaConfiguration {
|
|
1513
1676
|
/**
|
|
1677
|
+
* @public
|
|
1514
1678
|
* <p>The role that Kinesis Data Firehose can use to access Amazon Web Services Glue. This
|
|
1515
1679
|
* role must be in the same account you use for Kinesis Data Firehose. Cross-account roles
|
|
1516
1680
|
* aren't allowed.</p>
|
|
@@ -1522,11 +1686,13 @@ export interface SchemaConfiguration {
|
|
|
1522
1686
|
*/
|
|
1523
1687
|
RoleARN?: string;
|
|
1524
1688
|
/**
|
|
1689
|
+
* @public
|
|
1525
1690
|
* <p>The ID of the Amazon Web Services Glue Data Catalog. If you don't supply this, the
|
|
1526
1691
|
* Amazon Web Services account ID is used by default.</p>
|
|
1527
1692
|
*/
|
|
1528
1693
|
CatalogId?: string;
|
|
1529
1694
|
/**
|
|
1695
|
+
* @public
|
|
1530
1696
|
* <p>Specifies the name of the Amazon Web Services Glue database that contains the schema for
|
|
1531
1697
|
* the output data.</p>
|
|
1532
1698
|
* <important>
|
|
@@ -1537,6 +1703,7 @@ export interface SchemaConfiguration {
|
|
|
1537
1703
|
*/
|
|
1538
1704
|
DatabaseName?: string;
|
|
1539
1705
|
/**
|
|
1706
|
+
* @public
|
|
1540
1707
|
* <p>Specifies the Amazon Web Services Glue table that contains the column information that
|
|
1541
1708
|
* constitutes your data schema.</p>
|
|
1542
1709
|
* <important>
|
|
@@ -1547,11 +1714,13 @@ export interface SchemaConfiguration {
|
|
|
1547
1714
|
*/
|
|
1548
1715
|
TableName?: string;
|
|
1549
1716
|
/**
|
|
1717
|
+
* @public
|
|
1550
1718
|
* <p>If you don't specify an Amazon Web Services Region, the default is the current
|
|
1551
1719
|
* Region.</p>
|
|
1552
1720
|
*/
|
|
1553
1721
|
Region?: string;
|
|
1554
1722
|
/**
|
|
1723
|
+
* @public
|
|
1555
1724
|
* <p>Specifies the table version for the output data schema. If you don't specify this
|
|
1556
1725
|
* version ID, or if you set it to <code>LATEST</code>, Kinesis Data Firehose uses the most
|
|
1557
1726
|
* recent version. This means that any updates to the table are automatically picked
|
|
@@ -1570,23 +1739,27 @@ export interface SchemaConfiguration {
|
|
|
1570
1739
|
*/
|
|
1571
1740
|
export interface DataFormatConversionConfiguration {
|
|
1572
1741
|
/**
|
|
1742
|
+
* @public
|
|
1573
1743
|
* <p>Specifies the Amazon Web Services Glue Data Catalog table that contains the column
|
|
1574
1744
|
* information. This parameter is required if <code>Enabled</code> is set to true.</p>
|
|
1575
1745
|
*/
|
|
1576
1746
|
SchemaConfiguration?: SchemaConfiguration;
|
|
1577
1747
|
/**
|
|
1748
|
+
* @public
|
|
1578
1749
|
* <p>Specifies the deserializer that you want Kinesis Data Firehose to use to convert the
|
|
1579
1750
|
* format of your data from JSON. This parameter is required if <code>Enabled</code> is set to
|
|
1580
1751
|
* true.</p>
|
|
1581
1752
|
*/
|
|
1582
1753
|
InputFormatConfiguration?: InputFormatConfiguration;
|
|
1583
1754
|
/**
|
|
1755
|
+
* @public
|
|
1584
1756
|
* <p>Specifies the serializer that you want Kinesis Data Firehose to use to convert the
|
|
1585
1757
|
* format of your data to the Parquet or ORC format. This parameter is required if
|
|
1586
1758
|
* <code>Enabled</code> is set to true.</p>
|
|
1587
1759
|
*/
|
|
1588
1760
|
OutputFormatConfiguration?: OutputFormatConfiguration;
|
|
1589
1761
|
/**
|
|
1762
|
+
* @public
|
|
1590
1763
|
* <p>Defaults to <code>true</code>. Set it to <code>false</code> if you want to disable
|
|
1591
1764
|
* format conversion while preserving the configuration details.</p>
|
|
1592
1765
|
*/
|
|
@@ -1599,6 +1772,7 @@ export interface DataFormatConversionConfiguration {
|
|
|
1599
1772
|
*/
|
|
1600
1773
|
export interface RetryOptions {
|
|
1601
1774
|
/**
|
|
1775
|
+
* @public
|
|
1602
1776
|
* <p>The period of time during which Kinesis Data Firehose retries to deliver data to the
|
|
1603
1777
|
* specified Amazon S3 prefix.</p>
|
|
1604
1778
|
*/
|
|
@@ -1613,11 +1787,13 @@ export interface RetryOptions {
|
|
|
1613
1787
|
*/
|
|
1614
1788
|
export interface DynamicPartitioningConfiguration {
|
|
1615
1789
|
/**
|
|
1790
|
+
* @public
|
|
1616
1791
|
* <p>The retry behavior in case Kinesis Data Firehose is unable to deliver data to an Amazon
|
|
1617
1792
|
* S3 prefix.</p>
|
|
1618
1793
|
*/
|
|
1619
1794
|
RetryOptions?: RetryOptions;
|
|
1620
1795
|
/**
|
|
1796
|
+
* @public
|
|
1621
1797
|
* <p>Specifies that the dynamic partitioning is enabled for this Kinesis Data Firehose
|
|
1622
1798
|
* delivery stream.</p>
|
|
1623
1799
|
*/
|
|
@@ -1641,23 +1817,27 @@ export type S3BackupMode = (typeof S3BackupMode)[keyof typeof S3BackupMode];
|
|
|
1641
1817
|
*/
|
|
1642
1818
|
export interface ExtendedS3DestinationConfiguration {
|
|
1643
1819
|
/**
|
|
1820
|
+
* @public
|
|
1644
1821
|
* <p>The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more
|
|
1645
1822
|
* information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and
|
|
1646
1823
|
* Amazon Web Services Service Namespaces</a>.</p>
|
|
1647
1824
|
*/
|
|
1648
1825
|
RoleARN: string | undefined;
|
|
1649
1826
|
/**
|
|
1827
|
+
* @public
|
|
1650
1828
|
* <p>The ARN of the S3 bucket. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and
|
|
1651
1829
|
* Amazon Web Services Service Namespaces</a>.</p>
|
|
1652
1830
|
*/
|
|
1653
1831
|
BucketARN: string | undefined;
|
|
1654
1832
|
/**
|
|
1833
|
+
* @public
|
|
1655
1834
|
* <p>The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3
|
|
1656
1835
|
* files. You can also specify a custom prefix, as described in <a href="https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html">Custom Prefixes for Amazon S3
|
|
1657
1836
|
* Objects</a>.</p>
|
|
1658
1837
|
*/
|
|
1659
1838
|
Prefix?: string;
|
|
1660
1839
|
/**
|
|
1840
|
+
* @public
|
|
1661
1841
|
* <p>A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing
|
|
1662
1842
|
* them to S3. This prefix appears immediately following the bucket name. For information
|
|
1663
1843
|
* about how to specify this prefix, see <a href="https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html">Custom Prefixes for Amazon S3
|
|
@@ -1665,43 +1845,52 @@ export interface ExtendedS3DestinationConfiguration {
|
|
|
1665
1845
|
*/
|
|
1666
1846
|
ErrorOutputPrefix?: string;
|
|
1667
1847
|
/**
|
|
1848
|
+
* @public
|
|
1668
1849
|
* <p>The buffering option.</p>
|
|
1669
1850
|
*/
|
|
1670
1851
|
BufferingHints?: BufferingHints;
|
|
1671
1852
|
/**
|
|
1853
|
+
* @public
|
|
1672
1854
|
* <p>The compression format. If no value is specified, the default is
|
|
1673
1855
|
* UNCOMPRESSED.</p>
|
|
1674
1856
|
*/
|
|
1675
1857
|
CompressionFormat?: CompressionFormat | string;
|
|
1676
1858
|
/**
|
|
1859
|
+
* @public
|
|
1677
1860
|
* <p>The encryption configuration. If no value is specified, the default is no
|
|
1678
1861
|
* encryption.</p>
|
|
1679
1862
|
*/
|
|
1680
1863
|
EncryptionConfiguration?: EncryptionConfiguration;
|
|
1681
1864
|
/**
|
|
1865
|
+
* @public
|
|
1682
1866
|
* <p>The Amazon CloudWatch logging options for your delivery stream.</p>
|
|
1683
1867
|
*/
|
|
1684
1868
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
|
1685
1869
|
/**
|
|
1870
|
+
* @public
|
|
1686
1871
|
* <p>The data processing configuration.</p>
|
|
1687
1872
|
*/
|
|
1688
1873
|
ProcessingConfiguration?: ProcessingConfiguration;
|
|
1689
1874
|
/**
|
|
1875
|
+
* @public
|
|
1690
1876
|
* <p>The Amazon S3 backup mode. After you create a delivery stream, you can update it to
|
|
1691
1877
|
* enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the
|
|
1692
1878
|
* delivery stream to disable it. </p>
|
|
1693
1879
|
*/
|
|
1694
1880
|
S3BackupMode?: S3BackupMode | string;
|
|
1695
1881
|
/**
|
|
1882
|
+
* @public
|
|
1696
1883
|
* <p>The configuration for backup in Amazon S3.</p>
|
|
1697
1884
|
*/
|
|
1698
1885
|
S3BackupConfiguration?: S3DestinationConfiguration;
|
|
1699
1886
|
/**
|
|
1887
|
+
* @public
|
|
1700
1888
|
* <p>The serializer, deserializer, and schema for converting data from the JSON format to
|
|
1701
1889
|
* the Parquet or ORC format before writing it to Amazon S3.</p>
|
|
1702
1890
|
*/
|
|
1703
1891
|
DataFormatConversionConfiguration?: DataFormatConversionConfiguration;
|
|
1704
1892
|
/**
|
|
1893
|
+
* @public
|
|
1705
1894
|
* <p>The configuration of the dynamic partitioning mechanism that creates smaller data sets
|
|
1706
1895
|
* from the streaming data by partitioning it based on partition keys. Currently, dynamic
|
|
1707
1896
|
* partitioning is only supported for Amazon S3 destinations.
|
|
@@ -1719,6 +1908,7 @@ export interface ExtendedS3DestinationConfiguration {
|
|
|
1719
1908
|
*/
|
|
1720
1909
|
export interface HttpEndpointBufferingHints {
|
|
1721
1910
|
/**
|
|
1911
|
+
* @public
|
|
1722
1912
|
* <p>Buffer incoming data to the specified size, in MBs, before delivering it to the
|
|
1723
1913
|
* destination. The default value is 5. </p>
|
|
1724
1914
|
* <p>We recommend setting this parameter to a value greater than the amount of data you
|
|
@@ -1727,6 +1917,7 @@ export interface HttpEndpointBufferingHints {
|
|
|
1727
1917
|
*/
|
|
1728
1918
|
SizeInMBs?: number;
|
|
1729
1919
|
/**
|
|
1920
|
+
* @public
|
|
1730
1921
|
* <p>Buffer incoming data for the specified period of time, in seconds, before delivering it
|
|
1731
1922
|
* to the destination. The default value is 300 (5 minutes). </p>
|
|
1732
1923
|
*/
|
|
@@ -1739,6 +1930,7 @@ export interface HttpEndpointBufferingHints {
|
|
|
1739
1930
|
*/
|
|
1740
1931
|
export interface HttpEndpointConfiguration {
|
|
1741
1932
|
/**
|
|
1933
|
+
* @public
|
|
1742
1934
|
* <p>The URL of the HTTP endpoint selected as the destination.</p>
|
|
1743
1935
|
* <important>
|
|
1744
1936
|
* <p>If you choose an HTTP endpoint as your destination, review and follow the
|
|
@@ -1748,10 +1940,12 @@ export interface HttpEndpointConfiguration {
|
|
|
1748
1940
|
*/
|
|
1749
1941
|
Url: string | undefined;
|
|
1750
1942
|
/**
|
|
1943
|
+
* @public
|
|
1751
1944
|
* <p>The name of the HTTP endpoint selected as the destination.</p>
|
|
1752
1945
|
*/
|
|
1753
1946
|
Name?: string;
|
|
1754
1947
|
/**
|
|
1948
|
+
* @public
|
|
1755
1949
|
* <p>The access key required for Kinesis Firehose to authenticate with the HTTP endpoint
|
|
1756
1950
|
* selected as the destination.</p>
|
|
1757
1951
|
*/
|
|
@@ -1764,10 +1958,12 @@ export interface HttpEndpointConfiguration {
|
|
|
1764
1958
|
*/
|
|
1765
1959
|
export interface HttpEndpointCommonAttribute {
|
|
1766
1960
|
/**
|
|
1961
|
+
* @public
|
|
1767
1962
|
* <p>The name of the HTTP endpoint common attribute.</p>
|
|
1768
1963
|
*/
|
|
1769
1964
|
AttributeName: string | undefined;
|
|
1770
1965
|
/**
|
|
1966
|
+
* @public
|
|
1771
1967
|
* <p>The value of the HTTP endpoint common attribute.</p>
|
|
1772
1968
|
*/
|
|
1773
1969
|
AttributeValue: string | undefined;
|
|
@@ -1778,11 +1974,13 @@ export interface HttpEndpointCommonAttribute {
|
|
|
1778
1974
|
*/
|
|
1779
1975
|
export interface HttpEndpointRequestConfiguration {
|
|
1780
1976
|
/**
|
|
1977
|
+
* @public
|
|
1781
1978
|
* <p>Kinesis Data Firehose uses the content encoding to compress the body of a request before
|
|
1782
1979
|
* sending the request to the destination. For more information, see <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Encoding">Content-Encoding</a> in MDN Web Docs, the official Mozilla documentation.</p>
|
|
1783
1980
|
*/
|
|
1784
1981
|
ContentEncoding?: ContentEncoding | string;
|
|
1785
1982
|
/**
|
|
1983
|
+
* @public
|
|
1786
1984
|
* <p>Describes the metadata sent to the HTTP endpoint destination.</p>
|
|
1787
1985
|
*/
|
|
1788
1986
|
CommonAttributes?: HttpEndpointCommonAttribute[];
|
|
@@ -1795,6 +1993,7 @@ export interface HttpEndpointRequestConfiguration {
|
|
|
1795
1993
|
*/
|
|
1796
1994
|
export interface HttpEndpointRetryOptions {
|
|
1797
1995
|
/**
|
|
1996
|
+
* @public
|
|
1798
1997
|
* <p>The total amount of time that Kinesis Data Firehose spends on retries. This duration
|
|
1799
1998
|
* starts after the initial attempt to send data to the custom destination via HTTPS endpoint
|
|
1800
1999
|
* fails. It doesn't include the periods during which Kinesis Data Firehose waits for
|
|
@@ -1820,10 +2019,12 @@ export type HttpEndpointS3BackupMode = (typeof HttpEndpointS3BackupMode)[keyof t
|
|
|
1820
2019
|
*/
|
|
1821
2020
|
export interface HttpEndpointDestinationConfiguration {
|
|
1822
2021
|
/**
|
|
2022
|
+
* @public
|
|
1823
2023
|
* <p>The configuration of the HTTP endpoint selected as the destination.</p>
|
|
1824
2024
|
*/
|
|
1825
2025
|
EndpointConfiguration: HttpEndpointConfiguration | undefined;
|
|
1826
2026
|
/**
|
|
2027
|
+
* @public
|
|
1827
2028
|
* <p>The buffering options that can be used before data is delivered to the specified
|
|
1828
2029
|
* destination. Kinesis Data Firehose treats these options as hints, and it might choose to
|
|
1829
2030
|
* use more optimal values. The <code>SizeInMBs</code> and <code>IntervalInSeconds</code>
|
|
@@ -1832,30 +2033,36 @@ export interface HttpEndpointDestinationConfiguration {
|
|
|
1832
2033
|
*/
|
|
1833
2034
|
BufferingHints?: HttpEndpointBufferingHints;
|
|
1834
2035
|
/**
|
|
2036
|
+
* @public
|
|
1835
2037
|
* <p>Describes the Amazon CloudWatch logging options for your delivery stream.</p>
|
|
1836
2038
|
*/
|
|
1837
2039
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
|
1838
2040
|
/**
|
|
2041
|
+
* @public
|
|
1839
2042
|
* <p>The configuration of the requeste sent to the HTTP endpoint specified as the
|
|
1840
2043
|
* destination.</p>
|
|
1841
2044
|
*/
|
|
1842
2045
|
RequestConfiguration?: HttpEndpointRequestConfiguration;
|
|
1843
2046
|
/**
|
|
2047
|
+
* @public
|
|
1844
2048
|
* <p>Describes a data processing configuration.</p>
|
|
1845
2049
|
*/
|
|
1846
2050
|
ProcessingConfiguration?: ProcessingConfiguration;
|
|
1847
2051
|
/**
|
|
2052
|
+
* @public
|
|
1848
2053
|
* <p>Kinesis Data Firehose uses this IAM role for all the permissions that the delivery
|
|
1849
2054
|
* stream needs.</p>
|
|
1850
2055
|
*/
|
|
1851
2056
|
RoleARN?: string;
|
|
1852
2057
|
/**
|
|
2058
|
+
* @public
|
|
1853
2059
|
* <p>Describes the retry behavior in case Kinesis Data Firehose is unable to deliver data to
|
|
1854
2060
|
* the specified HTTP endpoint destination, or if it doesn't receive a valid acknowledgment of
|
|
1855
2061
|
* receipt from the specified HTTP endpoint destination.</p>
|
|
1856
2062
|
*/
|
|
1857
2063
|
RetryOptions?: HttpEndpointRetryOptions;
|
|
1858
2064
|
/**
|
|
2065
|
+
* @public
|
|
1859
2066
|
* <p>Describes the S3 bucket backup options for the data that Kinesis Data Firehose delivers
|
|
1860
2067
|
* to the HTTP endpoint destination. You can back up all documents (<code>AllData</code>) or
|
|
1861
2068
|
* only the documents that Kinesis Data Firehose could not deliver to the specified HTTP
|
|
@@ -1863,6 +2070,7 @@ export interface HttpEndpointDestinationConfiguration {
|
|
|
1863
2070
|
*/
|
|
1864
2071
|
S3BackupMode?: HttpEndpointS3BackupMode | string;
|
|
1865
2072
|
/**
|
|
2073
|
+
* @public
|
|
1866
2074
|
* <p>Describes the configuration of a destination in Amazon S3.</p>
|
|
1867
2075
|
*/
|
|
1868
2076
|
S3Configuration: S3DestinationConfiguration | undefined;
|
|
@@ -1874,11 +2082,13 @@ export interface HttpEndpointDestinationConfiguration {
|
|
|
1874
2082
|
*/
|
|
1875
2083
|
export interface KinesisStreamSourceConfiguration {
|
|
1876
2084
|
/**
|
|
2085
|
+
* @public
|
|
1877
2086
|
* <p>The ARN of the source Kinesis data stream. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams">Amazon
|
|
1878
2087
|
* Kinesis Data Streams ARN Format</a>.</p>
|
|
1879
2088
|
*/
|
|
1880
2089
|
KinesisStreamARN: string | undefined;
|
|
1881
2090
|
/**
|
|
2091
|
+
* @public
|
|
1882
2092
|
* <p>The ARN of the role that provides access to the source Kinesis data stream. For more
|
|
1883
2093
|
* information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam">Amazon Web Services
|
|
1884
2094
|
* Identity and Access Management (IAM) ARN Format</a>.</p>
|
|
@@ -1892,6 +2102,7 @@ export interface KinesisStreamSourceConfiguration {
|
|
|
1892
2102
|
*/
|
|
1893
2103
|
export interface RedshiftRetryOptions {
|
|
1894
2104
|
/**
|
|
2105
|
+
* @public
|
|
1895
2106
|
* <p>The length of time during which Kinesis Data Firehose retries delivery after a
|
|
1896
2107
|
* failure, starting from the initial request and including the first attempt. The default
|
|
1897
2108
|
* value is 3600 seconds (60 minutes). Kinesis Data Firehose does not retry if the value of
|
|
@@ -1918,33 +2129,40 @@ export type RedshiftS3BackupMode = (typeof RedshiftS3BackupMode)[keyof typeof Re
|
|
|
1918
2129
|
*/
|
|
1919
2130
|
export interface RedshiftDestinationConfiguration {
|
|
1920
2131
|
/**
|
|
2132
|
+
* @public
|
|
1921
2133
|
* <p>The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more
|
|
1922
2134
|
* information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and
|
|
1923
2135
|
* Amazon Web Services Service Namespaces</a>.</p>
|
|
1924
2136
|
*/
|
|
1925
2137
|
RoleARN: string | undefined;
|
|
1926
2138
|
/**
|
|
2139
|
+
* @public
|
|
1927
2140
|
* <p>The database connection string.</p>
|
|
1928
2141
|
*/
|
|
1929
2142
|
ClusterJDBCURL: string | undefined;
|
|
1930
2143
|
/**
|
|
2144
|
+
* @public
|
|
1931
2145
|
* <p>The <code>COPY</code> command.</p>
|
|
1932
2146
|
*/
|
|
1933
2147
|
CopyCommand: CopyCommand | undefined;
|
|
1934
2148
|
/**
|
|
2149
|
+
* @public
|
|
1935
2150
|
* <p>The name of the user.</p>
|
|
1936
2151
|
*/
|
|
1937
2152
|
Username: string | undefined;
|
|
1938
2153
|
/**
|
|
2154
|
+
* @public
|
|
1939
2155
|
* <p>The user password.</p>
|
|
1940
2156
|
*/
|
|
1941
2157
|
Password: string | undefined;
|
|
1942
2158
|
/**
|
|
2159
|
+
* @public
|
|
1943
2160
|
* <p>The retry behavior in case Kinesis Data Firehose is unable to deliver documents to
|
|
1944
2161
|
* Amazon Redshift. Default value is 3600 (60 minutes).</p>
|
|
1945
2162
|
*/
|
|
1946
2163
|
RetryOptions?: RedshiftRetryOptions;
|
|
1947
2164
|
/**
|
|
2165
|
+
* @public
|
|
1948
2166
|
* <p>The configuration for the intermediate Amazon S3 location from which Amazon Redshift
|
|
1949
2167
|
* obtains data. Restrictions are described in the topic for <a>CreateDeliveryStream</a>.</p>
|
|
1950
2168
|
* <p>The compression formats <code>SNAPPY</code> or <code>ZIP</code> cannot be specified
|
|
@@ -1954,20 +2172,24 @@ export interface RedshiftDestinationConfiguration {
|
|
|
1954
2172
|
*/
|
|
1955
2173
|
S3Configuration: S3DestinationConfiguration | undefined;
|
|
1956
2174
|
/**
|
|
2175
|
+
* @public
|
|
1957
2176
|
* <p>The data processing configuration.</p>
|
|
1958
2177
|
*/
|
|
1959
2178
|
ProcessingConfiguration?: ProcessingConfiguration;
|
|
1960
2179
|
/**
|
|
2180
|
+
* @public
|
|
1961
2181
|
* <p>The Amazon S3 backup mode. After you create a delivery stream, you can update it to
|
|
1962
2182
|
* enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the
|
|
1963
2183
|
* delivery stream to disable it. </p>
|
|
1964
2184
|
*/
|
|
1965
2185
|
S3BackupMode?: RedshiftS3BackupMode | string;
|
|
1966
2186
|
/**
|
|
2187
|
+
* @public
|
|
1967
2188
|
* <p>The configuration for backup in Amazon S3.</p>
|
|
1968
2189
|
*/
|
|
1969
2190
|
S3BackupConfiguration?: S3DestinationConfiguration;
|
|
1970
2191
|
/**
|
|
2192
|
+
* @public
|
|
1971
2193
|
* <p>The CloudWatch logging options for your delivery stream.</p>
|
|
1972
2194
|
*/
|
|
1973
2195
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
|
@@ -1991,6 +2213,7 @@ export type HECEndpointType = (typeof HECEndpointType)[keyof typeof HECEndpointT
|
|
|
1991
2213
|
*/
|
|
1992
2214
|
export interface SplunkRetryOptions {
|
|
1993
2215
|
/**
|
|
2216
|
+
* @public
|
|
1994
2217
|
* <p>The total amount of time that Kinesis Data Firehose spends on retries. This duration
|
|
1995
2218
|
* starts after the initial attempt to send data to Splunk fails. It doesn't include the
|
|
1996
2219
|
* periods during which Kinesis Data Firehose waits for acknowledgment from Splunk after each
|
|
@@ -2016,20 +2239,24 @@ export type SplunkS3BackupMode = (typeof SplunkS3BackupMode)[keyof typeof Splunk
|
|
|
2016
2239
|
*/
|
|
2017
2240
|
export interface SplunkDestinationConfiguration {
|
|
2018
2241
|
/**
|
|
2242
|
+
* @public
|
|
2019
2243
|
* <p>The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your
|
|
2020
2244
|
* data.</p>
|
|
2021
2245
|
*/
|
|
2022
2246
|
HECEndpoint: string | undefined;
|
|
2023
2247
|
/**
|
|
2248
|
+
* @public
|
|
2024
2249
|
* <p>This type can be either "Raw" or "Event."</p>
|
|
2025
2250
|
*/
|
|
2026
2251
|
HECEndpointType: HECEndpointType | string | undefined;
|
|
2027
2252
|
/**
|
|
2253
|
+
* @public
|
|
2028
2254
|
* <p>This is a GUID that you obtain from your Splunk cluster when you create a new HEC
|
|
2029
2255
|
* endpoint.</p>
|
|
2030
2256
|
*/
|
|
2031
2257
|
HECToken: string | undefined;
|
|
2032
2258
|
/**
|
|
2259
|
+
* @public
|
|
2033
2260
|
* <p>The amount of time that Kinesis Data Firehose waits to receive an acknowledgment from
|
|
2034
2261
|
* Splunk after it sends it data. At the end of the timeout period, Kinesis Data Firehose
|
|
2035
2262
|
* either tries to send the data again or considers it an error, based on your retry
|
|
@@ -2037,11 +2264,13 @@ export interface SplunkDestinationConfiguration {
|
|
|
2037
2264
|
*/
|
|
2038
2265
|
HECAcknowledgmentTimeoutInSeconds?: number;
|
|
2039
2266
|
/**
|
|
2267
|
+
* @public
|
|
2040
2268
|
* <p>The retry behavior in case Kinesis Data Firehose is unable to deliver data to Splunk,
|
|
2041
2269
|
* or if it doesn't receive an acknowledgment of receipt from Splunk.</p>
|
|
2042
2270
|
*/
|
|
2043
2271
|
RetryOptions?: SplunkRetryOptions;
|
|
2044
2272
|
/**
|
|
2273
|
+
* @public
|
|
2045
2274
|
* <p>Defines how documents should be delivered to Amazon S3. When set to
|
|
2046
2275
|
* <code>FailedEventsOnly</code>, Kinesis Data Firehose writes any data that could not be
|
|
2047
2276
|
* indexed to the configured Amazon S3 destination. When set to <code>AllEvents</code>,
|
|
@@ -2053,14 +2282,17 @@ export interface SplunkDestinationConfiguration {
|
|
|
2053
2282
|
*/
|
|
2054
2283
|
S3BackupMode?: SplunkS3BackupMode | string;
|
|
2055
2284
|
/**
|
|
2285
|
+
* @public
|
|
2056
2286
|
* <p>The configuration for the backup Amazon S3 location.</p>
|
|
2057
2287
|
*/
|
|
2058
2288
|
S3Configuration: S3DestinationConfiguration | undefined;
|
|
2059
2289
|
/**
|
|
2290
|
+
* @public
|
|
2060
2291
|
* <p>The data processing configuration.</p>
|
|
2061
2292
|
*/
|
|
2062
2293
|
ProcessingConfiguration?: ProcessingConfiguration;
|
|
2063
2294
|
/**
|
|
2295
|
+
* @public
|
|
2064
2296
|
* <p>The Amazon CloudWatch logging options for your delivery stream.</p>
|
|
2065
2297
|
*/
|
|
2066
2298
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
|
@@ -2072,11 +2304,13 @@ export interface SplunkDestinationConfiguration {
|
|
|
2072
2304
|
*/
|
|
2073
2305
|
export interface Tag {
|
|
2074
2306
|
/**
|
|
2307
|
+
* @public
|
|
2075
2308
|
* <p>A unique identifier for the tag. Maximum length: 128 characters. Valid characters:
|
|
2076
2309
|
* Unicode letters, digits, white space, _ . / = + - % @</p>
|
|
2077
2310
|
*/
|
|
2078
2311
|
Key: string | undefined;
|
|
2079
2312
|
/**
|
|
2313
|
+
* @public
|
|
2080
2314
|
* <p>An optional string, which you can use to describe or define the tag. Maximum length:
|
|
2081
2315
|
* 256 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - %
|
|
2082
2316
|
* @</p>
|
|
@@ -2088,6 +2322,7 @@ export interface Tag {
|
|
|
2088
2322
|
*/
|
|
2089
2323
|
export interface CreateDeliveryStreamInput {
|
|
2090
2324
|
/**
|
|
2325
|
+
* @public
|
|
2091
2326
|
* <p>The name of the delivery stream. This name must be unique per Amazon Web Services
|
|
2092
2327
|
* account in the same Amazon Web Services Region. If the delivery streams are in different
|
|
2093
2328
|
* accounts or different Regions, you can have multiple delivery streams with the same
|
|
@@ -2095,6 +2330,7 @@ export interface CreateDeliveryStreamInput {
|
|
|
2095
2330
|
*/
|
|
2096
2331
|
DeliveryStreamName: string | undefined;
|
|
2097
2332
|
/**
|
|
2333
|
+
* @public
|
|
2098
2334
|
* <p>The delivery stream type. This parameter can be one of the following
|
|
2099
2335
|
* values:</p>
|
|
2100
2336
|
* <ul>
|
|
@@ -2112,16 +2348,19 @@ export interface CreateDeliveryStreamInput {
|
|
|
2112
2348
|
*/
|
|
2113
2349
|
DeliveryStreamType?: DeliveryStreamType | string;
|
|
2114
2350
|
/**
|
|
2351
|
+
* @public
|
|
2115
2352
|
* <p>When a Kinesis data stream is used as the source for the delivery stream, a <a>KinesisStreamSourceConfiguration</a> containing the Kinesis data stream Amazon
|
|
2116
2353
|
* Resource Name (ARN) and the role ARN for the source stream.</p>
|
|
2117
2354
|
*/
|
|
2118
2355
|
KinesisStreamSourceConfiguration?: KinesisStreamSourceConfiguration;
|
|
2119
2356
|
/**
|
|
2357
|
+
* @public
|
|
2120
2358
|
* <p>Used to specify the type and Amazon Resource Name (ARN) of the KMS key needed for
|
|
2121
2359
|
* Server-Side Encryption (SSE).</p>
|
|
2122
2360
|
*/
|
|
2123
2361
|
DeliveryStreamEncryptionConfigurationInput?: DeliveryStreamEncryptionConfigurationInput;
|
|
2124
2362
|
/**
|
|
2363
|
+
* @public
|
|
2125
2364
|
* @deprecated
|
|
2126
2365
|
*
|
|
2127
2366
|
* <p>[Deprecated]
|
|
@@ -2129,32 +2368,39 @@ export interface CreateDeliveryStreamInput {
|
|
|
2129
2368
|
*/
|
|
2130
2369
|
S3DestinationConfiguration?: S3DestinationConfiguration;
|
|
2131
2370
|
/**
|
|
2371
|
+
* @public
|
|
2132
2372
|
* <p>The destination in Amazon S3. You can specify only one destination.</p>
|
|
2133
2373
|
*/
|
|
2134
2374
|
ExtendedS3DestinationConfiguration?: ExtendedS3DestinationConfiguration;
|
|
2135
2375
|
/**
|
|
2376
|
+
* @public
|
|
2136
2377
|
* <p>The destination in Amazon Redshift. You can specify only one destination.</p>
|
|
2137
2378
|
*/
|
|
2138
2379
|
RedshiftDestinationConfiguration?: RedshiftDestinationConfiguration;
|
|
2139
2380
|
/**
|
|
2381
|
+
* @public
|
|
2140
2382
|
* <p>The destination in Amazon ES. You can specify only one destination.</p>
|
|
2141
2383
|
*/
|
|
2142
2384
|
ElasticsearchDestinationConfiguration?: ElasticsearchDestinationConfiguration;
|
|
2143
2385
|
/**
|
|
2386
|
+
* @public
|
|
2144
2387
|
* <p>The destination in Amazon OpenSearch Service. You can specify only one
|
|
2145
2388
|
* destination.</p>
|
|
2146
2389
|
*/
|
|
2147
2390
|
AmazonopensearchserviceDestinationConfiguration?: AmazonopensearchserviceDestinationConfiguration;
|
|
2148
2391
|
/**
|
|
2392
|
+
* @public
|
|
2149
2393
|
* <p>The destination in Splunk. You can specify only one destination.</p>
|
|
2150
2394
|
*/
|
|
2151
2395
|
SplunkDestinationConfiguration?: SplunkDestinationConfiguration;
|
|
2152
2396
|
/**
|
|
2397
|
+
* @public
|
|
2153
2398
|
* <p>Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination.
|
|
2154
2399
|
* You can specify only one destination.</p>
|
|
2155
2400
|
*/
|
|
2156
2401
|
HttpEndpointDestinationConfiguration?: HttpEndpointDestinationConfiguration;
|
|
2157
2402
|
/**
|
|
2403
|
+
* @public
|
|
2158
2404
|
* <p>A set of tags to assign to the delivery stream. A tag is a key-value pair that you can
|
|
2159
2405
|
* define and assign to Amazon Web Services resources. Tags are metadata. For example, you can
|
|
2160
2406
|
* add friendly names and descriptions or other types of information that can help you
|
|
@@ -2166,6 +2412,7 @@ export interface CreateDeliveryStreamInput {
|
|
|
2166
2412
|
*/
|
|
2167
2413
|
Tags?: Tag[];
|
|
2168
2414
|
/**
|
|
2415
|
+
* @public
|
|
2169
2416
|
* <p>The destination in the Serverless offering for Amazon OpenSearch Service. You can
|
|
2170
2417
|
* specify only one destination.</p>
|
|
2171
2418
|
*/
|
|
@@ -2176,6 +2423,7 @@ export interface CreateDeliveryStreamInput {
|
|
|
2176
2423
|
*/
|
|
2177
2424
|
export interface CreateDeliveryStreamOutput {
|
|
2178
2425
|
/**
|
|
2426
|
+
* @public
|
|
2179
2427
|
* <p>The ARN of the delivery stream.</p>
|
|
2180
2428
|
*/
|
|
2181
2429
|
DeliveryStreamARN?: string;
|
|
@@ -2238,10 +2486,12 @@ export declare class ResourceInUseException extends __BaseException {
|
|
|
2238
2486
|
*/
|
|
2239
2487
|
export interface DeleteDeliveryStreamInput {
|
|
2240
2488
|
/**
|
|
2489
|
+
* @public
|
|
2241
2490
|
* <p>The name of the delivery stream.</p>
|
|
2242
2491
|
*/
|
|
2243
2492
|
DeliveryStreamName: string | undefined;
|
|
2244
2493
|
/**
|
|
2494
|
+
* @public
|
|
2245
2495
|
* <p>Set this to true if you want to delete the delivery stream even if Kinesis Data Firehose
|
|
2246
2496
|
* is unable to retire the grant for the CMK. Kinesis Data Firehose might be unable to retire
|
|
2247
2497
|
* the grant due to a customer error, such as when the CMK or the grant are in an invalid
|
|
@@ -2303,10 +2553,12 @@ export type DeliveryStreamFailureType = (typeof DeliveryStreamFailureType)[keyof
|
|
|
2303
2553
|
*/
|
|
2304
2554
|
export interface FailureDescription {
|
|
2305
2555
|
/**
|
|
2556
|
+
* @public
|
|
2306
2557
|
* <p>The type of error that caused the failure.</p>
|
|
2307
2558
|
*/
|
|
2308
2559
|
Type: DeliveryStreamFailureType | string | undefined;
|
|
2309
2560
|
/**
|
|
2561
|
+
* @public
|
|
2310
2562
|
* <p>A message providing details about the error that caused the failure.</p>
|
|
2311
2563
|
*/
|
|
2312
2564
|
Details: string | undefined;
|
|
@@ -2335,18 +2587,21 @@ export type DeliveryStreamEncryptionStatus = (typeof DeliveryStreamEncryptionSta
|
|
|
2335
2587
|
*/
|
|
2336
2588
|
export interface DeliveryStreamEncryptionConfiguration {
|
|
2337
2589
|
/**
|
|
2590
|
+
* @public
|
|
2338
2591
|
* <p>If <code>KeyType</code> is <code>CUSTOMER_MANAGED_CMK</code>, this field contains the
|
|
2339
2592
|
* ARN of the customer managed CMK. If <code>KeyType</code> is <code>Amazon Web Services_OWNED_CMK</code>, <code>DeliveryStreamEncryptionConfiguration</code> doesn't contain
|
|
2340
2593
|
* a value for <code>KeyARN</code>.</p>
|
|
2341
2594
|
*/
|
|
2342
2595
|
KeyARN?: string;
|
|
2343
2596
|
/**
|
|
2597
|
+
* @public
|
|
2344
2598
|
* <p>Indicates the type of customer master key (CMK) that is used for encryption. The default
|
|
2345
2599
|
* setting is <code>Amazon Web Services_OWNED_CMK</code>. For more information about CMKs, see
|
|
2346
2600
|
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys">Customer Master Keys (CMKs)</a>.</p>
|
|
2347
2601
|
*/
|
|
2348
2602
|
KeyType?: KeyType | string;
|
|
2349
2603
|
/**
|
|
2604
|
+
* @public
|
|
2350
2605
|
* <p>This is the server-side encryption (SSE) status for the delivery stream. For a full
|
|
2351
2606
|
* description of the different values of this status, see <a>StartDeliveryStreamEncryption</a> and <a>StopDeliveryStreamEncryption</a>. If this status is <code>ENABLING_FAILED</code>
|
|
2352
2607
|
* or <code>DISABLING_FAILED</code>, it is the status of the most recent attempt to enable or
|
|
@@ -2354,6 +2609,7 @@ export interface DeliveryStreamEncryptionConfiguration {
|
|
|
2354
2609
|
*/
|
|
2355
2610
|
Status?: DeliveryStreamEncryptionStatus | string;
|
|
2356
2611
|
/**
|
|
2612
|
+
* @public
|
|
2357
2613
|
* <p>Provides details in case one of the following operations fails due to an error related
|
|
2358
2614
|
* to KMS: <a>CreateDeliveryStream</a>, <a>DeleteDeliveryStream</a>,
|
|
2359
2615
|
* <a>StartDeliveryStreamEncryption</a>, <a>StopDeliveryStreamEncryption</a>.</p>
|
|
@@ -2381,12 +2637,14 @@ export type DeliveryStreamStatus = (typeof DeliveryStreamStatus)[keyof typeof De
|
|
|
2381
2637
|
*/
|
|
2382
2638
|
export interface ElasticsearchDestinationDescription {
|
|
2383
2639
|
/**
|
|
2640
|
+
* @public
|
|
2384
2641
|
* <p>The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more
|
|
2385
2642
|
* information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and
|
|
2386
2643
|
* Amazon Web Services Service Namespaces</a>.</p>
|
|
2387
2644
|
*/
|
|
2388
2645
|
RoleARN?: string;
|
|
2389
2646
|
/**
|
|
2647
|
+
* @public
|
|
2390
2648
|
* <p>The ARN of the Amazon ES domain. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
|
|
2391
2649
|
* Resource Names (ARNs) and Amazon Web Services Service Namespaces</a>.</p>
|
|
2392
2650
|
*
|
|
@@ -2395,50 +2653,61 @@ export interface ElasticsearchDestinationDescription {
|
|
|
2395
2653
|
*/
|
|
2396
2654
|
DomainARN?: string;
|
|
2397
2655
|
/**
|
|
2656
|
+
* @public
|
|
2398
2657
|
* <p>The endpoint to use when communicating with the cluster. Kinesis Data Firehose uses
|
|
2399
2658
|
* either this <code>ClusterEndpoint</code> or the <code>DomainARN</code> field to send data
|
|
2400
2659
|
* to Amazon ES.</p>
|
|
2401
2660
|
*/
|
|
2402
2661
|
ClusterEndpoint?: string;
|
|
2403
2662
|
/**
|
|
2663
|
+
* @public
|
|
2404
2664
|
* <p>The Elasticsearch index name.</p>
|
|
2405
2665
|
*/
|
|
2406
2666
|
IndexName?: string;
|
|
2407
2667
|
/**
|
|
2668
|
+
* @public
|
|
2408
2669
|
* <p>The Elasticsearch type name. This applies to Elasticsearch 6.x and lower versions.
|
|
2409
2670
|
* For Elasticsearch 7.x and OpenSearch Service 1.x, there's no value for
|
|
2410
2671
|
* <code>TypeName</code>.</p>
|
|
2411
2672
|
*/
|
|
2412
2673
|
TypeName?: string;
|
|
2413
2674
|
/**
|
|
2675
|
+
* @public
|
|
2414
2676
|
* <p>The Elasticsearch index rotation period</p>
|
|
2415
2677
|
*/
|
|
2416
2678
|
IndexRotationPeriod?: ElasticsearchIndexRotationPeriod | string;
|
|
2417
2679
|
/**
|
|
2680
|
+
* @public
|
|
2418
2681
|
* <p>The buffering options.</p>
|
|
2419
2682
|
*/
|
|
2420
2683
|
BufferingHints?: ElasticsearchBufferingHints;
|
|
2421
2684
|
/**
|
|
2685
|
+
* @public
|
|
2422
2686
|
* <p>The Amazon ES retry options.</p>
|
|
2423
2687
|
*/
|
|
2424
2688
|
RetryOptions?: ElasticsearchRetryOptions;
|
|
2425
2689
|
/**
|
|
2690
|
+
* @public
|
|
2426
2691
|
* <p>The Amazon S3 backup mode.</p>
|
|
2427
2692
|
*/
|
|
2428
2693
|
S3BackupMode?: ElasticsearchS3BackupMode | string;
|
|
2429
2694
|
/**
|
|
2695
|
+
* @public
|
|
2430
2696
|
* <p>The Amazon S3 destination.</p>
|
|
2431
2697
|
*/
|
|
2432
2698
|
S3DestinationDescription?: S3DestinationDescription;
|
|
2433
2699
|
/**
|
|
2700
|
+
* @public
|
|
2434
2701
|
* <p>The data processing configuration.</p>
|
|
2435
2702
|
*/
|
|
2436
2703
|
ProcessingConfiguration?: ProcessingConfiguration;
|
|
2437
2704
|
/**
|
|
2705
|
+
* @public
|
|
2438
2706
|
* <p>The Amazon CloudWatch logging options.</p>
|
|
2439
2707
|
*/
|
|
2440
2708
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
|
2441
2709
|
/**
|
|
2710
|
+
* @public
|
|
2442
2711
|
* <p>The details of the VPC of the Amazon ES destination.</p>
|
|
2443
2712
|
*/
|
|
2444
2713
|
VpcConfigurationDescription?: VpcConfigurationDescription;
|
|
@@ -2449,23 +2718,27 @@ export interface ElasticsearchDestinationDescription {
|
|
|
2449
2718
|
*/
|
|
2450
2719
|
export interface ExtendedS3DestinationDescription {
|
|
2451
2720
|
/**
|
|
2721
|
+
* @public
|
|
2452
2722
|
* <p>The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more
|
|
2453
2723
|
* information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and
|
|
2454
2724
|
* Amazon Web Services Service Namespaces</a>.</p>
|
|
2455
2725
|
*/
|
|
2456
2726
|
RoleARN: string | undefined;
|
|
2457
2727
|
/**
|
|
2728
|
+
* @public
|
|
2458
2729
|
* <p>The ARN of the S3 bucket. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and
|
|
2459
2730
|
* Amazon Web Services Service Namespaces</a>.</p>
|
|
2460
2731
|
*/
|
|
2461
2732
|
BucketARN: string | undefined;
|
|
2462
2733
|
/**
|
|
2734
|
+
* @public
|
|
2463
2735
|
* <p>The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3
|
|
2464
2736
|
* files. You can also specify a custom prefix, as described in <a href="https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html">Custom Prefixes for Amazon S3
|
|
2465
2737
|
* Objects</a>.</p>
|
|
2466
2738
|
*/
|
|
2467
2739
|
Prefix?: string;
|
|
2468
2740
|
/**
|
|
2741
|
+
* @public
|
|
2469
2742
|
* <p>A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing
|
|
2470
2743
|
* them to S3. This prefix appears immediately following the bucket name. For information
|
|
2471
2744
|
* about how to specify this prefix, see <a href="https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html">Custom Prefixes for Amazon S3
|
|
@@ -2473,41 +2746,50 @@ export interface ExtendedS3DestinationDescription {
|
|
|
2473
2746
|
*/
|
|
2474
2747
|
ErrorOutputPrefix?: string;
|
|
2475
2748
|
/**
|
|
2749
|
+
* @public
|
|
2476
2750
|
* <p>The buffering option.</p>
|
|
2477
2751
|
*/
|
|
2478
2752
|
BufferingHints: BufferingHints | undefined;
|
|
2479
2753
|
/**
|
|
2754
|
+
* @public
|
|
2480
2755
|
* <p>The compression format. If no value is specified, the default is
|
|
2481
2756
|
* <code>UNCOMPRESSED</code>.</p>
|
|
2482
2757
|
*/
|
|
2483
2758
|
CompressionFormat: CompressionFormat | string | undefined;
|
|
2484
2759
|
/**
|
|
2760
|
+
* @public
|
|
2485
2761
|
* <p>The encryption configuration. If no value is specified, the default is no
|
|
2486
2762
|
* encryption.</p>
|
|
2487
2763
|
*/
|
|
2488
2764
|
EncryptionConfiguration: EncryptionConfiguration | undefined;
|
|
2489
2765
|
/**
|
|
2766
|
+
* @public
|
|
2490
2767
|
* <p>The Amazon CloudWatch logging options for your delivery stream.</p>
|
|
2491
2768
|
*/
|
|
2492
2769
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
|
2493
2770
|
/**
|
|
2771
|
+
* @public
|
|
2494
2772
|
* <p>The data processing configuration.</p>
|
|
2495
2773
|
*/
|
|
2496
2774
|
ProcessingConfiguration?: ProcessingConfiguration;
|
|
2497
2775
|
/**
|
|
2776
|
+
* @public
|
|
2498
2777
|
* <p>The Amazon S3 backup mode.</p>
|
|
2499
2778
|
*/
|
|
2500
2779
|
S3BackupMode?: S3BackupMode | string;
|
|
2501
2780
|
/**
|
|
2781
|
+
* @public
|
|
2502
2782
|
* <p>The configuration for backup in Amazon S3.</p>
|
|
2503
2783
|
*/
|
|
2504
2784
|
S3BackupDescription?: S3DestinationDescription;
|
|
2505
2785
|
/**
|
|
2786
|
+
* @public
|
|
2506
2787
|
* <p>The serializer, deserializer, and schema for converting data from the JSON format to
|
|
2507
2788
|
* the Parquet or ORC format before writing it to Amazon S3.</p>
|
|
2508
2789
|
*/
|
|
2509
2790
|
DataFormatConversionConfiguration?: DataFormatConversionConfiguration;
|
|
2510
2791
|
/**
|
|
2792
|
+
* @public
|
|
2511
2793
|
* <p>The configuration of the dynamic partitioning mechanism that creates smaller data sets
|
|
2512
2794
|
* from the streaming data by partitioning it based on partition keys. Currently, dynamic
|
|
2513
2795
|
* partitioning is only supported for Amazon S3 destinations.
|
|
@@ -2521,10 +2803,12 @@ export interface ExtendedS3DestinationDescription {
|
|
|
2521
2803
|
*/
|
|
2522
2804
|
export interface HttpEndpointDescription {
|
|
2523
2805
|
/**
|
|
2806
|
+
* @public
|
|
2524
2807
|
* <p>The URL of the HTTP endpoint selected as the destination.</p>
|
|
2525
2808
|
*/
|
|
2526
2809
|
Url?: string;
|
|
2527
2810
|
/**
|
|
2811
|
+
* @public
|
|
2528
2812
|
* <p>The name of the HTTP endpoint selected as the destination.</p>
|
|
2529
2813
|
*/
|
|
2530
2814
|
Name?: string;
|
|
@@ -2535,10 +2819,12 @@ export interface HttpEndpointDescription {
|
|
|
2535
2819
|
*/
|
|
2536
2820
|
export interface HttpEndpointDestinationDescription {
|
|
2537
2821
|
/**
|
|
2822
|
+
* @public
|
|
2538
2823
|
* <p>The configuration of the specified HTTP endpoint destination.</p>
|
|
2539
2824
|
*/
|
|
2540
2825
|
EndpointConfiguration?: HttpEndpointDescription;
|
|
2541
2826
|
/**
|
|
2827
|
+
* @public
|
|
2542
2828
|
* <p>Describes buffering options that can be applied to the data before it is delivered to
|
|
2543
2829
|
* the HTTPS endpoint destination. Kinesis Data Firehose teats these options as hints, and it
|
|
2544
2830
|
* might choose to use more optimal values. The <code>SizeInMBs</code> and
|
|
@@ -2547,30 +2833,36 @@ export interface HttpEndpointDestinationDescription {
|
|
|
2547
2833
|
*/
|
|
2548
2834
|
BufferingHints?: HttpEndpointBufferingHints;
|
|
2549
2835
|
/**
|
|
2836
|
+
* @public
|
|
2550
2837
|
* <p>Describes the Amazon CloudWatch logging options for your delivery stream.</p>
|
|
2551
2838
|
*/
|
|
2552
2839
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
|
2553
2840
|
/**
|
|
2841
|
+
* @public
|
|
2554
2842
|
* <p>The configuration of request sent to the HTTP endpoint specified as the
|
|
2555
2843
|
* destination.</p>
|
|
2556
2844
|
*/
|
|
2557
2845
|
RequestConfiguration?: HttpEndpointRequestConfiguration;
|
|
2558
2846
|
/**
|
|
2847
|
+
* @public
|
|
2559
2848
|
* <p>Describes a data processing configuration.</p>
|
|
2560
2849
|
*/
|
|
2561
2850
|
ProcessingConfiguration?: ProcessingConfiguration;
|
|
2562
2851
|
/**
|
|
2852
|
+
* @public
|
|
2563
2853
|
* <p>Kinesis Data Firehose uses this IAM role for all the permissions that the delivery
|
|
2564
2854
|
* stream needs.</p>
|
|
2565
2855
|
*/
|
|
2566
2856
|
RoleARN?: string;
|
|
2567
2857
|
/**
|
|
2858
|
+
* @public
|
|
2568
2859
|
* <p>Describes the retry behavior in case Kinesis Data Firehose is unable to deliver data to
|
|
2569
2860
|
* the specified HTTP endpoint destination, or if it doesn't receive a valid acknowledgment of
|
|
2570
2861
|
* receipt from the specified HTTP endpoint destination.</p>
|
|
2571
2862
|
*/
|
|
2572
2863
|
RetryOptions?: HttpEndpointRetryOptions;
|
|
2573
2864
|
/**
|
|
2865
|
+
* @public
|
|
2574
2866
|
* <p>Describes the S3 bucket backup options for the data that Kinesis Firehose delivers to
|
|
2575
2867
|
* the HTTP endpoint destination. You can back up all documents (<code>AllData</code>) or only
|
|
2576
2868
|
* the documents that Kinesis Data Firehose could not deliver to the specified HTTP endpoint
|
|
@@ -2578,6 +2870,7 @@ export interface HttpEndpointDestinationDescription {
|
|
|
2578
2870
|
*/
|
|
2579
2871
|
S3BackupMode?: HttpEndpointS3BackupMode | string;
|
|
2580
2872
|
/**
|
|
2873
|
+
* @public
|
|
2581
2874
|
* <p>Describes a destination in Amazon S3.</p>
|
|
2582
2875
|
*/
|
|
2583
2876
|
S3DestinationDescription?: S3DestinationDescription;
|
|
@@ -2588,45 +2881,55 @@ export interface HttpEndpointDestinationDescription {
|
|
|
2588
2881
|
*/
|
|
2589
2882
|
export interface RedshiftDestinationDescription {
|
|
2590
2883
|
/**
|
|
2884
|
+
* @public
|
|
2591
2885
|
* <p>The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more
|
|
2592
2886
|
* information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and
|
|
2593
2887
|
* Amazon Web Services Service Namespaces</a>.</p>
|
|
2594
2888
|
*/
|
|
2595
2889
|
RoleARN: string | undefined;
|
|
2596
2890
|
/**
|
|
2891
|
+
* @public
|
|
2597
2892
|
* <p>The database connection string.</p>
|
|
2598
2893
|
*/
|
|
2599
2894
|
ClusterJDBCURL: string | undefined;
|
|
2600
2895
|
/**
|
|
2896
|
+
* @public
|
|
2601
2897
|
* <p>The <code>COPY</code> command.</p>
|
|
2602
2898
|
*/
|
|
2603
2899
|
CopyCommand: CopyCommand | undefined;
|
|
2604
2900
|
/**
|
|
2901
|
+
* @public
|
|
2605
2902
|
* <p>The name of the user.</p>
|
|
2606
2903
|
*/
|
|
2607
2904
|
Username: string | undefined;
|
|
2608
2905
|
/**
|
|
2906
|
+
* @public
|
|
2609
2907
|
* <p>The retry behavior in case Kinesis Data Firehose is unable to deliver documents to
|
|
2610
2908
|
* Amazon Redshift. Default value is 3600 (60 minutes).</p>
|
|
2611
2909
|
*/
|
|
2612
2910
|
RetryOptions?: RedshiftRetryOptions;
|
|
2613
2911
|
/**
|
|
2912
|
+
* @public
|
|
2614
2913
|
* <p>The Amazon S3 destination.</p>
|
|
2615
2914
|
*/
|
|
2616
2915
|
S3DestinationDescription: S3DestinationDescription | undefined;
|
|
2617
2916
|
/**
|
|
2917
|
+
* @public
|
|
2618
2918
|
* <p>The data processing configuration.</p>
|
|
2619
2919
|
*/
|
|
2620
2920
|
ProcessingConfiguration?: ProcessingConfiguration;
|
|
2621
2921
|
/**
|
|
2922
|
+
* @public
|
|
2622
2923
|
* <p>The Amazon S3 backup mode.</p>
|
|
2623
2924
|
*/
|
|
2624
2925
|
S3BackupMode?: RedshiftS3BackupMode | string;
|
|
2625
2926
|
/**
|
|
2927
|
+
* @public
|
|
2626
2928
|
* <p>The configuration for backup in Amazon S3.</p>
|
|
2627
2929
|
*/
|
|
2628
2930
|
S3BackupDescription?: S3DestinationDescription;
|
|
2629
2931
|
/**
|
|
2932
|
+
* @public
|
|
2630
2933
|
* <p>The Amazon CloudWatch logging options for your delivery stream.</p>
|
|
2631
2934
|
*/
|
|
2632
2935
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
|
@@ -2637,20 +2940,24 @@ export interface RedshiftDestinationDescription {
|
|
|
2637
2940
|
*/
|
|
2638
2941
|
export interface SplunkDestinationDescription {
|
|
2639
2942
|
/**
|
|
2943
|
+
* @public
|
|
2640
2944
|
* <p>The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your
|
|
2641
2945
|
* data.</p>
|
|
2642
2946
|
*/
|
|
2643
2947
|
HECEndpoint?: string;
|
|
2644
2948
|
/**
|
|
2949
|
+
* @public
|
|
2645
2950
|
* <p>This type can be either "Raw" or "Event."</p>
|
|
2646
2951
|
*/
|
|
2647
2952
|
HECEndpointType?: HECEndpointType | string;
|
|
2648
2953
|
/**
|
|
2954
|
+
* @public
|
|
2649
2955
|
* <p>A GUID you obtain from your Splunk cluster when you create a new HEC
|
|
2650
2956
|
* endpoint.</p>
|
|
2651
2957
|
*/
|
|
2652
2958
|
HECToken?: string;
|
|
2653
2959
|
/**
|
|
2960
|
+
* @public
|
|
2654
2961
|
* <p>The amount of time that Kinesis Data Firehose waits to receive an acknowledgment from
|
|
2655
2962
|
* Splunk after it sends it data. At the end of the timeout period, Kinesis Data Firehose
|
|
2656
2963
|
* either tries to send the data again or considers it an error, based on your retry
|
|
@@ -2658,11 +2965,13 @@ export interface SplunkDestinationDescription {
|
|
|
2658
2965
|
*/
|
|
2659
2966
|
HECAcknowledgmentTimeoutInSeconds?: number;
|
|
2660
2967
|
/**
|
|
2968
|
+
* @public
|
|
2661
2969
|
* <p>The retry behavior in case Kinesis Data Firehose is unable to deliver data to Splunk
|
|
2662
2970
|
* or if it doesn't receive an acknowledgment of receipt from Splunk.</p>
|
|
2663
2971
|
*/
|
|
2664
2972
|
RetryOptions?: SplunkRetryOptions;
|
|
2665
2973
|
/**
|
|
2974
|
+
* @public
|
|
2666
2975
|
* <p>Defines how documents should be delivered to Amazon S3. When set to
|
|
2667
2976
|
* <code>FailedDocumentsOnly</code>, Kinesis Data Firehose writes any data that could not
|
|
2668
2977
|
* be indexed to the configured Amazon S3 destination. When set to <code>AllDocuments</code>,
|
|
@@ -2671,14 +2980,17 @@ export interface SplunkDestinationDescription {
|
|
|
2671
2980
|
*/
|
|
2672
2981
|
S3BackupMode?: SplunkS3BackupMode | string;
|
|
2673
2982
|
/**
|
|
2983
|
+
* @public
|
|
2674
2984
|
* <p>The Amazon S3 destination.></p>
|
|
2675
2985
|
*/
|
|
2676
2986
|
S3DestinationDescription?: S3DestinationDescription;
|
|
2677
2987
|
/**
|
|
2988
|
+
* @public
|
|
2678
2989
|
* <p>The data processing configuration.</p>
|
|
2679
2990
|
*/
|
|
2680
2991
|
ProcessingConfiguration?: ProcessingConfiguration;
|
|
2681
2992
|
/**
|
|
2993
|
+
* @public
|
|
2682
2994
|
* <p>The Amazon CloudWatch logging options for your delivery stream.</p>
|
|
2683
2995
|
*/
|
|
2684
2996
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
|
@@ -2689,38 +3001,47 @@ export interface SplunkDestinationDescription {
|
|
|
2689
3001
|
*/
|
|
2690
3002
|
export interface DestinationDescription {
|
|
2691
3003
|
/**
|
|
3004
|
+
* @public
|
|
2692
3005
|
* <p>The ID of the destination.</p>
|
|
2693
3006
|
*/
|
|
2694
3007
|
DestinationId: string | undefined;
|
|
2695
3008
|
/**
|
|
3009
|
+
* @public
|
|
2696
3010
|
* <p>[Deprecated] The destination in Amazon S3.</p>
|
|
2697
3011
|
*/
|
|
2698
3012
|
S3DestinationDescription?: S3DestinationDescription;
|
|
2699
3013
|
/**
|
|
3014
|
+
* @public
|
|
2700
3015
|
* <p>The destination in Amazon S3.</p>
|
|
2701
3016
|
*/
|
|
2702
3017
|
ExtendedS3DestinationDescription?: ExtendedS3DestinationDescription;
|
|
2703
3018
|
/**
|
|
3019
|
+
* @public
|
|
2704
3020
|
* <p>The destination in Amazon Redshift.</p>
|
|
2705
3021
|
*/
|
|
2706
3022
|
RedshiftDestinationDescription?: RedshiftDestinationDescription;
|
|
2707
3023
|
/**
|
|
3024
|
+
* @public
|
|
2708
3025
|
* <p>The destination in Amazon ES.</p>
|
|
2709
3026
|
*/
|
|
2710
3027
|
ElasticsearchDestinationDescription?: ElasticsearchDestinationDescription;
|
|
2711
3028
|
/**
|
|
3029
|
+
* @public
|
|
2712
3030
|
* <p>The destination in Amazon OpenSearch Service.</p>
|
|
2713
3031
|
*/
|
|
2714
3032
|
AmazonopensearchserviceDestinationDescription?: AmazonopensearchserviceDestinationDescription;
|
|
2715
3033
|
/**
|
|
3034
|
+
* @public
|
|
2716
3035
|
* <p>The destination in Splunk.</p>
|
|
2717
3036
|
*/
|
|
2718
3037
|
SplunkDestinationDescription?: SplunkDestinationDescription;
|
|
2719
3038
|
/**
|
|
3039
|
+
* @public
|
|
2720
3040
|
* <p>Describes the specified HTTP endpoint destination.</p>
|
|
2721
3041
|
*/
|
|
2722
3042
|
HttpEndpointDestinationDescription?: HttpEndpointDestinationDescription;
|
|
2723
3043
|
/**
|
|
3044
|
+
* @public
|
|
2724
3045
|
* <p>The destination in the Serverless offering for Amazon OpenSearch Service.</p>
|
|
2725
3046
|
*/
|
|
2726
3047
|
AmazonOpenSearchServerlessDestinationDescription?: AmazonOpenSearchServerlessDestinationDescription;
|
|
@@ -2732,18 +3053,21 @@ export interface DestinationDescription {
|
|
|
2732
3053
|
*/
|
|
2733
3054
|
export interface KinesisStreamSourceDescription {
|
|
2734
3055
|
/**
|
|
3056
|
+
* @public
|
|
2735
3057
|
* <p>The Amazon Resource Name (ARN) of the source Kinesis data stream. For more
|
|
2736
3058
|
* information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams">Amazon
|
|
2737
3059
|
* Kinesis Data Streams ARN Format</a>.</p>
|
|
2738
3060
|
*/
|
|
2739
3061
|
KinesisStreamARN?: string;
|
|
2740
3062
|
/**
|
|
3063
|
+
* @public
|
|
2741
3064
|
* <p>The ARN of the role used by the source Kinesis data stream. For more information, see
|
|
2742
3065
|
* <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam">Amazon Web Services
|
|
2743
3066
|
* Identity and Access Management (IAM) ARN Format</a>.</p>
|
|
2744
3067
|
*/
|
|
2745
3068
|
RoleARN?: string;
|
|
2746
3069
|
/**
|
|
3070
|
+
* @public
|
|
2747
3071
|
* <p>Kinesis Data Firehose starts retrieving records from the Kinesis data stream starting
|
|
2748
3072
|
* with this timestamp.</p>
|
|
2749
3073
|
*/
|
|
@@ -2756,6 +3080,7 @@ export interface KinesisStreamSourceDescription {
|
|
|
2756
3080
|
*/
|
|
2757
3081
|
export interface SourceDescription {
|
|
2758
3082
|
/**
|
|
3083
|
+
* @public
|
|
2759
3084
|
* <p>The <a>KinesisStreamSourceDescription</a> value for the source Kinesis
|
|
2760
3085
|
* data stream.</p>
|
|
2761
3086
|
*/
|
|
@@ -2767,32 +3092,38 @@ export interface SourceDescription {
|
|
|
2767
3092
|
*/
|
|
2768
3093
|
export interface DeliveryStreamDescription {
|
|
2769
3094
|
/**
|
|
3095
|
+
* @public
|
|
2770
3096
|
* <p>The name of the delivery stream.</p>
|
|
2771
3097
|
*/
|
|
2772
3098
|
DeliveryStreamName: string | undefined;
|
|
2773
3099
|
/**
|
|
3100
|
+
* @public
|
|
2774
3101
|
* <p>The Amazon Resource Name (ARN) of the delivery stream. For more information, see
|
|
2775
3102
|
* <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
|
|
2776
3103
|
* Resource Names (ARNs) and Amazon Web Services Service Namespaces</a>.</p>
|
|
2777
3104
|
*/
|
|
2778
3105
|
DeliveryStreamARN: string | undefined;
|
|
2779
3106
|
/**
|
|
3107
|
+
* @public
|
|
2780
3108
|
* <p>The status of the delivery stream. If the status of a delivery stream is
|
|
2781
3109
|
* <code>CREATING_FAILED</code>, this status doesn't change, and you can't invoke
|
|
2782
3110
|
* <code>CreateDeliveryStream</code> again on it. However, you can invoke the <a>DeleteDeliveryStream</a> operation to delete it.</p>
|
|
2783
3111
|
*/
|
|
2784
3112
|
DeliveryStreamStatus: DeliveryStreamStatus | string | undefined;
|
|
2785
3113
|
/**
|
|
3114
|
+
* @public
|
|
2786
3115
|
* <p>Provides details in case one of the following operations fails due to an error related
|
|
2787
3116
|
* to KMS: <a>CreateDeliveryStream</a>, <a>DeleteDeliveryStream</a>,
|
|
2788
3117
|
* <a>StartDeliveryStreamEncryption</a>, <a>StopDeliveryStreamEncryption</a>.</p>
|
|
2789
3118
|
*/
|
|
2790
3119
|
FailureDescription?: FailureDescription;
|
|
2791
3120
|
/**
|
|
3121
|
+
* @public
|
|
2792
3122
|
* <p>Indicates the server-side encryption (SSE) status for the delivery stream.</p>
|
|
2793
3123
|
*/
|
|
2794
3124
|
DeliveryStreamEncryptionConfiguration?: DeliveryStreamEncryptionConfiguration;
|
|
2795
3125
|
/**
|
|
3126
|
+
* @public
|
|
2796
3127
|
* <p>The delivery stream type. This can be one of the following values:</p>
|
|
2797
3128
|
* <ul>
|
|
2798
3129
|
* <li>
|
|
@@ -2809,6 +3140,7 @@ export interface DeliveryStreamDescription {
|
|
|
2809
3140
|
*/
|
|
2810
3141
|
DeliveryStreamType: DeliveryStreamType | string | undefined;
|
|
2811
3142
|
/**
|
|
3143
|
+
* @public
|
|
2812
3144
|
* <p>Each time the destination is updated for a delivery stream, the version ID is
|
|
2813
3145
|
* changed, and the current version ID is required when updating the destination. This is so
|
|
2814
3146
|
* that the service knows it is applying the changes to the correct version of the delivery
|
|
@@ -2816,24 +3148,29 @@ export interface DeliveryStreamDescription {
|
|
|
2816
3148
|
*/
|
|
2817
3149
|
VersionId: string | undefined;
|
|
2818
3150
|
/**
|
|
3151
|
+
* @public
|
|
2819
3152
|
* <p>The date and time that the delivery stream was created.</p>
|
|
2820
3153
|
*/
|
|
2821
3154
|
CreateTimestamp?: Date;
|
|
2822
3155
|
/**
|
|
3156
|
+
* @public
|
|
2823
3157
|
* <p>The date and time that the delivery stream was last updated.</p>
|
|
2824
3158
|
*/
|
|
2825
3159
|
LastUpdateTimestamp?: Date;
|
|
2826
3160
|
/**
|
|
3161
|
+
* @public
|
|
2827
3162
|
* <p>If the <code>DeliveryStreamType</code> parameter is
|
|
2828
3163
|
* <code>KinesisStreamAsSource</code>, a <a>SourceDescription</a> object
|
|
2829
3164
|
* describing the source Kinesis data stream.</p>
|
|
2830
3165
|
*/
|
|
2831
3166
|
Source?: SourceDescription;
|
|
2832
3167
|
/**
|
|
3168
|
+
* @public
|
|
2833
3169
|
* <p>The destinations.</p>
|
|
2834
3170
|
*/
|
|
2835
3171
|
Destinations: DestinationDescription[] | undefined;
|
|
2836
3172
|
/**
|
|
3173
|
+
* @public
|
|
2837
3174
|
* <p>Indicates whether there are more destinations available to list.</p>
|
|
2838
3175
|
*/
|
|
2839
3176
|
HasMoreDestinations: boolean | undefined;
|
|
@@ -2843,15 +3180,18 @@ export interface DeliveryStreamDescription {
|
|
|
2843
3180
|
*/
|
|
2844
3181
|
export interface DescribeDeliveryStreamInput {
|
|
2845
3182
|
/**
|
|
3183
|
+
* @public
|
|
2846
3184
|
* <p>The name of the delivery stream.</p>
|
|
2847
3185
|
*/
|
|
2848
3186
|
DeliveryStreamName: string | undefined;
|
|
2849
3187
|
/**
|
|
3188
|
+
* @public
|
|
2850
3189
|
* <p>The limit on the number of destinations to return. You can have one destination per
|
|
2851
3190
|
* delivery stream.</p>
|
|
2852
3191
|
*/
|
|
2853
3192
|
Limit?: number;
|
|
2854
3193
|
/**
|
|
3194
|
+
* @public
|
|
2855
3195
|
* <p>The ID of the destination to start returning the destination information. Kinesis
|
|
2856
3196
|
* Data Firehose supports one destination per delivery stream.</p>
|
|
2857
3197
|
*/
|
|
@@ -2862,6 +3202,7 @@ export interface DescribeDeliveryStreamInput {
|
|
|
2862
3202
|
*/
|
|
2863
3203
|
export interface DescribeDeliveryStreamOutput {
|
|
2864
3204
|
/**
|
|
3205
|
+
* @public
|
|
2865
3206
|
* <p>Information about the delivery stream.</p>
|
|
2866
3207
|
*/
|
|
2867
3208
|
DeliveryStreamDescription: DeliveryStreamDescription | undefined;
|
|
@@ -2872,6 +3213,7 @@ export interface DescribeDeliveryStreamOutput {
|
|
|
2872
3213
|
*/
|
|
2873
3214
|
export interface ElasticsearchDestinationUpdate {
|
|
2874
3215
|
/**
|
|
3216
|
+
* @public
|
|
2875
3217
|
* <p>The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose
|
|
2876
3218
|
* for calling the Amazon ES Configuration API and for indexing documents. For more
|
|
2877
3219
|
* information, see <a href="https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3">Grant Kinesis Data
|
|
@@ -2880,6 +3222,7 @@ export interface ElasticsearchDestinationUpdate {
|
|
|
2880
3222
|
*/
|
|
2881
3223
|
RoleARN?: string;
|
|
2882
3224
|
/**
|
|
3225
|
+
* @public
|
|
2883
3226
|
* <p>The ARN of the Amazon ES domain. The IAM role must have permissions
|
|
2884
3227
|
* for <code>DescribeDomain</code>, <code>DescribeDomains</code>, and
|
|
2885
3228
|
* <code>DescribeDomainConfig</code> after assuming the IAM role specified in
|
|
@@ -2890,15 +3233,18 @@ export interface ElasticsearchDestinationUpdate {
|
|
|
2890
3233
|
*/
|
|
2891
3234
|
DomainARN?: string;
|
|
2892
3235
|
/**
|
|
3236
|
+
* @public
|
|
2893
3237
|
* <p>The endpoint to use when communicating with the cluster. Specify either this
|
|
2894
3238
|
* <code>ClusterEndpoint</code> or the <code>DomainARN</code> field.</p>
|
|
2895
3239
|
*/
|
|
2896
3240
|
ClusterEndpoint?: string;
|
|
2897
3241
|
/**
|
|
3242
|
+
* @public
|
|
2898
3243
|
* <p>The Elasticsearch index name.</p>
|
|
2899
3244
|
*/
|
|
2900
3245
|
IndexName?: string;
|
|
2901
3246
|
/**
|
|
3247
|
+
* @public
|
|
2902
3248
|
* <p>The Elasticsearch type name. For Elasticsearch 6.x, there can be only one type per
|
|
2903
3249
|
* index. If you try to specify a new type for an existing index that already has another
|
|
2904
3250
|
* type, Kinesis Data Firehose returns an error during runtime.</p>
|
|
@@ -2910,6 +3256,7 @@ export interface ElasticsearchDestinationUpdate {
|
|
|
2910
3256
|
*/
|
|
2911
3257
|
TypeName?: string;
|
|
2912
3258
|
/**
|
|
3259
|
+
* @public
|
|
2913
3260
|
* <p>The Elasticsearch index rotation period. Index rotation appends a timestamp to
|
|
2914
3261
|
* <code>IndexName</code> to facilitate the expiration of old data. For more information,
|
|
2915
3262
|
* see <a href="https://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-index-rotation">Index Rotation for the
|
|
@@ -2917,24 +3264,29 @@ export interface ElasticsearchDestinationUpdate {
|
|
|
2917
3264
|
*/
|
|
2918
3265
|
IndexRotationPeriod?: ElasticsearchIndexRotationPeriod | string;
|
|
2919
3266
|
/**
|
|
3267
|
+
* @public
|
|
2920
3268
|
* <p>The buffering options. If no value is specified,
|
|
2921
3269
|
* <code>ElasticsearchBufferingHints</code> object default values are used. </p>
|
|
2922
3270
|
*/
|
|
2923
3271
|
BufferingHints?: ElasticsearchBufferingHints;
|
|
2924
3272
|
/**
|
|
3273
|
+
* @public
|
|
2925
3274
|
* <p>The retry behavior in case Kinesis Data Firehose is unable to deliver documents to
|
|
2926
3275
|
* Amazon ES. The default value is 300 (5 minutes).</p>
|
|
2927
3276
|
*/
|
|
2928
3277
|
RetryOptions?: ElasticsearchRetryOptions;
|
|
2929
3278
|
/**
|
|
3279
|
+
* @public
|
|
2930
3280
|
* <p>The Amazon S3 destination.</p>
|
|
2931
3281
|
*/
|
|
2932
3282
|
S3Update?: S3DestinationUpdate;
|
|
2933
3283
|
/**
|
|
3284
|
+
* @public
|
|
2934
3285
|
* <p>The data processing configuration.</p>
|
|
2935
3286
|
*/
|
|
2936
3287
|
ProcessingConfiguration?: ProcessingConfiguration;
|
|
2937
3288
|
/**
|
|
3289
|
+
* @public
|
|
2938
3290
|
* <p>The CloudWatch logging options for your delivery stream.</p>
|
|
2939
3291
|
*/
|
|
2940
3292
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
|
@@ -2945,23 +3297,27 @@ export interface ElasticsearchDestinationUpdate {
|
|
|
2945
3297
|
*/
|
|
2946
3298
|
export interface ExtendedS3DestinationUpdate {
|
|
2947
3299
|
/**
|
|
3300
|
+
* @public
|
|
2948
3301
|
* <p>The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more
|
|
2949
3302
|
* information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and
|
|
2950
3303
|
* Amazon Web Services Service Namespaces</a>.</p>
|
|
2951
3304
|
*/
|
|
2952
3305
|
RoleARN?: string;
|
|
2953
3306
|
/**
|
|
3307
|
+
* @public
|
|
2954
3308
|
* <p>The ARN of the S3 bucket. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and
|
|
2955
3309
|
* Amazon Web Services Service Namespaces</a>.</p>
|
|
2956
3310
|
*/
|
|
2957
3311
|
BucketARN?: string;
|
|
2958
3312
|
/**
|
|
3313
|
+
* @public
|
|
2959
3314
|
* <p>The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3
|
|
2960
3315
|
* files. You can also specify a custom prefix, as described in <a href="https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html">Custom Prefixes for Amazon S3
|
|
2961
3316
|
* Objects</a>.</p>
|
|
2962
3317
|
*/
|
|
2963
3318
|
Prefix?: string;
|
|
2964
3319
|
/**
|
|
3320
|
+
* @public
|
|
2965
3321
|
* <p>A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing
|
|
2966
3322
|
* them to S3. This prefix appears immediately following the bucket name. For information
|
|
2967
3323
|
* about how to specify this prefix, see <a href="https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html">Custom Prefixes for Amazon S3
|
|
@@ -2969,42 +3325,51 @@ export interface ExtendedS3DestinationUpdate {
|
|
|
2969
3325
|
*/
|
|
2970
3326
|
ErrorOutputPrefix?: string;
|
|
2971
3327
|
/**
|
|
3328
|
+
* @public
|
|
2972
3329
|
* <p>The buffering option.</p>
|
|
2973
3330
|
*/
|
|
2974
3331
|
BufferingHints?: BufferingHints;
|
|
2975
3332
|
/**
|
|
3333
|
+
* @public
|
|
2976
3334
|
* <p>The compression format. If no value is specified, the default is
|
|
2977
3335
|
* <code>UNCOMPRESSED</code>. </p>
|
|
2978
3336
|
*/
|
|
2979
3337
|
CompressionFormat?: CompressionFormat | string;
|
|
2980
3338
|
/**
|
|
3339
|
+
* @public
|
|
2981
3340
|
* <p>The encryption configuration. If no value is specified, the default is no
|
|
2982
3341
|
* encryption.</p>
|
|
2983
3342
|
*/
|
|
2984
3343
|
EncryptionConfiguration?: EncryptionConfiguration;
|
|
2985
3344
|
/**
|
|
3345
|
+
* @public
|
|
2986
3346
|
* <p>The Amazon CloudWatch logging options for your delivery stream.</p>
|
|
2987
3347
|
*/
|
|
2988
3348
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
|
2989
3349
|
/**
|
|
3350
|
+
* @public
|
|
2990
3351
|
* <p>The data processing configuration.</p>
|
|
2991
3352
|
*/
|
|
2992
3353
|
ProcessingConfiguration?: ProcessingConfiguration;
|
|
2993
3354
|
/**
|
|
3355
|
+
* @public
|
|
2994
3356
|
* <p>You can update a delivery stream to enable Amazon S3 backup if it is disabled. If
|
|
2995
3357
|
* backup is enabled, you can't update the delivery stream to disable it. </p>
|
|
2996
3358
|
*/
|
|
2997
3359
|
S3BackupMode?: S3BackupMode | string;
|
|
2998
3360
|
/**
|
|
3361
|
+
* @public
|
|
2999
3362
|
* <p>The Amazon S3 destination for backup.</p>
|
|
3000
3363
|
*/
|
|
3001
3364
|
S3BackupUpdate?: S3DestinationUpdate;
|
|
3002
3365
|
/**
|
|
3366
|
+
* @public
|
|
3003
3367
|
* <p>The serializer, deserializer, and schema for converting data from the JSON format to
|
|
3004
3368
|
* the Parquet or ORC format before writing it to Amazon S3.</p>
|
|
3005
3369
|
*/
|
|
3006
3370
|
DataFormatConversionConfiguration?: DataFormatConversionConfiguration;
|
|
3007
3371
|
/**
|
|
3372
|
+
* @public
|
|
3008
3373
|
* <p>The configuration of the dynamic partitioning mechanism that creates smaller data sets
|
|
3009
3374
|
* from the streaming data by partitioning it based on partition keys. Currently, dynamic
|
|
3010
3375
|
* partitioning is only supported for Amazon S3 destinations.
|
|
@@ -3017,10 +3382,12 @@ export interface ExtendedS3DestinationUpdate {
|
|
|
3017
3382
|
*/
|
|
3018
3383
|
export interface ListDeliveryStreamsInput {
|
|
3019
3384
|
/**
|
|
3385
|
+
* @public
|
|
3020
3386
|
* <p>The maximum number of delivery streams to list. The default value is 10.</p>
|
|
3021
3387
|
*/
|
|
3022
3388
|
Limit?: number;
|
|
3023
3389
|
/**
|
|
3390
|
+
* @public
|
|
3024
3391
|
* <p>The delivery stream type. This can be one of the following values:</p>
|
|
3025
3392
|
* <ul>
|
|
3026
3393
|
* <li>
|
|
@@ -3039,6 +3406,7 @@ export interface ListDeliveryStreamsInput {
|
|
|
3039
3406
|
*/
|
|
3040
3407
|
DeliveryStreamType?: DeliveryStreamType | string;
|
|
3041
3408
|
/**
|
|
3409
|
+
* @public
|
|
3042
3410
|
* <p>The list of delivery streams returned by this call to
|
|
3043
3411
|
* <code>ListDeliveryStreams</code> will start with the delivery stream whose name comes
|
|
3044
3412
|
* alphabetically immediately after the name you specify in
|
|
@@ -3051,10 +3419,12 @@ export interface ListDeliveryStreamsInput {
|
|
|
3051
3419
|
*/
|
|
3052
3420
|
export interface ListDeliveryStreamsOutput {
|
|
3053
3421
|
/**
|
|
3422
|
+
* @public
|
|
3054
3423
|
* <p>The names of the delivery streams.</p>
|
|
3055
3424
|
*/
|
|
3056
3425
|
DeliveryStreamNames: string[] | undefined;
|
|
3057
3426
|
/**
|
|
3427
|
+
* @public
|
|
3058
3428
|
* <p>Indicates whether there are more delivery streams available to list.</p>
|
|
3059
3429
|
*/
|
|
3060
3430
|
HasMoreDeliveryStreams: boolean | undefined;
|
|
@@ -3064,16 +3434,19 @@ export interface ListDeliveryStreamsOutput {
|
|
|
3064
3434
|
*/
|
|
3065
3435
|
export interface ListTagsForDeliveryStreamInput {
|
|
3066
3436
|
/**
|
|
3437
|
+
* @public
|
|
3067
3438
|
* <p>The name of the delivery stream whose tags you want to list.</p>
|
|
3068
3439
|
*/
|
|
3069
3440
|
DeliveryStreamName: string | undefined;
|
|
3070
3441
|
/**
|
|
3442
|
+
* @public
|
|
3071
3443
|
* <p>The key to use as the starting point for the list of tags. If you set this parameter,
|
|
3072
3444
|
* <code>ListTagsForDeliveryStream</code> gets all tags that occur after
|
|
3073
3445
|
* <code>ExclusiveStartTagKey</code>.</p>
|
|
3074
3446
|
*/
|
|
3075
3447
|
ExclusiveStartTagKey?: string;
|
|
3076
3448
|
/**
|
|
3449
|
+
* @public
|
|
3077
3450
|
* <p>The number of tags to return. If this number is less than the total number of tags
|
|
3078
3451
|
* associated with the delivery stream, <code>HasMoreTags</code> is set to <code>true</code>
|
|
3079
3452
|
* in the response. To list additional tags, set <code>ExclusiveStartTagKey</code> to the last
|
|
@@ -3086,12 +3459,14 @@ export interface ListTagsForDeliveryStreamInput {
|
|
|
3086
3459
|
*/
|
|
3087
3460
|
export interface ListTagsForDeliveryStreamOutput {
|
|
3088
3461
|
/**
|
|
3462
|
+
* @public
|
|
3089
3463
|
* <p>A list of tags associated with <code>DeliveryStreamName</code>, starting with the
|
|
3090
3464
|
* first tag after <code>ExclusiveStartTagKey</code> and up to the specified
|
|
3091
3465
|
* <code>Limit</code>.</p>
|
|
3092
3466
|
*/
|
|
3093
3467
|
Tags: Tag[] | undefined;
|
|
3094
3468
|
/**
|
|
3469
|
+
* @public
|
|
3095
3470
|
* <p>If this is <code>true</code> in the response, more tags are available. To list the
|
|
3096
3471
|
* remaining tags, set <code>ExclusiveStartTagKey</code> to the key of the last tag returned
|
|
3097
3472
|
* and call <code>ListTagsForDeliveryStream</code> again.</p>
|
|
@@ -3104,6 +3479,7 @@ export interface ListTagsForDeliveryStreamOutput {
|
|
|
3104
3479
|
*/
|
|
3105
3480
|
export interface _Record {
|
|
3106
3481
|
/**
|
|
3482
|
+
* @public
|
|
3107
3483
|
* <p>The data blob, which is base64-encoded when the blob is serialized. The maximum size
|
|
3108
3484
|
* of the data blob, before base64-encoding, is 1,000 KiB.</p>
|
|
3109
3485
|
*/
|
|
@@ -3114,10 +3490,12 @@ export interface _Record {
|
|
|
3114
3490
|
*/
|
|
3115
3491
|
export interface PutRecordInput {
|
|
3116
3492
|
/**
|
|
3493
|
+
* @public
|
|
3117
3494
|
* <p>The name of the delivery stream.</p>
|
|
3118
3495
|
*/
|
|
3119
3496
|
DeliveryStreamName: string | undefined;
|
|
3120
3497
|
/**
|
|
3498
|
+
* @public
|
|
3121
3499
|
* <p>The record.</p>
|
|
3122
3500
|
*/
|
|
3123
3501
|
Record: _Record | undefined;
|
|
@@ -3127,10 +3505,12 @@ export interface PutRecordInput {
|
|
|
3127
3505
|
*/
|
|
3128
3506
|
export interface PutRecordOutput {
|
|
3129
3507
|
/**
|
|
3508
|
+
* @public
|
|
3130
3509
|
* <p>The ID of the record.</p>
|
|
3131
3510
|
*/
|
|
3132
3511
|
RecordId: string | undefined;
|
|
3133
3512
|
/**
|
|
3513
|
+
* @public
|
|
3134
3514
|
* <p>Indicates whether server-side encryption (SSE) was enabled during this operation.</p>
|
|
3135
3515
|
*/
|
|
3136
3516
|
Encrypted?: boolean;
|
|
@@ -3155,10 +3535,12 @@ export declare class ServiceUnavailableException extends __BaseException {
|
|
|
3155
3535
|
*/
|
|
3156
3536
|
export interface PutRecordBatchInput {
|
|
3157
3537
|
/**
|
|
3538
|
+
* @public
|
|
3158
3539
|
* <p>The name of the delivery stream.</p>
|
|
3159
3540
|
*/
|
|
3160
3541
|
DeliveryStreamName: string | undefined;
|
|
3161
3542
|
/**
|
|
3543
|
+
* @public
|
|
3162
3544
|
* <p>One or more records.</p>
|
|
3163
3545
|
*/
|
|
3164
3546
|
Records: _Record[] | undefined;
|
|
@@ -3172,14 +3554,17 @@ export interface PutRecordBatchInput {
|
|
|
3172
3554
|
*/
|
|
3173
3555
|
export interface PutRecordBatchResponseEntry {
|
|
3174
3556
|
/**
|
|
3557
|
+
* @public
|
|
3175
3558
|
* <p>The ID of the record.</p>
|
|
3176
3559
|
*/
|
|
3177
3560
|
RecordId?: string;
|
|
3178
3561
|
/**
|
|
3562
|
+
* @public
|
|
3179
3563
|
* <p>The error code for an individual record result.</p>
|
|
3180
3564
|
*/
|
|
3181
3565
|
ErrorCode?: string;
|
|
3182
3566
|
/**
|
|
3567
|
+
* @public
|
|
3183
3568
|
* <p>The error message for an individual record result.</p>
|
|
3184
3569
|
*/
|
|
3185
3570
|
ErrorMessage?: string;
|
|
@@ -3189,6 +3574,7 @@ export interface PutRecordBatchResponseEntry {
|
|
|
3189
3574
|
*/
|
|
3190
3575
|
export interface PutRecordBatchOutput {
|
|
3191
3576
|
/**
|
|
3577
|
+
* @public
|
|
3192
3578
|
* <p>The number of records that might have failed processing. This number might be greater
|
|
3193
3579
|
* than 0 even if the <a>PutRecordBatch</a> call succeeds. Check
|
|
3194
3580
|
* <code>FailedPutCount</code> to determine whether there are records that you need to
|
|
@@ -3196,10 +3582,12 @@ export interface PutRecordBatchOutput {
|
|
|
3196
3582
|
*/
|
|
3197
3583
|
FailedPutCount: number | undefined;
|
|
3198
3584
|
/**
|
|
3585
|
+
* @public
|
|
3199
3586
|
* <p>Indicates whether server-side encryption (SSE) was enabled during this operation.</p>
|
|
3200
3587
|
*/
|
|
3201
3588
|
Encrypted?: boolean;
|
|
3202
3589
|
/**
|
|
3590
|
+
* @public
|
|
3203
3591
|
* <p>The results array. For each record, the index of the response element is the same as
|
|
3204
3592
|
* the index used in the request array.</p>
|
|
3205
3593
|
*/
|
|
@@ -3210,11 +3598,13 @@ export interface PutRecordBatchOutput {
|
|
|
3210
3598
|
*/
|
|
3211
3599
|
export interface StartDeliveryStreamEncryptionInput {
|
|
3212
3600
|
/**
|
|
3601
|
+
* @public
|
|
3213
3602
|
* <p>The name of the delivery stream for which you want to enable server-side encryption
|
|
3214
3603
|
* (SSE).</p>
|
|
3215
3604
|
*/
|
|
3216
3605
|
DeliveryStreamName: string | undefined;
|
|
3217
3606
|
/**
|
|
3607
|
+
* @public
|
|
3218
3608
|
* <p>Used to specify the type and Amazon Resource Name (ARN) of the KMS key needed for
|
|
3219
3609
|
* Server-Side Encryption (SSE).</p>
|
|
3220
3610
|
*/
|
|
@@ -3230,6 +3620,7 @@ export interface StartDeliveryStreamEncryptionOutput {
|
|
|
3230
3620
|
*/
|
|
3231
3621
|
export interface StopDeliveryStreamEncryptionInput {
|
|
3232
3622
|
/**
|
|
3623
|
+
* @public
|
|
3233
3624
|
* <p>The name of the delivery stream for which you want to disable server-side encryption
|
|
3234
3625
|
* (SSE).</p>
|
|
3235
3626
|
*/
|
|
@@ -3245,10 +3636,12 @@ export interface StopDeliveryStreamEncryptionOutput {
|
|
|
3245
3636
|
*/
|
|
3246
3637
|
export interface TagDeliveryStreamInput {
|
|
3247
3638
|
/**
|
|
3639
|
+
* @public
|
|
3248
3640
|
* <p>The name of the delivery stream to which you want to add the tags.</p>
|
|
3249
3641
|
*/
|
|
3250
3642
|
DeliveryStreamName: string | undefined;
|
|
3251
3643
|
/**
|
|
3644
|
+
* @public
|
|
3252
3645
|
* <p>A set of key-value pairs to use to create the tags.</p>
|
|
3253
3646
|
*/
|
|
3254
3647
|
Tags: Tag[] | undefined;
|
|
@@ -3263,10 +3656,12 @@ export interface TagDeliveryStreamOutput {
|
|
|
3263
3656
|
*/
|
|
3264
3657
|
export interface UntagDeliveryStreamInput {
|
|
3265
3658
|
/**
|
|
3659
|
+
* @public
|
|
3266
3660
|
* <p>The name of the delivery stream.</p>
|
|
3267
3661
|
*/
|
|
3268
3662
|
DeliveryStreamName: string | undefined;
|
|
3269
3663
|
/**
|
|
3664
|
+
* @public
|
|
3270
3665
|
* <p>A list of tag keys. Each corresponding tag is removed from the delivery
|
|
3271
3666
|
* stream.</p>
|
|
3272
3667
|
*/
|
|
@@ -3283,10 +3678,12 @@ export interface UntagDeliveryStreamOutput {
|
|
|
3283
3678
|
*/
|
|
3284
3679
|
export interface HttpEndpointDestinationUpdate {
|
|
3285
3680
|
/**
|
|
3681
|
+
* @public
|
|
3286
3682
|
* <p>Describes the configuration of the HTTP endpoint destination.</p>
|
|
3287
3683
|
*/
|
|
3288
3684
|
EndpointConfiguration?: HttpEndpointConfiguration;
|
|
3289
3685
|
/**
|
|
3686
|
+
* @public
|
|
3290
3687
|
* <p>Describes buffering options that can be applied to the data before it is delivered to
|
|
3291
3688
|
* the HTTPS endpoint destination. Kinesis Data Firehose teats these options as hints, and it
|
|
3292
3689
|
* might choose to use more optimal values. The <code>SizeInMBs</code> and
|
|
@@ -3295,30 +3692,36 @@ export interface HttpEndpointDestinationUpdate {
|
|
|
3295
3692
|
*/
|
|
3296
3693
|
BufferingHints?: HttpEndpointBufferingHints;
|
|
3297
3694
|
/**
|
|
3695
|
+
* @public
|
|
3298
3696
|
* <p>Describes the Amazon CloudWatch logging options for your delivery stream.</p>
|
|
3299
3697
|
*/
|
|
3300
3698
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
|
3301
3699
|
/**
|
|
3700
|
+
* @public
|
|
3302
3701
|
* <p>The configuration of the request sent to the HTTP endpoint specified as the
|
|
3303
3702
|
* destination.</p>
|
|
3304
3703
|
*/
|
|
3305
3704
|
RequestConfiguration?: HttpEndpointRequestConfiguration;
|
|
3306
3705
|
/**
|
|
3706
|
+
* @public
|
|
3307
3707
|
* <p>Describes a data processing configuration.</p>
|
|
3308
3708
|
*/
|
|
3309
3709
|
ProcessingConfiguration?: ProcessingConfiguration;
|
|
3310
3710
|
/**
|
|
3711
|
+
* @public
|
|
3311
3712
|
* <p>Kinesis Data Firehose uses this IAM role for all the permissions that the delivery
|
|
3312
3713
|
* stream needs.</p>
|
|
3313
3714
|
*/
|
|
3314
3715
|
RoleARN?: string;
|
|
3315
3716
|
/**
|
|
3717
|
+
* @public
|
|
3316
3718
|
* <p>Describes the retry behavior in case Kinesis Data Firehose is unable to deliver data to
|
|
3317
3719
|
* the specified HTTP endpoint destination, or if it doesn't receive a valid acknowledgment of
|
|
3318
3720
|
* receipt from the specified HTTP endpoint destination.</p>
|
|
3319
3721
|
*/
|
|
3320
3722
|
RetryOptions?: HttpEndpointRetryOptions;
|
|
3321
3723
|
/**
|
|
3724
|
+
* @public
|
|
3322
3725
|
* <p>Describes the S3 bucket backup options for the data that Kinesis Firehose delivers to
|
|
3323
3726
|
* the HTTP endpoint destination. You can back up all documents (<code>AllData</code>) or only
|
|
3324
3727
|
* the documents that Kinesis Data Firehose could not deliver to the specified HTTP endpoint
|
|
@@ -3326,6 +3729,7 @@ export interface HttpEndpointDestinationUpdate {
|
|
|
3326
3729
|
*/
|
|
3327
3730
|
S3BackupMode?: HttpEndpointS3BackupMode | string;
|
|
3328
3731
|
/**
|
|
3732
|
+
* @public
|
|
3329
3733
|
* <p>Describes an update for a destination in Amazon S3.</p>
|
|
3330
3734
|
*/
|
|
3331
3735
|
S3Update?: S3DestinationUpdate;
|
|
@@ -3336,33 +3740,40 @@ export interface HttpEndpointDestinationUpdate {
|
|
|
3336
3740
|
*/
|
|
3337
3741
|
export interface RedshiftDestinationUpdate {
|
|
3338
3742
|
/**
|
|
3743
|
+
* @public
|
|
3339
3744
|
* <p>The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more
|
|
3340
3745
|
* information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and
|
|
3341
3746
|
* Amazon Web Services Service Namespaces</a>.</p>
|
|
3342
3747
|
*/
|
|
3343
3748
|
RoleARN?: string;
|
|
3344
3749
|
/**
|
|
3750
|
+
* @public
|
|
3345
3751
|
* <p>The database connection string.</p>
|
|
3346
3752
|
*/
|
|
3347
3753
|
ClusterJDBCURL?: string;
|
|
3348
3754
|
/**
|
|
3755
|
+
* @public
|
|
3349
3756
|
* <p>The <code>COPY</code> command.</p>
|
|
3350
3757
|
*/
|
|
3351
3758
|
CopyCommand?: CopyCommand;
|
|
3352
3759
|
/**
|
|
3760
|
+
* @public
|
|
3353
3761
|
* <p>The name of the user.</p>
|
|
3354
3762
|
*/
|
|
3355
3763
|
Username?: string;
|
|
3356
3764
|
/**
|
|
3765
|
+
* @public
|
|
3357
3766
|
* <p>The user password.</p>
|
|
3358
3767
|
*/
|
|
3359
3768
|
Password?: string;
|
|
3360
3769
|
/**
|
|
3770
|
+
* @public
|
|
3361
3771
|
* <p>The retry behavior in case Kinesis Data Firehose is unable to deliver documents to
|
|
3362
3772
|
* Amazon Redshift. Default value is 3600 (60 minutes).</p>
|
|
3363
3773
|
*/
|
|
3364
3774
|
RetryOptions?: RedshiftRetryOptions;
|
|
3365
3775
|
/**
|
|
3776
|
+
* @public
|
|
3366
3777
|
* <p>The Amazon S3 destination.</p>
|
|
3367
3778
|
* <p>The compression formats <code>SNAPPY</code> or <code>ZIP</code> cannot be specified
|
|
3368
3779
|
* in <code>RedshiftDestinationUpdate.S3Update</code> because the Amazon Redshift
|
|
@@ -3371,19 +3782,23 @@ export interface RedshiftDestinationUpdate {
|
|
|
3371
3782
|
*/
|
|
3372
3783
|
S3Update?: S3DestinationUpdate;
|
|
3373
3784
|
/**
|
|
3785
|
+
* @public
|
|
3374
3786
|
* <p>The data processing configuration.</p>
|
|
3375
3787
|
*/
|
|
3376
3788
|
ProcessingConfiguration?: ProcessingConfiguration;
|
|
3377
3789
|
/**
|
|
3790
|
+
* @public
|
|
3378
3791
|
* <p>You can update a delivery stream to enable Amazon S3 backup if it is disabled. If
|
|
3379
3792
|
* backup is enabled, you can't update the delivery stream to disable it. </p>
|
|
3380
3793
|
*/
|
|
3381
3794
|
S3BackupMode?: RedshiftS3BackupMode | string;
|
|
3382
3795
|
/**
|
|
3796
|
+
* @public
|
|
3383
3797
|
* <p>The Amazon S3 destination for backup.</p>
|
|
3384
3798
|
*/
|
|
3385
3799
|
S3BackupUpdate?: S3DestinationUpdate;
|
|
3386
3800
|
/**
|
|
3801
|
+
* @public
|
|
3387
3802
|
* <p>The Amazon CloudWatch logging options for your delivery stream.</p>
|
|
3388
3803
|
*/
|
|
3389
3804
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
|
@@ -3394,20 +3809,24 @@ export interface RedshiftDestinationUpdate {
|
|
|
3394
3809
|
*/
|
|
3395
3810
|
export interface SplunkDestinationUpdate {
|
|
3396
3811
|
/**
|
|
3812
|
+
* @public
|
|
3397
3813
|
* <p>The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your
|
|
3398
3814
|
* data.</p>
|
|
3399
3815
|
*/
|
|
3400
3816
|
HECEndpoint?: string;
|
|
3401
3817
|
/**
|
|
3818
|
+
* @public
|
|
3402
3819
|
* <p>This type can be either "Raw" or "Event."</p>
|
|
3403
3820
|
*/
|
|
3404
3821
|
HECEndpointType?: HECEndpointType | string;
|
|
3405
3822
|
/**
|
|
3823
|
+
* @public
|
|
3406
3824
|
* <p>A GUID that you obtain from your Splunk cluster when you create a new HEC
|
|
3407
3825
|
* endpoint.</p>
|
|
3408
3826
|
*/
|
|
3409
3827
|
HECToken?: string;
|
|
3410
3828
|
/**
|
|
3829
|
+
* @public
|
|
3411
3830
|
* <p>The amount of time that Kinesis Data Firehose waits to receive an acknowledgment from
|
|
3412
3831
|
* Splunk after it sends data. At the end of the timeout period, Kinesis Data Firehose either
|
|
3413
3832
|
* tries to send the data again or considers it an error, based on your retry
|
|
@@ -3415,11 +3834,13 @@ export interface SplunkDestinationUpdate {
|
|
|
3415
3834
|
*/
|
|
3416
3835
|
HECAcknowledgmentTimeoutInSeconds?: number;
|
|
3417
3836
|
/**
|
|
3837
|
+
* @public
|
|
3418
3838
|
* <p>The retry behavior in case Kinesis Data Firehose is unable to deliver data to Splunk
|
|
3419
3839
|
* or if it doesn't receive an acknowledgment of receipt from Splunk.</p>
|
|
3420
3840
|
*/
|
|
3421
3841
|
RetryOptions?: SplunkRetryOptions;
|
|
3422
3842
|
/**
|
|
3843
|
+
* @public
|
|
3423
3844
|
* <p>Specifies how you want Kinesis Data Firehose to back up documents to Amazon S3. When
|
|
3424
3845
|
* set to <code>FailedDocumentsOnly</code>, Kinesis Data Firehose writes any data that could
|
|
3425
3846
|
* not be indexed to the configured Amazon S3 destination. When set to <code>AllEvents</code>,
|
|
@@ -3431,14 +3852,17 @@ export interface SplunkDestinationUpdate {
|
|
|
3431
3852
|
*/
|
|
3432
3853
|
S3BackupMode?: SplunkS3BackupMode | string;
|
|
3433
3854
|
/**
|
|
3855
|
+
* @public
|
|
3434
3856
|
* <p>Your update to the configuration of the backup Amazon S3 location.</p>
|
|
3435
3857
|
*/
|
|
3436
3858
|
S3Update?: S3DestinationUpdate;
|
|
3437
3859
|
/**
|
|
3860
|
+
* @public
|
|
3438
3861
|
* <p>The data processing configuration.</p>
|
|
3439
3862
|
*/
|
|
3440
3863
|
ProcessingConfiguration?: ProcessingConfiguration;
|
|
3441
3864
|
/**
|
|
3865
|
+
* @public
|
|
3442
3866
|
* <p>The Amazon CloudWatch logging options for your delivery stream.</p>
|
|
3443
3867
|
*/
|
|
3444
3868
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
|
@@ -3448,10 +3872,12 @@ export interface SplunkDestinationUpdate {
|
|
|
3448
3872
|
*/
|
|
3449
3873
|
export interface UpdateDestinationInput {
|
|
3450
3874
|
/**
|
|
3875
|
+
* @public
|
|
3451
3876
|
* <p>The name of the delivery stream.</p>
|
|
3452
3877
|
*/
|
|
3453
3878
|
DeliveryStreamName: string | undefined;
|
|
3454
3879
|
/**
|
|
3880
|
+
* @public
|
|
3455
3881
|
* <p>Obtain this value from the <code>VersionId</code> result of <a>DeliveryStreamDescription</a>. This value is required, and helps the service
|
|
3456
3882
|
* perform conditional operations. For example, if there is an interleaving update and this
|
|
3457
3883
|
* value is null, then the update destination fails. After the update is successful, the
|
|
@@ -3460,40 +3886,49 @@ export interface UpdateDestinationInput {
|
|
|
3460
3886
|
*/
|
|
3461
3887
|
CurrentDeliveryStreamVersionId: string | undefined;
|
|
3462
3888
|
/**
|
|
3889
|
+
* @public
|
|
3463
3890
|
* <p>The ID of the destination.</p>
|
|
3464
3891
|
*/
|
|
3465
3892
|
DestinationId: string | undefined;
|
|
3466
3893
|
/**
|
|
3894
|
+
* @public
|
|
3467
3895
|
* @deprecated
|
|
3468
3896
|
*
|
|
3469
3897
|
* <p>[Deprecated] Describes an update for a destination in Amazon S3.</p>
|
|
3470
3898
|
*/
|
|
3471
3899
|
S3DestinationUpdate?: S3DestinationUpdate;
|
|
3472
3900
|
/**
|
|
3901
|
+
* @public
|
|
3473
3902
|
* <p>Describes an update for a destination in Amazon S3.</p>
|
|
3474
3903
|
*/
|
|
3475
3904
|
ExtendedS3DestinationUpdate?: ExtendedS3DestinationUpdate;
|
|
3476
3905
|
/**
|
|
3906
|
+
* @public
|
|
3477
3907
|
* <p>Describes an update for a destination in Amazon Redshift.</p>
|
|
3478
3908
|
*/
|
|
3479
3909
|
RedshiftDestinationUpdate?: RedshiftDestinationUpdate;
|
|
3480
3910
|
/**
|
|
3911
|
+
* @public
|
|
3481
3912
|
* <p>Describes an update for a destination in Amazon ES.</p>
|
|
3482
3913
|
*/
|
|
3483
3914
|
ElasticsearchDestinationUpdate?: ElasticsearchDestinationUpdate;
|
|
3484
3915
|
/**
|
|
3916
|
+
* @public
|
|
3485
3917
|
* <p>Describes an update for a destination in Amazon OpenSearch Service.</p>
|
|
3486
3918
|
*/
|
|
3487
3919
|
AmazonopensearchserviceDestinationUpdate?: AmazonopensearchserviceDestinationUpdate;
|
|
3488
3920
|
/**
|
|
3921
|
+
* @public
|
|
3489
3922
|
* <p>Describes an update for a destination in Splunk.</p>
|
|
3490
3923
|
*/
|
|
3491
3924
|
SplunkDestinationUpdate?: SplunkDestinationUpdate;
|
|
3492
3925
|
/**
|
|
3926
|
+
* @public
|
|
3493
3927
|
* <p>Describes an update to the specified HTTP endpoint destination.</p>
|
|
3494
3928
|
*/
|
|
3495
3929
|
HttpEndpointDestinationUpdate?: HttpEndpointDestinationUpdate;
|
|
3496
3930
|
/**
|
|
3931
|
+
* @public
|
|
3497
3932
|
* <p>Describes an update for a destination in the Serverless offering for Amazon OpenSearch
|
|
3498
3933
|
* Service.</p>
|
|
3499
3934
|
*/
|