Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DomainStatus

The current status of the search domain.

Hierarchy

  • DomainStatus

Index

Properties

Optional ARN

ARN: undefined | string

The Amazon Resource Name (ARN) of the search domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

Optional Created

Created: undefined | false | true

True if the search domain is created. It can take several minutes to initialize a domain when CreateDomain is called. Newly created search domains are returned from DescribeDomains with a false value for Created until domain creation is complete.

Optional Deleted

Deleted: undefined | false | true

True if the search domain has been deleted. The system must clean up resources dedicated to the search domain when DeleteDomain is called. Newly deleted search domains are returned from DescribeDomains with a true value for IsDeleted for several minutes until resource cleanup is complete.

Optional DocService

DocService: ServiceEndpoint

The service endpoint for updating documents in a search domain.

DomainId

DomainId: string | undefined

An internally generated unique identifier for a domain.

DomainName

DomainName: string | undefined

A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

Optional Limits

Limits: Limits

Optional Processing

Processing: undefined | false | true

True if processing is being done to activate the current domain configuration.

RequiresIndexDocuments

RequiresIndexDocuments: boolean | undefined

True if IndexDocuments needs to be called to activate the current domain configuration.

Optional SearchInstanceCount

SearchInstanceCount: undefined | number

The number of search instances that are available to process search requests.

Optional SearchInstanceType

SearchInstanceType: undefined | string

The instance type that is being used to process search requests.

Optional SearchPartitionCount

SearchPartitionCount: undefined | number

The number of partitions across which the search index is spread.

Optional SearchService

SearchService: ServiceEndpoint

The service endpoint for requesting search results from a search domain.