AWS Fundamentals Logo
AWS Fundamentals
AWS::CognitoSync::Dataset

CognitoSync Dataset

Resource type definition for a Cognito Sync Dataset. A dataset is a collection of key-value pairs per identity that can store up to 1 MB of data and sync across devices.

Properties

3 configurable properties. Click a row to see details.

Filter:
PropertyTypeFlags
DatasetName
string
Create-only
IdentityId
string
Create-only
IdentityPoolId
string
Create-only

Return Values

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

AttributeTypeDescription
ArnstringThe Amazon Resource Name (ARN) of the dataset.
CreationDatestringDate on which the dataset was created.
DataStorageintegerTotal size in bytes of the records in this dataset.
LastModifiedBystringThe device that made the last change to this dataset.
LastModifiedDatestringDate when the dataset was last modified.
NumRecordsintegerNumber of records in this dataset.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::CognitoSync::Dataset

Resources:
  MyResource:
    Type: AWS::CognitoSync::Dataset
    Properties:

Required IAM Permissions

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

read

cognito-sync:DescribeDataset

list

cognito-sync:ListDatasets

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

ServiceCognitoSync
Properties9
Required0
TaggingNot supported
Primary IDArn

Supported Operations

ReadList

Immutable After Creation

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

DatasetNameIdentityIdIdentityPoolId

External Links