Package software.amazon.awscdk.services.kinesisanalytics

Interface CfnApplicationReferenceDataSource.ReferenceDataSourceProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnApplicationReferenceDataSource.ReferenceDataSourceProperty.Jsii$Proxy

Enclosing class:

CfnApplicationReferenceDataSource

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

Describes the reference data source by providing the source information (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")
                 .referenceRoleArn("referenceRoleArn")
                 .build())
         .tableName("tableName")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnApplicationReferenceDataSource.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()	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-kinesisanalytics-applicationreferencedatasource-referencedatasource.html#cfn-kinesisanalytics-applicationreferencedatasource-referencedatasource-referenceschema

getS3ReferenceDataSource

@Stability(Stable)
@Nullable
default Object getS3ReferenceDataSource()

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

Also identifies the IAM role Amazon Kinesis Analytics can assume to read this object on your behalf. An Amazon Kinesis 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-kinesisanalytics-applicationreferencedatasource-referencedatasource.html#cfn-kinesisanalytics-applicationreferencedatasource-referencedatasource-s3referencedatasource

getTableName

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

Name of the in-application table to create.

See Also:

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

builder

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

Returns:

a CfnApplicationReferenceDataSource.ReferenceDataSourceProperty.Builder of CfnApplicationReferenceDataSource.ReferenceDataSourceProperty