Package software.amazon.awscdk.services.iotanalytics

Class CfnDatastore

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.iotanalytics.CfnDatastore
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IDatastoreRef, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)", date="2025-12-18T18:20:11.839Z") @Stability(Stable) public class CfnDatastore extends CfnResource implements IInspectable, IDatastoreRef, ITaggable
AWS::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 .

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;
 CfnDatastore cfnDatastore = CfnDatastore.Builder.create(this, "MyCfnDatastore")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnDatastore

      protected CfnDatastore(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnDatastore

      protected CfnDatastore(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnDatastore

      @Stability(Stable) public CfnDatastore(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnDatastoreProps props)
      Create a new AWS::IoTAnalytics::Datastore.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnDatastore

      @Stability(Stable) public CfnDatastore(@NotNull software.constructs.Construct scope, @NotNull String id)
      Create a new AWS::IoTAnalytics::Datastore.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.

  • Method Details

    • arnForDatastore

      @Stability(Stable) @NotNull public static String arnForDatastore(@NotNull IDatastoreRef resource)
      Parameters:
      resource - This parameter is required.

    • fromDatastoreName

      @Stability(Stable) @NotNull public static IDatastoreRef fromDatastoreName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String datastoreName)
      Creates a new IDatastoreRef from a datastoreName.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      datastoreName - This parameter is required.

    • isCfnDatastore

      @Stability(Stable) @NotNull public static Boolean isCfnDatastore(@NotNull Object x)
      Checks whether the given object is a CfnDatastore.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getDatastoreRef

      @Stability(Stable) @NotNull public DatastoreReference getDatastoreRef()
      A reference to a Datastore resource.
      Specified by:
      getDatastoreRef in interface IDatastoreRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getDatastoreName

      @Stability(Stable) @Nullable public String getDatastoreName()
      The name of the data store.

    • setDatastoreName

      @Stability(Stable) public void setDatastoreName(@Nullable String value)
      The name of the data store.

    • getDatastorePartitions

      @Stability(Stable) @Nullable public Object getDatastorePartitions()
      Information about the partition dimensions in a data store.

      Returns union: either IResolvable or CfnDatastore.DatastorePartitionsProperty

    • setDatastorePartitions

      @Stability(Stable) public void setDatastorePartitions(@Nullable IResolvable value)
      Information about the partition dimensions in a data store.

    • setDatastorePartitions

      @Stability(Stable) public void setDatastorePartitions(@Nullable CfnDatastore.DatastorePartitionsProperty value)
      Information about the partition dimensions in a data store.

    • getDatastoreStorage

      @Stability(Stable) @Nullable public Object getDatastoreStorage()
      Where data store data is stored.

      Returns union: either IResolvable or CfnDatastore.DatastoreStorageProperty

    • setDatastoreStorage

      @Stability(Stable) public void setDatastoreStorage(@Nullable IResolvable value)
      Where data store data is stored.

    • setDatastoreStorage

      @Stability(Stable) public void setDatastoreStorage(@Nullable CfnDatastore.DatastoreStorageProperty value)
      Where data store data is stored.

    • getFileFormatConfiguration

      @Stability(Stable) @Nullable public Object getFileFormatConfiguration()
      Contains the configuration information of file formats.

      AWS IoT Analytics data stores support JSON and Parquet .

      Returns union: either IResolvable or CfnDatastore.FileFormatConfigurationProperty

    • setFileFormatConfiguration

      @Stability(Stable) public void setFileFormatConfiguration(@Nullable IResolvable value)
      Contains the configuration information of file formats.

      AWS IoT Analytics data stores support JSON and Parquet .

    • setFileFormatConfiguration

      @Stability(Stable) public void setFileFormatConfiguration(@Nullable CfnDatastore.FileFormatConfigurationProperty value)
      Contains the configuration information of file formats.

      AWS IoT Analytics data stores support JSON and Parquet .

    • getRetentionPeriod

      @Stability(Stable) @Nullable public Object getRetentionPeriod()
      How long, in days, message data is kept for the data store.

      Returns union: either IResolvable or CfnDatastore.RetentionPeriodProperty

    • setRetentionPeriod

      @Stability(Stable) public void setRetentionPeriod(@Nullable IResolvable value)
      How long, in days, message data is kept for the data store.

    • setRetentionPeriod

      @Stability(Stable) public void setRetentionPeriod(@Nullable CfnDatastore.RetentionPeriodProperty value)
      How long, in days, message data is kept for the data store.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      Metadata which can be used to manage the data store.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      Metadata which can be used to manage the data store.