CfnDatastoreProps
- class aws_cdk.aws_iotanalytics.CfnDatastoreProps(*, datastore_name=None, datastore_partitions=None, datastore_storage=None, file_format_configuration=None, retention_period=None, tags=None)
Bases:
object
Properties for defining a
CfnDatastore
.- Parameters:
datastore_name (
Optional
[str
]) – The name of the data store.datastore_partitions (
Union
[IResolvable
,DatastorePartitionsProperty
,Dict
[str
,Any
],None
]) – Information about the partition dimensions in a data store.datastore_storage (
Union
[IResolvable
,DatastoreStorageProperty
,Dict
[str
,Any
],None
]) – Where data store data is stored.file_format_configuration (
Union
[IResolvable
,FileFormatConfigurationProperty
,Dict
[str
,Any
],None
]) – 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.retention_period (
Union
[IResolvable
,RetentionPeriodProperty
,Dict
[str
,Any
],None
]) – How long, in days, message data is kept for the data store. WhencustomerManagedS3
storage is selected, this parameter is ignored.tags (
Optional
[Sequence
[Union
[CfnTag
,Dict
[str
,Any
]]]]) – Metadata which can be used to manage the data store. For more information, see Tag .
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_iotanalytics as iotanalytics # json_configuration: Any # service_managed_s3: Any cfn_datastore_props = iotanalytics.CfnDatastoreProps( datastore_name="datastoreName", datastore_partitions=iotanalytics.CfnDatastore.DatastorePartitionsProperty( partitions=[iotanalytics.CfnDatastore.DatastorePartitionProperty( partition=iotanalytics.CfnDatastore.PartitionProperty( attribute_name="attributeName" ), timestamp_partition=iotanalytics.CfnDatastore.TimestampPartitionProperty( attribute_name="attributeName", # the properties below are optional timestamp_format="timestampFormat" ) )] ), datastore_storage=iotanalytics.CfnDatastore.DatastoreStorageProperty( customer_managed_s3=iotanalytics.CfnDatastore.CustomerManagedS3Property( bucket="bucket", role_arn="roleArn", # the properties below are optional key_prefix="keyPrefix" ), iot_site_wise_multi_layer_storage=iotanalytics.CfnDatastore.IotSiteWiseMultiLayerStorageProperty( customer_managed_s3_storage=iotanalytics.CfnDatastore.CustomerManagedS3StorageProperty( bucket="bucket", # the properties below are optional key_prefix="keyPrefix" ) ), service_managed_s3=service_managed_s3 ), file_format_configuration=iotanalytics.CfnDatastore.FileFormatConfigurationProperty( json_configuration=json_configuration, parquet_configuration=iotanalytics.CfnDatastore.ParquetConfigurationProperty( schema_definition=iotanalytics.CfnDatastore.SchemaDefinitionProperty( columns=[iotanalytics.CfnDatastore.ColumnProperty( name="name", type="type" )] ) ) ), retention_period=iotanalytics.CfnDatastore.RetentionPeriodProperty( number_of_days=123, unlimited=False ), tags=[CfnTag( key="key", value="value" )] )
Attributes
- datastore_name
The name of the data store.
- datastore_partitions
Information about the partition dimensions in a data store.
- datastore_storage
Where data store data is stored.
- file_format_configuration
//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.
- See:
- Type:
Contains the configuration information of file formats. AWS IoT Analytics data stores support JSON and `Parquet <https
- Type:
//docs.aws.amazon.com/https
- retention_period
How long, in days, message data is kept for the data store.
When
customerManagedS3
storage is selected, this parameter is ignored.