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

Inherits:

Struct

• Object
• Struct
• Aws::ElasticsearchService::Types::ElasticsearchDomainStatus

Defined in:

(unknown)

Overview

The current status of an Elasticsearch domain.

Returned by:

• CreateElasticsearchDomainResponse#domain_status
• DeleteElasticsearchDomainResponse#domain_status
• DescribeElasticsearchDomainResponse#domain_status

Instance Attribute Summary

• #access_policies ⇒ String

  IAM access policy as a JSON-formatted string.

• #advanced_options ⇒ Hash<String,String>

  Specifies the status of the AdvancedOptions.

• #advanced_security_options ⇒ Types::AdvancedSecurityOptions

  The current status of the Elasticsearch domain\'s advanced security options.

• #arn ⇒ String

  The Amazon resource name (ARN) of an Elasticsearch domain.

• #cognito_options ⇒ Types::CognitoOptions

  The CognitoOptions for the specified domain.

• #created ⇒ Boolean

  The domain creation status.

• #deleted ⇒ Boolean

  The domain deletion status.

• #domain_endpoint_options ⇒ Types::DomainEndpointOptions

  The current status of the Elasticsearch domain\'s endpoint options.

• #domain_id ⇒ String

  The unique identifier for the specified Elasticsearch domain.

• #domain_name ⇒ String

  The name of an Elasticsearch domain.

• #ebs_options ⇒ Types::EBSOptions

  The EBSOptions for the specified domain.

• #elasticsearch_cluster_config ⇒ Types::ElasticsearchClusterConfig

  The type and number of instances in the domain cluster.

• #elasticsearch_version ⇒ String
• #encryption_at_rest_options ⇒ Types::EncryptionAtRestOptions

  Specifies the status of the EncryptionAtRestOptions.

• #endpoint ⇒ String

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

• #endpoints ⇒ Hash<String,String>

  Map containing the Elasticsearch domain endpoints used to submit index and search requests.

• #log_publishing_options ⇒ Hash<String,Types::LogPublishingOption>

  Log publishing options for the given domain.

• #node_to_node_encryption_options ⇒ Types::NodeToNodeEncryptionOptions

  Specifies the status of the NodeToNodeEncryptionOptions.

• #processing ⇒ Boolean

  The status of the Elasticsearch domain configuration.

• #service_software_options ⇒ Types::ServiceSoftwareOptions

  The current status of the Elasticsearch domain\'s service software.

• #snapshot_options ⇒ Types::SnapshotOptions

  Specifies the status of the SnapshotOptions.

• #upgrade_processing ⇒ Boolean

  The status of an Elasticsearch domain version upgrade.

• #vpc_options ⇒ Types::VPCDerivedInfo

  The VPCOptions for the specified domain.

Instance Attribute Details

#access_policies ⇒ String

IAM access policy as a JSON-formatted string.

Returns:

• (String) —

  IAM access policy as a JSON-formatted string.

#advanced_options ⇒ Hash<String,String>

Specifies the status of the AdvancedOptions

Returns:

• (Hash<String,String>) —

  Specifies the status of the AdvancedOptions.

#advanced_security_options ⇒ Types::AdvancedSecurityOptions

The current status of the Elasticsearch domain\'s advanced security options.

Returns:

• (Types::AdvancedSecurityOptions) —

  The current status of the Elasticsearch domain\'s advanced security options.

#arn ⇒ String

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

Returns:

• (String) —

  The Amazon resource name (ARN) of an Elasticsearch domain.

#cognito_options ⇒ Types::CognitoOptions

The CognitoOptions for the specified domain. For more information, see Amazon Cognito Authentication for Kibanatarget="_blank".

Returns:

• (Types::CognitoOptions) —

  The CognitoOptions for the specified domain.

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

  The domain creation status.

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

  The domain deletion status.

#domain_endpoint_options ⇒ Types::DomainEndpointOptions

The current status of the Elasticsearch domain\'s endpoint options.

Returns:

• (Types::DomainEndpointOptions) —

  The current status of the Elasticsearch domain\'s endpoint options.

#domain_id ⇒ String

The unique identifier for the specified Elasticsearch domain.

Returns:

• (String) —

  The unique identifier for the specified Elasticsearch domain.

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

  The name of an Elasticsearch domain.

#ebs_options ⇒ Types::EBSOptions

The EBSOptions for the specified domain. See Configuring EBS-based Storagetarget="_blank" for more information.

Returns:

• (Types::EBSOptions) —

  The EBSOptions for the specified domain.

#elasticsearch_cluster_config ⇒ Types::ElasticsearchClusterConfig

The type and number of instances in the domain cluster.

Returns:

• (Types::ElasticsearchClusterConfig) —

  The type and number of instances in the domain cluster.

#elasticsearch_version ⇒ String

Returns:

• (String)

#encryption_at_rest_options ⇒ Types::EncryptionAtRestOptions

Specifies the status of the EncryptionAtRestOptions.

Returns:

• (Types::EncryptionAtRestOptions) —

  Specifies the status of the EncryptionAtRestOptions.

#endpoint ⇒ String

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

Returns:

• (String) —

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

#endpoints ⇒ Hash<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>) —

  Map containing the Elasticsearch domain endpoints used to submit index and search requests.

#log_publishing_options ⇒ Hash<String,Types::LogPublishingOption>

Log publishing options for the given domain.

Returns:

• (Hash<String,Types::LogPublishingOption>) —

  Log publishing options for the given domain.

#node_to_node_encryption_options ⇒ Types::NodeToNodeEncryptionOptions

Specifies the status of the NodeToNodeEncryptionOptions.

Returns:

• (Types::NodeToNodeEncryptionOptions) —

  Specifies the status of the NodeToNodeEncryptionOptions.

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

  The status of the Elasticsearch domain configuration.

#service_software_options ⇒ Types::ServiceSoftwareOptions

The current status of the Elasticsearch domain\'s service software.

Returns:

• (Types::ServiceSoftwareOptions) —

  The current status of the Elasticsearch domain\'s service software.

#snapshot_options ⇒ Types::SnapshotOptions

Specifies the status of the SnapshotOptions

Returns:

• (Types::SnapshotOptions) —

  Specifies the status of the SnapshotOptions.

#upgrade_processing ⇒ Boolean

The status of an Elasticsearch domain version upgrade. True if Amazon Elasticsearch Service is undergoing a version upgrade. False if the configuration is active.

Returns:

• (Boolean) —

  The status of an Elasticsearch domain version upgrade.

#vpc_options ⇒ Types::VPCDerivedInfo

The VPCOptions for the specified domain. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domainstarget="_blank".

Returns:

• (Types::VPCDerivedInfo) —

  The VPCOptions for the specified domain.