AWS::KinesisAnalyticsV2::Application CheckpointConfiguration - Amazon CloudFormation
SyntaxPropertiesSee also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::KinesisAnalyticsV2::Application CheckpointConfiguration

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.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "CheckpointingEnabled" : Boolean,
  "CheckpointInterval" : Integer,
  "ConfigurationType" : String,
  "MinPauseBetweenCheckpoints" : Integer
}

Properties

CheckpointingEnabled

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

Required: No

Type: Boolean

Update requires: No interruption

CheckpointInterval

Describes the interval in milliseconds between checkpoint operations.

Note

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.

Required: No

Type: Integer

Update requires: No interruption

ConfigurationType

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.

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

Required: Yes

Type: String

Allowed values: CUSTOM | DEFAULT

Update requires: No interruption

MinPauseBetweenCheckpoints

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.

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.

Required: No

Type: Integer

Update requires: No interruption

See also