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

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

aws-native.sagemaker.FeatureGroup

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

    Resource Type definition for AWS::SageMaker::FeatureGroup

    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,
                     record_identifier_feature_name: Optional[str] = None,
                     description: Optional[str] = None,
                     feature_group_name: Optional[str] = None,
                     offline_store_config: Optional[OfflineStoreConfigPropertiesArgs] = None,
                     online_store_config: Optional[OnlineStoreConfigPropertiesArgs] = None,
                     role_arn: Optional[str] = None,
                     tags: Optional[Sequence[_root_inputs.CreateOnlyTagArgs]] = 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-native: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.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const featureGroupResource = new aws_native.sagemaker.FeatureGroup("featureGroupResource", {
        eventTimeFeatureName: "string",
        featureDefinitions: [{
            featureName: "string",
            featureType: aws_native.sagemaker.FeatureGroupFeatureDefinitionFeatureType.Integral,
        }],
        recordIdentifierFeatureName: "string",
        description: "string",
        featureGroupName: "string",
        offlineStoreConfig: {
            s3StorageConfig: {
                s3Uri: "string",
                kmsKeyId: "string",
            },
            dataCatalogConfig: {
                catalog: "string",
                database: "string",
                tableName: "string",
            },
            disableGlueTableCreation: false,
            tableFormat: aws_native.sagemaker.FeatureGroupTableFormat.Iceberg,
        },
        onlineStoreConfig: {
            enableOnlineStore: false,
            securityConfig: {
                kmsKeyId: "string",
            },
            storageType: aws_native.sagemaker.FeatureGroupStorageType.Standard,
            ttlDuration: {
                unit: aws_native.sagemaker.FeatureGroupUnit.Seconds,
                value: 0,
            },
        },
        roleArn: "string",
        tags: [{
            key: "string",
            value: "string",
        }],
        throughputConfig: {
            throughputMode: aws_native.sagemaker.FeatureGroupThroughputMode.OnDemand,
            provisionedReadCapacityUnits: 0,
            provisionedWriteCapacityUnits: 0,
        },
    });
    
    Coming soon!
    

    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 Event Time Feature Name.
    FeatureDefinitions []FeatureGroupFeatureDefinitionArgs
    An Array of Feature Definition
    RecordIdentifierFeatureName string
    The Record Identifier Feature Name.
    Description string
    Description about the FeatureGroup.
    FeatureGroupName string
    The Name of the FeatureGroup.
    OfflineStoreConfig OfflineStoreConfigPropertiesArgs
    OnlineStoreConfig OnlineStoreConfigPropertiesArgs
    RoleArn string
    Role Arn
    Tags CreateOnlyTagArgs
    An array of key-value pair to apply to this resource.
    ThroughputConfig FeatureGroupThroughputConfigArgs
    eventTimeFeatureName String
    The Event Time Feature Name.
    featureDefinitions List<FeatureGroupFeatureDefinition>
    An Array of Feature Definition
    recordIdentifierFeatureName String
    The Record Identifier Feature Name.
    description String
    Description about the FeatureGroup.
    featureGroupName String
    The Name of the FeatureGroup.
    offlineStoreConfig OfflineStoreConfigProperties
    onlineStoreConfig OnlineStoreConfigProperties
    roleArn String
    Role Arn
    tags List<CreateOnlyTag>
    An array of key-value pair to apply to this resource.
    throughputConfig FeatureGroupThroughputConfig
    eventTimeFeatureName string
    The Event Time Feature Name.
    featureDefinitions FeatureGroupFeatureDefinition[]
    An Array of Feature Definition
    recordIdentifierFeatureName string
    The Record Identifier Feature Name.
    description string
    Description about the FeatureGroup.
    featureGroupName string
    The Name of the FeatureGroup.
    offlineStoreConfig OfflineStoreConfigProperties
    onlineStoreConfig OnlineStoreConfigProperties
    roleArn string
    Role Arn
    tags CreateOnlyTag[]
    An array of key-value pair to apply to this resource.
    throughputConfig FeatureGroupThroughputConfig
    event_time_feature_name str
    The Event Time Feature Name.
    feature_definitions Sequence[FeatureGroupFeatureDefinitionArgs]
    An Array of Feature Definition
    record_identifier_feature_name str
    The Record Identifier Feature Name.
    description str
    Description about the FeatureGroup.
    feature_group_name str
    The Name of the FeatureGroup.
    offline_store_config OfflineStoreConfigPropertiesArgs
    online_store_config OnlineStoreConfigPropertiesArgs
    role_arn str
    Role Arn
    tags Sequence[CreateOnlyTagArgs]
    An array of key-value pair to apply to this resource.
    throughput_config FeatureGroupThroughputConfigArgs
    eventTimeFeatureName String
    The Event Time Feature Name.
    featureDefinitions List<Property Map>
    An Array of Feature Definition
    recordIdentifierFeatureName String
    The Record Identifier Feature Name.
    description String
    Description about the FeatureGroup.
    featureGroupName String
    The Name of the FeatureGroup.
    offlineStoreConfig Property Map
    onlineStoreConfig Property Map
    roleArn String
    Role Arn
    tags List<Property Map>
    An array of key-value pair to apply to this resource.
    throughputConfig Property Map

    Outputs

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

    CreationTime string
    A timestamp of FeatureGroup creation time.
    FeatureGroupStatus string
    The status of the feature group.
    Id string
    The provider-assigned unique ID for this managed resource.
    CreationTime string
    A timestamp of FeatureGroup creation time.
    FeatureGroupStatus string
    The status of the feature group.
    Id string
    The provider-assigned unique ID for this managed resource.
    creationTime String
    A timestamp of FeatureGroup creation time.
    featureGroupStatus String
    The status of the feature group.
    id String
    The provider-assigned unique ID for this managed resource.
    creationTime string
    A timestamp of FeatureGroup creation time.
    featureGroupStatus string
    The status of the feature group.
    id string
    The provider-assigned unique ID for this managed resource.
    creation_time str
    A timestamp of FeatureGroup creation time.
    feature_group_status str
    The status of the feature group.
    id str
    The provider-assigned unique ID for this managed resource.
    creationTime String
    A timestamp of FeatureGroup creation time.
    featureGroupStatus String
    The status of the feature group.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    CreateOnlyTag, CreateOnlyTagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    FeatureGroupDataCatalogConfig, FeatureGroupDataCatalogConfigArgs

    Catalog string
    Database string
    TableName string
    Catalog string
    Database string
    TableName string
    catalog String
    database String
    tableName String
    catalog string
    database string
    tableName string
    catalog String
    database String
    tableName String

    FeatureGroupFeatureDefinition, FeatureGroupFeatureDefinitionArgs

    FeatureGroupFeatureDefinitionFeatureType, FeatureGroupFeatureDefinitionFeatureTypeArgs

    Integral
    Integral
    Fractional
    Fractional
    String
    String
    FeatureGroupFeatureDefinitionFeatureTypeIntegral
    Integral
    FeatureGroupFeatureDefinitionFeatureTypeFractional
    Fractional
    FeatureGroupFeatureDefinitionFeatureTypeString
    String
    Integral
    Integral
    Fractional
    Fractional
    String
    String
    Integral
    Integral
    Fractional
    Fractional
    String
    String
    INTEGRAL
    Integral
    FRACTIONAL
    Fractional
    STRING
    String
    "Integral"
    Integral
    "Fractional"
    Fractional
    "String"
    String

    FeatureGroupOnlineStoreSecurityConfig, FeatureGroupOnlineStoreSecurityConfigArgs

    KmsKeyId string
    KmsKeyId string
    kmsKeyId String
    kmsKeyId string
    kmsKeyId String

    FeatureGroupS3StorageConfig, FeatureGroupS3StorageConfigArgs

    S3Uri string
    KmsKeyId string
    S3Uri string
    KmsKeyId string
    s3Uri String
    kmsKeyId String
    s3Uri string
    kmsKeyId string
    s3Uri String
    kmsKeyId String

    FeatureGroupStorageType, FeatureGroupStorageTypeArgs

    Standard
    Standard
    InMemory
    InMemory
    FeatureGroupStorageTypeStandard
    Standard
    FeatureGroupStorageTypeInMemory
    InMemory
    Standard
    Standard
    InMemory
    InMemory
    Standard
    Standard
    InMemory
    InMemory
    STANDARD
    Standard
    IN_MEMORY
    InMemory
    "Standard"
    Standard
    "InMemory"
    InMemory

    FeatureGroupTableFormat, FeatureGroupTableFormatArgs

    Iceberg
    Iceberg
    Glue
    Glue
    FeatureGroupTableFormatIceberg
    Iceberg
    FeatureGroupTableFormatGlue
    Glue
    Iceberg
    Iceberg
    Glue
    Glue
    Iceberg
    Iceberg
    Glue
    Glue
    ICEBERG
    Iceberg
    GLUE
    Glue
    "Iceberg"
    Iceberg
    "Glue"
    Glue

    FeatureGroupThroughputConfig, FeatureGroupThroughputConfigArgs

    ThroughputMode Pulumi.AwsNative.SageMaker.FeatureGroupThroughputMode
    ProvisionedReadCapacityUnits int
    For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling.
    ProvisionedWriteCapacityUnits int
    For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling.
    ThroughputMode FeatureGroupThroughputMode
    ProvisionedReadCapacityUnits int
    For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling.
    ProvisionedWriteCapacityUnits int
    For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling.
    throughputMode FeatureGroupThroughputMode
    provisionedReadCapacityUnits Integer
    For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling.
    provisionedWriteCapacityUnits Integer
    For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling.
    throughputMode FeatureGroupThroughputMode
    provisionedReadCapacityUnits number
    For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling.
    provisionedWriteCapacityUnits number
    For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling.
    throughput_mode FeatureGroupThroughputMode
    provisioned_read_capacity_units int
    For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling.
    provisioned_write_capacity_units int
    For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling.
    throughputMode "OnDemand" | "Provisioned"
    provisionedReadCapacityUnits Number
    For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling.
    provisionedWriteCapacityUnits Number
    For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling.

    FeatureGroupThroughputMode, FeatureGroupThroughputModeArgs

    OnDemand
    OnDemand
    Provisioned
    Provisioned
    FeatureGroupThroughputModeOnDemand
    OnDemand
    FeatureGroupThroughputModeProvisioned
    Provisioned
    OnDemand
    OnDemand
    Provisioned
    Provisioned
    OnDemand
    OnDemand
    Provisioned
    Provisioned
    ON_DEMAND
    OnDemand
    PROVISIONED
    Provisioned
    "OnDemand"
    OnDemand
    "Provisioned"
    Provisioned

    FeatureGroupTtlDuration, FeatureGroupTtlDurationArgs

    FeatureGroupUnit, FeatureGroupUnitArgs

    Seconds
    Seconds
    Minutes
    Minutes
    Hours
    Hours
    Days
    Days
    Weeks
    Weeks
    FeatureGroupUnitSeconds
    Seconds
    FeatureGroupUnitMinutes
    Minutes
    FeatureGroupUnitHours
    Hours
    FeatureGroupUnitDays
    Days
    FeatureGroupUnitWeeks
    Weeks
    Seconds
    Seconds
    Minutes
    Minutes
    Hours
    Hours
    Days
    Days
    Weeks
    Weeks
    Seconds
    Seconds
    Minutes
    Minutes
    Hours
    Hours
    Days
    Days
    Weeks
    Weeks
    SECONDS
    Seconds
    MINUTES
    Minutes
    HOURS
    Hours
    DAYS
    Days
    WEEKS
    Weeks
    "Seconds"
    Seconds
    "Minutes"
    Minutes
    "Hours"
    Hours
    "Days"
    Days
    "Weeks"
    Weeks

    OfflineStoreConfigProperties, OfflineStoreConfigPropertiesArgs

    OnlineStoreConfigProperties, OnlineStoreConfigPropertiesArgs

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi