Class: Aws::IoTAnalytics::Types::Datastore

Inherits:

Struct

• Object
• Struct
• Aws::IoTAnalytics::Types::Datastore

Includes:

Structure

Defined in:

lib/aws-sdk-iotanalytics/types.rb

Overview

Information about a data store.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #arn ⇒ String

  The ARN of the data store.

• #creation_time ⇒ Time

  When the data store was created.

• #datastore_partitions ⇒ Types::DatastorePartitions

  Contains information about the partition dimensions in a data store.

• #file_format_configuration ⇒ Types::FileFormatConfiguration

  Contains the configuration information of file formats.

• #last_message_arrival_time ⇒ Time

  The last time when a new message arrived in the data store.

• #last_update_time ⇒ Time

  The last time the data store was updated.

• #name ⇒ String

  The name of the data store.

• #retention_period ⇒ Types::RetentionPeriod

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

• #status ⇒ String

  The status of a data store:.

• #storage ⇒ Types::DatastoreStorage

  Where data in a data store is stored..

Instance Attribute Details

#arn ⇒ String

The ARN of the data store.

Returns:

• (String)

# File 'lib/aws-sdk-iotanalytics/types.rb', line 1168

class Datastore < Struct.new(
  :name,
  :storage,
  :arn,
  :status,
  :retention_period,
  :creation_time,
  :last_update_time,
  :last_message_arrival_time,
  :file_format_configuration,
  :datastore_partitions)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time ⇒ Time

When the data store was created.

Returns:

• (Time)

# File 'lib/aws-sdk-iotanalytics/types.rb', line 1168

class Datastore < Struct.new(
  :name,
  :storage,
  :arn,
  :status,
  :retention_period,
  :creation_time,
  :last_update_time,
  :last_message_arrival_time,
  :file_format_configuration,
  :datastore_partitions)
  SENSITIVE = []
  include Aws::Structure
end

#datastore_partitions ⇒ Types::DatastorePartitions

Contains information about the partition dimensions in a data store.

Returns:

• (Types::DatastorePartitions)

# File 'lib/aws-sdk-iotanalytics/types.rb', line 1168

class Datastore < Struct.new(
  :name,
  :storage,
  :arn,
  :status,
  :retention_period,
  :creation_time,
  :last_update_time,
  :last_message_arrival_time,
  :file_format_configuration,
  :datastore_partitions)
  SENSITIVE = []
  include Aws::Structure
end

#file_format_configuration ⇒ Types::FileFormatConfiguration

Contains the configuration information of file formats. IoT Analytics data stores support JSON and [Parquet].

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.

[1]: parquet.apache.org/

Returns:

• (Types::FileFormatConfiguration)

# File 'lib/aws-sdk-iotanalytics/types.rb', line 1168

class Datastore < Struct.new(
  :name,
  :storage,
  :arn,
  :status,
  :retention_period,
  :creation_time,
  :last_update_time,
  :last_message_arrival_time,
  :file_format_configuration,
  :datastore_partitions)
  SENSITIVE = []
  include Aws::Structure
end

#last_message_arrival_time ⇒ Time

The last time when a new message arrived in the data store.

IoT Analytics updates this value at most once per minute for Amazon Simple Storage Service one data store. Hence, the ‘lastMessageArrivalTime` value is an approximation.

This feature only applies to messages that arrived in the data store after October 23, 2020.

Returns:

• (Time)

# File 'lib/aws-sdk-iotanalytics/types.rb', line 1168

class Datastore < Struct.new(
  :name,
  :storage,
  :arn,
  :status,
  :retention_period,
  :creation_time,
  :last_update_time,
  :last_message_arrival_time,
  :file_format_configuration,
  :datastore_partitions)
  SENSITIVE = []
  include Aws::Structure
end

#last_update_time ⇒ Time

The last time the data store was updated.

Returns:

• (Time)

# File 'lib/aws-sdk-iotanalytics/types.rb', line 1168

class Datastore < Struct.new(
  :name,
  :storage,
  :arn,
  :status,
  :retention_period,
  :creation_time,
  :last_update_time,
  :last_message_arrival_time,
  :file_format_configuration,
  :datastore_partitions)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the data store.

Returns:

• (String)

# File 'lib/aws-sdk-iotanalytics/types.rb', line 1168

class Datastore < Struct.new(
  :name,
  :storage,
  :arn,
  :status,
  :retention_period,
  :creation_time,
  :last_update_time,
  :last_message_arrival_time,
  :file_format_configuration,
  :datastore_partitions)
  SENSITIVE = []
  include Aws::Structure
end

#retention_period ⇒ Types::RetentionPeriod

How long, in days, message data is kept for the data store. When ‘customerManagedS3` storage is selected, this parameter is ignored.

Returns:

• (Types::RetentionPeriod)

# File 'lib/aws-sdk-iotanalytics/types.rb', line 1168

class Datastore < Struct.new(
  :name,
  :storage,
  :arn,
  :status,
  :retention_period,
  :creation_time,
  :last_update_time,
  :last_message_arrival_time,
  :file_format_configuration,
  :datastore_partitions)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of a data store:

CREATING

: The data store is being created.

ACTIVE

: The data store has been created and can be used.

DELETING

: The data store is being deleted.

Returns:

• (String)

# File 'lib/aws-sdk-iotanalytics/types.rb', line 1168

class Datastore < Struct.new(
  :name,
  :storage,
  :arn,
  :status,
  :retention_period,
  :creation_time,
  :last_update_time,
  :last_message_arrival_time,
  :file_format_configuration,
  :datastore_partitions)
  SENSITIVE = []
  include Aws::Structure
end

#storage ⇒ Types::DatastoreStorage

Where data in a data store is stored.. You can choose ‘serviceManagedS3` storage, `customerManagedS3` storage, or `iotSiteWiseMultiLayerStorage` storage. The default is `serviceManagedS3`. You can’t change the choice of Amazon S3 storage after your data store is created.

Returns:

• (Types::DatastoreStorage)

# File 'lib/aws-sdk-iotanalytics/types.rb', line 1168

class Datastore < Struct.new(
  :name,
  :storage,
  :arn,
  :status,
  :retention_period,
  :creation_time,
  :last_update_time,
  :last_message_arrival_time,
  :file_format_configuration,
  :datastore_partitions)
  SENSITIVE = []
  include Aws::Structure
end