class Aws::OpenSearchService::Types::DomainStatus
The current status of a domain.
@!attribute [rw] domain_id
The unique identifier for the specified domain. @return [String]
@!attribute [rw] domain_name
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). @return [String]
@!attribute [rw] arn
The Amazon Resource Name (ARN) of a domain. See [IAM identifiers ][1] in the *AWS Identity and Access Management User Guide* for more information. [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html @return [String]
@!attribute [rw] created
The domain creation status. `True` if the creation of a domain is complete. ` False ` if domain creation is still in progress. @return [Boolean]
@!attribute [rw] deleted
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. @return [Boolean]
@!attribute [rw] endpoint
The domain endpoint that you use to submit index and search requests. @return [String]
@!attribute [rw] endpoints
Map containing the domain endpoints used to submit index and search requests. Example `key, value`\: `'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'`. @return [Hash<String,String>]
@!attribute [rw] processing
The status of the domain configuration. `True` if Amazon OpenSearch Service is processing configuration changes. `False` if the configuration is active. @return [Boolean]
@!attribute [rw] upgrade_processing
The status of a domain version upgrade. `True` if Amazon OpenSearch Service is undergoing a version upgrade. `False` if the configuration is active. @return [Boolean]
@!attribute [rw] engine_version
@return [String]
@!attribute [rw] cluster_config
The type and number of instances in the domain. @return [Types::ClusterConfig]
@!attribute [rw] ebs_options
The `EBSOptions` for the specified domain. @return [Types::EBSOptions]
@!attribute [rw] access_policies
IAM access policy as a JSON-formatted string. @return [String]
@!attribute [rw] snapshot_options
The status of the `SnapshotOptions`. @return [Types::SnapshotOptions]
@!attribute [rw] vpc_options
The `VPCOptions` for the specified domain. For more information, see [ Launching your Amazon OpenSearch Service domains using a VPC][1]. [1]: http://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html @return [Types::VPCDerivedInfo]
@!attribute [rw] cognito_options
The `CognitoOptions` for the specified domain. For more information, see [Configuring Amazon Cognito authentication for OpenSearch Dashboards][1]. [1]: http://docs.aws.amazon.com/opensearch-service/latest/developerguide/cognito-auth.html @return [Types::CognitoOptions]
@!attribute [rw] encryption_at_rest_options
The status of the `EncryptionAtRestOptions`. @return [Types::EncryptionAtRestOptions]
@!attribute [rw] node_to_node_encryption_options
The status of the `NodeToNodeEncryptionOptions`. @return [Types::NodeToNodeEncryptionOptions]
@!attribute [rw] advanced_options
The status of the `AdvancedOptions`. @return [Hash<String,String>]
@!attribute [rw] log_publishing_options
Log publishing options for the given domain. @return [Hash<String,Types::LogPublishingOption>]
@!attribute [rw] service_software_options
The current status of the domain's service software. @return [Types::ServiceSoftwareOptions]
@!attribute [rw] domain_endpoint_options
The current status of the domain's endpoint options. @return [Types::DomainEndpointOptions]
@!attribute [rw] advanced_security_options
The current status of the domain's advanced security options. @return [Types::AdvancedSecurityOptions]
@!attribute [rw] auto_tune_options
The current status of the domain's Auto-Tune options. @return [Types::AutoTuneOptionsOutput]
@see docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DomainStatus AWS API Documentation
Constants
- SENSITIVE