@aws-sdk/client-firehose 3.686.0 → 3.688.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/index.js +81 -22
- package/dist-es/models/models_0.js +32 -15
- package/dist-es/protocols/Aws_json1_1.js +36 -0
- package/dist-types/commands/CreateDeliveryStreamCommand.d.ts +70 -12
- package/dist-types/commands/DeleteDeliveryStreamCommand.d.ts +8 -8
- package/dist-types/commands/DescribeDeliveryStreamCommand.d.ts +76 -8
- package/dist-types/commands/ListDeliveryStreamsCommand.d.ts +6 -6
- package/dist-types/commands/ListTagsForDeliveryStreamCommand.d.ts +1 -1
- package/dist-types/commands/PutRecordBatchCommand.d.ts +13 -8
- package/dist-types/commands/PutRecordCommand.d.ts +15 -10
- package/dist-types/commands/StartDeliveryStreamEncryptionCommand.d.ts +12 -12
- package/dist-types/commands/StopDeliveryStreamEncryptionCommand.d.ts +5 -5
- package/dist-types/commands/TagDeliveryStreamCommand.d.ts +3 -3
- package/dist-types/commands/UntagDeliveryStreamCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDestinationCommand.d.ts +17 -3
- package/dist-types/models/models_0.d.ts +818 -344
- package/dist-types/ts3.4/models/models_0.d.ts +120 -17
- package/package.json +6 -6
|
@@ -16,14 +16,14 @@ export interface AmazonOpenSearchServerlessBufferingHints {
|
|
|
16
16
|
* <p>Buffer incoming data to the specified size, in MBs, before delivering it to the
|
|
17
17
|
* destination. The default value is 5. </p>
|
|
18
18
|
* <p>We recommend setting this parameter to a value greater than the amount of data you
|
|
19
|
-
* typically ingest into the
|
|
19
|
+
* typically ingest into the Firehose stream in 10 seconds. For example, if you typically
|
|
20
20
|
* ingest data at 1 MB/sec, the value should be 10 MB or higher.</p>
|
|
21
21
|
* @public
|
|
22
22
|
*/
|
|
23
23
|
SizeInMBs?: number;
|
|
24
24
|
}
|
|
25
25
|
/**
|
|
26
|
-
* <p>Describes the Amazon CloudWatch logging options for your
|
|
26
|
+
* <p>Describes the Amazon CloudWatch logging options for your Firehose stream.</p>
|
|
27
27
|
* @public
|
|
28
28
|
*/
|
|
29
29
|
export interface CloudWatchLoggingOptions {
|
|
@@ -180,7 +180,7 @@ export interface BufferingHints {
|
|
|
180
180
|
* for it, you must also specify a value for <code>IntervalInSeconds</code>, and vice
|
|
181
181
|
* versa.</p>
|
|
182
182
|
* <p>We recommend setting this parameter to a value greater than the amount of data you
|
|
183
|
-
* typically ingest into the
|
|
183
|
+
* typically ingest into the Firehose stream in 10 seconds. For example, if you typically
|
|
184
184
|
* ingest data at 1 MiB/sec, the value should be 10 MiB or higher.</p>
|
|
185
185
|
* @public
|
|
186
186
|
*/
|
|
@@ -304,7 +304,7 @@ export interface S3DestinationConfiguration {
|
|
|
304
304
|
*/
|
|
305
305
|
EncryptionConfiguration?: EncryptionConfiguration;
|
|
306
306
|
/**
|
|
307
|
-
* <p>The CloudWatch logging options for your
|
|
307
|
+
* <p>The CloudWatch logging options for your Firehose stream.</p>
|
|
308
308
|
* @public
|
|
309
309
|
*/
|
|
310
310
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
|
@@ -326,14 +326,14 @@ export interface VpcConfiguration {
|
|
|
326
326
|
* scales up and down automatically based on throughput. To enable Firehose to
|
|
327
327
|
* scale up the number of ENIs to match throughput, ensure that you have sufficient quota. To
|
|
328
328
|
* help you calculate the quota you need, assume that Firehose can create up to
|
|
329
|
-
* three ENIs for this
|
|
329
|
+
* three ENIs for this Firehose stream for each of the subnets specified here. For more
|
|
330
330
|
* information about ENI quota, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html#vpc-limits-enis">Network Interfaces
|
|
331
331
|
* </a> in the Amazon VPC Quotas topic.</p>
|
|
332
332
|
* @public
|
|
333
333
|
*/
|
|
334
334
|
SubnetIds: string[] | undefined;
|
|
335
335
|
/**
|
|
336
|
-
* <p>The ARN of the IAM role that you want the
|
|
336
|
+
* <p>The ARN of the IAM role that you want the Firehose stream to use to create endpoints in
|
|
337
337
|
* the destination VPC. You can use your existing Firehose delivery role or you
|
|
338
338
|
* can specify a new role. In either case, make sure that the role trusts the Firehose service principal and that it grants the following permissions:</p>
|
|
339
339
|
* <ul>
|
|
@@ -456,7 +456,7 @@ export interface AmazonOpenSearchServerlessDestinationConfiguration {
|
|
|
456
456
|
*/
|
|
457
457
|
ProcessingConfiguration?: ProcessingConfiguration;
|
|
458
458
|
/**
|
|
459
|
-
* <p>Describes the Amazon CloudWatch logging options for your
|
|
459
|
+
* <p>Describes the Amazon CloudWatch logging options for your Firehose stream.</p>
|
|
460
460
|
* @public
|
|
461
461
|
*/
|
|
462
462
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
|
@@ -519,7 +519,7 @@ export interface S3DestinationDescription {
|
|
|
519
519
|
*/
|
|
520
520
|
EncryptionConfiguration: EncryptionConfiguration | undefined;
|
|
521
521
|
/**
|
|
522
|
-
* <p>The Amazon CloudWatch logging options for your
|
|
522
|
+
* <p>The Amazon CloudWatch logging options for your Firehose stream.</p>
|
|
523
523
|
* @public
|
|
524
524
|
*/
|
|
525
525
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
|
@@ -539,14 +539,14 @@ export interface VpcConfigurationDescription {
|
|
|
539
539
|
* scales up and down automatically based on throughput. To enable Firehose to
|
|
540
540
|
* scale up the number of ENIs to match throughput, ensure that you have sufficient quota. To
|
|
541
541
|
* help you calculate the quota you need, assume that Firehose can create up to
|
|
542
|
-
* three ENIs for this
|
|
542
|
+
* three ENIs for this Firehose stream for each of the subnets specified here. For more
|
|
543
543
|
* information about ENI quota, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html#vpc-limits-enis">Network Interfaces
|
|
544
544
|
* </a> in the Amazon VPC Quotas topic.</p>
|
|
545
545
|
* @public
|
|
546
546
|
*/
|
|
547
547
|
SubnetIds: string[] | undefined;
|
|
548
548
|
/**
|
|
549
|
-
* <p>The ARN of the IAM role that the
|
|
549
|
+
* <p>The ARN of the IAM role that the Firehose stream uses to create endpoints in the
|
|
550
550
|
* destination VPC. You can use your existing Firehose delivery role or you can
|
|
551
551
|
* specify a new role. In either case, make sure that the role trusts the Firehose service principal and that it grants the following permissions:</p>
|
|
552
552
|
* <ul>
|
|
@@ -591,7 +591,7 @@ export interface VpcConfigurationDescription {
|
|
|
591
591
|
* </p>
|
|
592
592
|
* </li>
|
|
593
593
|
* </ul>
|
|
594
|
-
* <p>If you revoke these permissions after you create the
|
|
594
|
+
* <p>If you revoke these permissions after you create the Firehose stream, Firehose can't scale out by creating more ENIs when necessary. You might therefore see a
|
|
595
595
|
* degradation in performance.</p>
|
|
596
596
|
* @public
|
|
597
597
|
*/
|
|
@@ -602,7 +602,7 @@ export interface VpcConfigurationDescription {
|
|
|
602
602
|
* ES domain uses or different ones. If you specify different security groups, ensure that
|
|
603
603
|
* they allow outbound HTTPS traffic to the Amazon ES domain's security group. Also ensure
|
|
604
604
|
* that the Amazon ES domain's security group allows HTTPS traffic from the security groups
|
|
605
|
-
* specified here. If you use the same security group for both your
|
|
605
|
+
* specified here. If you use the same security group for both your Firehose stream and the
|
|
606
606
|
* Amazon ES domain, make sure the security group inbound rule allows HTTPS traffic. For more
|
|
607
607
|
* information about security group rules, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html#SecurityGroupRules">Security group
|
|
608
608
|
* rules</a> in the Amazon VPC documentation.</p>
|
|
@@ -663,7 +663,7 @@ export interface AmazonOpenSearchServerlessDestinationDescription {
|
|
|
663
663
|
*/
|
|
664
664
|
ProcessingConfiguration?: ProcessingConfiguration;
|
|
665
665
|
/**
|
|
666
|
-
* <p>Describes the Amazon CloudWatch logging options for your
|
|
666
|
+
* <p>Describes the Amazon CloudWatch logging options for your Firehose stream.</p>
|
|
667
667
|
* @public
|
|
668
668
|
*/
|
|
669
669
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
|
@@ -728,7 +728,7 @@ export interface S3DestinationUpdate {
|
|
|
728
728
|
*/
|
|
729
729
|
EncryptionConfiguration?: EncryptionConfiguration;
|
|
730
730
|
/**
|
|
731
|
-
* <p>The CloudWatch logging options for your
|
|
731
|
+
* <p>The CloudWatch logging options for your Firehose stream.</p>
|
|
732
732
|
* @public
|
|
733
733
|
*/
|
|
734
734
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
|
@@ -781,7 +781,7 @@ export interface AmazonOpenSearchServerlessDestinationUpdate {
|
|
|
781
781
|
*/
|
|
782
782
|
ProcessingConfiguration?: ProcessingConfiguration;
|
|
783
783
|
/**
|
|
784
|
-
* <p>Describes the Amazon CloudWatch logging options for your
|
|
784
|
+
* <p>Describes the Amazon CloudWatch logging options for your Firehose stream.</p>
|
|
785
785
|
* @public
|
|
786
786
|
*/
|
|
787
787
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
|
@@ -802,7 +802,7 @@ export interface AmazonopensearchserviceBufferingHints {
|
|
|
802
802
|
* <p>Buffer incoming data to the specified size, in MBs, before delivering it to the
|
|
803
803
|
* destination. The default value is 5.</p>
|
|
804
804
|
* <p>We recommend setting this parameter to a value greater than the amount of data you
|
|
805
|
-
* typically ingest into the
|
|
805
|
+
* typically ingest into the Firehose stream in 10 seconds. For example, if you typically
|
|
806
806
|
* ingest data at 1 MB/sec, the value should be 10 MB or higher. </p>
|
|
807
807
|
* @public
|
|
808
808
|
*/
|
|
@@ -960,7 +960,7 @@ export interface AmazonopensearchserviceDestinationConfiguration {
|
|
|
960
960
|
*/
|
|
961
961
|
ProcessingConfiguration?: ProcessingConfiguration;
|
|
962
962
|
/**
|
|
963
|
-
* <p>Describes the Amazon CloudWatch logging options for your
|
|
963
|
+
* <p>Describes the Amazon CloudWatch logging options for your Firehose stream.</p>
|
|
964
964
|
* @public
|
|
965
965
|
*/
|
|
966
966
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
|
@@ -1040,7 +1040,7 @@ export interface AmazonopensearchserviceDestinationDescription {
|
|
|
1040
1040
|
*/
|
|
1041
1041
|
ProcessingConfiguration?: ProcessingConfiguration;
|
|
1042
1042
|
/**
|
|
1043
|
-
* <p>Describes the Amazon CloudWatch logging options for your
|
|
1043
|
+
* <p>Describes the Amazon CloudWatch logging options for your Firehose stream.</p>
|
|
1044
1044
|
* @public
|
|
1045
1045
|
*/
|
|
1046
1046
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
|
@@ -1089,9 +1089,9 @@ export interface AmazonopensearchserviceDestinationUpdate {
|
|
|
1089
1089
|
* <p>The Amazon OpenSearch Service type name. For Elasticsearch 6.x, there can be only one
|
|
1090
1090
|
* type per index. If you try to specify a new type for an existing index that already has
|
|
1091
1091
|
* another type, Firehose returns an error during runtime. </p>
|
|
1092
|
-
* <p>If you upgrade Elasticsearch from 6.x to 7.x and don’t update your
|
|
1092
|
+
* <p>If you upgrade Elasticsearch from 6.x to 7.x and don’t update your Firehose stream,
|
|
1093
1093
|
* Firehose still delivers data to Elasticsearch with the old index name and type
|
|
1094
|
-
* name. If you want to update your
|
|
1094
|
+
* name. If you want to update your Firehose stream with a new index name, provide an empty
|
|
1095
1095
|
* string for TypeName. </p>
|
|
1096
1096
|
* @public
|
|
1097
1097
|
*/
|
|
@@ -1125,7 +1125,7 @@ export interface AmazonopensearchserviceDestinationUpdate {
|
|
|
1125
1125
|
*/
|
|
1126
1126
|
ProcessingConfiguration?: ProcessingConfiguration;
|
|
1127
1127
|
/**
|
|
1128
|
-
* <p>Describes the Amazon CloudWatch logging options for your
|
|
1128
|
+
* <p>Describes the Amazon CloudWatch logging options for your Firehose stream.</p>
|
|
1129
1129
|
* @public
|
|
1130
1130
|
*/
|
|
1131
1131
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
|
@@ -1167,18 +1167,23 @@ export interface AuthenticationConfiguration {
|
|
|
1167
1167
|
* <p>
|
|
1168
1168
|
* Describes the containers where the destination Apache Iceberg Tables are persisted.
|
|
1169
1169
|
* </p>
|
|
1170
|
-
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
1171
1170
|
* @public
|
|
1172
1171
|
*/
|
|
1173
1172
|
export interface CatalogConfiguration {
|
|
1174
1173
|
/**
|
|
1175
1174
|
* <p>
|
|
1176
|
-
* Specifies the Glue catalog ARN
|
|
1175
|
+
* Specifies the Glue catalog ARN identifier of the destination Apache Iceberg Tables. You must specify the ARN in the format <code>arn:aws:glue:region:account-id:catalog</code>.
|
|
1177
1176
|
* </p>
|
|
1178
|
-
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
1179
1177
|
* @public
|
|
1180
1178
|
*/
|
|
1181
1179
|
CatalogARN?: string;
|
|
1180
|
+
/**
|
|
1181
|
+
* <p>
|
|
1182
|
+
* </p>
|
|
1183
|
+
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
1184
|
+
* @public
|
|
1185
|
+
*/
|
|
1186
|
+
WarehouseLocation?: string;
|
|
1182
1187
|
}
|
|
1183
1188
|
/**
|
|
1184
1189
|
* <p>Another modification has already happened. Fetch <code>VersionId</code> again and use
|
|
@@ -1245,6 +1250,236 @@ export interface CopyCommand {
|
|
|
1245
1250
|
*/
|
|
1246
1251
|
CopyOptions?: string;
|
|
1247
1252
|
}
|
|
1253
|
+
/**
|
|
1254
|
+
* <p>
|
|
1255
|
+
* </p>
|
|
1256
|
+
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
1257
|
+
* @public
|
|
1258
|
+
*/
|
|
1259
|
+
export interface DatabaseColumnList {
|
|
1260
|
+
/**
|
|
1261
|
+
* <p>
|
|
1262
|
+
* </p>
|
|
1263
|
+
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
1264
|
+
* @public
|
|
1265
|
+
*/
|
|
1266
|
+
Include?: string[];
|
|
1267
|
+
/**
|
|
1268
|
+
* <p>
|
|
1269
|
+
* </p>
|
|
1270
|
+
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
1271
|
+
* @public
|
|
1272
|
+
*/
|
|
1273
|
+
Exclude?: string[];
|
|
1274
|
+
}
|
|
1275
|
+
/**
|
|
1276
|
+
* <p>
|
|
1277
|
+
* </p>
|
|
1278
|
+
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
1279
|
+
* @public
|
|
1280
|
+
*/
|
|
1281
|
+
export interface DatabaseList {
|
|
1282
|
+
/**
|
|
1283
|
+
* <p>
|
|
1284
|
+
* </p>
|
|
1285
|
+
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
1286
|
+
* @public
|
|
1287
|
+
*/
|
|
1288
|
+
Include?: string[];
|
|
1289
|
+
/**
|
|
1290
|
+
* <p>
|
|
1291
|
+
* </p>
|
|
1292
|
+
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
1293
|
+
* @public
|
|
1294
|
+
*/
|
|
1295
|
+
Exclude?: string[];
|
|
1296
|
+
}
|
|
1297
|
+
/**
|
|
1298
|
+
* <p>The structure that defines how Firehose accesses the secret.</p>
|
|
1299
|
+
* @public
|
|
1300
|
+
*/
|
|
1301
|
+
export interface SecretsManagerConfiguration {
|
|
1302
|
+
/**
|
|
1303
|
+
* <p>The ARN of the secret that stores your credentials. It must be in the same region as the
|
|
1304
|
+
* Firehose stream and the role. The secret ARN can reside in a different account than the Firehose stream and role as Firehose supports cross-account secret access. This parameter is required when <b>Enabled</b> is set to <code>True</code>.</p>
|
|
1305
|
+
* @public
|
|
1306
|
+
*/
|
|
1307
|
+
SecretARN?: string;
|
|
1308
|
+
/**
|
|
1309
|
+
* <p>
|
|
1310
|
+
* Specifies the role that Firehose assumes when calling the Secrets Manager API operation. When you provide the role, it overrides any destination specific role defined in the destination configuration. If you do not provide the then we use the destination specific role. This parameter is required for Splunk.
|
|
1311
|
+
* </p>
|
|
1312
|
+
* @public
|
|
1313
|
+
*/
|
|
1314
|
+
RoleARN?: string;
|
|
1315
|
+
/**
|
|
1316
|
+
* <p>Specifies whether you want to use the secrets manager feature. When set as
|
|
1317
|
+
* <code>True</code> the secrets manager configuration overwrites the existing secrets in
|
|
1318
|
+
* the destination configuration. When it's set to <code>False</code> Firehose falls back to
|
|
1319
|
+
* the credentials in the destination configuration.</p>
|
|
1320
|
+
* @public
|
|
1321
|
+
*/
|
|
1322
|
+
Enabled: boolean | undefined;
|
|
1323
|
+
}
|
|
1324
|
+
/**
|
|
1325
|
+
* <p>
|
|
1326
|
+
* </p>
|
|
1327
|
+
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
1328
|
+
* @public
|
|
1329
|
+
*/
|
|
1330
|
+
export interface DatabaseSourceAuthenticationConfiguration {
|
|
1331
|
+
/**
|
|
1332
|
+
* <p>The structure that defines how Firehose accesses the secret.</p>
|
|
1333
|
+
* @public
|
|
1334
|
+
*/
|
|
1335
|
+
SecretsManagerConfiguration: SecretsManagerConfiguration | undefined;
|
|
1336
|
+
}
|
|
1337
|
+
/**
|
|
1338
|
+
* <p>
|
|
1339
|
+
* </p>
|
|
1340
|
+
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
1341
|
+
* @public
|
|
1342
|
+
*/
|
|
1343
|
+
export interface DatabaseSourceVPCConfiguration {
|
|
1344
|
+
/**
|
|
1345
|
+
* <p>
|
|
1346
|
+
* </p>
|
|
1347
|
+
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
1348
|
+
* @public
|
|
1349
|
+
*/
|
|
1350
|
+
VpcEndpointServiceName: string | undefined;
|
|
1351
|
+
}
|
|
1352
|
+
/**
|
|
1353
|
+
* @public
|
|
1354
|
+
* @enum
|
|
1355
|
+
*/
|
|
1356
|
+
export declare const SSLMode: {
|
|
1357
|
+
readonly Disabled: "Disabled";
|
|
1358
|
+
readonly Enabled: "Enabled";
|
|
1359
|
+
};
|
|
1360
|
+
/**
|
|
1361
|
+
* @public
|
|
1362
|
+
*/
|
|
1363
|
+
export type SSLMode = (typeof SSLMode)[keyof typeof SSLMode];
|
|
1364
|
+
/**
|
|
1365
|
+
* <p>
|
|
1366
|
+
* </p>
|
|
1367
|
+
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
1368
|
+
* @public
|
|
1369
|
+
*/
|
|
1370
|
+
export interface DatabaseTableList {
|
|
1371
|
+
/**
|
|
1372
|
+
* <p>
|
|
1373
|
+
* </p>
|
|
1374
|
+
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
1375
|
+
* @public
|
|
1376
|
+
*/
|
|
1377
|
+
Include?: string[];
|
|
1378
|
+
/**
|
|
1379
|
+
* <p>
|
|
1380
|
+
* </p>
|
|
1381
|
+
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
1382
|
+
* @public
|
|
1383
|
+
*/
|
|
1384
|
+
Exclude?: string[];
|
|
1385
|
+
}
|
|
1386
|
+
/**
|
|
1387
|
+
* @public
|
|
1388
|
+
* @enum
|
|
1389
|
+
*/
|
|
1390
|
+
export declare const DatabaseType: {
|
|
1391
|
+
readonly MySQL: "MySQL";
|
|
1392
|
+
readonly PostgreSQL: "PostgreSQL";
|
|
1393
|
+
};
|
|
1394
|
+
/**
|
|
1395
|
+
* @public
|
|
1396
|
+
*/
|
|
1397
|
+
export type DatabaseType = (typeof DatabaseType)[keyof typeof DatabaseType];
|
|
1398
|
+
/**
|
|
1399
|
+
* <p>
|
|
1400
|
+
* </p>
|
|
1401
|
+
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
1402
|
+
* @public
|
|
1403
|
+
*/
|
|
1404
|
+
export interface DatabaseSourceConfiguration {
|
|
1405
|
+
/**
|
|
1406
|
+
* <p>
|
|
1407
|
+
* </p>
|
|
1408
|
+
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
1409
|
+
* @public
|
|
1410
|
+
*/
|
|
1411
|
+
Type: DatabaseType | undefined;
|
|
1412
|
+
/**
|
|
1413
|
+
* <p>
|
|
1414
|
+
* </p>
|
|
1415
|
+
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
1416
|
+
* @public
|
|
1417
|
+
*/
|
|
1418
|
+
Endpoint: string | undefined;
|
|
1419
|
+
/**
|
|
1420
|
+
* <p>
|
|
1421
|
+
* </p>
|
|
1422
|
+
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
1423
|
+
* @public
|
|
1424
|
+
*/
|
|
1425
|
+
Port: number | undefined;
|
|
1426
|
+
/**
|
|
1427
|
+
* <p>
|
|
1428
|
+
* </p>
|
|
1429
|
+
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
1430
|
+
* @public
|
|
1431
|
+
*/
|
|
1432
|
+
SSLMode?: SSLMode;
|
|
1433
|
+
/**
|
|
1434
|
+
* <p>
|
|
1435
|
+
* </p>
|
|
1436
|
+
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
1437
|
+
* @public
|
|
1438
|
+
*/
|
|
1439
|
+
Databases: DatabaseList | undefined;
|
|
1440
|
+
/**
|
|
1441
|
+
* <p>
|
|
1442
|
+
* </p>
|
|
1443
|
+
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
1444
|
+
* @public
|
|
1445
|
+
*/
|
|
1446
|
+
Tables: DatabaseTableList | undefined;
|
|
1447
|
+
/**
|
|
1448
|
+
* <p>
|
|
1449
|
+
* </p>
|
|
1450
|
+
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
1451
|
+
* @public
|
|
1452
|
+
*/
|
|
1453
|
+
Columns?: DatabaseColumnList;
|
|
1454
|
+
/**
|
|
1455
|
+
* <p>
|
|
1456
|
+
* </p>
|
|
1457
|
+
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
1458
|
+
* @public
|
|
1459
|
+
*/
|
|
1460
|
+
SurrogateKeys?: string[];
|
|
1461
|
+
/**
|
|
1462
|
+
* <p>
|
|
1463
|
+
* </p>
|
|
1464
|
+
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
1465
|
+
* @public
|
|
1466
|
+
*/
|
|
1467
|
+
SnapshotWatermarkTable: string | undefined;
|
|
1468
|
+
/**
|
|
1469
|
+
* <p>
|
|
1470
|
+
* </p>
|
|
1471
|
+
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
1472
|
+
* @public
|
|
1473
|
+
*/
|
|
1474
|
+
DatabaseSourceAuthenticationConfiguration: DatabaseSourceAuthenticationConfiguration | undefined;
|
|
1475
|
+
/**
|
|
1476
|
+
* <p>
|
|
1477
|
+
* </p>
|
|
1478
|
+
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
1479
|
+
* @public
|
|
1480
|
+
*/
|
|
1481
|
+
DatabaseSourceVPCConfiguration: DatabaseSourceVPCConfiguration | undefined;
|
|
1482
|
+
}
|
|
1248
1483
|
/**
|
|
1249
1484
|
* @public
|
|
1250
1485
|
* @enum
|
|
@@ -1278,14 +1513,14 @@ export interface DeliveryStreamEncryptionConfigurationInput {
|
|
|
1278
1513
|
* that allows the Firehose service to use the customer managed CMK to perform
|
|
1279
1514
|
* encryption and decryption. Firehose manages that grant. </p>
|
|
1280
1515
|
* <p>When you invoke <a>StartDeliveryStreamEncryption</a> to change the CMK for a
|
|
1281
|
-
*
|
|
1516
|
+
* Firehose stream that is encrypted with a customer managed CMK, Firehose
|
|
1282
1517
|
* schedules the grant it had on the old CMK for retirement.</p>
|
|
1283
|
-
* <p>You can use a CMK of type CUSTOMER_MANAGED_CMK to encrypt up to 500
|
|
1518
|
+
* <p>You can use a CMK of type CUSTOMER_MANAGED_CMK to encrypt up to 500 Firehose streams. If
|
|
1284
1519
|
* a <a>CreateDeliveryStream</a> or <a>StartDeliveryStreamEncryption</a>
|
|
1285
1520
|
* operation exceeds this limit, Firehose throws a
|
|
1286
1521
|
* <code>LimitExceededException</code>. </p>
|
|
1287
1522
|
* <important>
|
|
1288
|
-
* <p>To encrypt your
|
|
1523
|
+
* <p>To encrypt your Firehose stream, use symmetric CMKs. Firehose doesn't
|
|
1289
1524
|
* support asymmetric CMKs. For information about symmetric and asymmetric CMKs, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-concepts.html">About
|
|
1290
1525
|
* Symmetric and Asymmetric CMKs</a> in the Amazon Web Services Key Management
|
|
1291
1526
|
* Service developer guide.</p>
|
|
@@ -1299,6 +1534,7 @@ export interface DeliveryStreamEncryptionConfigurationInput {
|
|
|
1299
1534
|
* @enum
|
|
1300
1535
|
*/
|
|
1301
1536
|
export declare const DeliveryStreamType: {
|
|
1537
|
+
readonly DatabaseAsSource: "DatabaseAsSource";
|
|
1302
1538
|
readonly DirectPut: "DirectPut";
|
|
1303
1539
|
readonly KinesisStreamAsSource: "KinesisStreamAsSource";
|
|
1304
1540
|
readonly MSKAsSource: "MSKAsSource";
|
|
@@ -1323,7 +1559,7 @@ export interface ElasticsearchBufferingHints {
|
|
|
1323
1559
|
* <p>Buffer incoming data to the specified size, in MBs, before delivering it to the
|
|
1324
1560
|
* destination. The default value is 5.</p>
|
|
1325
1561
|
* <p>We recommend setting this parameter to a value greater than the amount of data you
|
|
1326
|
-
* typically ingest into the
|
|
1562
|
+
* typically ingest into the Firehose stream in 10 seconds. For example, if you typically
|
|
1327
1563
|
* ingest data at 1 MB/sec, the value should be 10 MB or higher.</p>
|
|
1328
1564
|
* @public
|
|
1329
1565
|
*/
|
|
@@ -1442,7 +1678,7 @@ export interface ElasticsearchDestinationConfiguration {
|
|
|
1442
1678
|
* appended to the prefix. For more information, see <a href="https://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-s3-backup">Amazon S3 Backup for the
|
|
1443
1679
|
* Amazon ES Destination</a>. Default value is
|
|
1444
1680
|
* <code>FailedDocumentsOnly</code>.</p>
|
|
1445
|
-
* <p>You can't change this backup mode after you create the
|
|
1681
|
+
* <p>You can't change this backup mode after you create the Firehose stream. </p>
|
|
1446
1682
|
* @public
|
|
1447
1683
|
*/
|
|
1448
1684
|
S3BackupMode?: ElasticsearchS3BackupMode;
|
|
@@ -1457,7 +1693,7 @@ export interface ElasticsearchDestinationConfiguration {
|
|
|
1457
1693
|
*/
|
|
1458
1694
|
ProcessingConfiguration?: ProcessingConfiguration;
|
|
1459
1695
|
/**
|
|
1460
|
-
* <p>The Amazon CloudWatch logging options for your
|
|
1696
|
+
* <p>The Amazon CloudWatch logging options for your Firehose stream.</p>
|
|
1461
1697
|
* @public
|
|
1462
1698
|
*/
|
|
1463
1699
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
|
@@ -1868,14 +2104,13 @@ export interface DataFormatConversionConfiguration {
|
|
|
1868
2104
|
Enabled?: boolean;
|
|
1869
2105
|
}
|
|
1870
2106
|
/**
|
|
1871
|
-
* <p> The retry behavior in case Firehose is unable to deliver data to
|
|
1872
|
-
* S3 prefix.</p>
|
|
2107
|
+
* <p> The retry behavior in case Firehose is unable to deliver data to a destination.</p>
|
|
1873
2108
|
* @public
|
|
1874
2109
|
*/
|
|
1875
2110
|
export interface RetryOptions {
|
|
1876
2111
|
/**
|
|
1877
2112
|
* <p>The period of time during which Firehose retries to deliver data to the
|
|
1878
|
-
* specified
|
|
2113
|
+
* specified destination.</p>
|
|
1879
2114
|
* @public
|
|
1880
2115
|
*/
|
|
1881
2116
|
DurationInSeconds?: number;
|
|
@@ -1896,7 +2131,7 @@ export interface DynamicPartitioningConfiguration {
|
|
|
1896
2131
|
RetryOptions?: RetryOptions;
|
|
1897
2132
|
/**
|
|
1898
2133
|
* <p>Specifies that the dynamic partitioning is enabled for this Firehose
|
|
1899
|
-
*
|
|
2134
|
+
* Firehose stream.</p>
|
|
1900
2135
|
* @public
|
|
1901
2136
|
*/
|
|
1902
2137
|
Enabled?: boolean;
|
|
@@ -1964,7 +2199,7 @@ export interface ExtendedS3DestinationConfiguration {
|
|
|
1964
2199
|
*/
|
|
1965
2200
|
EncryptionConfiguration?: EncryptionConfiguration;
|
|
1966
2201
|
/**
|
|
1967
|
-
* <p>The Amazon CloudWatch logging options for your
|
|
2202
|
+
* <p>The Amazon CloudWatch logging options for your Firehose stream.</p>
|
|
1968
2203
|
* @public
|
|
1969
2204
|
*/
|
|
1970
2205
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
|
@@ -1974,9 +2209,9 @@ export interface ExtendedS3DestinationConfiguration {
|
|
|
1974
2209
|
*/
|
|
1975
2210
|
ProcessingConfiguration?: ProcessingConfiguration;
|
|
1976
2211
|
/**
|
|
1977
|
-
* <p>The Amazon S3 backup mode. After you create a
|
|
2212
|
+
* <p>The Amazon S3 backup mode. After you create a Firehose stream, you can update it to
|
|
1978
2213
|
* enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the
|
|
1979
|
-
*
|
|
2214
|
+
* Firehose stream to disable it. </p>
|
|
1980
2215
|
* @public
|
|
1981
2216
|
*/
|
|
1982
2217
|
S3BackupMode?: S3BackupMode;
|
|
@@ -2023,7 +2258,7 @@ export interface HttpEndpointBufferingHints {
|
|
|
2023
2258
|
* <p>Buffer incoming data to the specified size, in MBs, before delivering it to the
|
|
2024
2259
|
* destination. The default value is 5. </p>
|
|
2025
2260
|
* <p>We recommend setting this parameter to a value greater than the amount of data you
|
|
2026
|
-
* typically ingest into the
|
|
2261
|
+
* typically ingest into the Firehose stream in 10 seconds. For example, if you typically
|
|
2027
2262
|
* ingest data at 1 MB/sec, the value should be 10 MB or higher. </p>
|
|
2028
2263
|
* @public
|
|
2029
2264
|
*/
|
|
@@ -2125,33 +2360,6 @@ export declare const HttpEndpointS3BackupMode: {
|
|
|
2125
2360
|
* @public
|
|
2126
2361
|
*/
|
|
2127
2362
|
export type HttpEndpointS3BackupMode = (typeof HttpEndpointS3BackupMode)[keyof typeof HttpEndpointS3BackupMode];
|
|
2128
|
-
/**
|
|
2129
|
-
* <p>The structure that defines how Firehose accesses the secret.</p>
|
|
2130
|
-
* @public
|
|
2131
|
-
*/
|
|
2132
|
-
export interface SecretsManagerConfiguration {
|
|
2133
|
-
/**
|
|
2134
|
-
* <p>The ARN of the secret that stores your credentials. It must be in the same region as the
|
|
2135
|
-
* Firehose stream and the role. The secret ARN can reside in a different account than the delivery stream and role as Firehose supports cross-account secret access. This parameter is required when <b>Enabled</b> is set to <code>True</code>.</p>
|
|
2136
|
-
* @public
|
|
2137
|
-
*/
|
|
2138
|
-
SecretARN?: string;
|
|
2139
|
-
/**
|
|
2140
|
-
* <p>
|
|
2141
|
-
* Specifies the role that Firehose assumes when calling the Secrets Manager API operation. When you provide the role, it overrides any destination specific role defined in the destination configuration. If you do not provide the then we use the destination specific role. This parameter is required for Splunk.
|
|
2142
|
-
* </p>
|
|
2143
|
-
* @public
|
|
2144
|
-
*/
|
|
2145
|
-
RoleARN?: string;
|
|
2146
|
-
/**
|
|
2147
|
-
* <p>Specifies whether you want to use the the secrets manager feature. When set as
|
|
2148
|
-
* <code>True</code> the secrets manager configuration overwrites the existing secrets in
|
|
2149
|
-
* the destination configuration. When it's set to <code>False</code> Firehose falls back to
|
|
2150
|
-
* the credentials in the destination configuration.</p>
|
|
2151
|
-
* @public
|
|
2152
|
-
*/
|
|
2153
|
-
Enabled: boolean | undefined;
|
|
2154
|
-
}
|
|
2155
2363
|
/**
|
|
2156
2364
|
* <p>Describes the configuration of the HTTP endpoint destination.</p>
|
|
2157
2365
|
* @public
|
|
@@ -2172,7 +2380,7 @@ export interface HttpEndpointDestinationConfiguration {
|
|
|
2172
2380
|
*/
|
|
2173
2381
|
BufferingHints?: HttpEndpointBufferingHints;
|
|
2174
2382
|
/**
|
|
2175
|
-
* <p>Describes the Amazon CloudWatch logging options for your
|
|
2383
|
+
* <p>Describes the Amazon CloudWatch logging options for your Firehose stream.</p>
|
|
2176
2384
|
* @public
|
|
2177
2385
|
*/
|
|
2178
2386
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
|
@@ -2223,44 +2431,76 @@ export interface HttpEndpointDestinationConfiguration {
|
|
|
2223
2431
|
}
|
|
2224
2432
|
/**
|
|
2225
2433
|
* <p>
|
|
2226
|
-
* Describes the configuration of a destination in Apache Iceberg Tables.
|
|
2227
2434
|
* </p>
|
|
2228
2435
|
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
2229
2436
|
* @public
|
|
2230
2437
|
*/
|
|
2231
|
-
export interface
|
|
2438
|
+
export interface PartitionField {
|
|
2232
2439
|
/**
|
|
2233
2440
|
* <p>
|
|
2234
|
-
* Specifies the name of the Apache Iceberg Table.
|
|
2235
2441
|
* </p>
|
|
2236
2442
|
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
2237
2443
|
* @public
|
|
2238
2444
|
*/
|
|
2239
|
-
|
|
2445
|
+
SourceName: string | undefined;
|
|
2446
|
+
}
|
|
2447
|
+
/**
|
|
2448
|
+
* <p>
|
|
2449
|
+
* </p>
|
|
2450
|
+
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
2451
|
+
* @public
|
|
2452
|
+
*/
|
|
2453
|
+
export interface PartitionSpec {
|
|
2240
2454
|
/**
|
|
2241
2455
|
* <p>
|
|
2242
|
-
* The name of the Apache Iceberg database.
|
|
2243
2456
|
* </p>
|
|
2244
2457
|
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
2245
2458
|
* @public
|
|
2246
2459
|
*/
|
|
2247
|
-
|
|
2460
|
+
Identity?: PartitionField[];
|
|
2461
|
+
}
|
|
2462
|
+
/**
|
|
2463
|
+
* <p>
|
|
2464
|
+
* Describes the configuration of a destination in Apache Iceberg Tables.
|
|
2465
|
+
* </p>
|
|
2466
|
+
* @public
|
|
2467
|
+
*/
|
|
2468
|
+
export interface DestinationTableConfiguration {
|
|
2248
2469
|
/**
|
|
2249
2470
|
* <p>
|
|
2250
|
-
*
|
|
2251
|
-
*
|
|
2471
|
+
* Specifies the name of the Apache Iceberg Table.
|
|
2252
2472
|
* </p>
|
|
2253
|
-
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
2254
2473
|
* @public
|
|
2255
2474
|
*/
|
|
2256
|
-
|
|
2475
|
+
DestinationTableName: string | undefined;
|
|
2257
2476
|
/**
|
|
2258
2477
|
* <p>
|
|
2259
|
-
*
|
|
2260
|
-
*
|
|
2478
|
+
* The name of the Apache Iceberg database.
|
|
2479
|
+
* </p>
|
|
2480
|
+
* @public
|
|
2481
|
+
*/
|
|
2482
|
+
DestinationDatabaseName: string | undefined;
|
|
2483
|
+
/**
|
|
2484
|
+
* <p>
|
|
2485
|
+
* A list of unique keys for a given Apache Iceberg table. Firehose will use these for running Create, Update, or Delete operations on the given Iceberg table.
|
|
2486
|
+
*
|
|
2487
|
+
* </p>
|
|
2488
|
+
* @public
|
|
2489
|
+
*/
|
|
2490
|
+
UniqueKeys?: string[];
|
|
2491
|
+
/**
|
|
2492
|
+
* <p>
|
|
2493
|
+
* </p>
|
|
2261
2494
|
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
2262
2495
|
* @public
|
|
2263
2496
|
*/
|
|
2497
|
+
PartitionSpec?: PartitionSpec;
|
|
2498
|
+
/**
|
|
2499
|
+
* <p>
|
|
2500
|
+
* The table specific S3 error output prefix. All the errors that occurred while delivering to this table will be prefixed with this value in S3 destination.
|
|
2501
|
+
* </p>
|
|
2502
|
+
* @public
|
|
2503
|
+
*/
|
|
2264
2504
|
S3ErrorOutputPrefix?: string;
|
|
2265
2505
|
}
|
|
2266
2506
|
/**
|
|
@@ -2277,19 +2517,61 @@ export declare const IcebergS3BackupMode: {
|
|
|
2277
2517
|
export type IcebergS3BackupMode = (typeof IcebergS3BackupMode)[keyof typeof IcebergS3BackupMode];
|
|
2278
2518
|
/**
|
|
2279
2519
|
* <p>
|
|
2280
|
-
* Specifies the destination configure settings for Apache Iceberg Table.
|
|
2281
2520
|
* </p>
|
|
2282
2521
|
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
2283
2522
|
* @public
|
|
2284
2523
|
*/
|
|
2524
|
+
export interface SchemaEvolutionConfiguration {
|
|
2525
|
+
/**
|
|
2526
|
+
* <p>
|
|
2527
|
+
* </p>
|
|
2528
|
+
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
2529
|
+
* @public
|
|
2530
|
+
*/
|
|
2531
|
+
Enabled: boolean | undefined;
|
|
2532
|
+
}
|
|
2533
|
+
/**
|
|
2534
|
+
* <p>
|
|
2535
|
+
* </p>
|
|
2536
|
+
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
2537
|
+
* @public
|
|
2538
|
+
*/
|
|
2539
|
+
export interface TableCreationConfiguration {
|
|
2540
|
+
/**
|
|
2541
|
+
* <p>
|
|
2542
|
+
* </p>
|
|
2543
|
+
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
2544
|
+
* @public
|
|
2545
|
+
*/
|
|
2546
|
+
Enabled: boolean | undefined;
|
|
2547
|
+
}
|
|
2548
|
+
/**
|
|
2549
|
+
* <p>
|
|
2550
|
+
* Specifies the destination configure settings for Apache Iceberg Table.
|
|
2551
|
+
* </p>
|
|
2552
|
+
* @public
|
|
2553
|
+
*/
|
|
2285
2554
|
export interface IcebergDestinationConfiguration {
|
|
2286
2555
|
/**
|
|
2287
2556
|
* <p> Provides a list of <code>DestinationTableConfigurations</code> which Firehose uses
|
|
2288
|
-
* to deliver data to Apache Iceberg
|
|
2289
|
-
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
2557
|
+
* to deliver data to Apache Iceberg Tables. Firehose will write data with insert if table specific configuration is not provided here.</p>
|
|
2290
2558
|
* @public
|
|
2291
2559
|
*/
|
|
2292
2560
|
DestinationTableConfigurationList?: DestinationTableConfiguration[];
|
|
2561
|
+
/**
|
|
2562
|
+
* <p>
|
|
2563
|
+
* </p>
|
|
2564
|
+
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
2565
|
+
* @public
|
|
2566
|
+
*/
|
|
2567
|
+
SchemaEvolutionConfiguration?: SchemaEvolutionConfiguration;
|
|
2568
|
+
/**
|
|
2569
|
+
* <p>
|
|
2570
|
+
* </p>
|
|
2571
|
+
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
2572
|
+
* @public
|
|
2573
|
+
*/
|
|
2574
|
+
TableCreationConfiguration?: TableCreationConfiguration;
|
|
2293
2575
|
/**
|
|
2294
2576
|
* <p>Describes hints for the buffering to perform before delivering data to the
|
|
2295
2577
|
* destination. These options are treated as hints, and therefore Firehose might
|
|
@@ -2300,7 +2582,7 @@ export interface IcebergDestinationConfiguration {
|
|
|
2300
2582
|
*/
|
|
2301
2583
|
BufferingHints?: BufferingHints;
|
|
2302
2584
|
/**
|
|
2303
|
-
* <p>Describes the Amazon CloudWatch logging options for your
|
|
2585
|
+
* <p>Describes the Amazon CloudWatch logging options for your Firehose stream.</p>
|
|
2304
2586
|
* @public
|
|
2305
2587
|
*/
|
|
2306
2588
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
|
@@ -2310,23 +2592,20 @@ export interface IcebergDestinationConfiguration {
|
|
|
2310
2592
|
*/
|
|
2311
2593
|
ProcessingConfiguration?: ProcessingConfiguration;
|
|
2312
2594
|
/**
|
|
2313
|
-
* <p> Describes how Firehose will backup records. Currently,
|
|
2314
|
-
* <code>FailedDataOnly</code
|
|
2315
|
-
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
2595
|
+
* <p> Describes how Firehose will backup records. Currently,S3 backup only supports
|
|
2596
|
+
* <code>FailedDataOnly</code>. </p>
|
|
2316
2597
|
* @public
|
|
2317
2598
|
*/
|
|
2318
2599
|
S3BackupMode?: IcebergS3BackupMode;
|
|
2319
2600
|
/**
|
|
2320
|
-
* <p> The retry behavior in case Firehose is unable to deliver data to
|
|
2321
|
-
* S3 prefix.</p>
|
|
2601
|
+
* <p> The retry behavior in case Firehose is unable to deliver data to a destination.</p>
|
|
2322
2602
|
* @public
|
|
2323
2603
|
*/
|
|
2324
2604
|
RetryOptions?: RetryOptions;
|
|
2325
2605
|
/**
|
|
2326
2606
|
* <p>
|
|
2327
|
-
* The Amazon Resource Name (ARN) of the Apache Iceberg
|
|
2607
|
+
* The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling Apache Iceberg Tables.
|
|
2328
2608
|
* </p>
|
|
2329
|
-
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
2330
2609
|
* @public
|
|
2331
2610
|
*/
|
|
2332
2611
|
RoleARN: string | undefined;
|
|
@@ -2334,7 +2613,6 @@ export interface IcebergDestinationConfiguration {
|
|
|
2334
2613
|
* <p>
|
|
2335
2614
|
* Configuration describing where the destination Apache Iceberg Tables are persisted.
|
|
2336
2615
|
* </p>
|
|
2337
|
-
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
2338
2616
|
* @public
|
|
2339
2617
|
*/
|
|
2340
2618
|
CatalogConfiguration: CatalogConfiguration | undefined;
|
|
@@ -2346,7 +2624,7 @@ export interface IcebergDestinationConfiguration {
|
|
|
2346
2624
|
}
|
|
2347
2625
|
/**
|
|
2348
2626
|
* <p>The stream and role Amazon Resource Names (ARNs) for a Kinesis data stream used as
|
|
2349
|
-
* the source for a
|
|
2627
|
+
* the source for a Firehose stream.</p>
|
|
2350
2628
|
* @public
|
|
2351
2629
|
*/
|
|
2352
2630
|
export interface KinesisStreamSourceConfiguration {
|
|
@@ -2477,9 +2755,9 @@ export interface RedshiftDestinationConfiguration {
|
|
|
2477
2755
|
*/
|
|
2478
2756
|
ProcessingConfiguration?: ProcessingConfiguration;
|
|
2479
2757
|
/**
|
|
2480
|
-
* <p>The Amazon S3 backup mode. After you create a
|
|
2758
|
+
* <p>The Amazon S3 backup mode. After you create a Firehose stream, you can update it to
|
|
2481
2759
|
* enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the
|
|
2482
|
-
*
|
|
2760
|
+
* Firehose stream to disable it. </p>
|
|
2483
2761
|
* @public
|
|
2484
2762
|
*/
|
|
2485
2763
|
S3BackupMode?: RedshiftS3BackupMode;
|
|
@@ -2489,7 +2767,7 @@ export interface RedshiftDestinationConfiguration {
|
|
|
2489
2767
|
*/
|
|
2490
2768
|
S3BackupConfiguration?: S3DestinationConfiguration;
|
|
2491
2769
|
/**
|
|
2492
|
-
* <p>The CloudWatch logging options for your
|
|
2770
|
+
* <p>The CloudWatch logging options for your Firehose stream.</p>
|
|
2493
2771
|
* @public
|
|
2494
2772
|
*/
|
|
2495
2773
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
|
@@ -2509,9 +2787,8 @@ export interface RedshiftDestinationConfiguration {
|
|
|
2509
2787
|
*/
|
|
2510
2788
|
export interface SnowflakeBufferingHints {
|
|
2511
2789
|
/**
|
|
2512
|
-
* <p>
|
|
2513
|
-
*
|
|
2514
|
-
* </p>
|
|
2790
|
+
* <p>Buffer incoming data to the specified size, in MBs, before delivering it to the
|
|
2791
|
+
* destination. The default value is 128. </p>
|
|
2515
2792
|
* @public
|
|
2516
2793
|
*/
|
|
2517
2794
|
SizeInMBs?: number;
|
|
@@ -2665,7 +2942,7 @@ export interface SnowflakeDestinationConfiguration {
|
|
|
2665
2942
|
*/
|
|
2666
2943
|
SnowflakeVpcConfiguration?: SnowflakeVpcConfiguration;
|
|
2667
2944
|
/**
|
|
2668
|
-
* <p>Describes the Amazon CloudWatch logging options for your
|
|
2945
|
+
* <p>Describes the Amazon CloudWatch logging options for your Firehose stream.</p>
|
|
2669
2946
|
* @public
|
|
2670
2947
|
*/
|
|
2671
2948
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
|
@@ -2825,7 +3102,7 @@ export interface SplunkDestinationConfiguration {
|
|
|
2825
3102
|
*/
|
|
2826
3103
|
ProcessingConfiguration?: ProcessingConfiguration;
|
|
2827
3104
|
/**
|
|
2828
|
-
* <p>The Amazon CloudWatch logging options for your
|
|
3105
|
+
* <p>The Amazon CloudWatch logging options for your Firehose stream.</p>
|
|
2829
3106
|
* @public
|
|
2830
3107
|
*/
|
|
2831
3108
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
|
@@ -2843,7 +3120,7 @@ export interface SplunkDestinationConfiguration {
|
|
|
2843
3120
|
SecretsManagerConfiguration?: SecretsManagerConfiguration;
|
|
2844
3121
|
}
|
|
2845
3122
|
/**
|
|
2846
|
-
* <p>Metadata that you can assign to a
|
|
3123
|
+
* <p>Metadata that you can assign to a Firehose stream, consisting of a key-value
|
|
2847
3124
|
* pair.</p>
|
|
2848
3125
|
* @public
|
|
2849
3126
|
*/
|
|
@@ -2867,25 +3144,25 @@ export interface Tag {
|
|
|
2867
3144
|
*/
|
|
2868
3145
|
export interface CreateDeliveryStreamInput {
|
|
2869
3146
|
/**
|
|
2870
|
-
* <p>The name of the
|
|
2871
|
-
* account in the same Amazon Web Services Region. If the
|
|
2872
|
-
* accounts or different Regions, you can have multiple
|
|
3147
|
+
* <p>The name of the Firehose stream. This name must be unique per Amazon Web Services
|
|
3148
|
+
* account in the same Amazon Web Services Region. If the Firehose streams are in different
|
|
3149
|
+
* accounts or different Regions, you can have multiple Firehose streams with the same
|
|
2873
3150
|
* name.</p>
|
|
2874
3151
|
* @public
|
|
2875
3152
|
*/
|
|
2876
3153
|
DeliveryStreamName: string | undefined;
|
|
2877
3154
|
/**
|
|
2878
|
-
* <p>The
|
|
3155
|
+
* <p>The Firehose stream type. This parameter can be one of the following
|
|
2879
3156
|
* values:</p>
|
|
2880
3157
|
* <ul>
|
|
2881
3158
|
* <li>
|
|
2882
3159
|
* <p>
|
|
2883
|
-
* <code>DirectPut</code>: Provider applications access the
|
|
3160
|
+
* <code>DirectPut</code>: Provider applications access the Firehose stream
|
|
2884
3161
|
* directly.</p>
|
|
2885
3162
|
* </li>
|
|
2886
3163
|
* <li>
|
|
2887
3164
|
* <p>
|
|
2888
|
-
* <code>KinesisStreamAsSource</code>: The
|
|
3165
|
+
* <code>KinesisStreamAsSource</code>: The Firehose stream uses a Kinesis data
|
|
2889
3166
|
* stream as a source.</p>
|
|
2890
3167
|
* </li>
|
|
2891
3168
|
* </ul>
|
|
@@ -2893,180 +3170,398 @@ export interface CreateDeliveryStreamInput {
|
|
|
2893
3170
|
*/
|
|
2894
3171
|
DeliveryStreamType?: DeliveryStreamType;
|
|
2895
3172
|
/**
|
|
2896
|
-
* <p>When a Kinesis data stream is used as the source for the
|
|
2897
|
-
* Resource Name (ARN) and the role ARN for the source stream.</p>
|
|
3173
|
+
* <p>When a Kinesis data stream is used as the source for the Firehose stream, a <a>KinesisStreamSourceConfiguration</a> containing the Kinesis data stream Amazon
|
|
3174
|
+
* Resource Name (ARN) and the role ARN for the source stream.</p>
|
|
3175
|
+
* @public
|
|
3176
|
+
*/
|
|
3177
|
+
KinesisStreamSourceConfiguration?: KinesisStreamSourceConfiguration;
|
|
3178
|
+
/**
|
|
3179
|
+
* <p>Used to specify the type and Amazon Resource Name (ARN) of the KMS key needed for
|
|
3180
|
+
* Server-Side Encryption (SSE).</p>
|
|
3181
|
+
* @public
|
|
3182
|
+
*/
|
|
3183
|
+
DeliveryStreamEncryptionConfigurationInput?: DeliveryStreamEncryptionConfigurationInput;
|
|
3184
|
+
/**
|
|
3185
|
+
* @deprecated
|
|
3186
|
+
*
|
|
3187
|
+
* <p>[Deprecated]
|
|
3188
|
+
* The destination in Amazon S3. You can specify only one destination.</p>
|
|
3189
|
+
* @public
|
|
3190
|
+
*/
|
|
3191
|
+
S3DestinationConfiguration?: S3DestinationConfiguration;
|
|
3192
|
+
/**
|
|
3193
|
+
* <p>The destination in Amazon S3. You can specify only one destination.</p>
|
|
3194
|
+
* @public
|
|
3195
|
+
*/
|
|
3196
|
+
ExtendedS3DestinationConfiguration?: ExtendedS3DestinationConfiguration;
|
|
3197
|
+
/**
|
|
3198
|
+
* <p>The destination in Amazon Redshift. You can specify only one destination.</p>
|
|
3199
|
+
* @public
|
|
3200
|
+
*/
|
|
3201
|
+
RedshiftDestinationConfiguration?: RedshiftDestinationConfiguration;
|
|
3202
|
+
/**
|
|
3203
|
+
* <p>The destination in Amazon ES. You can specify only one destination.</p>
|
|
3204
|
+
* @public
|
|
3205
|
+
*/
|
|
3206
|
+
ElasticsearchDestinationConfiguration?: ElasticsearchDestinationConfiguration;
|
|
3207
|
+
/**
|
|
3208
|
+
* <p>The destination in Amazon OpenSearch Service. You can specify only one
|
|
3209
|
+
* destination.</p>
|
|
3210
|
+
* @public
|
|
3211
|
+
*/
|
|
3212
|
+
AmazonopensearchserviceDestinationConfiguration?: AmazonopensearchserviceDestinationConfiguration;
|
|
3213
|
+
/**
|
|
3214
|
+
* <p>The destination in Splunk. You can specify only one destination.</p>
|
|
3215
|
+
* @public
|
|
3216
|
+
*/
|
|
3217
|
+
SplunkDestinationConfiguration?: SplunkDestinationConfiguration;
|
|
3218
|
+
/**
|
|
3219
|
+
* <p>Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination.
|
|
3220
|
+
* You can specify only one destination.</p>
|
|
3221
|
+
* @public
|
|
3222
|
+
*/
|
|
3223
|
+
HttpEndpointDestinationConfiguration?: HttpEndpointDestinationConfiguration;
|
|
3224
|
+
/**
|
|
3225
|
+
* <p>A set of tags to assign to the Firehose stream. A tag is a key-value pair that you can
|
|
3226
|
+
* define and assign to Amazon Web Services resources. Tags are metadata. For example, you can
|
|
3227
|
+
* add friendly names and descriptions or other types of information that can help you
|
|
3228
|
+
* distinguish the Firehose stream. For more information about tags, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html">Using
|
|
3229
|
+
* Cost Allocation Tags</a> in the Amazon Web Services Billing and Cost Management User
|
|
3230
|
+
* Guide.</p>
|
|
3231
|
+
* <p>You can specify up to 50 tags when creating a Firehose stream.</p>
|
|
3232
|
+
* <p>If you specify tags in the <code>CreateDeliveryStream</code> action, Amazon Data
|
|
3233
|
+
* Firehose performs an additional authorization on the
|
|
3234
|
+
* <code>firehose:TagDeliveryStream</code> action to verify if users have permissions to
|
|
3235
|
+
* create tags. If you do not provide this permission, requests to create new Firehose
|
|
3236
|
+
* Firehose streams with IAM resource tags will fail with an
|
|
3237
|
+
* <code>AccessDeniedException</code> such as following.</p>
|
|
3238
|
+
* <p>
|
|
3239
|
+
* <b>AccessDeniedException</b>
|
|
3240
|
+
* </p>
|
|
3241
|
+
* <p>User: arn:aws:sts::x:assumed-role/x/x is not authorized to perform: firehose:TagDeliveryStream on resource: arn:aws:firehose:us-east-1:x:deliverystream/x with an explicit deny in an identity-based policy.</p>
|
|
3242
|
+
* <p>For an example IAM policy, see <a href="https://docs.aws.amazon.com/firehose/latest/APIReference/API_CreateDeliveryStream.html#API_CreateDeliveryStream_Examples">Tag example.</a>
|
|
3243
|
+
* </p>
|
|
3244
|
+
* @public
|
|
3245
|
+
*/
|
|
3246
|
+
Tags?: Tag[];
|
|
3247
|
+
/**
|
|
3248
|
+
* <p>The destination in the Serverless offering for Amazon OpenSearch Service. You can
|
|
3249
|
+
* specify only one destination.</p>
|
|
3250
|
+
* @public
|
|
3251
|
+
*/
|
|
3252
|
+
AmazonOpenSearchServerlessDestinationConfiguration?: AmazonOpenSearchServerlessDestinationConfiguration;
|
|
3253
|
+
/**
|
|
3254
|
+
* <p>The configuration for the Amazon MSK cluster to be used as the source for a delivery
|
|
3255
|
+
* stream.</p>
|
|
3256
|
+
* @public
|
|
3257
|
+
*/
|
|
3258
|
+
MSKSourceConfiguration?: MSKSourceConfiguration;
|
|
3259
|
+
/**
|
|
3260
|
+
* <p>Configure Snowflake destination</p>
|
|
3261
|
+
* @public
|
|
3262
|
+
*/
|
|
3263
|
+
SnowflakeDestinationConfiguration?: SnowflakeDestinationConfiguration;
|
|
3264
|
+
/**
|
|
3265
|
+
* <p>
|
|
3266
|
+
* Configure Apache Iceberg Tables destination.
|
|
3267
|
+
* </p>
|
|
3268
|
+
* @public
|
|
3269
|
+
*/
|
|
3270
|
+
IcebergDestinationConfiguration?: IcebergDestinationConfiguration;
|
|
3271
|
+
/**
|
|
3272
|
+
* <p>
|
|
3273
|
+
* </p>
|
|
3274
|
+
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
3275
|
+
* @public
|
|
3276
|
+
*/
|
|
3277
|
+
DatabaseSourceConfiguration?: DatabaseSourceConfiguration;
|
|
3278
|
+
}
|
|
3279
|
+
/**
|
|
3280
|
+
* @public
|
|
3281
|
+
*/
|
|
3282
|
+
export interface CreateDeliveryStreamOutput {
|
|
3283
|
+
/**
|
|
3284
|
+
* <p>The ARN of the Firehose stream.</p>
|
|
3285
|
+
* @public
|
|
3286
|
+
*/
|
|
3287
|
+
DeliveryStreamARN?: string;
|
|
3288
|
+
}
|
|
3289
|
+
/**
|
|
3290
|
+
* <p>The specified input parameter has a value that is not valid.</p>
|
|
3291
|
+
* @public
|
|
3292
|
+
*/
|
|
3293
|
+
export declare class InvalidArgumentException extends __BaseException {
|
|
3294
|
+
readonly name: "InvalidArgumentException";
|
|
3295
|
+
readonly $fault: "client";
|
|
3296
|
+
/**
|
|
3297
|
+
* @internal
|
|
3298
|
+
*/
|
|
3299
|
+
constructor(opts: __ExceptionOptionType<InvalidArgumentException, __BaseException>);
|
|
3300
|
+
}
|
|
3301
|
+
/**
|
|
3302
|
+
* <p>Firehose throws this exception when an attempt to put records or to start
|
|
3303
|
+
* or stop Firehose stream encryption fails. This happens when the KMS service throws one of
|
|
3304
|
+
* the following exception types: <code>AccessDeniedException</code>,
|
|
3305
|
+
* <code>InvalidStateException</code>, <code>DisabledException</code>, or
|
|
3306
|
+
* <code>NotFoundException</code>.</p>
|
|
3307
|
+
* @public
|
|
3308
|
+
*/
|
|
3309
|
+
export declare class InvalidKMSResourceException extends __BaseException {
|
|
3310
|
+
readonly name: "InvalidKMSResourceException";
|
|
3311
|
+
readonly $fault: "client";
|
|
3312
|
+
code?: string;
|
|
3313
|
+
/**
|
|
3314
|
+
* @internal
|
|
3315
|
+
*/
|
|
3316
|
+
constructor(opts: __ExceptionOptionType<InvalidKMSResourceException, __BaseException>);
|
|
3317
|
+
}
|
|
3318
|
+
/**
|
|
3319
|
+
* <p>You have already reached the limit for a requested resource.</p>
|
|
3320
|
+
* @public
|
|
3321
|
+
*/
|
|
3322
|
+
export declare class LimitExceededException extends __BaseException {
|
|
3323
|
+
readonly name: "LimitExceededException";
|
|
3324
|
+
readonly $fault: "client";
|
|
3325
|
+
/**
|
|
3326
|
+
* @internal
|
|
3327
|
+
*/
|
|
3328
|
+
constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
|
|
3329
|
+
}
|
|
3330
|
+
/**
|
|
3331
|
+
* <p>The resource is already in use and not available for this operation.</p>
|
|
3332
|
+
* @public
|
|
3333
|
+
*/
|
|
3334
|
+
export declare class ResourceInUseException extends __BaseException {
|
|
3335
|
+
readonly name: "ResourceInUseException";
|
|
3336
|
+
readonly $fault: "client";
|
|
3337
|
+
/**
|
|
3338
|
+
* @internal
|
|
3339
|
+
*/
|
|
3340
|
+
constructor(opts: __ExceptionOptionType<ResourceInUseException, __BaseException>);
|
|
3341
|
+
}
|
|
3342
|
+
/**
|
|
3343
|
+
* @public
|
|
3344
|
+
* @enum
|
|
3345
|
+
*/
|
|
3346
|
+
export declare const DeliveryStreamFailureType: {
|
|
3347
|
+
readonly CREATE_ENI_FAILED: "CREATE_ENI_FAILED";
|
|
3348
|
+
readonly CREATE_KMS_GRANT_FAILED: "CREATE_KMS_GRANT_FAILED";
|
|
3349
|
+
readonly DELETE_ENI_FAILED: "DELETE_ENI_FAILED";
|
|
3350
|
+
readonly DISABLED_KMS_KEY: "DISABLED_KMS_KEY";
|
|
3351
|
+
readonly ENI_ACCESS_DENIED: "ENI_ACCESS_DENIED";
|
|
3352
|
+
readonly INVALID_KMS_KEY: "INVALID_KMS_KEY";
|
|
3353
|
+
readonly KMS_ACCESS_DENIED: "KMS_ACCESS_DENIED";
|
|
3354
|
+
readonly KMS_KEY_NOT_FOUND: "KMS_KEY_NOT_FOUND";
|
|
3355
|
+
readonly KMS_OPT_IN_REQUIRED: "KMS_OPT_IN_REQUIRED";
|
|
3356
|
+
readonly RETIRE_KMS_GRANT_FAILED: "RETIRE_KMS_GRANT_FAILED";
|
|
3357
|
+
readonly SECURITY_GROUP_ACCESS_DENIED: "SECURITY_GROUP_ACCESS_DENIED";
|
|
3358
|
+
readonly SECURITY_GROUP_NOT_FOUND: "SECURITY_GROUP_NOT_FOUND";
|
|
3359
|
+
readonly SUBNET_ACCESS_DENIED: "SUBNET_ACCESS_DENIED";
|
|
3360
|
+
readonly SUBNET_NOT_FOUND: "SUBNET_NOT_FOUND";
|
|
3361
|
+
readonly UNKNOWN_ERROR: "UNKNOWN_ERROR";
|
|
3362
|
+
readonly VPC_ENDPOINT_SERVICE_NAME_NOT_FOUND: "VPC_ENDPOINT_SERVICE_NAME_NOT_FOUND";
|
|
3363
|
+
readonly VPC_INTERFACE_ENDPOINT_SERVICE_ACCESS_DENIED: "VPC_INTERFACE_ENDPOINT_SERVICE_ACCESS_DENIED";
|
|
3364
|
+
};
|
|
3365
|
+
/**
|
|
3366
|
+
* @public
|
|
3367
|
+
*/
|
|
3368
|
+
export type DeliveryStreamFailureType = (typeof DeliveryStreamFailureType)[keyof typeof DeliveryStreamFailureType];
|
|
3369
|
+
/**
|
|
3370
|
+
* <p>Provides details in case one of the following operations fails due to an error related
|
|
3371
|
+
* to KMS: <a>CreateDeliveryStream</a>, <a>DeleteDeliveryStream</a>,
|
|
3372
|
+
* <a>StartDeliveryStreamEncryption</a>, <a>StopDeliveryStreamEncryption</a>.</p>
|
|
3373
|
+
* @public
|
|
3374
|
+
*/
|
|
3375
|
+
export interface FailureDescription {
|
|
3376
|
+
/**
|
|
3377
|
+
* <p>The type of error that caused the failure.</p>
|
|
3378
|
+
* @public
|
|
3379
|
+
*/
|
|
3380
|
+
Type: DeliveryStreamFailureType | undefined;
|
|
3381
|
+
/**
|
|
3382
|
+
* <p>A message providing details about the error that caused the failure.</p>
|
|
3383
|
+
* @public
|
|
3384
|
+
*/
|
|
3385
|
+
Details: string | undefined;
|
|
3386
|
+
}
|
|
3387
|
+
/**
|
|
3388
|
+
* @public
|
|
3389
|
+
* @enum
|
|
3390
|
+
*/
|
|
3391
|
+
export declare const SnapshotRequestedBy: {
|
|
3392
|
+
readonly FIREHOSE: "FIREHOSE";
|
|
3393
|
+
readonly USER: "USER";
|
|
3394
|
+
};
|
|
3395
|
+
/**
|
|
3396
|
+
* @public
|
|
3397
|
+
*/
|
|
3398
|
+
export type SnapshotRequestedBy = (typeof SnapshotRequestedBy)[keyof typeof SnapshotRequestedBy];
|
|
3399
|
+
/**
|
|
3400
|
+
* @public
|
|
3401
|
+
* @enum
|
|
3402
|
+
*/
|
|
3403
|
+
export declare const SnapshotStatus: {
|
|
3404
|
+
readonly COMPLETE: "COMPLETE";
|
|
3405
|
+
readonly IN_PROGRESS: "IN_PROGRESS";
|
|
3406
|
+
readonly SUSPENDED: "SUSPENDED";
|
|
3407
|
+
};
|
|
3408
|
+
/**
|
|
3409
|
+
* @public
|
|
3410
|
+
*/
|
|
3411
|
+
export type SnapshotStatus = (typeof SnapshotStatus)[keyof typeof SnapshotStatus];
|
|
3412
|
+
/**
|
|
3413
|
+
* <p>
|
|
3414
|
+
* </p>
|
|
3415
|
+
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
3416
|
+
* @public
|
|
3417
|
+
*/
|
|
3418
|
+
export interface DatabaseSnapshotInfo {
|
|
3419
|
+
/**
|
|
3420
|
+
* <p>
|
|
3421
|
+
* </p>
|
|
3422
|
+
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
2898
3423
|
* @public
|
|
2899
3424
|
*/
|
|
2900
|
-
|
|
3425
|
+
Id: string | undefined;
|
|
2901
3426
|
/**
|
|
2902
|
-
* <p>
|
|
2903
|
-
*
|
|
3427
|
+
* <p>
|
|
3428
|
+
* </p>
|
|
3429
|
+
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
2904
3430
|
* @public
|
|
2905
3431
|
*/
|
|
2906
|
-
|
|
3432
|
+
Table: string | undefined;
|
|
2907
3433
|
/**
|
|
2908
|
-
*
|
|
2909
|
-
*
|
|
2910
|
-
*
|
|
2911
|
-
* The destination in Amazon S3. You can specify only one destination.</p>
|
|
3434
|
+
* <p>
|
|
3435
|
+
* </p>
|
|
3436
|
+
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
2912
3437
|
* @public
|
|
2913
3438
|
*/
|
|
2914
|
-
|
|
3439
|
+
RequestTimestamp: Date | undefined;
|
|
2915
3440
|
/**
|
|
2916
|
-
* <p>
|
|
3441
|
+
* <p>
|
|
3442
|
+
* </p>
|
|
3443
|
+
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
2917
3444
|
* @public
|
|
2918
3445
|
*/
|
|
2919
|
-
|
|
3446
|
+
RequestedBy: SnapshotRequestedBy | undefined;
|
|
2920
3447
|
/**
|
|
2921
|
-
* <p>
|
|
3448
|
+
* <p>
|
|
3449
|
+
* </p>
|
|
3450
|
+
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
2922
3451
|
* @public
|
|
2923
3452
|
*/
|
|
2924
|
-
|
|
3453
|
+
Status: SnapshotStatus | undefined;
|
|
2925
3454
|
/**
|
|
2926
|
-
* <p>
|
|
3455
|
+
* <p>Provides details in case one of the following operations fails due to an error related
|
|
3456
|
+
* to KMS: <a>CreateDeliveryStream</a>, <a>DeleteDeliveryStream</a>,
|
|
3457
|
+
* <a>StartDeliveryStreamEncryption</a>, <a>StopDeliveryStreamEncryption</a>.</p>
|
|
2927
3458
|
* @public
|
|
2928
3459
|
*/
|
|
2929
|
-
|
|
3460
|
+
FailureDescription?: FailureDescription;
|
|
3461
|
+
}
|
|
3462
|
+
/**
|
|
3463
|
+
* <p>
|
|
3464
|
+
* </p>
|
|
3465
|
+
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
3466
|
+
* @public
|
|
3467
|
+
*/
|
|
3468
|
+
export interface DatabaseSourceDescription {
|
|
2930
3469
|
/**
|
|
2931
|
-
* <p>
|
|
2932
|
-
*
|
|
3470
|
+
* <p>
|
|
3471
|
+
* </p>
|
|
3472
|
+
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
2933
3473
|
* @public
|
|
2934
3474
|
*/
|
|
2935
|
-
|
|
3475
|
+
Type?: DatabaseType;
|
|
2936
3476
|
/**
|
|
2937
|
-
* <p>
|
|
3477
|
+
* <p>
|
|
3478
|
+
* </p>
|
|
3479
|
+
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
2938
3480
|
* @public
|
|
2939
3481
|
*/
|
|
2940
|
-
|
|
3482
|
+
Endpoint?: string;
|
|
2941
3483
|
/**
|
|
2942
|
-
* <p>
|
|
2943
|
-
*
|
|
3484
|
+
* <p>
|
|
3485
|
+
* </p>
|
|
3486
|
+
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
2944
3487
|
* @public
|
|
2945
3488
|
*/
|
|
2946
|
-
|
|
3489
|
+
Port?: number;
|
|
2947
3490
|
/**
|
|
2948
|
-
* <p>
|
|
2949
|
-
* define and assign to Amazon Web Services resources. Tags are metadata. For example, you can
|
|
2950
|
-
* add friendly names and descriptions or other types of information that can help you
|
|
2951
|
-
* distinguish the delivery stream. For more information about tags, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html">Using
|
|
2952
|
-
* Cost Allocation Tags</a> in the Amazon Web Services Billing and Cost Management User
|
|
2953
|
-
* Guide.</p>
|
|
2954
|
-
* <p>You can specify up to 50 tags when creating a delivery stream.</p>
|
|
2955
|
-
* <p>If you specify tags in the <code>CreateDeliveryStream</code> action, Amazon Data
|
|
2956
|
-
* Firehose performs an additional authorization on the
|
|
2957
|
-
* <code>firehose:TagDeliveryStream</code> action to verify if users have permissions to
|
|
2958
|
-
* create tags. If you do not provide this permission, requests to create new Firehose
|
|
2959
|
-
* delivery streams with IAM resource tags will fail with an
|
|
2960
|
-
* <code>AccessDeniedException</code> such as following.</p>
|
|
2961
|
-
* <p>
|
|
2962
|
-
* <b>AccessDeniedException</b>
|
|
2963
|
-
* </p>
|
|
2964
|
-
* <p>User: arn:aws:sts::x:assumed-role/x/x is not authorized to perform: firehose:TagDeliveryStream on resource: arn:aws:firehose:us-east-1:x:deliverystream/x with an explicit deny in an identity-based policy.</p>
|
|
2965
|
-
* <p>For an example IAM policy, see <a href="https://docs.aws.amazon.com/firehose/latest/APIReference/API_CreateDeliveryStream.html#API_CreateDeliveryStream_Examples">Tag example.</a>
|
|
3491
|
+
* <p>
|
|
2966
3492
|
* </p>
|
|
3493
|
+
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
2967
3494
|
* @public
|
|
2968
3495
|
*/
|
|
2969
|
-
|
|
3496
|
+
SSLMode?: SSLMode;
|
|
2970
3497
|
/**
|
|
2971
|
-
* <p>
|
|
2972
|
-
*
|
|
3498
|
+
* <p>
|
|
3499
|
+
* </p>
|
|
3500
|
+
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
2973
3501
|
* @public
|
|
2974
3502
|
*/
|
|
2975
|
-
|
|
3503
|
+
Databases?: DatabaseList;
|
|
2976
3504
|
/**
|
|
2977
|
-
* <p>
|
|
2978
|
-
*
|
|
3505
|
+
* <p>
|
|
3506
|
+
* </p>
|
|
3507
|
+
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
2979
3508
|
* @public
|
|
2980
3509
|
*/
|
|
2981
|
-
|
|
3510
|
+
Tables?: DatabaseTableList;
|
|
2982
3511
|
/**
|
|
2983
|
-
* <p>
|
|
3512
|
+
* <p>
|
|
3513
|
+
* </p>
|
|
3514
|
+
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
2984
3515
|
* @public
|
|
2985
3516
|
*/
|
|
2986
|
-
|
|
3517
|
+
Columns?: DatabaseColumnList;
|
|
2987
3518
|
/**
|
|
2988
3519
|
* <p>
|
|
2989
|
-
*
|
|
2990
|
-
* </p>
|
|
3520
|
+
* </p>
|
|
2991
3521
|
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
2992
3522
|
* @public
|
|
2993
3523
|
*/
|
|
2994
|
-
|
|
2995
|
-
}
|
|
2996
|
-
/**
|
|
2997
|
-
* @public
|
|
2998
|
-
*/
|
|
2999
|
-
export interface CreateDeliveryStreamOutput {
|
|
3524
|
+
SurrogateKeys?: string[];
|
|
3000
3525
|
/**
|
|
3001
|
-
* <p>
|
|
3526
|
+
* <p>
|
|
3527
|
+
* </p>
|
|
3528
|
+
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
3002
3529
|
* @public
|
|
3003
3530
|
*/
|
|
3004
|
-
|
|
3005
|
-
}
|
|
3006
|
-
/**
|
|
3007
|
-
* <p>The specified input parameter has a value that is not valid.</p>
|
|
3008
|
-
* @public
|
|
3009
|
-
*/
|
|
3010
|
-
export declare class InvalidArgumentException extends __BaseException {
|
|
3011
|
-
readonly name: "InvalidArgumentException";
|
|
3012
|
-
readonly $fault: "client";
|
|
3013
|
-
/**
|
|
3014
|
-
* @internal
|
|
3015
|
-
*/
|
|
3016
|
-
constructor(opts: __ExceptionOptionType<InvalidArgumentException, __BaseException>);
|
|
3017
|
-
}
|
|
3018
|
-
/**
|
|
3019
|
-
* <p>Firehose throws this exception when an attempt to put records or to start
|
|
3020
|
-
* or stop delivery stream encryption fails. This happens when the KMS service throws one of
|
|
3021
|
-
* the following exception types: <code>AccessDeniedException</code>,
|
|
3022
|
-
* <code>InvalidStateException</code>, <code>DisabledException</code>, or
|
|
3023
|
-
* <code>NotFoundException</code>.</p>
|
|
3024
|
-
* @public
|
|
3025
|
-
*/
|
|
3026
|
-
export declare class InvalidKMSResourceException extends __BaseException {
|
|
3027
|
-
readonly name: "InvalidKMSResourceException";
|
|
3028
|
-
readonly $fault: "client";
|
|
3029
|
-
code?: string;
|
|
3531
|
+
SnapshotWatermarkTable?: string;
|
|
3030
3532
|
/**
|
|
3031
|
-
*
|
|
3533
|
+
* <p>
|
|
3534
|
+
* </p>
|
|
3535
|
+
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
3536
|
+
* @public
|
|
3032
3537
|
*/
|
|
3033
|
-
|
|
3034
|
-
}
|
|
3035
|
-
/**
|
|
3036
|
-
* <p>You have already reached the limit for a requested resource.</p>
|
|
3037
|
-
* @public
|
|
3038
|
-
*/
|
|
3039
|
-
export declare class LimitExceededException extends __BaseException {
|
|
3040
|
-
readonly name: "LimitExceededException";
|
|
3041
|
-
readonly $fault: "client";
|
|
3538
|
+
SnapshotInfo?: DatabaseSnapshotInfo[];
|
|
3042
3539
|
/**
|
|
3043
|
-
*
|
|
3540
|
+
* <p>
|
|
3541
|
+
* </p>
|
|
3542
|
+
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
3543
|
+
* @public
|
|
3044
3544
|
*/
|
|
3045
|
-
|
|
3046
|
-
}
|
|
3047
|
-
/**
|
|
3048
|
-
* <p>The resource is already in use and not available for this operation.</p>
|
|
3049
|
-
* @public
|
|
3050
|
-
*/
|
|
3051
|
-
export declare class ResourceInUseException extends __BaseException {
|
|
3052
|
-
readonly name: "ResourceInUseException";
|
|
3053
|
-
readonly $fault: "client";
|
|
3545
|
+
DatabaseSourceAuthenticationConfiguration?: DatabaseSourceAuthenticationConfiguration;
|
|
3054
3546
|
/**
|
|
3055
|
-
*
|
|
3547
|
+
* <p>
|
|
3548
|
+
* </p>
|
|
3549
|
+
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
3550
|
+
* @public
|
|
3056
3551
|
*/
|
|
3057
|
-
|
|
3552
|
+
DatabaseSourceVPCConfiguration?: DatabaseSourceVPCConfiguration;
|
|
3058
3553
|
}
|
|
3059
3554
|
/**
|
|
3060
3555
|
* @public
|
|
3061
3556
|
*/
|
|
3062
3557
|
export interface DeleteDeliveryStreamInput {
|
|
3063
3558
|
/**
|
|
3064
|
-
* <p>The name of the
|
|
3559
|
+
* <p>The name of the Firehose stream.</p>
|
|
3065
3560
|
* @public
|
|
3066
3561
|
*/
|
|
3067
3562
|
DeliveryStreamName: string | undefined;
|
|
3068
3563
|
/**
|
|
3069
|
-
* <p>Set this to true if you want to delete the
|
|
3564
|
+
* <p>Set this to true if you want to delete the Firehose stream even if Firehose
|
|
3070
3565
|
* is unable to retire the grant for the CMK. Firehose might be unable to retire
|
|
3071
3566
|
* the grant due to a customer error, such as when the CMK or the grant are in an invalid
|
|
3072
3567
|
* state. If you force deletion, you can then use the <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_RevokeGrant.html">RevokeGrant</a> operation to
|
|
@@ -3095,49 +3590,6 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
3095
3590
|
*/
|
|
3096
3591
|
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
3097
3592
|
}
|
|
3098
|
-
/**
|
|
3099
|
-
* @public
|
|
3100
|
-
* @enum
|
|
3101
|
-
*/
|
|
3102
|
-
export declare const DeliveryStreamFailureType: {
|
|
3103
|
-
readonly CREATE_ENI_FAILED: "CREATE_ENI_FAILED";
|
|
3104
|
-
readonly CREATE_KMS_GRANT_FAILED: "CREATE_KMS_GRANT_FAILED";
|
|
3105
|
-
readonly DELETE_ENI_FAILED: "DELETE_ENI_FAILED";
|
|
3106
|
-
readonly DISABLED_KMS_KEY: "DISABLED_KMS_KEY";
|
|
3107
|
-
readonly ENI_ACCESS_DENIED: "ENI_ACCESS_DENIED";
|
|
3108
|
-
readonly INVALID_KMS_KEY: "INVALID_KMS_KEY";
|
|
3109
|
-
readonly KMS_ACCESS_DENIED: "KMS_ACCESS_DENIED";
|
|
3110
|
-
readonly KMS_KEY_NOT_FOUND: "KMS_KEY_NOT_FOUND";
|
|
3111
|
-
readonly KMS_OPT_IN_REQUIRED: "KMS_OPT_IN_REQUIRED";
|
|
3112
|
-
readonly RETIRE_KMS_GRANT_FAILED: "RETIRE_KMS_GRANT_FAILED";
|
|
3113
|
-
readonly SECURITY_GROUP_ACCESS_DENIED: "SECURITY_GROUP_ACCESS_DENIED";
|
|
3114
|
-
readonly SECURITY_GROUP_NOT_FOUND: "SECURITY_GROUP_NOT_FOUND";
|
|
3115
|
-
readonly SUBNET_ACCESS_DENIED: "SUBNET_ACCESS_DENIED";
|
|
3116
|
-
readonly SUBNET_NOT_FOUND: "SUBNET_NOT_FOUND";
|
|
3117
|
-
readonly UNKNOWN_ERROR: "UNKNOWN_ERROR";
|
|
3118
|
-
};
|
|
3119
|
-
/**
|
|
3120
|
-
* @public
|
|
3121
|
-
*/
|
|
3122
|
-
export type DeliveryStreamFailureType = (typeof DeliveryStreamFailureType)[keyof typeof DeliveryStreamFailureType];
|
|
3123
|
-
/**
|
|
3124
|
-
* <p>Provides details in case one of the following operations fails due to an error related
|
|
3125
|
-
* to KMS: <a>CreateDeliveryStream</a>, <a>DeleteDeliveryStream</a>,
|
|
3126
|
-
* <a>StartDeliveryStreamEncryption</a>, <a>StopDeliveryStreamEncryption</a>.</p>
|
|
3127
|
-
* @public
|
|
3128
|
-
*/
|
|
3129
|
-
export interface FailureDescription {
|
|
3130
|
-
/**
|
|
3131
|
-
* <p>The type of error that caused the failure.</p>
|
|
3132
|
-
* @public
|
|
3133
|
-
*/
|
|
3134
|
-
Type: DeliveryStreamFailureType | undefined;
|
|
3135
|
-
/**
|
|
3136
|
-
* <p>A message providing details about the error that caused the failure.</p>
|
|
3137
|
-
* @public
|
|
3138
|
-
*/
|
|
3139
|
-
Details: string | undefined;
|
|
3140
|
-
}
|
|
3141
3593
|
/**
|
|
3142
3594
|
* @public
|
|
3143
3595
|
* @enum
|
|
@@ -3176,7 +3628,7 @@ export interface DeliveryStreamEncryptionConfiguration {
|
|
|
3176
3628
|
*/
|
|
3177
3629
|
KeyType?: KeyType;
|
|
3178
3630
|
/**
|
|
3179
|
-
* <p>This is the server-side encryption (SSE) status for the
|
|
3631
|
+
* <p>This is the server-side encryption (SSE) status for the Firehose stream. For a full
|
|
3180
3632
|
* description of the different values of this status, see <a>StartDeliveryStreamEncryption</a> and <a>StopDeliveryStreamEncryption</a>. If this status is <code>ENABLING_FAILED</code>
|
|
3181
3633
|
* or <code>DISABLING_FAILED</code>, it is the status of the most recent attempt to enable or
|
|
3182
3634
|
* disable SSE, respectively.</p>
|
|
@@ -3343,7 +3795,7 @@ export interface ExtendedS3DestinationDescription {
|
|
|
3343
3795
|
*/
|
|
3344
3796
|
EncryptionConfiguration: EncryptionConfiguration | undefined;
|
|
3345
3797
|
/**
|
|
3346
|
-
* <p>The Amazon CloudWatch logging options for your
|
|
3798
|
+
* <p>The Amazon CloudWatch logging options for your Firehose stream.</p>
|
|
3347
3799
|
* @public
|
|
3348
3800
|
*/
|
|
3349
3801
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
|
@@ -3423,7 +3875,7 @@ export interface HttpEndpointDestinationDescription {
|
|
|
3423
3875
|
*/
|
|
3424
3876
|
BufferingHints?: HttpEndpointBufferingHints;
|
|
3425
3877
|
/**
|
|
3426
|
-
* <p>Describes the Amazon CloudWatch logging options for your
|
|
3878
|
+
* <p>Describes the Amazon CloudWatch logging options for your Firehose stream.</p>
|
|
3427
3879
|
* @public
|
|
3428
3880
|
*/
|
|
3429
3881
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
|
@@ -3476,17 +3928,29 @@ export interface HttpEndpointDestinationDescription {
|
|
|
3476
3928
|
* <p>
|
|
3477
3929
|
* Describes a destination in Apache Iceberg Tables.
|
|
3478
3930
|
* </p>
|
|
3479
|
-
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
3480
3931
|
* @public
|
|
3481
3932
|
*/
|
|
3482
3933
|
export interface IcebergDestinationDescription {
|
|
3483
3934
|
/**
|
|
3484
3935
|
* <p> Provides a list of <code>DestinationTableConfigurations</code> which Firehose uses
|
|
3485
|
-
* to deliver data to Apache Iceberg
|
|
3486
|
-
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
3936
|
+
* to deliver data to Apache Iceberg Tables. Firehose will write data with insert if table specific configuration is not provided here.</p>
|
|
3487
3937
|
* @public
|
|
3488
3938
|
*/
|
|
3489
3939
|
DestinationTableConfigurationList?: DestinationTableConfiguration[];
|
|
3940
|
+
/**
|
|
3941
|
+
* <p>
|
|
3942
|
+
* </p>
|
|
3943
|
+
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
3944
|
+
* @public
|
|
3945
|
+
*/
|
|
3946
|
+
SchemaEvolutionConfiguration?: SchemaEvolutionConfiguration;
|
|
3947
|
+
/**
|
|
3948
|
+
* <p>
|
|
3949
|
+
* </p>
|
|
3950
|
+
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
3951
|
+
* @public
|
|
3952
|
+
*/
|
|
3953
|
+
TableCreationConfiguration?: TableCreationConfiguration;
|
|
3490
3954
|
/**
|
|
3491
3955
|
* <p>Describes hints for the buffering to perform before delivering data to the
|
|
3492
3956
|
* destination. These options are treated as hints, and therefore Firehose might
|
|
@@ -3497,7 +3961,7 @@ export interface IcebergDestinationDescription {
|
|
|
3497
3961
|
*/
|
|
3498
3962
|
BufferingHints?: BufferingHints;
|
|
3499
3963
|
/**
|
|
3500
|
-
* <p>Describes the Amazon CloudWatch logging options for your
|
|
3964
|
+
* <p>Describes the Amazon CloudWatch logging options for your Firehose stream.</p>
|
|
3501
3965
|
* @public
|
|
3502
3966
|
*/
|
|
3503
3967
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
|
@@ -3508,22 +3972,19 @@ export interface IcebergDestinationDescription {
|
|
|
3508
3972
|
ProcessingConfiguration?: ProcessingConfiguration;
|
|
3509
3973
|
/**
|
|
3510
3974
|
* <p> Describes how Firehose will backup records. Currently,Firehose only supports
|
|
3511
|
-
* <code>FailedDataOnly</code
|
|
3512
|
-
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
3975
|
+
* <code>FailedDataOnly</code>. </p>
|
|
3513
3976
|
* @public
|
|
3514
3977
|
*/
|
|
3515
3978
|
S3BackupMode?: IcebergS3BackupMode;
|
|
3516
3979
|
/**
|
|
3517
|
-
* <p> The retry behavior in case Firehose is unable to deliver data to
|
|
3518
|
-
* S3 prefix.</p>
|
|
3980
|
+
* <p> The retry behavior in case Firehose is unable to deliver data to a destination.</p>
|
|
3519
3981
|
* @public
|
|
3520
3982
|
*/
|
|
3521
3983
|
RetryOptions?: RetryOptions;
|
|
3522
3984
|
/**
|
|
3523
3985
|
* <p>
|
|
3524
|
-
* The Amazon Resource Name (ARN) of the Apache Iceberg Tables
|
|
3986
|
+
* The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling Apache Iceberg Tables.
|
|
3525
3987
|
* </p>
|
|
3526
|
-
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
3527
3988
|
* @public
|
|
3528
3989
|
*/
|
|
3529
3990
|
RoleARN?: string;
|
|
@@ -3531,7 +3992,6 @@ export interface IcebergDestinationDescription {
|
|
|
3531
3992
|
* <p>
|
|
3532
3993
|
* Configuration describing where the destination Iceberg tables are persisted.
|
|
3533
3994
|
* </p>
|
|
3534
|
-
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
3535
3995
|
* @public
|
|
3536
3996
|
*/
|
|
3537
3997
|
CatalogConfiguration?: CatalogConfiguration;
|
|
@@ -3595,7 +4055,7 @@ export interface RedshiftDestinationDescription {
|
|
|
3595
4055
|
*/
|
|
3596
4056
|
S3BackupDescription?: S3DestinationDescription;
|
|
3597
4057
|
/**
|
|
3598
|
-
* <p>The Amazon CloudWatch logging options for your
|
|
4058
|
+
* <p>The Amazon CloudWatch logging options for your Firehose stream.</p>
|
|
3599
4059
|
* @public
|
|
3600
4060
|
*/
|
|
3601
4061
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
|
@@ -3666,7 +4126,7 @@ export interface SnowflakeDestinationDescription {
|
|
|
3666
4126
|
*/
|
|
3667
4127
|
SnowflakeVpcConfiguration?: SnowflakeVpcConfiguration;
|
|
3668
4128
|
/**
|
|
3669
|
-
* <p>Describes the Amazon CloudWatch logging options for your
|
|
4129
|
+
* <p>Describes the Amazon CloudWatch logging options for your Firehose stream.</p>
|
|
3670
4130
|
* @public
|
|
3671
4131
|
*/
|
|
3672
4132
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
|
@@ -3766,7 +4226,7 @@ export interface SplunkDestinationDescription {
|
|
|
3766
4226
|
*/
|
|
3767
4227
|
ProcessingConfiguration?: ProcessingConfiguration;
|
|
3768
4228
|
/**
|
|
3769
|
-
* <p>The Amazon CloudWatch logging options for your
|
|
4229
|
+
* <p>The Amazon CloudWatch logging options for your Firehose stream.</p>
|
|
3770
4230
|
* @public
|
|
3771
4231
|
*/
|
|
3772
4232
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
|
@@ -3784,7 +4244,7 @@ export interface SplunkDestinationDescription {
|
|
|
3784
4244
|
SecretsManagerConfiguration?: SecretsManagerConfiguration;
|
|
3785
4245
|
}
|
|
3786
4246
|
/**
|
|
3787
|
-
* <p>Describes the destination for a
|
|
4247
|
+
* <p>Describes the destination for a Firehose stream.</p>
|
|
3788
4248
|
* @public
|
|
3789
4249
|
*/
|
|
3790
4250
|
export interface DestinationDescription {
|
|
@@ -3842,14 +4302,13 @@ export interface DestinationDescription {
|
|
|
3842
4302
|
* <p>
|
|
3843
4303
|
* Describes a destination in Apache Iceberg Tables.
|
|
3844
4304
|
* </p>
|
|
3845
|
-
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
3846
4305
|
* @public
|
|
3847
4306
|
*/
|
|
3848
4307
|
IcebergDestinationDescription?: IcebergDestinationDescription;
|
|
3849
4308
|
}
|
|
3850
4309
|
/**
|
|
3851
4310
|
* <p>Details about a Kinesis data stream used as the source for a Firehose
|
|
3852
|
-
*
|
|
4311
|
+
* Firehose stream.</p>
|
|
3853
4312
|
* @public
|
|
3854
4313
|
*/
|
|
3855
4314
|
export interface KinesisStreamSourceDescription {
|
|
@@ -3876,7 +4335,7 @@ export interface KinesisStreamSourceDescription {
|
|
|
3876
4335
|
}
|
|
3877
4336
|
/**
|
|
3878
4337
|
* <p>Details about the Amazon MSK cluster used as the source for a Firehose
|
|
3879
|
-
*
|
|
4338
|
+
* Firehose stream.</p>
|
|
3880
4339
|
* @public
|
|
3881
4340
|
*/
|
|
3882
4341
|
export interface MSKSourceDescription {
|
|
@@ -3913,7 +4372,7 @@ export interface MSKSourceDescription {
|
|
|
3913
4372
|
}
|
|
3914
4373
|
/**
|
|
3915
4374
|
* <p>Details about a Kinesis data stream used as the source for a Firehose
|
|
3916
|
-
*
|
|
4375
|
+
* Firehose stream.</p>
|
|
3917
4376
|
* @public
|
|
3918
4377
|
*/
|
|
3919
4378
|
export interface SourceDescription {
|
|
@@ -3929,26 +4388,33 @@ export interface SourceDescription {
|
|
|
3929
4388
|
* @public
|
|
3930
4389
|
*/
|
|
3931
4390
|
MSKSourceDescription?: MSKSourceDescription;
|
|
4391
|
+
/**
|
|
4392
|
+
* <p>
|
|
4393
|
+
* </p>
|
|
4394
|
+
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
4395
|
+
* @public
|
|
4396
|
+
*/
|
|
4397
|
+
DatabaseSourceDescription?: DatabaseSourceDescription;
|
|
3932
4398
|
}
|
|
3933
4399
|
/**
|
|
3934
|
-
* <p>Contains information about a
|
|
4400
|
+
* <p>Contains information about a Firehose stream.</p>
|
|
3935
4401
|
* @public
|
|
3936
4402
|
*/
|
|
3937
4403
|
export interface DeliveryStreamDescription {
|
|
3938
4404
|
/**
|
|
3939
|
-
* <p>The name of the
|
|
4405
|
+
* <p>The name of the Firehose stream.</p>
|
|
3940
4406
|
* @public
|
|
3941
4407
|
*/
|
|
3942
4408
|
DeliveryStreamName: string | undefined;
|
|
3943
4409
|
/**
|
|
3944
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
4410
|
+
* <p>The Amazon Resource Name (ARN) of the Firehose stream. For more information, see
|
|
3945
4411
|
* <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
|
|
3946
4412
|
* Resource Names (ARNs) and Amazon Web Services Service Namespaces</a>.</p>
|
|
3947
4413
|
* @public
|
|
3948
4414
|
*/
|
|
3949
4415
|
DeliveryStreamARN: string | undefined;
|
|
3950
4416
|
/**
|
|
3951
|
-
* <p>The status of the
|
|
4417
|
+
* <p>The status of the Firehose stream. If the status of a Firehose stream is
|
|
3952
4418
|
* <code>CREATING_FAILED</code>, this status doesn't change, and you can't invoke
|
|
3953
4419
|
* <code>CreateDeliveryStream</code> again on it. However, you can invoke the <a>DeleteDeliveryStream</a> operation to delete it.</p>
|
|
3954
4420
|
* @public
|
|
@@ -3962,21 +4428,21 @@ export interface DeliveryStreamDescription {
|
|
|
3962
4428
|
*/
|
|
3963
4429
|
FailureDescription?: FailureDescription;
|
|
3964
4430
|
/**
|
|
3965
|
-
* <p>Indicates the server-side encryption (SSE) status for the
|
|
4431
|
+
* <p>Indicates the server-side encryption (SSE) status for the Firehose stream.</p>
|
|
3966
4432
|
* @public
|
|
3967
4433
|
*/
|
|
3968
4434
|
DeliveryStreamEncryptionConfiguration?: DeliveryStreamEncryptionConfiguration;
|
|
3969
4435
|
/**
|
|
3970
|
-
* <p>The
|
|
4436
|
+
* <p>The Firehose stream type. This can be one of the following values:</p>
|
|
3971
4437
|
* <ul>
|
|
3972
4438
|
* <li>
|
|
3973
4439
|
* <p>
|
|
3974
|
-
* <code>DirectPut</code>: Provider applications access the
|
|
4440
|
+
* <code>DirectPut</code>: Provider applications access the Firehose stream
|
|
3975
4441
|
* directly.</p>
|
|
3976
4442
|
* </li>
|
|
3977
4443
|
* <li>
|
|
3978
4444
|
* <p>
|
|
3979
|
-
* <code>KinesisStreamAsSource</code>: The
|
|
4445
|
+
* <code>KinesisStreamAsSource</code>: The Firehose stream uses a Kinesis data
|
|
3980
4446
|
* stream as a source.</p>
|
|
3981
4447
|
* </li>
|
|
3982
4448
|
* </ul>
|
|
@@ -3984,7 +4450,7 @@ export interface DeliveryStreamDescription {
|
|
|
3984
4450
|
*/
|
|
3985
4451
|
DeliveryStreamType: DeliveryStreamType | undefined;
|
|
3986
4452
|
/**
|
|
3987
|
-
* <p>Each time the destination is updated for a
|
|
4453
|
+
* <p>Each time the destination is updated for a Firehose stream, the version ID is
|
|
3988
4454
|
* changed, and the current version ID is required when updating the destination. This is so
|
|
3989
4455
|
* that the service knows it is applying the changes to the correct version of the delivery
|
|
3990
4456
|
* stream.</p>
|
|
@@ -3992,12 +4458,12 @@ export interface DeliveryStreamDescription {
|
|
|
3992
4458
|
*/
|
|
3993
4459
|
VersionId: string | undefined;
|
|
3994
4460
|
/**
|
|
3995
|
-
* <p>The date and time that the
|
|
4461
|
+
* <p>The date and time that the Firehose stream was created.</p>
|
|
3996
4462
|
* @public
|
|
3997
4463
|
*/
|
|
3998
4464
|
CreateTimestamp?: Date;
|
|
3999
4465
|
/**
|
|
4000
|
-
* <p>The date and time that the
|
|
4466
|
+
* <p>The date and time that the Firehose stream was last updated.</p>
|
|
4001
4467
|
* @public
|
|
4002
4468
|
*/
|
|
4003
4469
|
LastUpdateTimestamp?: Date;
|
|
@@ -4024,18 +4490,18 @@ export interface DeliveryStreamDescription {
|
|
|
4024
4490
|
*/
|
|
4025
4491
|
export interface DescribeDeliveryStreamInput {
|
|
4026
4492
|
/**
|
|
4027
|
-
* <p>The name of the
|
|
4493
|
+
* <p>The name of the Firehose stream.</p>
|
|
4028
4494
|
* @public
|
|
4029
4495
|
*/
|
|
4030
4496
|
DeliveryStreamName: string | undefined;
|
|
4031
4497
|
/**
|
|
4032
4498
|
* <p>The limit on the number of destinations to return. You can have one destination per
|
|
4033
|
-
*
|
|
4499
|
+
* Firehose stream.</p>
|
|
4034
4500
|
* @public
|
|
4035
4501
|
*/
|
|
4036
4502
|
Limit?: number;
|
|
4037
4503
|
/**
|
|
4038
|
-
* <p>The ID of the destination to start returning the destination information. Firehose supports one destination per
|
|
4504
|
+
* <p>The ID of the destination to start returning the destination information. Firehose supports one destination per Firehose stream.</p>
|
|
4039
4505
|
* @public
|
|
4040
4506
|
*/
|
|
4041
4507
|
ExclusiveStartDestinationId?: string;
|
|
@@ -4045,7 +4511,7 @@ export interface DescribeDeliveryStreamInput {
|
|
|
4045
4511
|
*/
|
|
4046
4512
|
export interface DescribeDeliveryStreamOutput {
|
|
4047
4513
|
/**
|
|
4048
|
-
* <p>Information about the
|
|
4514
|
+
* <p>Information about the Firehose stream.</p>
|
|
4049
4515
|
* @public
|
|
4050
4516
|
*/
|
|
4051
4517
|
DeliveryStreamDescription: DeliveryStreamDescription | undefined;
|
|
@@ -4088,9 +4554,9 @@ export interface ElasticsearchDestinationUpdate {
|
|
|
4088
4554
|
* <p>The Elasticsearch type name. For Elasticsearch 6.x, there can be only one type per
|
|
4089
4555
|
* index. If you try to specify a new type for an existing index that already has another
|
|
4090
4556
|
* type, Firehose returns an error during runtime.</p>
|
|
4091
|
-
* <p>If you upgrade Elasticsearch from 6.x to 7.x and don’t update your
|
|
4557
|
+
* <p>If you upgrade Elasticsearch from 6.x to 7.x and don’t update your Firehose stream,
|
|
4092
4558
|
* Firehose still delivers data to Elasticsearch with the old index name and type
|
|
4093
|
-
* name. If you want to update your
|
|
4559
|
+
* name. If you want to update your Firehose stream with a new index name, provide an empty
|
|
4094
4560
|
* string for <code>TypeName</code>. </p>
|
|
4095
4561
|
* @public
|
|
4096
4562
|
*/
|
|
@@ -4126,7 +4592,7 @@ export interface ElasticsearchDestinationUpdate {
|
|
|
4126
4592
|
*/
|
|
4127
4593
|
ProcessingConfiguration?: ProcessingConfiguration;
|
|
4128
4594
|
/**
|
|
4129
|
-
* <p>The CloudWatch logging options for your
|
|
4595
|
+
* <p>The CloudWatch logging options for your Firehose stream.</p>
|
|
4130
4596
|
* @public
|
|
4131
4597
|
*/
|
|
4132
4598
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
|
@@ -4187,7 +4653,7 @@ export interface ExtendedS3DestinationUpdate {
|
|
|
4187
4653
|
*/
|
|
4188
4654
|
EncryptionConfiguration?: EncryptionConfiguration;
|
|
4189
4655
|
/**
|
|
4190
|
-
* <p>The Amazon CloudWatch logging options for your
|
|
4656
|
+
* <p>The Amazon CloudWatch logging options for your Firehose stream.</p>
|
|
4191
4657
|
* @public
|
|
4192
4658
|
*/
|
|
4193
4659
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
|
@@ -4197,8 +4663,8 @@ export interface ExtendedS3DestinationUpdate {
|
|
|
4197
4663
|
*/
|
|
4198
4664
|
ProcessingConfiguration?: ProcessingConfiguration;
|
|
4199
4665
|
/**
|
|
4200
|
-
* <p>You can update a
|
|
4201
|
-
* backup is enabled, you can't update the
|
|
4666
|
+
* <p>You can update a Firehose stream to enable Amazon S3 backup if it is disabled. If
|
|
4667
|
+
* backup is enabled, you can't update the Firehose stream to disable it. </p>
|
|
4202
4668
|
* @public
|
|
4203
4669
|
*/
|
|
4204
4670
|
S3BackupMode?: S3BackupMode;
|
|
@@ -4237,32 +4703,32 @@ export interface ExtendedS3DestinationUpdate {
|
|
|
4237
4703
|
*/
|
|
4238
4704
|
export interface ListDeliveryStreamsInput {
|
|
4239
4705
|
/**
|
|
4240
|
-
* <p>The maximum number of
|
|
4706
|
+
* <p>The maximum number of Firehose streams to list. The default value is 10.</p>
|
|
4241
4707
|
* @public
|
|
4242
4708
|
*/
|
|
4243
4709
|
Limit?: number;
|
|
4244
4710
|
/**
|
|
4245
|
-
* <p>The
|
|
4711
|
+
* <p>The Firehose stream type. This can be one of the following values:</p>
|
|
4246
4712
|
* <ul>
|
|
4247
4713
|
* <li>
|
|
4248
4714
|
* <p>
|
|
4249
|
-
* <code>DirectPut</code>: Provider applications access the
|
|
4715
|
+
* <code>DirectPut</code>: Provider applications access the Firehose stream
|
|
4250
4716
|
* directly.</p>
|
|
4251
4717
|
* </li>
|
|
4252
4718
|
* <li>
|
|
4253
4719
|
* <p>
|
|
4254
|
-
* <code>KinesisStreamAsSource</code>: The
|
|
4720
|
+
* <code>KinesisStreamAsSource</code>: The Firehose stream uses a Kinesis data
|
|
4255
4721
|
* stream as a source.</p>
|
|
4256
4722
|
* </li>
|
|
4257
4723
|
* </ul>
|
|
4258
|
-
* <p>This parameter is optional. If this parameter is omitted,
|
|
4724
|
+
* <p>This parameter is optional. If this parameter is omitted, Firehose streams of all
|
|
4259
4725
|
* types are returned.</p>
|
|
4260
4726
|
* @public
|
|
4261
4727
|
*/
|
|
4262
4728
|
DeliveryStreamType?: DeliveryStreamType;
|
|
4263
4729
|
/**
|
|
4264
|
-
* <p>The list of
|
|
4265
|
-
* <code>ListDeliveryStreams</code> will start with the
|
|
4730
|
+
* <p>The list of Firehose streams returned by this call to
|
|
4731
|
+
* <code>ListDeliveryStreams</code> will start with the Firehose stream whose name comes
|
|
4266
4732
|
* alphabetically immediately after the name you specify in
|
|
4267
4733
|
* <code>ExclusiveStartDeliveryStreamName</code>.</p>
|
|
4268
4734
|
* @public
|
|
@@ -4274,12 +4740,12 @@ export interface ListDeliveryStreamsInput {
|
|
|
4274
4740
|
*/
|
|
4275
4741
|
export interface ListDeliveryStreamsOutput {
|
|
4276
4742
|
/**
|
|
4277
|
-
* <p>The names of the
|
|
4743
|
+
* <p>The names of the Firehose streams.</p>
|
|
4278
4744
|
* @public
|
|
4279
4745
|
*/
|
|
4280
4746
|
DeliveryStreamNames: string[] | undefined;
|
|
4281
4747
|
/**
|
|
4282
|
-
* <p>Indicates whether there are more
|
|
4748
|
+
* <p>Indicates whether there are more Firehose streams available to list.</p>
|
|
4283
4749
|
* @public
|
|
4284
4750
|
*/
|
|
4285
4751
|
HasMoreDeliveryStreams: boolean | undefined;
|
|
@@ -4289,7 +4755,7 @@ export interface ListDeliveryStreamsOutput {
|
|
|
4289
4755
|
*/
|
|
4290
4756
|
export interface ListTagsForDeliveryStreamInput {
|
|
4291
4757
|
/**
|
|
4292
|
-
* <p>The name of the
|
|
4758
|
+
* <p>The name of the Firehose stream whose tags you want to list.</p>
|
|
4293
4759
|
* @public
|
|
4294
4760
|
*/
|
|
4295
4761
|
DeliveryStreamName: string | undefined;
|
|
@@ -4302,7 +4768,7 @@ export interface ListTagsForDeliveryStreamInput {
|
|
|
4302
4768
|
ExclusiveStartTagKey?: string;
|
|
4303
4769
|
/**
|
|
4304
4770
|
* <p>The number of tags to return. If this number is less than the total number of tags
|
|
4305
|
-
* associated with the
|
|
4771
|
+
* associated with the Firehose stream, <code>HasMoreTags</code> is set to <code>true</code>
|
|
4306
4772
|
* in the response. To list additional tags, set <code>ExclusiveStartTagKey</code> to the last
|
|
4307
4773
|
* key in the response. </p>
|
|
4308
4774
|
* @public
|
|
@@ -4342,7 +4808,7 @@ export declare class InvalidSourceException extends __BaseException {
|
|
|
4342
4808
|
constructor(opts: __ExceptionOptionType<InvalidSourceException, __BaseException>);
|
|
4343
4809
|
}
|
|
4344
4810
|
/**
|
|
4345
|
-
* <p>The unit of data in a
|
|
4811
|
+
* <p>The unit of data in a Firehose stream.</p>
|
|
4346
4812
|
* @public
|
|
4347
4813
|
*/
|
|
4348
4814
|
export interface _Record {
|
|
@@ -4358,7 +4824,7 @@ export interface _Record {
|
|
|
4358
4824
|
*/
|
|
4359
4825
|
export interface PutRecordInput {
|
|
4360
4826
|
/**
|
|
4361
|
-
* <p>The name of the
|
|
4827
|
+
* <p>The name of the Firehose stream.</p>
|
|
4362
4828
|
* @public
|
|
4363
4829
|
*/
|
|
4364
4830
|
DeliveryStreamName: string | undefined;
|
|
@@ -4385,7 +4851,7 @@ export interface PutRecordOutput {
|
|
|
4385
4851
|
}
|
|
4386
4852
|
/**
|
|
4387
4853
|
* <p>The service is unavailable. Back off and retry the operation. If you continue to see
|
|
4388
|
-
* the exception, throughput limits for the
|
|
4854
|
+
* the exception, throughput limits for the Firehose stream may have been exceeded. For more
|
|
4389
4855
|
* information about limits and how to request an increase, see <a href="https://docs.aws.amazon.com/firehose/latest/dev/limits.html">Amazon Firehose
|
|
4390
4856
|
* Limits</a>.</p>
|
|
4391
4857
|
* @public
|
|
@@ -4403,7 +4869,7 @@ export declare class ServiceUnavailableException extends __BaseException {
|
|
|
4403
4869
|
*/
|
|
4404
4870
|
export interface PutRecordBatchInput {
|
|
4405
4871
|
/**
|
|
4406
|
-
* <p>The name of the
|
|
4872
|
+
* <p>The name of the Firehose stream.</p>
|
|
4407
4873
|
* @public
|
|
4408
4874
|
*/
|
|
4409
4875
|
DeliveryStreamName: string | undefined;
|
|
@@ -4415,8 +4881,8 @@ export interface PutRecordBatchInput {
|
|
|
4415
4881
|
}
|
|
4416
4882
|
/**
|
|
4417
4883
|
* <p>Contains the result for an individual record from a <a>PutRecordBatch</a>
|
|
4418
|
-
* request. If the record is successfully added to your
|
|
4419
|
-
* ID. If the record fails to be added to your
|
|
4884
|
+
* request. If the record is successfully added to your Firehose stream, it receives a record
|
|
4885
|
+
* ID. If the record fails to be added to your Firehose stream, the result includes an error
|
|
4420
4886
|
* code and an error message.</p>
|
|
4421
4887
|
* @public
|
|
4422
4888
|
*/
|
|
@@ -4466,7 +4932,7 @@ export interface PutRecordBatchOutput {
|
|
|
4466
4932
|
*/
|
|
4467
4933
|
export interface StartDeliveryStreamEncryptionInput {
|
|
4468
4934
|
/**
|
|
4469
|
-
* <p>The name of the
|
|
4935
|
+
* <p>The name of the Firehose stream for which you want to enable server-side encryption
|
|
4470
4936
|
* (SSE).</p>
|
|
4471
4937
|
* @public
|
|
4472
4938
|
*/
|
|
@@ -4488,7 +4954,7 @@ export interface StartDeliveryStreamEncryptionOutput {
|
|
|
4488
4954
|
*/
|
|
4489
4955
|
export interface StopDeliveryStreamEncryptionInput {
|
|
4490
4956
|
/**
|
|
4491
|
-
* <p>The name of the
|
|
4957
|
+
* <p>The name of the Firehose stream for which you want to disable server-side encryption
|
|
4492
4958
|
* (SSE).</p>
|
|
4493
4959
|
* @public
|
|
4494
4960
|
*/
|
|
@@ -4504,7 +4970,7 @@ export interface StopDeliveryStreamEncryptionOutput {
|
|
|
4504
4970
|
*/
|
|
4505
4971
|
export interface TagDeliveryStreamInput {
|
|
4506
4972
|
/**
|
|
4507
|
-
* <p>The name of the
|
|
4973
|
+
* <p>The name of the Firehose stream to which you want to add the tags.</p>
|
|
4508
4974
|
* @public
|
|
4509
4975
|
*/
|
|
4510
4976
|
DeliveryStreamName: string | undefined;
|
|
@@ -4524,7 +4990,7 @@ export interface TagDeliveryStreamOutput {
|
|
|
4524
4990
|
*/
|
|
4525
4991
|
export interface UntagDeliveryStreamInput {
|
|
4526
4992
|
/**
|
|
4527
|
-
* <p>The name of the
|
|
4993
|
+
* <p>The name of the Firehose stream.</p>
|
|
4528
4994
|
* @public
|
|
4529
4995
|
*/
|
|
4530
4996
|
DeliveryStreamName: string | undefined;
|
|
@@ -4560,7 +5026,7 @@ export interface HttpEndpointDestinationUpdate {
|
|
|
4560
5026
|
*/
|
|
4561
5027
|
BufferingHints?: HttpEndpointBufferingHints;
|
|
4562
5028
|
/**
|
|
4563
|
-
* <p>Describes the Amazon CloudWatch logging options for your
|
|
5029
|
+
* <p>Describes the Amazon CloudWatch logging options for your Firehose stream.</p>
|
|
4564
5030
|
* @public
|
|
4565
5031
|
*/
|
|
4566
5032
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
|
@@ -4613,17 +5079,29 @@ export interface HttpEndpointDestinationUpdate {
|
|
|
4613
5079
|
* <p>
|
|
4614
5080
|
* Describes an update for a destination in Apache Iceberg Tables.
|
|
4615
5081
|
* </p>
|
|
4616
|
-
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
4617
5082
|
* @public
|
|
4618
5083
|
*/
|
|
4619
5084
|
export interface IcebergDestinationUpdate {
|
|
4620
5085
|
/**
|
|
4621
5086
|
* <p> Provides a list of <code>DestinationTableConfigurations</code> which Firehose uses
|
|
4622
|
-
* to deliver data to Apache Iceberg
|
|
4623
|
-
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
5087
|
+
* to deliver data to Apache Iceberg Tables. Firehose will write data with insert if table specific configuration is not provided here.</p>
|
|
4624
5088
|
* @public
|
|
4625
5089
|
*/
|
|
4626
5090
|
DestinationTableConfigurationList?: DestinationTableConfiguration[];
|
|
5091
|
+
/**
|
|
5092
|
+
* <p>
|
|
5093
|
+
* </p>
|
|
5094
|
+
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
5095
|
+
* @public
|
|
5096
|
+
*/
|
|
5097
|
+
SchemaEvolutionConfiguration?: SchemaEvolutionConfiguration;
|
|
5098
|
+
/**
|
|
5099
|
+
* <p>
|
|
5100
|
+
* </p>
|
|
5101
|
+
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
5102
|
+
* @public
|
|
5103
|
+
*/
|
|
5104
|
+
TableCreationConfiguration?: TableCreationConfiguration;
|
|
4627
5105
|
/**
|
|
4628
5106
|
* <p>Describes hints for the buffering to perform before delivering data to the
|
|
4629
5107
|
* destination. These options are treated as hints, and therefore Firehose might
|
|
@@ -4634,7 +5112,7 @@ export interface IcebergDestinationUpdate {
|
|
|
4634
5112
|
*/
|
|
4635
5113
|
BufferingHints?: BufferingHints;
|
|
4636
5114
|
/**
|
|
4637
|
-
* <p>Describes the Amazon CloudWatch logging options for your
|
|
5115
|
+
* <p>Describes the Amazon CloudWatch logging options for your Firehose stream.</p>
|
|
4638
5116
|
* @public
|
|
4639
5117
|
*/
|
|
4640
5118
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
|
@@ -4645,22 +5123,19 @@ export interface IcebergDestinationUpdate {
|
|
|
4645
5123
|
ProcessingConfiguration?: ProcessingConfiguration;
|
|
4646
5124
|
/**
|
|
4647
5125
|
* <p> Describes how Firehose will backup records. Currently,Firehose only supports
|
|
4648
|
-
* <code>FailedDataOnly</code
|
|
4649
|
-
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
5126
|
+
* <code>FailedDataOnly</code>. </p>
|
|
4650
5127
|
* @public
|
|
4651
5128
|
*/
|
|
4652
5129
|
S3BackupMode?: IcebergS3BackupMode;
|
|
4653
5130
|
/**
|
|
4654
|
-
* <p> The retry behavior in case Firehose is unable to deliver data to
|
|
4655
|
-
* S3 prefix.</p>
|
|
5131
|
+
* <p> The retry behavior in case Firehose is unable to deliver data to a destination.</p>
|
|
4656
5132
|
* @public
|
|
4657
5133
|
*/
|
|
4658
5134
|
RetryOptions?: RetryOptions;
|
|
4659
5135
|
/**
|
|
4660
5136
|
* <p>
|
|
4661
|
-
* The Amazon Resource Name (ARN) of the Apache Iceberg Tables
|
|
5137
|
+
* The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling Apache Iceberg Tables.
|
|
4662
5138
|
* </p>
|
|
4663
|
-
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
4664
5139
|
* @public
|
|
4665
5140
|
*/
|
|
4666
5141
|
RoleARN?: string;
|
|
@@ -4668,7 +5143,6 @@ export interface IcebergDestinationUpdate {
|
|
|
4668
5143
|
* <p>
|
|
4669
5144
|
* Configuration describing where the destination Iceberg tables are persisted.
|
|
4670
5145
|
* </p>
|
|
4671
|
-
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
4672
5146
|
* @public
|
|
4673
5147
|
*/
|
|
4674
5148
|
CatalogConfiguration?: CatalogConfiguration;
|
|
@@ -4731,8 +5205,8 @@ export interface RedshiftDestinationUpdate {
|
|
|
4731
5205
|
*/
|
|
4732
5206
|
ProcessingConfiguration?: ProcessingConfiguration;
|
|
4733
5207
|
/**
|
|
4734
|
-
* <p>You can update a
|
|
4735
|
-
* backup is enabled, you can't update the
|
|
5208
|
+
* <p>You can update a Firehose stream to enable Amazon S3 backup if it is disabled. If
|
|
5209
|
+
* backup is enabled, you can't update the Firehose stream to disable it. </p>
|
|
4736
5210
|
* @public
|
|
4737
5211
|
*/
|
|
4738
5212
|
S3BackupMode?: RedshiftS3BackupMode;
|
|
@@ -4742,7 +5216,7 @@ export interface RedshiftDestinationUpdate {
|
|
|
4742
5216
|
*/
|
|
4743
5217
|
S3BackupUpdate?: S3DestinationUpdate;
|
|
4744
5218
|
/**
|
|
4745
|
-
* <p>The Amazon CloudWatch logging options for your
|
|
5219
|
+
* <p>The Amazon CloudWatch logging options for your Firehose stream.</p>
|
|
4746
5220
|
* @public
|
|
4747
5221
|
*/
|
|
4748
5222
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
|
@@ -4816,7 +5290,7 @@ export interface SnowflakeDestinationUpdate {
|
|
|
4816
5290
|
*/
|
|
4817
5291
|
ContentColumnName?: string;
|
|
4818
5292
|
/**
|
|
4819
|
-
* <p>Describes the Amazon CloudWatch logging options for your
|
|
5293
|
+
* <p>Describes the Amazon CloudWatch logging options for your Firehose stream.</p>
|
|
4820
5294
|
* @public
|
|
4821
5295
|
*/
|
|
4822
5296
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
|
@@ -4844,7 +5318,8 @@ export interface SnowflakeDestinationUpdate {
|
|
|
4844
5318
|
*/
|
|
4845
5319
|
RetryOptions?: SnowflakeRetryOptions;
|
|
4846
5320
|
/**
|
|
4847
|
-
* <p>Choose an S3 backup mode</
|
|
5321
|
+
* <p>Choose an S3 backup mode. Once you set the mode as <code>AllData</code>, you can not
|
|
5322
|
+
* change it to <code>FailedDataOnly</code>.</p>
|
|
4848
5323
|
* @public
|
|
4849
5324
|
*/
|
|
4850
5325
|
S3BackupMode?: SnowflakeS3BackupMode;
|
|
@@ -4927,7 +5402,7 @@ export interface SplunkDestinationUpdate {
|
|
|
4927
5402
|
*/
|
|
4928
5403
|
ProcessingConfiguration?: ProcessingConfiguration;
|
|
4929
5404
|
/**
|
|
4930
|
-
* <p>The Amazon CloudWatch logging options for your
|
|
5405
|
+
* <p>The Amazon CloudWatch logging options for your Firehose stream.</p>
|
|
4931
5406
|
* @public
|
|
4932
5407
|
*/
|
|
4933
5408
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
|
@@ -4949,7 +5424,7 @@ export interface SplunkDestinationUpdate {
|
|
|
4949
5424
|
*/
|
|
4950
5425
|
export interface UpdateDestinationInput {
|
|
4951
5426
|
/**
|
|
4952
|
-
* <p>The name of the
|
|
5427
|
+
* <p>The name of the Firehose stream.</p>
|
|
4953
5428
|
* @public
|
|
4954
5429
|
*/
|
|
4955
5430
|
DeliveryStreamName: string | undefined;
|
|
@@ -5019,7 +5494,6 @@ export interface UpdateDestinationInput {
|
|
|
5019
5494
|
* <p>
|
|
5020
5495
|
* Describes an update for a destination in Apache Iceberg Tables.
|
|
5021
5496
|
* </p>
|
|
5022
|
-
* <p>Amazon Data Firehose is in preview release and is subject to change.</p>
|
|
5023
5497
|
* @public
|
|
5024
5498
|
*/
|
|
5025
5499
|
IcebergDestinationUpdate?: IcebergDestinationUpdate;
|