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

Class KinesisStreamProps.Builder

java.lang.Object

software.amazon.awscdk.services.events.targets.KinesisStreamProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<KinesisStreamProps>

Enclosing interface:

KinesisStreamProps

@Stability(Stable)
public static final class KinesisStreamProps.Builder
extends Object
implements software.amazon.jsii.Builder<KinesisStreamProps>

A builder for KinesisStreamProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
KinesisStreamProps	build()	Builds the configured instance.
KinesisStreamProps.Builder	deadLetterQueue(IQueue deadLetterQueue)	Sets the value of TargetBaseProps.getDeadLetterQueue()
KinesisStreamProps.Builder	maxEventAge(Duration maxEventAge)	Sets the value of TargetBaseProps.getMaxEventAge()
KinesisStreamProps.Builder	message(RuleTargetInput message)	Sets the value of KinesisStreamProps.getMessage()
KinesisStreamProps.Builder	partitionKeyPath(String partitionKeyPath)	Sets the value of KinesisStreamProps.getPartitionKeyPath()
KinesisStreamProps.Builder	retryAttempts(Number retryAttempts)	Sets the value of TargetBaseProps.getRetryAttempts()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

message

@Stability(Stable)
public KinesisStreamProps.Builder message(RuleTargetInput message)

Sets the value of KinesisStreamProps.getMessage()

Parameters:

message - The message to send to the stream. Must be a valid JSON text passed to the target stream.

Returns:

this

partitionKeyPath

@Stability(Stable)
public KinesisStreamProps.Builder partitionKeyPath(String partitionKeyPath)

Sets the value of KinesisStreamProps.getPartitionKeyPath()

Parameters:

partitionKeyPath - Partition Key Path for records sent to this stream.

Returns:

this

deadLetterQueue

@Stability(Stable)
public KinesisStreamProps.Builder deadLetterQueue(IQueue deadLetterQueue)

Sets the value of TargetBaseProps.getDeadLetterQueue()

Parameters:

deadLetterQueue - 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.

Returns:

this

maxEventAge

@Stability(Stable)
public KinesisStreamProps.Builder maxEventAge(Duration maxEventAge)

Sets the value of TargetBaseProps.getMaxEventAge()

Parameters:

maxEventAge - The maximum age of a request that Lambda sends to a function for processing. Minimum value of 60. Maximum value of 86400.

Returns:

this

retryAttempts

@Stability(Stable)
public KinesisStreamProps.Builder retryAttempts(Number retryAttempts)

Sets the value of TargetBaseProps.getRetryAttempts()

Parameters:

retryAttempts - The maximum number of times to retry when the function returns an error. Minimum value of 0. Maximum value of 185.

Returns:

this

build

@Stability(Stable)
public KinesisStreamProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<KinesisStreamProps>

Returns:

a new instance of KinesisStreamProps

Throws:

NullPointerException - if any required attribute was not provided