Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.KinesisAnalyticsV2.Types.CheckpointConfigurationDescription

Description

Documentation

data CheckpointConfigurationDescription Source #

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

See: newCheckpointConfigurationDescription smart constructor.

Constructors

CheckpointConfigurationDescription'

Fields

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.
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.
configurationType :: Maybe ConfigurationType
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
minPauseBetweenCheckpoints :: Maybe Natural
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.

Instances

Instances details

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

newCheckpointConfigurationDescription :: CheckpointConfigurationDescription Source #

Create a value of CheckpointConfigurationDescription 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:checkpointInterval:CheckpointConfigurationDescription', checkpointConfigurationDescription_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:checkpointingEnabled:CheckpointConfigurationDescription', checkpointConfigurationDescription_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:configurationType:CheckpointConfigurationDescription', checkpointConfigurationDescription_configurationType - 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

$sel:minPauseBetweenCheckpoints:CheckpointConfigurationDescription', checkpointConfigurationDescription_minPauseBetweenCheckpoints - 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.

checkpointConfigurationDescription_checkpointInterval :: Lens' CheckpointConfigurationDescription (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.

checkpointConfigurationDescription_checkpointingEnabled :: Lens' CheckpointConfigurationDescription (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.

checkpointConfigurationDescription_configurationType :: Lens' CheckpointConfigurationDescription (Maybe ConfigurationType) Source #

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

checkpointConfigurationDescription_minPauseBetweenCheckpoints :: Lens' CheckpointConfigurationDescription (Maybe Natural) Source #

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.