amazonka-kinesisanalyticsv2-2.0: Amazon Kinesis Analytics SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.KinesisAnalyticsV2.Types.ReferenceDataSourceDescription

Description

 
Synopsis

Documentation

data ReferenceDataSourceDescription Source #

For a SQL-based Kinesis Data Analytics application, describes the reference data source configured for an application.

See: newReferenceDataSourceDescription smart constructor.

Constructors

ReferenceDataSourceDescription' 

Fields

  • referenceSchema :: Maybe SourceSchema

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

  • referenceId :: Text

    The ID of the reference data source. This is the ID that Kinesis Data Analytics assigns when you add the reference data source to your application using the CreateApplication or UpdateApplication operation.

  • tableName :: Text

    The in-application table name created by the specific reference data source configuration.

  • s3ReferenceDataSourceDescription :: S3ReferenceDataSourceDescription

    Provides the Amazon S3 bucket name, the object key name that contains the reference data.

Instances

Instances details
FromJSON ReferenceDataSourceDescription Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.Types.ReferenceDataSourceDescription

Generic ReferenceDataSourceDescription Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.Types.ReferenceDataSourceDescription

Associated Types

type Rep ReferenceDataSourceDescription :: Type -> Type #

Read ReferenceDataSourceDescription Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.Types.ReferenceDataSourceDescription

Show ReferenceDataSourceDescription Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.Types.ReferenceDataSourceDescription

NFData ReferenceDataSourceDescription Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.Types.ReferenceDataSourceDescription

Eq ReferenceDataSourceDescription Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.Types.ReferenceDataSourceDescription

Hashable ReferenceDataSourceDescription Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.Types.ReferenceDataSourceDescription

type Rep ReferenceDataSourceDescription Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.Types.ReferenceDataSourceDescription

type Rep ReferenceDataSourceDescription = D1 ('MetaData "ReferenceDataSourceDescription" "Amazonka.KinesisAnalyticsV2.Types.ReferenceDataSourceDescription" "amazonka-kinesisanalyticsv2-2.0-EuRTRS4ROZrHrkll3mMtCB" 'False) (C1 ('MetaCons "ReferenceDataSourceDescription'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "referenceSchema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SourceSchema)) :*: S1 ('MetaSel ('Just "referenceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "tableName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "s3ReferenceDataSourceDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 S3ReferenceDataSourceDescription))))

newReferenceDataSourceDescription Source #

Create a value of ReferenceDataSourceDescription with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:referenceSchema:ReferenceDataSourceDescription', referenceDataSourceDescription_referenceSchema - Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.

$sel:referenceId:ReferenceDataSourceDescription', referenceDataSourceDescription_referenceId - The ID of the reference data source. This is the ID that Kinesis Data Analytics assigns when you add the reference data source to your application using the CreateApplication or UpdateApplication operation.

$sel:tableName:ReferenceDataSourceDescription', referenceDataSourceDescription_tableName - The in-application table name created by the specific reference data source configuration.

$sel:s3ReferenceDataSourceDescription:ReferenceDataSourceDescription', referenceDataSourceDescription_s3ReferenceDataSourceDescription - Provides the Amazon S3 bucket name, the object key name that contains the reference data.

referenceDataSourceDescription_referenceSchema :: Lens' ReferenceDataSourceDescription (Maybe SourceSchema) Source #

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

referenceDataSourceDescription_referenceId :: Lens' ReferenceDataSourceDescription Text Source #

The ID of the reference data source. This is the ID that Kinesis Data Analytics assigns when you add the reference data source to your application using the CreateApplication or UpdateApplication operation.

referenceDataSourceDescription_tableName :: Lens' ReferenceDataSourceDescription Text Source #

The in-application table name created by the specific reference data source configuration.

referenceDataSourceDescription_s3ReferenceDataSourceDescription :: Lens' ReferenceDataSourceDescription S3ReferenceDataSourceDescription Source #

Provides the Amazon S3 bucket name, the object key name that contains the reference data.