Amazon Managed Apache Flink Parallelism Configuration Structure

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.

Type: object Properties: 4 Required: 1
Apache FlinkBig DataReal-Time ProcessingStreaming Analytics

ParallelismConfiguration is a JSON Structure definition published by Amazon Managed Service for Apache Flink, describing 4 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

ConfigurationType Parallelism ParallelismPerKPU AutoScalingEnabled

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-managed-apache-flink/refs/heads/main/json-structure/amazon-managed-apache-flink-parallelism-configuration-structure.json",
  "name": "ParallelismConfiguration",
  "description": "Describes parameters for how a Flink-based Kinesis Data Analytics application executes multiple tasks simultaneously. For more information about parallelism, see <a href=\"https://ci.apache.org/projects/flink/flink-docs-release-1.8/dev/parallel.html\">Parallel Execution</a> in the <a href=\"https://ci.apache.org/projects/flink/flink-docs-release-1.8/\">Apache Flink Documentation</a>.",
  "type": "object",
  "properties": {
    "ConfigurationType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ConfigurationType"
        },
        {
          "description": "Describes whether the application uses the default parallelism for the Kinesis Data Analytics service. You must set this property to <code>CUSTOM</code> in order to change your application's <code>AutoScalingEnabled</code>, <code>Parallelism</code>, or <code>ParallelismPerKPU</code> properties."
        }
      ]
    },
    "Parallelism": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Parallelism"
        },
        {
          "description": "Describes the initial number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform. If <code>AutoScalingEnabled</code> is set to True, Kinesis Data Analytics increases the <code>CurrentParallelism</code> value in response to application load. The service can increase the <code>CurrentParallelism</code> value up to the maximum parallelism, which is <code>ParalellismPerKPU</code> 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 <code>CurrentParallelism</code> value down to the <code>Parallelism</code> setting."
        }
      ]
    },
    "ParallelismPerKPU": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ParallelismPerKPU"
        },
        {
          "description": "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 <a href=\"http://aws.amazon.com/kinesis/data-analytics/pricing/\">Amazon Kinesis Data Analytics Pricing</a>."
        }
      ]
    },
    "AutoScalingEnabled": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BooleanObject"
        },
        {
          "description": "Describes whether the Kinesis Data Analytics service can increase the parallelism of the application in response to increased throughput."
        }
      ]
    }
  },
  "required": [
    "ConfigurationType"
  ]
}