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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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].

[1]: nightlies.apache.org/flink/flink-docs-release-1.20/docs/dev/datastream/fault-tolerance/checkpointing/#enabling-and-configuring-checkpointing [2]: nightlies.apache.org/flink/flink-docs-release-1.20/

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#checkpoint_interval ⇒ Integer

Describes the interval in milliseconds between checkpoint operations.

<note markdown=“1”> 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.

</note>

Returns:

  • (Integer) 


1268
1269
1270
1271
1272
1273
1274
1275
 
# File 'lib/aws-sdk-kinesisanalyticsv2/types.rb', line 1268

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.

<note markdown=“1”> 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.

</note>

Returns:

  • (Boolean) 


1268
1269
1270
1271
1272
1273
1274
1275
 
# File 'lib/aws-sdk-kinesisanalyticsv2/types.rb', line 1268

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.

<note markdown=“1”> 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

</note>

Returns:

  • (String) 


1268
1269
1270
1271
1272
1273
1274
1275
 
# File 'lib/aws-sdk-kinesisanalyticsv2/types.rb', line 1268

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].

<note markdown=“1”> 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.

</note>

[1]: nightlies.apache.org/flink/flink-docs-release-1.20/docs/ops/state/large_state_tuning/#tuning-checkpointing [2]: nightlies.apache.org/flink/flink-docs-release-1.20/

Returns:

  • (Integer) 


1268
1269
1270
1271
1272
1273
1274
1275
 
# File 'lib/aws-sdk-kinesisanalyticsv2/types.rb', line 1268

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