Class: Aws::ElasticsearchService::Types::ElasticsearchDomainStatus

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-elasticsearchservice/types.rb

Overview

The current status of an Elasticsearch domain.

Instance Attribute Summary collapse

Instance Attribute Details

#access_policies ⇒ String

IAM access policy as a JSON-formatted string.

Returns:

  • (String) 


666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
 
# File 'lib/aws-sdk-elasticsearchservice/types.rb', line 666

class ElasticsearchDomainStatus < Struct.new(
  :domain_id,
  :domain_name,
  :arn,
  :created,
  :deleted,
  :endpoint,
  :processing,
  :elasticsearch_version,
  :elasticsearch_cluster_config,
  :ebs_options,
  :access_policies,
  :snapshot_options,
  :advanced_options)
  include Aws::Structure
end

#advanced_options ⇒ Hash<String,String>

Specifies the status of the ‘AdvancedOptions`

Returns:

  • (Hash<String,String>) 


666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
 
# File 'lib/aws-sdk-elasticsearchservice/types.rb', line 666

class ElasticsearchDomainStatus < Struct.new(
  :domain_id,
  :domain_name,
  :arn,
  :created,
  :deleted,
  :endpoint,
  :processing,
  :elasticsearch_version,
  :elasticsearch_cluster_config,
  :ebs_options,
  :access_policies,
  :snapshot_options,
  :advanced_options)
  include Aws::Structure
end

#arn ⇒ String

The Amazon resource name (ARN) of an Elasticsearch 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) 


666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
 
# File 'lib/aws-sdk-elasticsearchservice/types.rb', line 666

class ElasticsearchDomainStatus < Struct.new(
  :domain_id,
  :domain_name,
  :arn,
  :created,
  :deleted,
  :endpoint,
  :processing,
  :elasticsearch_version,
  :elasticsearch_cluster_config,
  :ebs_options,
  :access_policies,
  :snapshot_options,
  :advanced_options)
  include Aws::Structure
end

#created ⇒ Boolean

The domain creation status. ‘True` if the creation of an Elasticsearch domain is complete. `False` if domain creation is still in progress.

Returns:

  • (Boolean) 


666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
 
# File 'lib/aws-sdk-elasticsearchservice/types.rb', line 666

class ElasticsearchDomainStatus < Struct.new(
  :domain_id,
  :domain_name,
  :arn,
  :created,
  :deleted,
  :endpoint,
  :processing,
  :elasticsearch_version,
  :elasticsearch_cluster_config,
  :ebs_options,
  :access_policies,
  :snapshot_options,
  :advanced_options)
  include Aws::Structure
end

#deleted ⇒ Boolean

The domain deletion status. ‘True` if a delete request has been received for the domain but resource cleanup is still in progress. `False` if the domain has not been deleted. Once domain deletion is complete, the status of the domain is no longer returned.

Returns:

  • (Boolean) 


666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
 
# File 'lib/aws-sdk-elasticsearchservice/types.rb', line 666

class ElasticsearchDomainStatus < Struct.new(
  :domain_id,
  :domain_name,
  :arn,
  :created,
  :deleted,
  :endpoint,
  :processing,
  :elasticsearch_version,
  :elasticsearch_cluster_config,
  :ebs_options,
  :access_policies,
  :snapshot_options,
  :advanced_options)
  include Aws::Structure
end

#domain_id ⇒ String

The unique identifier for the specified Elasticsearch domain.

Returns:

  • (String) 


666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
 
# File 'lib/aws-sdk-elasticsearchservice/types.rb', line 666

class ElasticsearchDomainStatus < Struct.new(
  :domain_id,
  :domain_name,
  :arn,
  :created,
  :deleted,
  :endpoint,
  :processing,
  :elasticsearch_version,
  :elasticsearch_cluster_config,
  :ebs_options,
  :access_policies,
  :snapshot_options,
  :advanced_options)
  include Aws::Structure
end

#domain_name ⇒ String

The name of an Elasticsearch 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) 


666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
 
# File 'lib/aws-sdk-elasticsearchservice/types.rb', line 666

class ElasticsearchDomainStatus < Struct.new(
  :domain_id,
  :domain_name,
  :arn,
  :created,
  :deleted,
  :endpoint,
  :processing,
  :elasticsearch_version,
  :elasticsearch_cluster_config,
  :ebs_options,
  :access_policies,
  :snapshot_options,
  :advanced_options)
  include Aws::Structure
end

#ebs_options ⇒ Types::EBSOptions

The ‘EBSOptions` for the specified domain. See [Configuring EBS-based Storage] for more information.

[1]: docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs

Returns:



666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
 
# File 'lib/aws-sdk-elasticsearchservice/types.rb', line 666

class ElasticsearchDomainStatus < Struct.new(
  :domain_id,
  :domain_name,
  :arn,
  :created,
  :deleted,
  :endpoint,
  :processing,
  :elasticsearch_version,
  :elasticsearch_cluster_config,
  :ebs_options,
  :access_policies,
  :snapshot_options,
  :advanced_options)
  include Aws::Structure
end

#elasticsearch_cluster_config ⇒ Types::ElasticsearchClusterConfig

The type and number of instances in the domain cluster.

Returns:



666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
 
# File 'lib/aws-sdk-elasticsearchservice/types.rb', line 666

class ElasticsearchDomainStatus < Struct.new(
  :domain_id,
  :domain_name,
  :arn,
  :created,
  :deleted,
  :endpoint,
  :processing,
  :elasticsearch_version,
  :elasticsearch_cluster_config,
  :ebs_options,
  :access_policies,
  :snapshot_options,
  :advanced_options)
  include Aws::Structure
end

#elasticsearch_version ⇒ String

Returns:

  • (String) 


666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
 
# File 'lib/aws-sdk-elasticsearchservice/types.rb', line 666

class ElasticsearchDomainStatus < Struct.new(
  :domain_id,
  :domain_name,
  :arn,
  :created,
  :deleted,
  :endpoint,
  :processing,
  :elasticsearch_version,
  :elasticsearch_cluster_config,
  :ebs_options,
  :access_policies,
  :snapshot_options,
  :advanced_options)
  include Aws::Structure
end

#endpoint ⇒ String

The Elasticsearch domain endpoint that you use to submit index and search requests.

Returns:

  • (String) 


666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
 
# File 'lib/aws-sdk-elasticsearchservice/types.rb', line 666

class ElasticsearchDomainStatus < Struct.new(
  :domain_id,
  :domain_name,
  :arn,
  :created,
  :deleted,
  :endpoint,
  :processing,
  :elasticsearch_version,
  :elasticsearch_cluster_config,
  :ebs_options,
  :access_policies,
  :snapshot_options,
  :advanced_options)
  include Aws::Structure
end

#processing ⇒ Boolean

The status of the Elasticsearch domain configuration. ‘True` if Amazon Elasticsearch Service is processing configuration changes. `False` if the configuration is active.

Returns:

  • (Boolean) 


666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
 
# File 'lib/aws-sdk-elasticsearchservice/types.rb', line 666

class ElasticsearchDomainStatus < Struct.new(
  :domain_id,
  :domain_name,
  :arn,
  :created,
  :deleted,
  :endpoint,
  :processing,
  :elasticsearch_version,
  :elasticsearch_cluster_config,
  :ebs_options,
  :access_policies,
  :snapshot_options,
  :advanced_options)
  include Aws::Structure
end

#snapshot_options ⇒ Types::SnapshotOptions

Specifies the status of the ‘SnapshotOptions`

Returns:



666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
 
# File 'lib/aws-sdk-elasticsearchservice/types.rb', line 666

class ElasticsearchDomainStatus < Struct.new(
  :domain_id,
  :domain_name,
  :arn,
  :created,
  :deleted,
  :endpoint,
  :processing,
  :elasticsearch_version,
  :elasticsearch_cluster_config,
  :ebs_options,
  :access_policies,
  :snapshot_options,
  :advanced_options)
  include Aws::Structure
end