Skip to content
v2.275.0

CfnDatastoreProps Struct ​

Properties for defining a CfnDatastore.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_iotanalytics as iotanalytics } from 'aws-cdk-lib';

declare const jsonConfiguration: any;
declare const serviceManagedS3: any;
const cfnDatastoreProps: iotanalytics.CfnDatastoreProps = {
  datastoreName: 'datastoreName',
  datastorePartitions: {
    partitions: [{
      partition: {
        attributeName: 'attributeName',
      },
      timestampPartition: {
        attributeName: 'attributeName',

        // the properties below are optional
        timestampFormat: 'timestampFormat',
      },
    }],
  },
  datastoreStorage: {
    customerManagedS3: {
      bucket: 'bucket',
      roleArn: 'roleArn',

      // the properties below are optional
      keyPrefix: 'keyPrefix',
    },
    iotSiteWiseMultiLayerStorage: {
      customerManagedS3Storage: {
        bucket: 'bucket',

        // the properties below are optional
        keyPrefix: 'keyPrefix',
      },
    },
    serviceManagedS3: serviceManagedS3,
  },
  fileFormatConfiguration: {
    jsonConfiguration: jsonConfiguration,
    parquetConfiguration: {
      schemaDefinition: {
        columns: [{
          name: 'name',
          type: 'type',
        }],
      },
    },
  },
  retentionPeriod: {
    numberOfDays: 123,
    unlimited: false,
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties ​

datastoreNameoptionalstringdatastore_nameoptionalstrdatastoreNameoptionalStringDatastoreNameoptionalstringDatastoreNameoptional*string#
The name of the data store.
datastorePartitionsoptionalIResolvable | CfnDatastore.DatastorePartitionsPropertydatastore_partitionsoptionaltyping.Union[IResolvable, DatastorePartitionsProperty]datastorePartitionsoptionalIResolvableDatastorePartitionsoptionalIResolvableDatastorePartitionsoptionalinterface{}#
Information about the partition dimensions in a data store.
datastoreStorageoptionalIResolvable | CfnDatastore.DatastoreStoragePropertydatastore_storageoptionaltyping.Union[IResolvable, DatastoreStorageProperty]datastoreStorageoptionalIResolvableDatastoreStorageoptionalIResolvableDatastoreStorageoptionalinterface{}#
Where data store data is stored.
fileFormatConfigurationoptionalIResolvable | CfnDatastore.FileFormatConfigurationPropertyfile_format_configurationoptionaltyping.Union[IResolvable, FileFormatConfigurationProperty]fileFormatConfigurationoptionalIResolvableFileFormatConfigurationoptionalIResolvableFileFormatConfigurationoptionalinterface{}#
Contains the configuration information of file formats. ITA data stores support JSON and [Parquet](https://docs.aws.amazon.com/https://parquet.apache.org/) .

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.

retentionPeriodoptionalIResolvable | CfnDatastore.RetentionPeriodPropertyretention_periodoptionaltyping.Union[IResolvable, RetentionPeriodProperty]retentionPeriodoptionalIResolvableRetentionPeriodoptionalIResolvableRetentionPeriodoptionalinterface{}#
How long, in days, message data is kept for the data store.

When customerManagedS3 storage is selected, this parameter is ignored.

tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
Metadata which can be used to manage the data store.

For more information, see Tag .