Package software.amazon.awscdk.services.pipes

Interface CfnPipe.PipeSourceKinesisStreamParametersProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPipe.PipeSourceKinesisStreamParametersProperty.Jsii$Proxy

Enclosing class:

CfnPipe

@Stability(Stable)
public static interface CfnPipe.PipeSourceKinesisStreamParametersProperty
extends software.amazon.jsii.JsiiSerializable

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.pipes.*;
 PipeSourceKinesisStreamParametersProperty pipeSourceKinesisStreamParametersProperty = PipeSourceKinesisStreamParametersProperty.builder()
         .startingPosition("startingPosition")
         // the properties below are optional
         .batchSize(123)
         .deadLetterConfig(DeadLetterConfigProperty.builder()
                 .arn("arn")
                 .build())
         .maximumBatchingWindowInSeconds(123)
         .maximumRecordAgeInSeconds(123)
         .maximumRetryAttempts(123)
         .onPartialBatchItemFailure("onPartialBatchItemFailure")
         .parallelizationFactor(123)
         .startingPositionTimestamp("startingPositionTimestamp")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcekinesisstreamparameters.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnPipe.PipeSourceKinesisStreamParametersProperty.Builder	builder()
default Number	getBatchSize()
default Object	getDeadLetterConfig()
default Number	getMaximumBatchingWindowInSeconds()
default Number	getMaximumRecordAgeInSeconds()
default Number	getMaximumRetryAttempts()
default String	getOnPartialBatchItemFailure()
default Number	getParallelizationFactor()
String	getStartingPosition()
default String	getStartingPositionTimestamp()	With StartingPosition set to AT_TIMESTAMP , the time from which to start reading, in Unix time seconds.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getStartingPosition

@Stability(Stable)
@NotNull
String getStartingPosition()

See Also:

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

getBatchSize

@Stability(Stable)
@Nullable
default Number getBatchSize()

See Also:

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

getDeadLetterConfig

@Stability(Stable)
@Nullable
default Object getDeadLetterConfig()

See Also:

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

getMaximumBatchingWindowInSeconds

@Stability(Stable)
@Nullable
default Number getMaximumBatchingWindowInSeconds()

See Also:

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

getMaximumRecordAgeInSeconds

@Stability(Stable)
@Nullable
default Number getMaximumRecordAgeInSeconds()

See Also:

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

getMaximumRetryAttempts

@Stability(Stable)
@Nullable
default Number getMaximumRetryAttempts()

See Also:

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

getOnPartialBatchItemFailure

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

See Also:

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

getParallelizationFactor

@Stability(Stable)
@Nullable
default Number getParallelizationFactor()

See Also:

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

getStartingPositionTimestamp

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

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

See Also:

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

builder

@Stability(Stable)
static CfnPipe.PipeSourceKinesisStreamParametersProperty.Builder builder()

Returns:

a CfnPipe.PipeSourceKinesisStreamParametersProperty.Builder of CfnPipe.PipeSourceKinesisStreamParametersProperty