Class: Aws::KinesisAnalyticsV2::Types::ParallelismConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/types.rb

Overview

Note:

When making an API call, you may pass ParallelismConfiguration data as a hash:

{
  configuration_type: "DEFAULT", # required, accepts DEFAULT, CUSTOM
  parallelism: 1,
  parallelism_per_kpu: 1,
  auto_scaling_enabled: false,
}

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#auto_scaling_enabledBoolean

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

Returns:

  • (Boolean)


4307
4308
4309
4310
4311
4312
4313
4314
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/types.rb', line 4307

class ParallelismConfiguration < Struct.new(
  :configuration_type,
  :parallelism,
  :parallelism_per_kpu,
  :auto_scaling_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#configuration_typeString

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.

Returns:

  • (String)


4307
4308
4309
4310
4311
4312
4313
4314
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/types.rb', line 4307

class ParallelismConfiguration < Struct.new(
  :configuration_type,
  :parallelism,
  :parallelism_per_kpu,
  :auto_scaling_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#parallelismInteger

Describes the initial number of parallel tasks that a Java-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.

Returns:

  • (Integer)


4307
4308
4309
4310
4311
4312
4313
4314
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/types.rb', line 4307

class ParallelismConfiguration < Struct.new(
  :configuration_type,
  :parallelism,
  :parallelism_per_kpu,
  :auto_scaling_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#parallelism_per_kpuInteger

Describes the number of parallel tasks that a Java-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.

Returns:

  • (Integer)


4307
4308
4309
4310
4311
4312
4313
4314
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/types.rb', line 4307

class ParallelismConfiguration < Struct.new(
  :configuration_type,
  :parallelism,
  :parallelism_per_kpu,
  :auto_scaling_enabled)
  SENSITIVE = []
  include Aws::Structure
end