AWS::KinesisAnalyticsV2::ApplicationOutput - AWS CloudFormation
SyntaxPropertiesReturn valuesExamplesSee also

AWS::KinesisAnalyticsV2::ApplicationOutput

Adds an external destination to your SQL-based Amazon Kinesis Data Analytics application.

If you want Kinesis Data Analytics to deliver data from an in-application stream within your application to an external destination (such as an Kinesis data stream, a Kinesis Data Firehose delivery stream, or an Amazon Lambda function), you add the relevant configuration to your application using this operation. You can configure one or more outputs for your application. Each output configuration maps an in-application stream and an external destination.

You can use one of the output configurations to deliver data from your in-application error stream to an external destination so that you can analyze the errors.

Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application version.

Note

Creation of multiple outputs should be sequential (use of DependsOn) to avoid a problem with a stale application version (ConcurrentModificationException).

Syntax

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

JSON

{
  "Type" : "AWS::KinesisAnalyticsV2::ApplicationOutput",
  "Properties" : {
      "ApplicationName" : String,
      "Output" : Output
    }
}

YAML

Type: AWS::KinesisAnalyticsV2::ApplicationOutput
Properties:
  ApplicationName: String
  Output: 
    Output

Properties

ApplicationName

The name of the application.

Required: Yes

Type: String

Update requires: Replacement

Output

Describes a SQL-based Kinesis Data Analytics application's output configuration, in which you identify an in-application stream and a destination where you want the in-application stream data to be written. The destination can be a Kinesis data stream or a Kinesis Data Firehose delivery stream.

Required: Yes

Type: Output

Update requires: No interruption

Return values

Fn::GetAtt

Examples

Create an ApplicationOutput object

JSON

{
    "Type": "AWS::KinesisAnalyticsV2::ApplicationOutput",
    "Properties": {
        "ApplicationName": {
            "Ref": "BasicApplication"
        },
        "Output": {
            "Name": "exampleOutput",
            "DestinationSchema": {
                "RecordFormatType": "CSV"
            },
            "KinesisStreamsOutput": {
                "ResourceARN": {
                    "Fn::GetAtt": [
                        "OutputKinesisStream",
                        "Arn"
                    ]
                }
            }
        }
    }
}

YAML

Type: AWS::KinesisAnalyticsV2::ApplicationOutput
Properties:
  ApplicationName:
    Ref: BasicApplication
  Output:
    Name: exampleOutput
    DestinationSchema:
      RecordFormatType: CSV
    KinesisStreamsOutput:
      ResourceARN:
        Fn::GetAtt:
        - OutputKinesisStream
        - Arn

See also