Class CfnDatastore
AWS::IoTAnalytics::Datastore resource is a repository for messages.
Inherited Members
Namespace: Amazon.CDK.AWS.IoTAnalytics
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDatastore : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnDatastore
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
For more information, see How to Use AWS IoT Analytics in the AWS IoT Analytics User Guide .
CloudformationResource: AWS::IoTAnalytics::Datastore
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.IoTAnalytics;
var jsonConfiguration;
var serviceManagedS3;
var cfnDatastore = new CfnDatastore(this, "MyCfnDatastore", new CfnDatastoreProps {
DatastoreName = "datastoreName",
DatastorePartitions = new DatastorePartitionsProperty {
Partitions = new [] { new DatastorePartitionProperty {
Partition = new PartitionProperty {
AttributeName = "attributeName"
},
TimestampPartition = new TimestampPartitionProperty {
AttributeName = "attributeName",
// the properties below are optional
TimestampFormat = "timestampFormat"
}
} }
},
DatastoreStorage = new DatastoreStorageProperty {
CustomerManagedS3 = new CustomerManagedS3Property {
Bucket = "bucket",
RoleArn = "roleArn",
// the properties below are optional
KeyPrefix = "keyPrefix"
},
IotSiteWiseMultiLayerStorage = new IotSiteWiseMultiLayerStorageProperty {
CustomerManagedS3Storage = new CustomerManagedS3StorageProperty {
Bucket = "bucket",
// the properties below are optional
KeyPrefix = "keyPrefix"
}
},
ServiceManagedS3 = serviceManagedS3
},
FileFormatConfiguration = new FileFormatConfigurationProperty {
JsonConfiguration = jsonConfiguration,
ParquetConfiguration = new ParquetConfigurationProperty {
SchemaDefinition = new SchemaDefinitionProperty {
Columns = new [] { new ColumnProperty {
Name = "name",
Type = "type"
} }
}
}
},
RetentionPeriod = new RetentionPeriodProperty {
NumberOfDays = 123,
Unlimited = false
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnDatastore(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnDatastore(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnDatastore(Construct, String, ICfnDatastoreProps) |
Properties
AttrId | |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DatastoreName | The name of the data store. |
DatastorePartitions | Information about the partition dimensions in a data store. |
DatastoreStorage | Where data store data is stored. |
FileFormatConfiguration | Contains the configuration information of file formats. |
RetentionPeriod | How long, in days, message data is kept for the data store. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | Metadata which can be used to manage the data store. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnDatastore(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnDatastore(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnDatastore(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnDatastore(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnDatastore(Construct, String, ICfnDatastoreProps)
public CfnDatastore(Construct scope, string id, ICfnDatastoreProps props = null)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnDatastoreProps
Resource properties.
Properties
AttrId
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
DatastoreName
The name of the data store.
public virtual string DatastoreName { get; set; }
Property Value
System.String
DatastorePartitions
Information about the partition dimensions in a data store.
public virtual object DatastorePartitions { get; set; }
Property Value
System.Object
DatastoreStorage
Where data store data is stored.
public virtual object DatastoreStorage { get; set; }
Property Value
System.Object
FileFormatConfiguration
Contains the configuration information of file formats.
public virtual object FileFormatConfiguration { get; set; }
Property Value
System.Object
Remarks
AWS IoT Analytics data stores support JSON and Parquet .
RetentionPeriod
How long, in days, message data is kept for the data store.
public virtual object RetentionPeriod { get; set; }
Property Value
System.Object
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
Metadata which can be used to manage the data store.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>