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 AWS::IoTAnalytics::Datastore.

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-datastore.html

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_iotanalytics as iotanalytics

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=iotanalytics.CfnDatastore.ServiceManagedS3Property()
    ),
    file_format_configuration=iotanalytics.CfnDatastore.FileFormatConfigurationProperty(
        json_configuration=iotanalytics.CfnDatastore.JsonConfigurationProperty(),
        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

AWS::IoTAnalytics::Datastore.DatastoreName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-datastore.html#cfn-iotanalytics-datastore-datastorename

Return type

Optional[str]

datastore_partitions

AWS::IoTAnalytics::Datastore.DatastorePartitions.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-datastore.html#cfn-iotanalytics-datastore-datastorepartitions

Return type

Union[IResolvable, DatastorePartitionsProperty, None]

datastore_storage

AWS::IoTAnalytics::Datastore.DatastoreStorage.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-datastore.html#cfn-iotanalytics-datastore-datastorestorage

Return type

Union[IResolvable, DatastoreStorageProperty, None]

file_format_configuration

AWS::IoTAnalytics::Datastore.FileFormatConfiguration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-datastore.html#cfn-iotanalytics-datastore-fileformatconfiguration

Return type

Union[IResolvable, FileFormatConfigurationProperty, None]

retention_period

AWS::IoTAnalytics::Datastore.RetentionPeriod.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-datastore.html#cfn-iotanalytics-datastore-retentionperiod

Return type

Union[IResolvable, RetentionPeriodProperty, None]

tags

AWS::IoTAnalytics::Datastore.Tags.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-datastore.html#cfn-iotanalytics-datastore-tags

Return type

Optional[List[CfnTag]]