Package software.amazon.awscdk.cfnpropertymixins.services.sagemaker

Class CfnFeatureGroupMixinProps.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.sagemaker.CfnFeatureGroupMixinProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnFeatureGroupMixinProps>

Enclosing interface:

CfnFeatureGroupMixinProps

@Stability(Stable)
public static final class CfnFeatureGroupMixinProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnFeatureGroupMixinProps>

A builder for CfnFeatureGroupMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnFeatureGroupMixinProps	build()	Builds the configured instance.
CfnFeatureGroupMixinProps.Builder	description(String description)	Sets the value of CfnFeatureGroupMixinProps.getDescription()
CfnFeatureGroupMixinProps.Builder	eventTimeFeatureName(String eventTimeFeatureName)	Sets the value of CfnFeatureGroupMixinProps.getEventTimeFeatureName()
CfnFeatureGroupMixinProps.Builder	featureDefinitions(List<? extends Object> featureDefinitions)	Sets the value of CfnFeatureGroupMixinProps.getFeatureDefinitions()
CfnFeatureGroupMixinProps.Builder	featureDefinitions(IResolvable featureDefinitions)	Sets the value of CfnFeatureGroupMixinProps.getFeatureDefinitions()
CfnFeatureGroupMixinProps.Builder	featureGroupName(String featureGroupName)	Sets the value of CfnFeatureGroupMixinProps.getFeatureGroupName()
CfnFeatureGroupMixinProps.Builder	offlineStoreConfig(Object offlineStoreConfig)	Sets the value of CfnFeatureGroupMixinProps.getOfflineStoreConfig()
CfnFeatureGroupMixinProps.Builder	onlineStoreConfig(Object onlineStoreConfig)	Sets the value of CfnFeatureGroupMixinProps.getOnlineStoreConfig()
CfnFeatureGroupMixinProps.Builder	recordIdentifierFeatureName(String recordIdentifierFeatureName)	Sets the value of CfnFeatureGroupMixinProps.getRecordIdentifierFeatureName()
CfnFeatureGroupMixinProps.Builder	roleArn(String roleArn)	Sets the value of CfnFeatureGroupMixinProps.getRoleArn()
CfnFeatureGroupMixinProps.Builder	roleArn(IRoleRef roleArn)	Sets the value of CfnFeatureGroupMixinProps.getRoleArn()
CfnFeatureGroupMixinProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnFeatureGroupMixinProps.getTags()
CfnFeatureGroupMixinProps.Builder	throughputConfig(CfnFeatureGroupPropsMixin.ThroughputConfigProperty throughputConfig)	Sets the value of CfnFeatureGroupMixinProps.getThroughputConfig()
CfnFeatureGroupMixinProps.Builder	throughputConfig(IResolvable throughputConfig)	Sets the value of CfnFeatureGroupMixinProps.getThroughputConfig()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

description

@Stability(Stable)
public CfnFeatureGroupMixinProps.Builder description(String description)

Sets the value of CfnFeatureGroupMixinProps.getDescription()

Parameters:

description - A free form description of a FeatureGroup .

Returns:

this

eventTimeFeatureName

@Stability(Stable)
public CfnFeatureGroupMixinProps.Builder eventTimeFeatureName(String eventTimeFeatureName)

Sets the value of CfnFeatureGroupMixinProps.getEventTimeFeatureName()

Parameters:

eventTimeFeatureName - The name of the feature that stores the EventTime of a Record in a FeatureGroup . A EventTime is point in time when a new event occurs that corresponds to the creation or update of a Record in FeatureGroup . All Records in the FeatureGroup must have a corresponding EventTime .

Returns:

this

featureDefinitions

@Stability(Stable)
public CfnFeatureGroupMixinProps.Builder featureDefinitions(IResolvable featureDefinitions)

Sets the value of CfnFeatureGroupMixinProps.getFeatureDefinitions()

Parameters:

featureDefinitions - A list of Feature s. Each Feature must include a FeatureName and a FeatureType . Valid FeatureType s are Integral , Fractional and String .

FeatureName s cannot be any of the following: is_deleted , write_time , api_invocation_time .

You can create up to 2,500 FeatureDefinition s per FeatureGroup .

Returns:

this

featureDefinitions

@Stability(Stable)
public CfnFeatureGroupMixinProps.Builder featureDefinitions(List<? extends Object> featureDefinitions)

Sets the value of CfnFeatureGroupMixinProps.getFeatureDefinitions()

Parameters:

featureDefinitions - A list of Feature s. Each Feature must include a FeatureName and a FeatureType . Valid FeatureType s are Integral , Fractional and String .

FeatureName s cannot be any of the following: is_deleted , write_time , api_invocation_time .

You can create up to 2,500 FeatureDefinition s per FeatureGroup .

Returns:

this

featureGroupName

@Stability(Stable)
public CfnFeatureGroupMixinProps.Builder featureGroupName(String featureGroupName)

Sets the value of CfnFeatureGroupMixinProps.getFeatureGroupName()

Parameters:

featureGroupName - The name of the FeatureGroup .

Returns:

this

offlineStoreConfig

@Stability(Stable)
public CfnFeatureGroupMixinProps.Builder offlineStoreConfig(Object offlineStoreConfig)

Sets the value of CfnFeatureGroupMixinProps.getOfflineStoreConfig()

Parameters:

offlineStoreConfig - The configuration of an OfflineStore .

Returns:

this

onlineStoreConfig

@Stability(Stable)
public CfnFeatureGroupMixinProps.Builder onlineStoreConfig(Object onlineStoreConfig)

Sets the value of CfnFeatureGroupMixinProps.getOnlineStoreConfig()

Parameters:

onlineStoreConfig - The configuration of an OnlineStore .

Returns:

this

recordIdentifierFeatureName

@Stability(Stable)
public CfnFeatureGroupMixinProps.Builder recordIdentifierFeatureName(String recordIdentifierFeatureName)

Sets the value of CfnFeatureGroupMixinProps.getRecordIdentifierFeatureName()

Parameters:

recordIdentifierFeatureName - The name of the Feature whose value uniquely identifies a Record defined in the FeatureGroup FeatureDefinitions .

Returns:

this

roleArn

@Stability(Stable)
public CfnFeatureGroupMixinProps.Builder roleArn(String roleArn)

Sets the value of CfnFeatureGroupMixinProps.getRoleArn()

Parameters:

roleArn - The Amazon Resource Name (ARN) of the IAM execution role used to create the feature group.

Returns:

this

roleArn

@Stability(Stable)
public CfnFeatureGroupMixinProps.Builder roleArn(IRoleRef roleArn)

Sets the value of CfnFeatureGroupMixinProps.getRoleArn()

Parameters:

roleArn - The Amazon Resource Name (ARN) of the IAM execution role used to create the feature group.

Returns:

this

tags

@Stability(Stable)
public CfnFeatureGroupMixinProps.Builder tags(List<? extends CfnTag> tags)

Sets the value of CfnFeatureGroupMixinProps.getTags()

Parameters:

tags - Tags used to define a FeatureGroup .

Returns:

this

throughputConfig

@Stability(Stable)
public CfnFeatureGroupMixinProps.Builder throughputConfig(IResolvable throughputConfig)

Sets the value of CfnFeatureGroupMixinProps.getThroughputConfig()

Parameters:

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

Returns:

this

throughputConfig

@Stability(Stable)
public CfnFeatureGroupMixinProps.Builder throughputConfig(CfnFeatureGroupPropsMixin.ThroughputConfigProperty throughputConfig)

Sets the value of CfnFeatureGroupMixinProps.getThroughputConfig()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public CfnFeatureGroupMixinProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnFeatureGroupMixinProps>

Returns:

a new instance of CfnFeatureGroupMixinProps

Throws:

NullPointerException - if any required attribute was not provided