Skip to content
v2.278.0

S3ReferenceDataSourceProperty Struct ​

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 ​

ts
// 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',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_kinesisanalytics as kinesisanalytics

s3_reference_data_source_property = kinesisanalytics.CfnApplicationReferenceDataSource.S3ReferenceDataSourceProperty(
    bucket_arn="bucketArn",
    file_key="fileKey",
    reference_role_arn="referenceRoleArn"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.kinesisanalytics.*;

S3ReferenceDataSourceProperty s3ReferenceDataSourceProperty = S3ReferenceDataSourceProperty.builder()
        .bucketArn("bucketArn")
        .fileKey("fileKey")
        .referenceRoleArn("referenceRoleArn")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.KinesisAnalytics;

var s3ReferenceDataSourceProperty = new S3ReferenceDataSourceProperty {
    BucketArn = "bucketArn",
    FileKey = "fileKey",
    ReferenceRoleArn = "referenceRoleArn"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

s3ReferenceDataSourceProperty := &S3ReferenceDataSourceProperty{
	BucketArn: jsii.String("bucketArn"),
	FileKey: jsii.String("fileKey"),
	ReferenceRoleArn: jsii.String("referenceRoleArn"),
}

Properties ​

bucketArnstringbucket_arnstrbucketArnStringBucketArnstringBucketArn*string required #
Amazon Resource Name (ARN) of the S3 bucket.
fileKeystringfile_keystrfileKeyStringFileKeystringFileKey*string required #
Object key name containing reference data.
referenceRoleArnstringreference_role_arnstrreferenceRoleArnStringReferenceRoleArnstringReferenceRoleArn*string required #
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.