CfnDatastorePropsMixin
- class aws_cdk.mixins_preview.aws_iotanalytics.mixins.CfnDatastorePropsMixin(props, *, strategy=None)
Bases:
MixinAWS::IoTAnalytics::Datastore resource is a repository for messages.
For more information, see How to Use AWS IoT Analytics in the AWS IoT Analytics User Guide .
- See:
- CloudformationResource:
AWS::IoTAnalytics::Datastore
- Mixin:
true
- 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.mixins_preview import mixins from aws_cdk.mixins_preview.aws_iotanalytics import mixins as iotanalytics_mixins # json_configuration: Any # service_managed_s3: Any cfn_datastore_props_mixin = iotanalytics_mixins.CfnDatastorePropsMixin(iotanalytics_mixins.CfnDatastoreMixinProps( datastore_name="datastoreName", datastore_partitions=iotanalytics_mixins.CfnDatastorePropsMixin.DatastorePartitionsProperty( partitions=[iotanalytics_mixins.CfnDatastorePropsMixin.DatastorePartitionProperty( partition=iotanalytics_mixins.CfnDatastorePropsMixin.PartitionProperty( attribute_name="attributeName" ), timestamp_partition=iotanalytics_mixins.CfnDatastorePropsMixin.TimestampPartitionProperty( attribute_name="attributeName", timestamp_format="timestampFormat" ) )] ), datastore_storage=iotanalytics_mixins.CfnDatastorePropsMixin.DatastoreStorageProperty( customer_managed_s3=iotanalytics_mixins.CfnDatastorePropsMixin.CustomerManagedS3Property( bucket="bucket", key_prefix="keyPrefix", role_arn="roleArn" ), iot_site_wise_multi_layer_storage=iotanalytics_mixins.CfnDatastorePropsMixin.IotSiteWiseMultiLayerStorageProperty( customer_managed_s3_storage=iotanalytics_mixins.CfnDatastorePropsMixin.CustomerManagedS3StorageProperty( bucket="bucket", key_prefix="keyPrefix" ) ), service_managed_s3=service_managed_s3 ), file_format_configuration=iotanalytics_mixins.CfnDatastorePropsMixin.FileFormatConfigurationProperty( json_configuration=json_configuration, parquet_configuration=iotanalytics_mixins.CfnDatastorePropsMixin.ParquetConfigurationProperty( schema_definition=iotanalytics_mixins.CfnDatastorePropsMixin.SchemaDefinitionProperty( columns=[iotanalytics_mixins.CfnDatastorePropsMixin.ColumnProperty( name="name", type="type" )] ) ) ), retention_period=iotanalytics_mixins.CfnDatastorePropsMixin.RetentionPeriodProperty( number_of_days=123, unlimited=False ), tags=[CfnTag( key="key", value="value" )] ), strategy=mixins.PropertyMergeStrategy.OVERRIDE )
Create a mixin to apply properties to
AWS::IoTAnalytics::Datastore.- Parameters:
props (
Union[CfnDatastoreMixinProps,Dict[str,Any]]) – L1 properties to apply.strategy (
Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE
Methods
- apply_to(construct)
Apply the mixin properties to the construct.
- Parameters:
construct (
IConstruct)- Return type:
- supports(construct)
Check if this mixin supports the given construct.
- Parameters:
construct (
IConstruct)- Return type:
bool
Attributes
- CFN_PROPERTY_KEYS = ['datastoreName', 'datastorePartitions', 'datastoreStorage', 'fileFormatConfiguration', 'retentionPeriod', 'tags']
Static Methods
- classmethod is_mixin(x)
(experimental) Checks if
xis a Mixin.- Parameters:
x (
Any) – Any object.- Return type:
bool- Returns:
true if
xis an object created from a class which extendsMixin.- Stability:
experimental
ColumnProperty
- class CfnDatastorePropsMixin.ColumnProperty(*, name=None, type=None)
Bases:
objectContains information about a column that stores your data.
- Parameters:
name (
Optional[str]) – The name of the column.type (
Optional[str]) – The type of data. For more information about the supported data types, see Common data types in the AWS Glue Developer Guide .
- 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.mixins_preview.aws_iotanalytics import mixins as iotanalytics_mixins column_property = iotanalytics_mixins.CfnDatastorePropsMixin.ColumnProperty( name="name", type="type" )
Attributes
- name
The name of the column.
- type
The type of data.
For more information about the supported data types, see Common data types in the AWS Glue Developer Guide .
CustomerManagedS3Property
- class CfnDatastorePropsMixin.CustomerManagedS3Property(*, bucket=None, key_prefix=None, role_arn=None)
Bases:
objectS3-customer-managed;
When you choose customer-managed storage, the
retentionPeriodparameter is ignored. You can’t change the choice of Amazon S3 storage after your data store is created.- Parameters:
bucket (
Optional[str]) – The name of the Amazon S3 bucket where your data is stored.key_prefix (
Optional[str]) – (Optional) The prefix used to create the keys of the data store data objects. Each object in an Amazon S3 bucket has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/).role_arn (
Optional[str]) – The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 resources.
- 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.mixins_preview.aws_iotanalytics import mixins as iotanalytics_mixins customer_managed_s3_property = iotanalytics_mixins.CfnDatastorePropsMixin.CustomerManagedS3Property( bucket="bucket", key_prefix="keyPrefix", role_arn="roleArn" )
Attributes
- bucket
The name of the Amazon S3 bucket where your data is stored.
- key_prefix
(Optional) The prefix used to create the keys of the data store data objects.
Each object in an Amazon S3 bucket has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/).
- role_arn
The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 resources.
CustomerManagedS3StorageProperty
- class CfnDatastorePropsMixin.CustomerManagedS3StorageProperty(*, bucket=None, key_prefix=None)
Bases:
objectAmazon S3 -customer-managed;
When you choose customer-managed storage, the
retentionPeriodparameter is ignored. You can’t change the choice of Amazon S3 storage after your data store is created.- Parameters:
bucket (
Optional[str]) – The name of the Amazon S3 bucket where your data is stored.key_prefix (
Optional[str]) – (Optional) The prefix used to create the keys of the data store data objects. Each object in an Amazon S3 bucket has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/).
- 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.mixins_preview.aws_iotanalytics import mixins as iotanalytics_mixins customer_managed_s3_storage_property = iotanalytics_mixins.CfnDatastorePropsMixin.CustomerManagedS3StorageProperty( bucket="bucket", key_prefix="keyPrefix" )
Attributes
- bucket
The name of the Amazon S3 bucket where your data is stored.
- key_prefix
(Optional) The prefix used to create the keys of the data store data objects.
Each object in an Amazon S3 bucket has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/).
DatastorePartitionProperty
- class CfnDatastorePropsMixin.DatastorePartitionProperty(*, partition=None, timestamp_partition=None)
Bases:
objectA single dimension to partition a data store.
The dimension must be an
AttributePartitionor aTimestampPartition.- Parameters:
partition (
Union[IResolvable,PartitionProperty,Dict[str,Any],None]) – A partition dimension defined by an attribute.timestamp_partition (
Union[IResolvable,TimestampPartitionProperty,Dict[str,Any],None]) – A partition dimension defined by a timestamp attribute.
- 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.mixins_preview.aws_iotanalytics import mixins as iotanalytics_mixins datastore_partition_property = iotanalytics_mixins.CfnDatastorePropsMixin.DatastorePartitionProperty( partition=iotanalytics_mixins.CfnDatastorePropsMixin.PartitionProperty( attribute_name="attributeName" ), timestamp_partition=iotanalytics_mixins.CfnDatastorePropsMixin.TimestampPartitionProperty( attribute_name="attributeName", timestamp_format="timestampFormat" ) )
Attributes
- partition
A partition dimension defined by an attribute.
- timestamp_partition
A partition dimension defined by a timestamp attribute.
DatastorePartitionsProperty
- class CfnDatastorePropsMixin.DatastorePartitionsProperty(*, partitions=None)
Bases:
objectInformation about the partition dimensions in a data store.
- Parameters:
partitions (
Union[IResolvable,Sequence[Union[IResolvable,DatastorePartitionProperty,Dict[str,Any]]],None]) – A list of partition dimensions in a data store.- 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.mixins_preview.aws_iotanalytics import mixins as iotanalytics_mixins datastore_partitions_property = iotanalytics_mixins.CfnDatastorePropsMixin.DatastorePartitionsProperty( partitions=[iotanalytics_mixins.CfnDatastorePropsMixin.DatastorePartitionProperty( partition=iotanalytics_mixins.CfnDatastorePropsMixin.PartitionProperty( attribute_name="attributeName" ), timestamp_partition=iotanalytics_mixins.CfnDatastorePropsMixin.TimestampPartitionProperty( attribute_name="attributeName", timestamp_format="timestampFormat" ) )] )
Attributes
- partitions
A list of partition dimensions in a data store.
DatastoreStorageProperty
- class CfnDatastorePropsMixin.DatastoreStorageProperty(*, customer_managed_s3=None, iot_site_wise_multi_layer_storage=None, service_managed_s3=None)
Bases:
objectWhere data store data is stored.
- Parameters:
customer_managed_s3 (
Union[IResolvable,CustomerManagedS3Property,Dict[str,Any],None]) – Use this to store data store data in an S3 bucket that you manage. The choice of service-managed or customer-managed S3 storage cannot be changed after creation of the data store.iot_site_wise_multi_layer_storage (
Union[IResolvable,IotSiteWiseMultiLayerStorageProperty,Dict[str,Any],None]) – Use this to store data used by AWS IoT SiteWise in an Amazon S3 bucket that you manage. You can’t change the choice of Amazon S3 storage after your data store is created.service_managed_s3 (
Any) – Use this to store data store data in an S3 bucket managed by the AWS IoT Analytics service. The choice of service-managed or customer-managed S3 storage cannot be changed after creation of the data store.
- 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.mixins_preview.aws_iotanalytics import mixins as iotanalytics_mixins # service_managed_s3: Any datastore_storage_property = iotanalytics_mixins.CfnDatastorePropsMixin.DatastoreStorageProperty( customer_managed_s3=iotanalytics_mixins.CfnDatastorePropsMixin.CustomerManagedS3Property( bucket="bucket", key_prefix="keyPrefix", role_arn="roleArn" ), iot_site_wise_multi_layer_storage=iotanalytics_mixins.CfnDatastorePropsMixin.IotSiteWiseMultiLayerStorageProperty( customer_managed_s3_storage=iotanalytics_mixins.CfnDatastorePropsMixin.CustomerManagedS3StorageProperty( bucket="bucket", key_prefix="keyPrefix" ) ), service_managed_s3=service_managed_s3 )
Attributes
- customer_managed_s3
Use this to store data store data in an S3 bucket that you manage.
The choice of service-managed or customer-managed S3 storage cannot be changed after creation of the data store.
- iot_site_wise_multi_layer_storage
Use this to store data used by AWS IoT SiteWise in an Amazon S3 bucket that you manage.
You can’t change the choice of Amazon S3 storage after your data store is created.
- service_managed_s3
Use this to store data store data in an S3 bucket managed by the AWS IoT Analytics service.
The choice of service-managed or customer-managed S3 storage cannot be changed after creation of the data store.
FileFormatConfigurationProperty
- class CfnDatastorePropsMixin.FileFormatConfigurationProperty(*, json_configuration=None, parquet_configuration=None)
Bases:
objectContains 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.
- Parameters:
json_configuration (
Any) – Contains the configuration information of the JSON format.parquet_configuration (
Union[IResolvable,ParquetConfigurationProperty,Dict[str,Any],None]) – Contains the configuration information of the Parquet format.
- 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.mixins_preview.aws_iotanalytics import mixins as iotanalytics_mixins # json_configuration: Any file_format_configuration_property = iotanalytics_mixins.CfnDatastorePropsMixin.FileFormatConfigurationProperty( json_configuration=json_configuration, parquet_configuration=iotanalytics_mixins.CfnDatastorePropsMixin.ParquetConfigurationProperty( schema_definition=iotanalytics_mixins.CfnDatastorePropsMixin.SchemaDefinitionProperty( columns=[iotanalytics_mixins.CfnDatastorePropsMixin.ColumnProperty( name="name", type="type" )] ) ) )
Attributes
- json_configuration
Contains the configuration information of the JSON format.
- parquet_configuration
Contains the configuration information of the Parquet format.
IotSiteWiseMultiLayerStorageProperty
- class CfnDatastorePropsMixin.IotSiteWiseMultiLayerStorageProperty(*, customer_managed_s3_storage=None)
Bases:
objectStores data used by AWS IoT SiteWise in an Amazon S3 bucket that you manage.
You can’t change the choice of Amazon S3 storage after your data store is created.
- Parameters:
customer_managed_s3_storage (
Union[IResolvable,CustomerManagedS3StorageProperty,Dict[str,Any],None]) – Stores data used by AWS IoT SiteWise in an Amazon S3 bucket that you manage.- 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.mixins_preview.aws_iotanalytics import mixins as iotanalytics_mixins iot_site_wise_multi_layer_storage_property = iotanalytics_mixins.CfnDatastorePropsMixin.IotSiteWiseMultiLayerStorageProperty( customer_managed_s3_storage=iotanalytics_mixins.CfnDatastorePropsMixin.CustomerManagedS3StorageProperty( bucket="bucket", key_prefix="keyPrefix" ) )
Attributes
- customer_managed_s3_storage
Stores data used by AWS IoT SiteWise in an Amazon S3 bucket that you manage.
ParquetConfigurationProperty
- class CfnDatastorePropsMixin.ParquetConfigurationProperty(*, schema_definition=None)
Bases:
objectContains the configuration information of the Parquet format.
- Parameters:
schema_definition (
Union[IResolvable,SchemaDefinitionProperty,Dict[str,Any],None]) – Information needed to define a schema.- 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.mixins_preview.aws_iotanalytics import mixins as iotanalytics_mixins parquet_configuration_property = iotanalytics_mixins.CfnDatastorePropsMixin.ParquetConfigurationProperty( schema_definition=iotanalytics_mixins.CfnDatastorePropsMixin.SchemaDefinitionProperty( columns=[iotanalytics_mixins.CfnDatastorePropsMixin.ColumnProperty( name="name", type="type" )] ) )
Attributes
- schema_definition
Information needed to define a schema.
PartitionProperty
- class CfnDatastorePropsMixin.PartitionProperty(*, attribute_name=None)
Bases:
objectA single dimension to partition a data store.
The dimension must be an
AttributePartitionor aTimestampPartition.- Parameters:
attribute_name (
Optional[str]) – The name of the attribute that defines a partition dimension.- 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.mixins_preview.aws_iotanalytics import mixins as iotanalytics_mixins partition_property = iotanalytics_mixins.CfnDatastorePropsMixin.PartitionProperty( attribute_name="attributeName" )
Attributes
- attribute_name
The name of the attribute that defines a partition dimension.
RetentionPeriodProperty
- class CfnDatastorePropsMixin.RetentionPeriodProperty(*, number_of_days=None, unlimited=None)
Bases:
objectHow long, in days, message data is kept.
- Parameters:
number_of_days (
Union[int,float,None]) – The number of days that message data is kept. Theunlimitedparameter must be false.unlimited (
Union[bool,IResolvable,None]) – If true, message data is kept indefinitely.
- 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.mixins_preview.aws_iotanalytics import mixins as iotanalytics_mixins retention_period_property = iotanalytics_mixins.CfnDatastorePropsMixin.RetentionPeriodProperty( number_of_days=123, unlimited=False )
Attributes
- number_of_days
The number of days that message data is kept.
The
unlimitedparameter must be false.
- unlimited
If true, message data is kept indefinitely.
SchemaDefinitionProperty
- class CfnDatastorePropsMixin.SchemaDefinitionProperty(*, columns=None)
Bases:
objectInformation needed to define a schema.
- Parameters:
columns (
Union[IResolvable,Sequence[Union[IResolvable,ColumnProperty,Dict[str,Any]]],None]) – Specifies one or more columns that store your data. Each schema can have up to 100 columns. Each column can have up to 100 nested types.- 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.mixins_preview.aws_iotanalytics import mixins as iotanalytics_mixins schema_definition_property = iotanalytics_mixins.CfnDatastorePropsMixin.SchemaDefinitionProperty( columns=[iotanalytics_mixins.CfnDatastorePropsMixin.ColumnProperty( name="name", type="type" )] )
Attributes
- columns
Specifies one or more columns that store your data.
Each schema can have up to 100 columns. Each column can have up to 100 nested types.
TimestampPartitionProperty
- class CfnDatastorePropsMixin.TimestampPartitionProperty(*, attribute_name=None, timestamp_format=None)
Bases:
objectA partition dimension defined by a timestamp attribute.
- Parameters:
attribute_name (
Optional[str]) – The attribute name of the partition defined by a timestamp.timestamp_format (
Optional[str]) – The timestamp format of a partition defined by a timestamp. The default format is seconds since epoch (January 1, 1970 at midnight UTC time).
- 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.mixins_preview.aws_iotanalytics import mixins as iotanalytics_mixins timestamp_partition_property = iotanalytics_mixins.CfnDatastorePropsMixin.TimestampPartitionProperty( attribute_name="attributeName", timestamp_format="timestampFormat" )
Attributes
- attribute_name
The attribute name of the partition defined by a timestamp.
- timestamp_format
The timestamp format of a partition defined by a timestamp.
The default format is seconds since epoch (January 1, 1970 at midnight UTC time).