Package software.amazon.awscdk.services.scheduler.targets.alpha

Class KinesisStreamPutRecordProps.Builder

java.lang.Object

software.amazon.awscdk.services.scheduler.targets.alpha.KinesisStreamPutRecordProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<KinesisStreamPutRecordProps>

Enclosing interface:

KinesisStreamPutRecordProps

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

A builder for KinesisStreamPutRecordProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
KinesisStreamPutRecordProps	build()	Builds the configured instance.
KinesisStreamPutRecordProps.Builder	deadLetterQueue(IQueue deadLetterQueue)	Sets the value of ScheduleTargetBaseProps.getDeadLetterQueue()
KinesisStreamPutRecordProps.Builder	input(ScheduleTargetInput input)	Sets the value of ScheduleTargetBaseProps.getInput()
KinesisStreamPutRecordProps.Builder	maxEventAge(Duration maxEventAge)	Sets the value of ScheduleTargetBaseProps.getMaxEventAge()
KinesisStreamPutRecordProps.Builder	partitionKey(String partitionKey)	Sets the value of KinesisStreamPutRecordProps.getPartitionKey()
KinesisStreamPutRecordProps.Builder	retryAttempts(Number retryAttempts)	Sets the value of ScheduleTargetBaseProps.getRetryAttempts()
KinesisStreamPutRecordProps.Builder	role(IRole role)	Sets the value of ScheduleTargetBaseProps.getRole()

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

partitionKey

@Stability(Experimental)
public KinesisStreamPutRecordProps.Builder partitionKey(String partitionKey)

Sets the value of KinesisStreamPutRecordProps.getPartitionKey()

Parameters:

partitionKey - The shard to which EventBridge Scheduler sends the event. This parameter is required. The length must be between 1 and 256.

Returns:

this

deadLetterQueue

@Stability(Experimental)
public KinesisStreamPutRecordProps.Builder deadLetterQueue(IQueue deadLetterQueue)

Sets the value of ScheduleTargetBaseProps.getDeadLetterQueue()

Parameters:

deadLetterQueue - The SQS queue to be used as deadLetterQueue. 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

input

@Stability(Experimental)
public KinesisStreamPutRecordProps.Builder input(ScheduleTargetInput input)

Sets the value of ScheduleTargetBaseProps.getInput()

Parameters:

input - Input passed to the target.

Returns:

this

maxEventAge

@Stability(Experimental)
public KinesisStreamPutRecordProps.Builder maxEventAge(Duration maxEventAge)

Sets the value of ScheduleTargetBaseProps.getMaxEventAge()

Parameters:

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

Returns:

this

retryAttempts

@Stability(Experimental)
public KinesisStreamPutRecordProps.Builder retryAttempts(Number retryAttempts)

Sets the value of ScheduleTargetBaseProps.getRetryAttempts()

Parameters:

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

Returns:

this

role

@Stability(Experimental)
public KinesisStreamPutRecordProps.Builder role(IRole role)

Sets the value of ScheduleTargetBaseProps.getRole()

Parameters:

role - An execution role is an IAM role that EventBridge Scheduler assumes in order to interact with other AWS services on your behalf. If none provided templates target will automatically create an IAM role with all the minimum necessary permissions to interact with the templated target. If you wish you may specify your own IAM role, then the templated targets will grant minimal required permissions.

Universal target automatically create an IAM role if you do not specify your own IAM role. However, in comparison with templated targets, for universal targets you must grant the required IAM permissions yourself.

Returns:

this

build

@Stability(Experimental)
public KinesisStreamPutRecordProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of KinesisStreamPutRecordProps

Throws:

NullPointerException - if any required attribute was not provided