AWS::KinesisAnalyticsV2::Application

Creates an Amazon Kinesis Data Analytics application. For information about creating a Kinesis Data Analytics application, see Creating an Application.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::KinesisAnalyticsV2::Application",
  "Properties" : {
      "ApplicationConfiguration" : ApplicationConfiguration,
      "ApplicationDescription" : String,
      "ApplicationMode" : String,
      "ApplicationName" : String,
      "RuntimeEnvironment" : String,
      "ServiceExecutionRole" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::KinesisAnalyticsV2::Application
Properties: 
  ApplicationConfiguration: 
    ApplicationConfiguration
  ApplicationDescription: String
  ApplicationMode: String
  ApplicationName: String
  RuntimeEnvironment: String
  ServiceExecutionRole: String
  Tags: 
    - Tag

Properties

ApplicationConfiguration

Use this parameter to configure the application.

Required: No

Type: ApplicationConfiguration

Update requires: No interruption

ApplicationDescription

The description of the application.

Required: No

Type: String

Minimum: 0

Maximum: 1024

Update requires: No interruption

ApplicationMode

To create a Kinesis Data Analytics Studio notebook, you must set the mode to INTERACTIVE. However, for a Kinesis Data Analytics for Apache Flink application, the mode is optional.

Required: No

Type: String

Allowed values: INTERACTIVE | STREAMING

Update requires: Replacement

ApplicationName

The name of the application.

Required: No

Type: String

Minimum: 1

Maximum: 128

Pattern: [a-zA-Z0-9_.-]+

Update requires: Replacement

RuntimeEnvironment

The runtime environment for the application (SQL-1_0, FLINK-1_6, FLINK-1_8, or FLINK-1_11).

Required: Yes

Type: String

Allowed values: FLINK-1_11 | FLINK-1_6 | FLINK-1_8 | SQL-1_0 | ZEPPELIN-FLINK-1_0

Update requires: Replacement

ServiceExecutionRole

Specifies the IAM role that the application uses to access external resources.

Required: Yes

Type: String

Minimum: 1

Maximum: 2048

Pattern: arn:.*

Update requires: No interruption

Tags

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.

Required: No

Type: List of Tag

Update requires: No interruption

Examples

Create an application

JSON

{ "Description": "Sample KinesisAnalytics via CloudFormation",
                "Resources": { "BasicApplication": { "Type": "AWS::KinesisAnalyticsV2::Application",
                "Properties": { "ApplicationName": "sampleApplication", "ApplicationDescription":
                "SampleApp", "RuntimeEnvironment": "SQL-1_0", "ServiceExecutionRole": {
                "Fn::GetAtt": [ "ServiceExecutionRole", "Arn" ] }, "ApplicationConfiguration": {
                "SqlApplicationConfiguration": { "Inputs": [ { "NamePrefix": "exampleNamePrefix",
                "InputSchema": { "RecordColumns": [ { "Name": "example", "SqlType": "VARCHAR(16)",
                "Mapping": "$.example" } ], "RecordFormat": { "RecordFormatType": "JSON",
                "MappingParameters": { "JSONMappingParameters": { "RecordRowPath": "$" } } } },
                "KinesisStreamsInput": { "ResourceARN": { "Fn::GetAtt": [ "InputKinesisStream",
                "Arn" ] } } } ] }, "ApplicationCodeConfiguration": { "CodeContent": { "TextContent":
                "Example Application Code" }, "CodeContentType": "PLAINTEXT" } } } },
                "ServiceExecutionRole": { "Type": "AWS::IAM::Role", "Properties": {
                "AssumeRolePolicyDocument": { "Version": "2012-10-17", "Statement": [ { "Effect":
                "Allow", "Principal": { "Service": "kinesisanalytics.amazonaws.com" }, "Action":
                "sts:AssumeRole" } ] }, "Path": "/", "Policies": [ { "PolicyName": "Open",
                "PolicyDocument": { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow",
                "Action": "*", "Resource": "*" } ] } } ] } }, "InputKinesisStream": { "Type":
                "AWS::Kinesis::Stream", "Properties": { "ShardCount": 1 } }, "KinesisAnalyticsRole":
                { "Type": "AWS::IAM::Role", "Properties": { "AssumeRolePolicyDocument": { "Version":
                "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "Service":
                "kinesisanalytics.amazonaws.com" }, "Action": "sts:AssumeRole" } ] }, "Path": "/",
                "Policies": [ { "PolicyName": "Open", "PolicyDocument": { "Version": "2012-10-17",
                "Statement": [ { "Effect": "Allow", "Action": "*", "Resource": "*" } ] } } ] } },
                "BasicApplicationOutputs": { "Type": "AWS::KinesisAnalyticsV2::ApplicationOutput",
                "DependsOn": "BasicApplication", "Properties": { "ApplicationName": { "Ref":
                "BasicApplication" }, "Output": { "Name": "exampleOutput", "DestinationSchema": {
                "RecordFormatType": "CSV" }, "KinesisStreamsOutput": { "ResourceARN": {
                "Fn::GetAtt": [ "OutputKinesisStream", "Arn" ] } } } } }, "OutputKinesisStream": {
                "Type": "AWS::Kinesis::Stream", "Properties": { "ShardCount": 1 } },
                "BasicApplicationReferenceDataSource": { "Type":
                "AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource", "DependsOn":
                "BasicApplicationOutputs", "Properties": { "ApplicationName": { "Ref":
                "BasicApplication" }, "ReferenceDataSource": { "TableName": "exampleTable",
                "ReferenceSchema": { "RecordColumns": [ { "Name": "example", "SqlType":
                "VARCHAR(16)", "Mapping": "$.example" } ], "RecordFormat": { "RecordFormatType":
                "JSON", "MappingParameters": { "JSONMappingParameters": { "RecordRowPath": "$" } } }
                }, "S3ReferenceDataSource": { "BucketARN": { "Fn::GetAtt": [ "S3Bucket", "Arn" ] },
                "FileKey": "fakeKey" } } } }, "S3Bucket": { "Type": "AWS::S3::Bucket" } },
                "Outputs": { "ApplicationPhysicalResourceId": { "Value": { "Ref": "BasicApplication"
                } } } } 

YAML

Description: Sample KinesisAnalytics via CloudFormation
                Description: Sample KinesisAnalytics via CloudFormation Resources: BasicApplication:
                Type: 'AWS::KinesisAnalyticsV2::Application' Properties: ApplicationName:
                sampleApplication ApplicationDescription: SampleApp RuntimeEnvironment: SQL-1_0
                ServiceExecutionRole: !GetAtt - ServiceExecutionRole - Arn ApplicationConfiguration:
                SqlApplicationConfiguration: Inputs: - NamePrefix: exampleNamePrefix InputSchema:
                RecordColumns: - Name: example SqlType: VARCHAR(16) Mapping: $.example RecordFormat:
                RecordFormatType: JSON MappingParameters: JSONMappingParameters: RecordRowPath: $
                KinesisStreamsInput: ResourceARN: !GetAtt - InputKinesisStream - Arn
                ApplicationCodeConfiguration: CodeContent: TextContent: Example Application Code
                CodeContentType: PLAINTEXT ServiceExecutionRole: Type: 'AWS::IAM::Role' Properties:
                AssumeRolePolicyDocument: Version: 2012-10-17 Statement: - Effect: Allow Principal:
                Service: kinesisanalytics.amazonaws.com Action: 'sts:AssumeRole' Path: / Policies: -
                PolicyName: Open PolicyDocument: Version: 2012-10-17 Statement: - Effect: Allow
                Action: '*' Resource: '*' InputKinesisStream: Type: 'AWS::Kinesis::Stream'
                Properties: ShardCount: 1 KinesisAnalyticsRole: Type: 'AWS::IAM::Role' Properties:
                AssumeRolePolicyDocument: Version: 2012-10-17 Statement: - Effect: Allow Principal:
                Service: kinesisanalytics.amazonaws.com Action: 'sts:AssumeRole' Path: / Policies: -
                PolicyName: Open PolicyDocument: Version: 2012-10-17 Statement: - Effect: Allow
                Action: '*' Resource: '*' BasicApplicationOutputs: Type:
                'AWS::KinesisAnalyticsV2::ApplicationOutput' DependsOn: BasicApplication Properties:
                ApplicationName: !Ref BasicApplication Output: Name: exampleOutput
                DestinationSchema: RecordFormatType: CSV KinesisStreamsOutput: ResourceARN: !GetAtt
                - OutputKinesisStream - Arn OutputKinesisStream: Type: 'AWS::Kinesis::Stream'
                Properties: ShardCount: 1 BasicApplicationReferenceDataSource: Type:
                'AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource' DependsOn:
                BasicApplicationOutputs Properties: ApplicationName: !Ref BasicApplication
                ReferenceDataSource: TableName: exampleTable ReferenceSchema: RecordColumns: - Name:
                example SqlType: VARCHAR(16) Mapping: $.example RecordFormat: RecordFormatType: JSON
                MappingParameters: JSONMappingParameters: RecordRowPath: $ S3ReferenceDataSource:
                BucketARN: !GetAtt - S3Bucket - Arn FileKey: fakeKey S3Bucket: Type:
                'AWS::S3::Bucket' Outputs: ApplicationPhysicalResourceId: Value: !Ref
                BasicApplication

See also

• CreateApplication in the Amazon Kinesis Data Analytics API Reference