You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CloudSearch::Types::DomainStatus

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

The current status of the search domain.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ 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.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) of the search domain.

#created ⇒ Boolean

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.

Returns:

  • (Boolean) —

    True if the search domain is created.

#deleted ⇒ Boolean

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.

Returns:

  • (Boolean) —

    True if the search domain has been deleted.

#doc_service ⇒ Types::ServiceEndpoint

The service endpoint for updating documents in a search domain.

Returns:

#domain_id ⇒ String

An internally generated unique identifier for a domain.

Returns:

  • (String) —

    An internally generated unique identifier for a domain.

    .

#domain_name ⇒ String

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).

Returns:

  • (String) —

    A string that represents the name of a domain.

#limits ⇒ Types::Limits

Returns:

#processing ⇒ Boolean

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

Returns:

  • (Boolean) —

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

#requires_index_documents ⇒ Boolean

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

Returns:

  • (Boolean) —

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

#search_instance_count ⇒ Integer

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

Returns:

  • (Integer) —

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

#search_instance_type ⇒ String

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

Returns:

  • (String) —

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

#search_partition_count ⇒ Integer

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

Returns:

  • (Integer) —

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

#search_service ⇒ Types::ServiceEndpoint

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

Returns: