libZSservicesZSamazonka-kinesisanalyticsv2ZSamazonka-kinesisanalyticsv2
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.KinesisAnalyticsV2.Types.CheckpointConfigurationUpdate

Description

 
Synopsis

Documentation

data CheckpointConfigurationUpdate Source #

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

See: newCheckpointConfigurationUpdate smart constructor.

Constructors

CheckpointConfigurationUpdate' 

Fields

  • checkpointIntervalUpdate :: Maybe Natural

    Describes updates to 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.

  • checkpointingEnabledUpdate :: Maybe Bool

    Describes updates to whether checkpointing is enabled for an 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.

  • minPauseBetweenCheckpointsUpdate :: Maybe Natural

    Describes updates to 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.

  • configurationTypeUpdate :: Maybe ConfigurationType

    Describes updates to whether the application uses the default checkpointing behavior of Kinesis Data Analytics. 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 CheckpointConfigurationUpdate Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.Types.CheckpointConfigurationUpdate

Methods

(==) :: CheckpointConfigurationUpdate -> CheckpointConfigurationUpdate -> Bool #

(/=) :: CheckpointConfigurationUpdate -> CheckpointConfigurationUpdate -> Bool #

Read CheckpointConfigurationUpdate Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.Types.CheckpointConfigurationUpdate

Methods

readsPrec :: Int -> ReadS CheckpointConfigurationUpdate #

readList :: ReadS [CheckpointConfigurationUpdate] #

readPrec :: ReadPrec CheckpointConfigurationUpdate #

readListPrec :: ReadPrec [CheckpointConfigurationUpdate] #

Show CheckpointConfigurationUpdate Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.Types.CheckpointConfigurationUpdate

Methods

showsPrec :: Int -> CheckpointConfigurationUpdate -> ShowS #

show :: CheckpointConfigurationUpdate -> String #

showList :: [CheckpointConfigurationUpdate] -> ShowS #

Generic CheckpointConfigurationUpdate Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.Types.CheckpointConfigurationUpdate

Associated Types

type Rep CheckpointConfigurationUpdate :: Type -> Type #

Methods

from :: CheckpointConfigurationUpdate -> Rep CheckpointConfigurationUpdate x #

to :: Rep CheckpointConfigurationUpdate x -> CheckpointConfigurationUpdate #

NFData CheckpointConfigurationUpdate Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.Types.CheckpointConfigurationUpdate

Methods

rnf :: CheckpointConfigurationUpdate -> () #

Hashable CheckpointConfigurationUpdate Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.Types.CheckpointConfigurationUpdate

Methods

hashWithSalt :: Int -> CheckpointConfigurationUpdate -> Int #

hash :: CheckpointConfigurationUpdate -> Int #

ToJSON CheckpointConfigurationUpdate Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.Types.CheckpointConfigurationUpdate

Methods

toJSON :: CheckpointConfigurationUpdate -> Value #

toEncoding :: CheckpointConfigurationUpdate -> Encoding #

toJSONList :: [CheckpointConfigurationUpdate] -> Value #

toEncodingList :: [CheckpointConfigurationUpdate] -> Encoding #

type Rep CheckpointConfigurationUpdate Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.Types.CheckpointConfigurationUpdate

type Rep CheckpointConfigurationUpdate = D1 ('MetaData "CheckpointConfigurationUpdate" "Amazonka.KinesisAnalyticsV2.Types.CheckpointConfigurationUpdate" "libZSservicesZSamazonka-kinesisanalyticsv2ZSamazonka-kinesisanalyticsv2" 'False) (C1 ('MetaCons "CheckpointConfigurationUpdate'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "checkpointIntervalUpdate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "checkpointingEnabledUpdate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "minPauseBetweenCheckpointsUpdate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "configurationTypeUpdate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConfigurationType)))))

newCheckpointConfigurationUpdate :: CheckpointConfigurationUpdate Source #

Create a value of CheckpointConfigurationUpdate 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:checkpointIntervalUpdate:CheckpointConfigurationUpdate', checkpointConfigurationUpdate_checkpointIntervalUpdate - Describes updates to 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:checkpointingEnabledUpdate:CheckpointConfigurationUpdate', checkpointConfigurationUpdate_checkpointingEnabledUpdate - Describes updates to whether checkpointing is enabled for an 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:minPauseBetweenCheckpointsUpdate:CheckpointConfigurationUpdate', checkpointConfigurationUpdate_minPauseBetweenCheckpointsUpdate - Describes updates to 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.

$sel:configurationTypeUpdate:CheckpointConfigurationUpdate', checkpointConfigurationUpdate_configurationTypeUpdate - Describes updates to whether the application uses the default checkpointing behavior of Kinesis Data Analytics. 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

checkpointConfigurationUpdate_checkpointIntervalUpdate :: Lens' CheckpointConfigurationUpdate (Maybe Natural) Source #

Describes updates to 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.

checkpointConfigurationUpdate_checkpointingEnabledUpdate :: Lens' CheckpointConfigurationUpdate (Maybe Bool) Source #

Describes updates to whether checkpointing is enabled for an 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.

checkpointConfigurationUpdate_minPauseBetweenCheckpointsUpdate :: Lens' CheckpointConfigurationUpdate (Maybe Natural) Source #

Describes updates to 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.

checkpointConfigurationUpdate_configurationTypeUpdate :: Lens' CheckpointConfigurationUpdate (Maybe ConfigurationType) Source #

Describes updates to whether the application uses the default checkpointing behavior of Kinesis Data Analytics. 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