aws-cdk-lib.aws_kinesisanalyticsv2.CfnApplication.CheckpointConfigurationProperty

CheckpointConfigurationProperty Struct

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 .

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_kinesisanalyticsv2 as kinesisanalyticsv2 } from 'aws-cdk-lib';
const checkpointConfigurationProperty: kinesisanalyticsv2.CfnApplication.CheckpointConfigurationProperty = {
  configurationType: 'configurationType',

  // the properties below are optional
  checkpointingEnabled: false,
  checkpointInterval: 123,
  minPauseBetweenCheckpoints: 123,
};

Properties

checkpointingEnabled?optionalboolean | IResolvablecheckpointing_enabled?optionaltyping.Union[bool, IResolvable]checkpointingEnabled?optionalBooleanCheckpointingEnabled?optionalboolCheckpointingEnabled?optionalinterface{}#

Describes whether checkpointing is enabled for a Managed Service for Apache Flink 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.

checkpointInterval?optionalnumbercheckpoint_interval?optionalint | floatcheckpointInterval?optionalNumberCheckpointInterval?optionaldoubleCheckpointInterval?optional*float64#

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.

configurationTypestringconfiguration_typestrconfigurationTypeStringConfigurationTypestringConfigurationType*stringrequired#

Describes whether the application uses Managed Service for Apache Flink' default checkpointing behavior.

notes

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

minPauseBetweenCheckpoints?optionalnumbermin_pause_between_checkpoints?optionalint | floatminPauseBetweenCheckpoints?optionalNumberMinPauseBetweenCheckpoints?optionaldoubleMinPauseBetweenCheckpoints?optional*float64#

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

notes

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.