software.amazon.awscdk.services.kinesisanalytics

Interface CfnApplicationReferenceDataSourceV2.ReferenceDataSourceProperty

All Known Implementing Classes:

CfnApplicationReferenceDataSourceV2.ReferenceDataSourceProperty.Jsii$Proxy

Enclosing class:

CfnApplicationReferenceDataSourceV2

public static interface CfnApplicationReferenceDataSourceV2.ReferenceDataSourceProperty

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.kinesisanalytics.*;
 ReferenceDataSourceProperty referenceDataSourceProperty = ReferenceDataSourceProperty.builder()
         .referenceSchema(ReferenceSchemaProperty.builder()
                 .recordColumns(List.of(RecordColumnProperty.builder()
                         .name("name")
                         .sqlType("sqlType")
                         // the properties below are optional
                         .mapping("mapping")
                         .build()))
                 .recordFormat(RecordFormatProperty.builder()
                         .recordFormatType("recordFormatType")
                         // the properties below are optional
                         .mappingParameters(MappingParametersProperty.builder()
                                 .csvMappingParameters(CSVMappingParametersProperty.builder()
                                         .recordColumnDelimiter("recordColumnDelimiter")
                                         .recordRowDelimiter("recordRowDelimiter")
                                         .build())
                                 .jsonMappingParameters(JSONMappingParametersProperty.builder()
                                         .recordRowPath("recordRowPath")
                                         .build())
                                 .build())
                         .build())
                 // the properties below are optional
                 .recordEncoding("recordEncoding")
                 .build())
         // the properties below are optional
         .s3ReferenceDataSource(S3ReferenceDataSourceProperty.builder()
                 .bucketArn("bucketArn")
                 .fileKey("fileKey")
                 .build())
         .tableName("tableName")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnApplicationReferenceDataSourceV2.ReferenceDataSourceProperty.Builder A builder for CfnApplicationReferenceDataSourceV2.ReferenceDataSourceProperty
static class	CfnApplicationReferenceDataSourceV2.ReferenceDataSourceProperty.Jsii$Proxy An implementation for CfnApplicationReferenceDataSourceV2.ReferenceDataSourceProperty

Method Summary

Modifier and Type	Method and Description
static CfnApplicationReferenceDataSourceV2.ReferenceDataSourceProperty.Builder	builder()
java.lang.Object	getReferenceSchema() Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.
default java.lang.Object	getS3ReferenceDataSource() Identifies the S3 bucket and object that contains the reference data.
default java.lang.String	getTableName() The name of the in-application table to create.

Method Detail

getReferenceSchema

java.lang.Object getReferenceSchema()

Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.

getS3ReferenceDataSource

default java.lang.Object getS3ReferenceDataSource()

Identifies the S3 bucket and object that contains the reference data.

A Kinesis Data Analytics application loads reference data only once. If the data changes, you call the UpdateApplication operation to trigger reloading of data into your application.

getTableName

default java.lang.String getTableName()

The name of the in-application table to create.

builder

static CfnApplicationReferenceDataSourceV2.ReferenceDataSourceProperty.Builder builder()

Returns:

a CfnApplicationReferenceDataSourceV2.ReferenceDataSourceProperty.Builder of CfnApplicationReferenceDataSourceV2.ReferenceDataSourceProperty