Package software.amazon.awscdk.services.kinesisanalyticsv2

Interface CfnApplication.InputProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnApplication.InputProperty.Jsii$Proxy

Enclosing class:

CfnApplication

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

When you configure the application input for a SQL-based Kinesis Data Analytics application, you specify the streaming source, the in-application stream name that is created, and the mapping between the two.

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.*;
 InputProperty inputProperty = InputProperty.builder()
         .inputSchema(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())
         .namePrefix("namePrefix")
         // the properties below are optional
         .inputParallelism(InputParallelismProperty.builder()
                 .count(123)
                 .build())
         .inputProcessingConfiguration(InputProcessingConfigurationProperty.builder()
                 .inputLambdaProcessor(InputLambdaProcessorProperty.builder()
                         .resourceArn("resourceArn")
                         .build())
                 .build())
         .kinesisFirehoseInput(KinesisFirehoseInputProperty.builder()
                 .resourceArn("resourceArn")
                 .build())
         .kinesisStreamsInput(KinesisStreamsInputProperty.builder()
                 .resourceArn("resourceArn")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnApplication.InputProperty.Builder	builder()
default Object	getInputParallelism()	Describes the number of in-application streams to create.
default Object	getInputProcessingConfiguration()	The InputProcessingConfiguration for the input.
Object	getInputSchema()	Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created.
default Object	getKinesisFirehoseInput()	If the streaming source is an Amazon Kinesis Data Firehose delivery stream, identifies the delivery stream's ARN.
default Object	getKinesisStreamsInput()	If the streaming source is an Amazon Kinesis data stream, identifies the stream's Amazon Resource Name (ARN).
String	getNamePrefix()	The name prefix to use when creating an in-application stream.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getInputSchema

@Stability(Stable)
@NotNull
Object getInputSchema()

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

Also used to describe the format of the reference data source.

getNamePrefix

@Stability(Stable)
@NotNull
String getNamePrefix()

The name prefix to use when creating an in-application stream.

Suppose that you specify a prefix " MyInApplicationStream ." Kinesis Data Analytics then creates one or more (as per the InputParallelism count you specified) in-application streams with the names " MyInApplicationStream_001 ," " MyInApplicationStream_002 ," and so on.

getInputParallelism

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

Describes the number of in-application streams to create.

getInputProcessingConfiguration

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

The InputProcessingConfiguration for the input. An input processor transforms records as they are received from the stream, before the application's SQL code executes. Currently, the only input processing configuration available is InputLambdaProcessor .

getKinesisFirehoseInput

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

If the streaming source is an Amazon Kinesis Data Firehose delivery stream, identifies the delivery stream's ARN.

getKinesisStreamsInput

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

If the streaming source is an Amazon Kinesis data stream, identifies the stream's Amazon Resource Name (ARN).

builder

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

Returns:

a CfnApplication.InputProperty.Builder of CfnApplication.InputProperty