Package software.amazon.awscdk.services.kinesisanalyticsv2

Interface CfnApplication.CheckpointConfigurationProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnApplication.CheckpointConfigurationProperty.Jsii$Proxy
Enclosing class:
CfnApplication
@Stability(Stable) public static interface CfnApplication.CheckpointConfigurationProperty extends software.amazon.jsii.JsiiSerializable
Describes an application's checkpointing configuration.

Checkpointing is the process of persisting application state for fault tolerance. For more information, see Checkpoints for Fault Tolerance in the Apache Flink Documentation .

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.kinesisanalyticsv2.*;
 CheckpointConfigurationProperty checkpointConfigurationProperty = CheckpointConfigurationProperty.builder()
         .configurationType("configurationType")
         // the properties below are optional
         .checkpointingEnabled(false)
         .checkpointInterval(123)
         .minPauseBetweenCheckpoints(123)
         .build();

  • Method Details

    • getConfigurationType

      @Stability(Stable) @NotNull String getConfigurationType()
      Describes whether the application uses Kinesis Data Analytics' default checkpointing behavior.

      You must set this property to CUSTOM in order to set the CheckpointingEnabled , CheckpointInterval , or MinPauseBetweenCheckpoints parameters.

      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

    • getCheckpointingEnabled

      @Stability(Stable) @Nullable default Object getCheckpointingEnabled()
      Describes whether checkpointing is enabled for a Flink-based Kinesis Data Analytics application.

      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.

    • getCheckpointInterval

      @Stability(Stable) @Nullable default Number getCheckpointInterval()
      Describes the interval in milliseconds between checkpoint operations.

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

    • getMinPauseBetweenCheckpoints

      @Stability(Stable) @Nullable default Number getMinPauseBetweenCheckpoints()
      Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start.

      If a checkpoint operation takes longer than the CheckpointInterval , the application otherwise performs continual checkpoint operations. For more information, see Tuning Checkpointing in the Apache Flink Documentation .

      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.

    • builder

      @Stability(Stable) static CfnApplication.CheckpointConfigurationProperty.Builder builder()
      Returns:
      a CfnApplication.CheckpointConfigurationProperty.Builder of CfnApplication.CheckpointConfigurationProperty