Class: AWSCDK::Pipes::CfnPipe::PipeTargetKinesisStreamParametersProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Pipes::CfnPipe::PipeTargetKinesisStreamParametersProperty

Defined in:

pipes/cfn_pipe.rb

Overview

The parameters for using a Kinesis stream as a target.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetkinesisstreamparameters.html

Instance Attribute Summary

• #partition_key ⇒ String readonly

  Determines which shard in the stream the data record is assigned to.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(partition_key:) ⇒ PipeTargetKinesisStreamParametersProperty constructor

  A new instance of PipeTargetKinesisStreamParametersProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(partition_key:) ⇒ PipeTargetKinesisStreamParametersProperty

Returns a new instance of PipeTargetKinesisStreamParametersProperty.

Parameters:

• partition_key (String) —

  Determines which shard in the stream the data record is assigned to.

# File 'pipes/cfn_pipe.rb', line 3449

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

Instance Attribute Details

#partition_key ⇒ String (readonly)

Determines which shard in the stream the data record is assigned to.

Partition keys are Unicode strings with a maximum length limit of 256 characters for each key. Amazon Kinesis Data Streams uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard. Specifically, an MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetkinesisstreamparameters.html#cfn-pipes-pipe-pipetargetkinesisstreamparameters-partitionkey

# File 'pipes/cfn_pipe.rb', line 3460

def partition_key
  @partition_key
end

Class Method Details

.jsii_properties ⇒ Object

# File 'pipes/cfn_pipe.rb', line 3462

def self.jsii_properties
  {
    :partition_key => "partitionKey",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'pipes/cfn_pipe.rb', line 3468

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