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

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

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

Overview

The current status of an Elasticsearch domain.

Instance Attribute Summary collapse

Instance Attribute Details

#access_policiesString

IAM access policy as a JSON-formatted string.

Returns:

  • (String)


945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/types.rb', line 945

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

#advanced_optionsHash<String,String>

Specifies the status of the AdvancedOptions

Returns:

  • (Hash<String,String>)


945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/types.rb', line 945

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

#arnString

The Amazon resource name (ARN) of an Elasticsearch domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

Returns:

  • (String)


945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/types.rb', line 945

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

#cognito_optionsTypes::CognitoOptions

The CognitoOptions for the specified domain. For more information, see Amazon Cognito Authentication for Kibana.



945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/types.rb', line 945

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

#createdBoolean

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

Returns:

  • (Boolean)


945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/types.rb', line 945

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

#deletedBoolean

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)


945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/types.rb', line 945

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

#domain_idString

The unique identifier for the specified Elasticsearch domain.

Returns:

  • (String)


945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/types.rb', line 945

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

#domain_nameString

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)


945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/types.rb', line 945

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

#ebs_optionsTypes::EBSOptions

The EBSOptions for the specified domain. See Configuring EBS-based Storage for more information.

Returns:



945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/types.rb', line 945

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

#elasticsearch_cluster_configTypes::ElasticsearchClusterConfig

The type and number of instances in the domain cluster.



945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/types.rb', line 945

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

#elasticsearch_versionString

Returns:

  • (String)


945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/types.rb', line 945

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

#encryption_at_rest_optionsTypes::EncryptionAtRestOptions

Specifies the status of the EncryptionAtRestOptions.



945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/types.rb', line 945

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

#endpointString

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

Returns:

  • (String)


945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/types.rb', line 945

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

#endpointsHash<String,String>

Map containing the Elasticsearch domain endpoints used to submit index and search requests. Example key, value: 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'.

Returns:

  • (Hash<String,String>)


945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/types.rb', line 945

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

#log_publishing_optionsHash<String,Types::LogPublishingOption>

Log publishing options for the given domain.

Returns:



945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/types.rb', line 945

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

#processingBoolean

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

Returns:

  • (Boolean)


945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/types.rb', line 945

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

#snapshot_optionsTypes::SnapshotOptions

Specifies the status of the SnapshotOptions



945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/types.rb', line 945

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

#vpc_optionsTypes::VPCDerivedInfo

The VPCOptions for the specified domain. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.



945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/types.rb', line 945

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