| « PreviousNext » | |
   | Did this page help you? Yes | No | Tell us about it... |
Creating an Amazon CloudSearch Domain
A search domain encapsulates your data, metadata, and index configuration options such as text processing options and ranking options. Each domain is searched separately. If you have multiple collections of data that you want to make searchable, you can create a separate search domain for each collection. When you create a new search domain, you must also configure access policies, configure indexing options, and upload documents before you can start submitting search requests.
When you create a search domain, you must give it a unique name. Domain names must start with a letter or number and be at least 3 and no more than 28 characters long. The allowed characters are: a-z, 0-9, and hyphen (-). Upper case letters, underscores (_), and other special characters are not allowed in domain names.
You can choose the AWS region where you want to create your search domain. Typically, you should choose the region closest to your operations. For example, if you reside in Europe, create your search domain in the EU (Ireland) Region (eu-west-1). For a current list of supported regions and endpoints, see Regions and Endpoints. For more information about choosing a region, see Regions and Endpoints for Amazon CloudSearch.
Note
Amazon CloudSearch domains in different regions are entirely independent. For example, if you create a search domain called my-domain in us-east-1, and another domain called my-domain in eu-west-1, they are completely independent and do not share any data.
Each domain has unique endpoints through which you upload data for indexing and submit search requests. For example, the endpoints for a domain called imdb-movies might be:
search-imdb-movies-rr2f34ofg56xneuemujamut52i.us-east-1.cloudsearch.amazonaws.com doc-imdb-movies-rr2f34ofg56xneuemujamut52i.us-east-1.cloudsearch.amazonaws.com
Important
By default, access to a new domain's document and search endpoints is blocked for all IP addresses. You must configure access policies for the domain to be able to submit search requests to the domain's search endpoint and upload data from the command line or through the domain's document endpoint. You can upload documents and search the domain through the Amazon CloudSearch console without configuring access policies.
You can create a search domain using the cs-create-domain command, from the Amazon CloudSearch console, or using the CreateDomain configuration action.
Command Line Tools
You use the cs-create-domain command to create search domains. For information about installing and setting up the Amazon CloudSearch command line tools, see Amazon CloudSearch Command Line Tool Reference.
To create a domain
Run the
cs-create-domaincommand and specify the name of the domain you want to create with the--domain-nameoption. For example, to create a domain called movies:cs-create-domain --domain-name movies =========================================== Creating domain [movies] Domain endpoints are currently being created. Use cs-describe-domain to check for endpoints.
It can take around half an hour to create endpoints for a new domain. By default, the cs-create-domain command returns immediately. If you specify the --wait option, the cs-create-domain command returns once your domain's endpoints are active.
You can use the cs-describe-domain command to view a summary of the domain's status and configuration. For more information, see Getting Information about an Amazon CloudSearch Domain.
AWS Management Console
The Amazon CloudSearch console enables you to easily create new search domains and provides a variety of options for configuring indexing options, including Cloning an Existing Domain's Indexing Options.
To create a domain
Go to the Amazon CloudSearch console at https://console.aws.amazon.com/cloudsearch/home.
At the top of the Navigation panel, click Create a New Domain. (If you are creating a domain for the first time, click Create Your First Search Domain on the Welcome page.)
On the NAME YOUR DOMAIN step, enter a name for your new domain and click Continue. Domain names must start with a letter or number and be at least 3 and no more than 28 characters long. Domain names can contain the following characters: a-z (lower case), 0-9, and - (hyphen). Upper case letters, underscores (_), and other special characters are not allowed in domain names.
On the CONFIGURE INDEX step, select Manual Configuration and click Continue. You can configure index fields and access policies when you first create the domain, or simply create a domain and configure it later. For more information about using the Amazon CloudSearch console to configure the domain, see Configuring Index Fields for an Amazon CloudSearch Domain and Configuring Access for an Amazon CloudSearch Domain.
On the REVIEW INDEX CONFIGURATION step, click Continue to configure the index fields later. For more information about configuring index fields, see Configuring Index Fields for an Amazon CloudSearch Domain.
On the SET UP ACCESS POLICIES step, click Continue to set up access policies later. For more information about configuring access policies, see Configuring Access for an Amazon CloudSearch Domain.
Note
If you don't configure access policies, you will only be able to upload documents and submit search queries through the console. By default, the Document and Search endpoints are configured to block all IP addresses.
On the CONFIRM step, review the domain configuration and click Confirm to create your domain.
Once the domain has been created, click OK to exit the Create New Search Domain wizard and go to the domain's dashboard.
API
You use the CreateDomain configuration action to create new domains. For example:
https://cloudsearch.us-east-1.amazonaws.com?Action=CreateDomain &DomainName=movies &Version=2011-02-01 &X-Amz-Algorithm=AWS4-HMAC-SHA256 &X-Amz-Credential=AKIAIOSFODNN7EXAMPLE/20120328/us-east-1/cloudsearch/aws4_request &X-Amz-Date=2012-03-28T21:54:28.711Z &X-Amz-SignedHeaders=host &X-Amz-Signature=f5f82e71838707de1f72bfc42cc021e0324e1befa5df7c39c2ac25c61b3c8dcb
Note
Amazon CloudSearch configuration requests are authenticated using your AWS credentials. For more information about signing requests, see Request Authentication.
