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

Class: Aws::Kinesis::Types::Consumer

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

Overview

An object that represents the details of the consumer you registered.

Instance Attribute Summary collapse

Instance Attribute Details

#consumer_arnString

When you register a consumer, Kinesis Data Streams generates an ARN for it. You need this ARN to be able to call SubscribeToShard.

If you delete a consumer and then create a new one with the same name, it won't have the same ARN. That's because consumer ARNs contain the creation timestamp. This is important to keep in mind if you have IAM policies that reference consumer ARNs.

Returns:

  • (String)


66
67
68
69
70
71
72
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 66

class Consumer < Struct.new(
  :consumer_name,
  :consumer_arn,
  :consumer_status,
  :consumer_creation_timestamp)
  include Aws::Structure
end

#consumer_creation_timestampTime

Returns:

  • (Time)


66
67
68
69
70
71
72
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 66

class Consumer < Struct.new(
  :consumer_name,
  :consumer_arn,
  :consumer_status,
  :consumer_creation_timestamp)
  include Aws::Structure
end

#consumer_nameString

The name of the consumer is something you choose when you register the consumer.

Returns:

  • (String)


66
67
68
69
70
71
72
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 66

class Consumer < Struct.new(
  :consumer_name,
  :consumer_arn,
  :consumer_status,
  :consumer_creation_timestamp)
  include Aws::Structure
end

#consumer_statusString

A consumer can't read data while in the CREATING or DELETING states.

Returns:

  • (String)


66
67
68
69
70
71
72
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 66

class Consumer < Struct.new(
  :consumer_name,
  :consumer_arn,
  :consumer_status,
  :consumer_creation_timestamp)
  include Aws::Structure
end