UNPKG

1.3 kBTypeScriptView Raw
1import * as events from '@aws-cdk/aws-events';
2import * as kinesis from '@aws-cdk/aws-kinesis';
3/**
4 * Customize the Kinesis Stream Event Target
5 */
6export interface KinesisStreamProps {
7 /**
8 * Partition Key Path for records sent to this stream
9 *
10 * @default - eventId as the partition key
11 */
12 readonly partitionKeyPath?: string;
13 /**
14 * The message to send to the stream.
15 *
16 * Must be a valid JSON text passed to the target stream.
17 *
18 * @default - the entire CloudWatch event
19 */
20 readonly message?: events.RuleTargetInput;
21}
22/**
23 * Use a Kinesis Stream as a target for AWS CloudWatch event rules.
24 *
25 * @example
26 * /// fixture=withRepoAndKinesisStream
27 * // put to a Kinesis stream every time code is committed
28 * // to a CodeCommit repository
29 * repository.onCommit('onCommit', { target: new targets.KinesisStream(stream) });
30 *
31 */
32export declare class KinesisStream implements events.IRuleTarget {
33 private readonly stream;
34 private readonly props;
35 constructor(stream: kinesis.IStream, props?: KinesisStreamProps);
36 /**
37 * Returns a RuleTarget that can be used to trigger this Kinesis Stream as a
38 * result from a CloudWatch event.
39 */
40 bind(_rule: events.IRule, _id?: string): events.RuleTargetConfig;
41}