KinesisStream

class aws_cdk.aws_events_targets.KinesisStream(stream, *, message=None, partition_key_path=None, dead_letter_queue=None, max_event_age=None, retry_attempts=None)

Bases: object

Use a Kinesis Stream as a target for AWS CloudWatch event rules.

Example:

# put to a Kinesis stream every time code is committed
# to a CodeCommit repository
repository.on_commit("onCommit", target=targets.KinesisStream(stream))
Parameters:

  • stream (IStream) –

  • message (Optional[RuleTargetInput]) – The message to send to the stream. Must be a valid JSON text passed to the target stream. Default: - the entire CloudWatch event

  • partition_key_path (Optional[str]) – Partition Key Path for records sent to this stream. Default: - eventId as the partition key

  • dead_letter_queue (Optional[IQueue]) – The SQS queue to be used as deadLetterQueue. Check out the considerations for using a dead-letter queue. The events not successfully delivered are automatically retried for a specified period of time, depending on the retry policy of the target. If an event is not delivered before all retry attempts are exhausted, it will be sent to the dead letter queue. Default: - no dead-letter queue

  • max_event_age (Optional[Duration]) – The maximum age of a request that Lambda sends to a function for processing. Minimum value of 60. Maximum value of 86400. Default: Duration.hours(24)

  • retry_attempts (Union[int, float, None]) – The maximum number of times to retry when the function returns an error. Minimum value of 0. Maximum value of 185. Default: 185

Methods

bind(_rule, _id=None)

Returns a RuleTarget that can be used to trigger this Kinesis Stream as a result from a CloudWatch event.

Parameters:

  • _rule (IRule) –

  • _id (Optional[str]) –

Return type:

RuleTargetConfig