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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/types.rb

Overview

Information about a data store.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The ARN of the data store.

Returns:

  • (String)


1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/types.rb', line 1644

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_timeTime

When the data store was created.

Returns:

  • (Time)


1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/types.rb', line 1644

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_partitionsTypes::DatastorePartitions

Contains information about the partition dimensions in a data store.



1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/types.rb', line 1644

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_configurationTypes::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.



1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/types.rb', line 1644

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_timeTime

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)


1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/types.rb', line 1644

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_timeTime

The last time the data store was updated.

Returns:

  • (Time)


1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/types.rb', line 1644

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

#nameString

The name of the data store.

Returns:

  • (String)


1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/types.rb', line 1644

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_periodTypes::RetentionPeriod

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



1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/types.rb', line 1644

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

#statusString

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)


1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/types.rb', line 1644

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

#storageTypes::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.



1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/types.rb', line 1644

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