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

Inherits:

Struct

Object
Struct
Aws::CloudSearch::Types::DomainStatus

show all

Includes:: Structure

Defined in:: lib/aws-sdk-cloudsearch/types.rb

Overview

The current status of the search domain.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#arn ⇒ String

The Amazon Resource Name (ARN) of the search domain.
#created ⇒ Boolean

True if the search domain is created.
#deleted ⇒ Boolean

True if the search domain has been deleted.
#doc_service ⇒ Types::ServiceEndpoint

The service endpoint for updating documents in a search domain.
#domain_id ⇒ String

An internally generated unique identifier for a domain.
#domain_name ⇒ String

A string that represents the name of a domain.
#limits ⇒ Types::Limits
#processing ⇒ 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.
#search_instance_count ⇒ 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.
#search_partition_count ⇒ 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.

Instance Attribute Details

#arn ⇒ `String`

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

Identifiers for IAM Entities][1: in *Using AWS Identity and Access

Management* for more information.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html

Returns:

(String)

# File 'lib/aws-sdk-cloudsearch/types.rb', line 1127

class DomainStatus < Struct.new(
  :domain_id,
  :domain_name,
  :arn,
  :created,
  :deleted,
  :doc_service,
  :search_service,
  :requires_index_documents,
  :processing,
  :search_instance_type,
  :search_partition_count,
  :search_instance_count,
  :limits)
  SENSITIVE = []
  include Aws::Structure
end

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

# File 'lib/aws-sdk-cloudsearch/types.rb', line 1127

class DomainStatus < Struct.new(
  :domain_id,
  :domain_name,
  :arn,
  :created,
  :deleted,
  :doc_service,
  :search_service,
  :requires_index_documents,
  :processing,
  :search_instance_type,
  :search_partition_count,
  :search_instance_count,
  :limits)
  SENSITIVE = []
  include Aws::Structure
end

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

# File 'lib/aws-sdk-cloudsearch/types.rb', line 1127

class DomainStatus < Struct.new(
  :domain_id,
  :domain_name,
  :arn,
  :created,
  :deleted,
  :doc_service,
  :search_service,
  :requires_index_documents,
  :processing,
  :search_instance_type,
  :search_partition_count,
  :search_instance_count,
  :limits)
  SENSITIVE = []
  include Aws::Structure
end

#doc_service ⇒ `Types::ServiceEndpoint`

The service endpoint for updating documents in a search domain.

Returns:

(Types::ServiceEndpoint)

# File 'lib/aws-sdk-cloudsearch/types.rb', line 1127

class DomainStatus < Struct.new(
  :domain_id,
  :domain_name,
  :arn,
  :created,
  :deleted,
  :doc_service,
  :search_service,
  :requires_index_documents,
  :processing,
  :search_instance_type,
  :search_partition_count,
  :search_instance_count,
  :limits)
  SENSITIVE = []
  include Aws::Structure
end

#domain_id ⇒ `String`

An internally generated unique identifier for a domain.

Returns:

(String)

# File 'lib/aws-sdk-cloudsearch/types.rb', line 1127

class DomainStatus < Struct.new(
  :domain_id,
  :domain_name,
  :arn,
  :created,
  :deleted,
  :doc_service,
  :search_service,
  :requires_index_documents,
  :processing,
  :search_instance_type,
  :search_partition_count,
  :search_instance_count,
  :limits)
  SENSITIVE = []
  include Aws::Structure
end

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

# File 'lib/aws-sdk-cloudsearch/types.rb', line 1127

class DomainStatus < Struct.new(
  :domain_id,
  :domain_name,
  :arn,
  :created,
  :deleted,
  :doc_service,
  :search_service,
  :requires_index_documents,
  :processing,
  :search_instance_type,
  :search_partition_count,
  :search_instance_count,
  :limits)
  SENSITIVE = []
  include Aws::Structure
end

#limits ⇒ `Types::Limits`

Returns:

(Types::Limits)

# File 'lib/aws-sdk-cloudsearch/types.rb', line 1127

class DomainStatus < Struct.new(
  :domain_id,
  :domain_name,
  :arn,
  :created,
  :deleted,
  :doc_service,
  :search_service,
  :requires_index_documents,
  :processing,
  :search_instance_type,
  :search_partition_count,
  :search_instance_count,
  :limits)
  SENSITIVE = []
  include Aws::Structure
end

#processing ⇒ `Boolean`

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

Returns:

(Boolean)

# File 'lib/aws-sdk-cloudsearch/types.rb', line 1127

class DomainStatus < Struct.new(
  :domain_id,
  :domain_name,
  :arn,
  :created,
  :deleted,
  :doc_service,
  :search_service,
  :requires_index_documents,
  :processing,
  :search_instance_type,
  :search_partition_count,
  :search_instance_count,
  :limits)
  SENSITIVE = []
  include Aws::Structure
end

#requires_index_documents ⇒ `Boolean`

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

Returns:

(Boolean)

# File 'lib/aws-sdk-cloudsearch/types.rb', line 1127

class DomainStatus < Struct.new(
  :domain_id,
  :domain_name,
  :arn,
  :created,
  :deleted,
  :doc_service,
  :search_service,
  :requires_index_documents,
  :processing,
  :search_instance_type,
  :search_partition_count,
  :search_instance_count,
  :limits)
  SENSITIVE = []
  include Aws::Structure
end

#search_instance_count ⇒ `Integer`

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

Returns:

(Integer)

# File 'lib/aws-sdk-cloudsearch/types.rb', line 1127

class DomainStatus < Struct.new(
  :domain_id,
  :domain_name,
  :arn,
  :created,
  :deleted,
  :doc_service,
  :search_service,
  :requires_index_documents,
  :processing,
  :search_instance_type,
  :search_partition_count,
  :search_instance_count,
  :limits)
  SENSITIVE = []
  include Aws::Structure
end

#search_instance_type ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-cloudsearch/types.rb', line 1127

class DomainStatus < Struct.new(
  :domain_id,
  :domain_name,
  :arn,
  :created,
  :deleted,
  :doc_service,
  :search_service,
  :requires_index_documents,
  :processing,
  :search_instance_type,
  :search_partition_count,
  :search_instance_count,
  :limits)
  SENSITIVE = []
  include Aws::Structure
end

#search_partition_count ⇒ `Integer`

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

Returns:

(Integer)

# File 'lib/aws-sdk-cloudsearch/types.rb', line 1127

class DomainStatus < Struct.new(
  :domain_id,
  :domain_name,
  :arn,
  :created,
  :deleted,
  :doc_service,
  :search_service,
  :requires_index_documents,
  :processing,
  :search_instance_type,
  :search_partition_count,
  :search_instance_count,
  :limits)
  SENSITIVE = []
  include Aws::Structure
end

#search_service ⇒ `Types::ServiceEndpoint`

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

Returns:

(Types::ServiceEndpoint)

# File 'lib/aws-sdk-cloudsearch/types.rb', line 1127

class DomainStatus < Struct.new(
  :domain_id,
  :domain_name,
  :arn,
  :created,
  :deleted,
  :doc_service,
  :search_service,
  :requires_index_documents,
  :processing,
  :search_instance_type,
  :search_partition_count,
  :search_instance_count,
  :limits)
  SENSITIVE = []
  include Aws::Structure
end

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

#created ⇒ Boolean

#deleted ⇒ Boolean

#doc_service ⇒ Types::ServiceEndpoint

#domain_id ⇒ String

#domain_name ⇒ String

#limits ⇒ Types::Limits

#processing ⇒ Boolean

#requires_index_documents ⇒ Boolean

#search_instance_count ⇒ Integer

#search_instance_type ⇒ String

#search_partition_count ⇒ Integer

#search_service ⇒ Types::ServiceEndpoint

#arn ⇒ `String`

#created ⇒ `Boolean`

#deleted ⇒ `Boolean`

#doc_service ⇒ `Types::ServiceEndpoint`

#domain_id ⇒ `String`

#domain_name ⇒ `String`

#limits ⇒ `Types::Limits`

#processing ⇒ `Boolean`

#requires_index_documents ⇒ `Boolean`

#search_instance_count ⇒ `Integer`

#search_instance_type ⇒ `String`

#search_partition_count ⇒ `Integer`

#search_service ⇒ `Types::ServiceEndpoint`