aws.sagemaker.FeatureGroup
Explore with Pulumi AI
Provides a SageMaker Feature Group resource.
Example Usage
Basic usage:
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.sagemaker.FeatureGroup("example", {
    featureGroupName: "example",
    recordIdentifierFeatureName: "example",
    eventTimeFeatureName: "example",
    roleArn: test.arn,
    featureDefinitions: [{
        featureName: "example",
        featureType: "String",
    }],
    onlineStoreConfig: {
        enableOnlineStore: true,
    },
});
import pulumi
import pulumi_aws as aws
example = aws.sagemaker.FeatureGroup("example",
    feature_group_name="example",
    record_identifier_feature_name="example",
    event_time_feature_name="example",
    role_arn=test["arn"],
    feature_definitions=[{
        "feature_name": "example",
        "feature_type": "String",
    }],
    online_store_config={
        "enable_online_store": True,
    })
package main
import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/sagemaker"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sagemaker.NewFeatureGroup(ctx, "example", &sagemaker.FeatureGroupArgs{
			FeatureGroupName:            pulumi.String("example"),
			RecordIdentifierFeatureName: pulumi.String("example"),
			EventTimeFeatureName:        pulumi.String("example"),
			RoleArn:                     pulumi.Any(test.Arn),
			FeatureDefinitions: sagemaker.FeatureGroupFeatureDefinitionArray{
				&sagemaker.FeatureGroupFeatureDefinitionArgs{
					FeatureName: pulumi.String("example"),
					FeatureType: pulumi.String("String"),
				},
			},
			OnlineStoreConfig: &sagemaker.FeatureGroupOnlineStoreConfigArgs{
				EnableOnlineStore: pulumi.Bool(true),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() => 
{
    var example = new Aws.Sagemaker.FeatureGroup("example", new()
    {
        FeatureGroupName = "example",
        RecordIdentifierFeatureName = "example",
        EventTimeFeatureName = "example",
        RoleArn = test.Arn,
        FeatureDefinitions = new[]
        {
            new Aws.Sagemaker.Inputs.FeatureGroupFeatureDefinitionArgs
            {
                FeatureName = "example",
                FeatureType = "String",
            },
        },
        OnlineStoreConfig = new Aws.Sagemaker.Inputs.FeatureGroupOnlineStoreConfigArgs
        {
            EnableOnlineStore = true,
        },
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.sagemaker.FeatureGroup;
import com.pulumi.aws.sagemaker.FeatureGroupArgs;
import com.pulumi.aws.sagemaker.inputs.FeatureGroupFeatureDefinitionArgs;
import com.pulumi.aws.sagemaker.inputs.FeatureGroupOnlineStoreConfigArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var example = new FeatureGroup("example", FeatureGroupArgs.builder()
            .featureGroupName("example")
            .recordIdentifierFeatureName("example")
            .eventTimeFeatureName("example")
            .roleArn(test.arn())
            .featureDefinitions(FeatureGroupFeatureDefinitionArgs.builder()
                .featureName("example")
                .featureType("String")
                .build())
            .onlineStoreConfig(FeatureGroupOnlineStoreConfigArgs.builder()
                .enableOnlineStore(true)
                .build())
            .build());
    }
}
resources:
  example:
    type: aws:sagemaker:FeatureGroup
    properties:
      featureGroupName: example
      recordIdentifierFeatureName: example
      eventTimeFeatureName: example
      roleArn: ${test.arn}
      featureDefinitions:
        - featureName: example
          featureType: String
      onlineStoreConfig:
        enableOnlineStore: true
Create FeatureGroup Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new FeatureGroup(name: string, args: FeatureGroupArgs, opts?: CustomResourceOptions);@overload
def FeatureGroup(resource_name: str,
                 args: FeatureGroupArgs,
                 opts: Optional[ResourceOptions] = None)
@overload
def FeatureGroup(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 event_time_feature_name: Optional[str] = None,
                 feature_definitions: Optional[Sequence[FeatureGroupFeatureDefinitionArgs]] = None,
                 feature_group_name: Optional[str] = None,
                 record_identifier_feature_name: Optional[str] = None,
                 role_arn: Optional[str] = None,
                 description: Optional[str] = None,
                 offline_store_config: Optional[FeatureGroupOfflineStoreConfigArgs] = None,
                 online_store_config: Optional[FeatureGroupOnlineStoreConfigArgs] = None,
                 tags: Optional[Mapping[str, str]] = None,
                 throughput_config: Optional[FeatureGroupThroughputConfigArgs] = None)func NewFeatureGroup(ctx *Context, name string, args FeatureGroupArgs, opts ...ResourceOption) (*FeatureGroup, error)public FeatureGroup(string name, FeatureGroupArgs args, CustomResourceOptions? opts = null)
public FeatureGroup(String name, FeatureGroupArgs args)
public FeatureGroup(String name, FeatureGroupArgs args, CustomResourceOptions options)
type: aws:sagemaker:FeatureGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args FeatureGroupArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args FeatureGroupArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args FeatureGroupArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args FeatureGroupArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args FeatureGroupArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var featureGroupResource = new Aws.Sagemaker.FeatureGroup("featureGroupResource", new()
{
    EventTimeFeatureName = "string",
    FeatureDefinitions = new[]
    {
        new Aws.Sagemaker.Inputs.FeatureGroupFeatureDefinitionArgs
        {
            CollectionConfig = new Aws.Sagemaker.Inputs.FeatureGroupFeatureDefinitionCollectionConfigArgs
            {
                VectorConfig = new Aws.Sagemaker.Inputs.FeatureGroupFeatureDefinitionCollectionConfigVectorConfigArgs
                {
                    Dimension = 0,
                },
            },
            CollectionType = "string",
            FeatureName = "string",
            FeatureType = "string",
        },
    },
    FeatureGroupName = "string",
    RecordIdentifierFeatureName = "string",
    RoleArn = "string",
    Description = "string",
    OfflineStoreConfig = new Aws.Sagemaker.Inputs.FeatureGroupOfflineStoreConfigArgs
    {
        S3StorageConfig = new Aws.Sagemaker.Inputs.FeatureGroupOfflineStoreConfigS3StorageConfigArgs
        {
            S3Uri = "string",
            KmsKeyId = "string",
            ResolvedOutputS3Uri = "string",
        },
        DataCatalogConfig = new Aws.Sagemaker.Inputs.FeatureGroupOfflineStoreConfigDataCatalogConfigArgs
        {
            Catalog = "string",
            Database = "string",
            TableName = "string",
        },
        DisableGlueTableCreation = false,
        TableFormat = "string",
    },
    OnlineStoreConfig = new Aws.Sagemaker.Inputs.FeatureGroupOnlineStoreConfigArgs
    {
        EnableOnlineStore = false,
        SecurityConfig = new Aws.Sagemaker.Inputs.FeatureGroupOnlineStoreConfigSecurityConfigArgs
        {
            KmsKeyId = "string",
        },
        StorageType = "string",
        TtlDuration = new Aws.Sagemaker.Inputs.FeatureGroupOnlineStoreConfigTtlDurationArgs
        {
            Unit = "string",
            Value = 0,
        },
    },
    Tags = 
    {
        { "string", "string" },
    },
    ThroughputConfig = new Aws.Sagemaker.Inputs.FeatureGroupThroughputConfigArgs
    {
        ProvisionedReadCapacityUnits = 0,
        ProvisionedWriteCapacityUnits = 0,
        ThroughputMode = "string",
    },
});
example, err := sagemaker.NewFeatureGroup(ctx, "featureGroupResource", &sagemaker.FeatureGroupArgs{
	EventTimeFeatureName: pulumi.String("string"),
	FeatureDefinitions: sagemaker.FeatureGroupFeatureDefinitionArray{
		&sagemaker.FeatureGroupFeatureDefinitionArgs{
			CollectionConfig: &sagemaker.FeatureGroupFeatureDefinitionCollectionConfigArgs{
				VectorConfig: &sagemaker.FeatureGroupFeatureDefinitionCollectionConfigVectorConfigArgs{
					Dimension: pulumi.Int(0),
				},
			},
			CollectionType: pulumi.String("string"),
			FeatureName:    pulumi.String("string"),
			FeatureType:    pulumi.String("string"),
		},
	},
	FeatureGroupName:            pulumi.String("string"),
	RecordIdentifierFeatureName: pulumi.String("string"),
	RoleArn:                     pulumi.String("string"),
	Description:                 pulumi.String("string"),
	OfflineStoreConfig: &sagemaker.FeatureGroupOfflineStoreConfigArgs{
		S3StorageConfig: &sagemaker.FeatureGroupOfflineStoreConfigS3StorageConfigArgs{
			S3Uri:               pulumi.String("string"),
			KmsKeyId:            pulumi.String("string"),
			ResolvedOutputS3Uri: pulumi.String("string"),
		},
		DataCatalogConfig: &sagemaker.FeatureGroupOfflineStoreConfigDataCatalogConfigArgs{
			Catalog:   pulumi.String("string"),
			Database:  pulumi.String("string"),
			TableName: pulumi.String("string"),
		},
		DisableGlueTableCreation: pulumi.Bool(false),
		TableFormat:              pulumi.String("string"),
	},
	OnlineStoreConfig: &sagemaker.FeatureGroupOnlineStoreConfigArgs{
		EnableOnlineStore: pulumi.Bool(false),
		SecurityConfig: &sagemaker.FeatureGroupOnlineStoreConfigSecurityConfigArgs{
			KmsKeyId: pulumi.String("string"),
		},
		StorageType: pulumi.String("string"),
		TtlDuration: &sagemaker.FeatureGroupOnlineStoreConfigTtlDurationArgs{
			Unit:  pulumi.String("string"),
			Value: pulumi.Int(0),
		},
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	ThroughputConfig: &sagemaker.FeatureGroupThroughputConfigArgs{
		ProvisionedReadCapacityUnits:  pulumi.Int(0),
		ProvisionedWriteCapacityUnits: pulumi.Int(0),
		ThroughputMode:                pulumi.String("string"),
	},
})
var featureGroupResource = new FeatureGroup("featureGroupResource", FeatureGroupArgs.builder()
    .eventTimeFeatureName("string")
    .featureDefinitions(FeatureGroupFeatureDefinitionArgs.builder()
        .collectionConfig(FeatureGroupFeatureDefinitionCollectionConfigArgs.builder()
            .vectorConfig(FeatureGroupFeatureDefinitionCollectionConfigVectorConfigArgs.builder()
                .dimension(0)
                .build())
            .build())
        .collectionType("string")
        .featureName("string")
        .featureType("string")
        .build())
    .featureGroupName("string")
    .recordIdentifierFeatureName("string")
    .roleArn("string")
    .description("string")
    .offlineStoreConfig(FeatureGroupOfflineStoreConfigArgs.builder()
        .s3StorageConfig(FeatureGroupOfflineStoreConfigS3StorageConfigArgs.builder()
            .s3Uri("string")
            .kmsKeyId("string")
            .resolvedOutputS3Uri("string")
            .build())
        .dataCatalogConfig(FeatureGroupOfflineStoreConfigDataCatalogConfigArgs.builder()
            .catalog("string")
            .database("string")
            .tableName("string")
            .build())
        .disableGlueTableCreation(false)
        .tableFormat("string")
        .build())
    .onlineStoreConfig(FeatureGroupOnlineStoreConfigArgs.builder()
        .enableOnlineStore(false)
        .securityConfig(FeatureGroupOnlineStoreConfigSecurityConfigArgs.builder()
            .kmsKeyId("string")
            .build())
        .storageType("string")
        .ttlDuration(FeatureGroupOnlineStoreConfigTtlDurationArgs.builder()
            .unit("string")
            .value(0)
            .build())
        .build())
    .tags(Map.of("string", "string"))
    .throughputConfig(FeatureGroupThroughputConfigArgs.builder()
        .provisionedReadCapacityUnits(0)
        .provisionedWriteCapacityUnits(0)
        .throughputMode("string")
        .build())
    .build());
feature_group_resource = aws.sagemaker.FeatureGroup("featureGroupResource",
    event_time_feature_name="string",
    feature_definitions=[{
        "collection_config": {
            "vector_config": {
                "dimension": 0,
            },
        },
        "collection_type": "string",
        "feature_name": "string",
        "feature_type": "string",
    }],
    feature_group_name="string",
    record_identifier_feature_name="string",
    role_arn="string",
    description="string",
    offline_store_config={
        "s3_storage_config": {
            "s3_uri": "string",
            "kms_key_id": "string",
            "resolved_output_s3_uri": "string",
        },
        "data_catalog_config": {
            "catalog": "string",
            "database": "string",
            "table_name": "string",
        },
        "disable_glue_table_creation": False,
        "table_format": "string",
    },
    online_store_config={
        "enable_online_store": False,
        "security_config": {
            "kms_key_id": "string",
        },
        "storage_type": "string",
        "ttl_duration": {
            "unit": "string",
            "value": 0,
        },
    },
    tags={
        "string": "string",
    },
    throughput_config={
        "provisioned_read_capacity_units": 0,
        "provisioned_write_capacity_units": 0,
        "throughput_mode": "string",
    })
const featureGroupResource = new aws.sagemaker.FeatureGroup("featureGroupResource", {
    eventTimeFeatureName: "string",
    featureDefinitions: [{
        collectionConfig: {
            vectorConfig: {
                dimension: 0,
            },
        },
        collectionType: "string",
        featureName: "string",
        featureType: "string",
    }],
    featureGroupName: "string",
    recordIdentifierFeatureName: "string",
    roleArn: "string",
    description: "string",
    offlineStoreConfig: {
        s3StorageConfig: {
            s3Uri: "string",
            kmsKeyId: "string",
            resolvedOutputS3Uri: "string",
        },
        dataCatalogConfig: {
            catalog: "string",
            database: "string",
            tableName: "string",
        },
        disableGlueTableCreation: false,
        tableFormat: "string",
    },
    onlineStoreConfig: {
        enableOnlineStore: false,
        securityConfig: {
            kmsKeyId: "string",
        },
        storageType: "string",
        ttlDuration: {
            unit: "string",
            value: 0,
        },
    },
    tags: {
        string: "string",
    },
    throughputConfig: {
        provisionedReadCapacityUnits: 0,
        provisionedWriteCapacityUnits: 0,
        throughputMode: "string",
    },
});
type: aws:sagemaker:FeatureGroup
properties:
    description: string
    eventTimeFeatureName: string
    featureDefinitions:
        - collectionConfig:
            vectorConfig:
                dimension: 0
          collectionType: string
          featureName: string
          featureType: string
    featureGroupName: string
    offlineStoreConfig:
        dataCatalogConfig:
            catalog: string
            database: string
            tableName: string
        disableGlueTableCreation: false
        s3StorageConfig:
            kmsKeyId: string
            resolvedOutputS3Uri: string
            s3Uri: string
        tableFormat: string
    onlineStoreConfig:
        enableOnlineStore: false
        securityConfig:
            kmsKeyId: string
        storageType: string
        ttlDuration:
            unit: string
            value: 0
    recordIdentifierFeatureName: string
    roleArn: string
    tags:
        string: string
    throughputConfig:
        provisionedReadCapacityUnits: 0
        provisionedWriteCapacityUnits: 0
        throughputMode: string
FeatureGroup Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The FeatureGroup resource accepts the following input properties:
- EventTime stringFeature Name 
- The name of the feature that stores the EventTime of a Record in a Feature Group.
- FeatureDefinitions List<FeatureGroup Feature Definition> 
- A list of Feature names and types. See Feature Definition Below.
- FeatureGroup stringName 
- The name of the Feature Group. The name must be unique within an AWS Region in an AWS account.
- RecordIdentifier stringFeature Name 
- 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.
- RoleArn string
- The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the Offline Store if an offline_store_configis provided.
- Description string
- A free-form description of a Feature Group.
- OfflineStore FeatureConfig Group Offline Store Config 
- The Offline Feature Store Configuration. See Offline Store Config Below.
- OnlineStore FeatureConfig Group Online Store Config 
- The Online Feature Store Configuration. See Online Store Config Below.
- Dictionary<string, string>
- Map of resource tags for the resource. .If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- ThroughputConfig FeatureGroup Throughput Config 
- EventTime stringFeature Name 
- The name of the feature that stores the EventTime of a Record in a Feature Group.
- FeatureDefinitions []FeatureGroup Feature Definition Args 
- A list of Feature names and types. See Feature Definition Below.
- FeatureGroup stringName 
- The name of the Feature Group. The name must be unique within an AWS Region in an AWS account.
- RecordIdentifier stringFeature Name 
- 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.
- RoleArn string
- The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the Offline Store if an offline_store_configis provided.
- Description string
- A free-form description of a Feature Group.
- OfflineStore FeatureConfig Group Offline Store Config Args 
- The Offline Feature Store Configuration. See Offline Store Config Below.
- OnlineStore FeatureConfig Group Online Store Config Args 
- The Online Feature Store Configuration. See Online Store Config Below.
- map[string]string
- Map of resource tags for the resource. .If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- ThroughputConfig FeatureGroup Throughput Config Args 
- eventTime StringFeature Name 
- The name of the feature that stores the EventTime of a Record in a Feature Group.
- featureDefinitions List<FeatureGroup Feature Definition> 
- A list of Feature names and types. See Feature Definition Below.
- featureGroup StringName 
- The name of the Feature Group. The name must be unique within an AWS Region in an AWS account.
- recordIdentifier StringFeature Name 
- 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.
- roleArn String
- The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the Offline Store if an offline_store_configis provided.
- description String
- A free-form description of a Feature Group.
- offlineStore FeatureConfig Group Offline Store Config 
- The Offline Feature Store Configuration. See Offline Store Config Below.
- onlineStore FeatureConfig Group Online Store Config 
- The Online Feature Store Configuration. See Online Store Config Below.
- Map<String,String>
- Map of resource tags for the resource. .If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- throughputConfig FeatureGroup Throughput Config 
- eventTime stringFeature Name 
- The name of the feature that stores the EventTime of a Record in a Feature Group.
- featureDefinitions FeatureGroup Feature Definition[] 
- A list of Feature names and types. See Feature Definition Below.
- featureGroup stringName 
- The name of the Feature Group. The name must be unique within an AWS Region in an AWS account.
- recordIdentifier stringFeature Name 
- 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.
- roleArn string
- The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the Offline Store if an offline_store_configis provided.
- description string
- A free-form description of a Feature Group.
- offlineStore FeatureConfig Group Offline Store Config 
- The Offline Feature Store Configuration. See Offline Store Config Below.
- onlineStore FeatureConfig Group Online Store Config 
- The Online Feature Store Configuration. See Online Store Config Below.
- {[key: string]: string}
- Map of resource tags for the resource. .If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- throughputConfig FeatureGroup Throughput Config 
- event_time_ strfeature_ name 
- The name of the feature that stores the EventTime of a Record in a Feature Group.
- feature_definitions Sequence[FeatureGroup Feature Definition Args] 
- A list of Feature names and types. See Feature Definition Below.
- feature_group_ strname 
- The name of the Feature Group. The name must be unique within an AWS Region in an AWS account.
- record_identifier_ strfeature_ name 
- 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.
- role_arn str
- The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the Offline Store if an offline_store_configis provided.
- description str
- A free-form description of a Feature Group.
- offline_store_ Featureconfig Group Offline Store Config Args 
- The Offline Feature Store Configuration. See Offline Store Config Below.
- online_store_ Featureconfig Group Online Store Config Args 
- The Online Feature Store Configuration. See Online Store Config Below.
- Mapping[str, str]
- Map of resource tags for the resource. .If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- throughput_config FeatureGroup Throughput Config Args 
- eventTime StringFeature Name 
- The name of the feature that stores the EventTime of a Record in a Feature Group.
- featureDefinitions List<Property Map>
- A list of Feature names and types. See Feature Definition Below.
- featureGroup StringName 
- The name of the Feature Group. The name must be unique within an AWS Region in an AWS account.
- recordIdentifier StringFeature Name 
- 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.
- roleArn String
- The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the Offline Store if an offline_store_configis provided.
- description String
- A free-form description of a Feature Group.
- offlineStore Property MapConfig 
- The Offline Feature Store Configuration. See Offline Store Config Below.
- onlineStore Property MapConfig 
- The Online Feature Store Configuration. See Online Store Config Below.
- Map<String>
- Map of resource tags for the resource. .If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- throughputConfig Property Map
Outputs
All input properties are implicitly available as output properties. Additionally, the FeatureGroup resource produces the following output properties:
Look up Existing FeatureGroup Resource
Get an existing FeatureGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: FeatureGroupState, opts?: CustomResourceOptions): FeatureGroup@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        description: Optional[str] = None,
        event_time_feature_name: Optional[str] = None,
        feature_definitions: Optional[Sequence[FeatureGroupFeatureDefinitionArgs]] = None,
        feature_group_name: Optional[str] = None,
        offline_store_config: Optional[FeatureGroupOfflineStoreConfigArgs] = None,
        online_store_config: Optional[FeatureGroupOnlineStoreConfigArgs] = None,
        record_identifier_feature_name: Optional[str] = None,
        role_arn: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        throughput_config: Optional[FeatureGroupThroughputConfigArgs] = None) -> FeatureGroupfunc GetFeatureGroup(ctx *Context, name string, id IDInput, state *FeatureGroupState, opts ...ResourceOption) (*FeatureGroup, error)public static FeatureGroup Get(string name, Input<string> id, FeatureGroupState? state, CustomResourceOptions? opts = null)public static FeatureGroup get(String name, Output<String> id, FeatureGroupState state, CustomResourceOptions options)resources:  _:    type: aws:sagemaker:FeatureGroup    get:      id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Arn string
- The Amazon Resource Name (ARN) assigned by AWS to this feature_group.
- Description string
- A free-form description of a Feature Group.
- EventTime stringFeature Name 
- The name of the feature that stores the EventTime of a Record in a Feature Group.
- FeatureDefinitions List<FeatureGroup Feature Definition> 
- A list of Feature names and types. See Feature Definition Below.
- FeatureGroup stringName 
- The name of the Feature Group. The name must be unique within an AWS Region in an AWS account.
- OfflineStore FeatureConfig Group Offline Store Config 
- The Offline Feature Store Configuration. See Offline Store Config Below.
- OnlineStore FeatureConfig Group Online Store Config 
- The Online Feature Store Configuration. See Online Store Config Below.
- RecordIdentifier stringFeature Name 
- 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.
- RoleArn string
- The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the Offline Store if an offline_store_configis provided.
- Dictionary<string, string>
- Map of resource tags for the resource. .If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- Dictionary<string, string>
- A map of tags assigned to the resource, including those inherited from the provider default_tagsconfiguration block.
- ThroughputConfig FeatureGroup Throughput Config 
- Arn string
- The Amazon Resource Name (ARN) assigned by AWS to this feature_group.
- Description string
- A free-form description of a Feature Group.
- EventTime stringFeature Name 
- The name of the feature that stores the EventTime of a Record in a Feature Group.
- FeatureDefinitions []FeatureGroup Feature Definition Args 
- A list of Feature names and types. See Feature Definition Below.
- FeatureGroup stringName 
- The name of the Feature Group. The name must be unique within an AWS Region in an AWS account.
- OfflineStore FeatureConfig Group Offline Store Config Args 
- The Offline Feature Store Configuration. See Offline Store Config Below.
- OnlineStore FeatureConfig Group Online Store Config Args 
- The Online Feature Store Configuration. See Online Store Config Below.
- RecordIdentifier stringFeature Name 
- 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.
- RoleArn string
- The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the Offline Store if an offline_store_configis provided.
- map[string]string
- Map of resource tags for the resource. .If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- map[string]string
- A map of tags assigned to the resource, including those inherited from the provider default_tagsconfiguration block.
- ThroughputConfig FeatureGroup Throughput Config Args 
- arn String
- The Amazon Resource Name (ARN) assigned by AWS to this feature_group.
- description String
- A free-form description of a Feature Group.
- eventTime StringFeature Name 
- The name of the feature that stores the EventTime of a Record in a Feature Group.
- featureDefinitions List<FeatureGroup Feature Definition> 
- A list of Feature names and types. See Feature Definition Below.
- featureGroup StringName 
- The name of the Feature Group. The name must be unique within an AWS Region in an AWS account.
- offlineStore FeatureConfig Group Offline Store Config 
- The Offline Feature Store Configuration. See Offline Store Config Below.
- onlineStore FeatureConfig Group Online Store Config 
- The Online Feature Store Configuration. See Online Store Config Below.
- recordIdentifier StringFeature Name 
- 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.
- roleArn String
- The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the Offline Store if an offline_store_configis provided.
- Map<String,String>
- Map of resource tags for the resource. .If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- Map<String,String>
- A map of tags assigned to the resource, including those inherited from the provider default_tagsconfiguration block.
- throughputConfig FeatureGroup Throughput Config 
- arn string
- The Amazon Resource Name (ARN) assigned by AWS to this feature_group.
- description string
- A free-form description of a Feature Group.
- eventTime stringFeature Name 
- The name of the feature that stores the EventTime of a Record in a Feature Group.
- featureDefinitions FeatureGroup Feature Definition[] 
- A list of Feature names and types. See Feature Definition Below.
- featureGroup stringName 
- The name of the Feature Group. The name must be unique within an AWS Region in an AWS account.
- offlineStore FeatureConfig Group Offline Store Config 
- The Offline Feature Store Configuration. See Offline Store Config Below.
- onlineStore FeatureConfig Group Online Store Config 
- The Online Feature Store Configuration. See Online Store Config Below.
- recordIdentifier stringFeature Name 
- 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.
- roleArn string
- The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the Offline Store if an offline_store_configis provided.
- {[key: string]: string}
- Map of resource tags for the resource. .If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- {[key: string]: string}
- A map of tags assigned to the resource, including those inherited from the provider default_tagsconfiguration block.
- throughputConfig FeatureGroup Throughput Config 
- arn str
- The Amazon Resource Name (ARN) assigned by AWS to this feature_group.
- description str
- A free-form description of a Feature Group.
- event_time_ strfeature_ name 
- The name of the feature that stores the EventTime of a Record in a Feature Group.
- feature_definitions Sequence[FeatureGroup Feature Definition Args] 
- A list of Feature names and types. See Feature Definition Below.
- feature_group_ strname 
- The name of the Feature Group. The name must be unique within an AWS Region in an AWS account.
- offline_store_ Featureconfig Group Offline Store Config Args 
- The Offline Feature Store Configuration. See Offline Store Config Below.
- online_store_ Featureconfig Group Online Store Config Args 
- The Online Feature Store Configuration. See Online Store Config Below.
- record_identifier_ strfeature_ name 
- 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.
- role_arn str
- The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the Offline Store if an offline_store_configis provided.
- Mapping[str, str]
- Map of resource tags for the resource. .If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- Mapping[str, str]
- A map of tags assigned to the resource, including those inherited from the provider default_tagsconfiguration block.
- throughput_config FeatureGroup Throughput Config Args 
- arn String
- The Amazon Resource Name (ARN) assigned by AWS to this feature_group.
- description String
- A free-form description of a Feature Group.
- eventTime StringFeature Name 
- The name of the feature that stores the EventTime of a Record in a Feature Group.
- featureDefinitions List<Property Map>
- A list of Feature names and types. See Feature Definition Below.
- featureGroup StringName 
- The name of the Feature Group. The name must be unique within an AWS Region in an AWS account.
- offlineStore Property MapConfig 
- The Offline Feature Store Configuration. See Offline Store Config Below.
- onlineStore Property MapConfig 
- The Online Feature Store Configuration. See Online Store Config Below.
- recordIdentifier StringFeature Name 
- 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.
- roleArn String
- The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the Offline Store if an offline_store_configis provided.
- Map<String>
- Map of resource tags for the resource. .If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- Map<String>
- A map of tags assigned to the resource, including those inherited from the provider default_tagsconfiguration block.
- throughputConfig Property Map
Supporting Types
FeatureGroupFeatureDefinition, FeatureGroupFeatureDefinitionArgs        
- CollectionConfig FeatureGroup Feature Definition Collection Config 
- CollectionType string
- FeatureName string
- The name of a feature. feature_namecannot be any of the following:is_deleted,write_time,api_invocation_time.
- FeatureType string
- The value type of a feature. Valid values are Integral,Fractional, orString.
- CollectionConfig FeatureGroup Feature Definition Collection Config 
- CollectionType string
- FeatureName string
- The name of a feature. feature_namecannot be any of the following:is_deleted,write_time,api_invocation_time.
- FeatureType string
- The value type of a feature. Valid values are Integral,Fractional, orString.
- collectionConfig FeatureGroup Feature Definition Collection Config 
- collectionType String
- featureName String
- The name of a feature. feature_namecannot be any of the following:is_deleted,write_time,api_invocation_time.
- featureType String
- The value type of a feature. Valid values are Integral,Fractional, orString.
- collectionConfig FeatureGroup Feature Definition Collection Config 
- collectionType string
- featureName string
- The name of a feature. feature_namecannot be any of the following:is_deleted,write_time,api_invocation_time.
- featureType string
- The value type of a feature. Valid values are Integral,Fractional, orString.
- collection_config FeatureGroup Feature Definition Collection Config 
- collection_type str
- feature_name str
- The name of a feature. feature_namecannot be any of the following:is_deleted,write_time,api_invocation_time.
- feature_type str
- The value type of a feature. Valid values are Integral,Fractional, orString.
- collectionConfig Property Map
- collectionType String
- featureName String
- The name of a feature. feature_namecannot be any of the following:is_deleted,write_time,api_invocation_time.
- featureType String
- The value type of a feature. Valid values are Integral,Fractional, orString.
FeatureGroupFeatureDefinitionCollectionConfig, FeatureGroupFeatureDefinitionCollectionConfigArgs            
FeatureGroupFeatureDefinitionCollectionConfigVectorConfig, FeatureGroupFeatureDefinitionCollectionConfigVectorConfigArgs                
- Dimension int
- Dimension int
- dimension Integer
- dimension number
- dimension int
- dimension Number
FeatureGroupOfflineStoreConfig, FeatureGroupOfflineStoreConfigArgs          
- S3StorageConfig FeatureGroup Offline Store Config S3Storage Config 
- The Amazon Simple Storage (Amazon S3) location of OfflineStore. See S3 Storage Config Below.
- DataCatalog FeatureConfig Group Offline Store Config Data Catalog Config 
- The meta data of the Glue table that is autogenerated when an OfflineStore is created. See Data Catalog Config Below.
- DisableGlue boolTable Creation 
- Set to trueto turn Online Store On.
- TableFormat string
- Format for the offline store table. Supported formats are Glue(Default) and ApacheIceberg(https://iceberg.apache.org/).
- S3StorageConfig FeatureGroup Offline Store Config S3Storage Config 
- The Amazon Simple Storage (Amazon S3) location of OfflineStore. See S3 Storage Config Below.
- DataCatalog FeatureConfig Group Offline Store Config Data Catalog Config 
- The meta data of the Glue table that is autogenerated when an OfflineStore is created. See Data Catalog Config Below.
- DisableGlue boolTable Creation 
- Set to trueto turn Online Store On.
- TableFormat string
- Format for the offline store table. Supported formats are Glue(Default) and ApacheIceberg(https://iceberg.apache.org/).
- s3StorageConfig FeatureGroup Offline Store Config S3Storage Config 
- The Amazon Simple Storage (Amazon S3) location of OfflineStore. See S3 Storage Config Below.
- dataCatalog FeatureConfig Group Offline Store Config Data Catalog Config 
- The meta data of the Glue table that is autogenerated when an OfflineStore is created. See Data Catalog Config Below.
- disableGlue BooleanTable Creation 
- Set to trueto turn Online Store On.
- tableFormat String
- Format for the offline store table. Supported formats are Glue(Default) and ApacheIceberg(https://iceberg.apache.org/).
- s3StorageConfig FeatureGroup Offline Store Config S3Storage Config 
- The Amazon Simple Storage (Amazon S3) location of OfflineStore. See S3 Storage Config Below.
- dataCatalog FeatureConfig Group Offline Store Config Data Catalog Config 
- The meta data of the Glue table that is autogenerated when an OfflineStore is created. See Data Catalog Config Below.
- disableGlue booleanTable Creation 
- Set to trueto turn Online Store On.
- tableFormat string
- Format for the offline store table. Supported formats are Glue(Default) and ApacheIceberg(https://iceberg.apache.org/).
- s3_storage_ Featureconfig Group Offline Store Config S3Storage Config 
- The Amazon Simple Storage (Amazon S3) location of OfflineStore. See S3 Storage Config Below.
- data_catalog_ Featureconfig Group Offline Store Config Data Catalog Config 
- The meta data of the Glue table that is autogenerated when an OfflineStore is created. See Data Catalog Config Below.
- disable_glue_ booltable_ creation 
- Set to trueto turn Online Store On.
- table_format str
- Format for the offline store table. Supported formats are Glue(Default) and ApacheIceberg(https://iceberg.apache.org/).
- s3StorageConfig Property Map
- The Amazon Simple Storage (Amazon S3) location of OfflineStore. See S3 Storage Config Below.
- dataCatalog Property MapConfig 
- The meta data of the Glue table that is autogenerated when an OfflineStore is created. See Data Catalog Config Below.
- disableGlue BooleanTable Creation 
- Set to trueto turn Online Store On.
- tableFormat String
- Format for the offline store table. Supported formats are Glue(Default) and ApacheIceberg(https://iceberg.apache.org/).
FeatureGroupOfflineStoreConfigDataCatalogConfig, FeatureGroupOfflineStoreConfigDataCatalogConfigArgs                
- catalog str
- The name of the Glue table catalog.
- database str
- The name of the Glue table database.
- table_name str
- The name of the Glue table.
FeatureGroupOfflineStoreConfigS3StorageConfig, FeatureGroupOfflineStoreConfigS3StorageConfigArgs              
- S3Uri string
- The S3 URI, or location in Amazon S3, of OfflineStore.
- KmsKey stringId 
- The AWS Key Management Service (KMS) key ID of the key used to encrypt any objects written into the OfflineStore S3 location.
- ResolvedOutput stringS3Uri 
- The S3 path where offline records are written.
- S3Uri string
- The S3 URI, or location in Amazon S3, of OfflineStore.
- KmsKey stringId 
- The AWS Key Management Service (KMS) key ID of the key used to encrypt any objects written into the OfflineStore S3 location.
- ResolvedOutput stringS3Uri 
- The S3 path where offline records are written.
- s3Uri String
- The S3 URI, or location in Amazon S3, of OfflineStore.
- kmsKey StringId 
- The AWS Key Management Service (KMS) key ID of the key used to encrypt any objects written into the OfflineStore S3 location.
- resolvedOutput StringS3Uri 
- The S3 path where offline records are written.
- s3Uri string
- The S3 URI, or location in Amazon S3, of OfflineStore.
- kmsKey stringId 
- The AWS Key Management Service (KMS) key ID of the key used to encrypt any objects written into the OfflineStore S3 location.
- resolvedOutput stringS3Uri 
- The S3 path where offline records are written.
- s3_uri str
- The S3 URI, or location in Amazon S3, of OfflineStore.
- kms_key_ strid 
- The AWS Key Management Service (KMS) key ID of the key used to encrypt any objects written into the OfflineStore S3 location.
- resolved_output_ strs3_ uri 
- The S3 path where offline records are written.
- s3Uri String
- The S3 URI, or location in Amazon S3, of OfflineStore.
- kmsKey StringId 
- The AWS Key Management Service (KMS) key ID of the key used to encrypt any objects written into the OfflineStore S3 location.
- resolvedOutput StringS3Uri 
- The S3 path where offline records are written.
FeatureGroupOnlineStoreConfig, FeatureGroupOnlineStoreConfigArgs          
- EnableOnline boolStore 
- Set to trueto disable the automatic creation of an AWS Glue table when configuring an OfflineStore.
- SecurityConfig FeatureGroup Online Store Config Security Config 
- Security config for at-rest encryption of your OnlineStore. See Security Config Below.
- StorageType string
- Option for different tiers of low latency storage for real-time data retrieval. Valid values are Standard, orInMemory.
- TtlDuration FeatureGroup Online Store Config Ttl Duration 
- Time to live duration, where the record is hard deleted after the expiration time is reached; ExpiresAt = EventTime + TtlDuration.. See TTl Duration Below.
- EnableOnline boolStore 
- Set to trueto disable the automatic creation of an AWS Glue table when configuring an OfflineStore.
- SecurityConfig FeatureGroup Online Store Config Security Config 
- Security config for at-rest encryption of your OnlineStore. See Security Config Below.
- StorageType string
- Option for different tiers of low latency storage for real-time data retrieval. Valid values are Standard, orInMemory.
- TtlDuration FeatureGroup Online Store Config Ttl Duration 
- Time to live duration, where the record is hard deleted after the expiration time is reached; ExpiresAt = EventTime + TtlDuration.. See TTl Duration Below.
- enableOnline BooleanStore 
- Set to trueto disable the automatic creation of an AWS Glue table when configuring an OfflineStore.
- securityConfig FeatureGroup Online Store Config Security Config 
- Security config for at-rest encryption of your OnlineStore. See Security Config Below.
- storageType String
- Option for different tiers of low latency storage for real-time data retrieval. Valid values are Standard, orInMemory.
- ttlDuration FeatureGroup Online Store Config Ttl Duration 
- Time to live duration, where the record is hard deleted after the expiration time is reached; ExpiresAt = EventTime + TtlDuration.. See TTl Duration Below.
- enableOnline booleanStore 
- Set to trueto disable the automatic creation of an AWS Glue table when configuring an OfflineStore.
- securityConfig FeatureGroup Online Store Config Security Config 
- Security config for at-rest encryption of your OnlineStore. See Security Config Below.
- storageType string
- Option for different tiers of low latency storage for real-time data retrieval. Valid values are Standard, orInMemory.
- ttlDuration FeatureGroup Online Store Config Ttl Duration 
- Time to live duration, where the record is hard deleted after the expiration time is reached; ExpiresAt = EventTime + TtlDuration.. See TTl Duration Below.
- enable_online_ boolstore 
- Set to trueto disable the automatic creation of an AWS Glue table when configuring an OfflineStore.
- security_config FeatureGroup Online Store Config Security Config 
- Security config for at-rest encryption of your OnlineStore. See Security Config Below.
- storage_type str
- Option for different tiers of low latency storage for real-time data retrieval. Valid values are Standard, orInMemory.
- ttl_duration FeatureGroup Online Store Config Ttl Duration 
- Time to live duration, where the record is hard deleted after the expiration time is reached; ExpiresAt = EventTime + TtlDuration.. See TTl Duration Below.
- enableOnline BooleanStore 
- Set to trueto disable the automatic creation of an AWS Glue table when configuring an OfflineStore.
- securityConfig Property Map
- Security config for at-rest encryption of your OnlineStore. See Security Config Below.
- storageType String
- Option for different tiers of low latency storage for real-time data retrieval. Valid values are Standard, orInMemory.
- ttlDuration Property Map
- Time to live duration, where the record is hard deleted after the expiration time is reached; ExpiresAt = EventTime + TtlDuration.. See TTl Duration Below.
FeatureGroupOnlineStoreConfigSecurityConfig, FeatureGroupOnlineStoreConfigSecurityConfigArgs              
- KmsKey stringId 
- 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.
- KmsKey stringId 
- 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.
- kmsKey StringId 
- 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.
- kmsKey stringId 
- 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.
- kms_key_ strid 
- 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.
- kmsKey StringId 
- 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.
FeatureGroupOnlineStoreConfigTtlDuration, FeatureGroupOnlineStoreConfigTtlDurationArgs              
FeatureGroupThroughputConfig, FeatureGroupThroughputConfigArgs        
- provisionedRead IntegerCapacity Units 
- provisionedWrite IntegerCapacity Units 
- throughputMode String
- provisionedRead numberCapacity Units 
- provisionedWrite numberCapacity Units 
- throughputMode string
- provisionedRead NumberCapacity Units 
- provisionedWrite NumberCapacity Units 
- throughputMode String
Import
Using pulumi import, import Feature Groups using the name. For example:
$ pulumi import aws:sagemaker/featureGroup:FeatureGroup test_feature_group feature_group-foo
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the awsTerraform Provider.