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

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

Overview

Describes checkpointing parameters for a Managed Service for Apache Flink application.

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) 


1259
1260
1261
1262
1263
1264
1265
1266
 
# File 'lib/aws-sdk-kinesisanalyticsv2/types.rb', line 1259

class CheckpointConfigurationDescription < 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) 


1259
1260
1261
1262
1263
1264
1265
1266
 
# File 'lib/aws-sdk-kinesisanalyticsv2/types.rb', line 1259

class CheckpointConfigurationDescription < 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 the default checkpointing behavior in Managed Service for Apache Flink.

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


1259
1260
1261
1262
1263
1264
1265
1266
 
# File 'lib/aws-sdk-kinesisanalyticsv2/types.rb', line 1259

class CheckpointConfigurationDescription < 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.

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

Returns:

  • (Integer) 


1259
1260
1261
1262
1263
1264
1265
1266
 
# File 'lib/aws-sdk-kinesisanalyticsv2/types.rb', line 1259

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