Package software.amazon.awscdk.services.sagemaker

Class CfnFeatureGroup.Builder

java.lang.Object

software.amazon.awscdk.services.sagemaker.CfnFeatureGroup.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnFeatureGroup>

Enclosing class:

CfnFeatureGroup

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

A fluent builder for CfnFeatureGroup.

Method Summary

Modifier and Type	Method	Description
CfnFeatureGroup	build()
static CfnFeatureGroup.Builder	create(software.constructs.Construct scope, String id)
CfnFeatureGroup.Builder	description(String description)	A free form description of a FeatureGroup .
CfnFeatureGroup.Builder	eventTimeFeatureName(String eventTimeFeatureName)	The name of the feature that stores the EventTime of a Record in a FeatureGroup .
CfnFeatureGroup.Builder	featureDefinitions(List<? extends Object> featureDefinitions)	A list of Feature s.
CfnFeatureGroup.Builder	featureDefinitions(IResolvable featureDefinitions)	A list of Feature s.
CfnFeatureGroup.Builder	featureGroupName(String featureGroupName)	The name of the FeatureGroup .
CfnFeatureGroup.Builder	offlineStoreConfig(Object offlineStoreConfig)	The configuration of an OfflineStore .
CfnFeatureGroup.Builder	onlineStoreConfig(Object onlineStoreConfig)	The configuration of an OnlineStore .
CfnFeatureGroup.Builder	recordIdentifierFeatureName(String recordIdentifierFeatureName)	The name of the Feature whose value uniquely identifies a Record defined in the FeatureGroup FeatureDefinitions .
CfnFeatureGroup.Builder	roleArn(String roleArn)	The Amazon Resource Name (ARN) of the IAM execution role used to create the feature group.
CfnFeatureGroup.Builder	roleArn(IRoleRef roleArn)	The Amazon Resource Name (ARN) of the IAM execution role used to create the feature group.
CfnFeatureGroup.Builder	tags(List<? extends CfnTag> tags)	Tags used to define a FeatureGroup .
CfnFeatureGroup.Builder	throughputConfig(IResolvable throughputConfig)	Used to set feature group throughput configuration.
CfnFeatureGroup.Builder	throughputConfig(CfnFeatureGroup.ThroughputConfigProperty throughputConfig)	Used to set feature group throughput configuration.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnFeatureGroup.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnFeatureGroup.Builder.

eventTimeFeatureName

@Stability(Stable)
public CfnFeatureGroup.Builder eventTimeFeatureName(String 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 .

Parameters:

eventTimeFeatureName - The name of the feature that stores the EventTime of a Record in a FeatureGroup . This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-featuregroup.html#cfn-sagemaker-featuregroup-eventtimefeaturename

featureDefinitions

@Stability(Stable)
public CfnFeatureGroup.Builder featureDefinitions(IResolvable 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 .

Parameters:

featureDefinitions - A list of Feature s. Each Feature must include a FeatureName and a FeatureType . This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-featuregroup.html#cfn-sagemaker-featuregroup-featuredefinitions

featureDefinitions

@Stability(Stable)
public CfnFeatureGroup.Builder featureDefinitions(List<? extends Object> 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 .

Parameters:

featureDefinitions - A list of Feature s. Each Feature must include a FeatureName and a FeatureType . This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-featuregroup.html#cfn-sagemaker-featuregroup-featuredefinitions

featureGroupName

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

The name of the FeatureGroup .

Parameters:

featureGroupName - The name of the FeatureGroup . This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-featuregroup.html#cfn-sagemaker-featuregroup-featuregroupname

recordIdentifierFeatureName

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

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

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-featuregroup.html#cfn-sagemaker-featuregroup-recordidentifierfeaturename

description

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

A free form description of a FeatureGroup .

Parameters:

description - A free form description of a FeatureGroup . This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-featuregroup.html#cfn-sagemaker-featuregroup-description

offlineStoreConfig

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

The configuration of an OfflineStore .

Parameters:

offlineStoreConfig - The configuration of an OfflineStore . This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-featuregroup.html#cfn-sagemaker-featuregroup-offlinestoreconfig

onlineStoreConfig

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

The configuration of an OnlineStore .

Parameters:

onlineStoreConfig - The configuration of an OnlineStore . This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-featuregroup.html#cfn-sagemaker-featuregroup-onlinestoreconfig

roleArn

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

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

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-featuregroup.html#cfn-sagemaker-featuregroup-rolearn

roleArn

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

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

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-featuregroup.html#cfn-sagemaker-featuregroup-rolearn

tags

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

Tags used to define a FeatureGroup .

Parameters:

tags - Tags used to define a FeatureGroup . This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-featuregroup.html#cfn-sagemaker-featuregroup-tags

throughputConfig

@Stability(Stable)
public CfnFeatureGroup.Builder throughputConfig(IResolvable 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.

Parameters:

throughputConfig - Used to set feature group throughput configuration. This parameter is required.

Returns:

this

See Also:

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

throughputConfig

@Stability(Stable)
public CfnFeatureGroup.Builder throughputConfig(CfnFeatureGroup.ThroughputConfigProperty 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.

Parameters:

throughputConfig - Used to set feature group throughput configuration. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnFeatureGroup build()

Specified by:

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

Returns:

a newly built instance of CfnFeatureGroup.