software.amazon.awscdk.services.kinesisanalytics

Interface CfnApplication.InputProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnApplication.InputProperty.Jsii$Proxy

Enclosing class:

CfnApplication

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

When you configure the application input, you specify the streaming source, the in-application stream name that is created, and the mapping between the two.

For more information, see Configuring Application Input .

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.*;
 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")
                         .roleArn("roleArn")
                         .build())
                 .build())
         .kinesisFirehoseInput(KinesisFirehoseInputProperty.builder()
                 .resourceArn("resourceArn")
                 .roleArn("roleArn")
                 .build())
         .kinesisStreamsInput(KinesisStreamsInputProperty.builder()
                 .resourceArn("resourceArn")
                 .roleArn("roleArn")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnApplication.InputProperty.Builder	builder()
default Object	getInputParallelism() Describes the number of in-application streams to create.
default Object	getInputProcessingConfiguration() The [InputProcessingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputprocessingconfiguration.html) 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 Firehose delivery stream, identifies the delivery stream's ARN and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.
default Object	getKinesisStreamsInput() If the streaming source is an Amazon Kinesis stream, identifies the stream's Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.
String	getNamePrefix() Name prefix to use when creating an in-application stream.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getInputSchema

@Stability(value=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(value=Stable)
 @NotNull
String getNamePrefix()

Name prefix to use when creating an in-application stream.

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

getInputParallelism

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

Describes the number of in-application streams to create.

Data from your source is routed to these in-application input streams.

See Configuring Application Input .

getInputProcessingConfiguration

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

The [InputProcessingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputprocessingconfiguration.html) 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputlambdaprocessor.html) .

getKinesisFirehoseInput

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

If the streaming source is an Amazon Kinesis Firehose delivery stream, identifies the delivery stream's ARN and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.

Note: Either KinesisStreamsInput or KinesisFirehoseInput is required.

getKinesisStreamsInput

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

If the streaming source is an Amazon Kinesis stream, identifies the stream's Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.

Note: Either KinesisStreamsInput or KinesisFirehoseInput is required.

builder

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

Returns:

a CfnApplication.InputProperty.Builder of CfnApplication.InputProperty