Amplify has re-imagined the way frontend developers build fullstack applications. Develop and deploy without the hassle.

Page updated Apr 16, 2024

Storing analytics data

The Amazon Data Firehose analytics provider allows you to send analytics data to an Amazon Data Firehose stream for reliably storing data.

Setup Firehose stream

The following is an example utilizing the AWS Cloud Development Kit (AWS CDK) to create the Analytics resource powered by Amazon Data Firehose.

Let's create a storage bucket to store the data from the Firehose stream.

import { defineStorage } from "@aws-amplify/backend";
// Define the S3 bucket resource
export const storage = defineStorage({
name: "FirehoseDestinationBucket",

next, let's create the Firehose resource.

import { defineBackend } from "@aws-amplify/backend";
import { auth } from "./auth/resource";
import { data } from "./data/resource";
import { storage } from "./storage/resource";
import { CfnDeliveryStream } from "aws-cdk-lib/aws-kinesisfirehose";
import { Stack } from "aws-cdk-lib/core";
import {
} from "aws-cdk-lib/aws-iam";
const backend = defineBackend({
// additional resources
// Create a new stack for the Firehose resources
const firehoseStack = backend.createStack("firehose-stack");
// Access the S3 bucket resource
const s3Bucket =;
// Create a new IAM role for the Firehose
const firehoseRole = new Role(firehoseStack, "FirehoseRole", {
assumedBy: new ServicePrincipal(""),
// Grant the Firehose role read/write permissions to the S3 bucket
// Create a new Firehose delivery stream
const myFirehose = new CfnDeliveryStream(firehoseStack, "MyFirehose", {
deliveryStreamType: "DirectPut",
s3DestinationConfiguration: {
bucketArn: s3Bucket.bucketArn,
roleArn: firehoseRole.roleArn,
deliveryStreamName: "myFirehose",
// Create a new IAM policy to allow users to write to the Firehose
const firehosePolicy = new Policy(firehoseStack, "FirehosePolicy", {
statements: [
new PolicyStatement({
actions: ["firehose:PutRecordBatch"],
resources: [myFirehose.attrArn],
// Attach the policy to the authenticated and unauthenticated IAM roles

Installation and Configuration

Ensure you have setup IAM permissions for firehose:PutRecordBatch.

Example IAM policy for Amazon Data Firehose:

"Version": "2012-10-17",
"Statement": [{
"Effect": "Allow",
"Action": "firehose:PutRecordBatch",
// replace the template fields
"Resource": "arn:aws:firehose:<your-aws-region>:<your-aws-account-id>:deliverystream/<your-stream-name>"

Configure Firehose:

import { Amplify } from 'aws-amplify';
Analytics: {
KinesisFirehose: {
// REQUIRED - Amazon Kinesis Firehose service region
region: 'us-east-1',
// OPTIONAL - The buffer size for events in number of items.
bufferSize: 1000,
// OPTIONAL - The number of events to be deleted from the buffer when flushed.
flushSize: 100,
// OPTIONAL - The interval in milliseconds to perform a buffer check and flush if necessary.
flushInterval: 5000, // 5s
// OPTIONAL - The limit for failed recording retries.
resendLimit: 5

Storing data

You can send a data to a Firehose stream with the standard record method. Any data is acceptable and streamName is required:

import { record } from 'aws-amplify/analytics/kinesis-firehose';
data: {
// The data blob to put into the record
streamName: 'myFirehose'

Flush events

The recorded events are saved in a buffer and sent to the remote server periodically (You can tune it with the flushInterval option). If needed, you have the option to manually clear all the events from the buffer by using the 'flushEvents' API.

import { flushEvents } from 'aws-amplify/analytics/kinesis-firehose';