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

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

Overview

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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

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 value of 60000, even if this value is set to another value using this API or in application code.

Returns:

  • (Integer) 


1193
1194
1195
1196
1197
1198
1199
1200
 
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/types.rb', line 1193

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

#checkpointing_enabled ⇒ Boolean

Describes whether checkpointing is enabled for a Managed Service for Apache Flink 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) 


1193
1194
1195
1196
1197
1198
1199
1200
 
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/types.rb', line 1193

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

#configuration_type ⇒ String

Describes whether the application uses Managed Service for Apache Flink' 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

Returns:

  • (String) 


1193
1194
1195
1196
1197
1198
1199
1200
 
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/types.rb', line 1193

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

#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) 


1193
1194
1195
1196
1197
1198
1199
1200
 
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/types.rb', line 1193

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