Package software.amazon.awscdk.services.sagemaker

Interface CfnFeatureGroup.ThroughputConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFeatureGroup.ThroughputConfigProperty.Jsii$Proxy

Enclosing class:

CfnFeatureGroup

@Stability(Stable)
public static interface CfnFeatureGroup.ThroughputConfigProperty
extends software.amazon.jsii.JsiiSerializable

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.sagemaker.*;
 ThroughputConfigProperty throughputConfigProperty = ThroughputConfigProperty.builder()
         .throughputMode("throughputMode")
         // the properties below are optional
         .provisionedReadCapacityUnits(123)
         .provisionedWriteCapacityUnits(123)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-throughputconfig.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnFeatureGroup.ThroughputConfigProperty.Builder	A builder for CfnFeatureGroup.ThroughputConfigProperty
static final class	CfnFeatureGroup.ThroughputConfigProperty.Jsii$Proxy	An implementation for CfnFeatureGroup.ThroughputConfigProperty

Method Summary

Modifier and Type	Method	Description
static CfnFeatureGroup.ThroughputConfigProperty.Builder	builder()
default Number	getProvisionedReadCapacityUnits()	For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling.
default Number	getProvisionedWriteCapacityUnits()	For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling.
String	getThroughputMode()	The mode used for your feature group throughput: ON_DEMAND or PROVISIONED .

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getThroughputMode

@Stability(Stable)
@NotNull
String getThroughputMode()

The mode used for your feature group throughput: ON_DEMAND or PROVISIONED .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-throughputconfig.html#cfn-sagemaker-featuregroup-throughputconfig-throughputmode

getProvisionedReadCapacityUnits

@Stability(Stable)
@Nullable
default Number getProvisionedReadCapacityUnits()

For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling.

This field is not applicable for on-demand feature groups.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-throughputconfig.html#cfn-sagemaker-featuregroup-throughputconfig-provisionedreadcapacityunits

getProvisionedWriteCapacityUnits

@Stability(Stable)
@Nullable
default Number getProvisionedWriteCapacityUnits()

For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling.

This field is not applicable for on-demand feature groups.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-throughputconfig.html#cfn-sagemaker-featuregroup-throughputconfig-provisionedwritecapacityunits

builder

@Stability(Stable)
static CfnFeatureGroup.ThroughputConfigProperty.Builder builder()

Returns:

a CfnFeatureGroup.ThroughputConfigProperty.Builder of CfnFeatureGroup.ThroughputConfigProperty