AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the AddApplicationReferenceDataSource operation.

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

Adds a reference data source to an existing application.

Amazon Kinesis Analytics reads reference data (that is, an Amazon S3 object) and creates an in-application table within your application. In the request, you provide the source (S3 bucket name and object key name), name of the in-application table to create, and the necessary mapping information that describes how data in Amazon S3 object maps to columns in the resulting in-application table.

For conceptual information, see Configuring Application Input. For the limits on data sources you can add to your application, see Limits.

This operation requires permissions to perform the kinesisanalytics:AddApplicationOutput action.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.KinesisAnalytics.AmazonKinesisAnalyticsRequest
      Amazon.KinesisAnalytics.Model.AddApplicationReferenceDataSourceRequest

Namespace: Amazon.KinesisAnalytics.Model
Assembly: AWSSDK.KinesisAnalytics.dll
Version: 3.x.y.z

Syntax

C#
public class AddApplicationReferenceDataSourceRequest : AmazonKinesisAnalyticsRequest
         IAmazonWebServiceRequest

The AddApplicationReferenceDataSourceRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property ApplicationName System.String

Gets and sets the property ApplicationName.

Name of an existing application.

Public Property CurrentApplicationVersionId System.Int64

Gets and sets the property CurrentApplicationVersionId.

Version of the application for which you are adding the reference data source. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned.

Public Property ReferenceDataSource Amazon.KinesisAnalytics.Model.ReferenceDataSource

Gets and sets the property ReferenceDataSource.

The reference data source can be an object in your Amazon S3 bucket. Amazon Kinesis Analytics reads the object and copies the data into the in-application table that is created. You provide an S3 bucket, object key name, and the resulting in-application table that is created. You must also provide an IAM role with the necessary permissions that Amazon Kinesis Analytics can assume to read the object from your S3 bucket on your behalf.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5