Docs Packages
  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.112.0 published on Wednesday, Jul 24, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.sagemaker.FeatureGroup

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.112.0 published on Wednesday, Jul 24, 2024 by Pulumi
pulumi/pulumi-aws-native

    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.

    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 List<Pulumi.AwsNative.SageMaker.Inputs.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 Pulumi.AwsNative.SageMaker.Inputs.OfflineStoreConfigProperties
    The configuration of an OfflineStore .
    OnlineStoreConfig Pulumi.AwsNative.SageMaker.Inputs.OnlineStoreConfigProperties
    The configuration of an OnlineStore .
    RoleArn string
    Role Arn
    Tags List<Pulumi.AwsNative.Inputs.CreateOnlyTag>
    An array of key-value pair to apply to this resource.
    ThroughputConfig Pulumi.AwsNative.SageMaker.Inputs.FeatureGroupThroughputConfig

    Used to set feature group throughput configuration. There are two modes: ON_DEMAND and PROVISIONED . With on-demand mode, you are charged for data reads and writes that your application performs on your feature group. You do not need to specify read and write throughput because Feature Store accommodates your workloads as they ramp up and down. You can switch a feature group to on-demand only once in a 24 hour period. With provisioned throughput mode, you specify the read and write capacity per second that you expect your application to require, and you are billed based on those limits. Exceeding provisioned throughput will result in your requests being throttled.

    Note: PROVISIONED throughput mode is supported only for feature groups that are offline-only, or use the Standard tier online store.

    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
    The configuration of an OfflineStore .
    OnlineStoreConfig OnlineStoreConfigPropertiesArgs
    The configuration of an OnlineStore .
    RoleArn string
    Role Arn
    Tags CreateOnlyTagArgs
    An array of key-value pair to apply to this resource.
    ThroughputConfig FeatureGroupThroughputConfigArgs

    Used to set feature group throughput configuration. There are two modes: ON_DEMAND and PROVISIONED . With on-demand mode, you are charged for data reads and writes that your application performs on your feature group. You do not need to specify read and write throughput because Feature Store accommodates your workloads as they ramp up and down. You can switch a feature group to on-demand only once in a 24 hour period. With provisioned throughput mode, you specify the read and write capacity per second that you expect your application to require, and you are billed based on those limits. Exceeding provisioned throughput will result in your requests being throttled.

    Note: PROVISIONED throughput mode is supported only for feature groups that are offline-only, or use the Standard tier online store.

    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
    The configuration of an OfflineStore .
    onlineStoreConfig OnlineStoreConfigProperties
    The configuration of an OnlineStore .
    roleArn String
    Role Arn
    tags List<CreateOnlyTag>
    An array of key-value pair to apply to this resource.
    throughputConfig FeatureGroupThroughputConfig

    Used to set feature group throughput configuration. There are two modes: ON_DEMAND and PROVISIONED . With on-demand mode, you are charged for data reads and writes that your application performs on your feature group. You do not need to specify read and write throughput because Feature Store accommodates your workloads as they ramp up and down. You can switch a feature group to on-demand only once in a 24 hour period. With provisioned throughput mode, you specify the read and write capacity per second that you expect your application to require, and you are billed based on those limits. Exceeding provisioned throughput will result in your requests being throttled.

    Note: PROVISIONED throughput mode is supported only for feature groups that are offline-only, or use the Standard tier online store.

    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
    The configuration of an OfflineStore .
    onlineStoreConfig OnlineStoreConfigProperties
    The configuration of an OnlineStore .
    roleArn string
    Role Arn
    tags CreateOnlyTag[]
    An array of key-value pair to apply to this resource.
    throughputConfig FeatureGroupThroughputConfig

    Used to set feature group throughput configuration. There are two modes: ON_DEMAND and PROVISIONED . With on-demand mode, you are charged for data reads and writes that your application performs on your feature group. You do not need to specify read and write throughput because Feature Store accommodates your workloads as they ramp up and down. You can switch a feature group to on-demand only once in a 24 hour period. With provisioned throughput mode, you specify the read and write capacity per second that you expect your application to require, and you are billed based on those limits. Exceeding provisioned throughput will result in your requests being throttled.

    Note: PROVISIONED throughput mode is supported only for feature groups that are offline-only, or use the Standard tier online store.

    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
    The configuration of an OfflineStore .
    online_store_config OnlineStoreConfigPropertiesArgs
    The configuration of an OnlineStore .
    role_arn str
    Role Arn
    tags Sequence[CreateOnlyTagArgs]
    An array of key-value pair to apply to this resource.
    throughput_config FeatureGroupThroughputConfigArgs

    Used to set feature group throughput configuration. There are two modes: ON_DEMAND and PROVISIONED . With on-demand mode, you are charged for data reads and writes that your application performs on your feature group. You do not need to specify read and write throughput because Feature Store accommodates your workloads as they ramp up and down. You can switch a feature group to on-demand only once in a 24 hour period. With provisioned throughput mode, you specify the read and write capacity per second that you expect your application to require, and you are billed based on those limits. Exceeding provisioned throughput will result in your requests being throttled.

    Note: PROVISIONED throughput mode is supported only for feature groups that are offline-only, or use the Standard tier online store.

    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
    The configuration of an OfflineStore .
    onlineStoreConfig Property Map
    The configuration of an OnlineStore .
    roleArn String
    Role Arn
    tags List<Property Map>
    An array of key-value pair to apply to this resource.
    throughputConfig Property Map

    Used to set feature group throughput configuration. There are two modes: ON_DEMAND and PROVISIONED . With on-demand mode, you are charged for data reads and writes that your application performs on your feature group. You do not need to specify read and write throughput because Feature Store accommodates your workloads as they ramp up and down. You can switch a feature group to on-demand only once in a 24 hour period. With provisioned throughput mode, you specify the read and write capacity per second that you expect your application to require, and you are billed based on those limits. Exceeding provisioned throughput will result in your requests being throttled.

    Note: PROVISIONED throughput mode is supported only for feature groups that are offline-only, or use the Standard tier online store.

    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
    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.

    FeatureGroupFeatureDefinition, FeatureGroupFeatureDefinitionArgs

    FeatureName string

    The name of a feature. The type must be a string. FeatureName cannot be any of the following: is_deleted , write_time , api_invocation_time .

    The name:

    • Must start with an alphanumeric character.
    • Can only include alphanumeric characters, underscores, and hyphens. Spaces are not allowed.
    FeatureType Pulumi.AwsNative.SageMaker.FeatureGroupFeatureDefinitionFeatureType
    The value type of a feature. Valid values are Integral, Fractional, or String.
    FeatureName string

    The name of a feature. The type must be a string. FeatureName cannot be any of the following: is_deleted , write_time , api_invocation_time .

    The name:

    • Must start with an alphanumeric character.
    • Can only include alphanumeric characters, underscores, and hyphens. Spaces are not allowed.
    FeatureType FeatureGroupFeatureDefinitionFeatureType
    The value type of a feature. Valid values are Integral, Fractional, or String.
    featureName String

    The name of a feature. The type must be a string. FeatureName cannot be any of the following: is_deleted , write_time , api_invocation_time .

    The name:

    • Must start with an alphanumeric character.
    • Can only include alphanumeric characters, underscores, and hyphens. Spaces are not allowed.
    featureType FeatureGroupFeatureDefinitionFeatureType
    The value type of a feature. Valid values are Integral, Fractional, or String.
    featureName string

    The name of a feature. The type must be a string. FeatureName cannot be any of the following: is_deleted , write_time , api_invocation_time .

    The name:

    • Must start with an alphanumeric character.
    • Can only include alphanumeric characters, underscores, and hyphens. Spaces are not allowed.
    featureType FeatureGroupFeatureDefinitionFeatureType
    The value type of a feature. Valid values are Integral, Fractional, or String.
    feature_name str

    The name of a feature. The type must be a string. FeatureName cannot be any of the following: is_deleted , write_time , api_invocation_time .

    The name:

    • Must start with an alphanumeric character.
    • Can only include alphanumeric characters, underscores, and hyphens. Spaces are not allowed.
    feature_type FeatureGroupFeatureDefinitionFeatureType
    The value type of a feature. Valid values are Integral, Fractional, or String.
    featureName String

    The name of a feature. The type must be a string. FeatureName cannot be any of the following: is_deleted , write_time , api_invocation_time .

    The name:

    • Must start with an alphanumeric character.
    • Can only include alphanumeric characters, underscores, and hyphens. Spaces are not allowed.
    featureType "Integral" | "Fractional" | "String"
    The value type of a feature. Valid values are Integral, Fractional, or String.

    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

    The AWS Key Management Service (KMS) key ARN that SageMaker Feature Store uses to encrypt the Amazon S3 objects at rest using Amazon S3 server-side encryption.

    The caller (either user or IAM role) of CreateFeatureGroup must have below permissions to the OnlineStore KmsKeyId :

    • "kms:Encrypt"
    • "kms:Decrypt"
    • "kms:DescribeKey"
    • "kms:CreateGrant"
    • "kms:RetireGrant"
    • "kms:ReEncryptFrom"
    • "kms:ReEncryptTo"
    • "kms:GenerateDataKey"
    • "kms:ListAliases"
    • "kms:ListGrants"
    • "kms:RevokeGrant"

    The caller (either user or IAM role) to all DataPlane operations ( PutRecord , GetRecord , DeleteRecord ) must have the following permissions to the KmsKeyId :

    • "kms:Decrypt"
    KmsKeyId string

    The AWS Key Management Service (KMS) key ARN that SageMaker Feature Store uses to encrypt the Amazon S3 objects at rest using Amazon S3 server-side encryption.

    The caller (either user or IAM role) of CreateFeatureGroup must have below permissions to the OnlineStore KmsKeyId :

    • "kms:Encrypt"
    • "kms:Decrypt"
    • "kms:DescribeKey"
    • "kms:CreateGrant"
    • "kms:RetireGrant"
    • "kms:ReEncryptFrom"
    • "kms:ReEncryptTo"
    • "kms:GenerateDataKey"
    • "kms:ListAliases"
    • "kms:ListGrants"
    • "kms:RevokeGrant"

    The caller (either user or IAM role) to all DataPlane operations ( PutRecord , GetRecord , DeleteRecord ) must have the following permissions to the KmsKeyId :

    • "kms:Decrypt"
    kmsKeyId String

    The AWS Key Management Service (KMS) key ARN that SageMaker Feature Store uses to encrypt the Amazon S3 objects at rest using Amazon S3 server-side encryption.

    The caller (either user or IAM role) of CreateFeatureGroup must have below permissions to the OnlineStore KmsKeyId :

    • "kms:Encrypt"
    • "kms:Decrypt"
    • "kms:DescribeKey"
    • "kms:CreateGrant"
    • "kms:RetireGrant"
    • "kms:ReEncryptFrom"
    • "kms:ReEncryptTo"
    • "kms:GenerateDataKey"
    • "kms:ListAliases"
    • "kms:ListGrants"
    • "kms:RevokeGrant"

    The caller (either user or IAM role) to all DataPlane operations ( PutRecord , GetRecord , DeleteRecord ) must have the following permissions to the KmsKeyId :

    • "kms:Decrypt"
    kmsKeyId string

    The AWS Key Management Service (KMS) key ARN that SageMaker Feature Store uses to encrypt the Amazon S3 objects at rest using Amazon S3 server-side encryption.

    The caller (either user or IAM role) of CreateFeatureGroup must have below permissions to the OnlineStore KmsKeyId :

    • "kms:Encrypt"
    • "kms:Decrypt"
    • "kms:DescribeKey"
    • "kms:CreateGrant"
    • "kms:RetireGrant"
    • "kms:ReEncryptFrom"
    • "kms:ReEncryptTo"
    • "kms:GenerateDataKey"
    • "kms:ListAliases"
    • "kms:ListGrants"
    • "kms:RevokeGrant"

    The caller (either user or IAM role) to all DataPlane operations ( PutRecord , GetRecord , DeleteRecord ) must have the following permissions to the KmsKeyId :

    • "kms:Decrypt"
    kms_key_id str

    The AWS Key Management Service (KMS) key ARN that SageMaker Feature Store uses to encrypt the Amazon S3 objects at rest using Amazon S3 server-side encryption.

    The caller (either user or IAM role) of CreateFeatureGroup must have below permissions to the OnlineStore KmsKeyId :

    • "kms:Encrypt"
    • "kms:Decrypt"
    • "kms:DescribeKey"
    • "kms:CreateGrant"
    • "kms:RetireGrant"
    • "kms:ReEncryptFrom"
    • "kms:ReEncryptTo"
    • "kms:GenerateDataKey"
    • "kms:ListAliases"
    • "kms:ListGrants"
    • "kms:RevokeGrant"

    The caller (either user or IAM role) to all DataPlane operations ( PutRecord , GetRecord , DeleteRecord ) must have the following permissions to the KmsKeyId :

    • "kms:Decrypt"
    kmsKeyId String

    The AWS Key Management Service (KMS) key ARN that SageMaker Feature Store uses to encrypt the Amazon S3 objects at rest using Amazon S3 server-side encryption.

    The caller (either user or IAM role) of CreateFeatureGroup must have below permissions to the OnlineStore KmsKeyId :

    • "kms:Encrypt"
    • "kms:Decrypt"
    • "kms:DescribeKey"
    • "kms:CreateGrant"
    • "kms:RetireGrant"
    • "kms:ReEncryptFrom"
    • "kms:ReEncryptTo"
    • "kms:GenerateDataKey"
    • "kms:ListAliases"
    • "kms:ListGrants"
    • "kms:RevokeGrant"

    The caller (either user or IAM role) to all DataPlane operations ( PutRecord , GetRecord , DeleteRecord ) must have the following permissions to the KmsKeyId :

    • "kms:Decrypt"

    FeatureGroupS3StorageConfig, FeatureGroupS3StorageConfigArgs

    S3Uri string

    The S3 URI, or location in Amazon S3, of OfflineStore .

    S3 URIs have a format similar to the following: s3://example-bucket/prefix/ .

    KmsKeyId string

    The AWS Key Management Service (KMS) key ARN of the key used to encrypt any objects written into the OfflineStore S3 location.

    The IAM roleARN that is passed as a parameter to CreateFeatureGroup must have below permissions to the KmsKeyId :

    • "kms:GenerateDataKey"
    S3Uri string

    The S3 URI, or location in Amazon S3, of OfflineStore .

    S3 URIs have a format similar to the following: s3://example-bucket/prefix/ .

    KmsKeyId string

    The AWS Key Management Service (KMS) key ARN of the key used to encrypt any objects written into the OfflineStore S3 location.

    The IAM roleARN that is passed as a parameter to CreateFeatureGroup must have below permissions to the KmsKeyId :

    • "kms:GenerateDataKey"
    s3Uri String

    The S3 URI, or location in Amazon S3, of OfflineStore .

    S3 URIs have a format similar to the following: s3://example-bucket/prefix/ .

    kmsKeyId String

    The AWS Key Management Service (KMS) key ARN of the key used to encrypt any objects written into the OfflineStore S3 location.

    The IAM roleARN that is passed as a parameter to CreateFeatureGroup must have below permissions to the KmsKeyId :

    • "kms:GenerateDataKey"
    s3Uri string

    The S3 URI, or location in Amazon S3, of OfflineStore .

    S3 URIs have a format similar to the following: s3://example-bucket/prefix/ .

    kmsKeyId string

    The AWS Key Management Service (KMS) key ARN of the key used to encrypt any objects written into the OfflineStore S3 location.

    The IAM roleARN that is passed as a parameter to CreateFeatureGroup must have below permissions to the KmsKeyId :

    • "kms:GenerateDataKey"
    s3_uri str

    The S3 URI, or location in Amazon S3, of OfflineStore .

    S3 URIs have a format similar to the following: s3://example-bucket/prefix/ .

    kms_key_id str

    The AWS Key Management Service (KMS) key ARN of the key used to encrypt any objects written into the OfflineStore S3 location.

    The IAM roleARN that is passed as a parameter to CreateFeatureGroup must have below permissions to the KmsKeyId :

    • "kms:GenerateDataKey"
    s3Uri String

    The S3 URI, or location in Amazon S3, of OfflineStore .

    S3 URIs have a format similar to the following: s3://example-bucket/prefix/ .

    kmsKeyId String

    The AWS Key Management Service (KMS) key ARN of the key used to encrypt any objects written into the OfflineStore S3 location.

    The IAM roleARN that is passed as a parameter to CreateFeatureGroup must have below permissions to the KmsKeyId :

    • "kms:GenerateDataKey"

    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
    The mode used for your feature group throughput: ON_DEMAND or PROVISIONED .
    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
    The mode used for your feature group throughput: ON_DEMAND or PROVISIONED .
    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
    The mode used for your feature group throughput: ON_DEMAND or PROVISIONED .
    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
    The mode used for your feature group throughput: ON_DEMAND or 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.
    throughput_mode FeatureGroupThroughputMode
    The mode used for your feature group throughput: ON_DEMAND or PROVISIONED .
    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"
    The mode used for your feature group throughput: ON_DEMAND or 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

    Unit Pulumi.AwsNative.SageMaker.FeatureGroupUnit
    TtlDuration time unit.
    Value int
    TtlDuration time value.
    Unit FeatureGroupUnit
    TtlDuration time unit.
    Value int
    TtlDuration time value.
    unit FeatureGroupUnit
    TtlDuration time unit.
    value Integer
    TtlDuration time value.
    unit FeatureGroupUnit
    TtlDuration time unit.
    value number
    TtlDuration time value.
    unit FeatureGroupUnit
    TtlDuration time unit.
    value int
    TtlDuration time value.
    unit "Seconds" | "Minutes" | "Hours" | "Days" | "Weeks"
    TtlDuration time unit.
    value Number
    TtlDuration time value.

    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

    S3StorageConfig Pulumi.AwsNative.SageMaker.Inputs.FeatureGroupS3StorageConfig
    The Amazon Simple Storage (Amazon S3) location of OfflineStore .
    DataCatalogConfig Pulumi.AwsNative.SageMaker.Inputs.FeatureGroupDataCatalogConfig
    The meta data of the Glue table that is autogenerated when an OfflineStore is created.
    DisableGlueTableCreation bool

    Set to True to disable the automatic creation of an AWS Glue table when configuring an OfflineStore . If set to False , Feature Store will name the OfflineStore Glue table following Athena's naming recommendations .

    The default value is False .

    TableFormat Pulumi.AwsNative.SageMaker.FeatureGroupTableFormat
    Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg .
    S3StorageConfig FeatureGroupS3StorageConfig
    The Amazon Simple Storage (Amazon S3) location of OfflineStore .
    DataCatalogConfig FeatureGroupDataCatalogConfig
    The meta data of the Glue table that is autogenerated when an OfflineStore is created.
    DisableGlueTableCreation bool

    Set to True to disable the automatic creation of an AWS Glue table when configuring an OfflineStore . If set to False , Feature Store will name the OfflineStore Glue table following Athena's naming recommendations .

    The default value is False .

    TableFormat FeatureGroupTableFormat
    Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg .
    s3StorageConfig FeatureGroupS3StorageConfig
    The Amazon Simple Storage (Amazon S3) location of OfflineStore .
    dataCatalogConfig FeatureGroupDataCatalogConfig
    The meta data of the Glue table that is autogenerated when an OfflineStore is created.
    disableGlueTableCreation Boolean

    Set to True to disable the automatic creation of an AWS Glue table when configuring an OfflineStore . If set to False , Feature Store will name the OfflineStore Glue table following Athena's naming recommendations .

    The default value is False .

    tableFormat FeatureGroupTableFormat
    Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg .
    s3StorageConfig FeatureGroupS3StorageConfig
    The Amazon Simple Storage (Amazon S3) location of OfflineStore .
    dataCatalogConfig FeatureGroupDataCatalogConfig
    The meta data of the Glue table that is autogenerated when an OfflineStore is created.
    disableGlueTableCreation boolean

    Set to True to disable the automatic creation of an AWS Glue table when configuring an OfflineStore . If set to False , Feature Store will name the OfflineStore Glue table following Athena's naming recommendations .

    The default value is False .

    tableFormat FeatureGroupTableFormat
    Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg .
    s3_storage_config FeatureGroupS3StorageConfig
    The Amazon Simple Storage (Amazon S3) location of OfflineStore .
    data_catalog_config FeatureGroupDataCatalogConfig
    The meta data of the Glue table that is autogenerated when an OfflineStore is created.
    disable_glue_table_creation bool

    Set to True to disable the automatic creation of an AWS Glue table when configuring an OfflineStore . If set to False , Feature Store will name the OfflineStore Glue table following Athena's naming recommendations .

    The default value is False .

    table_format FeatureGroupTableFormat
    Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg .
    s3StorageConfig Property Map
    The Amazon Simple Storage (Amazon S3) location of OfflineStore .
    dataCatalogConfig Property Map
    The meta data of the Glue table that is autogenerated when an OfflineStore is created.
    disableGlueTableCreation Boolean

    Set to True to disable the automatic creation of an AWS Glue table when configuring an OfflineStore . If set to False , Feature Store will name the OfflineStore Glue table following Athena's naming recommendations .

    The default value is False .

    tableFormat "Iceberg" | "Glue"
    Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg .

    OnlineStoreConfigProperties, OnlineStoreConfigPropertiesArgs

    EnableOnlineStore bool

    Turn OnlineStore off by specifying False for the EnableOnlineStore flag. Turn OnlineStore on by specifying True for the EnableOnlineStore flag.

    The default value is False .

    SecurityConfig Pulumi.AwsNative.SageMaker.Inputs.FeatureGroupOnlineStoreSecurityConfig
    Use to specify KMS Key ID ( KMSKeyId ) for at-rest encryption of your OnlineStore .
    StorageType Pulumi.AwsNative.SageMaker.FeatureGroupStorageType
    Option for different tiers of low latency storage for real-time data retrieval.

    • Standard : A managed low latency data store for feature groups.
    • InMemory : A managed data store for feature groups that supports very low latency retrieval.
    TtlDuration Pulumi.AwsNative.SageMaker.Inputs.FeatureGroupTtlDuration
    Time to live duration, where the record is hard deleted after the expiration time is reached; ExpiresAt = EventTime + TtlDuration . For information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.
    EnableOnlineStore bool

    Turn OnlineStore off by specifying False for the EnableOnlineStore flag. Turn OnlineStore on by specifying True for the EnableOnlineStore flag.

    The default value is False .

    SecurityConfig FeatureGroupOnlineStoreSecurityConfig
    Use to specify KMS Key ID ( KMSKeyId ) for at-rest encryption of your OnlineStore .
    StorageType FeatureGroupStorageType
    Option for different tiers of low latency storage for real-time data retrieval.

    • Standard : A managed low latency data store for feature groups.
    • InMemory : A managed data store for feature groups that supports very low latency retrieval.
    TtlDuration FeatureGroupTtlDuration
    Time to live duration, where the record is hard deleted after the expiration time is reached; ExpiresAt = EventTime + TtlDuration . For information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.
    enableOnlineStore Boolean

    Turn OnlineStore off by specifying False for the EnableOnlineStore flag. Turn OnlineStore on by specifying True for the EnableOnlineStore flag.

    The default value is False .

    securityConfig FeatureGroupOnlineStoreSecurityConfig
    Use to specify KMS Key ID ( KMSKeyId ) for at-rest encryption of your OnlineStore .
    storageType FeatureGroupStorageType
    Option for different tiers of low latency storage for real-time data retrieval.

    • Standard : A managed low latency data store for feature groups.
    • InMemory : A managed data store for feature groups that supports very low latency retrieval.
    ttlDuration FeatureGroupTtlDuration
    Time to live duration, where the record is hard deleted after the expiration time is reached; ExpiresAt = EventTime + TtlDuration . For information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.
    enableOnlineStore boolean

    Turn OnlineStore off by specifying False for the EnableOnlineStore flag. Turn OnlineStore on by specifying True for the EnableOnlineStore flag.

    The default value is False .

    securityConfig FeatureGroupOnlineStoreSecurityConfig
    Use to specify KMS Key ID ( KMSKeyId ) for at-rest encryption of your OnlineStore .
    storageType FeatureGroupStorageType
    Option for different tiers of low latency storage for real-time data retrieval.

    • Standard : A managed low latency data store for feature groups.
    • InMemory : A managed data store for feature groups that supports very low latency retrieval.
    ttlDuration FeatureGroupTtlDuration
    Time to live duration, where the record is hard deleted after the expiration time is reached; ExpiresAt = EventTime + TtlDuration . For information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.
    enable_online_store bool

    Turn OnlineStore off by specifying False for the EnableOnlineStore flag. Turn OnlineStore on by specifying True for the EnableOnlineStore flag.

    The default value is False .

    security_config FeatureGroupOnlineStoreSecurityConfig
    Use to specify KMS Key ID ( KMSKeyId ) for at-rest encryption of your OnlineStore .
    storage_type FeatureGroupStorageType
    Option for different tiers of low latency storage for real-time data retrieval.

    • Standard : A managed low latency data store for feature groups.
    • InMemory : A managed data store for feature groups that supports very low latency retrieval.
    ttl_duration FeatureGroupTtlDuration
    Time to live duration, where the record is hard deleted after the expiration time is reached; ExpiresAt = EventTime + TtlDuration . For information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.
    enableOnlineStore Boolean

    Turn OnlineStore off by specifying False for the EnableOnlineStore flag. Turn OnlineStore on by specifying True for the EnableOnlineStore flag.

    The default value is False .

    securityConfig Property Map
    Use to specify KMS Key ID ( KMSKeyId ) for at-rest encryption of your OnlineStore .
    storageType "Standard" | "InMemory"
    Option for different tiers of low latency storage for real-time data retrieval.

    • Standard : A managed low latency data store for feature groups.
    • InMemory : A managed data store for feature groups that supports very low latency retrieval.
    ttlDuration Property Map
    Time to live duration, where the record is hard deleted after the expiration time is reached; ExpiresAt = EventTime + TtlDuration . For information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.

    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.112.0 published on Wednesday, Jul 24, 2024 by Pulumi
    pulumi/pulumi-aws-native