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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/types.rb

Overview

Note:

When making an API call, you may pass CheckpointConfiguration data as a 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.

Instance Attribute Summary collapse

Instance Attribute Details

#checkpoint_intervalInteger

Describes the interval in milliseconds between checkpoint operations.

Returns:

  • (Integer)


1181
1182
1183
1184
1185
1186
1187
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/types.rb', line 1181

class CheckpointConfiguration < Struct.new(
  :configuration_type,
  :checkpointing_enabled,
  :checkpoint_interval,
  :min_pause_between_checkpoints)
  include Aws::Structure
end

#checkpointing_enabledBoolean

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

Returns:

  • (Boolean)


1181
1182
1183
1184
1185
1186
1187
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/types.rb', line 1181

class CheckpointConfiguration < Struct.new(
  :configuration_type,
  :checkpointing_enabled,
  :checkpoint_interval,
  :min_pause_between_checkpoints)
  include Aws::Structure
end

#configuration_typeString

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

Returns:

  • (String)


1181
1182
1183
1184
1185
1186
1187
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/types.rb', line 1181

class CheckpointConfiguration < Struct.new(
  :configuration_type,
  :checkpointing_enabled,
  :checkpoint_interval,
  :min_pause_between_checkpoints)
  include Aws::Structure
end

#min_pause_between_checkpointsInteger

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.

Returns:

  • (Integer)


1181
1182
1183
1184
1185
1186
1187
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/types.rb', line 1181

class CheckpointConfiguration < Struct.new(
  :configuration_type,
  :checkpointing_enabled,
  :checkpoint_interval,
  :min_pause_between_checkpoints)
  include Aws::Structure
end