@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
128 lines (127 loc) • 6.21 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Resource Type definition for AWS::SageMaker::FeatureGroup
*/
export declare class FeatureGroup extends pulumi.CustomResource {
/**
* Get an existing FeatureGroup resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): FeatureGroup;
/**
* Returns true if the given object is an instance of FeatureGroup. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is FeatureGroup;
/**
* A timestamp of FeatureGroup creation time.
*/
readonly creationTime: pulumi.Output<string>;
/**
* Description about the FeatureGroup.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The Event Time Feature Name.
*/
readonly eventTimeFeatureName: pulumi.Output<string>;
/**
* An Array of Feature Definition
*/
readonly featureDefinitions: pulumi.Output<outputs.sagemaker.FeatureGroupFeatureDefinition[]>;
/**
* The Name of the FeatureGroup.
*/
readonly featureGroupName: pulumi.Output<string>;
/**
* The status of the feature group.
*/
readonly featureGroupStatus: pulumi.Output<string>;
/**
* The configuration of an `OfflineStore` .
*/
readonly offlineStoreConfig: pulumi.Output<outputs.sagemaker.OfflineStoreConfigProperties | undefined>;
/**
* The configuration of an `OnlineStore` .
*/
readonly onlineStoreConfig: pulumi.Output<outputs.sagemaker.OnlineStoreConfigProperties | undefined>;
/**
* The Record Identifier Feature Name.
*/
readonly recordIdentifierFeatureName: pulumi.Output<string>;
/**
* Role Arn
*/
readonly roleArn: pulumi.Output<string | undefined>;
/**
* An array of key-value pair to apply to this resource.
*/
readonly tags: pulumi.Output<outputs.CreateOnlyTag[] | undefined>;
/**
* 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`](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OnlineStoreConfig.html#sagemaker-Type-OnlineStoreConfig-StorageType) tier online store.
*/
readonly throughputConfig: pulumi.Output<outputs.sagemaker.FeatureGroupThroughputConfig | undefined>;
/**
* Create a FeatureGroup resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: FeatureGroupArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a FeatureGroup resource.
*/
export interface FeatureGroupArgs {
/**
* Description about the FeatureGroup.
*/
description?: pulumi.Input<string>;
/**
* The Event Time Feature Name.
*/
eventTimeFeatureName: pulumi.Input<string>;
/**
* An Array of Feature Definition
*/
featureDefinitions: pulumi.Input<pulumi.Input<inputs.sagemaker.FeatureGroupFeatureDefinitionArgs>[]>;
/**
* The Name of the FeatureGroup.
*/
featureGroupName?: pulumi.Input<string>;
/**
* The configuration of an `OfflineStore` .
*/
offlineStoreConfig?: pulumi.Input<inputs.sagemaker.OfflineStoreConfigPropertiesArgs>;
/**
* The configuration of an `OnlineStore` .
*/
onlineStoreConfig?: pulumi.Input<inputs.sagemaker.OnlineStoreConfigPropertiesArgs>;
/**
* The Record Identifier Feature Name.
*/
recordIdentifierFeatureName: pulumi.Input<string>;
/**
* Role Arn
*/
roleArn?: pulumi.Input<string>;
/**
* An array of key-value pair to apply to this resource.
*/
tags?: pulumi.Input<pulumi.Input<inputs.CreateOnlyTagArgs>[]>;
/**
* 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`](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OnlineStoreConfig.html#sagemaker-Type-OnlineStoreConfig-StorageType) tier online store.
*/
throughputConfig?: pulumi.Input<inputs.sagemaker.FeatureGroupThroughputConfigArgs>;
}