fix(iot): FirehoseStreamAction is now called `FirehosePutRecordActi…

…on` (#18356) By #18321 (comment) BREAKING CHANGE: the class `FirehoseStreamAction` has been renamed to `FirehosePutRecordAction` ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
aws · Jan 11, 2022 · c016a9f · c016a9f
1 parent ee95905
commit c016a9f
Show file tree

Hide file tree

Showing 6 changed files with 14 additions and 15 deletions.
diff --git a/packages/@aws-cdk/aws-iot-actions/README.md b/packages/@aws-cdk/aws-iot-actions/README.md
@@ -189,9 +189,9 @@ const stream = new firehose.DeliveryStream(this, 'MyStream', {
 const topicRule = new iot.TopicRule(this, 'TopicRule', {
   sql: iot.IotSql.fromStringAsVer20160323("SELECT * FROM 'device/+/data'"),
   actions: [
-    new actions.FirehoseStreamAction(stream, {
+    new actions.FirehosePutRecordAction(stream, {
       batchMode: true,
-      recordSeparator: actions.FirehoseStreamRecordSeparator.NEWLINE,
+      recordSeparator: actions.FirehoseRecordSeparator.NEWLINE,
     }),
   ],
 });

diff --git a/...iot-actions/lib/firehose-stream-action.ts → ...actions/lib/firehose-put-record-action.ts b/...iot-actions/lib/firehose-stream-action.ts → ...actions/lib/firehose-put-record-action.ts
@@ -7,7 +7,7 @@ import { singletonActionRole } from './private/role';
 /**
  * Record Separator to be used to separate records.
  */
-export enum FirehoseStreamRecordSeparator {
+export enum FirehoseRecordSeparator {
   /**
    * Separate by a new line
    */
@@ -32,7 +32,7 @@ export enum FirehoseStreamRecordSeparator {
 /**
  * Configuration properties of an action for the Kinesis Data Firehose stream.
  */
-export interface FirehoseStreamActionProps extends CommonActionProps {
+export interface FirehosePutRecordActionProps extends CommonActionProps {
   /**
    * Whether to deliver the Kinesis Data Firehose stream as a batch by using `PutRecordBatch`.
    * When batchMode is true and the rule's SQL statement evaluates to an Array, each Array
@@ -48,14 +48,14 @@ export interface FirehoseStreamActionProps extends CommonActionProps {
    *
    * @default - none -- the stream does not use a separator
    */
-  readonly recordSeparator?: FirehoseStreamRecordSeparator;
+  readonly recordSeparator?: FirehoseRecordSeparator;
 }
 
 
 /**
  * The action to put the record from an MQTT message to the Kinesis Data Firehose stream.
  */
-export class FirehoseStreamAction implements iot.IAction {
+export class FirehosePutRecordAction implements iot.IAction {
   private readonly batchMode?: boolean;
   private readonly recordSeparator?: string;
   private readonly role?: iam.IRole;
@@ -64,7 +64,7 @@ export class FirehoseStreamAction implements iot.IAction {
    * @param stream The Kinesis Data Firehose stream to which to put records.
    * @param props Optional properties to not use default
    */
-  constructor(private readonly stream: firehose.IDeliveryStream, props: FirehoseStreamActionProps = {}) {
+  constructor(private readonly stream: firehose.IDeliveryStream, props: FirehosePutRecordActionProps = {}) {
     this.batchMode = props.batchMode;
     this.recordSeparator = props.recordSeparator;
     this.role = props.role;

diff --git a/packages/@aws-cdk/aws-iot-actions/lib/index.ts b/packages/@aws-cdk/aws-iot-actions/lib/index.ts
@@ -2,8 +2,7 @@ export * from './cloudwatch-logs-action';
 export * from './cloudwatch-put-metric-action';
 export * from './cloudwatch-set-alarm-state-action';
 export * from './common-action-props';
-export * from './firehose-stream-action';
+export * from './firehose-put-record-action';
 export * from './lambda-function-action';
 export * from './s3-put-object-action';
 export * from './sqs-queue-action';
-
diff --git a/...s-firehose/firehose-stream-action.test.ts → ...rehose/firehose-put-record-action.test.ts b/...s-firehose/firehose-stream-action.test.ts → ...rehose/firehose-put-record-action.test.ts
@@ -15,7 +15,7 @@ test('Default firehose stream action', () => {
 
   // WHEN
   topicRule.addAction(
-    new actions.FirehoseStreamAction(stream),
+    new actions.FirehosePutRecordAction(stream),
   );
 
   // THEN
@@ -77,7 +77,7 @@ test('can set batchMode', () => {
 
   // WHEN
   topicRule.addAction(
-    new actions.FirehoseStreamAction(stream, { batchMode: true }),
+    new actions.FirehosePutRecordAction(stream, { batchMode: true }),
   );
 
   // THEN
@@ -100,7 +100,7 @@ test('can set separotor', () => {
 
   // WHEN
   topicRule.addAction(
-    new actions.FirehoseStreamAction(stream, { recordSeparator: actions.FirehoseStreamRecordSeparator.NEWLINE }),
+    new actions.FirehosePutRecordAction(stream, { recordSeparator: actions.FirehoseRecordSeparator.NEWLINE }),
   );
 
   // THEN
@@ -124,7 +124,7 @@ test('can set role', () => {
 
   // WHEN
   topicRule.addAction(
-    new actions.FirehoseStreamAction(stream, { role }),
+    new actions.FirehosePutRecordAction(stream, { role }),
   );
 
   // THEN

diff --git a/...nteg.firehose-stream-action.expected.json → ....firehose-put-record-action.expected.json b/...nteg.firehose-stream-action.expected.json → ....firehose-put-record-action.expected.json
diff --git a/...-firehose/integ.firehose-stream-action.ts → ...ehose/integ.firehose-put-record-action.ts b/...-firehose/integ.firehose-stream-action.ts → ...ehose/integ.firehose-put-record-action.ts
@@ -25,9 +25,9 @@ class TestStack extends cdk.Stack {
       destinations: [new destinations.S3Bucket(bucket)],
     });
     topicRule.addAction(
-      new actions.FirehoseStreamAction(stream, {
+      new actions.FirehosePutRecordAction(stream, {
         batchMode: true,
-        recordSeparator: actions.FirehoseStreamRecordSeparator.NEWLINE,
+        recordSeparator: actions.FirehoseRecordSeparator.NEWLINE,
       }),
     );
   }