storage_configurations

Creates, updates, deletes, gets or lists a storage_configurations resource.

Overview

Name	storage_configurations
Type	Resource
Id	aws.iotsitewise.storage_configurations

Fields

The following fields are returned by SELECT queries:

describe_storage_configuration

Name	Datatype	Description
configuration_status	object	Contains current status information for the configuration.
disallow_ingest_null_na_n	boolean	Describes the configuration for ingesting NULL and NaN data. By default the feature is allowed. The feature is disallowed if the value is true.
disassociated_data_storage	string	Contains the storage configuration for time series (data streams) that aren't associated with asset properties. The disassociatedDataStorage can be one of the following values: ENABLED – IoT SiteWise accepts time series that aren't associated with asset properties. After the disassociatedDataStorage is enabled, you can't disable it. DISABLED – IoT SiteWise doesn't accept time series (data streams) that aren't associated with asset properties. For more information, see Data streams in the IoT SiteWise User Guide. (ENABLED, DISABLED)
last_update_date	string (date-time)	The date the storage configuration was last updated, in Unix epoch time.
multi_layer_storage	object	Contains information about the storage destination.
retention_period	object	The number of days your data is kept in the hot tier. By default, your data is kept indefinitely in the hot tier.
storage_type	string	The storage tier that you specified for your data. The storageType parameter can be one of the following values: SITEWISE_DEFAULT_STORAGE – IoT SiteWise saves your data into the hot tier. The hot tier is a service-managed database. MULTI_LAYER_STORAGE – IoT SiteWise saves your data in both the cold tier and the hot tier. The cold tier is a customer-managed Amazon S3 bucket. (SITEWISE_DEFAULT_STORAGE, MULTI_LAYER_STORAGE)
warm_tier	string	A service managed storage tier optimized for analytical queries. It stores periodically uploaded, buffered and historical data ingested with the CreaeBulkImportJob API. (ENABLED, DISABLED)
warm_tier_retention_period	object	Set this period to specify how long your data is stored in the warm tier before it is deleted. You can set this only if cold tier is enabled.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_storage_configuration	select	region		Retrieves information about the storage configuration for IoT SiteWise.
put_storage_configuration	replace	region, storageType		Configures storage settings for IoT SiteWise.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_storage_configuration

Retrieves information about the storage configuration for IoT SiteWise.

SELECT
configuration_status,
disallow_ingest_null_na_n,
disassociated_data_storage,
last_update_date,
multi_layer_storage,
retention_period,
storage_type,
warm_tier,
warm_tier_retention_period
FROM aws.iotsitewise.storage_configurations
WHERE region = '{{ region }}' -- required
;

REPLACE examples

put_storage_configuration

Configures storage settings for IoT SiteWise.

REPLACE aws.iotsitewise.storage_configurations
SET 
storageType = '{{ storageType }}',
multiLayerStorage = '{{ multiLayerStorage }}',
disassociatedDataStorage = '{{ disassociatedDataStorage }}',
retentionPeriod = '{{ retentionPeriod }}',
warmTier = '{{ warmTier }}',
warmTierRetentionPeriod = '{{ warmTierRetentionPeriod }}',
disallowIngestNullNaN = {{ disallowIngestNullNaN }}
WHERE 
region = '{{ region }}' --required
AND storageType = '{{ storageType }}' --required
RETURNING
configuration_status,
disallow_ingest_null_na_n,
disassociated_data_storage,
multi_layer_storage,
retention_period,
storage_type,
warm_tier,
warm_tier_retention_period;