Interface ICfnDatastoreProps
Properties for defining a CfnDatastore
.
Namespace: Amazon.CDK.AWS.IoTAnalytics
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnDatastoreProps
Syntax (vb)
Public Interface ICfnDatastoreProps
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.IoTAnalytics;
var jsonConfiguration;
var serviceManagedS3;
var cfnDatastoreProps = new CfnDatastoreProps {
DatastoreName = "datastoreName",
DatastorePartitions = new DatastorePartitionsProperty {
Partitions = new [] { new DatastorePartitionProperty {
Partition = new PartitionProperty {
AttributeName = "attributeName"
},
TimestampPartition = new TimestampPartitionProperty {
AttributeName = "attributeName",
// the properties below are optional
TimestampFormat = "timestampFormat"
}
} }
},
DatastoreStorage = new DatastoreStorageProperty {
CustomerManagedS3 = new CustomerManagedS3Property {
Bucket = "bucket",
RoleArn = "roleArn",
// the properties below are optional
KeyPrefix = "keyPrefix"
},
IotSiteWiseMultiLayerStorage = new IotSiteWiseMultiLayerStorageProperty {
CustomerManagedS3Storage = new CustomerManagedS3StorageProperty {
Bucket = "bucket",
// the properties below are optional
KeyPrefix = "keyPrefix"
}
},
ServiceManagedS3 = serviceManagedS3
},
FileFormatConfiguration = new FileFormatConfigurationProperty {
JsonConfiguration = jsonConfiguration,
ParquetConfiguration = new ParquetConfigurationProperty {
SchemaDefinition = new SchemaDefinitionProperty {
Columns = new [] { new ColumnProperty {
Name = "name",
Type = "type"
} }
}
}
},
RetentionPeriod = new RetentionPeriodProperty {
NumberOfDays = 123,
Unlimited = false
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
};
Synopsis
Properties
DatastoreName | The name of the data store. |
DatastorePartitions | Information about the partition dimensions in a data store. |
DatastoreStorage | Where data store data is stored. |
FileFormatConfiguration | Contains the configuration information of file formats. AWS IoT Analytics data stores support JSON and Parquet . |
RetentionPeriod | How long, in days, message data is kept for the data store. |
Tags | Metadata which can be used to manage the data store. |
Properties
DatastoreName
The name of the data store.
virtual string DatastoreName { get; }
Property Value
System.String
Remarks
DatastorePartitions
Information about the partition dimensions in a data store.
virtual object DatastorePartitions { get; }
Property Value
System.Object
Remarks
DatastoreStorage
Where data store data is stored.
virtual object DatastoreStorage { get; }
Property Value
System.Object
Remarks
FileFormatConfiguration
Contains the configuration information of file formats. AWS IoT Analytics data stores support JSON and Parquet .
virtual object FileFormatConfiguration { get; }
Property Value
System.Object
Remarks
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
How long, in days, message data is kept for the data store.
virtual object RetentionPeriod { get; }
Property Value
System.Object
Remarks
When customerManagedS3
storage is selected, this parameter is ignored.
Tags
Metadata which can be used to manage the data store.
virtual ICfnTag[] Tags { get; }
Property Value
ICfnTag[]