Skip to content

Commit

Permalink
chore(iot): rename FirehoseStreamProps to FirehoseStreamActionProps (#…
Browse files Browse the repository at this point in the history
…17495)

An action item from #17466 (review).

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
  • Loading branch information
skinny85 authored Nov 15, 2021
1 parent f52d9bf commit 4cd4af8
Show file tree
Hide file tree
Showing 11 changed files with 4 additions and 6 deletions.
6 changes: 2 additions & 4 deletions packages/@aws-cdk/aws-iot-actions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,9 +136,7 @@ import * as s3 from '@aws-cdk/aws-s3';
import * as firehose from '@aws-cdk/aws-kinesisfirehose';
import * as destinations from '@aws-cdk/aws-kinesisfirehose-destinations';

const bucket = new s3.Bucket(this, 'MyBucket', {
removalPolicy: cdk.RemovalPolicy.DESTROY,
});
const bucket = new s3.Bucket(this, 'MyBucket');
const stream = new firehose.DeliveryStream(this, 'MyStream', {
destinations: [new destinations.S3Bucket(bucket)],
});
Expand All @@ -149,7 +147,7 @@ const topicRule = new iot.TopicRule(this, 'TopicRule', {
new actions.FirehoseStreamAction(stream, {
batchMode: true,
recordSeparator: actions.FirehoseStreamRecordSeparator.NEWLINE,
})
}),
],
});
```
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ export enum FirehoseStreamRecordSeparator {
/**
* Configuration properties of an action for the Kinesis Data Firehose stream.
*/
export interface FirehoseStreamProps extends CommonActionProps {
export interface FirehoseStreamActionProps 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
Expand Down Expand Up @@ -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: FirehoseStreamProps = {}) {
constructor(private readonly stream: firehose.IDeliveryStream, props: FirehoseStreamActionProps = {}) {
this.batchMode = props.batchMode;
this.recordSeparator = props.recordSeparator;
this.role = props.role;
Expand Down

0 comments on commit 4cd4af8

Please sign in to comment.