Class KinesisStreamProps

Customize the Kinesis Stream Event Target.

Inheritance
object
KinesisStreamProps
Inherited Members
Namespace: Amazon.CDK.AWS.Events.Targets
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class KinesisStreamProps : IKinesisStreamProps, ITargetBaseProps
Syntax (vb)
Public Class KinesisStreamProps Implements IKinesisStreamProps, ITargetBaseProps
Remarks

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK;
            using Amazon.CDK.AWS.Events;
            using Amazon.CDK.AWS.Events.Targets;
            using Amazon.CDK.AWS.SQS;

            Queue queue;
            RuleTargetInput ruleTargetInput;

            var kinesisStreamProps = new KinesisStreamProps {
                DeadLetterQueue = queue,
                MaxEventAge = Duration.Minutes(30),
                Message = ruleTargetInput,
                PartitionKeyPath = "partitionKeyPath",
                RetryAttempts = 123
            };

Synopsis

Constructors

KinesisStreamProps()

Customize the Kinesis Stream Event Target.

Properties

DeadLetterQueue

The SQS queue to be used as deadLetterQueue. Check out the considerations for using a dead-letter queue.
MaxEventAge

The maximum age of a request that Lambda sends to a function for processing.
Message

The message to send to the stream.
PartitionKeyPath

Partition Key Path for records sent to this stream.
RetryAttempts

The maximum number of times to retry when the function returns an error.

Constructors

KinesisStreamProps()

Customize the Kinesis Stream Event Target.

public KinesisStreamProps()
Remarks

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK;
            using Amazon.CDK.AWS.Events;
            using Amazon.CDK.AWS.Events.Targets;
            using Amazon.CDK.AWS.SQS;

            Queue queue;
            RuleTargetInput ruleTargetInput;

            var kinesisStreamProps = new KinesisStreamProps {
                DeadLetterQueue = queue,
                MaxEventAge = Duration.Minutes(30),
                Message = ruleTargetInput,
                PartitionKeyPath = "partitionKeyPath",
                RetryAttempts = 123
            };

Properties

DeadLetterQueue

The SQS queue to be used as deadLetterQueue. Check out the considerations for using a dead-letter queue.

public IQueue? DeadLetterQueue { get; set; }
Property Value

IQueue

Remarks

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

MaxEventAge

The maximum age of a request that Lambda sends to a function for processing.

public Duration? MaxEventAge { get; set; }
Property Value

Duration

Remarks

Minimum value of 60. Maximum value of 86400.

Default: Duration.hours(24)

Message

The message to send to the stream.

public RuleTargetInput? Message { get; set; }
Property Value

RuleTargetInput

Remarks

Must be a valid JSON text passed to the target stream.

Default: - the entire CloudWatch event

PartitionKeyPath

Partition Key Path for records sent to this stream.

public string? PartitionKeyPath { get; set; }
Property Value

string

Remarks

Default: - eventId as the partition key

RetryAttempts

The maximum number of times to retry when the function returns an error.

public double? RetryAttempts { get; set; }
Property Value

double?

Remarks

Minimum value of 0. Maximum value of 185.

Default: 185

Implements