Amazon Kinesis Analytics
kinesisanalytics (API Version 2018-05-23)

CheckpointConfigurationDescription

Describes checkpointing parameters for a Java-based Amazon Kinesis Data Analytics application.

Contents

CheckpointingEnabled

Describes whether checkpointing is enabled for a Java-based Kinesis Data Analytics application.

Note

If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a CheckpointingEnabled value of true, even if this value is set to another value using this API or in application code.

Type: Boolean

Required: No

CheckpointInterval

Describes the interval in milliseconds between checkpoint operations.

Note

If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a CheckpointInterval vaue of 60000, even if this value is set to another value using this API or in application code.

Type: Long

Valid Range: Minimum value of 1.

Required: No

ConfigurationType

Describes whether the application uses the default checkpointing behavior in Kinesis Data Analytics.

Note

If this value is set to DEFAULT, the application will use the following values, even if they are set to other values using APIs or application code:

  • CheckpointingEnabled: true

  • CheckpointInterval: 60000

  • MinPauseBetweenCheckpoints: 5000

Type: String

Valid Values: DEFAULT | CUSTOM

Required: No

MinPauseBetweenCheckpoints

Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start.

Note

If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a MinPauseBetweenCheckpoints value of 5000, even if this value is set using this API or in application code.

Type: Long

Valid Range: Minimum value of 1.

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: