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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.943Z")
 @Stability(value=Stable)
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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnDatastore(software.constructs.Construct scope, String id) Create a new `AWS::IoTAnalytics::Datastore`.
	CfnDatastore(software.constructs.Construct scope, 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

Modifier and Type	Method and Description
String	getAttrId()
protected Map<String,Object>	getCfnProperties()
String	getDatastoreName() The name of the data store.
Object	getDatastorePartitions() Information about the partition dimensions in a data store.
Object	getDatastoreStorage() Where data store data is stored.
Object	getFileFormatConfiguration() Contains the configuration information of file formats.
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 Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDatastoreName(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.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=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 - - scoped id of the resource. This parameter is required.

props - - resource properties.

CfnDatastore

@Stability(value=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 - - scoped id of the resource. This parameter is required.

Method Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrId()

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

Metadata which can be used to manage the data store.

For more information, see Tag .

getDatastoreName

@Stability(value=Stable)
 @Nullable
public String getDatastoreName()

The name of the data store.

setDatastoreName

@Stability(value=Stable)
public void setDatastoreName(@Nullable
                                                      String value)

The name of the data store.

getDatastorePartitions

@Stability(value=Stable)
 @Nullable
public Object getDatastorePartitions()

Information about the partition dimensions in a data store.

setDatastorePartitions

@Stability(value=Stable)
public void setDatastorePartitions(@Nullable
                                                            CfnDatastore.DatastorePartitionsProperty value)

Information about the partition dimensions in a data store.

setDatastorePartitions

@Stability(value=Stable)
public void setDatastorePartitions(@Nullable
                                                            IResolvable value)

Information about the partition dimensions in a data store.

getDatastoreStorage

@Stability(value=Stable)
 @Nullable
public Object getDatastoreStorage()

Where data store data is stored.

setDatastoreStorage

@Stability(value=Stable)
public void setDatastoreStorage(@Nullable
                                                         CfnDatastore.DatastoreStorageProperty value)

Where data store data is stored.

setDatastoreStorage

@Stability(value=Stable)
public void setDatastoreStorage(@Nullable
                                                         IResolvable value)

Where data store data is stored.

getFileFormatConfiguration

@Stability(value=Stable)
 @Nullable
public 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

@Stability(value=Stable)
public void setFileFormatConfiguration(@Nullable
                                                                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.

setFileFormatConfiguration

@Stability(value=Stable)
public void setFileFormatConfiguration(@Nullable
                                                                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.

getRetentionPeriod

@Stability(value=Stable)
 @Nullable
public Object getRetentionPeriod()

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

When customerManagedS3 storage is selected, this parameter is ignored.

setRetentionPeriod

@Stability(value=Stable)
public void setRetentionPeriod(@Nullable
                                                        CfnDatastore.RetentionPeriodProperty value)

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

When customerManagedS3 storage is selected, this parameter is ignored.

setRetentionPeriod

@Stability(value=Stable)
public void setRetentionPeriod(@Nullable
                                                        IResolvable value)

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

When customerManagedS3 storage is selected, this parameter is ignored.