Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.KinesisAnalyticsV2.Types.CheckpointConfiguration

Description

Documentation

data CheckpointConfiguration Source #

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: newCheckpointConfiguration smart constructor.

Constructors

CheckpointConfiguration'

Fields

checkpointingEnabled :: Maybe Bool
Describes whether checkpointing is enabled for a Flink-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.
minPauseBetweenCheckpoints :: Maybe Natural
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.
checkpointInterval :: Maybe Natural
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.
configurationType :: ConfigurationType
Describes whether the application uses Kinesis Data Analytics' 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

Instances

Instances details

Eq CheckpointConfiguration Source #
Instance details Defined in Amazonka.KinesisAnalyticsV2.Types.CheckpointConfiguration Methods (==) :: CheckpointConfiguration -> CheckpointConfiguration -> Bool # (/=) :: CheckpointConfiguration -> CheckpointConfiguration -> Bool #
Read CheckpointConfiguration Source #
Instance details Defined in Amazonka.KinesisAnalyticsV2.Types.CheckpointConfiguration Methods readsPrec :: Int -> ReadS CheckpointConfiguration # readList :: ReadS [CheckpointConfiguration] # readPrec :: ReadPrec CheckpointConfiguration # readListPrec :: ReadPrec [CheckpointConfiguration] #
Show CheckpointConfiguration Source #
Instance details Defined in Amazonka.KinesisAnalyticsV2.Types.CheckpointConfiguration Methods showsPrec :: Int -> CheckpointConfiguration -> ShowS # show :: CheckpointConfiguration -> String # showList :: [CheckpointConfiguration] -> ShowS #
Generic CheckpointConfiguration Source #
Instance details Defined in Amazonka.KinesisAnalyticsV2.Types.CheckpointConfiguration Associated Types type Rep CheckpointConfiguration :: Type -> Type # Methods from :: CheckpointConfiguration -> Rep CheckpointConfiguration x # to :: Rep CheckpointConfiguration x -> CheckpointConfiguration #
NFData CheckpointConfiguration Source #
Instance details Defined in Amazonka.KinesisAnalyticsV2.Types.CheckpointConfiguration Methods rnf :: CheckpointConfiguration -> () #
Hashable CheckpointConfiguration Source #
Instance details Defined in Amazonka.KinesisAnalyticsV2.Types.CheckpointConfiguration Methods hashWithSalt :: Int -> CheckpointConfiguration -> Int # hash :: CheckpointConfiguration -> Int #
ToJSON CheckpointConfiguration Source #
Instance details Defined in Amazonka.KinesisAnalyticsV2.Types.CheckpointConfiguration Methods toJSON :: CheckpointConfiguration -> Value # toEncoding :: CheckpointConfiguration -> Encoding # toJSONList :: [CheckpointConfiguration] -> Value # toEncodingList :: [CheckpointConfiguration] -> Encoding #
type Rep CheckpointConfiguration Source #
Instance details Defined in Amazonka.KinesisAnalyticsV2.Types.CheckpointConfiguration type Rep CheckpointConfiguration = D1 ('MetaData "CheckpointConfiguration" "Amazonka.KinesisAnalyticsV2.Types.CheckpointConfiguration" "libZSservicesZSamazonka-kinesisanalyticsv2ZSamazonka-kinesisanalyticsv2" 'False) (C1 ('MetaCons "CheckpointConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "checkpointingEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "minPauseBetweenCheckpoints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "checkpointInterval") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "configurationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ConfigurationType))))

newCheckpointConfiguration Source #

Arguments

:: ConfigurationType	`$sel:configurationType:CheckpointConfiguration'`
-> CheckpointConfiguration

Create a value of CheckpointConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:checkpointingEnabled:CheckpointConfiguration', checkpointConfiguration_checkpointingEnabled - Describes whether checkpointing is enabled for a Flink-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.

$sel:minPauseBetweenCheckpoints:CheckpointConfiguration', checkpointConfiguration_minPauseBetweenCheckpoints - 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.

$sel:checkpointInterval:CheckpointConfiguration', checkpointConfiguration_checkpointInterval - 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.

$sel:configurationType:CheckpointConfiguration', checkpointConfiguration_configurationType - Describes whether the application uses Kinesis Data Analytics' 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

checkpointConfiguration_checkpointingEnabled :: Lens' CheckpointConfiguration (Maybe Bool) Source #

Describes whether checkpointing is enabled for a Flink-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.

checkpointConfiguration_minPauseBetweenCheckpoints :: Lens' CheckpointConfiguration (Maybe Natural) Source #

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.

checkpointConfiguration_checkpointInterval :: Lens' CheckpointConfiguration (Maybe Natural) Source #

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.

checkpointConfiguration_configurationType :: Lens' CheckpointConfiguration ConfigurationType Source #

Describes whether the application uses Kinesis Data Analytics' 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