AWS SDK Version 2 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

.NET Framework 3.5
Defines a field in the index, including its name, type, and the source of its data. The IndexFieldType indicates which of the options will be present. It is invalid to specify options for a type other than the IndexFieldType.

Inheritance Hierarchy


Namespace: Amazon.CloudSearch_2011_02_01.Model
Assembly: AWSSDK.dll
Version: (assembly version)


public class IndexField : Object

The IndexField type exposes the following members


Public Method IndexField()


Public Property IndexFieldName System.String Gets and sets the property IndexFieldName.

The name of a field in the search index. Field names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The names "body", "docid", and "text_relevance" are reserved and cannot be specified as field or rank expression names.

Public Property IndexFieldType Amazon.CloudSearch_2011_02_01.IndexFieldType Gets and sets the property IndexFieldType.

The type of field. Based on this type, exactly one of the UIntOptions, LiteralOptions or TextOptions must be present.

Public Property LiteralOptions Amazon.CloudSearch_2011_02_01.Model.LiteralOptions Gets and sets the property LiteralOptions.

Options for literal field. Present if IndexFieldType specifies the field is of type literal.

Public Property SourceAttributes System.Collections.Generic.List<Amazon.CloudSearch_2011_02_01.Model.SourceAttribute> Gets and sets the property SourceAttributes.

An optional list of source attributes that provide data for this index field. If not specified, the data is pulled from a source attribute with the same name as this IndexField. When one or more source attributes are specified, an optional data transformation can be applied to the source data when populating the index field. You can configure a maximum of 20 sources for an IndexField.

Public Property TextOptions Amazon.CloudSearch_2011_02_01.Model.TextOptions Gets and sets the property TextOptions.

Options for text field. Present if IndexFieldType specifies the field is of type text.

Public Property UIntOptions Amazon.CloudSearch_2011_02_01.Model.UIntOptions Gets and sets the property UIntOptions.

Options for an unsigned integer field. Present if IndexFieldType specifies the field is of type unsigned integer.

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5