amazon_dynamodb_online_store_spec

class databricks.feature_store.online_store_spec.amazon_dynamodb_online_store_spec.AmazonDynamoDBSpec(*, region: Optional[str], access_key_id: Optional[str] = None, secret_access_key: Optional[str] = None, session_token: Optional[str] = None, table_name: Optional[str] = None, read_secret_prefix: Optional[str] = None, write_secret_prefix: Optional[str] = None, ttl: Optional[datetime.timedelta] = None)

Bases: databricks.feature_store.online_store_spec.online_store_spec.OnlineStoreSpec

This OnlineStoreSpec implementation is intended for publishing features to Amazon DynamoDB.

If table_name is not provided, FeatureStoreClient.publish_table will use the offline store’s database and table name combined as the online table name.

To use a different table name in the online store, provide a value for the table_name argument.

The expected read or write secrets for DynamoDB for a given {prefix} string are ${prefix}-access-key-id, ${prefix}-secret-access-key, and ${prefix}-session-token.

If none of the access_key_id, secret_access_key, and write_secret_prefix are passed, the instance profile attached to the cluster will be used to write to DynamoDB.

Note

AmazonDynamoDBSpec is available starting with Databricks Runtime 10.4 for ML.

Instance profile based writes are available starting with Databricks Runtime 10.5 for ML.

Parameters
  • region – Region to access online store.

  • access_key_id – Access key ID that has access to the online store.

  • secret_access_key – Secret access key to access the online store.

  • session_token – Session token to access the online store.

  • table_name – Table name.

  • read_secret_prefix – Prefix for read secret.

  • write_secret_prefix – Prefix for write secret.

  • ttl – The time to live for data published to the online store. This attribute is only applicable when publishing time series feature tables. If the time to live is specified for a time series table, FeatureStoreClient.publish_table() will publish a window of data instead of the latest snapshot.

Methods

auth_type()

Publish Auth type.

Properties

access_key_id

Access key ID that has access to the online store. Property will be empty if write_secret_prefix or the instance profile attached to the cluster are intended to be used.

secret_access_key

Secret access key to access the online store. Property will be empty if write_secret_prefix or the instance profile attached to the cluster are intended to be used.

session_token

Session token to access the online store. Property will be empty if write_secret_prefix or the instance profile attached to the cluster are intended to be used.

cloud

Define the cloud property for the data store.

store_type

Define the data store type.

region

Region to access the online store.

ttl

Time to live attribute for the online store.

auth_type()

Publish Auth type.

clone(**kwargs)

Clone a feature spec.

non_secret_properties()

TODO (ML-21692): Determine if this function is required and update for use if necessary.

Dictionary of non-secret properties.

property access_key_id

Access key ID that has access to the online store. Property will be empty if write_secret_prefix or the instance profile attached to the cluster are intended to be used.

property driver

Name of the custom JDBC driver to access the online store.

property password

Password to access the online store.

Property will be empty if write_scret_prefix argument was used.

property read_secret_prefix

Prefix for read access to online store.

Name of the secret scope and prefix that contains the username and password to access the online store with read-only credentials.

See the read_secret_prefix parameter description for details.

property region

Region to access the online store.

property secret_access_key

Secret access key to access the online store. Property will be empty if write_secret_prefix or the instance profile attached to the cluster are intended to be used.

property session_token

Session token to access the online store. Property will be empty if write_secret_prefix or the instance profile attached to the cluster are intended to be used.

property table_name

Table name.

property ttl

Time to live attribute for the online store.

property type

Type of the online store.

property user

Username that has access to the online store.

Property will be empty if write_scret_prefix argument was used.

property write_secret_prefix

Secret prefix that contains online store login info.

Name of the secret scope and prefix that contains the username and password to access the online store with read/write credentials. See the write_secret_prefix parameter description for details.