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.46.0 (build cd08c55)",
           date="2021-11-25T20:11:06.862Z")
 @Stability(value=Stable)
public class CfnDatastore
extends CfnResource
implements IInspectable

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

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.*;
 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(ServiceManagedS3Property.builder().build())
                 .build())
         .fileFormatConfiguration(FileFormatConfigurationProperty.builder()
                 .jsonConfiguration(JsonConfigurationProperty.builder().build())
                 .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 Example:
static interface	CfnDatastore.CustomerManagedS3Property Example:
static interface	CfnDatastore.CustomerManagedS3StorageProperty Example:
static interface	CfnDatastore.DatastorePartitionProperty Example:
static interface	CfnDatastore.DatastorePartitionsProperty Example:
static interface	CfnDatastore.DatastoreStorageProperty Example:
static interface	CfnDatastore.FileFormatConfigurationProperty Example:
static interface	CfnDatastore.IotSiteWiseMultiLayerStorageProperty Example:
static interface	CfnDatastore.JsonConfigurationProperty Example:
static interface	CfnDatastore.ParquetConfigurationProperty Example:
static interface	CfnDatastore.PartitionProperty Example:
static interface	CfnDatastore.RetentionPeriodProperty Example:
static interface	CfnDatastore.SchemaDefinitionProperty Example:
static interface	CfnDatastore.ServiceManagedS3Property Example:
static interface	CfnDatastore.TimestampPartitionProperty Example:

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
protected Map<String,Object>	getCfnProperties()
String	getDatastoreName() `AWS::IoTAnalytics::Datastore.DatastoreName`.
Object	getDatastorePartitions() `AWS::IoTAnalytics::Datastore.DatastorePartitions`.
Object	getDatastoreStorage() `AWS::IoTAnalytics::Datastore.DatastoreStorage`.
Object	getFileFormatConfiguration() `AWS::IoTAnalytics::Datastore.FileFormatConfiguration`.
Object	getRetentionPeriod() `AWS::IoTAnalytics::Datastore.RetentionPeriod`.
TagManager	getTags() `AWS::IoTAnalytics::Datastore.Tags`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDatastoreName(String value) `AWS::IoTAnalytics::Datastore.DatastoreName`.
void	setDatastorePartitions(CfnDatastore.DatastorePartitionsProperty value) `AWS::IoTAnalytics::Datastore.DatastorePartitions`.
void	setDatastorePartitions(IResolvable value) `AWS::IoTAnalytics::Datastore.DatastorePartitions`.
void	setDatastoreStorage(CfnDatastore.DatastoreStorageProperty value) `AWS::IoTAnalytics::Datastore.DatastoreStorage`.
void	setDatastoreStorage(IResolvable value) `AWS::IoTAnalytics::Datastore.DatastoreStorage`.
void	setFileFormatConfiguration(CfnDatastore.FileFormatConfigurationProperty value) `AWS::IoTAnalytics::Datastore.FileFormatConfiguration`.
void	setFileFormatConfiguration(IResolvable value) `AWS::IoTAnalytics::Datastore.FileFormatConfiguration`.
void	setRetentionPeriod(CfnDatastore.RetentionPeriodProperty value) `AWS::IoTAnalytics::Datastore.RetentionPeriod`.
void	setRetentionPeriod(IResolvable value) `AWS::IoTAnalytics::Datastore.RetentionPeriod`.

Methods inherited from class software.amazon.awscdk.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.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.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getDatastoreName

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

`AWS::IoTAnalytics::Datastore.DatastoreName`.

setDatastoreName

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

`AWS::IoTAnalytics::Datastore.DatastoreName`.

getDatastorePartitions

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

`AWS::IoTAnalytics::Datastore.DatastorePartitions`.

setDatastorePartitions

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

`AWS::IoTAnalytics::Datastore.DatastorePartitions`.

setDatastorePartitions

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

`AWS::IoTAnalytics::Datastore.DatastorePartitions`.

getDatastoreStorage

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

`AWS::IoTAnalytics::Datastore.DatastoreStorage`.

setDatastoreStorage

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

`AWS::IoTAnalytics::Datastore.DatastoreStorage`.

setDatastoreStorage

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

`AWS::IoTAnalytics::Datastore.DatastoreStorage`.

getFileFormatConfiguration

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

`AWS::IoTAnalytics::Datastore.FileFormatConfiguration`.

setFileFormatConfiguration

@Stability(value=Stable)
public void setFileFormatConfiguration(@Nullable
                                                                CfnDatastore.FileFormatConfigurationProperty value)

`AWS::IoTAnalytics::Datastore.FileFormatConfiguration`.

setFileFormatConfiguration

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

`AWS::IoTAnalytics::Datastore.FileFormatConfiguration`.

getRetentionPeriod

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

`AWS::IoTAnalytics::Datastore.RetentionPeriod`.

setRetentionPeriod

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

`AWS::IoTAnalytics::Datastore.RetentionPeriod`.

setRetentionPeriod

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

`AWS::IoTAnalytics::Datastore.RetentionPeriod`.

getTags

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

`AWS::IoTAnalytics::Datastore.Tags`.