AWS::Kinesis::StreamConsumer

Kinesis StreamConsumer

Resource Type definition for AWS::Kinesis::StreamConsumer

Properties

3 configurable properties. 2 required. Click a row to see details.

Filter:

Property	Type	Flags
`ConsumerName`	`string`	RequiredCreate-only
`StreamARN`	`string`	RequiredCreate-only
`Tags`	`Array<Tag>`	Create-only

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`ConsumerARN`	`string`	The ARN returned by Kinesis Data Streams when you registered the consumer. If you don't know the ARN of the consumer that you want to deregister, you can use the ListStreamConsumers operation to get a list of the descriptions of all the consumers that are currently registered with a given data st...
`ConsumerCreationTimestamp`	`string`	Timestamp when the consumer was created.
`ConsumerStatus`	`string`	A consumer can't read data while in the CREATING or DELETING states. Valid Values: CREATING \| DELETING \| ACTIVE

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::Kinesis::StreamConsumer

Resources:
  MyResource:
    Type: AWS::Kinesis::StreamConsumer
    Properties:
      ConsumerName: "my-consumername"
      StreamARN: "arn:aws:service:region:account:resource"
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

read

kinesis:DescribeStreamConsumerkinesis:ListTagsForResource

create

kinesis:RegisterStreamConsumerkinesis:DescribeStreamConsumerkinesis:TagResource

list

kinesis:ListStreamConsumers

delete

kinesis:DeregisterStreamConsumerkinesis:DescribeStreamConsumerkinesis:UntagResource

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceKinesis

Properties6

Required2

TaggingSupported

Primary IDConsumerARN

Supported Operations

ReadCreateListDelete

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

ConsumerNameStreamARNTags

Related Resources

External Links

AWS Documentation