Class CfnApplicationV2.CheckpointConfigurationProperty
Describes an application's checkpointing configuration.
Inheritance
Namespace: Amazon.CDK.AWS.KinesisAnalytics
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CheckpointConfigurationProperty : Object, CfnApplicationV2.ICheckpointConfigurationProperty
Syntax (vb)
Public Class CheckpointConfigurationProperty
Inherits Object
Implements CfnApplicationV2.ICheckpointConfigurationProperty
Remarks
Checkpointing is the process of persisting application state for fault tolerance. For more information, see Checkpoints for Fault Tolerance in the Apache Flink Documentation .
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.KinesisAnalytics;
var checkpointConfigurationProperty = new CheckpointConfigurationProperty {
ConfigurationType = "configurationType",
// the properties below are optional
CheckpointingEnabled = false,
CheckpointInterval = 123,
MinPauseBetweenCheckpoints = 123
};
Synopsis
Constructors
CheckpointConfigurationProperty() |
Properties
CheckpointingEnabled | Describes whether checkpointing is enabled for a Managed Service for Apache Flink application. |
CheckpointInterval | Describes the interval in milliseconds between checkpoint operations. |
ConfigurationType | Describes whether the application uses Managed Service for Apache Flink' default checkpointing behavior. |
MinPauseBetweenCheckpoints | Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start. |
Constructors
CheckpointConfigurationProperty()
public CheckpointConfigurationProperty()
Properties
CheckpointingEnabled
Describes whether checkpointing is enabled for a Managed Service for Apache Flink application.
public object CheckpointingEnabled { get; set; }
Property Value
System.Object
Remarks
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.
CheckpointInterval
Describes the interval in milliseconds between checkpoint operations.
public Nullable<double> CheckpointInterval { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
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.
ConfigurationType
Describes whether the application uses Managed Service for Apache Flink' default checkpointing behavior.
public string ConfigurationType { get; set; }
Property Value
System.String
Remarks
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:
MinPauseBetweenCheckpoints
Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start.
public Nullable<double> MinPauseBetweenCheckpoints { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
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.