libZSservicesZSamazonka-kinesis-analyticsZSamazonka-kinesis-analytics
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.KinesisAnalytics.Types.S3ReferenceDataSource

Description

 
Synopsis

Documentation

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

See: newS3ReferenceDataSource smart constructor.

Constructors

S3ReferenceDataSource' 

Fields

  • bucketARN :: Text

    Amazon Resource Name (ARN) of the S3 bucket.

  • fileKey :: Text

    Object key name containing reference data.

  • referenceRoleARN :: Text

    ARN of the IAM role that the service can assume to read data on your behalf. This role must have permission for the s3:GetObject action on the object and trust policy that allows Amazon Kinesis Analytics service principal to assume this role.

Instances

Instances details
Eq S3ReferenceDataSource Source # 
Instance details

Defined in Amazonka.KinesisAnalytics.Types.S3ReferenceDataSource

Read S3ReferenceDataSource Source # 
Instance details

Defined in Amazonka.KinesisAnalytics.Types.S3ReferenceDataSource

Show S3ReferenceDataSource Source # 
Instance details

Defined in Amazonka.KinesisAnalytics.Types.S3ReferenceDataSource

Generic S3ReferenceDataSource Source # 
Instance details

Defined in Amazonka.KinesisAnalytics.Types.S3ReferenceDataSource

Associated Types

type Rep S3ReferenceDataSource :: Type -> Type #

NFData S3ReferenceDataSource Source # 
Instance details

Defined in Amazonka.KinesisAnalytics.Types.S3ReferenceDataSource

Methods

rnf :: S3ReferenceDataSource -> () #

Hashable S3ReferenceDataSource Source # 
Instance details

Defined in Amazonka.KinesisAnalytics.Types.S3ReferenceDataSource

ToJSON S3ReferenceDataSource Source # 
Instance details

Defined in Amazonka.KinesisAnalytics.Types.S3ReferenceDataSource

type Rep S3ReferenceDataSource Source # 
Instance details

Defined in Amazonka.KinesisAnalytics.Types.S3ReferenceDataSource

type Rep S3ReferenceDataSource = D1 ('MetaData "S3ReferenceDataSource" "Amazonka.KinesisAnalytics.Types.S3ReferenceDataSource" "libZSservicesZSamazonka-kinesis-analyticsZSamazonka-kinesis-analytics" 'False) (C1 ('MetaCons "S3ReferenceDataSource'" 'PrefixI 'True) (S1 ('MetaSel ('Just "bucketARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "fileKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "referenceRoleARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newS3ReferenceDataSource Source #

Create a value of S3ReferenceDataSource 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:bucketARN:S3ReferenceDataSource', s3ReferenceDataSource_bucketARN - Amazon Resource Name (ARN) of the S3 bucket.

$sel:fileKey:S3ReferenceDataSource', s3ReferenceDataSource_fileKey - Object key name containing reference data.

$sel:referenceRoleARN:S3ReferenceDataSource', s3ReferenceDataSource_referenceRoleARN - ARN of the IAM role that the service can assume to read data on your behalf. This role must have permission for the s3:GetObject action on the object and trust policy that allows Amazon Kinesis Analytics service principal to assume this role.

s3ReferenceDataSource_bucketARN :: Lens' S3ReferenceDataSource Text Source #

Amazon Resource Name (ARN) of the S3 bucket.

s3ReferenceDataSource_fileKey :: Lens' S3ReferenceDataSource Text Source #

Object key name containing reference data.

s3ReferenceDataSource_referenceRoleARN :: Lens' S3ReferenceDataSource Text Source #

ARN of the IAM role that the service can assume to read data on your behalf. This role must have permission for the s3:GetObject action on the object and trust policy that allows Amazon Kinesis Analytics service principal to assume this role.