AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#access_policiesString

IAM access policy as a JSON-formatted string.

Returns:

  • (String)

    IAM access policy as a JSON-formatted string.

#advanced_optionsHash<String,String>

Specifies the status of the AdvancedOptions

Returns:

  • (Hash<String,String>)

    Specifies the status of the AdvancedOptions.

#advanced_security_optionsTypes::AdvancedSecurityOptions

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

Returns:

#arnString

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_optionsTypes::CognitoOptions

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

Returns:

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

    The domain creation status.

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

    The domain deletion status.

#domain_endpoint_optionsTypes::DomainEndpointOptions

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

Returns:

#domain_idString

The unique identifier for the specified Elasticsearch domain.

Returns:

  • (String)

    The unique identifier for the specified Elasticsearch domain.

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

    The name of an Elasticsearch domain.

#ebs_optionsTypes::EBSOptions

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

Returns:

#elasticsearch_cluster_configTypes::ElasticsearchClusterConfig

The type and number of instances in the domain cluster.

Returns:

#elasticsearch_versionString

Returns:

  • (String)

#encryption_at_rest_optionsTypes::EncryptionAtRestOptions

Specifies the status of the EncryptionAtRestOptions.

Returns:

#endpointString

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.

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

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

#log_publishing_optionsHash<String,Types::LogPublishingOption>

Log publishing options for the given domain.

Returns:

#node_to_node_encryption_optionsTypes::NodeToNodeEncryptionOptions

Specifies the status of the NodeToNodeEncryptionOptions.

Returns:

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

    The status of the Elasticsearch domain configuration.

#service_software_optionsTypes::ServiceSoftwareOptions

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

Returns:

#snapshot_optionsTypes::SnapshotOptions

Specifies the status of the SnapshotOptions

Returns:

#upgrade_processingBoolean

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_optionsTypes::VPCDerivedInfo

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

Returns: