Struct aws_sdk_opensearch::model::DomainStatus

#[non_exhaustive]
pub struct DomainStatus { /* private fields */ }

The current status of an OpenSearch Service domain.

Implementations

impl DomainStatus

pub fn domain_id(&self) -> Option<&str>

Unique identifier for the domain.

pub fn domain_name(&self) -> Option<&str>

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

pub fn arn(&self) -> Option<&str>

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

pub fn created(&self) -> Option<bool>

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

pub fn deleted(&self) -> Option<bool>

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.

pub fn endpoint(&self) -> Option<&str>

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

pub fn endpoints(&self) -> Option<&HashMap<String, String>>

The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints.. Example key, value: 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'.

pub fn processing(&self) -> Option<bool>

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

pub fn upgrade_processing(&self) -> Option<bool>

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.

pub fn engine_version(&self) -> Option<&str>

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

pub fn cluster_config(&self) -> Option<&ClusterConfig>

Container for the cluster configuration of the domain.

pub fn ebs_options(&self) -> Option<&EbsOptions>

Container for EBS-based storage settings for the domain.

pub fn access_policies(&self) -> Option<&str>

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

pub fn snapshot_options(&self) -> Option<&SnapshotOptions>

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

pub fn vpc_options(&self) -> Option<&VpcDerivedInfo>

The VPC configuration for the domain.

pub fn cognito_options(&self) -> Option<&CognitoOptions>

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

pub fn encryption_at_rest_options(&self) -> Option<&EncryptionAtRestOptions>

Encryption at rest settings for the domain.

pub fn node_to_node_encryption_options(
    &self
) -> Option<&NodeToNodeEncryptionOptions>

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

pub fn advanced_options(&self) -> Option<&HashMap<String, String>>

Key-value pairs that specify advanced configuration options.

pub fn log_publishing_options(
    &self
) -> Option<&HashMap<LogType, LogPublishingOption>>

Log publishing options for the domain.

pub fn service_software_options(&self) -> Option<&ServiceSoftwareOptions>

The current status of the domain's service software.

pub fn domain_endpoint_options(&self) -> Option<&DomainEndpointOptions>

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

pub fn advanced_security_options(&self) -> Option<&AdvancedSecurityOptions>

Settings for fine-grained access control.

pub fn auto_tune_options(&self) -> Option<&AutoTuneOptionsOutput>

Auto-Tune settings for the domain.

pub fn change_progress_details(&self) -> Option<&ChangeProgressDetails>

Information about a configuration change happening on the domain.

impl DomainStatus

pub fn builder() -> Builder

Creates a new builder-style object to manufacture DomainStatus.

Trait Implementations

impl Clone for DomainStatus

fn clone(&self) -> DomainStatus

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DomainStatus

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<DomainStatus> for DomainStatus

fn eq(&self, other: &DomainStatus) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DomainStatus