Package software.amazon.awscdk.services.events.targets

Interface KinesisStreamProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, TargetBaseProps

All Known Implementing Classes:

KinesisStreamProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-06T23:25:10.351Z")
@Stability(Stable)
public interface KinesisStreamProps
extends software.amazon.jsii.JsiiSerializable, TargetBaseProps

Customize the Kinesis Stream Event Target.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.events.*;
 import software.amazon.awscdk.services.events.targets.*;
 import software.amazon.awscdk.services.sqs.*;
 Queue queue;
 RuleTargetInput ruleTargetInput;
 KinesisStreamProps kinesisStreamProps = KinesisStreamProps.builder()
         .deadLetterQueue(queue)
         .maxEventAge(Duration.minutes(30))
         .message(ruleTargetInput)
         .partitionKeyPath("partitionKeyPath")
         .retryAttempts(123)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	KinesisStreamProps.Builder	A builder for KinesisStreamProps
static final class	KinesisStreamProps.Jsii$Proxy	An implementation for KinesisStreamProps

Method Summary

Modifier and Type	Method	Description
static KinesisStreamProps.Builder	builder()
default RuleTargetInput	getMessage()	The message to send to the stream.
default String	getPartitionKeyPath()	Partition Key Path for records sent to this stream.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.services.events.targets.TargetBaseProps

getDeadLetterQueue, getMaxEventAge, getRetryAttempts

Method Details

getMessage

@Stability(Stable)
@Nullable
default RuleTargetInput getMessage()

The message to send to the stream.

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

Default: - the entire CloudWatch event

getPartitionKeyPath

@Stability(Stable)
@Nullable
default String getPartitionKeyPath()

Partition Key Path for records sent to this stream.

Default: - eventId as the partition key

builder

@Stability(Stable)
static KinesisStreamProps.Builder builder()

Returns:

a KinesisStreamProps.Builder of KinesisStreamProps