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

Class: Aws::KinesisAnalyticsV2::Types::CheckpointConfigurationDescription

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

Overview

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

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#checkpoint_intervalInteger

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_enabledBoolean

Describes whether checkpointing is enabled for a Java-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 Java-based Kinesis Data Analytics application.

#configuration_typeString

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

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 the default checkpointing behavior in Kinesis Data Analytics.

#min_pause_between_checkpointsInteger

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

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.