Package software.amazon.awssdk.services.sagemaker.model

Interface CreateFeatureGroupRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateFeatureGroupRequest.Builder,CreateFeatureGroupRequest>, SageMakerRequest.Builder, SdkBuilder<CreateFeatureGroupRequest.Builder,CreateFeatureGroupRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateFeatureGroupRequest
public static interface CreateFeatureGroupRequest.Builder extends SageMakerRequest.Builder, SdkPojo, CopyableBuilder<CreateFeatureGroupRequest.Builder,CreateFeatureGroupRequest>

  • Method Details

    • featureGroupName

      CreateFeatureGroupRequest.Builder featureGroupName(String featureGroupName)

      The name of the FeatureGroup. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.

      The name:

      • Must start with an alphanumeric character.

      • Can only include alphanumeric characters, underscores, and hyphens. Spaces are not allowed.

      Parameters:
      featureGroupName - The name of the FeatureGroup. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.

      The name:

      • Must start with an alphanumeric character.

      • Can only include alphanumeric characters, underscores, and hyphens. Spaces are not allowed.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • recordIdentifierFeatureName

      CreateFeatureGroupRequest.Builder recordIdentifierFeatureName(String recordIdentifierFeatureName)

      The name of the Feature whose value uniquely identifies a Record defined in the FeatureStore. Only the latest record per identifier value will be stored in the OnlineStore. RecordIdentifierFeatureName must be one of feature definitions' names.

      You use the RecordIdentifierFeatureName to access data in a FeatureStore.

      This name:

      • Must start with an alphanumeric character.

      • Can only contains alphanumeric characters, hyphens, underscores. Spaces are not allowed.

      Parameters:
      recordIdentifierFeatureName - The name of the Feature whose value uniquely identifies a Record defined in the FeatureStore. Only the latest record per identifier value will be stored in the OnlineStore. RecordIdentifierFeatureName must be one of feature definitions' names.

      You use the RecordIdentifierFeatureName to access data in a FeatureStore.

      This name:

      • Must start with an alphanumeric character.

      • Can only contains alphanumeric characters, hyphens, underscores. Spaces are not allowed.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • eventTimeFeatureName

      CreateFeatureGroupRequest.Builder eventTimeFeatureName(String eventTimeFeatureName)

      The name of the feature that stores the EventTime of a Record in a FeatureGroup.

      An EventTime is a point in time when a new event occurs that corresponds to the creation or update of a Record in a FeatureGroup. All Records in the FeatureGroup must have a corresponding EventTime.

      An EventTime can be a String or Fractional.

      • Fractional: EventTime feature values must be a Unix timestamp in seconds.

      • String: EventTime feature values must be an ISO-8601 string in the format. The following formats are supported yyyy-MM-dd'T'HH:mm:ssZ and yyyy-MM-dd'T'HH:mm:ss.SSSZ where yyyy, MM, and dd represent the year, month, and day respectively and HH, mm, ss, and if applicable, SSS represent the hour, month, second and milliseconds respsectively. 'T' and Z are constants.

      Parameters:
      eventTimeFeatureName - The name of the feature that stores the EventTime of a Record in a FeatureGroup.

      An EventTime is a point in time when a new event occurs that corresponds to the creation or update of a Record in a FeatureGroup. All Records in the FeatureGroup must have a corresponding EventTime.

      An EventTime can be a String or Fractional.

      • Fractional: EventTime feature values must be a Unix timestamp in seconds.

      • String: EventTime feature values must be an ISO-8601 string in the format. The following formats are supported yyyy-MM-dd'T'HH:mm:ssZ and yyyy-MM-dd'T'HH:mm:ss.SSSZ where yyyy, MM, and dd represent the year, month, and day respectively and HH, mm, ss, and if applicable, SSS represent the hour, month, second and milliseconds respsectively. 'T' and Z are constants.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • featureDefinitions

      CreateFeatureGroupRequest.Builder featureDefinitions(Collection<FeatureDefinition> featureDefinitions)

      A list of Feature names and types. Name and Type is compulsory per Feature.

      Valid feature FeatureTypes are Integral, Fractional and String.

      FeatureNames cannot be any of the following: is_deleted, write_time, api_invocation_time

      You can create up to 2,500 FeatureDefinitions per FeatureGroup.

      Parameters:
      featureDefinitions - A list of Feature names and types. Name and Type is compulsory per Feature.

      Valid feature FeatureTypes are Integral, Fractional and String.

      FeatureNames cannot be any of the following: is_deleted, write_time, api_invocation_time

      You can create up to 2,500 FeatureDefinitions per FeatureGroup.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • featureDefinitions

      CreateFeatureGroupRequest.Builder featureDefinitions(FeatureDefinition... featureDefinitions)

      A list of Feature names and types. Name and Type is compulsory per Feature.

      Valid feature FeatureTypes are Integral, Fractional and String.

      FeatureNames cannot be any of the following: is_deleted, write_time, api_invocation_time

      You can create up to 2,500 FeatureDefinitions per FeatureGroup.

      Parameters:
      featureDefinitions - A list of Feature names and types. Name and Type is compulsory per Feature.

      Valid feature FeatureTypes are Integral, Fractional and String.

      FeatureNames cannot be any of the following: is_deleted, write_time, api_invocation_time

      You can create up to 2,500 FeatureDefinitions per FeatureGroup.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • featureDefinitions

      CreateFeatureGroupRequest.Builder featureDefinitions(Consumer<FeatureDefinition.Builder>... featureDefinitions)

      A list of Feature names and types. Name and Type is compulsory per Feature.

      Valid feature FeatureTypes are Integral, Fractional and String.

      FeatureNames cannot be any of the following: is_deleted, write_time, api_invocation_time

      You can create up to 2,500 FeatureDefinitions per FeatureGroup.

      This is a convenience method that creates an instance of the FeatureDefinition.Builder avoiding the need to create one manually via FeatureDefinition.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to featureDefinitions(List<FeatureDefinition>).

      Parameters:
      featureDefinitions - a consumer that will call methods on FeatureDefinition.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • onlineStoreConfig

      CreateFeatureGroupRequest.Builder onlineStoreConfig(OnlineStoreConfig onlineStoreConfig)

      You can turn the OnlineStore on or off by specifying True for the EnableOnlineStore flag in OnlineStoreConfig.

      You can also include an Amazon Web Services KMS key ID (KMSKeyId) for at-rest encryption of the OnlineStore.

      The default value is False.

      Parameters:
      onlineStoreConfig - You can turn the OnlineStore on or off by specifying True for the EnableOnlineStore flag in OnlineStoreConfig.

      You can also include an Amazon Web Services KMS key ID (KMSKeyId) for at-rest encryption of the OnlineStore.

      The default value is False.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • onlineStoreConfig

      default CreateFeatureGroupRequest.Builder onlineStoreConfig(Consumer<OnlineStoreConfig.Builder> onlineStoreConfig)

      You can turn the OnlineStore on or off by specifying True for the EnableOnlineStore flag in OnlineStoreConfig.

      You can also include an Amazon Web Services KMS key ID (KMSKeyId) for at-rest encryption of the OnlineStore.

      The default value is False.

      This is a convenience method that creates an instance of the OnlineStoreConfig.Builder avoiding the need to create one manually via OnlineStoreConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to onlineStoreConfig(OnlineStoreConfig).

      Parameters:
      onlineStoreConfig - a consumer that will call methods on OnlineStoreConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • offlineStoreConfig

      CreateFeatureGroupRequest.Builder offlineStoreConfig(OfflineStoreConfig offlineStoreConfig)

      Use this to configure an OfflineFeatureStore. This parameter allows you to specify:

      • The Amazon Simple Storage Service (Amazon S3) location of an OfflineStore.

      • A configuration for an Amazon Web Services Glue or Amazon Web Services Hive data catalog.

      • An KMS encryption key to encrypt the Amazon S3 location used for OfflineStore. If KMS encryption key is not specified, by default we encrypt all data at rest using Amazon Web Services KMS key. By defining your bucket-level key for SSE, you can reduce Amazon Web Services KMS requests costs by up to 99 percent.

      • Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg.

      To learn more about this parameter, see OfflineStoreConfig.

      Parameters:
      offlineStoreConfig - Use this to configure an OfflineFeatureStore. This parameter allows you to specify:

      • The Amazon Simple Storage Service (Amazon S3) location of an OfflineStore.

      • A configuration for an Amazon Web Services Glue or Amazon Web Services Hive data catalog.

      • An KMS encryption key to encrypt the Amazon S3 location used for OfflineStore. If KMS encryption key is not specified, by default we encrypt all data at rest using Amazon Web Services KMS key. By defining your bucket-level key for SSE, you can reduce Amazon Web Services KMS requests costs by up to 99 percent.

      • Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg.

      To learn more about this parameter, see OfflineStoreConfig.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • offlineStoreConfig

      default CreateFeatureGroupRequest.Builder offlineStoreConfig(Consumer<OfflineStoreConfig.Builder> offlineStoreConfig)

      Use this to configure an OfflineFeatureStore. This parameter allows you to specify:

      • The Amazon Simple Storage Service (Amazon S3) location of an OfflineStore.

      • A configuration for an Amazon Web Services Glue or Amazon Web Services Hive data catalog.

      • An KMS encryption key to encrypt the Amazon S3 location used for OfflineStore. If KMS encryption key is not specified, by default we encrypt all data at rest using Amazon Web Services KMS key. By defining your bucket-level key for SSE, you can reduce Amazon Web Services KMS requests costs by up to 99 percent.

      • Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg.

      To learn more about this parameter, see OfflineStoreConfig.

      This is a convenience method that creates an instance of the OfflineStoreConfig.Builder avoiding the need to create one manually via OfflineStoreConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to offlineStoreConfig(OfflineStoreConfig).

      Parameters:
      offlineStoreConfig - a consumer that will call methods on OfflineStoreConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • throughputConfig

      CreateFeatureGroupRequest.Builder throughputConfig(ThroughputConfig throughputConfig)
      Sets the value of the ThroughputConfig property for this object.
      Parameters:
      throughputConfig - The new value for the ThroughputConfig property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • throughputConfig

      default CreateFeatureGroupRequest.Builder throughputConfig(Consumer<ThroughputConfig.Builder> throughputConfig)
      Sets the value of the ThroughputConfig property for this object. This is a convenience method that creates an instance of the ThroughputConfig.Builder avoiding the need to create one manually via ThroughputConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to throughputConfig(ThroughputConfig).

      Parameters:
      throughputConfig - a consumer that will call methods on ThroughputConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • roleArn

      CreateFeatureGroupRequest.Builder roleArn(String roleArn)

      The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the OfflineStore if an OfflineStoreConfig is provided.

      Parameters:
      roleArn - The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the OfflineStore if an OfflineStoreConfig is provided.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      CreateFeatureGroupRequest.Builder description(String description)

      A free-form description of a FeatureGroup.

      Parameters:
      description - A free-form description of a FeatureGroup.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateFeatureGroupRequest.Builder tags(Collection<Tag> tags)

      Tags used to identify Features in each FeatureGroup.

      Parameters:
      tags - Tags used to identify Features in each FeatureGroup.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateFeatureGroupRequest.Builder tags(Tag... tags)

      Tags used to identify Features in each FeatureGroup.

      Parameters:
      tags - Tags used to identify Features in each FeatureGroup.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateFeatureGroupRequest.Builder tags(Consumer<Tag.Builder>... tags)

      Tags used to identify Features in each FeatureGroup.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      CreateFeatureGroupRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateFeatureGroupRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.