aws-cdk-lib.aws_iotanalytics.CfnDatastoreProps

interface CfnDatastoreProps

LanguageType name
.NETAmazon.CDK.AWS.IoTAnalytics.CfnDatastoreProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsiotanalytics#CfnDatastoreProps
Javasoftware.amazon.awscdk.services.iotanalytics.CfnDatastoreProps
Pythonaws_cdk.aws_iotanalytics.CfnDatastoreProps
TypeScript aws-cdk-lib » 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 { 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

NameTypeDescription
datastoreName?stringThe name of the data store.
datastorePartitions?IResolvable | DatastorePartitionsPropertyInformation about the partition dimensions in a data store.
datastoreStorage?IResolvable | DatastoreStoragePropertyWhere data store data is stored.
fileFormatConfiguration?IResolvable | FileFormatConfigurationPropertyContains the configuration information of file formats. AWS IoT Analytics data stores support JSON and Parquet .
retentionPeriod?IResolvable | RetentionPeriodPropertyHow long, in days, message data is kept for the data store.
tags?CfnTag[]Metadata which can be used to manage the data store.

datastoreName?

Type: string (optional)

The name of the data store.


datastorePartitions?

Type: IResolvable | DatastorePartitionsProperty (optional)

Information about the partition dimensions in a data store.


datastoreStorage?

Type: IResolvable | DatastoreStorageProperty (optional)

Where data store data is stored.


fileFormatConfiguration?

Type: IResolvable | FileFormatConfigurationProperty (optional)

Contains the configuration information of file formats. AWS 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.


retentionPeriod?

Type: IResolvable | RetentionPeriodProperty (optional)

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

When customerManagedS3 storage is selected, this parameter is ignored.


tags?

Type: CfnTag[] (optional)

Metadata which can be used to manage the data store.

For more information, see Tag .