Class: AWSCDK::KinesisAnalytics::CfnApplicationReferenceDataSource::S3ReferenceDataSourceProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
kinesis_analytics/cfn_application_reference_data_source.rb

Overview

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 Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(bucket_arn:, file_key:, reference_role_arn:) ⇒ S3ReferenceDataSourceProperty

Returns a new instance of S3ReferenceDataSourceProperty.

Parameters:

  • bucket_arn (String) —

    Amazon Resource Name (ARN) of the S3 bucket.

  • file_key (String) —

    Object key name containing reference data.

  • reference_role_arn (String) —

    ARN of the IAM role that the service can assume to read data on your behalf.



863
864
865
866
867
868
869
870
 
# File 'kinesis_analytics/cfn_application_reference_data_source.rb', line 863

def initialize(bucket_arn:, file_key:, reference_role_arn:)
  @bucket_arn = bucket_arn
  Jsii::Type.check_type(@bucket_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "bucketArn")
  @file_key = file_key
  Jsii::Type.check_type(@file_key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "fileKey")
  @reference_role_arn = reference_role_arn
  Jsii::Type.check_type(@reference_role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "referenceRoleArn")
end

Instance Attribute Details

#bucket_arn ⇒ String (readonly)

Amazon Resource Name (ARN) of the S3 bucket.

Returns:

  • (String)

See Also:



876
877
878
 
# File 'kinesis_analytics/cfn_application_reference_data_source.rb', line 876

def bucket_arn
  @bucket_arn
end

#file_key ⇒ String (readonly)

Object key name containing reference data.

Returns:

  • (String)

See Also:



881
882
883
 
# File 'kinesis_analytics/cfn_application_reference_data_source.rb', line 881

def file_key
  @file_key
end

#reference_role_arn ⇒ String (readonly)

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)

See Also:



888
889
890
 
# File 'kinesis_analytics/cfn_application_reference_data_source.rb', line 888

def reference_role_arn
  @reference_role_arn
end

Class Method Details

.jsii_properties ⇒ Object 



890
891
892
893
894
895
896
 
# File 'kinesis_analytics/cfn_application_reference_data_source.rb', line 890

def self.jsii_properties
  {
    :bucket_arn => "bucketArn",
    :file_key => "fileKey",
    :reference_role_arn => "referenceRoleArn",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



898
899
900
901
902
903
904
905
906
 
# File 'kinesis_analytics/cfn_application_reference_data_source.rb', line 898

def to_jsii
  result = {}
  result.merge!({
    "bucketArn" => @bucket_arn,
    "fileKey" => @file_key,
    "referenceRoleArn" => @reference_role_arn,
  })
  result.compact
end