Amazon Managed Apache Flink Create Application Request Structure

CreateApplicationRequest schema from Amazon Managed Service for Apache Flink API

Type: object Properties: 8 Required: 3
Apache FlinkBig DataReal-Time ProcessingStreaming Analytics

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

Properties

ApplicationName ApplicationDescription RuntimeEnvironment ServiceExecutionRole ApplicationConfiguration CloudWatchLoggingOptions Tags ApplicationMode

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-create-application-request-structure.json",
  "name": "CreateApplicationRequest",
  "description": "CreateApplicationRequest schema from Amazon Managed Service for Apache Flink API",
  "type": "object",
  "properties": {
    "ApplicationName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ApplicationName"
        },
        {
          "description": "The name of your application (for example, <code>sample-app</code>)."
        }
      ]
    },
    "ApplicationDescription": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ApplicationDescription"
        },
        {
          "description": "A summary description of the application."
        }
      ]
    },
    "RuntimeEnvironment": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RuntimeEnvironment"
        },
        {
          "description": "The runtime environment for the application."
        }
      ]
    },
    "ServiceExecutionRole": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RoleARN"
        },
        {
          "description": "The IAM role used by the application to access Kinesis data streams, Kinesis Data Firehose delivery streams, Amazon S3 objects, and other external resources."
        }
      ]
    },
    "ApplicationConfiguration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ApplicationConfiguration"
        },
        {
          "description": "Use this parameter to configure the application."
        }
      ]
    },
    "CloudWatchLoggingOptions": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CloudWatchLoggingOptions"
        },
        {
          "description": "Use this parameter to configure an Amazon CloudWatch log stream to monitor application configuration errors. "
        }
      ]
    },
    "Tags": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Tags"
        },
        {
          "description": "A list of one or more tags to assign to the application. A tag is a key-value pair that identifies an application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50. For more information, see <a href=\"https://docs.aws.amazon.com/kinesisanalytics/latest/java/how-tagging.html\">Using Tagging</a>."
        }
      ]
    },
    "ApplicationMode": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ApplicationMode"
        },
        {
          "description": "Use the <code>STREAMING</code> mode to create a Kinesis Data Analytics For Flink application. To create a Kinesis Data Analytics Studio notebook, use the <code>INTERACTIVE</code> mode."
        }
      ]
    }
  },
  "required": [
    "ApplicationName",
    "RuntimeEnvironment",
    "ServiceExecutionRole"
  ]
}