Show / Hide Table of Contents

Class CfnDatastoreMixinProps

Properties for CfnDatastorePropsMixin.

Inheritance
object
CfnDatastoreMixinProps
Implements
ICfnDatastoreMixinProps
Inherited Members
object.GetType()
object.MemberwiseClone()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: Amazon.CDK.CfnPropertyMixins.AWS.IoTAnalytics
Assembly: Amazon.CDK.CfnPropertyMixins.dll
Syntax (csharp)
public class CfnDatastoreMixinProps : ICfnDatastoreMixinProps
Syntax (vb)
Public Class CfnDatastoreMixinProps Implements ICfnDatastoreMixinProps
Remarks

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

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.CfnPropertyMixins.AWS.IoTAnalytics;

             var jsonConfiguration;
             var serviceManagedS3;

             var cfnDatastoreMixinProps = new CfnDatastoreMixinProps {
                 DatastoreName = "datastoreName",
                 DatastorePartitions = new DatastorePartitionsProperty {
                     Partitions = new [] { new DatastorePartitionProperty {
                         Partition = new PartitionProperty {
                             AttributeName = "attributeName"
                         },
                         TimestampPartition = new TimestampPartitionProperty {
                             AttributeName = "attributeName",
                             TimestampFormat = "timestampFormat"
                         }
                     } }
                 },
                 DatastoreStorage = new DatastoreStorageProperty {
                     CustomerManagedS3 = new CustomerManagedS3Property {
                         Bucket = "bucket",
                         KeyPrefix = "keyPrefix",
                         RoleArn = "roleArn"
                     },
                     IotSiteWiseMultiLayerStorage = new IotSiteWiseMultiLayerStorageProperty {
                         CustomerManagedS3Storage = new CustomerManagedS3StorageProperty {
                             Bucket = "bucket",
                             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

Constructors

CfnDatastoreMixinProps()

Properties for CfnDatastorePropsMixin.

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. ITA 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.

Constructors

CfnDatastoreMixinProps()

Properties for CfnDatastorePropsMixin.

public CfnDatastoreMixinProps()
Remarks

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

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.CfnPropertyMixins.AWS.IoTAnalytics;

             var jsonConfiguration;
             var serviceManagedS3;

             var cfnDatastoreMixinProps = new CfnDatastoreMixinProps {
                 DatastoreName = "datastoreName",
                 DatastorePartitions = new DatastorePartitionsProperty {
                     Partitions = new [] { new DatastorePartitionProperty {
                         Partition = new PartitionProperty {
                             AttributeName = "attributeName"
                         },
                         TimestampPartition = new TimestampPartitionProperty {
                             AttributeName = "attributeName",
                             TimestampFormat = "timestampFormat"
                         }
                     } }
                 },
                 DatastoreStorage = new DatastoreStorageProperty {
                     CustomerManagedS3 = new CustomerManagedS3Property {
                         Bucket = "bucket",
                         KeyPrefix = "keyPrefix",
                         RoleArn = "roleArn"
                     },
                     IotSiteWiseMultiLayerStorage = new IotSiteWiseMultiLayerStorageProperty {
                         CustomerManagedS3Storage = new CustomerManagedS3StorageProperty {
                             Bucket = "bucket",
                             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"
                 } }
             };

Properties

DatastoreName

The name of the data store.

public string? DatastoreName { get; set; }
Property Value

string

Remarks

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

DatastorePartitions

Information about the partition dimensions in a data store.

public object? DatastorePartitions { get; set; }
Property Value

object

Remarks

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

Type union: either IResolvable or CfnDatastorePropsMixin.IDatastorePartitionsProperty

DatastoreStorage

Where data store data is stored.

public object? DatastoreStorage { get; set; }
Property Value

object

Remarks

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

Type union: either IResolvable or CfnDatastorePropsMixin.IDatastoreStorageProperty

FileFormatConfiguration

Contains the configuration information of file formats. ITA data stores support JSON and Parquet .

public object? FileFormatConfiguration { get; set; }
Property Value

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.

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

Type union: either IResolvable or CfnDatastorePropsMixin.IFileFormatConfigurationProperty

RetentionPeriod

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

public object? RetentionPeriod { get; set; }
Property Value

object

Remarks

When customerManagedS3 storage is selected, this parameter is ignored.

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

Type union: either IResolvable or CfnDatastorePropsMixin.IRetentionPeriodProperty

Tags

Metadata which can be used to manage the data store.

public ICfnTag[]? Tags { get; set; }
Property Value

ICfnTag[]

Remarks

For more information, see Tag .

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

Implements

ICfnDatastoreMixinProps
Back to top Generated by DocFX