You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::KinesisAnalytics::Types::S3ReferenceDataSource

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/types.rb

Overview

Note:

When making an API call, you may pass S3ReferenceDataSource data as a hash:

{
  bucket_arn: "BucketARN", # required
  file_key: "FileKey", # required
  reference_role_arn: "RoleARN", # required
}

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.

Instance Attribute Summary collapse

Instance Attribute Details

#bucket_arnString

Amazon Resource Name (ARN) of the S3 bucket.

Returns:

  • (String)


2747
2748
2749
2750
2751
2752
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/types.rb', line 2747

class S3ReferenceDataSource < Struct.new(
  :bucket_arn,
  :file_key,
  :reference_role_arn)
  include Aws::Structure
end

#file_keyString

Object key name containing reference data.

Returns:

  • (String)


2747
2748
2749
2750
2751
2752
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/types.rb', line 2747

class S3ReferenceDataSource < Struct.new(
  :bucket_arn,
  :file_key,
  :reference_role_arn)
  include Aws::Structure
end

#reference_role_arnString

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.

Returns:

  • (String)


2747
2748
2749
2750
2751
2752
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/types.rb', line 2747

class S3ReferenceDataSource < Struct.new(
  :bucket_arn,
  :file_key,
  :reference_role_arn)
  include Aws::Structure
end