You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Kinesis::Types::PutRecordInput

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing PutRecordInput as input to an Aws::Client method, you can use a vanilla Hash:

{
  stream_name: "StreamName", # required
  data: "data", # required
  partition_key: "PartitionKey", # required
  explicit_hash_key: "HashKey",
  sequence_number_for_ordering: "SequenceNumber",
}

Represents the input for PutRecord.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#data ⇒ String

The data blob to put into the record, which is base64-encoded when the blob is serialized. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MiB).

Returns:

  • (String) —

    The data blob to put into the record, which is base64-encoded when the blob is serialized.

#explicit_hash_key ⇒ String

The hash value used to explicitly determine the shard the data record is assigned to by overriding the partition key hash.

Returns:

  • (String) —

    The hash value used to explicitly determine the shard the data record is assigned to by overriding the partition key hash.

#partition_key ⇒ String

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) —

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

#sequence_number_for_ordering ⇒ String

Guarantees strictly increasing sequence numbers, for puts from the same client and to the same partition key. Usage: set the SequenceNumberForOrdering of record n to the sequence number of record n-1 (as returned in the result when putting record n-1). If this parameter is not set, records are coarsely ordered based on arrival time.

Returns:

  • (String) —

    Guarantees strictly increasing sequence numbers, for puts from the same client and to the same partition key.

#stream_name ⇒ String

The name of the stream to put the data record into.

Returns:

  • (String) —

    The name of the stream to put the data record into.