amazonka-kinesisanalyticsv2-2.0: Amazon Kinesis Analytics SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.KinesisAnalyticsV2.Types.ParallelismConfiguration

Description

 
Synopsis

Documentation

data ParallelismConfiguration Source #

Describes parameters for how a Flink-based Kinesis Data Analytics application executes multiple tasks simultaneously. For more information about parallelism, see Parallel Execution in the Apache Flink Documentation.

See: newParallelismConfiguration smart constructor.

Constructors

ParallelismConfiguration' 

Fields

  • autoScalingEnabled :: Maybe Bool

    Describes whether the Kinesis Data Analytics service can increase the parallelism of the application in response to increased throughput.

  • parallelism :: Maybe Natural

    Describes the initial number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform. If AutoScalingEnabled is set to True, Kinesis Data Analytics increases the CurrentParallelism value in response to application load. The service can increase the CurrentParallelism value up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can reduce the CurrentParallelism value down to the Parallelism setting.

  • parallelismPerKPU :: Maybe Natural

    Describes the number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform per Kinesis Processing Unit (KPU) used by the application. For more information about KPUs, see Amazon Kinesis Data Analytics Pricing.

  • configurationType :: ConfigurationType

    Describes whether the application uses the default parallelism for the Kinesis Data Analytics service. You must set this property to CUSTOM in order to change your application's AutoScalingEnabled, Parallelism, or ParallelismPerKPU properties.

Instances

Instances details
ToJSON ParallelismConfiguration Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.Types.ParallelismConfiguration

Generic ParallelismConfiguration Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.Types.ParallelismConfiguration

Associated Types

type Rep ParallelismConfiguration :: Type -> Type #

Read ParallelismConfiguration Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.Types.ParallelismConfiguration

Show ParallelismConfiguration Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.Types.ParallelismConfiguration

NFData ParallelismConfiguration Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.Types.ParallelismConfiguration

Eq ParallelismConfiguration Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.Types.ParallelismConfiguration

Hashable ParallelismConfiguration Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.Types.ParallelismConfiguration

type Rep ParallelismConfiguration Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.Types.ParallelismConfiguration

type Rep ParallelismConfiguration = D1 ('MetaData "ParallelismConfiguration" "Amazonka.KinesisAnalyticsV2.Types.ParallelismConfiguration" "amazonka-kinesisanalyticsv2-2.0-EuRTRS4ROZrHrkll3mMtCB" 'False) (C1 ('MetaCons "ParallelismConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "autoScalingEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "parallelism") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "parallelismPerKPU") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "configurationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ConfigurationType))))

newParallelismConfiguration Source #

Create a value of ParallelismConfiguration 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:autoScalingEnabled:ParallelismConfiguration', parallelismConfiguration_autoScalingEnabled - Describes whether the Kinesis Data Analytics service can increase the parallelism of the application in response to increased throughput.

$sel:parallelism:ParallelismConfiguration', parallelismConfiguration_parallelism - Describes the initial number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform. If AutoScalingEnabled is set to True, Kinesis Data Analytics increases the CurrentParallelism value in response to application load. The service can increase the CurrentParallelism value up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can reduce the CurrentParallelism value down to the Parallelism setting.

$sel:parallelismPerKPU:ParallelismConfiguration', parallelismConfiguration_parallelismPerKPU - Describes the number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform per Kinesis Processing Unit (KPU) used by the application. For more information about KPUs, see Amazon Kinesis Data Analytics Pricing.

$sel:configurationType:ParallelismConfiguration', parallelismConfiguration_configurationType - Describes whether the application uses the default parallelism for the Kinesis Data Analytics service. You must set this property to CUSTOM in order to change your application's AutoScalingEnabled, Parallelism, or ParallelismPerKPU properties.

parallelismConfiguration_autoScalingEnabled :: Lens' ParallelismConfiguration (Maybe Bool) Source #

Describes whether the Kinesis Data Analytics service can increase the parallelism of the application in response to increased throughput.

parallelismConfiguration_parallelism :: Lens' ParallelismConfiguration (Maybe Natural) Source #

Describes the initial number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform. If AutoScalingEnabled is set to True, Kinesis Data Analytics increases the CurrentParallelism value in response to application load. The service can increase the CurrentParallelism value up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can reduce the CurrentParallelism value down to the Parallelism setting.

parallelismConfiguration_parallelismPerKPU :: Lens' ParallelismConfiguration (Maybe Natural) Source #

Describes the number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform per Kinesis Processing Unit (KPU) used by the application. For more information about KPUs, see Amazon Kinesis Data Analytics Pricing.

parallelismConfiguration_configurationType :: Lens' ParallelismConfiguration ConfigurationType Source #

Describes whether the application uses the default parallelism for the Kinesis Data Analytics service. You must set this property to CUSTOM in order to change your application's AutoScalingEnabled, Parallelism, or ParallelismPerKPU properties.