Class CfnApplicationReferenceDataSource

Adds a reference data source to an existing SQL-based Kinesis Data Analytics application.

Inheritance
System.Object
CfnElement
CfnRefElement
CfnResource
CfnApplicationReferenceDataSource
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.KinesisAnalyticsV2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnApplicationReferenceDataSource : CfnResource, IInspectable
Syntax (vb)
Public Class CfnApplicationReferenceDataSource
    Inherits CfnResource
    Implements IInspectable
Remarks

Kinesis Data 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 an Amazon S3 object maps to columns in the resulting in-application table.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalyticsv2-applicationreferencedatasource.html

CloudformationResource: AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.KinesisAnalyticsV2;

var cfnApplicationReferenceDataSource = new CfnApplicationReferenceDataSource(this, "MyCfnApplicationReferenceDataSource", new CfnApplicationReferenceDataSourceProps {
    ApplicationName = "applicationName",
    ReferenceDataSource = new ReferenceDataSourceProperty {
        ReferenceSchema = new ReferenceSchemaProperty {
            RecordColumns = new [] { new RecordColumnProperty {
                Name = "name",
                SqlType = "sqlType",

                // the properties below are optional
                Mapping = "mapping"
            } },
            RecordFormat = new RecordFormatProperty {
                RecordFormatType = "recordFormatType",

                // the properties below are optional
                MappingParameters = new MappingParametersProperty {
                    CsvMappingParameters = new CSVMappingParametersProperty {
                        RecordColumnDelimiter = "recordColumnDelimiter",
                        RecordRowDelimiter = "recordRowDelimiter"
                    },
                    JsonMappingParameters = new JSONMappingParametersProperty {
                        RecordRowPath = "recordRowPath"
                    }
                }
            },

            // the properties below are optional
            RecordEncoding = "recordEncoding"
        },

        // the properties below are optional
        S3ReferenceDataSource = new S3ReferenceDataSourceProperty {
            BucketArn = "bucketArn",
            FileKey = "fileKey"
        },
        TableName = "tableName"
    }
});

Synopsis

Constructors

CfnApplicationReferenceDataSource(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnApplicationReferenceDataSource(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps
CfnApplicationReferenceDataSource(Construct, String, ICfnApplicationReferenceDataSourceProps)

Properties

ApplicationName

The name of the application.
AttrId
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties
ReferenceDataSource

For a SQL-based Kinesis Data Analytics application, describes the reference data source by providing the source information (Amazon S3 bucket name and object key name), the resulting in-application table name that is created, and the necessary schema to map the data elements in the Amazon S3 object to the in-application table.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnApplicationReferenceDataSource(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnApplicationReferenceDataSource(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnApplicationReferenceDataSource(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnApplicationReferenceDataSource(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

CfnApplicationReferenceDataSource(Construct, String, ICfnApplicationReferenceDataSourceProps)

public CfnApplicationReferenceDataSource(Construct scope, string id, ICfnApplicationReferenceDataSourceProps props)
Parameters
scope Constructs.Construct

Scope in which this resource is defined.

id System.String

Construct identifier for this resource (unique in its scope).

props ICfnApplicationReferenceDataSourceProps

Resource properties.

Properties

ApplicationName

The name of the application.

public virtual string ApplicationName { get; set; }
Property Value

System.String

AttrId

public virtual string AttrId { get; }
Property Value

System.String

Remarks

CloudformationAttribute: Id

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

System.String

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

ReferenceDataSource

For a SQL-based Kinesis Data Analytics application, describes the reference data source by providing the source information (Amazon S3 bucket name and object key name), the resulting in-application table name that is created, and the necessary schema to map the data elements in the Amazon S3 object to the in-application table.

public virtual object ReferenceDataSource { get; set; }
Property Value

System.Object

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

RenderProperties(IDictionary<String, Object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

Implements