Class: AWSCDK::Events::CfnRule::KinesisParametersProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Events::CfnRule::KinesisParametersProperty

Defined in:

events/cfn_rule.rb

Overview

This object enables you to specify a JSON path to extract from the event and use as the partition key for the Amazon Kinesis data stream, so that you can control the shard to which the event goes.

If you do not include this parameter, the default is to use the event_id as the partition key.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-kinesisparameters.html

Instance Attribute Summary

• #partition_key_path ⇒ String readonly

  The JSON path to be extracted from the event and used as the partition key.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(partition_key_path:) ⇒ KinesisParametersProperty constructor

  A new instance of KinesisParametersProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(partition_key_path:) ⇒ KinesisParametersProperty

Returns a new instance of KinesisParametersProperty.

Parameters:

• partition_key_path (String) —

  The JSON path to be extracted from the event and used as the partition key.

# File 'events/cfn_rule.rb', line 1326

def initialize(partition_key_path:)
  @partition_key_path = partition_key_path
  Jsii::Type.check_type(@partition_key_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "partitionKeyPath")
end

Instance Attribute Details

#partition_key_path ⇒ String (readonly)

The JSON path to be extracted from the event and used as the partition key.

For more information, see Amazon Kinesis Streams Key Concepts in the Amazon Kinesis Streams Developer Guide .

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-kinesisparameters.html#cfn-events-rule-kinesisparameters-partitionkeypath

# File 'events/cfn_rule.rb', line 1337

def partition_key_path
  @partition_key_path
end

Class Method Details

.jsii_properties ⇒ Object

# File 'events/cfn_rule.rb', line 1339

def self.jsii_properties
  {
    :partition_key_path => "partitionKeyPath",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'events/cfn_rule.rb', line 1345

def to_jsii
  result = {}
  result.merge!({
    "partitionKeyPath" => @partition_key_path,
  })
  result.compact
end