Class: Aws::Kinesis::Types::Record

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb

Overview

The unit of data of the Kinesis data stream, which is composed of a sequence number, a partition key, and a data blob.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#approximate_arrival_timestamp ⇒ Time

The approximate time that the record was inserted into the stream.

Returns:

  • (Time) 


2558
2559
2560
2561
2562
2563
2564
2565
2566
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 2558

class Record < Struct.new(
  :sequence_number,
  :approximate_arrival_timestamp,
  :data,
  :partition_key,
  :encryption_type)
  SENSITIVE = []
  include Aws::Structure
end

#data ⇒ String

The data blob. The data in the blob is both opaque and immutable to Kinesis Data Streams, which does not inspect, interpret, or change the data in the blob in any way. 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 (10 MiB).

Returns:

  • (String) 


2558
2559
2560
2561
2562
2563
2564
2565
2566
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 2558

class Record < Struct.new(
  :sequence_number,
  :approximate_arrival_timestamp,
  :data,
  :partition_key,
  :encryption_type)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_type ⇒ String

The encryption type used on the record. This parameter can be one of the following values:

  • NONE: Do not encrypt the records in the stream.

  • KMS: Use server-side encryption on the records in the stream using a customer-managed Amazon Web Services KMS key.

Returns:

  • (String) 


2558
2559
2560
2561
2562
2563
2564
2565
2566
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 2558

class Record < Struct.new(
  :sequence_number,
  :approximate_arrival_timestamp,
  :data,
  :partition_key,
  :encryption_type)
  SENSITIVE = []
  include Aws::Structure
end

#partition_key ⇒ String

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

For a stream that uses the AUTO record distribution strategy, this value is not returned if the producer did not provide a partition key when writing the record. If the producer provided a partition key, the original value is returned even though it was not used to determine shard placement.

Returns:

  • (String) 


2558
2559
2560
2561
2562
2563
2564
2565
2566
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 2558

class Record < Struct.new(
  :sequence_number,
  :approximate_arrival_timestamp,
  :data,
  :partition_key,
  :encryption_type)
  SENSITIVE = []
  include Aws::Structure
end

#sequence_number ⇒ String

The unique identifier of the record within its shard.

Returns:

  • (String) 


2558
2559
2560
2561
2562
2563
2564
2565
2566
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 2558

class Record < Struct.new(
  :sequence_number,
  :approximate_arrival_timestamp,
  :data,
  :partition_key,
  :encryption_type)
  SENSITIVE = []
  include Aws::Structure
end