OfflineStoreConfigProperty Struct
The configuration of an OfflineStore .
Provide an OfflineStoreConfig in a request to CreateFeatureGroup to create an OfflineStore .
To encrypt an OfflineStore using at rest data encryption, specify AWS Key Management Service (KMS) key ID, or KMSKeyId , in S3StorageConfig .
| Source | |
|---|---|
| Type last changed |
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sagemaker as sagemaker } from 'aws-cdk-lib';
const offlineStoreConfigProperty: sagemaker.CfnFeatureGroup.OfflineStoreConfigProperty = {
s3StorageConfig: {
s3Uri: 's3Uri',
// the properties below are optional
kmsKeyId: 'kmsKeyId',
},
// the properties below are optional
dataCatalogConfig: {
catalog: 'catalog',
database: 'database',
tableName: 'tableName',
},
disableGlueTableCreation: false,
tableFormat: 'tableFormat',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sagemaker as sagemaker
offline_store_config_property = sagemaker.CfnFeatureGroup.OfflineStoreConfigProperty(
s3_storage_config=sagemaker.CfnFeatureGroup.S3StorageConfigProperty(
s3_uri="s3Uri",
# the properties below are optional
kms_key_id="kmsKeyId"
),
# the properties below are optional
data_catalog_config=sagemaker.CfnFeatureGroup.DataCatalogConfigProperty(
catalog="catalog",
database="database",
table_name="tableName"
),
disable_glue_table_creation=False,
table_format="tableFormat"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.sagemaker.*;
OfflineStoreConfigProperty offlineStoreConfigProperty = OfflineStoreConfigProperty.builder()
.s3StorageConfig(S3StorageConfigProperty.builder()
.s3Uri("s3Uri")
// the properties below are optional
.kmsKeyId("kmsKeyId")
.build())
// the properties below are optional
.dataCatalogConfig(DataCatalogConfigProperty.builder()
.catalog("catalog")
.database("database")
.tableName("tableName")
.build())
.disableGlueTableCreation(false)
.tableFormat("tableFormat")
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Sagemaker;
var offlineStoreConfigProperty = new OfflineStoreConfigProperty {
S3StorageConfig = new S3StorageConfigProperty {
S3Uri = "s3Uri",
// the properties below are optional
KmsKeyId = "kmsKeyId"
},
// the properties below are optional
DataCatalogConfig = new DataCatalogConfigProperty {
Catalog = "catalog",
Database = "database",
TableName = "tableName"
},
DisableGlueTableCreation = false,
TableFormat = "tableFormat"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
offlineStoreConfigProperty := &OfflineStoreConfigProperty{
S3StorageConfig: &S3StorageConfigProperty{
S3Uri: jsii.String("s3Uri"),
// the properties below are optional
KmsKeyId: jsii.String("kmsKeyId"),
},
// the properties below are optional
DataCatalogConfig: &DataCatalogConfigProperty{
Catalog: jsii.String("catalog"),
Database: jsii.String("database"),
TableName: jsii.String("tableName"),
},
DisableGlueTableCreation: jsii.Boolean(false),
TableFormat: jsii.String("tableFormat"),
}
Properties
dataCatalogConfigoptionalIResolvable | CfnFeatureGroup.data_catalog_configoptionaltyping.Union[IResolvable, DataCatalogConfigProperty]dataCatalogConfigoptionalIResolvableDataCatalogConfigoptionalIResolvableDataCatalogConfigoptionalinterface{} #The meta data of the Glue table that is autogenerated when an `OfflineStore` is created.
disableGlueTableCreationoptionalboolean | IResolvabledisable_glue_table_creationoptionaltyping.Union[bool, IResolvable]disableGlueTableCreationoptionalBooleanDisableGlueTableCreationoptionalboolDisableGlueTableCreationoptionalinterface{} #Set to `True` to disable the automatic creation of an AWS Glue table when configuring an `OfflineStore` .
If set to False , Feature Store will name the OfflineStore Glue table following Athena's naming recommendations .
The default value is False .
s3StorageConfigIResolvable | CfnFeatureGroup.s3_storage_configtyping.Union[IResolvable, S3StorageConfigProperty]s3StorageConfigIResolvableS3StorageConfigIResolvableS3StorageConfiginterface{} required #The Amazon Simple Storage (Amazon S3) location of `OfflineStore` .
tableFormatoptionalstringtable_formatoptionalstrtableFormatoptionalStringTableFormatoptionalstringTableFormatoptional*string #Format for the offline store table.
Supported formats are Glue (Default) and Apache Iceberg .