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

Description

 
Synopsis

Documentation

data ReferenceDataSourceUpdate Source #

When you update a reference data source configuration for a SQL-based Kinesis Data Analytics application, this object provides all the updated values (such as the source bucket name and object key name), the in-application table name that is created, and updated mapping information that maps the data in the Amazon S3 object to the in-application reference table that is created.

See: newReferenceDataSourceUpdate smart constructor.

Constructors

ReferenceDataSourceUpdate' 

Fields

  • referenceSchemaUpdate :: 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.

  • s3ReferenceDataSourceUpdate :: Maybe S3ReferenceDataSourceUpdate

    Describes the S3 bucket name, object key name, and IAM role that Kinesis Data Analytics can assume to read the Amazon S3 object on your behalf and populate the in-application reference table.

  • tableNameUpdate :: Maybe Text

    The in-application table name that is created by this update.

  • referenceId :: Text

    The ID of the reference data source that is being updated. You can use the DescribeApplication operation to get this value.

Instances

Instances details
ToJSON ReferenceDataSourceUpdate Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.Types.ReferenceDataSourceUpdate

Generic ReferenceDataSourceUpdate Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.Types.ReferenceDataSourceUpdate

Associated Types

type Rep ReferenceDataSourceUpdate :: Type -> Type #

Read ReferenceDataSourceUpdate Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.Types.ReferenceDataSourceUpdate

Show ReferenceDataSourceUpdate Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.Types.ReferenceDataSourceUpdate

NFData ReferenceDataSourceUpdate Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.Types.ReferenceDataSourceUpdate

Eq ReferenceDataSourceUpdate Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.Types.ReferenceDataSourceUpdate

Hashable ReferenceDataSourceUpdate Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.Types.ReferenceDataSourceUpdate

type Rep ReferenceDataSourceUpdate Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.Types.ReferenceDataSourceUpdate

type Rep ReferenceDataSourceUpdate = D1 ('MetaData "ReferenceDataSourceUpdate" "Amazonka.KinesisAnalyticsV2.Types.ReferenceDataSourceUpdate" "amazonka-kinesisanalyticsv2-2.0-EuRTRS4ROZrHrkll3mMtCB" 'False) (C1 ('MetaCons "ReferenceDataSourceUpdate'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "referenceSchemaUpdate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SourceSchema)) :*: S1 ('MetaSel ('Just "s3ReferenceDataSourceUpdate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3ReferenceDataSourceUpdate))) :*: (S1 ('MetaSel ('Just "tableNameUpdate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "referenceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newReferenceDataSourceUpdate Source #

Create a value of ReferenceDataSourceUpdate 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:referenceSchemaUpdate:ReferenceDataSourceUpdate', referenceDataSourceUpdate_referenceSchemaUpdate - 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:s3ReferenceDataSourceUpdate:ReferenceDataSourceUpdate', referenceDataSourceUpdate_s3ReferenceDataSourceUpdate - Describes the S3 bucket name, object key name, and IAM role that Kinesis Data Analytics can assume to read the Amazon S3 object on your behalf and populate the in-application reference table.

$sel:tableNameUpdate:ReferenceDataSourceUpdate', referenceDataSourceUpdate_tableNameUpdate - The in-application table name that is created by this update.

$sel:referenceId:ReferenceDataSourceUpdate', referenceDataSourceUpdate_referenceId - The ID of the reference data source that is being updated. You can use the DescribeApplication operation to get this value.

referenceDataSourceUpdate_referenceSchemaUpdate :: Lens' ReferenceDataSourceUpdate (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.

referenceDataSourceUpdate_s3ReferenceDataSourceUpdate :: Lens' ReferenceDataSourceUpdate (Maybe S3ReferenceDataSourceUpdate) Source #

Describes the S3 bucket name, object key name, and IAM role that Kinesis Data Analytics can assume to read the Amazon S3 object on your behalf and populate the in-application reference table.

referenceDataSourceUpdate_tableNameUpdate :: Lens' ReferenceDataSourceUpdate (Maybe Text) Source #

The in-application table name that is created by this update.

referenceDataSourceUpdate_referenceId :: Lens' ReferenceDataSourceUpdate Text Source #

The ID of the reference data source that is being updated. You can use the DescribeApplication operation to get this value.