feat(iot): add Action to put record to Kinesis Data stream #18321
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| import * as iam from '@aws-cdk/aws-iam'; | ||
| import * as iot from '@aws-cdk/aws-iot'; | ||
| import * as kinesis from '@aws-cdk/aws-kinesis'; | ||
| import { CommonActionProps } from './common-action-props'; | ||
| import { singletonActionRole } from './private/role'; | ||
|
|
||
| /** | ||
| * Configuration properties of an action for the Kinesis Data stream. | ||
| */ | ||
| export interface KinesisPutRecordActionProps extends CommonActionProps { | ||
| /** | ||
| * The partition key used to determine to which shard the data is written. | ||
| * The partition key is usually composed of an expression (for example, ${topic()} or ${timestamp()}). | ||
| * For more information @see https://docs.aws.amazon.com/kinesis/latest/APIReference/API_PutRecord.html#API_PutRecord_RequestParameters | ||
yamatatsu marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| * | ||
| * @default - None | ||
|
There was a problem hiding this comment. Can you elaborate what does "None" mean here? There was a problem hiding this comment. Sorry, I tried to elaborate, but I could not😞. Proberbly, IoT Core rule is fill default value (e.g. MQTT payload JSON string or hash of it) because There was a problem hiding this comment. Did you try deploying an IoT app without this property filled? Maybe this is simply a mistake in the CloudFormation resource, and this should actually be required? There was a problem hiding this comment.
Yes I tried and the deploying secceeded. Again, I deployed, and I tested following for confirmation to be spreaded records to shards:
Results:
The IoT Core may be filling in a static There was a problem hiding this comment. OK. I think that's a good guess. Let's put that in the docs - it's certainly better than just "None", which gives you no clue what that actually means 🙂. Thanks for the detailed testing! There was a problem hiding this comment. Thank you! OK. If we beleave this guess, I think it is better that fill default value. Because in Kinesis Stream, it is pretty not helpful to not spread records by shards. I found that This is the documentation of I try to add default value There was a problem hiding this comment. I don't hate it, but I'm a little concerned that the L2 won't have all of the capabilities of the underlying service (in this case, leaving the partition key as empty). Does the Console allow you to leave it as empty, or do you have to provide a value? There was a problem hiding this comment.
It is so reasonable I think! So I will never mind to revert my commit that add default value.
The Console requre PartitionKey, but CloudFormation does not. For keeping compatibility for CloudFormation, let's not add a default value, instead add a detailed description in JSDoc and Readme? There was a problem hiding this comment. Let's do this. Make this field required, like it is in the console. But, allow specifying an empty string there ( This way, we will be close to the Console experience, while covering the entire service capabilities. What do you think about this @yamatatsu? There was a problem hiding this comment. It's good I think! 👍🏻 |
||
| */ | ||
| readonly partitionKey?: string; | ||
| } | ||
|
|
||
| /** | ||
| * The action to put the record from an MQTT message to the Kinesis Data stream. | ||
| */ | ||
| export class KinesisPutRecordAction implements iot.IAction { | ||
yamatatsu marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| private readonly partitionKey?: string; | ||
| private readonly role?: iam.IRole; | ||
|
|
||
| /** | ||
| * @param stream The Kinesis Data stream to which to put records. | ||
| * @param props Optional properties to not use default | ||
| */ | ||
| constructor(private readonly stream: kinesis.IStream, props: KinesisPutRecordActionProps = {}) { | ||
| this.partitionKey = props.partitionKey; | ||
| this.role = props.role; | ||
| } | ||
|
|
||
| bind(rule: iot.ITopicRule): iot.ActionConfig { | ||
| const role = this.role ?? singletonActionRole(rule); | ||
| role.addToPrincipalPolicy(new iam.PolicyStatement({ | ||
| actions: ['kinesis:PutRecord'], | ||
skinny85 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| resources: [this.stream.streamArn], | ||
| })); | ||
|
|
||
| return { | ||
| configuration: { | ||
| kinesis: { | ||
| streamName: this.stream.streamName, | ||
| partitionKey: this.partitionKey, | ||
| roleArn: role.roleArn, | ||
| }, | ||
| }, | ||
| }; | ||
| } | ||
| } | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,268 @@ | ||
| { | ||
| "Resources": { | ||
| "Logs6819BB44": { | ||
| "Type": "AWS::Logs::LogGroup", | ||
| "Properties": { | ||
| "RetentionInDays": 731 | ||
| }, | ||
| "UpdateReplacePolicy": "Delete", | ||
| "DeletionPolicy": "Delete" | ||
| }, | ||
| "TopicRuleTopicRuleActionRole246C4F77": { | ||
| "Type": "AWS::IAM::Role", | ||
| "Properties": { | ||
| "AssumeRolePolicyDocument": { | ||
| "Statement": [ | ||
| { | ||
| "Action": "sts:AssumeRole", | ||
| "Effect": "Allow", | ||
| "Principal": { | ||
| "Service": "iot.amazonaws.com" | ||
| } | ||
| } | ||
| ], | ||
| "Version": "2012-10-17" | ||
| } | ||
| } | ||
| }, | ||
| "TopicRuleTopicRuleActionRoleDefaultPolicy99ADD687": { | ||
| "Type": "AWS::IAM::Policy", | ||
| "Properties": { | ||
| "PolicyDocument": { | ||
| "Statement": [ | ||
| { | ||
| "Action": [ | ||
| "logs:CreateLogStream", | ||
| "logs:PutLogEvents" | ||
| ], | ||
| "Effect": "Allow", | ||
| "Resource": { | ||
| "Fn::GetAtt": [ | ||
| "Logs6819BB44", | ||
| "Arn" | ||
| ] | ||
| } | ||
| }, | ||
| { | ||
| "Action": "logs:DescribeLogStreams", | ||
| "Effect": "Allow", | ||
| "Resource": { | ||
| "Fn::GetAtt": [ | ||
| "Logs6819BB44", | ||
| "Arn" | ||
| ] | ||
| } | ||
| }, | ||
| { | ||
| "Action": "kinesis:PutRecord", | ||
| "Effect": "Allow", | ||
| "Resource": { | ||
| "Fn::GetAtt": [ | ||
| "MyStream5C050E93", | ||
| "Arn" | ||
| ] | ||
| } | ||
| } | ||
| ], | ||
| "Version": "2012-10-17" | ||
| }, | ||
| "PolicyName": "TopicRuleTopicRuleActionRoleDefaultPolicy99ADD687", | ||
| "Roles": [ | ||
| { | ||
| "Ref": "TopicRuleTopicRuleActionRole246C4F77" | ||
| } | ||
| ] | ||
| } | ||
| }, | ||
| "TopicRule40A4EA44": { | ||
| "Type": "AWS::IoT::TopicRule", | ||
| "Properties": { | ||
| "TopicRulePayload": { | ||
| "Actions": [ | ||
| { | ||
| "Kinesis": { | ||
| "PartitionKey": "${timestamp()}", | ||
| "RoleArn": { | ||
| "Fn::GetAtt": [ | ||
| "TopicRuleTopicRuleActionRole246C4F77", | ||
| "Arn" | ||
| ] | ||
| }, | ||
| "StreamName": { | ||
| "Ref": "MyStream5C050E93" | ||
| } | ||
| } | ||
| } | ||
| ], | ||
| "AwsIotSqlVersion": "2016-03-23", | ||
| "ErrorAction": { | ||
| "CloudwatchLogs": { | ||
| "LogGroupName": { | ||
| "Ref": "Logs6819BB44" | ||
| }, | ||
| "RoleArn": { | ||
| "Fn::GetAtt": [ | ||
| "TopicRuleTopicRuleActionRole246C4F77", | ||
| "Arn" | ||
| ] | ||
| } | ||
| } | ||
| }, | ||
| "Sql": "SELECT * FROM 'device/+/data'" | ||
| } | ||
| } | ||
| }, | ||
| "MyStream5C050E93": { | ||
| "Type": "AWS::Kinesis::Stream", | ||
| "Properties": { | ||
| "ShardCount": 3, | ||
| "RetentionPeriodHours": 24, | ||
| "StreamEncryption": { | ||
| "Fn::If": [ | ||
| "AwsCdkKinesisEncryptedStreamsUnsupportedRegions", | ||
| { | ||
| "Ref": "AWS::NoValue" | ||
| }, | ||
| { | ||
| "EncryptionType": "KMS", | ||
| "KeyId": "alias/aws/kinesis" | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| }, | ||
| "MyLambdaServiceRole4539ECB6": { | ||
| "Type": "AWS::IAM::Role", | ||
| "Properties": { | ||
| "AssumeRolePolicyDocument": { | ||
| "Statement": [ | ||
| { | ||
| "Action": "sts:AssumeRole", | ||
| "Effect": "Allow", | ||
| "Principal": { | ||
| "Service": "lambda.amazonaws.com" | ||
| } | ||
| } | ||
| ], | ||
| "Version": "2012-10-17" | ||
| }, | ||
| "ManagedPolicyArns": [ | ||
| { | ||
| "Fn::Join": [ | ||
| "", | ||
| [ | ||
| "arn:", | ||
| { | ||
| "Ref": "AWS::Partition" | ||
| }, | ||
| ":iam::aws:policy/service-role/AWSLambdaBasicExecutionRole" | ||
| ] | ||
| ] | ||
| } | ||
| ] | ||
| } | ||
| }, | ||
| "MyLambdaServiceRoleDefaultPolicy5BBC6F68": { | ||
| "Type": "AWS::IAM::Policy", | ||
| "Properties": { | ||
| "PolicyDocument": { | ||
| "Statement": [ | ||
| { | ||
| "Action": [ | ||
| "kinesis:DescribeStreamSummary", | ||
| "kinesis:GetRecords", | ||
| "kinesis:GetShardIterator", | ||
| "kinesis:ListShards", | ||
| "kinesis:SubscribeToShard", | ||
| "kinesis:DescribeStream", | ||
| "kinesis:ListStreams" | ||
| ], | ||
| "Effect": "Allow", | ||
| "Resource": { | ||
| "Fn::GetAtt": [ | ||
| "MyStream5C050E93", | ||
| "Arn" | ||
| ] | ||
| } | ||
| }, | ||
| { | ||
| "Action": "kinesis:DescribeStream", | ||
| "Effect": "Allow", | ||
| "Resource": { | ||
| "Fn::GetAtt": [ | ||
| "MyStream5C050E93", | ||
| "Arn" | ||
| ] | ||
| } | ||
| } | ||
| ], | ||
| "Version": "2012-10-17" | ||
| }, | ||
| "PolicyName": "MyLambdaServiceRoleDefaultPolicy5BBC6F68", | ||
| "Roles": [ | ||
| { | ||
| "Ref": "MyLambdaServiceRole4539ECB6" | ||
| } | ||
| ] | ||
| } | ||
| }, | ||
| "MyLambdaCCE802FB": { | ||
| "Type": "AWS::Lambda::Function", | ||
| "Properties": { | ||
| "Code": { | ||
| "ZipFile": "\n exports.handler = (event) => {\n event.Records.forEach(rec => {\n console.log('eventID:', rec.eventID)\n })\n }\n " | ||
| }, | ||
| "Role": { | ||
| "Fn::GetAtt": [ | ||
| "MyLambdaServiceRole4539ECB6", | ||
| "Arn" | ||
| ] | ||
| }, | ||
| "Handler": "index.handler", | ||
| "Runtime": "nodejs14.x" | ||
| }, | ||
| "DependsOn": [ | ||
| "MyLambdaServiceRoleDefaultPolicy5BBC6F68", | ||
| "MyLambdaServiceRole4539ECB6" | ||
| ] | ||
| }, | ||
| "MyLambdaKinesisEventSourceteststackMyStreamED37A4A443E4E7EF": { | ||
| "Type": "AWS::Lambda::EventSourceMapping", | ||
| "Properties": { | ||
| "FunctionName": { | ||
| "Ref": "MyLambdaCCE802FB" | ||
| }, | ||
| "BatchSize": 100, | ||
| "EventSourceArn": { | ||
| "Fn::GetAtt": [ | ||
| "MyStream5C050E93", | ||
| "Arn" | ||
| ] | ||
| }, | ||
| "StartingPosition": "TRIM_HORIZON" | ||
| } | ||
| } | ||
| }, | ||
| "Conditions": { | ||
| "AwsCdkKinesisEncryptedStreamsUnsupportedRegions": { | ||
| "Fn::Or": [ | ||
| { | ||
| "Fn::Equals": [ | ||
| { | ||
| "Ref": "AWS::Region" | ||
| }, | ||
| "cn-north-1" | ||
| ] | ||
| }, | ||
| { | ||
| "Fn::Equals": [ | ||
| { | ||
| "Ref": "AWS::Region" | ||
| }, | ||
| "cn-northwest-1" | ||
| ] | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| } |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's mention what's the default.