Package software.amazon.awscdk.services.pipes.sources.alpha

Class KinesisSourceParameters.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.pipes.sources.alpha.KinesisSourceParameters.Jsii$Proxy

All Implemented Interfaces:

KinesisSourceParameters, StreamSourceParameters, software.amazon.jsii.JsiiSerializable

Enclosing interface:

KinesisSourceParameters

@Stability(Experimental)
@Internal
public static final class KinesisSourceParameters.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements KinesisSourceParameters

An implementation for KinesisSourceParameters

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.pipes.sources.alpha.KinesisSourceParameters

KinesisSourceParameters.Builder, KinesisSourceParameters.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(KinesisSourceParameters.Builder builder)	Constructor that initializes the object based on literal property values passed by the KinesisSourceParameters.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Number	getBatchSize()	(experimental) The maximum number of records to include in each batch.
final Object	getDeadLetterTarget()	(experimental) Define the target to send dead-letter queue events to.
final Duration	getMaximumBatchingWindow()	(experimental) The maximum length of a time to wait for events.
final Duration	getMaximumRecordAge()	(experimental) Discard records older than the specified age.
final Number	getMaximumRetryAttempts()	(experimental) Discard records after the specified number of retries.
final OnPartialBatchItemFailure	getOnPartialBatchItemFailure()	(experimental) Define how to handle item process failures.
final Number	getParallelizationFactor()	(experimental) The number of batches to process concurrently from each shard.
final KinesisStartingPosition	getStartingPosition()	(experimental) The position in a stream from which to start reading.
final Instant	getStartingPositionTimestamp()	(experimental) With StartingPosition set to AT_TIMESTAMP, the time from which to start reading, in ISO 8601 format.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(KinesisSourceParameters.Builder builder)

Constructor that initializes the object based on literal property values passed by the KinesisSourceParameters.Builder.

Method Details

getStartingPosition

public final KinesisStartingPosition getStartingPosition()

Description copied from interface: KinesisSourceParameters

(experimental) The position in a stream from which to start reading.

Specified by:

getStartingPosition in interface KinesisSourceParameters

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcekinesisstreamparameters.html#cfn-pipes-pipe-pipesourcekinesisstreamparameters-startingposition

getStartingPositionTimestamp

public final Instant getStartingPositionTimestamp()

Description copied from interface: KinesisSourceParameters

(experimental) With StartingPosition set to AT_TIMESTAMP, the time from which to start reading, in ISO 8601 format.

Default: - no starting position timestamp

Example:

 new Date(Date.UTC(1969, 10, 20, 0, 0, 0));
 

Specified by:

getStartingPositionTimestamp in interface KinesisSourceParameters

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcekinesisstreamparameters.html#cfn-pipes-pipe-pipesourcekinesisstreamparameters-startingpositiontimestamp

getBatchSize

public final Number getBatchSize()

Description copied from interface: StreamSourceParameters

(experimental) The maximum number of records to include in each batch.

Default: 1

Specified by:

getBatchSize in interface StreamSourceParameters

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcekinesisstreamparameters.html#cfn-pipes-pipe-pipesourcekinesisstreamparameters-batchsize

getDeadLetterTarget

public final Object getDeadLetterTarget()

Description copied from interface: StreamSourceParameters

(experimental) Define the target to send dead-letter queue events to.

The dead-letter queue stores any events that are not successfully delivered to a Pipes target after all retry attempts are exhausted. You can then resolve the issue that caused the failed invocations and replay the events at a later time. In some cases, such as when access is denied to a resource, events are sent directly to the dead-letter queue and are not retried.

Returns union: either IQueue or ITopic

Default: - no dead-letter queue or topic

Specified by:

getDeadLetterTarget in interface StreamSourceParameters

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcekinesisstreamparameters.html#cfn-pipes-pipe-pipesourcekinesisstreamparameters-deadletterconfig

getMaximumBatchingWindow

public final Duration getMaximumBatchingWindow()

Description copied from interface: StreamSourceParameters

(experimental) The maximum length of a time to wait for events.

Default: - the events will be handled immediately

Specified by:

getMaximumBatchingWindow in interface StreamSourceParameters

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcekinesisstreamparameters.html#cfn-pipes-pipe-pipesourcekinesisstreamparameters-maximumbatchingwindowinseconds

getMaximumRecordAge

public final Duration getMaximumRecordAge()

Description copied from interface: StreamSourceParameters

(experimental) 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.

Default: -1 - EventBridge won't discard old records

Specified by:

getMaximumRecordAge in interface StreamSourceParameters

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcekinesisstreamparameters.html#cfn-pipes-pipe-pipesourcekinesisstreamparameters-maximumrecordageinseconds

getMaximumRetryAttempts

public final Number getMaximumRetryAttempts()

Description copied from interface: StreamSourceParameters

(experimental) 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.

Default: -1 - EventBridge will retry failed records until the record expires in the event source

Specified by:

getMaximumRetryAttempts in interface StreamSourceParameters

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcekinesisstreamparameters.html#cfn-pipes-pipe-pipesourcekinesisstreamparameters-maximumretryattempts

getOnPartialBatchItemFailure

public final OnPartialBatchItemFailure getOnPartialBatchItemFailure()

Description copied from interface: StreamSourceParameters

(experimental) Define how to handle item process failures.

invalid reference

OnPartialBatchItemFailure.AUTOMATIC_BISECT

halves each batch and will retry each half until all the records are processed or there is one failed message left in the batch.

Default: off - EventBridge will retry the entire batch

Specified by:

getOnPartialBatchItemFailure in interface StreamSourceParameters

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcekinesisstreamparameters.html#cfn-pipes-pipe-pipesourcekinesisstreamparameters-onpartialbatchitemfailure

getParallelizationFactor

public final Number getParallelizationFactor()

Description copied from interface: StreamSourceParameters

(experimental) The number of batches to process concurrently from each shard.

Default: 1

Specified by:

getParallelizationFactor in interface StreamSourceParameters

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcekinesisstreamparameters.html#cfn-pipes-pipe-pipesourcekinesisstreamparameters-parallelizationfactor

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object