Package software.amazon.awscdk.services.iotanalytics

Interface CfnDatastoreProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDatastoreProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:29:57.792Z")
@Stability(Stable)
public interface CfnDatastoreProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnDatastore.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iotanalytics.*;
 Object jsonConfiguration;
 Object serviceManagedS3;
 CfnDatastoreProps cfnDatastoreProps = CfnDatastoreProps.builder()
         .datastoreName("datastoreName")
         .datastorePartitions(DatastorePartitionsProperty.builder()
                 .partitions(List.of(DatastorePartitionProperty.builder()
                         .partition(PartitionProperty.builder()
                                 .attributeName("attributeName")
                                 .build())
                         .timestampPartition(TimestampPartitionProperty.builder()
                                 .attributeName("attributeName")
                                 // the properties below are optional
                                 .timestampFormat("timestampFormat")
                                 .build())
                         .build()))
                 .build())
         .datastoreStorage(DatastoreStorageProperty.builder()
                 .customerManagedS3(CustomerManagedS3Property.builder()
                         .bucket("bucket")
                         .roleArn("roleArn")
                         // the properties below are optional
                         .keyPrefix("keyPrefix")
                         .build())
                 .iotSiteWiseMultiLayerStorage(IotSiteWiseMultiLayerStorageProperty.builder()
                         .customerManagedS3Storage(CustomerManagedS3StorageProperty.builder()
                                 .bucket("bucket")
                                 // the properties below are optional
                                 .keyPrefix("keyPrefix")
                                 .build())
                         .build())
                 .serviceManagedS3(serviceManagedS3)
                 .build())
         .fileFormatConfiguration(FileFormatConfigurationProperty.builder()
                 .jsonConfiguration(jsonConfiguration)
                 .parquetConfiguration(ParquetConfigurationProperty.builder()
                         .schemaDefinition(SchemaDefinitionProperty.builder()
                                 .columns(List.of(ColumnProperty.builder()
                                         .name("name")
                                         .type("type")
                                         .build()))
                                 .build())
                         .build())
                 .build())
         .retentionPeriod(RetentionPeriodProperty.builder()
                 .numberOfDays(123)
                 .unlimited(false)
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDatastoreProps.Builder	A builder for CfnDatastoreProps
static final class	CfnDatastoreProps.Jsii$Proxy	An implementation for CfnDatastoreProps

Method Summary

Modifier and Type	Method	Description
static CfnDatastoreProps.Builder	builder()
default String	getDatastoreName()	The name of the data store.
default Object	getDatastorePartitions()	Information about the partition dimensions in a data store.
default Object	getDatastoreStorage()	Where data store data is stored.
default Object	getFileFormatConfiguration()	Contains the configuration information of file formats.
default Object	getRetentionPeriod()	How long, in days, message data is kept for the data store.
default List<CfnTag>	getTags()	Metadata which can be used to manage the data store.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDatastoreName

@Stability(Stable)
@Nullable
default String getDatastoreName()

The name of the data store.

getDatastorePartitions

@Stability(Stable)
@Nullable
default Object getDatastorePartitions()

Information about the partition dimensions in a data store.

getDatastoreStorage

@Stability(Stable)
@Nullable
default Object getDatastoreStorage()

Where data store data is stored.

getFileFormatConfiguration

@Stability(Stable)
@Nullable
default Object getFileFormatConfiguration()

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.

getRetentionPeriod

@Stability(Stable)
@Nullable
default Object getRetentionPeriod()

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

When customerManagedS3 storage is selected, this parameter is ignored.

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

Metadata which can be used to manage the data store.

For more information, see Tag .

builder

@Stability(Stable)
static CfnDatastoreProps.Builder builder()

Returns:

a CfnDatastoreProps.Builder of CfnDatastoreProps