aws-cdk-lib.aws_kinesisanalytics.CfnApplicationReferenceDataSource.S3ReferenceDataSourceProperty

interface S3ReferenceDataSourceProperty

LanguageType name
.NETAmazon.CDK.AWS.KinesisAnalytics.CfnApplicationReferenceDataSource.S3ReferenceDataSourceProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awskinesisanalytics#CfnApplicationReferenceDataSource_S3ReferenceDataSourceProperty
Javasoftware.amazon.awscdk.services.kinesisanalytics.CfnApplicationReferenceDataSource.S3ReferenceDataSourceProperty
Pythonaws_cdk.aws_kinesisanalytics.CfnApplicationReferenceDataSource.S3ReferenceDataSourceProperty
TypeScript aws-cdk-lib » aws_kinesisanalytics » CfnApplicationReferenceDataSource » S3ReferenceDataSourceProperty

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.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_kinesisanalytics as kinesisanalytics } from 'aws-cdk-lib';
const s3ReferenceDataSourceProperty: kinesisanalytics.CfnApplicationReferenceDataSource.S3ReferenceDataSourceProperty = {
  bucketArn: 'bucketArn',
  fileKey: 'fileKey',
  referenceRoleArn: 'referenceRoleArn',
};

Properties

NameTypeDescription
bucketArnstringAmazon Resource Name (ARN) of the S3 bucket.
fileKeystringObject key name containing reference data.
referenceRoleArnstringARN of the IAM role that the service can assume to read data on your behalf.

bucketArn

Type: string

Amazon Resource Name (ARN) of the S3 bucket.


fileKey

Type: string

Object key name containing reference data.


referenceRoleArn

Type: string

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.