AWS::IoTAnalytics::Datastore - Amazon CloudFormation
SyntaxPropertiesExamplesSee also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::IoTAnalytics::Datastore

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

Syntax

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

JSON

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

Properties

DatastoreName

The name of the data store.

Required: No

Type: String

Pattern: [a-zA-Z0-9_]+

Minimum: 1

Maximum: 128

Update requires: Replacement

DatastorePartitions

Information about the partition dimensions in a data store.

Required: No

Type: DatastorePartitions

Update requires: No interruption

DatastoreStorage

Where data store data is stored.

Required: No

Type: DatastoreStorage

Update requires: No interruption

FileFormatConfiguration

Contains the configuration information of file formats. Amazon IoT Analytics data stores support JSON and Parquet.

The default file format is JSON. You can specify only one format.

You can't change the file format after you create the data store.

Required: No

Type: FileFormatConfiguration

Update requires: No interruption

RetentionPeriod

How long, in days, message data is kept for the data store. When customerManagedS3 storage is selected, this parameter is ignored.

Required: No

Type: RetentionPeriod

Update requires: No interruption

Tags

Metadata which can be used to manage the data store.

For more information, see Tag.

Required: No

Type: Array of Tag

Minimum: 1

Maximum: 50

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