You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::KinesisAnalytics::Types::Input

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/types.rb

Overview

Note:

When making an API call, you may pass Input data as a hash:

{
  name_prefix: "InAppStreamName", # required
  input_processing_configuration: {
    input_lambda_processor: { # required
      resource_arn: "ResourceARN", # required
      role_arn: "RoleARN", # required
    },
  },
  kinesis_streams_input: {
    resource_arn: "ResourceARN", # required
    role_arn: "RoleARN", # required
  },
  kinesis_firehose_input: {
    resource_arn: "ResourceARN", # required
    role_arn: "RoleARN", # required
  },
  input_parallelism: {
    count: 1,
  },
  input_schema: { # required
    record_format: { # required
      record_format_type: "JSON", # required, accepts JSON, CSV
      mapping_parameters: {
        json_mapping_parameters: {
          record_row_path: "RecordRowPath", # required
        },
        csv_mapping_parameters: {
          record_row_delimiter: "RecordRowDelimiter", # required
          record_column_delimiter: "RecordColumnDelimiter", # required
        },
      },
    },
    record_encoding: "RecordEncoding",
    record_columns: [ # required
      {
        name: "RecordColumnName", # required
        mapping: "RecordColumnMapping",
        sql_type: "RecordColumnSqlType", # required
      },
    ],
  },
}

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.

Instance Attribute Summary collapse

Instance Attribute Details

#input_parallelismTypes::InputParallelism

Describes the number of in-application streams to create.

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

(see Configuring Application Input.



1317
1318
1319
1320
1321
1322
1323
1324
1325
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/types.rb', line 1317

class Input < Struct.new(
  :name_prefix,
  :input_processing_configuration,
  :kinesis_streams_input,
  :kinesis_firehose_input,
  :input_parallelism,
  :input_schema)
  include Aws::Structure
end

#input_processing_configurationTypes::InputProcessingConfiguration

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.



1317
1318
1319
1320
1321
1322
1323
1324
1325
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/types.rb', line 1317

class Input < Struct.new(
  :name_prefix,
  :input_processing_configuration,
  :kinesis_streams_input,
  :kinesis_firehose_input,
  :input_parallelism,
  :input_schema)
  include Aws::Structure
end

#input_schemaTypes::SourceSchema

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.

Returns:



1317
1318
1319
1320
1321
1322
1323
1324
1325
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/types.rb', line 1317

class Input < Struct.new(
  :name_prefix,
  :input_processing_configuration,
  :kinesis_streams_input,
  :kinesis_firehose_input,
  :input_parallelism,
  :input_schema)
  include Aws::Structure
end

#kinesis_firehose_inputTypes::KinesisFirehoseInput

If the streaming source is an Amazon Kinesis Firehose delivery stream, identifies the Firehose 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.



1317
1318
1319
1320
1321
1322
1323
1324
1325
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/types.rb', line 1317

class Input < Struct.new(
  :name_prefix,
  :input_processing_configuration,
  :kinesis_streams_input,
  :kinesis_firehose_input,
  :input_parallelism,
  :input_schema)
  include Aws::Structure
end

#kinesis_streams_inputTypes::KinesisStreamsInput

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.



1317
1318
1319
1320
1321
1322
1323
1324
1325
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/types.rb', line 1317

class Input < Struct.new(
  :name_prefix,
  :input_processing_configuration,
  :kinesis_streams_input,
  :kinesis_firehose_input,
  :input_parallelism,
  :input_schema)
  include Aws::Structure
end

#name_prefixString

Name prefix to use when creating in-application stream. Suppose you specify a prefix "MyInApplicationStream". Amazon Kinesis Analytics will then create one or more (as per the InputParallelism count you specified) in-application streams with names "MyInApplicationStream_001", "MyInApplicationStream_002" and so on.

Returns:

  • (String)


1317
1318
1319
1320
1321
1322
1323
1324
1325
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/types.rb', line 1317

class Input < Struct.new(
  :name_prefix,
  :input_processing_configuration,
  :kinesis_streams_input,
  :kinesis_firehose_input,
  :input_parallelism,
  :input_schema)
  include Aws::Structure
end