Amazon Managed Apache Flink Stop Application Request Structure

StopApplicationRequest schema from Amazon Managed Service for Apache Flink API

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

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

Properties

ApplicationName Force

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-stop-application-request-structure.json",
  "name": "StopApplicationRequest",
  "description": "StopApplicationRequest schema from Amazon Managed Service for Apache Flink API",
  "type": "object",
  "properties": {
    "ApplicationName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ApplicationName"
        },
        {
          "description": "The name of the running application to stop."
        }
      ]
    },
    "Force": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BooleanObject"
        },
        {
          "description": "<p>Set to <code>true</code> to force the application to stop. If you set <code>Force</code> to <code>true</code>, Kinesis Data Analytics stops the application without taking a snapshot. </p> <note> <p>Force-stopping your application may lead to data loss or duplication. To prevent data loss or duplicate processing of data during application restarts, we recommend you to take frequent snapshots of your application.</p> </note> <p>You can only force stop a Flink-based Kinesis Data Analytics application. You can't force stop a SQL-based Kinesis Data Analytics application.</p> <p>The application must be in the <code>STARTING</code>, <code>UPDATING</code>, <code>STOPPING</code>, <code>AUTOSCALING</code>, or <code>RUNNING</code> status. </p>"
        }
      ]
    }
  },
  "required": [
    "ApplicationName"
  ]
}