Package software.amazon.awscdk.mixins.preview.services.kinesisanalytics.mixins

Interface CfnApplicationReferenceDataSourcePropsMixin.S3ReferenceDataSourceProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnApplicationReferenceDataSourcePropsMixin.S3ReferenceDataSourceProperty.Jsii$Proxy

Enclosing class:

CfnApplicationReferenceDataSourcePropsMixin

@Stability(Stable)
public static interface CfnApplicationReferenceDataSourcePropsMixin.S3ReferenceDataSourceProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.mixins.preview.services.kinesisanalytics.mixins.*;
 S3ReferenceDataSourceProperty s3ReferenceDataSourceProperty = S3ReferenceDataSourceProperty.builder()
         .bucketArn("bucketArn")
         .fileKey("fileKey")
         .referenceRoleArn("referenceRoleArn")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-s3referencedatasource.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnApplicationReferenceDataSourcePropsMixin.S3ReferenceDataSourceProperty.Builder	A builder for CfnApplicationReferenceDataSourcePropsMixin.S3ReferenceDataSourceProperty
static final class	CfnApplicationReferenceDataSourcePropsMixin.S3ReferenceDataSourceProperty.Jsii$Proxy	An implementation for CfnApplicationReferenceDataSourcePropsMixin.S3ReferenceDataSourceProperty

Method Summary

Modifier and Type	Method	Description
static CfnApplicationReferenceDataSourcePropsMixin.S3ReferenceDataSourceProperty.Builder	builder()
default String	getBucketArn()	Amazon Resource Name (ARN) of the S3 bucket.
default String	getFileKey()	Object key name containing reference data.
default String	getReferenceRoleArn()	ARN of the IAM role that the service can assume to read data on your behalf.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBucketArn

@Stability(Stable)
@Nullable
default String getBucketArn()

Amazon Resource Name (ARN) of the S3 bucket.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-s3referencedatasource.html#cfn-kinesisanalytics-applicationreferencedatasource-s3referencedatasource-bucketarn

getFileKey

@Stability(Stable)
@Nullable
default String getFileKey()

Object key name containing reference data.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-s3referencedatasource.html#cfn-kinesisanalytics-applicationreferencedatasource-s3referencedatasource-filekey

getReferenceRoleArn

@Stability(Stable)
@Nullable
default String getReferenceRoleArn()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-s3referencedatasource.html#cfn-kinesisanalytics-applicationreferencedatasource-s3referencedatasource-referencerolearn

builder

@Stability(Stable)
static CfnApplicationReferenceDataSourcePropsMixin.S3ReferenceDataSourceProperty.Builder builder()

Returns:

a CfnApplicationReferenceDataSourcePropsMixin.S3ReferenceDataSourceProperty.Builder of CfnApplicationReferenceDataSourcePropsMixin.S3ReferenceDataSourceProperty