Docs Packages
  1. Packages
  2. AWS Classic
  3. API Docs
  4. sagemaker
  5. FeatureGroup

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.31.1 published on Thursday, Apr 18, 2024 by Pulumi
pulumi/pulumi-aws

aws.sagemaker.FeatureGroup

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.31.1 published on Thursday, Apr 18, 2024 by Pulumi
pulumi/pulumi-aws

    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=[aws.sagemaker.FeatureGroupFeatureDefinitionArgs(
        feature_name="example",
        feature_type="String",
    )],
    online_store_config=aws.sagemaker.FeatureGroupOnlineStoreConfigArgs(
        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)
    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.

    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
        {
            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" },
    },
});

    example, err := sagemaker.NewFeatureGroup(ctx, "featureGroupResource", &sagemaker.FeatureGroupArgs{
	EventTimeFeatureName: pulumi.String("string"),
	FeatureDefinitions: sagemaker.FeatureGroupFeatureDefinitionArray{
		&sagemaker.FeatureGroupFeatureDefinitionArgs{
			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"),
	},
})

    var featureGroupResource = new FeatureGroup("featureGroupResource", FeatureGroupArgs.builder()        
    .eventTimeFeatureName("string")
    .featureDefinitions(FeatureGroupFeatureDefinitionArgs.builder()
        .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"))
    .build());

    feature_group_resource = aws.sagemaker.FeatureGroup("featureGroupResource",
    event_time_feature_name="string",
    feature_definitions=[aws.sagemaker.FeatureGroupFeatureDefinitionArgs(
        feature_name="string",
        feature_type="string",
    )],
    feature_group_name="string",
    record_identifier_feature_name="string",
    role_arn="string",
    description="string",
    offline_store_config=aws.sagemaker.FeatureGroupOfflineStoreConfigArgs(
        s3_storage_config=aws.sagemaker.FeatureGroupOfflineStoreConfigS3StorageConfigArgs(
            s3_uri="string",
            kms_key_id="string",
            resolved_output_s3_uri="string",
        ),
        data_catalog_config=aws.sagemaker.FeatureGroupOfflineStoreConfigDataCatalogConfigArgs(
            catalog="string",
            database="string",
            table_name="string",
        ),
        disable_glue_table_creation=False,
        table_format="string",
    ),
    online_store_config=aws.sagemaker.FeatureGroupOnlineStoreConfigArgs(
        enable_online_store=False,
        security_config=aws.sagemaker.FeatureGroupOnlineStoreConfigSecurityConfigArgs(
            kms_key_id="string",
        ),
        storage_type="string",
        ttl_duration=aws.sagemaker.FeatureGroupOnlineStoreConfigTtlDurationArgs(
            unit="string",
            value=0,
        ),
    ),
    tags={
        "string": "string",
    })

    const featureGroupResource = new aws.sagemaker.FeatureGroup("featureGroupResource", {
    eventTimeFeatureName: "string",
    featureDefinitions: [{
        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",
    },
});

    type: aws:sagemaker:FeatureGroup
properties:
    description: string
    eventTimeFeatureName: string
    featureDefinitions:
        - 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

    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

    The FeatureGroup resource accepts the following input properties:

    EventTimeFeatureName string
    The name of the feature that stores the EventTime of a Record in a Feature Group.
    FeatureDefinitions List<Pulumi.Aws.Sagemaker.Inputs.FeatureGroupFeatureDefinition>
    A list of Feature names and types. See Feature Definition Below.
    FeatureGroupName string
    The name of the Feature Group. The name must be unique within an AWS Region in an AWS account.
    RecordIdentifierFeatureName string
    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_config is provided.
    Description string
    A free-form description of a Feature Group.
    OfflineStoreConfig Pulumi.Aws.Sagemaker.Inputs.FeatureGroupOfflineStoreConfig
    The Offline Feature Store Configuration. See Offline Store Config Below.
    OnlineStoreConfig Pulumi.Aws.Sagemaker.Inputs.FeatureGroupOnlineStoreConfig
    The Online Feature Store Configuration. See Online Store Config Below.
    Tags Dictionary<string, string>
    Map of resource tags for the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    EventTimeFeatureName string
    The name of the feature that stores the EventTime of a Record in a Feature Group.
    FeatureDefinitions []FeatureGroupFeatureDefinitionArgs
    A list of Feature names and types. See Feature Definition Below.
    FeatureGroupName string
    The name of the Feature Group. The name must be unique within an AWS Region in an AWS account.
    RecordIdentifierFeatureName string
    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_config is provided.
    Description string
    A free-form description of a Feature Group.
    OfflineStoreConfig FeatureGroupOfflineStoreConfigArgs
    The Offline Feature Store Configuration. See Offline Store Config Below.
    OnlineStoreConfig FeatureGroupOnlineStoreConfigArgs
    The Online Feature Store Configuration. See Online Store Config Below.
    Tags map[string]string
    Map of resource tags for the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    eventTimeFeatureName String
    The name of the feature that stores the EventTime of a Record in a Feature Group.
    featureDefinitions List<FeatureGroupFeatureDefinition>
    A list of Feature names and types. See Feature Definition Below.
    featureGroupName String
    The name of the Feature Group. The name must be unique within an AWS Region in an AWS account.
    recordIdentifierFeatureName String
    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_config is provided.
    description String
    A free-form description of a Feature Group.
    offlineStoreConfig FeatureGroupOfflineStoreConfig
    The Offline Feature Store Configuration. See Offline Store Config Below.
    onlineStoreConfig FeatureGroupOnlineStoreConfig
    The Online Feature Store Configuration. See Online Store Config Below.
    tags Map<String,String>
    Map of resource tags for the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    eventTimeFeatureName string
    The name of the feature that stores the EventTime of a Record in a Feature Group.
    featureDefinitions FeatureGroupFeatureDefinition[]
    A list of Feature names and types. See Feature Definition Below.
    featureGroupName string
    The name of the Feature Group. The name must be unique within an AWS Region in an AWS account.
    recordIdentifierFeatureName string
    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_config is provided.
    description string
    A free-form description of a Feature Group.
    offlineStoreConfig FeatureGroupOfflineStoreConfig
    The Offline Feature Store Configuration. See Offline Store Config Below.
    onlineStoreConfig FeatureGroupOnlineStoreConfig
    The Online Feature Store Configuration. See Online Store Config Below.
    tags {[key: string]: string}
    Map of resource tags for the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    event_time_feature_name str
    The name of the feature that stores the EventTime of a Record in a Feature Group.
    feature_definitions Sequence[FeatureGroupFeatureDefinitionArgs]
    A list of Feature names and types. See Feature Definition Below.
    feature_group_name str
    The name of the Feature Group. The name must be unique within an AWS Region in an AWS account.
    record_identifier_feature_name str
    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_config is provided.
    description str
    A free-form description of a Feature Group.
    offline_store_config FeatureGroupOfflineStoreConfigArgs
    The Offline Feature Store Configuration. See Offline Store Config Below.
    online_store_config FeatureGroupOnlineStoreConfigArgs
    The Online Feature Store Configuration. See Online Store Config Below.
    tags Mapping[str, str]
    Map of resource tags for the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    eventTimeFeatureName String
    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.
    featureGroupName String
    The name of the Feature Group. The name must be unique within an AWS Region in an AWS account.
    recordIdentifierFeatureName String
    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_config is provided.
    description String
    A free-form description of a Feature Group.
    offlineStoreConfig Property Map
    The Offline Feature Store Configuration. See Offline Store Config Below.
    onlineStoreConfig Property Map
    The Online Feature Store Configuration. See Online Store Config Below.
    tags Map<String>
    Map of resource tags for the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the FeatureGroup resource produces the following output properties:

    Arn string
    The Amazon Resource Name (ARN) assigned by AWS to this feature_group.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    The Amazon Resource Name (ARN) assigned by AWS to this feature_group.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Amazon Resource Name (ARN) assigned by AWS to this feature_group.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    The Amazon Resource Name (ARN) assigned by AWS to this feature_group.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    The Amazon Resource Name (ARN) assigned by AWS to this feature_group.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Amazon Resource Name (ARN) assigned by AWS to this feature_group.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    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) -> FeatureGroup
    func 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)
    Resource lookup is not supported in YAML
    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.
    The following state arguments are supported:
    Arn string
    The Amazon Resource Name (ARN) assigned by AWS to this feature_group.
    Description string
    A free-form description of a Feature Group.
    EventTimeFeatureName string
    The name of the feature that stores the EventTime of a Record in a Feature Group.
    FeatureDefinitions List<Pulumi.Aws.Sagemaker.Inputs.FeatureGroupFeatureDefinition>
    A list of Feature names and types. See Feature Definition Below.
    FeatureGroupName string
    The name of the Feature Group. The name must be unique within an AWS Region in an AWS account.
    OfflineStoreConfig Pulumi.Aws.Sagemaker.Inputs.FeatureGroupOfflineStoreConfig
    The Offline Feature Store Configuration. See Offline Store Config Below.
    OnlineStoreConfig Pulumi.Aws.Sagemaker.Inputs.FeatureGroupOnlineStoreConfig
    The Online Feature Store Configuration. See Online Store Config Below.
    RecordIdentifierFeatureName string
    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_config is provided.
    Tags Dictionary<string, string>
    Map of resource tags for the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    The Amazon Resource Name (ARN) assigned by AWS to this feature_group.
    Description string
    A free-form description of a Feature Group.
    EventTimeFeatureName string
    The name of the feature that stores the EventTime of a Record in a Feature Group.
    FeatureDefinitions []FeatureGroupFeatureDefinitionArgs
    A list of Feature names and types. See Feature Definition Below.
    FeatureGroupName string
    The name of the Feature Group. The name must be unique within an AWS Region in an AWS account.
    OfflineStoreConfig FeatureGroupOfflineStoreConfigArgs
    The Offline Feature Store Configuration. See Offline Store Config Below.
    OnlineStoreConfig FeatureGroupOnlineStoreConfigArgs
    The Online Feature Store Configuration. See Online Store Config Below.
    RecordIdentifierFeatureName string
    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_config is provided.
    Tags map[string]string
    Map of resource tags for the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Amazon Resource Name (ARN) assigned by AWS to this feature_group.
    description String
    A free-form description of a Feature Group.
    eventTimeFeatureName String
    The name of the feature that stores the EventTime of a Record in a Feature Group.
    featureDefinitions List<FeatureGroupFeatureDefinition>
    A list of Feature names and types. See Feature Definition Below.
    featureGroupName String
    The name of the Feature Group. The name must be unique within an AWS Region in an AWS account.
    offlineStoreConfig FeatureGroupOfflineStoreConfig
    The Offline Feature Store Configuration. See Offline Store Config Below.
    onlineStoreConfig FeatureGroupOnlineStoreConfig
    The Online Feature Store Configuration. See Online Store Config Below.
    recordIdentifierFeatureName String
    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_config is provided.
    tags Map<String,String>
    Map of resource tags for the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    The Amazon Resource Name (ARN) assigned by AWS to this feature_group.
    description string
    A free-form description of a Feature Group.
    eventTimeFeatureName string
    The name of the feature that stores the EventTime of a Record in a Feature Group.
    featureDefinitions FeatureGroupFeatureDefinition[]
    A list of Feature names and types. See Feature Definition Below.
    featureGroupName string
    The name of the Feature Group. The name must be unique within an AWS Region in an AWS account.
    offlineStoreConfig FeatureGroupOfflineStoreConfig
    The Offline Feature Store Configuration. See Offline Store Config Below.
    onlineStoreConfig FeatureGroupOnlineStoreConfig
    The Online Feature Store Configuration. See Online Store Config Below.
    recordIdentifierFeatureName string
    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_config is provided.
    tags {[key: string]: string}
    Map of resource tags for the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    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_feature_name str
    The name of the feature that stores the EventTime of a Record in a Feature Group.
    feature_definitions Sequence[FeatureGroupFeatureDefinitionArgs]
    A list of Feature names and types. See Feature Definition Below.
    feature_group_name str
    The name of the Feature Group. The name must be unique within an AWS Region in an AWS account.
    offline_store_config FeatureGroupOfflineStoreConfigArgs
    The Offline Feature Store Configuration. See Offline Store Config Below.
    online_store_config FeatureGroupOnlineStoreConfigArgs
    The Online Feature Store Configuration. See Online Store Config Below.
    record_identifier_feature_name str
    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_config is provided.
    tags Mapping[str, str]
    Map of resource tags for the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Amazon Resource Name (ARN) assigned by AWS to this feature_group.
    description String
    A free-form description of a Feature Group.
    eventTimeFeatureName String
    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.
    featureGroupName String
    The name of the Feature Group. The name must be unique within an AWS Region in an AWS account.
    offlineStoreConfig Property Map
    The Offline Feature Store Configuration. See Offline Store Config Below.
    onlineStoreConfig Property Map
    The Online Feature Store Configuration. See Online Store Config Below.
    recordIdentifierFeatureName String
    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_config is provided.
    tags Map<String>
    Map of resource tags for the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Supporting Types

    FeatureGroupFeatureDefinition, FeatureGroupFeatureDefinitionArgs

    FeatureName string
    The name of a feature. feature_name cannot 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, or String.
    FeatureName string
    The name of a feature. feature_name cannot 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, or String.
    featureName String
    The name of a feature. feature_name cannot 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, or String.
    featureName string
    The name of a feature. feature_name cannot 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, or String.
    feature_name str
    The name of a feature. feature_name cannot 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, or String.
    featureName String
    The name of a feature. feature_name cannot 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, or String.

    FeatureGroupOfflineStoreConfig, FeatureGroupOfflineStoreConfigArgs

    S3StorageConfig Pulumi.Aws.Sagemaker.Inputs.FeatureGroupOfflineStoreConfigS3StorageConfig
    The Amazon Simple Storage (Amazon S3) location of OfflineStore. See S3 Storage Config Below.
    DataCatalogConfig Pulumi.Aws.Sagemaker.Inputs.FeatureGroupOfflineStoreConfigDataCatalogConfig
    The meta data of the Glue table that is autogenerated when an OfflineStore is created. See Data Catalog Config Below.
    DisableGlueTableCreation bool
    Set to true to turn Online Store On.
    TableFormat string
    Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg (https://iceberg.apache.org/).
    S3StorageConfig FeatureGroupOfflineStoreConfigS3StorageConfig
    The Amazon Simple Storage (Amazon S3) location of OfflineStore. See S3 Storage Config Below.
    DataCatalogConfig FeatureGroupOfflineStoreConfigDataCatalogConfig
    The meta data of the Glue table that is autogenerated when an OfflineStore is created. See Data Catalog Config Below.
    DisableGlueTableCreation bool
    Set to true to turn Online Store On.
    TableFormat string
    Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg (https://iceberg.apache.org/).
    s3StorageConfig FeatureGroupOfflineStoreConfigS3StorageConfig
    The Amazon Simple Storage (Amazon S3) location of OfflineStore. See S3 Storage Config Below.
    dataCatalogConfig FeatureGroupOfflineStoreConfigDataCatalogConfig
    The meta data of the Glue table that is autogenerated when an OfflineStore is created. See Data Catalog Config Below.
    disableGlueTableCreation Boolean
    Set to true to turn Online Store On.
    tableFormat String
    Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg (https://iceberg.apache.org/).
    s3StorageConfig FeatureGroupOfflineStoreConfigS3StorageConfig
    The Amazon Simple Storage (Amazon S3) location of OfflineStore. See S3 Storage Config Below.
    dataCatalogConfig FeatureGroupOfflineStoreConfigDataCatalogConfig
    The meta data of the Glue table that is autogenerated when an OfflineStore is created. See Data Catalog Config Below.
    disableGlueTableCreation boolean
    Set to true to turn Online Store On.
    tableFormat string
    Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg (https://iceberg.apache.org/).
    s3_storage_config FeatureGroupOfflineStoreConfigS3StorageConfig
    The Amazon Simple Storage (Amazon S3) location of OfflineStore. See S3 Storage Config Below.
    data_catalog_config FeatureGroupOfflineStoreConfigDataCatalogConfig
    The meta data of the Glue table that is autogenerated when an OfflineStore is created. See Data Catalog Config Below.
    disable_glue_table_creation bool
    Set to true to turn Online Store On.
    table_format str
    Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg (https://iceberg.apache.org/).
    s3StorageConfig Property Map
    The Amazon Simple Storage (Amazon S3) location of OfflineStore. See S3 Storage Config Below.
    dataCatalogConfig Property Map
    The meta data of the Glue table that is autogenerated when an OfflineStore is created. See Data Catalog Config Below.
    disableGlueTableCreation Boolean
    Set to true to turn Online Store On.
    tableFormat String
    Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg (https://iceberg.apache.org/).

    FeatureGroupOfflineStoreConfigDataCatalogConfig, FeatureGroupOfflineStoreConfigDataCatalogConfigArgs

    Catalog string
    The name of the Glue table catalog.
    Database string
    The name of the Glue table database.
    TableName string
    The name of the Glue table.
    Catalog string
    The name of the Glue table catalog.
    Database string
    The name of the Glue table database.
    TableName string
    The name of the Glue table.
    catalog String
    The name of the Glue table catalog.
    database String
    The name of the Glue table database.
    tableName String
    The name of the Glue table.
    catalog string
    The name of the Glue table catalog.
    database string
    The name of the Glue table database.
    tableName string
    The name of the Glue table.
    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.
    catalog String
    The name of the Glue table catalog.
    database String
    The name of the Glue table database.
    tableName String
    The name of the Glue table.

    FeatureGroupOfflineStoreConfigS3StorageConfig, FeatureGroupOfflineStoreConfigS3StorageConfigArgs

    S3Uri string
    The S3 URI, or location in Amazon S3, of OfflineStore.
    KmsKeyId string
    The AWS Key Management Service (KMS) key ID of the key used to encrypt any objects written into the OfflineStore S3 location.
    ResolvedOutputS3Uri string
    The S3 path where offline records are written.
    S3Uri string
    The S3 URI, or location in Amazon S3, of OfflineStore.
    KmsKeyId string
    The AWS Key Management Service (KMS) key ID of the key used to encrypt any objects written into the OfflineStore S3 location.
    ResolvedOutputS3Uri string
    The S3 path where offline records are written.
    s3Uri String
    The S3 URI, or location in Amazon S3, of OfflineStore.
    kmsKeyId String
    The AWS Key Management Service (KMS) key ID of the key used to encrypt any objects written into the OfflineStore S3 location.
    resolvedOutputS3Uri String
    The S3 path where offline records are written.
    s3Uri string
    The S3 URI, or location in Amazon S3, of OfflineStore.
    kmsKeyId string
    The AWS Key Management Service (KMS) key ID of the key used to encrypt any objects written into the OfflineStore S3 location.
    resolvedOutputS3Uri string
    The S3 path where offline records are written.
    s3_uri str
    The S3 URI, or location in Amazon S3, of OfflineStore.
    kms_key_id str
    The AWS Key Management Service (KMS) key ID of the key used to encrypt any objects written into the OfflineStore S3 location.
    resolved_output_s3_uri str
    The S3 path where offline records are written.
    s3Uri String
    The S3 URI, or location in Amazon S3, of OfflineStore.
    kmsKeyId String
    The AWS Key Management Service (KMS) key ID of the key used to encrypt any objects written into the OfflineStore S3 location.
    resolvedOutputS3Uri String
    The S3 path where offline records are written.

    FeatureGroupOnlineStoreConfig, FeatureGroupOnlineStoreConfigArgs

    EnableOnlineStore bool
    Set to true to disable the automatic creation of an AWS Glue table when configuring an OfflineStore.
    SecurityConfig Pulumi.Aws.Sagemaker.Inputs.FeatureGroupOnlineStoreConfigSecurityConfig
    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, or InMemory.
    TtlDuration Pulumi.Aws.Sagemaker.Inputs.FeatureGroupOnlineStoreConfigTtlDuration
    Time to live duration, where the record is hard deleted after the expiration time is reached; ExpiresAt = EventTime + TtlDuration.. See TTl Duration Below.
    EnableOnlineStore bool
    Set to true to disable the automatic creation of an AWS Glue table when configuring an OfflineStore.
    SecurityConfig FeatureGroupOnlineStoreConfigSecurityConfig
    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, or InMemory.
    TtlDuration FeatureGroupOnlineStoreConfigTtlDuration
    Time to live duration, where the record is hard deleted after the expiration time is reached; ExpiresAt = EventTime + TtlDuration.. See TTl Duration Below.
    enableOnlineStore Boolean
    Set to true to disable the automatic creation of an AWS Glue table when configuring an OfflineStore.
    securityConfig FeatureGroupOnlineStoreConfigSecurityConfig
    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, or InMemory.
    ttlDuration FeatureGroupOnlineStoreConfigTtlDuration
    Time to live duration, where the record is hard deleted after the expiration time is reached; ExpiresAt = EventTime + TtlDuration.. See TTl Duration Below.
    enableOnlineStore boolean
    Set to true to disable the automatic creation of an AWS Glue table when configuring an OfflineStore.
    securityConfig FeatureGroupOnlineStoreConfigSecurityConfig
    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, or InMemory.
    ttlDuration FeatureGroupOnlineStoreConfigTtlDuration
    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_store bool
    Set to true to disable the automatic creation of an AWS Glue table when configuring an OfflineStore.
    security_config FeatureGroupOnlineStoreConfigSecurityConfig
    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, or InMemory.
    ttl_duration FeatureGroupOnlineStoreConfigTtlDuration
    Time to live duration, where the record is hard deleted after the expiration time is reached; ExpiresAt = EventTime + TtlDuration.. See TTl Duration Below.
    enableOnlineStore Boolean
    Set to true to 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, or InMemory.
    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

    KmsKeyId string
    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.
    KmsKeyId string
    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.
    kmsKeyId String
    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.
    kmsKeyId string
    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_id str
    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.
    kmsKeyId String
    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

    Unit string
    TtlDuration time unit. Valid values are Seconds, Minutes, Hours, Days, or Weeks.
    Value int
    TtlDuration time value.
    Unit string
    TtlDuration time unit. Valid values are Seconds, Minutes, Hours, Days, or Weeks.
    Value int
    TtlDuration time value.
    unit String
    TtlDuration time unit. Valid values are Seconds, Minutes, Hours, Days, or Weeks.
    value Integer
    TtlDuration time value.
    unit string
    TtlDuration time unit. Valid values are Seconds, Minutes, Hours, Days, or Weeks.
    value number
    TtlDuration time value.
    unit str
    TtlDuration time unit. Valid values are Seconds, Minutes, Hours, Days, or Weeks.
    value int
    TtlDuration time value.
    unit String
    TtlDuration time unit. Valid values are Seconds, Minutes, Hours, Days, or Weeks.
    value Number
    TtlDuration time value.

    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 aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.31.1 published on Thursday, Apr 18, 2024 by Pulumi
    pulumi/pulumi-aws