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.ReferenceDataSourceDescription

Description

Documentation

data ReferenceDataSourceDescription Source #

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
ID of the reference data source. This is the ID that Amazon Kinesis Analytics assigns when you add the reference data source to your application using the AddApplicationReferenceDataSource operation.
tableName :: Text
The in-application table name created by the specific reference data source configuration.
s3ReferenceDataSourceDescription :: S3ReferenceDataSourceDescription
Provides the S3 bucket name, the object key name that contains the reference data. It also provides the Amazon Resource Name (ARN) of the IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object and populate the in-application reference table.

Instances

Instances details

FromJSON ReferenceDataSourceDescription Source #
Instance details Defined in Amazonka.KinesisAnalytics.Types.ReferenceDataSourceDescription Methods parseJSON :: Value -> Parser ReferenceDataSourceDescription # parseJSONList :: Value -> Parser [ReferenceDataSourceDescription] #
Generic ReferenceDataSourceDescription Source #
Instance details Defined in Amazonka.KinesisAnalytics.Types.ReferenceDataSourceDescription Associated Types type Rep ReferenceDataSourceDescription :: Type -> Type # Methods from :: ReferenceDataSourceDescription -> Rep ReferenceDataSourceDescription x # to :: Rep ReferenceDataSourceDescription x -> ReferenceDataSourceDescription #
Read ReferenceDataSourceDescription Source #
Instance details Defined in Amazonka.KinesisAnalytics.Types.ReferenceDataSourceDescription Methods readsPrec :: Int -> ReadS ReferenceDataSourceDescription # readList :: ReadS [ReferenceDataSourceDescription] # readPrec :: ReadPrec ReferenceDataSourceDescription # readListPrec :: ReadPrec [ReferenceDataSourceDescription] #
Show ReferenceDataSourceDescription Source #
Instance details Defined in Amazonka.KinesisAnalytics.Types.ReferenceDataSourceDescription Methods showsPrec :: Int -> ReferenceDataSourceDescription -> ShowS # show :: ReferenceDataSourceDescription -> String # showList :: [ReferenceDataSourceDescription] -> ShowS #
NFData ReferenceDataSourceDescription Source #
Instance details Defined in Amazonka.KinesisAnalytics.Types.ReferenceDataSourceDescription Methods rnf :: ReferenceDataSourceDescription -> () #
Eq ReferenceDataSourceDescription Source #
Instance details Defined in Amazonka.KinesisAnalytics.Types.ReferenceDataSourceDescription Methods (==) :: ReferenceDataSourceDescription -> ReferenceDataSourceDescription -> Bool # (/=) :: ReferenceDataSourceDescription -> ReferenceDataSourceDescription -> Bool #
Hashable ReferenceDataSourceDescription Source #
Instance details Defined in Amazonka.KinesisAnalytics.Types.ReferenceDataSourceDescription Methods hashWithSalt :: Int -> ReferenceDataSourceDescription -> Int # hash :: ReferenceDataSourceDescription -> Int #
type Rep ReferenceDataSourceDescription Source #
Instance details Defined in Amazonka.KinesisAnalytics.Types.ReferenceDataSourceDescription type Rep ReferenceDataSourceDescription = D1 ('MetaData "ReferenceDataSourceDescription" "Amazonka.KinesisAnalytics.Types.ReferenceDataSourceDescription" "amazonka-kinesis-analytics-2.0-7I8X2DEyFUlG6TCxCRLiwg" '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 #

Arguments

:: Text	`$sel:referenceId:ReferenceDataSourceDescription'`
-> Text	`$sel:tableName:ReferenceDataSourceDescription'`
-> S3ReferenceDataSourceDescription	`$sel:s3ReferenceDataSourceDescription:ReferenceDataSourceDescription'`
-> ReferenceDataSourceDescription

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 - ID of the reference data source. This is the ID that Amazon Kinesis Analytics assigns when you add the reference data source to your application using the AddApplicationReferenceDataSource 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 S3 bucket name, the object key name that contains the reference data. It also provides the Amazon Resource Name (ARN) of the IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object and populate the in-application reference table.

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 #

ID of the reference data source. This is the ID that Amazon Kinesis Analytics assigns when you add the reference data source to your application using the AddApplicationReferenceDataSource 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 S3 bucket name, the object key name that contains the reference data. It also provides the Amazon Resource Name (ARN) of the IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object and populate the in-application reference table.