Synopsis
Calls the Amazon CloudSearch DefineIndexField API operation.
Syntax
Set-CSIndexField-DomainName <String>-TextArrayOptions_AnalysisScheme <String>-TextOptions_AnalysisScheme <String>-DateArrayOptions_DefaultValue <String>-DateOptions_DefaultValue <String>-DoubleArrayOptions_DefaultValue <Double>-DoubleOptions_DefaultValue <Double>-IntArrayOptions_DefaultValue <Int64>-IntOptions_DefaultValue <Int64>-LatLonOptions_DefaultValue <String>-LiteralArrayOptions_DefaultValue <String>-LiteralOptions_DefaultValue <String>-TextArrayOptions_DefaultValue <String>-TextOptions_DefaultValue <String>-DateArrayOptions_FacetEnabled <Boolean>-DateOptions_FacetEnabled <Boolean>-DoubleArrayOptions_FacetEnabled <Boolean>-DoubleOptions_FacetEnabled <Boolean>-IntArrayOptions_FacetEnabled <Boolean>-IntOptions_FacetEnabled <Boolean>-LatLonOptions_FacetEnabled <Boolean>-LiteralArrayOptions_FacetEnabled <Boolean>-LiteralOptions_FacetEnabled <Boolean>-TextArrayOptions_HighlightEnabled <Boolean>-TextOptions_HighlightEnabled <Boolean>-IndexField_IndexFieldName <String>-IndexField_IndexFieldType <IndexFieldType>-DateArrayOptions_ReturnEnabled <Boolean>-DateOptions_ReturnEnabled <Boolean>-DoubleArrayOptions_ReturnEnabled <Boolean>-DoubleOptions_ReturnEnabled <Boolean>-IntArrayOptions_ReturnEnabled <Boolean>-IntOptions_ReturnEnabled <Boolean>-LatLonOptions_ReturnEnabled <Boolean>-LiteralArrayOptions_ReturnEnabled <Boolean>-LiteralOptions_ReturnEnabled <Boolean>-TextArrayOptions_ReturnEnabled <Boolean>-TextOptions_ReturnEnabled <Boolean>-DateArrayOptions_SearchEnabled <Boolean>-DateOptions_SearchEnabled <Boolean>-DoubleArrayOptions_SearchEnabled <Boolean>-DoubleOptions_SearchEnabled <Boolean>-IntArrayOptions_SearchEnabled <Boolean>-IntOptions_SearchEnabled <Boolean>-LatLonOptions_SearchEnabled <Boolean>-LiteralArrayOptions_SearchEnabled <Boolean>-LiteralOptions_SearchEnabled <Boolean>-DateOptions_SortEnabled <Boolean>-DoubleOptions_SortEnabled <Boolean>-IntOptions_SortEnabled <Boolean>-LatLonOptions_SortEnabled <Boolean>-LiteralOptions_SortEnabled <Boolean>-TextOptions_SortEnabled <Boolean>-DateOptions_SourceField <String>-DoubleOptions_SourceField <String>-IntOptions_SourceField <String>-LatLonOptions_SourceField <String>-LiteralOptions_SourceField <String>-TextOptions_SourceField <String>-DateArrayOptions_SourceField <String>-DoubleArrayOptions_SourceField <String>-IntArrayOptions_SourceField <String>-LiteralArrayOptions_SourceField <String>-TextArrayOptions_SourceField <String>-Force <SwitchParameter>
Description
Configures an
IndexField for the search domain. Used to create new fields and modify existing ones. You must specify the name of the domain you are configuring and an index field configuration. The index field configuration specifies a unique name, the index field type, and the options you want to configure for the field. The options you can specify depend on the IndexFieldType. If the field exists, the new configuration replaces the old one. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide. Parameters
-DateArrayOptions_DefaultValue <String>
A value to use for the field if the field isn't specified for a document.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_DateArrayOptions_DefaultValue |
-DateArrayOptions_FacetEnabled <Boolean>
Whether facet information can be returned for the field.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_DateArrayOptions_FacetEnabled |
-DateArrayOptions_ReturnEnabled <Boolean>
Whether the contents of the field can be returned in the search results.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_DateArrayOptions_ReturnEnabled |
-DateArrayOptions_SearchEnabled <Boolean>
Whether the contents of the field are searchable.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_DateArrayOptions_SearchEnabled |
-DateArrayOptions_SourceField <String>
A list of source fields to map to the field.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_DateArrayOptions_SourceFields |
-DateOptions_DefaultValue <String>
A value to use for the field if the field isn't specified for a document.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_DateOptions_DefaultValue |
-DateOptions_FacetEnabled <Boolean>
Whether facet information can be returned for the field.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_DateOptions_FacetEnabled |
-DateOptions_ReturnEnabled <Boolean>
Whether the contents of the field can be returned in the search results.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_DateOptions_ReturnEnabled |
-DateOptions_SearchEnabled <Boolean>
Whether the contents of the field are searchable.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_DateOptions_SearchEnabled |
-DateOptions_SortEnabled <Boolean>
Whether the field can be used to sort the search results.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_DateOptions_SortEnabled |
-DateOptions_SourceField <String>
The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_DateOptions_SourceField |
-DomainName <String>
The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
| Required? | False |
| Position? | 1 |
| Accept pipeline input? | True (ByValue, ByPropertyName) |
-DoubleArrayOptions_DefaultValue <Double>
A value to use for the field if the field isn't specified for a document.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_DoubleArrayOptions_DefaultValue |
-DoubleArrayOptions_FacetEnabled <Boolean>
Whether facet information can be returned for the field.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_DoubleArrayOptions_FacetEnabled |
-DoubleArrayOptions_ReturnEnabled <Boolean>
Whether the contents of the field can be returned in the search results.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_DoubleArrayOptions_ReturnEnabled |
-DoubleArrayOptions_SearchEnabled <Boolean>
Whether the contents of the field are searchable.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_DoubleArrayOptions_SearchEnabled |
-DoubleArrayOptions_SourceField <String>
A list of source fields to map to the field.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_DoubleArrayOptions_SourceFields |
-DoubleOptions_DefaultValue <Double>
A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_DoubleOptions_DefaultValue |
-DoubleOptions_FacetEnabled <Boolean>
Whether facet information can be returned for the field.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_DoubleOptions_FacetEnabled |
-DoubleOptions_ReturnEnabled <Boolean>
Whether the contents of the field can be returned in the search results.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_DoubleOptions_ReturnEnabled |
-DoubleOptions_SearchEnabled <Boolean>
Whether the contents of the field are searchable.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_DoubleOptions_SearchEnabled |
-DoubleOptions_SortEnabled <Boolean>
Whether the field can be used to sort the search results.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_DoubleOptions_SortEnabled |
-DoubleOptions_SourceField <String>
The name of the source field to map to the field.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_DoubleOptions_SourceField |
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-IndexField_IndexFieldName <String>
A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options. Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported. The name
score is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-IndexField_IndexFieldType <IndexFieldType>
The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-IntArrayOptions_DefaultValue <Int64>
A value to use for the field if the field isn't specified for a document.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_IntArrayOptions_DefaultValue |
-IntArrayOptions_FacetEnabled <Boolean>
Whether facet information can be returned for the field.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_IntArrayOptions_FacetEnabled |
-IntArrayOptions_ReturnEnabled <Boolean>
Whether the contents of the field can be returned in the search results.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_IntArrayOptions_ReturnEnabled |
-IntArrayOptions_SearchEnabled <Boolean>
Whether the contents of the field are searchable.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_IntArrayOptions_SearchEnabled |
-IntArrayOptions_SourceField <String>
A list of source fields to map to the field.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_IntArrayOptions_SourceFields |
-IntOptions_DefaultValue <Int64>
A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_IntOptions_DefaultValue |
-IntOptions_FacetEnabled <Boolean>
Whether facet information can be returned for the field.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_IntOptions_FacetEnabled |
-IntOptions_ReturnEnabled <Boolean>
Whether the contents of the field can be returned in the search results.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_IntOptions_ReturnEnabled |
-IntOptions_SearchEnabled <Boolean>
Whether the contents of the field are searchable.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_IntOptions_SearchEnabled |
-IntOptions_SortEnabled <Boolean>
Whether the field can be used to sort the search results.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_IntOptions_SortEnabled |
-IntOptions_SourceField <String>
The name of the source field to map to the field.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_IntOptions_SourceField |
-LatLonOptions_DefaultValue <String>
A value to use for the field if the field isn't specified for a document.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_LatLonOptions_DefaultValue |
-LatLonOptions_FacetEnabled <Boolean>
Whether facet information can be returned for the field.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_LatLonOptions_FacetEnabled |
-LatLonOptions_ReturnEnabled <Boolean>
Whether the contents of the field can be returned in the search results.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_LatLonOptions_ReturnEnabled |
-LatLonOptions_SearchEnabled <Boolean>
Whether the contents of the field are searchable.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_LatLonOptions_SearchEnabled |
-LatLonOptions_SortEnabled <Boolean>
Whether the field can be used to sort the search results.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_LatLonOptions_SortEnabled |
-LatLonOptions_SourceField <String>
The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_LatLonOptions_SourceField |
-LiteralArrayOptions_DefaultValue <String>
A value to use for the field if the field isn't specified for a document.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_LiteralArrayOptions_DefaultValue |
-LiteralArrayOptions_FacetEnabled <Boolean>
Whether facet information can be returned for the field.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_LiteralArrayOptions_FacetEnabled |
-LiteralArrayOptions_ReturnEnabled <Boolean>
Whether the contents of the field can be returned in the search results.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_LiteralArrayOptions_ReturnEnabled |
-LiteralArrayOptions_SearchEnabled <Boolean>
Whether the contents of the field are searchable.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_LiteralArrayOptions_SearchEnabled |
-LiteralArrayOptions_SourceField <String>
A list of source fields to map to the field.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_LiteralArrayOptions_SourceFields |
-LiteralOptions_DefaultValue <String>
A value to use for the field if the field isn't specified for a document.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_LiteralOptions_DefaultValue |
-LiteralOptions_FacetEnabled <Boolean>
Whether facet information can be returned for the field.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_LiteralOptions_FacetEnabled |
-LiteralOptions_ReturnEnabled <Boolean>
Whether the contents of the field can be returned in the search results.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_LiteralOptions_ReturnEnabled |
-LiteralOptions_SearchEnabled <Boolean>
Whether the contents of the field are searchable.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_LiteralOptions_SearchEnabled |
-LiteralOptions_SortEnabled <Boolean>
Whether the field can be used to sort the search results.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_LiteralOptions_SortEnabled |
-LiteralOptions_SourceField <String>
The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_LiteralOptions_SourceField |
-TextArrayOptions_AnalysisScheme <String>
The name of an analysis scheme for a
text-array field. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_TextArrayOptions_AnalysisScheme |
-TextArrayOptions_DefaultValue <String>
A value to use for the field if the field isn't specified for a document.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_TextArrayOptions_DefaultValue |
-TextArrayOptions_HighlightEnabled <Boolean>
Whether highlights can be returned for the field.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_TextArrayOptions_HighlightEnabled |
-TextArrayOptions_ReturnEnabled <Boolean>
Whether the contents of the field can be returned in the search results.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_TextArrayOptions_ReturnEnabled |
-TextArrayOptions_SourceField <String>
A list of source fields to map to the field.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_TextArrayOptions_SourceFields |
-TextOptions_AnalysisScheme <String>
The name of an analysis scheme for a
text field. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_TextOptions_AnalysisScheme |
-TextOptions_DefaultValue <String>
A value to use for the field if the field isn't specified for a document.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_TextOptions_DefaultValue |
-TextOptions_HighlightEnabled <Boolean>
Whether highlights can be returned for the field.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_TextOptions_HighlightEnabled |
-TextOptions_ReturnEnabled <Boolean>
Whether the contents of the field can be returned in the search results.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_TextOptions_ReturnEnabled |
-TextOptions_SortEnabled <Boolean>
Whether the field can be used to sort the search results.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_TextOptions_SortEnabled |
-TextOptions_SourceField <String>
The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | IndexField_TextOptions_SourceField |
Common Credential and Region Parameters
-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key
if the corresponding session token is supplied to the -SessionToken parameter.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information,
and optionally a token for session-based credentials.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)
If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.
If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.
As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing
credential information. The profile is expected to be found in the secure credential
file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also
specify the name of a profile stored in the .ini-format credential file used with
the AWS CLI and other AWS SDKs.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile.
Contains the network credentials to be supplied during authentication with the
configured identity provider's endpoint. This parameter is not required if the
user's default network identity can or should be used during authentication.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key
if the corresponding session token is supplied to the -SessionToken parameter.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-SessionToken <String>
The session token if the access and secret keys are temporary session-based
credentials.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-EndpointUrl <String>
The endpoint to make the call against.
Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
Inputs
You can pipe a String object to this cmdlet for the DomainName parameter.
Outputs
This cmdlet returns a IndexFieldStatus object.
The service call response (type Amazon.CloudSearch.Model.DefineIndexFieldResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
Related Links
Supported Version
AWS Tools for PowerShell: 2.x.y.z
