Class: Aws::IoTSiteWise::Types::PutStorageConfigurationRequest

Inherits:

Struct

• Object
• Struct
• Aws::IoTSiteWise::Types::PutStorageConfigurationRequest

Defined in:

gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb

Overview

Note:

When making an API call, you may pass PutStorageConfigurationRequest data as a hash:

{
  storage_type: "SITEWISE_DEFAULT_STORAGE", # required, accepts SITEWISE_DEFAULT_STORAGE, MULTI_LAYER_STORAGE
  multi_layer_storage: {
    customer_managed_s3_storage: { # required
      s3_resource_arn: "ARN", # required
      role_arn: "ARN", # required
    },
  },
  disassociated_data_storage: "ENABLED", # accepts ENABLED, DISABLED
  retention_period: {
    number_of_days: 1,
    unlimited: false,
  },
}

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #disassociated_data_storage ⇒ String

  Contains the storage configuration for time series (data streams) that aren't associated with asset properties.

• #multi_layer_storage ⇒ Types::MultiLayerStorage

  Identifies a storage destination.

• #retention_period ⇒ Types::RetentionPeriod

  How many days your data is kept in the hot tier.

• #storage_type ⇒ String

  The storage tier that you specified for your data.

Instance Attribute Details

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

Returns:

• (String)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 6710

class PutStorageConfigurationRequest < Struct.new(
  :storage_type,
  :multi_layer_storage,
  :disassociated_data_storage,
  :retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#multi_layer_storage ⇒ Types::MultiLayerStorage

Identifies a storage destination. If you specified MULTI_LAYER_STORAGE for the storage type, you must specify a MultiLayerStorage object.

Returns:

• (Types::MultiLayerStorage)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 6710

class PutStorageConfigurationRequest < Struct.new(
  :storage_type,
  :multi_layer_storage,
  :disassociated_data_storage,
  :retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#retention_period ⇒ Types::RetentionPeriod

How many days your data is kept in the hot tier. By default, your data is kept indefinitely in the hot tier.

Returns:

• (Types::RetentionPeriod)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 6710

class PutStorageConfigurationRequest < Struct.new(
  :storage_type,
  :multi_layer_storage,
  :disassociated_data_storage,
  :retention_period)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

• (String)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 6710

class PutStorageConfigurationRequest < Struct.new(
  :storage_type,
  :multi_layer_storage,
  :disassociated_data_storage,
  :retention_period)
  SENSITIVE = []
  include Aws::Structure
end