Sign In to the Console
AWS CloudFormation
User Guide (API Version 2010-05-15)

AWS Documentation » AWS CloudFormation » User Guide » Template Reference » AWS Resource and Property Types Reference » AWS IoT Analytics Resource Types Reference » AWS::IoTAnalytics::Datastore

AWS::IoTAnalytics::Datastore

The AWS::IoTAnalytics::Datastore resource is a repository for messages. For more information, see How to Use AWS IoT Analytics in the AWS IoT Analytics User Guide.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::IoTAnalytics::Datastore",
  "Properties" : {
    "DatastoreName" : String,
    "RetentionPeriod" : RetentionPeriod,
    "Tags" : [ Tag, ... ]
  }
}

YAML

Type: "AWS::IoTAnalytics::Datastore"
Properties:
  DatastoreName: String
  RetentionPeriod: 
    RetentionPeriod
  Tags: 
    - Tag

Properties

DatastoreName

The name of the data store.

Required: No

Type: String

Update requires: Replacement

RetentionPeriod

How long, in days, message data is kept for the data store.

Required: No

Type: RetentionPeriod

Update requires: No interruption

Tags

Metadata which can be used to manage the data store.

Required: No

Type: List of Resource Tag property types

Update requires: No interruption

Examples

Simple Datastore

The following example creates a simple datastore.

JSON

{
    "Description": "Create a simple Datastore",
    "Resources": {
        "Datastore": {
            "Type": "AWS::IoTAnalytics::Datastore",
            "Properties": {
                "DatastoreName": "SimpleDatastore"
            }
        }
    }
}

YAML

---
Description: "Create a simple Datastore"
Resources:
  Datastore:
    Type: "AWS::IoTAnalytics::Datastore"
    Properties:
      DatastoreName: "SimpleDatastore"

Complex Datastore

The following example creates a complex datastore.

JSON

{
    "Description": "Create a complex Datastore",
    "Resources": {
        "Datastore": {
            "Type": "AWS::IoTAnalytics::Datastore",
            "Properties": {
                "DatastoreName": "ComplexDatastore",
                "RetentionPeriod": {
                    "Unlimited": false,
                    "NumberOfDays": 10
                },
                "Tags": [
                    {
                        "Key": "keyname1",
                        "Value": "value1"
                    },
                    {
                        "Key": "keyname2",
                        "Value": "value2"
                    }
                ]
            }
        }
    }
}

YAML


---
Description: "Create a complex Datastore"
Resources:
  Datastore:
    Type: "AWS::IoTAnalytics::Datastore"
    Properties:
      DatastoreName: "ComplexDatastore"
      RetentionPeriod:
        Unlimited: false
        NumberOfDays: 10
      Tags:
        -
          Key: "keyname1"
          Value: "value1"
        -
          Key: "keyname2"
          Value: "value2"

See Also