Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.KinesisAnalytics.Types.ReferenceDataSource

Description

Documentation

data ReferenceDataSource Source #

Describes the reference data source by providing the source information (S3 bucket name and object key name), the resulting in-application table name that is created, and the necessary schema to map the data elements in the Amazon S3 object to the in-application table.

See: newReferenceDataSource smart constructor.

Constructors

ReferenceDataSource'

Fields

s3ReferenceDataSource :: Maybe S3ReferenceDataSource
Identifies the S3 bucket and object that contains the reference data. Also identifies the IAM role Amazon Kinesis Analytics can assume to read this object on your behalf. An Amazon Kinesis Analytics application loads reference data only once. If the data changes, you call the UpdateApplication operation to trigger reloading of data into your application.
tableName :: Text
Name of the in-application table to create.
referenceSchema :: 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.

Instances

Instances details

ToJSON ReferenceDataSource Source #
Instance details Defined in Amazonka.KinesisAnalytics.Types.ReferenceDataSource Methods toJSON :: ReferenceDataSource -> Value # toEncoding :: ReferenceDataSource -> Encoding # toJSONList :: [ReferenceDataSource] -> Value # toEncodingList :: [ReferenceDataSource] -> Encoding #
Generic ReferenceDataSource Source #
Instance details Defined in Amazonka.KinesisAnalytics.Types.ReferenceDataSource Associated Types type Rep ReferenceDataSource :: Type -> Type # Methods from :: ReferenceDataSource -> Rep ReferenceDataSource x # to :: Rep ReferenceDataSource x -> ReferenceDataSource #
Read ReferenceDataSource Source #
Instance details Defined in Amazonka.KinesisAnalytics.Types.ReferenceDataSource Methods readsPrec :: Int -> ReadS ReferenceDataSource # readList :: ReadS [ReferenceDataSource] # readPrec :: ReadPrec ReferenceDataSource # readListPrec :: ReadPrec [ReferenceDataSource] #
Show ReferenceDataSource Source #
Instance details Defined in Amazonka.KinesisAnalytics.Types.ReferenceDataSource Methods showsPrec :: Int -> ReferenceDataSource -> ShowS # show :: ReferenceDataSource -> String # showList :: [ReferenceDataSource] -> ShowS #
NFData ReferenceDataSource Source #
Instance details Defined in Amazonka.KinesisAnalytics.Types.ReferenceDataSource Methods rnf :: ReferenceDataSource -> () #
Eq ReferenceDataSource Source #
Instance details Defined in Amazonka.KinesisAnalytics.Types.ReferenceDataSource Methods (==) :: ReferenceDataSource -> ReferenceDataSource -> Bool # (/=) :: ReferenceDataSource -> ReferenceDataSource -> Bool #
Hashable ReferenceDataSource Source #
Instance details Defined in Amazonka.KinesisAnalytics.Types.ReferenceDataSource Methods hashWithSalt :: Int -> ReferenceDataSource -> Int # hash :: ReferenceDataSource -> Int #
type Rep ReferenceDataSource Source #
Instance details Defined in Amazonka.KinesisAnalytics.Types.ReferenceDataSource type Rep ReferenceDataSource = D1 ('MetaData "ReferenceDataSource" "Amazonka.KinesisAnalytics.Types.ReferenceDataSource" "amazonka-kinesis-analytics-2.0-7I8X2DEyFUlG6TCxCRLiwg" 'False) (C1 ('MetaCons "ReferenceDataSource'" 'PrefixI 'True) (S1 ('MetaSel ('Just "s3ReferenceDataSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3ReferenceDataSource)) :: (S1 ('MetaSel ('Just "tableName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "referenceSchema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SourceSchema))))

newReferenceDataSource Source #

Arguments

:: Text	`$sel:tableName:ReferenceDataSource'`
-> SourceSchema	`$sel:referenceSchema:ReferenceDataSource'`
-> ReferenceDataSource

Create a value of ReferenceDataSource 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:s3ReferenceDataSource:ReferenceDataSource', referenceDataSource_s3ReferenceDataSource - Identifies the S3 bucket and object that contains the reference data. Also identifies the IAM role Amazon Kinesis Analytics can assume to read this object on your behalf. An Amazon Kinesis Analytics application loads reference data only once. If the data changes, you call the UpdateApplication operation to trigger reloading of data into your application.

$sel:tableName:ReferenceDataSource', referenceDataSource_tableName - Name of the in-application table to create.

$sel:referenceSchema:ReferenceDataSource', referenceDataSource_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.

referenceDataSource_s3ReferenceDataSource :: Lens' ReferenceDataSource (Maybe S3ReferenceDataSource) Source #

Identifies the S3 bucket and object that contains the reference data. Also identifies the IAM role Amazon Kinesis Analytics can assume to read this object on your behalf. An Amazon Kinesis Analytics application loads reference data only once. If the data changes, you call the UpdateApplication operation to trigger reloading of data into your application.

referenceDataSource_tableName :: Lens' ReferenceDataSource Text Source #

Name of the in-application table to create.

referenceDataSource_referenceSchema :: Lens' ReferenceDataSource 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.