AWS::Kinesis::Stream

Kinesis Stream

Resource Type definition for AWS::Kinesis::Stream

Properties

9 configurable properties. Click a row to see details.

Filter:

Property	Type	Flags
`DesiredShardLevelMetrics`	`Array<string>`
`MaxRecordSizeInKiB`	`integer`
`Name`	`string`	Create-only
`RetentionPeriodHours`	`integer`
`ShardCount`	`integer`
`StreamEncryption`	`StreamEncryption`
`StreamModeDetails`	`StreamModeDetails`
`Tags`	`Array<Tag>`
`WarmThroughputMiBps`	`integer`	Write-only

Return Values

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

Attribute	Type	Description
`Arn`	`string`	The Amazon resource name (ARN) of the Kinesis stream
`WarmThroughputObject`	`WarmThroughputObject`	Warm throughput configuration details for the stream. Only present for ON_DEMAND streams.

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::Stream

Resources:
  MyResource:
    Type: AWS::Kinesis::Stream
    Properties:
      Tags:
        - Key: Environment
          Value: Production
      Name: !Ref "AWS::StackName"

Required IAM Permissions

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

create

kinesis:EnableEnhancedMonitoringkinesis:DescribeStreamSummarykinesis:CreateStreamkinesis:IncreaseStreamRetentionPeriodkinesis:StartStreamEncryptionkinesis:AddTagsToStreamkinesis:ListTagsForStreamkinesis:ListTagsForResource

read

kinesis:DescribeStreamSummarykinesis:ListTagsForStreamkinesis:ListTagsForResource

update

kinesis:EnableEnhancedMonitoringkinesis:DisableEnhancedMonitoringkinesis:DescribeStreamSummarykinesis:UpdateShardCountkinesis:UpdateStreamModekinesis:IncreaseStreamRetentionPeriodkinesis:DecreaseStreamRetentionPeriodkinesis:StartStreamEncryption

delete

kinesis:DescribeStreamSummarykinesis:DeleteStreamkinesis:RemoveTagsFromStreamkinesis:UntagResource

list

kinesis:ListStreams

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

Properties11

Required0

TaggingSupported

Primary IDName

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

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

Name

Related Resources

External Links

AWS Documentation