Interface CfnDatastoreProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnDatastoreProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
date="2024-08-23T05:56:18.133Z")
@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();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnDatastoreProps
static final class
An implementation forCfnDatastoreProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnDatastoreProps.Builder
builder()
default String
The name of the data store.default Object
Information about the partition dimensions in a data store.default Object
Where data store data is stored.default Object
Contains the configuration information of file formats.default Object
How long, in days, message data is kept for the data store.getTags()
Metadata which can be used to manage the data store.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getDatastoreName
The name of the data store.- See Also:
-
getDatastorePartitions
Information about the partition dimensions in a data store.- See Also:
-
getDatastoreStorage
Where data store data is stored.- See Also:
-
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.
- See Also:
-
getRetentionPeriod
How long, in days, message data is kept for the data store.When
customerManagedS3
storage is selected, this parameter is ignored.- See Also:
-
getTags
Metadata which can be used to manage the data store.For more information, see Tag .
- See Also:
-
builder
- Returns:
- a
CfnDatastoreProps.Builder
ofCfnDatastoreProps
-