FeatureGroup class

Provides a SageMaker AI 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", {
    onlineStoreConfig: {
        enableOnlineStore: true,
    },
    featureDefinitions: [{
        featureName: "example",
        featureType: "String",
    }],
    featureGroupName: "example",
    recordIdentifierFeatureName: "example",
    eventTimeFeatureName: "example",
    roleArn: test.arn,
});

import pulumi
import pulumi_aws as aws

example = aws.sagemaker.FeatureGroup("example",
    online_store_config={
        "enable_online_store": True,
    },
    feature_definitions=[{
        "feature_name": "example",
        "feature_type": "String",
    }],
    feature_group_name="example",
    record_identifier_feature_name="example",
    event_time_feature_name="example",
    role_arn=test["arn"])

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()
    {
        OnlineStoreConfig = new Aws.Sagemaker.Inputs.FeatureGroupOnlineStoreConfigArgs
        {
            EnableOnlineStore = true,
        },
        FeatureDefinitions = new[]
        {
            new Aws.Sagemaker.Inputs.FeatureGroupFeatureDefinitionArgs
            {
                FeatureName = "example",
                FeatureType = "String",
            },
        },
        FeatureGroupName = "example",
        RecordIdentifierFeatureName = "example",
        EventTimeFeatureName = "example",
        RoleArn = test.Arn,
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/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{
			OnlineStoreConfig: &sagemaker.FeatureGroupOnlineStoreConfigArgs{
				EnableOnlineStore: pulumi.Bool(true),
			},
			FeatureDefinitions: sagemaker.FeatureGroupFeatureDefinitionArray{
				&sagemaker.FeatureGroupFeatureDefinitionArgs{
					FeatureName: pulumi.String("example"),
					FeatureType: pulumi.String("String"),
				},
			},
			FeatureGroupName:            pulumi.String("example"),
			RecordIdentifierFeatureName: pulumi.String("example"),
			EventTimeFeatureName:        pulumi.String("example"),
			RoleArn:                     pulumi.Any(test.Arn),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_sagemaker_featuregroup" "example" {
  online_store_config = {
    enable_online_store = true
  }
  feature_definitions {
    feature_name = "example"
    feature_type = "String"
  }
  feature_group_name             = "example"
  record_identifier_feature_name = "example"
  event_time_feature_name        = "example"
  role_arn                       = test.arn
}

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.FeatureGroupOnlineStoreConfigArgs;
import com.pulumi.aws.sagemaker.inputs.FeatureGroupFeatureDefinitionArgs;
import java.util.ArrayList;
import java.util.Arrays;
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()
            .onlineStoreConfig(FeatureGroupOnlineStoreConfigArgs.builder()
                .enableOnlineStore(true)
                .build())
            .featureDefinitions(FeatureGroupFeatureDefinitionArgs.builder()
                .featureName("example")
                .featureType("String")
                .build())
            .featureGroupName("example")
            .recordIdentifierFeatureName("example")
            .eventTimeFeatureName("example")
            .roleArn(test.arn())
            .build());

    }
}

resources:
  example:
    type: aws:sagemaker:FeatureGroup
    properties:
      onlineStoreConfig:
        enableOnlineStore: true
      featureDefinitions:
        - featureName: example
          featureType: String
      featureGroupName: example
      recordIdentifierFeatureName: example
      eventTimeFeatureName: example
      roleArn: ${test.arn}

Import

Using pulumi import, import Feature Groups using the name. For example:

$ pulumi import aws:sagemaker/featureGroup:FeatureGroup test_feature_group feature_group-foo

Constructors

FeatureGroup(String name, {FeatureGroupArgs? args, CustomResourceOptions? options}): Creates a new FeatureGroup. name The Pulumi resource name. args Arguments used to configure this FeatureGroup. The set of arguments for FeatureGroup. options Resource options controlling this resource's behavior.
FeatureGroup.reference(String urn): Creates a typed reference to an existing FeatureGroup resource.

Properties

arn ↔ Output<String>: ARN assigned by AWS to this feature_group.
latefinal
childResources → Set<Resource>: finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>: latefinalinherited
description ↔ Output<String?>: A free-form description of a Feature Group.
latefinal
eventTimeFeatureName ↔ Output<String>: The name of the feature that stores the EventTime of a Record in a Feature Group.
latefinal
featureDefinitions ↔ Output<List<FeatureGroupFeatureDefinition>>: A list of Feature names and types. See Feature Definition Below.
latefinal
featureGroupName ↔ Output<String>: The name of the Feature Group. The name must be unique within an AWS Region in an AWS account.
latefinal
hashCode → int: The hash code for this object.
no setterinherited
id ↔ Output<String>: getter/setter pairinherited
isCustom → bool: Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool: Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool: Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool: Whether this instance represents a resource value returned over RPC.
finalinherited
offlineStoreConfig ↔ Output<FeatureGroupOfflineStoreConfig?>: The Offline Feature Store Configuration. See Offline Store Config Below.
latefinal
onlineStoreConfig ↔ Output<FeatureGroupOnlineStoreConfig?>: The Online Feature Store Configuration. See Online Store Config Below.
latefinal
recordIdentifierFeatureName ↔ Output<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.
latefinal
region ↔ Output<String>: Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>: Inherited/explicit async transforms.
no setterinherited
roleArn ↔ Output<String>: The ARN of the IAM execution role used to persist data into the Offline Store if an offlineStoreConfig is provided.
latefinal
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
tags ↔ Output<Map<String, String>?>: Map of resource tags for the resource. .If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>: A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
throughputConfig ↔ Output<FeatureGroupThroughputConfig>: latefinal
transformations → List<ResourceTransformation>: Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>: latefinalinherited

Methods

failId(Object error) → void: Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void: Completes all output properties with error.
inherited
failUrn(Object error) → void: Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?: Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String: Returns this resource's logical name.
inherited
getResourceType() → String: Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>: Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void: Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void: Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void: Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>: Serializes resource properties for RPC transmission.
inherited
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {FeatureGroupState? state, CustomResourceOptions? options}) → FeatureGroup: Gets an existing FeatureGroup resource's state with the given name and id.

FeatureGroup class

Example Usage

Import

Constructors

Properties

Methods

Operators

Static Methods

sagemaker library