DomainStatus - Amazon OpenSearch Service

DomainStatus

The current status of an OpenSearch Service domain.

Contents

ARN

The Amazon Resource Name (ARN) of the domain. For more information, see IAM identifiers in the AWS Identity and Access Management User Guide.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: .*

Required: Yes

ClusterConfig

Container for the cluster configuration of the domain.

Type: ClusterConfig object

Required: Yes

DomainId

Unique identifier for the domain.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: Yes

DomainName

Name of the domain. Domain names are unique across all domains owned by the same account within an AWS Region.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 28.

Pattern: [a-z][a-z0-9\-]+

Required: Yes

AccessPolicies

Identity and Access Management (IAM) policy document specifying the access policies for the domain.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 102400.

Pattern: .*

Required: No

AdvancedOptions

Key-value pairs that specify advanced configuration options.

Type: String to string map

Required: No

AdvancedSecurityOptions

Settings for fine-grained access control.

Type: AdvancedSecurityOptions object

Required: No

AutoTuneOptions

Auto-Tune settings for the domain.

Type: AutoTuneOptionsOutput object

Required: No

ChangeProgressDetails

Information about a configuration change happening on the domain.

Type: ChangeProgressDetails object

Required: No

CognitoOptions

Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.

Type: CognitoOptions object

Required: No

Created

Creation status of an OpenSearch Service domain. True if domain creation is complete. False if domain creation is still in progress.

Type: Boolean

Required: No

Deleted

Deletion status of an OpenSearch Service domain. True if domain deletion is complete. False if domain deletion is still in progress. Once deletion is complete, the status of the domain is no longer returned.

Type: Boolean

Required: No

DomainEndpointOptions

Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

Type: DomainEndpointOptions object

Required: No

DomainEndpointV2HostedZoneId

The dual stack hosted zone ID for the domain.

Type: String

Required: No

DomainProcessingStatus

The status of any changes that are currently in progress for the domain.

Type: String

Valid Values: Creating | Active | Modifying | UpgradingEngineVersion | UpdatingServiceSoftware | Isolated | Deleting

Required: No

EBSOptions

Container for EBS-based storage settings for the domain.

Type: EBSOptions object

Required: No

EncryptionAtRestOptions

Encryption at rest settings for the domain.

Type: EncryptionAtRestOptions object

Required: No

Endpoint

Domain-specific endpoint used to submit index, search, and data upload requests to the domain.

Type: String

Required: No

Endpoints

The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints. For example:

  • IPv4 IP addresses - 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'

  • Dual stack IP addresses - 'vpcv2':'vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.aos.us-east-1.on.aws'

Type: String to string map

Required: No

EndpointV2

If IPAddressType to set to dualstack, a version 2 domain endpoint is provisioned. This endpoint functions like a normal endpoint, except that it works with both IPv4 and IPv6 IP addresses. Normal endpoints work only with IPv4 IP addresses.

Type: String

Required: No

EngineVersion

Version of OpenSearch or Elasticsearch that the domain is running, in the format Elasticsearch_X.Y or OpenSearch_X.Y.

Type: String

Length Constraints: Minimum length of 14. Maximum length of 18.

Pattern: ^Elasticsearch_[0-9]{1}\.[0-9]{1,2}$|^OpenSearch_[0-9]{1,2}\.[0-9]{1,2}$

Required: No

IPAddressType

The type of IP addresses supported by the endpoint for the domain.

Type: String

Valid Values: ipv4 | dualstack

Required: No

LogPublishingOptions

Log publishing options for the domain.

Type: String to LogPublishingOption object map

Valid Keys: INDEX_SLOW_LOGS | SEARCH_SLOW_LOGS | ES_APPLICATION_LOGS | AUDIT_LOGS

Required: No

ModifyingProperties

Information about the domain properties that are currently being modified.

Type: Array of ModifyingProperties objects

Required: No

NodeToNodeEncryptionOptions

Whether node-to-node encryption is enabled or disabled.

Type: NodeToNodeEncryptionOptions object

Required: No

OffPeakWindowOptions

Options that specify a custom 10-hour window during which OpenSearch Service can perform configuration changes on the domain.

Type: OffPeakWindowOptions object

Required: No

Processing

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

Type: Boolean

Required: No

ServiceSoftwareOptions

The current status of the domain's service software.

Type: ServiceSoftwareOptions object

Required: No

SnapshotOptions

DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.

Type: SnapshotOptions object

Required: No

SoftwareUpdateOptions

Service software update options for the domain.

Type: SoftwareUpdateOptions object

Required: No

UpgradeProcessing

The status of a domain version upgrade to a new version of OpenSearch or Elasticsearch. True if OpenSearch Service is in the process of a version upgrade. False if the configuration is active.

Type: Boolean

Required: No

VPCOptions

The VPC configuration for the domain.

Type: VPCDerivedInfo object

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: