@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:36.973Z") public class CfnDatastore extends CfnResource implements IInspectable
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();
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.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
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) |
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.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnDatastore(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnDatastore(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnDatastore(Construct scope, java.lang.String id, CfnDatastoreProps props)
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.public CfnDatastore(Construct scope, java.lang.String id)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrId()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
For more information, see Tag .
public java.lang.String getDatastoreName()
public void setDatastoreName(java.lang.String value)
public java.lang.Object getDatastorePartitions()
public void setDatastorePartitions(IResolvable value)
public void setDatastorePartitions(CfnDatastore.DatastorePartitionsProperty value)
public java.lang.Object getDatastoreStorage()
public void setDatastoreStorage(IResolvable value)
public void setDatastoreStorage(CfnDatastore.DatastoreStorageProperty value)
public java.lang.Object getFileFormatConfiguration()
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.
public void setFileFormatConfiguration(IResolvable value)
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.
public void setFileFormatConfiguration(CfnDatastore.FileFormatConfigurationProperty value)
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.
public java.lang.Object getRetentionPeriod()
When customerManagedS3
storage is selected, this parameter is ignored.
public void setRetentionPeriod(IResolvable value)
When customerManagedS3
storage is selected, this parameter is ignored.
public void setRetentionPeriod(CfnDatastore.RetentionPeriodProperty value)
When customerManagedS3
storage is selected, this parameter is ignored.