Skip to content

OfflineStoreConfig

Used by
Source code in docs_src/capo_sagemaker/types/offline_store_config.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
class OfflineStoreConfig(TypedDict, closed=True):
    s3_storage_config: NotRequired[
        "capo_sagemaker.types.s3_storage_config.S3StorageConfig"
    ]
    """<p>The Amazon Simple Storage (Amazon S3) location of <code>OfflineStore</code>.</p>"""
    disable_glue_table_creation: NotRequired["capo_sagemaker.types.boolean.Boolean"]
    """<p>Set to <code>True</code> to disable the automatic creation of an Amazon Web Services Glue table when configuring an <code>OfflineStore</code>. If set to <code>True</code> and <code>DataCatalogConfig</code> is provided, Feature Store associates the provided catalog configuration with the feature group without creating a table. In this case, you are responsible for creating and managing the Glue table. If set to <code>True</code> without <code>DataCatalogConfig</code>, no Glue table is created or associated with the feature group. The <code>Iceberg</code> table format is only supported when this is set to <code>False</code>.</p> <p>If set to <code>False</code> and <code>DataCatalogConfig</code> is provided, Feature Store creates the table using the specified names. If set to <code>False</code> without <code>DataCatalogConfig</code>, Feature Store auto-generates the table name following <a href="https://docs.aws.amazon.com/athena/latest/ug/tables-databases-columns-names.html">Athena's naming recommendations</a>. This applies to both Glue and Apache Iceberg table formats.</p> <p>The default value is <code>False</code>.</p>"""
    data_catalog_config: NotRequired[
        "capo_sagemaker.types.data_catalog_config.DataCatalogConfig"
    ]
    """<p>The meta data of the Glue table for the <code>OfflineStore</code>. If not provided, Feature Store auto-generates the table name, database, and catalog when the <code>OfflineStore</code> is created. You can optionally provide this configuration to specify custom values. This applies to both Glue and Apache Iceberg table formats.</p>"""
    table_format: NotRequired["capo_sagemaker.types.table_format.TableFormat"]
    """<p>Format for the offline store table. Supported formats are Glue (Default) and <a href="https://iceberg.apache.org/">Apache Iceberg</a>.</p>"""

data_catalog_config instance-attribute 

data_catalog_config: NotRequired[DataCatalogConfig]

The meta data of the Glue table for the OfflineStore. If not provided, Feature Store auto-generates the table name, database, and catalog when the OfflineStore is created. You can optionally provide this configuration to specify custom values. This applies to both Glue and Apache Iceberg table formats.

disable_glue_table_creation instance-attribute 

disable_glue_table_creation: NotRequired[Boolean]

Set to True to disable the automatic creation of an Amazon Web Services Glue table when configuring an OfflineStore. If set to True and DataCatalogConfig is provided, Feature Store associates the provided catalog configuration with the feature group without creating a table. In this case, you are responsible for creating and managing the Glue table. If set to True without DataCatalogConfig, no Glue table is created or associated with the feature group. The Iceberg table format is only supported when this is set to False.

If set to False and DataCatalogConfig is provided, Feature Store creates the table using the specified names. If set to False without DataCatalogConfig, Feature Store auto-generates the table name following Athena's naming recommendations. This applies to both Glue and Apache Iceberg table formats.

The default value is False.

s3_storage_config instance-attribute 

s3_storage_config: NotRequired[S3StorageConfig]

The Amazon Simple Storage (Amazon S3) location of OfflineStore.

table_format instance-attribute 

table_format: NotRequired[TableFormat]

Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg.