CfnDatastore

java.lang.Object
- software.constructs.Construct
- - software.amazon.awscdk.core.Construct
  - - software.amazon.awscdk.core.CfnElement
    - - software.amazon.awscdk.core.CfnRefElement
      - software.amazon.awscdk.core.CfnResource
        
        software.amazon.awscdk.services.iotanalytics.CfnDatastore

All Implemented Interfaces:: IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:36.973Z")
public class CfnDatastore
extends CfnResource
implements IInspectable

A CloudFormation `AWS::IoTAnalytics::Datastore`.

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();

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`CfnDatastore.Builder` A fluent builder for `CfnDatastore`.
`static interface`	`CfnDatastore.ColumnProperty` Contains information about a column that stores your data.
`static interface`	`CfnDatastore.CustomerManagedS3Property` S3-customer-managed;
`static interface`	`CfnDatastore.CustomerManagedS3StorageProperty` Amazon S3 -customer-managed;
`static interface`	`CfnDatastore.DatastorePartitionProperty` A single dimension to partition a data store.
`static interface`	`CfnDatastore.DatastorePartitionsProperty` Information about the partition dimensions in a data store.
`static interface`	`CfnDatastore.DatastoreStorageProperty` Where data store data is stored.
`static interface`	`CfnDatastore.FileFormatConfigurationProperty` Contains the configuration information of file formats.
`static interface`	`CfnDatastore.IotSiteWiseMultiLayerStorageProperty` Stores data used by AWS IoT SiteWise in an Amazon S3 bucket that you manage.
`static interface`	`CfnDatastore.ParquetConfigurationProperty` Contains the configuration information of the Parquet format.
`static interface`	`CfnDatastore.PartitionProperty` A single dimension to partition a data store.
`static interface`	`CfnDatastore.RetentionPeriodProperty` How long, in days, message data is kept.
`static interface`	`CfnDatastore.SchemaDefinitionProperty` Information needed to define a schema.
`static interface`	`CfnDatastore.TimestampPartitionProperty` A partition dimension defined by a timestamp attribute.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CFN_RESOURCE_TYPE_NAME` The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnDatastore(Construct scope, java.lang.String id)` Create a new `AWS::IoTAnalytics::Datastore`.
	`CfnDatastore(Construct scope, java.lang.String id, CfnDatastoreProps props)` Create a new `AWS::IoTAnalytics::Datastore`.
`protected`	`CfnDatastore(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnDatastore(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAttrId()`
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.lang.String`	`getDatastoreName()` The name of the data store.
`java.lang.Object`	`getDatastorePartitions()` Information about the partition dimensions in a data store.
`java.lang.Object`	`getDatastoreStorage()` Where data store data is stored.
`java.lang.Object`	`getFileFormatConfiguration()` Contains the configuration information of file formats.
`java.lang.Object`	`getRetentionPeriod()` How long, in days, message data is kept for the data store.
`TagManager`	`getTags()` Metadata which can be used to manage the data store.
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)`
`void`	`setDatastoreName(java.lang.String value)` The name of the data store.
`void`	`setDatastorePartitions(CfnDatastore.DatastorePartitionsProperty value)` Information about the partition dimensions in a data store.
`void`	`setDatastorePartitions(IResolvable value)` Information about the partition dimensions in a data store.
`void`	`setDatastoreStorage(CfnDatastore.DatastoreStorageProperty value)` Where data store data is stored.
`void`	`setDatastoreStorage(IResolvable value)` Where data store data is stored.
`void`	`setFileFormatConfiguration(CfnDatastore.FileFormatConfigurationProperty value)` Contains the configuration information of file formats.
`void`	`setFileFormatConfiguration(IResolvable value)` Contains the configuration information of file formats.
`void`	`setRetentionPeriod(CfnDatastore.RetentionPeriodProperty value)` How long, in days, message data is kept for the data store.
`void`	`setRetentionPeriod(IResolvable value)` How long, in days, message data is kept for the data store.

Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnDatastore
```
protected CfnDatastore(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnDatastore
```
protected CfnDatastore(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnDatastore
```
public CfnDatastore(Construct scope,
                    java.lang.String id,
                    CfnDatastoreProps props)
```
    Create a new `AWS::IoTAnalytics::Datastore`.
    
    Parameters:
    
    scope - - scope in which this resource is defined. This parameter is required.
    
    id - - scoped id of the resource. This parameter is required.
    
    props - - resource properties.
  - CfnDatastore
```
public CfnDatastore(Construct scope,
                    java.lang.String id)
```
    Create a new `AWS::IoTAnalytics::Datastore`.
    
    Parameters:
    
    scope - - scope in which this resource is defined. This parameter is required.
    
    id - - scoped id of the resource. This parameter is required.
- Method Detail
  - inspect
```
public void inspect(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
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrId
```
public java.lang.String getAttrId()
```
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
public TagManager getTags()
```
    Metadata which can be used to manage the data store.
    For more information, see Tag .
  - getDatastoreName
```
public java.lang.String getDatastoreName()
```
    The name of the data store.
  - setDatastoreName
```
public void setDatastoreName(java.lang.String value)
```
    The name of the data store.
  - getDatastorePartitions
```
public java.lang.Object getDatastorePartitions()
```
    Information about the partition dimensions in a data store.
  - setDatastorePartitions
```
public void setDatastorePartitions(IResolvable value)
```
    Information about the partition dimensions in a data store.
  - setDatastorePartitions
```
public void setDatastorePartitions(CfnDatastore.DatastorePartitionsProperty value)
```
    Information about the partition dimensions in a data store.
  - getDatastoreStorage
```
public java.lang.Object getDatastoreStorage()
```
    Where data store data is stored.
  - setDatastoreStorage
```
public void setDatastoreStorage(IResolvable value)
```
    Where data store data is stored.
  - setDatastoreStorage
```
public void setDatastoreStorage(CfnDatastore.DatastoreStorageProperty value)
```
    Where data store data is stored.
  - getFileFormatConfiguration
```
public java.lang.Object getFileFormatConfiguration()
```
    Contains the configuration information of file formats. AWS IoT Analytics data stores support JSON and [Parquet](https://docs.aws.amazon.com/https://parquet.apache.org/) .
    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.
  - setFileFormatConfiguration
```
public void setFileFormatConfiguration(IResolvable value)
```
    Contains the configuration information of file formats. AWS IoT Analytics data stores support JSON and [Parquet](https://docs.aws.amazon.com/https://parquet.apache.org/) .
    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.
  - setFileFormatConfiguration
```
public void setFileFormatConfiguration(CfnDatastore.FileFormatConfigurationProperty value)
```
    Contains the configuration information of file formats. AWS IoT Analytics data stores support JSON and [Parquet](https://docs.aws.amazon.com/https://parquet.apache.org/) .
    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
```
public java.lang.Object getRetentionPeriod()
```
    How long, in days, message data is kept for the data store.
    When customerManagedS3 storage is selected, this parameter is ignored.
  - setRetentionPeriod
```
public void setRetentionPeriod(IResolvable value)
```
    How long, in days, message data is kept for the data store.
    When customerManagedS3 storage is selected, this parameter is ignored.
  - setRetentionPeriod
```
public void setRetentionPeriod(CfnDatastore.RetentionPeriodProperty value)
```
    How long, in days, message data is kept for the data store.
    When customerManagedS3 storage is selected, this parameter is ignored.

Class CfnDatastore

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnDatastore

CfnDatastore

CfnDatastore

CfnDatastore

Method Detail

inspect

renderProperties

getAttrId

getCfnProperties

getTags

getDatastoreName

setDatastoreName

getDatastorePartitions

setDatastorePartitions

setDatastorePartitions

getDatastoreStorage

setDatastoreStorage

setDatastoreStorage

getFileFormatConfiguration

setFileFormatConfiguration

setFileFormatConfiguration

getRetentionPeriod

setRetentionPeriod

setRetentionPeriod