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

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

Overview

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

Constant Summary collapse

SENSITIVE =
[]

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)


1399
1400
1401
1402
1403
1404
1405
1406
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/types.rb', line 1399

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

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


1399
1400
1401
1402
1403
1404
1405
1406
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/types.rb', line 1399

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

#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

Returns:

  • (String)


1399
1400
1401
1402
1403
1404
1405
1406
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/types.rb', line 1399

class CheckpointConfigurationDescription < Struct.new(
  :configuration_type,
  :checkpointing_enabled,
  :checkpoint_interval,
  :min_pause_between_checkpoints)
  SENSITIVE = []
  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 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)


1399
1400
1401
1402
1403
1404
1405
1406
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/types.rb', line 1399

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