Class: Aws::Kinesis::Types::RegisterStreamConsumerInput

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

Overview

Note:

When making an API call, you may pass RegisterStreamConsumerInput data as a hash:

{
  stream_arn: "StreamARN", # required
  consumer_name: "ConsumerName", # required
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#consumer_nameString

For a given Kinesis data stream, each consumer must have a unique name. However, consumer names don't have to be unique across data streams.

Returns:

  • (String)

1778
1779
1780
1781
1782
1783
# File 'lib/aws-sdk-kinesis/types.rb', line 1778

class RegisterStreamConsumerInput < Struct.new(
  :stream_arn,
  :consumer_name)
  SENSITIVE = []
  include Aws::Structure
end

#stream_arnString

The ARN of the Kinesis data stream that you want to register the consumer with. For more info, see [Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces].

[1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams

Returns:

  • (String)

1778
1779
1780
1781
1782
1783
# File 'lib/aws-sdk-kinesis/types.rb', line 1778

class RegisterStreamConsumerInput < Struct.new(
  :stream_arn,
  :consumer_name)
  SENSITIVE = []
  include Aws::Structure
end