interface CfnDatastoreProps

Language	Type name
.NET	`Amazon.CDK.AWS.IoTAnalytics.CfnDatastoreProps`
Java	`software.amazon.awscdk.services.iotanalytics.CfnDatastoreProps`
Python	`aws_cdk.aws_iotanalytics.CfnDatastoreProps`
TypeScript	`@aws-cdk/aws-iotanalytics` » `CfnDatastoreProps`

Properties for defining a CfnDatastore.

Example

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

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

Name	Type	Description
datastoreName?	`string`	The name of the data store.
datastorePartitions?	`IResolvable` `\|` `DatastorePartitionsProperty`	Information about the partition dimensions in a data store.
datastoreStorage?	`IResolvable` `\|` `DatastoreStorageProperty`	Where data store data is stored.
fileFormatConfiguration?	`IResolvable` `\|` `FileFormatConfigurationProperty`	Contains the configuration information of file formats. AWS IoT Analytics data stores support JSON and Parquet .
retentionPeriod?	`IResolvable` `\|` `RetentionPeriodProperty`	How long, in days, message data is kept for the data store.
tags?	`CfnTag[]`	Metadata which can be used to manage the data store.