feat(client-firehose): Adds integration with Secrets Manager for Reds…

…hift, Splunk, HttpEndpoint, and Snowflake destinations
aws · Jun 6, 2024 · ae7c3b0 · ae7c3b0
1 parent 8c1f604
commit ae7c3b0
Show file tree

Hide file tree

Showing 11 changed files with 341 additions and 49 deletions.
diff --git a/clients/client-firehose/README.md b/clients/client-firehose/README.md
@@ -11,10 +11,9 @@ AWS SDK for JavaScript Firehose Client for Node.js, Browser and React Native.
 
 <p>Amazon Data Firehose was previously known as Amazon Kinesis Data Firehose.</p>
 </note>
-<p>Amazon Data Firehose is a fully managed service that delivers real-time
-streaming data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon
-OpenSearch Service, Amazon Redshift, Splunk, and various other supportd
-destinations.</p>
+<p>Amazon Data Firehose is a fully managed service that delivers real-time streaming
+data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon OpenSearch
+Service, Amazon Redshift, Splunk, and various other supported destinations.</p>
 
 ## Installing
 

diff --git a/clients/client-firehose/src/Firehose.ts b/clients/client-firehose/src/Firehose.ts
@@ -278,10 +278,9 @@ export interface Firehose {
  *          <note>
  *             <p>Amazon Data Firehose was previously known as Amazon Kinesis Data Firehose.</p>
  *          </note>
- *          <p>Amazon Data Firehose is a fully managed service that delivers real-time
- *          streaming data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon
- *          OpenSearch Service, Amazon Redshift, Splunk, and various other supportd
- *          destinations.</p>
+ *          <p>Amazon Data Firehose is a fully managed service that delivers real-time streaming
+ *          data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon OpenSearch
+ *          Service, Amazon Redshift, Splunk, and various other supported destinations.</p>
  * @public
  */
 export class Firehose extends FirehoseClient implements Firehose {}

diff --git a/clients/client-firehose/src/FirehoseClient.ts b/clients/client-firehose/src/FirehoseClient.ts
@@ -310,10 +310,9 @@ export interface FirehoseClientResolvedConfig extends FirehoseClientResolvedConf
  *          <note>
  *             <p>Amazon Data Firehose was previously known as Amazon Kinesis Data Firehose.</p>
  *          </note>
- *          <p>Amazon Data Firehose is a fully managed service that delivers real-time
- *          streaming data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon
- *          OpenSearch Service, Amazon Redshift, Splunk, and various other supportd
- *          destinations.</p>
+ *          <p>Amazon Data Firehose is a fully managed service that delivers real-time streaming
+ *          data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon OpenSearch
+ *          Service, Amazon Redshift, Splunk, and various other supported destinations.</p>
  * @public
  */
 export class FirehoseClient extends __Client<

diff --git a/clients/client-firehose/src/commands/CreateDeliveryStreamCommand.ts b/clients/client-firehose/src/commands/CreateDeliveryStreamCommand.ts
@@ -266,8 +266,8 @@ export interface CreateDeliveryStreamCommandOutput extends CreateDeliveryStreamO
  *       DataTableColumns: "STRING_VALUE",
  *       CopyOptions: "STRING_VALUE",
  *     },
- *     Username: "STRING_VALUE", // required
- *     Password: "STRING_VALUE", // required
+ *     Username: "STRING_VALUE",
+ *     Password: "STRING_VALUE",
  *     RetryOptions: { // RedshiftRetryOptions
  *       DurationInSeconds: Number("int"),
  *     },
@@ -331,6 +331,11 @@ export interface CreateDeliveryStreamCommandOutput extends CreateDeliveryStreamO
  *       },
  *     },
  *     CloudWatchLoggingOptions: "<CloudWatchLoggingOptions>",
+ *     SecretsManagerConfiguration: { // SecretsManagerConfiguration
+ *       SecretARN: "STRING_VALUE",
+ *       RoleARN: "STRING_VALUE",
+ *       Enabled: true || false, // required
+ *     },
  *   },
  *   ElasticsearchDestinationConfiguration: { // ElasticsearchDestinationConfiguration
  *     RoleARN: "STRING_VALUE", // required
@@ -432,7 +437,7 @@ export interface CreateDeliveryStreamCommandOutput extends CreateDeliveryStreamO
  *   SplunkDestinationConfiguration: { // SplunkDestinationConfiguration
  *     HECEndpoint: "STRING_VALUE", // required
  *     HECEndpointType: "Raw" || "Event", // required
- *     HECToken: "STRING_VALUE", // required
+ *     HECToken: "STRING_VALUE",
  *     HECAcknowledgmentTimeoutInSeconds: Number("int"),
  *     RetryOptions: { // SplunkRetryOptions
  *       DurationInSeconds: Number("int"),
@@ -458,6 +463,11 @@ export interface CreateDeliveryStreamCommandOutput extends CreateDeliveryStreamO
  *       IntervalInSeconds: Number("int"),
  *       SizeInMBs: Number("int"),
  *     },
+ *     SecretsManagerConfiguration: {
+ *       SecretARN: "STRING_VALUE",
+ *       RoleARN: "STRING_VALUE",
+ *       Enabled: true || false, // required
+ *     },
  *   },
  *   HttpEndpointDestinationConfiguration: { // HttpEndpointDestinationConfiguration
  *     EndpointConfiguration: { // HttpEndpointConfiguration
@@ -486,6 +496,11 @@ export interface CreateDeliveryStreamCommandOutput extends CreateDeliveryStreamO
  *     },
  *     S3BackupMode: "FailedDataOnly" || "AllData",
  *     S3Configuration: "<S3DestinationConfiguration>", // required
+ *     SecretsManagerConfiguration: {
+ *       SecretARN: "STRING_VALUE",
+ *       RoleARN: "STRING_VALUE",
+ *       Enabled: true || false, // required
+ *     },
  *   },
  *   Tags: [ // TagDeliveryStreamInputTagList
  *     { // Tag
@@ -528,9 +543,9 @@ export interface CreateDeliveryStreamCommandOutput extends CreateDeliveryStreamO
  *   },
  *   SnowflakeDestinationConfiguration: { // SnowflakeDestinationConfiguration
  *     AccountUrl: "STRING_VALUE", // required
- *     PrivateKey: "STRING_VALUE", // required
+ *     PrivateKey: "STRING_VALUE",
  *     KeyPassphrase: "STRING_VALUE",
- *     User: "STRING_VALUE", // required
+ *     User: "STRING_VALUE",
  *     Database: "STRING_VALUE", // required
  *     Schema: "STRING_VALUE", // required
  *     Table: "STRING_VALUE", // required
@@ -552,6 +567,11 @@ export interface CreateDeliveryStreamCommandOutput extends CreateDeliveryStreamO
  *     },
  *     S3BackupMode: "FailedDataOnly" || "AllData",
  *     S3Configuration: "<S3DestinationConfiguration>", // required
+ *     SecretsManagerConfiguration: {
+ *       SecretARN: "STRING_VALUE",
+ *       RoleARN: "STRING_VALUE",
+ *       Enabled: true || false, // required
+ *     },
  *   },
  * };
  * const command = new CreateDeliveryStreamCommand(input);

diff --git a/clients/client-firehose/src/commands/DescribeDeliveryStreamCommand.ts b/clients/client-firehose/src/commands/DescribeDeliveryStreamCommand.ts
@@ -243,7 +243,7 @@ export interface DescribeDeliveryStreamCommandOutput extends DescribeDeliveryStr
  * //             DataTableColumns: "STRING_VALUE",
  * //             CopyOptions: "STRING_VALUE",
  * //           },
- * //           Username: "STRING_VALUE", // required
+ * //           Username: "STRING_VALUE",
  * //           RetryOptions: { // RedshiftRetryOptions
  * //             DurationInSeconds: Number("int"),
  * //           },
@@ -307,6 +307,11 @@ export interface DescribeDeliveryStreamCommandOutput extends DescribeDeliveryStr
  * //             },
  * //           },
  * //           CloudWatchLoggingOptions: "<CloudWatchLoggingOptions>",
+ * //           SecretsManagerConfiguration: { // SecretsManagerConfiguration
+ * //             SecretARN: "STRING_VALUE",
+ * //             RoleARN: "STRING_VALUE",
+ * //             Enabled: true || false, // required
+ * //           },
  * //         },
  * //         ElasticsearchDestinationDescription: { // ElasticsearchDestinationDescription
  * //           RoleARN: "STRING_VALUE",
@@ -436,6 +441,11 @@ export interface DescribeDeliveryStreamCommandOutput extends DescribeDeliveryStr
  * //             IntervalInSeconds: Number("int"),
  * //             SizeInMBs: Number("int"),
  * //           },
+ * //           SecretsManagerConfiguration: {
+ * //             SecretARN: "STRING_VALUE",
+ * //             RoleARN: "STRING_VALUE",
+ * //             Enabled: true || false, // required
+ * //           },
  * //         },
  * //         HttpEndpointDestinationDescription: { // HttpEndpointDestinationDescription
  * //           EndpointConfiguration: { // HttpEndpointDescription
@@ -463,6 +473,11 @@ export interface DescribeDeliveryStreamCommandOutput extends DescribeDeliveryStr
  * //           },
  * //           S3BackupMode: "FailedDataOnly" || "AllData",
  * //           S3DestinationDescription: "<S3DestinationDescription>",
+ * //           SecretsManagerConfiguration: {
+ * //             SecretARN: "STRING_VALUE",
+ * //             RoleARN: "STRING_VALUE",
+ * //             Enabled: true || false, // required
+ * //           },
  * //         },
  * //         SnowflakeDestinationDescription: { // SnowflakeDestinationDescription
  * //           AccountUrl: "STRING_VALUE",
@@ -488,6 +503,11 @@ export interface DescribeDeliveryStreamCommandOutput extends DescribeDeliveryStr
  * //           },
  * //           S3BackupMode: "FailedDataOnly" || "AllData",
  * //           S3DestinationDescription: "<S3DestinationDescription>",
+ * //           SecretsManagerConfiguration: {
+ * //             SecretARN: "STRING_VALUE",
+ * //             RoleARN: "STRING_VALUE",
+ * //             Enabled: true || false, // required
+ * //           },
  * //         },
  * //         AmazonOpenSearchServerlessDestinationDescription: { // AmazonOpenSearchServerlessDestinationDescription
  * //           RoleARN: "STRING_VALUE",

diff --git a/clients/client-firehose/src/commands/StartDeliveryStreamEncryptionCommand.ts b/clients/client-firehose/src/commands/StartDeliveryStreamEncryptionCommand.ts
@@ -52,7 +52,9 @@ export interface StartDeliveryStreamEncryptionCommandOutput
  *          CMK is of type <code>CUSTOMER_MANAGED_CMK</code>, Firehose creates a grant
  *          that enables it to use the new CMK to encrypt and decrypt data and to manage the
  *          grant.</p>
- *          <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>
+ *          <p>For the KMS grant creation to be successful, the Firehose API operations
+ *             <code>StartDeliveryStreamEncryption</code> and <code>CreateDeliveryStream</code> should
+ *          not be called with session credentials that are more than 6 hours old.</p>
  *          <p>If a delivery stream already has encryption enabled and then you invoke this operation
  *          to change the ARN of the CMK or both its type and ARN and you get
  *             <code>ENABLING_FAILED</code>, this only means that the attempt to change the CMK failed.

diff --git a/clients/client-firehose/src/commands/UpdateDestinationCommand.ts b/clients/client-firehose/src/commands/UpdateDestinationCommand.ts
@@ -280,6 +280,11 @@ export interface UpdateDestinationCommandOutput extends UpdateDestinationOutput,
  *       },
  *     },
  *     CloudWatchLoggingOptions: "<CloudWatchLoggingOptions>",
+ *     SecretsManagerConfiguration: { // SecretsManagerConfiguration
+ *       SecretARN: "STRING_VALUE",
+ *       RoleARN: "STRING_VALUE",
+ *       Enabled: true || false, // required
+ *     },
  *   },
  *   ElasticsearchDestinationUpdate: { // ElasticsearchDestinationUpdate
  *     RoleARN: "STRING_VALUE",
@@ -387,6 +392,11 @@ export interface UpdateDestinationCommandOutput extends UpdateDestinationOutput,
  *       IntervalInSeconds: Number("int"),
  *       SizeInMBs: Number("int"),
  *     },
+ *     SecretsManagerConfiguration: {
+ *       SecretARN: "STRING_VALUE",
+ *       RoleARN: "STRING_VALUE",
+ *       Enabled: true || false, // required
+ *     },
  *   },
  *   HttpEndpointDestinationUpdate: { // HttpEndpointDestinationUpdate
  *     EndpointConfiguration: { // HttpEndpointConfiguration
@@ -415,6 +425,11 @@ export interface UpdateDestinationCommandOutput extends UpdateDestinationOutput,
  *     },
  *     S3BackupMode: "FailedDataOnly" || "AllData",
  *     S3Update: "<S3DestinationUpdate>",
+ *     SecretsManagerConfiguration: {
+ *       SecretARN: "STRING_VALUE",
+ *       RoleARN: "STRING_VALUE",
+ *       Enabled: true || false, // required
+ *     },
  *   },
  *   AmazonOpenSearchServerlessDestinationUpdate: { // AmazonOpenSearchServerlessDestinationUpdate
  *     RoleARN: "STRING_VALUE",
@@ -454,6 +469,11 @@ export interface UpdateDestinationCommandOutput extends UpdateDestinationOutput,
  *     },
  *     S3BackupMode: "FailedDataOnly" || "AllData",
  *     S3Update: "<S3DestinationUpdate>",
+ *     SecretsManagerConfiguration: {
+ *       SecretARN: "STRING_VALUE",
+ *       RoleARN: "STRING_VALUE",
+ *       Enabled: true || false, // required
+ *     },
  *   },
  * };
  * const command = new UpdateDestinationCommand(input);

diff --git a/clients/client-firehose/src/index.ts b/clients/client-firehose/src/index.ts
@@ -5,10 +5,9 @@
  *          <note>
  *             <p>Amazon Data Firehose was previously known as Amazon Kinesis Data Firehose.</p>
  *          </note>
- *          <p>Amazon Data Firehose is a fully managed service that delivers real-time
- *          streaming data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon
- *          OpenSearch Service, Amazon Redshift, Splunk, and various other supportd
- *          destinations.</p>
+ *          <p>Amazon Data Firehose is a fully managed service that delivers real-time streaming
+ *          data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon OpenSearch
+ *          Service, Amazon Redshift, Splunk, and various other supported destinations.</p>
  *
  * @packageDocumentation
  */