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

Class: Aws::KinesisAnalyticsV2::Types::CheckpointConfigurationUpdate

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

Overview

Note:

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

{
  configuration_type_update: "DEFAULT", # accepts DEFAULT, CUSTOM
  checkpointing_enabled_update: false,
  checkpoint_interval_update: 1,
  min_pause_between_checkpoints_update: 1,
}

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

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#checkpoint_interval_updateInteger

Describes updates to 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 updates to the interval in milliseconds between checkpoint operations.

#checkpointing_enabled_updateBoolean

Describes updates to whether checkpointing is enabled for an 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 updates to whether checkpointing is enabled for an application.

#configuration_type_updateString

Describes updates to whether the application uses the default checkpointing behavior of Kinesis Data Analytics. 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 updates to whether the application uses the default checkpointing behavior of Kinesis Data Analytics.

#min_pause_between_checkpoints_updateInteger

Describes updates to 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 updates to the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start.