Package software.amazon.awscdk.services.pipes

Class CfnPipe.PipeSourceKinesisStreamParametersProperty.Builder

java.lang.Object

software.amazon.awscdk.services.pipes.CfnPipe.PipeSourceKinesisStreamParametersProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnPipe.PipeSourceKinesisStreamParametersProperty>

Enclosing interface:

CfnPipe.PipeSourceKinesisStreamParametersProperty

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

A builder for CfnPipe.PipeSourceKinesisStreamParametersProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnPipe.PipeSourceKinesisStreamParametersProperty.Builder	batchSize(Number batchSize)	Sets the value of CfnPipe.PipeSourceKinesisStreamParametersProperty.getBatchSize()
CfnPipe.PipeSourceKinesisStreamParametersProperty	build()	Builds the configured instance.
CfnPipe.PipeSourceKinesisStreamParametersProperty.Builder	deadLetterConfig(IResolvable deadLetterConfig)	Sets the value of CfnPipe.PipeSourceKinesisStreamParametersProperty.getDeadLetterConfig()
CfnPipe.PipeSourceKinesisStreamParametersProperty.Builder	deadLetterConfig(CfnPipe.DeadLetterConfigProperty deadLetterConfig)	Sets the value of CfnPipe.PipeSourceKinesisStreamParametersProperty.getDeadLetterConfig()
CfnPipe.PipeSourceKinesisStreamParametersProperty.Builder	maximumBatchingWindowInSeconds(Number maximumBatchingWindowInSeconds)	Sets the value of CfnPipe.PipeSourceKinesisStreamParametersProperty.getMaximumBatchingWindowInSeconds()
CfnPipe.PipeSourceKinesisStreamParametersProperty.Builder	maximumRecordAgeInSeconds(Number maximumRecordAgeInSeconds)	Sets the value of CfnPipe.PipeSourceKinesisStreamParametersProperty.getMaximumRecordAgeInSeconds()
CfnPipe.PipeSourceKinesisStreamParametersProperty.Builder	maximumRetryAttempts(Number maximumRetryAttempts)	Sets the value of CfnPipe.PipeSourceKinesisStreamParametersProperty.getMaximumRetryAttempts()
CfnPipe.PipeSourceKinesisStreamParametersProperty.Builder	onPartialBatchItemFailure(String onPartialBatchItemFailure)	Sets the value of CfnPipe.PipeSourceKinesisStreamParametersProperty.getOnPartialBatchItemFailure()
CfnPipe.PipeSourceKinesisStreamParametersProperty.Builder	parallelizationFactor(Number parallelizationFactor)	Sets the value of CfnPipe.PipeSourceKinesisStreamParametersProperty.getParallelizationFactor()
CfnPipe.PipeSourceKinesisStreamParametersProperty.Builder	startingPosition(String startingPosition)	Sets the value of CfnPipe.PipeSourceKinesisStreamParametersProperty.getStartingPosition()
CfnPipe.PipeSourceKinesisStreamParametersProperty.Builder	startingPositionTimestamp(String startingPositionTimestamp)	Sets the value of CfnPipe.PipeSourceKinesisStreamParametersProperty.getStartingPositionTimestamp()

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

startingPosition

@Stability(Stable)
public CfnPipe.PipeSourceKinesisStreamParametersProperty.Builder startingPosition(String startingPosition)

Sets the value of CfnPipe.PipeSourceKinesisStreamParametersProperty.getStartingPosition()

Parameters:

startingPosition - (Streams only) The position in a stream from which to start reading. This parameter is required.

Returns:

this

batchSize

@Stability(Stable)
public CfnPipe.PipeSourceKinesisStreamParametersProperty.Builder batchSize(Number batchSize)

Sets the value of CfnPipe.PipeSourceKinesisStreamParametersProperty.getBatchSize()

Parameters:

batchSize - The maximum number of records to include in each batch.

Returns:

this

deadLetterConfig

@Stability(Stable)
public CfnPipe.PipeSourceKinesisStreamParametersProperty.Builder deadLetterConfig(IResolvable deadLetterConfig)

Sets the value of CfnPipe.PipeSourceKinesisStreamParametersProperty.getDeadLetterConfig()

Parameters:

deadLetterConfig - Define the target queue to send dead-letter queue events to.

Returns:

this

deadLetterConfig

@Stability(Stable)
public CfnPipe.PipeSourceKinesisStreamParametersProperty.Builder deadLetterConfig(CfnPipe.DeadLetterConfigProperty deadLetterConfig)

Sets the value of CfnPipe.PipeSourceKinesisStreamParametersProperty.getDeadLetterConfig()

Parameters:

deadLetterConfig - Define the target queue to send dead-letter queue events to.

Returns:

this

maximumBatchingWindowInSeconds

@Stability(Stable)
public CfnPipe.PipeSourceKinesisStreamParametersProperty.Builder maximumBatchingWindowInSeconds(Number maximumBatchingWindowInSeconds)

Sets the value of CfnPipe.PipeSourceKinesisStreamParametersProperty.getMaximumBatchingWindowInSeconds()

Parameters:

maximumBatchingWindowInSeconds - The maximum length of a time to wait for events.

Returns:

this

maximumRecordAgeInSeconds

@Stability(Stable)
public CfnPipe.PipeSourceKinesisStreamParametersProperty.Builder maximumRecordAgeInSeconds(Number maximumRecordAgeInSeconds)

Sets the value of CfnPipe.PipeSourceKinesisStreamParametersProperty.getMaximumRecordAgeInSeconds()

Parameters:

maximumRecordAgeInSeconds - (Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, EventBridge never discards old records.

Returns:

this

maximumRetryAttempts

@Stability(Stable)
public CfnPipe.PipeSourceKinesisStreamParametersProperty.Builder maximumRetryAttempts(Number maximumRetryAttempts)

Sets the value of CfnPipe.PipeSourceKinesisStreamParametersProperty.getMaximumRetryAttempts()

Parameters:

maximumRetryAttempts - (Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source.

Returns:

this

onPartialBatchItemFailure

@Stability(Stable)
public CfnPipe.PipeSourceKinesisStreamParametersProperty.Builder onPartialBatchItemFailure(String onPartialBatchItemFailure)

Sets the value of CfnPipe.PipeSourceKinesisStreamParametersProperty.getOnPartialBatchItemFailure()

Parameters:

onPartialBatchItemFailure - (Streams only) Define how to handle item process failures. AUTOMATIC_BISECT halves each batch and retry each half until all the records are processed or there is one failed message left in the batch.

Returns:

this

parallelizationFactor

@Stability(Stable)
public CfnPipe.PipeSourceKinesisStreamParametersProperty.Builder parallelizationFactor(Number parallelizationFactor)

Sets the value of CfnPipe.PipeSourceKinesisStreamParametersProperty.getParallelizationFactor()

Parameters:

parallelizationFactor - (Streams only) The number of batches to process concurrently from each shard. The default value is 1.

Returns:

this

startingPositionTimestamp

@Stability(Stable)
public CfnPipe.PipeSourceKinesisStreamParametersProperty.Builder startingPositionTimestamp(String startingPositionTimestamp)

Sets the value of CfnPipe.PipeSourceKinesisStreamParametersProperty.getStartingPositionTimestamp()

Parameters:

startingPositionTimestamp - With StartingPosition set to AT_TIMESTAMP , the time from which to start reading, in Unix time seconds.

Returns:

this

build

@Stability(Stable)
public CfnPipe.PipeSourceKinesisStreamParametersProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnPipe.PipeSourceKinesisStreamParametersProperty>

Returns:

a new instance of CfnPipe.PipeSourceKinesisStreamParametersProperty

Throws:

NullPointerException - if any required attribute was not provided