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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb

Overview

The current status of the search domain.

Constant Summary collapse

SENSITIVE = 
[]

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) 


1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
 
# File 'gems/aws-sdk-cloudsearch/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) 


1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
 
# File 'gems/aws-sdk-cloudsearch/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) 


1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
 
# File 'gems/aws-sdk-cloudsearch/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:



1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
 
# File 'gems/aws-sdk-cloudsearch/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) 


1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
 
# File 'gems/aws-sdk-cloudsearch/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) 


1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
 
# File 'gems/aws-sdk-cloudsearch/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:



1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
 
# File 'gems/aws-sdk-cloudsearch/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) 


1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
 
# File 'gems/aws-sdk-cloudsearch/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) 


1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
 
# File 'gems/aws-sdk-cloudsearch/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) 


1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
 
# File 'gems/aws-sdk-cloudsearch/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) 


1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
 
# File 'gems/aws-sdk-cloudsearch/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) 


1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
 
# File 'gems/aws-sdk-cloudsearch/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:



1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
 
# File 'gems/aws-sdk-cloudsearch/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