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

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.

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

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)


1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 1303

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)
  include Aws::Structure
end

#createdBoolean

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)


1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 1303

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)
  include Aws::Structure
end

#deletedBoolean

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)


1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 1303

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)
  include Aws::Structure
end

#doc_serviceTypes::ServiceEndpoint

The service endpoint for updating documents in a search domain.



1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 1303

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)
  include Aws::Structure
end

#domain_idString

An internally generated unique identifier for a domain.

Returns:

  • (String)


1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 1303

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)
  include Aws::Structure
end

#domain_nameString

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)


1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 1303

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)
  include Aws::Structure
end

#limitsTypes::Limits

Returns:



1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 1303

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)
  include Aws::Structure
end

#processingBoolean

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

Returns:

  • (Boolean)


1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 1303

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)
  include Aws::Structure
end

#requires_index_documentsBoolean

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

Returns:

  • (Boolean)


1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 1303

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)
  include Aws::Structure
end

#search_instance_countInteger

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

Returns:

  • (Integer)


1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 1303

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)
  include Aws::Structure
end

#search_instance_typeString

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

Returns:

  • (String)


1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 1303

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)
  include Aws::Structure
end

#search_partition_countInteger

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

Returns:

  • (Integer)


1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 1303

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)
  include Aws::Structure
end

#search_serviceTypes::ServiceEndpoint

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



1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 1303

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)
  include Aws::Structure
end