index_fields

Creates, updates, deletes, gets or lists an index_fields resource.

Overview

Name	index_fields
Type	Resource
Id	aws.cloudsearch.index_fields

Fields

The following fields are returned by SELECT queries:

describe_index_fields

Name	Datatype	Description
options	string	Configuration information for a field in the index, including its name, type, and options. The supported options depend on the IndexFieldType.
status	string	The status of domain configuration option.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_index_fields	select	DomainName, region	FieldNames, Deployed	Gets information about the index fields configured for the search domain. Can be limited to specific fields by name. By default, shows all fields and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Getting Domain Information in the Amazon CloudSearch Developer Guide.
delete_index_field	delete	DomainName, IndexFieldName, region		Removes an IndexField from the search domain. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
DomainName	string
IndexFieldName	string	The name of the index field your want to remove from the domain's indexing options.
region	string	AWS region (default: us-east-1)
Deployed	boolean	Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.
FieldNames	array	A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.

SELECT examples

describe_index_fields

Gets information about the index fields configured for the search domain. Can be limited to specific fields by name. By default, shows all fields and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Getting Domain Information in the Amazon CloudSearch Developer Guide.

SELECT
options,
status
FROM aws.cloudsearch.index_fields
WHERE DomainName = '{{ DomainName }}' -- required
AND region = '{{ region }}' -- required
AND FieldNames = '{{ FieldNames }}'
AND Deployed = '{{ Deployed }}'
;

DELETE examples

delete_index_field

Removes an IndexField from the search domain. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.

DELETE FROM aws.cloudsearch.index_fields
WHERE DomainName = '{{ DomainName }}' --required
AND IndexFieldName = '{{ IndexFieldName }}' --required
AND region = '{{ region }}' --required
;