Package software.amazon.awscdk.services.kinesisanalytics

Interface CfnApplicationV2.InputSchemaProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnApplicationV2.InputSchemaProperty.Jsii$Proxy

Enclosing class:

CfnApplicationV2

@Stability(Stable)
public static interface CfnApplicationV2.InputSchemaProperty
extends software.amazon.jsii.JsiiSerializable

For a SQL-based Kinesis Data Analytics application, 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.

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.*;
 InputSchemaProperty inputSchemaProperty = InputSchemaProperty.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();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnApplicationV2.InputSchemaProperty.Builder	builder()
Object	getRecordColumns()	A list of RecordColumn objects.
default String	getRecordEncoding()	Specifies the encoding of the records in the streaming source.
Object	getRecordFormat()	Specifies the format of the records on the streaming source.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRecordColumns

@Stability(Stable)
@NotNull
Object getRecordColumns()

A list of RecordColumn objects.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-inputschema.html#cfn-kinesisanalyticsv2-application-inputschema-recordcolumns

getRecordFormat

@Stability(Stable)
@NotNull
Object getRecordFormat()

Specifies the format of the records on the streaming source.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-inputschema.html#cfn-kinesisanalyticsv2-application-inputschema-recordformat

getRecordEncoding

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

Specifies the encoding of the records in the streaming source.

For example, UTF-8.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-inputschema.html#cfn-kinesisanalyticsv2-application-inputschema-recordencoding

builder

@Stability(Stable)
static CfnApplicationV2.InputSchemaProperty.Builder builder()

Returns:

a CfnApplicationV2.InputSchemaProperty.Builder of CfnApplicationV2.InputSchemaProperty