Amazon Managed Apache Flink Parallelism Configuration Description Structure

Describes parameters for how a Flink-based Kinesis Data Analytics application executes multiple tasks simultaneously.

Type: object Properties: 5
Apache FlinkBig DataReal-Time ProcessingStreaming Analytics

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

Properties

ConfigurationType Parallelism ParallelismPerKPU CurrentParallelism 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-description-structure.json",
  "name": "ParallelismConfigurationDescription",
  "description": "Describes parameters for how a Flink-based Kinesis Data Analytics application executes multiple tasks simultaneously.",
  "type": "object",
  "properties": {
    "ConfigurationType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ConfigurationType"
        },
        {
          "description": "Describes whether the application uses the default parallelism for the Kinesis Data Analytics service. "
        }
      ]
    },
    "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, then Kinesis Data Analytics can increase the <code>CurrentParallelism</code> value in response to application load. The service can increase <code>CurrentParallelism</code> 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."
        }
      ]
    },
    "CurrentParallelism": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Parallelism"
        },
        {
          "description": "Describes the current 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 can increase this value in response to application load. The service can increase this 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."
        }
      ]
    },
    "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."
        }
      ]
    }
  }
}