Skip to content

Commit ae7c3b0

Browse files
author
awstools
committed
feat(client-firehose): Adds integration with Secrets Manager for Redshift, Splunk, HttpEndpoint, and Snowflake destinations
1 parent 8c1f604 commit ae7c3b0

File tree

11 files changed

+341
-49
lines changed

11 files changed

+341
-49
lines changed

‎clients/client-firehose/README.md‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,9 @@ AWS SDK for JavaScript Firehose Client for Node.js, Browser and React Native.
1111

1212
<p>Amazon Data Firehose was previously known as Amazon Kinesis Data Firehose.</p>
1313
</note>
14-
<p>Amazon Data Firehose is a fully managed service that delivers real-time
15-
streaming data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon
16-
OpenSearch Service, Amazon Redshift, Splunk, and various other supportd
17-
destinations.</p>
14+
<p>Amazon Data Firehose is a fully managed service that delivers real-time streaming
15+
data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon OpenSearch
16+
Service, Amazon Redshift, Splunk, and various other supported destinations.</p>
1817

1918
## Installing
2019

‎clients/client-firehose/src/Firehose.ts‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -278,10 +278,9 @@ export interface Firehose {
278278
* <note>
279279
* <p>Amazon Data Firehose was previously known as Amazon Kinesis Data Firehose.</p>
280280
* </note>
281-
* <p>Amazon Data Firehose is a fully managed service that delivers real-time
282-
* streaming data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon
283-
* OpenSearch Service, Amazon Redshift, Splunk, and various other supportd
284-
* destinations.</p>
281+
* <p>Amazon Data Firehose is a fully managed service that delivers real-time streaming
282+
* data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon OpenSearch
283+
* Service, Amazon Redshift, Splunk, and various other supported destinations.</p>
285284
* @public
286285
*/
287286
export class Firehose extends FirehoseClient implements Firehose {}

‎clients/client-firehose/src/FirehoseClient.ts‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -310,10 +310,9 @@ export interface FirehoseClientResolvedConfig extends FirehoseClientResolvedConf
310310
* <note>
311311
* <p>Amazon Data Firehose was previously known as Amazon Kinesis Data Firehose.</p>
312312
* </note>
313-
* <p>Amazon Data Firehose is a fully managed service that delivers real-time
314-
* streaming data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon
315-
* OpenSearch Service, Amazon Redshift, Splunk, and various other supportd
316-
* destinations.</p>
313+
* <p>Amazon Data Firehose is a fully managed service that delivers real-time streaming
314+
* data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon OpenSearch
315+
* Service, Amazon Redshift, Splunk, and various other supported destinations.</p>
317316
* @public
318317
*/
319318
export class FirehoseClient extends __Client<

‎clients/client-firehose/src/commands/CreateDeliveryStreamCommand.ts‎

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -266,8 +266,8 @@ export interface CreateDeliveryStreamCommandOutput extends CreateDeliveryStreamO
266266
* DataTableColumns: "STRING_VALUE",
267267
* CopyOptions: "STRING_VALUE",
268268
* },
269-
* Username: "STRING_VALUE", // required
270-
* Password: "STRING_VALUE", // required
269+
* Username: "STRING_VALUE",
270+
* Password: "STRING_VALUE",
271271
* RetryOptions: { // RedshiftRetryOptions
272272
* DurationInSeconds: Number("int"),
273273
* },
@@ -331,6 +331,11 @@ export interface CreateDeliveryStreamCommandOutput extends CreateDeliveryStreamO
331331
* },
332332
* },
333333
* CloudWatchLoggingOptions: "<CloudWatchLoggingOptions>",
334+
* SecretsManagerConfiguration: { // SecretsManagerConfiguration
335+
* SecretARN: "STRING_VALUE",
336+
* RoleARN: "STRING_VALUE",
337+
* Enabled: true || false, // required
338+
* },
334339
* },
335340
* ElasticsearchDestinationConfiguration: { // ElasticsearchDestinationConfiguration
336341
* RoleARN: "STRING_VALUE", // required
@@ -432,7 +437,7 @@ export interface CreateDeliveryStreamCommandOutput extends CreateDeliveryStreamO
432437
* SplunkDestinationConfiguration: { // SplunkDestinationConfiguration
433438
* HECEndpoint: "STRING_VALUE", // required
434439
* HECEndpointType: "Raw" || "Event", // required
435-
* HECToken: "STRING_VALUE", // required
440+
* HECToken: "STRING_VALUE",
436441
* HECAcknowledgmentTimeoutInSeconds: Number("int"),
437442
* RetryOptions: { // SplunkRetryOptions
438443
* DurationInSeconds: Number("int"),
@@ -458,6 +463,11 @@ export interface CreateDeliveryStreamCommandOutput extends CreateDeliveryStreamO
458463
* IntervalInSeconds: Number("int"),
459464
* SizeInMBs: Number("int"),
460465
* },
466+
* SecretsManagerConfiguration: {
467+
* SecretARN: "STRING_VALUE",
468+
* RoleARN: "STRING_VALUE",
469+
* Enabled: true || false, // required
470+
* },
461471
* },
462472
* HttpEndpointDestinationConfiguration: { // HttpEndpointDestinationConfiguration
463473
* EndpointConfiguration: { // HttpEndpointConfiguration
@@ -486,6 +496,11 @@ export interface CreateDeliveryStreamCommandOutput extends CreateDeliveryStreamO
486496
* },
487497
* S3BackupMode: "FailedDataOnly" || "AllData",
488498
* S3Configuration: "<S3DestinationConfiguration>", // required
499+
* SecretsManagerConfiguration: {
500+
* SecretARN: "STRING_VALUE",
501+
* RoleARN: "STRING_VALUE",
502+
* Enabled: true || false, // required
503+
* },
489504
* },
490505
* Tags: [ // TagDeliveryStreamInputTagList
491506
* { // Tag
@@ -528,9 +543,9 @@ export interface CreateDeliveryStreamCommandOutput extends CreateDeliveryStreamO
528543
* },
529544
* SnowflakeDestinationConfiguration: { // SnowflakeDestinationConfiguration
530545
* AccountUrl: "STRING_VALUE", // required
531-
* PrivateKey: "STRING_VALUE", // required
546+
* PrivateKey: "STRING_VALUE",
532547
* KeyPassphrase: "STRING_VALUE",
533-
* User: "STRING_VALUE", // required
548+
* User: "STRING_VALUE",
534549
* Database: "STRING_VALUE", // required
535550
* Schema: "STRING_VALUE", // required
536551
* Table: "STRING_VALUE", // required
@@ -552,6 +567,11 @@ export interface CreateDeliveryStreamCommandOutput extends CreateDeliveryStreamO
552567
* },
553568
* S3BackupMode: "FailedDataOnly" || "AllData",
554569
* S3Configuration: "<S3DestinationConfiguration>", // required
570+
* SecretsManagerConfiguration: {
571+
* SecretARN: "STRING_VALUE",
572+
* RoleARN: "STRING_VALUE",
573+
* Enabled: true || false, // required
574+
* },
555575
* },
556576
* };
557577
* const command = new CreateDeliveryStreamCommand(input);

‎clients/client-firehose/src/commands/DescribeDeliveryStreamCommand.ts‎

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,7 @@ export interface DescribeDeliveryStreamCommandOutput extends DescribeDeliveryStr
243243
* // DataTableColumns: "STRING_VALUE",
244244
* // CopyOptions: "STRING_VALUE",
245245
* // },
246-
* // Username: "STRING_VALUE", // required
246+
* // Username: "STRING_VALUE",
247247
* // RetryOptions: { // RedshiftRetryOptions
248248
* // DurationInSeconds: Number("int"),
249249
* // },
@@ -307,6 +307,11 @@ export interface DescribeDeliveryStreamCommandOutput extends DescribeDeliveryStr
307307
* // },
308308
* // },
309309
* // CloudWatchLoggingOptions: "<CloudWatchLoggingOptions>",
310+
* // SecretsManagerConfiguration: { // SecretsManagerConfiguration
311+
* // SecretARN: "STRING_VALUE",
312+
* // RoleARN: "STRING_VALUE",
313+
* // Enabled: true || false, // required
314+
* // },
310315
* // },
311316
* // ElasticsearchDestinationDescription: { // ElasticsearchDestinationDescription
312317
* // RoleARN: "STRING_VALUE",
@@ -436,6 +441,11 @@ export interface DescribeDeliveryStreamCommandOutput extends DescribeDeliveryStr
436441
* // IntervalInSeconds: Number("int"),
437442
* // SizeInMBs: Number("int"),
438443
* // },
444+
* // SecretsManagerConfiguration: {
445+
* // SecretARN: "STRING_VALUE",
446+
* // RoleARN: "STRING_VALUE",
447+
* // Enabled: true || false, // required
448+
* // },
439449
* // },
440450
* // HttpEndpointDestinationDescription: { // HttpEndpointDestinationDescription
441451
* // EndpointConfiguration: { // HttpEndpointDescription
@@ -463,6 +473,11 @@ export interface DescribeDeliveryStreamCommandOutput extends DescribeDeliveryStr
463473
* // },
464474
* // S3BackupMode: "FailedDataOnly" || "AllData",
465475
* // S3DestinationDescription: "<S3DestinationDescription>",
476+
* // SecretsManagerConfiguration: {
477+
* // SecretARN: "STRING_VALUE",
478+
* // RoleARN: "STRING_VALUE",
479+
* // Enabled: true || false, // required
480+
* // },
466481
* // },
467482
* // SnowflakeDestinationDescription: { // SnowflakeDestinationDescription
468483
* // AccountUrl: "STRING_VALUE",
@@ -488,6 +503,11 @@ export interface DescribeDeliveryStreamCommandOutput extends DescribeDeliveryStr
488503
* // },
489504
* // S3BackupMode: "FailedDataOnly" || "AllData",
490505
* // S3DestinationDescription: "<S3DestinationDescription>",
506+
* // SecretsManagerConfiguration: {
507+
* // SecretARN: "STRING_VALUE",
508+
* // RoleARN: "STRING_VALUE",
509+
* // Enabled: true || false, // required
510+
* // },
491511
* // },
492512
* // AmazonOpenSearchServerlessDestinationDescription: { // AmazonOpenSearchServerlessDestinationDescription
493513
* // RoleARN: "STRING_VALUE",

‎clients/client-firehose/src/commands/StartDeliveryStreamEncryptionCommand.ts‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,9 @@ export interface StartDeliveryStreamEncryptionCommandOutput
5252
* CMK is of type <code>CUSTOMER_MANAGED_CMK</code>, Firehose creates a grant
5353
* that enables it to use the new CMK to encrypt and decrypt data and to manage the
5454
* grant.</p>
55-
* <p>For the KMS grant creation to be successful, Firehose APIs <code>StartDeliveryStreamEncryption</code> and <code>CreateDeliveryStream</code> should not be called with session credentials that are more than 6 hours old.</p>
55+
* <p>For the KMS grant creation to be successful, the Firehose API operations
56+
* <code>StartDeliveryStreamEncryption</code> and <code>CreateDeliveryStream</code> should
57+
* not be called with session credentials that are more than 6 hours old.</p>
5658
* <p>If a delivery stream already has encryption enabled and then you invoke this operation
5759
* to change the ARN of the CMK or both its type and ARN and you get
5860
* <code>ENABLING_FAILED</code>, this only means that the attempt to change the CMK failed.

‎clients/client-firehose/src/commands/UpdateDestinationCommand.ts‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -280,6 +280,11 @@ export interface UpdateDestinationCommandOutput extends UpdateDestinationOutput,
280280
* },
281281
* },
282282
* CloudWatchLoggingOptions: "<CloudWatchLoggingOptions>",
283+
* SecretsManagerConfiguration: { // SecretsManagerConfiguration
284+
* SecretARN: "STRING_VALUE",
285+
* RoleARN: "STRING_VALUE",
286+
* Enabled: true || false, // required
287+
* },
283288
* },
284289
* ElasticsearchDestinationUpdate: { // ElasticsearchDestinationUpdate
285290
* RoleARN: "STRING_VALUE",
@@ -387,6 +392,11 @@ export interface UpdateDestinationCommandOutput extends UpdateDestinationOutput,
387392
* IntervalInSeconds: Number("int"),
388393
* SizeInMBs: Number("int"),
389394
* },
395+
* SecretsManagerConfiguration: {
396+
* SecretARN: "STRING_VALUE",
397+
* RoleARN: "STRING_VALUE",
398+
* Enabled: true || false, // required
399+
* },
390400
* },
391401
* HttpEndpointDestinationUpdate: { // HttpEndpointDestinationUpdate
392402
* EndpointConfiguration: { // HttpEndpointConfiguration
@@ -415,6 +425,11 @@ export interface UpdateDestinationCommandOutput extends UpdateDestinationOutput,
415425
* },
416426
* S3BackupMode: "FailedDataOnly" || "AllData",
417427
* S3Update: "<S3DestinationUpdate>",
428+
* SecretsManagerConfiguration: {
429+
* SecretARN: "STRING_VALUE",
430+
* RoleARN: "STRING_VALUE",
431+
* Enabled: true || false, // required
432+
* },
418433
* },
419434
* AmazonOpenSearchServerlessDestinationUpdate: { // AmazonOpenSearchServerlessDestinationUpdate
420435
* RoleARN: "STRING_VALUE",
@@ -454,6 +469,11 @@ export interface UpdateDestinationCommandOutput extends UpdateDestinationOutput,
454469
* },
455470
* S3BackupMode: "FailedDataOnly" || "AllData",
456471
* S3Update: "<S3DestinationUpdate>",
472+
* SecretsManagerConfiguration: {
473+
* SecretARN: "STRING_VALUE",
474+
* RoleARN: "STRING_VALUE",
475+
* Enabled: true || false, // required
476+
* },
457477
* },
458478
* };
459479
* const command = new UpdateDestinationCommand(input);

‎clients/client-firehose/src/index.ts‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,9 @@
55
* <note>
66
* <p>Amazon Data Firehose was previously known as Amazon Kinesis Data Firehose.</p>
77
* </note>
8-
* <p>Amazon Data Firehose is a fully managed service that delivers real-time
9-
* streaming data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon
10-
* OpenSearch Service, Amazon Redshift, Splunk, and various other supportd
11-
* destinations.</p>
8+
* <p>Amazon Data Firehose is a fully managed service that delivers real-time streaming
9+
* data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon OpenSearch
10+
* Service, Amazon Redshift, Splunk, and various other supported destinations.</p>
1211
*
1312
* @packageDocumentation
1413
*/

0 commit comments

Comments
 (0)