Package software.amazon.awscdk.services.kinesisanalyticsv2

Interface CfnApplication.RecordFormatProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnApplication.RecordFormatProperty.Jsii$Proxy

Enclosing class:

CfnApplication

@Stability(Stable)
public static interface CfnApplication.RecordFormatProperty
extends software.amazon.jsii.JsiiSerializable

For a SQL-based Kinesis Data Analytics application, describes the record format and relevant mapping information that should be applied to schematize the records on the 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.kinesisanalyticsv2.*;
 RecordFormatProperty recordFormatProperty = 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();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnApplication.RecordFormatProperty.Builder	builder()
default Object	getMappingParameters()	When you configure application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.
String	getRecordFormatType()	The type of record format.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRecordFormatType

@Stability(Stable)
@NotNull
String getRecordFormatType()

The type of record format.

See Also:

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

getMappingParameters

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

When you configure application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.

See Also:

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

builder

@Stability(Stable)
static CfnApplication.RecordFormatProperty.Builder builder()

Returns:

a CfnApplication.RecordFormatProperty.Builder of CfnApplication.RecordFormatProperty