Struct aws_sdk_kinesisanalytics::types::InputDescription

#[non_exhaustive]
pub struct InputDescription {
    pub input_id: Option<String>,
    pub name_prefix: Option<String>,
    pub in_app_stream_names: Option<Vec<String>>,
    pub input_processing_configuration_description: Option<InputProcessingConfigurationDescription>,
    pub kinesis_streams_input_description: Option<KinesisStreamsInputDescription>,
    pub kinesis_firehose_input_description: Option<KinesisFirehoseInputDescription>,
    pub input_schema: Option<SourceSchema>,
    pub input_parallelism: Option<InputParallelism>,
    pub input_starting_position_configuration: Option<InputStartingPositionConfiguration>,
}

Describes the application input configuration. For more information, see Configuring Application Input.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

input_id: Option<String>

Input ID associated with the application input. This is the ID that Amazon Kinesis Analytics assigns to each input configuration you add to your application.

name_prefix: Option<String>

In-application name prefix.

in_app_stream_names: Option<Vec<String>>

Returns the in-application stream names that are mapped to the stream source.

input_processing_configuration_description: Option<InputProcessingConfigurationDescription>

The description of the preprocessor that executes on records in this input before the application's code is run.

kinesis_streams_input_description: Option<KinesisStreamsInputDescription>

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

kinesis_firehose_input_description: Option<KinesisFirehoseInputDescription>

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

input_schema: Option<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.

input_parallelism: Option<InputParallelism>

Describes the configured parallelism (number of in-application streams mapped to the streaming source).

input_starting_position_configuration: Option<InputStartingPositionConfiguration>

Point at which the application is configured to read from the input stream.

Implementations

impl InputDescription

pub fn input_id(&self) -> Option<&str>

Input ID associated with the application input. This is the ID that Amazon Kinesis Analytics assigns to each input configuration you add to your application.

pub fn name_prefix(&self) -> Option<&str>

In-application name prefix.

pub fn in_app_stream_names(&self) -> &[String]

Returns the in-application stream names that are mapped to the stream source.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .in_app_stream_names.is_none().

pub fn input_processing_configuration_description( &self ) -> Option<&InputProcessingConfigurationDescription>

The description of the preprocessor that executes on records in this input before the application's code is run.

pub fn kinesis_streams_input_description( &self ) -> Option<&KinesisStreamsInputDescription>

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

pub fn kinesis_firehose_input_description( &self ) -> Option<&KinesisFirehoseInputDescription>

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

pub fn input_schema(&self) -> Option<&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.

pub fn input_parallelism(&self) -> Option<&InputParallelism>

Describes the configured parallelism (number of in-application streams mapped to the streaming source).

pub fn input_starting_position_configuration( &self ) -> Option<&InputStartingPositionConfiguration>

Point at which the application is configured to read from the input stream.

impl InputDescription

pub fn builder() -> InputDescriptionBuilder

Creates a new builder-style object to manufacture InputDescription.

Trait Implementations

impl Clone for InputDescription

fn clone(&self) -> InputDescription

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for InputDescription

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for InputDescription

fn eq(&self, other: &InputDescription) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for InputDescription