Resource: awsSagemakerFeatureGroup
Provides a SageMaker Feature Group resource.
Example Usage
Basic usage:
/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.sagemakerFeatureGroup.SagemakerFeatureGroup(this, "example", {
eventTimeFeatureName: "example",
featureDefinition: [
{
featureName: "example",
featureType: "String",
},
],
featureGroupName: "example",
onlineStoreConfig: {
enableOnlineStore: true,
},
recordIdentifierFeatureName: "example",
roleArn: "${aws_iam_role.test.arn}",
});
Argument Reference
The following arguments are supported:
featureGroupName
- (Required) The name of the Feature Group. The name must be unique within an AWS Region in an AWS account.recordIdentifierFeatureName
- (Required) The name of the Feature whose value uniquely identifies a Record defined in the Feature Store. Only the latest record per identifier value will be stored in the Online Store.eventTimeFeatureName
- (Required) The name of the feature that stores the EventTime of a Record in a Feature Group.description
(Optional) - A free-form description of a Feature Group.roleArn
(Required) - The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the Offline Store if anofflineStoreConfig
is provided.featureDefinition
(Optional) - A list of Feature names and types. See Feature Definition Below.offlineStoreConfig
(Optional) - The Offline Feature Store Configuration. See Offline Store Config Below.onlineStoreConfig
(Optional) - The Online Feature Store Configuration. See Online Store Config Below.tags
- (Optional) Map of resource tags for the resource. If configured with a providerdefaultTags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
Feature Definition
featureName
- (Required) The name of a feature.featureName
cannot be any of the following:isDeleted
,writeTime
,apiInvocationTime
.featureType
- (Required) The value type of a feature. Valid values areintegral
,fractional
, orstring
.
Offline Store Config
enableOnlineStore
- (Optional) Set totrue
to disable the automatic creation of an AWS Glue table when configuring an OfflineStore.s3StorageConfig
- (Required) The Amazon Simple Storage (Amazon S3) location of OfflineStore. See S3 Storage Config Below.dataCatalogConfig
- (Optional) The meta data of the Glue table that is autogenerated when an OfflineStore is created. See Data Catalog Config Below.
Online Store Config
disableGlueTableCreation
- (Optional) Set totrue
to turn Online Store On.securityConfig
- (Required) Security config for at-rest encryption of your OnlineStore. See Security Config Below.
S3 Storage Config
kmsKeyId
- (Optional) The AWS Key Management Service (KMS) key ID of the key used to encrypt any objects written into the OfflineStore S3 location.s3Uri
- (Required) The S3 URI, or location in Amazon S3, of OfflineStore.
Data Catalog Config
catalog
- (Optional) The name of the Glue table catalog.database
- (Optional) The name of the Glue table database.tableName
- (Optional) The name of the Glue table.
Security Config
kmsKeyId
- (Optional) The ID of the AWS Key Management Service (AWS KMS) key that SageMaker Feature Store uses to encrypt the Amazon S3 objects at rest using Amazon S3 server-side encryption.
Attributes Reference
In addition to all arguments above, the following attributes are exported:
name
- The name of the Feature Group.arn
- The Amazon Resource Name (ARN) assigned by AWS to this feature_group.tagsAll
- A map of tags assigned to the resource, including those inherited from the providerdefaultTags
configuration block.
Import
Feature Groups can be imported using the name
, e.g.,