Class: AWSCDK::QLDB::CfnStream::KinesisConfigurationProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::QLDB::CfnStream::KinesisConfigurationProperty

Defined in:

qldb/cfn_stream.rb

Overview

The configuration settings of the Amazon Kinesis Data Streams destination for an Amazon QLDB journal stream.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qldb-stream-kinesisconfiguration.html

Instance Attribute Summary

• #aggregation_enabled ⇒ Boolean, ... readonly

  Enables QLDB to publish multiple data records in a single Kinesis Data Streams record, increasing the number of records sent per API call.

• #stream_arn ⇒ String^? readonly

  The Amazon Resource Name (ARN) of the Kinesis Data Streams resource.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(aggregation_enabled: nil, stream_arn: nil) ⇒ KinesisConfigurationProperty constructor

  A new instance of KinesisConfigurationProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(aggregation_enabled: nil, stream_arn: nil) ⇒ KinesisConfigurationProperty

Returns a new instance of KinesisConfigurationProperty.

Parameters:

• aggregation_enabled (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

  Enables QLDB to publish multiple data records in a single Kinesis Data Streams record, increasing the number of records sent per API call.

• stream_arn (String, nil) (defaults to: nil) —

  The Amazon Resource Name (ARN) of the Kinesis Data Streams resource.

# File 'qldb/cfn_stream.rb', line 613

def initialize(aggregation_enabled: nil, stream_arn: nil)
  @aggregation_enabled = aggregation_enabled
  Jsii::Type.check_type(@aggregation_enabled, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "aggregationEnabled") unless @aggregation_enabled.nil?
  @stream_arn = stream_arn
  Jsii::Type.check_type(@stream_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "streamArn") unless @stream_arn.nil?
end

Instance Attribute Details

#aggregation_enabled ⇒ Boolean, ... (readonly)

Enables QLDB to publish multiple data records in a single Kinesis Data Streams record, increasing the number of records sent per API call.

Default: True

Record aggregation has important implications for processing records and requires de-aggregation in your stream consumer. To learn more, see KPL Key Concepts and Consumer De-aggregation in the Amazon Kinesis Data Streams Developer Guide .

Returns:

• (Boolean, AWSCDK::IResolvable, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qldb-stream-kinesisconfiguration.html#cfn-qldb-stream-kinesisconfiguration-aggregationenabled

# File 'qldb/cfn_stream.rb', line 628

def aggregation_enabled
  @aggregation_enabled
end

#stream_arn ⇒ String^? (readonly)

The Amazon Resource Name (ARN) of the Kinesis Data Streams resource.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qldb-stream-kinesisconfiguration.html#cfn-qldb-stream-kinesisconfiguration-streamarn

# File 'qldb/cfn_stream.rb', line 633

def stream_arn
  @stream_arn
end

Class Method Details

.jsii_properties ⇒ Object

# File 'qldb/cfn_stream.rb', line 635

def self.jsii_properties
  {
    :aggregation_enabled => "aggregationEnabled",
    :stream_arn => "streamArn",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'qldb/cfn_stream.rb', line 642

def to_jsii
  result = {}
  result.merge!({
    "aggregationEnabled" => @aggregation_enabled,
    "streamArn" => @stream_arn,
  })
  result.compact
end