You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::KinesisAnalyticsV2::Types::CheckpointConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CheckpointConfiguration as input to an Aws::Client method, you can use a vanilla Hash:

{
  configuration_type: "DEFAULT", # required, accepts DEFAULT, CUSTOM
  checkpointing_enabled: false,
  checkpoint_interval: 1,
  min_pause_between_checkpoints: 1,
}

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.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#checkpoint_interval ⇒ Integer

Describes the interval in milliseconds between checkpoint operations.

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.

Returns:

  • (Integer) —

    Describes the interval in milliseconds between checkpoint operations.

#checkpointing_enabled ⇒ Boolean

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.

Returns:

  • (Boolean) —

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

#configuration_type ⇒ String

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

Possible values:

  • DEFAULT
  • CUSTOM

Returns:

  • (String) —

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

#min_pause_between_checkpoints ⇒ Integer

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.

Returns:

  • (Integer) —

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