Class: AWSCDK::Sagemaker::CfnFeatureGroup::ThroughputConfigProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Sagemaker::CfnFeatureGroup::ThroughputConfigProperty

Defined in:

sagemaker/cfn_feature_group.rb

Overview

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.

See Also:

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

Instance Attribute Summary

• #provisioned_read_capacity_units ⇒ Numeric^? readonly

  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 ⇒ Numeric^? readonly

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

• #throughput_mode ⇒ String readonly

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

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(throughput_mode:, provisioned_read_capacity_units: nil, provisioned_write_capacity_units: nil) ⇒ ThroughputConfigProperty constructor

  A new instance of ThroughputConfigProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(throughput_mode:, provisioned_read_capacity_units: nil, provisioned_write_capacity_units: nil) ⇒ ThroughputConfigProperty

Returns a new instance of ThroughputConfigProperty.

Parameters:

• throughput_mode (String) —

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

• provisioned_read_capacity_units (Numeric, nil) (defaults to: nil) —

  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 (Numeric, nil) (defaults to: nil) —

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

# File 'sagemaker/cfn_feature_group.rb', line 1026

def initialize(throughput_mode:, provisioned_read_capacity_units: nil, provisioned_write_capacity_units: nil)
  @throughput_mode = throughput_mode
  Jsii::Type.check_type(@throughput_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "throughputMode")
  @provisioned_read_capacity_units = provisioned_read_capacity_units
  Jsii::Type.check_type(@provisioned_read_capacity_units, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "provisionedReadCapacityUnits") unless @provisioned_read_capacity_units.nil?
  @provisioned_write_capacity_units = provisioned_write_capacity_units
  Jsii::Type.check_type(@provisioned_write_capacity_units, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "provisionedWriteCapacityUnits") unless @provisioned_write_capacity_units.nil?
end

Instance Attribute Details

#provisioned_read_capacity_units ⇒ Numeric^? (readonly)

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.

Returns:

• (Numeric, nil)

See Also:

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

# File 'sagemaker/cfn_feature_group.rb', line 1046

def provisioned_read_capacity_units
  @provisioned_read_capacity_units
end

#provisioned_write_capacity_units ⇒ Numeric^? (readonly)

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.

Returns:

• (Numeric, nil)

See Also:

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

# File 'sagemaker/cfn_feature_group.rb', line 1053

def provisioned_write_capacity_units
  @provisioned_write_capacity_units
end

#throughput_mode ⇒ String (readonly)

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

Returns:

• (String)

See Also:

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

# File 'sagemaker/cfn_feature_group.rb', line 1039

def throughput_mode
  @throughput_mode
end

Class Method Details

.jsii_properties ⇒ Object

# File 'sagemaker/cfn_feature_group.rb', line 1055

def self.jsii_properties
  {
    :throughput_mode => "throughputMode",
    :provisioned_read_capacity_units => "provisionedReadCapacityUnits",
    :provisioned_write_capacity_units => "provisionedWriteCapacityUnits",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'sagemaker/cfn_feature_group.rb', line 1063

def to_jsii
  result = {}
  result.merge!({
    "throughputMode" => @throughput_mode,
    "provisionedReadCapacityUnits" => @provisioned_read_capacity_units,
    "provisionedWriteCapacityUnits" => @provisioned_write_capacity_units,
  })
  result.compact
end