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
,ITaggable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.106.0 (build e852934)",
date="2025-02-12T12:32:04.255Z")
@Stability(Stable)
public class CfnDatastore
extends CfnResource
implements IInspectable, 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:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
A fluent builder forCfnDatastore
.static interface
Contains information about a column that stores your data.static interface
S3-customer-managed;static interface
Amazon S3 -customer-managed;static interface
A single dimension to partition a data store.static interface
Information about the partition dimensions in a data store.static interface
Where data store data is stored.static interface
Contains the configuration information of file formats.static interface
Stores data used by AWS IoT SiteWise in an Amazon S3 bucket that you manage.static interface
Contains the configuration information of the Parquet format.static interface
A single dimension to partition a data store.static interface
How long, in days, message data is kept.static interface
Information needed to define a schema.static interface
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.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
CfnDatastore
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnDatastore
(software.amazon.jsii.JsiiObjectRef objRef) CfnDatastore
(software.constructs.Construct scope, String id) CfnDatastore
(software.constructs.Construct scope, String id, CfnDatastoreProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe name of the data store.Information about the partition dimensions in a data store.Where data store data is stored.Contains the configuration information of file formats.How long, in days, message data is kept for the data store.getTags()
Tag Manager which manages the tags for this resource.Metadata which can be used to manage the data store.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setDatastoreName
(String value) The name of the data store.void
Information about the partition dimensions in a data store.void
Information about the partition dimensions in a data store.void
setDatastoreStorage
(IResolvable value) Where data store data is stored.void
Where data store data is stored.void
Contains the configuration information of file formats.void
Contains the configuration information of file formats.void
setRetentionPeriod
(IResolvable value) How long, in days, message data is kept for the data store.void
How long, in days, message data is kept for the data store.void
setTagsRaw
(List<CfnTag> value) Metadata which can be used to manage the data store.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, 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 Details
-
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) - 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) - 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
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- 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 classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrId
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getDatastoreName
The name of the data store. -
setDatastoreName
The name of the data store. -
getDatastorePartitions
Information about the partition dimensions in a data store. -
setDatastorePartitions
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
Where data store data is stored. -
setDatastoreStorage
Where data store data is stored. -
setDatastoreStorage
@Stability(Stable) public void setDatastoreStorage(@Nullable CfnDatastore.DatastoreStorageProperty value) Where data store data is stored. -
getFileFormatConfiguration
Contains the configuration information of file formats.AWS IoT Analytics data stores support JSON and Parquet .
-
setFileFormatConfiguration
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
How long, in days, message data is kept for the data store. -
setRetentionPeriod
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
Metadata which can be used to manage the data store. -
setTagsRaw
Metadata which can be used to manage the data store.
-