Package software.amazon.awscdk.services.kinesisanalytics

Interface CfnApplicationReferenceDataSourceV2.ReferenceDataSourceProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnApplicationReferenceDataSourceV2.ReferenceDataSourceProperty.Jsii$Proxy

Enclosing class:

CfnApplicationReferenceDataSourceV2

@Stability(Stable)
public static interface CfnApplicationReferenceDataSourceV2.ReferenceDataSourceProperty
extends software.amazon.jsii.JsiiSerializable

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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationreferencedatasource-referencedatasource.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnApplicationReferenceDataSourceV2.ReferenceDataSourceProperty.Builder	builder()
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 Object	getS3ReferenceDataSource()	Identifies the S3 bucket and object that contains the reference data.
default String	getTableName()	The name of the in-application table to create.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getReferenceSchema

@Stability(Stable)
@NotNull
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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationreferencedatasource-referencedatasource.html#cfn-kinesisanalyticsv2-applicationreferencedatasource-referencedatasource-referenceschema

getS3ReferenceDataSource

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationreferencedatasource-referencedatasource.html#cfn-kinesisanalyticsv2-applicationreferencedatasource-referencedatasource-s3referencedatasource

getTableName

@Stability(Stable)
@Nullable
default String getTableName()

The name of the in-application table to create.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationreferencedatasource-referencedatasource.html#cfn-kinesisanalyticsv2-applicationreferencedatasource-referencedatasource-tablename

builder

@Stability(Stable)
static CfnApplicationReferenceDataSourceV2.ReferenceDataSourceProperty.Builder builder()

Returns:

a CfnApplicationReferenceDataSourceV2.ReferenceDataSourceProperty.Builder of CfnApplicationReferenceDataSourceV2.ReferenceDataSourceProperty