Struct aws_sdk_opensearch::types::DomainStatus

#[non_exhaustive]
pub struct DomainStatus {

    pub domain_id: String,
    pub domain_name: String,
    pub arn: String,
    pub created: Option<bool>,
    pub deleted: Option<bool>,
    pub endpoint: Option<String>,
    pub endpoint_v2: Option<String>,
    pub endpoints: Option<HashMap<String, String>>,
    pub processing: Option<bool>,
    pub upgrade_processing: Option<bool>,
    pub engine_version: Option<String>,
    pub cluster_config: Option<ClusterConfig>,
    pub ebs_options: Option<EbsOptions>,
    pub access_policies: Option<String>,
    pub ip_address_type: Option<IpAddressType>,
    pub snapshot_options: Option<SnapshotOptions>,
    pub vpc_options: Option<VpcDerivedInfo>,
    pub cognito_options: Option<CognitoOptions>,
    pub encryption_at_rest_options: Option<EncryptionAtRestOptions>,
    pub node_to_node_encryption_options: Option<NodeToNodeEncryptionOptions>,
    pub advanced_options: Option<HashMap<String, String>>,
    pub log_publishing_options: Option<HashMap<LogType, LogPublishingOption>>,
    pub service_software_options: Option<ServiceSoftwareOptions>,
    pub domain_endpoint_options: Option<DomainEndpointOptions>,
    pub advanced_security_options: Option<AdvancedSecurityOptions>,
    pub auto_tune_options: Option<AutoTuneOptionsOutput>,
    pub change_progress_details: Option<ChangeProgressDetails>,
    pub off_peak_window_options: Option<OffPeakWindowOptions>,
    pub software_update_options: Option<SoftwareUpdateOptions>,
}

The current status of an OpenSearch Service domain.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

domain_id: String

Unique identifier for the domain.

domain_name: String

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

arn: String

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

created: Option<bool>

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

deleted: 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.

endpoint: Option<String>

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

endpoint_v2: Option<String>

The domain endpoint to which index and search requests are submitted. For example, search-imdb-movies-oopcnjfn6ugo.eu-west-1.es.amazonaws.com or doc-imdb-movies-oopcnjfn6u.eu-west-1.es.amazonaws.com.

endpoints: 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'.

processing: Option<bool>

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

upgrade_processing: 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.

engine_version: Option<String>

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

cluster_config: Option<ClusterConfig>

Container for the cluster configuration of the domain.

ebs_options: Option<EbsOptions>

Container for EBS-based storage settings for the domain.

access_policies: Option<String>

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

ip_address_type: Option<IpAddressType>

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

snapshot_options: Option<SnapshotOptions>

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

vpc_options: Option<VpcDerivedInfo>

The VPC configuration for the domain.

cognito_options: Option<CognitoOptions>

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

encryption_at_rest_options: Option<EncryptionAtRestOptions>

Encryption at rest settings for the domain.

node_to_node_encryption_options: Option<NodeToNodeEncryptionOptions>

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

advanced_options: Option<HashMap<String, String>>

Key-value pairs that specify advanced configuration options.

log_publishing_options: Option<HashMap<LogType, LogPublishingOption>>

Log publishing options for the domain.

service_software_options: Option<ServiceSoftwareOptions>

The current status of the domain's service software.

domain_endpoint_options: Option<DomainEndpointOptions>

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

advanced_security_options: Option<AdvancedSecurityOptions>

Settings for fine-grained access control.

auto_tune_options: Option<AutoTuneOptionsOutput>

Auto-Tune settings for the domain.

change_progress_details: Option<ChangeProgressDetails>

Information about a configuration change happening on the domain.

off_peak_window_options: Option<OffPeakWindowOptions>

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

software_update_options: Option<SoftwareUpdateOptions>

Service software update options for the domain.

Implementations

impl DomainStatus

pub fn domain_id(&self) -> &str

Unique identifier for the domain.

pub fn domain_name(&self) -> &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) -> &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 endpoint_v2(&self) -> Option<&str>

The domain endpoint to which index and search requests are submitted. For example, search-imdb-movies-oopcnjfn6ugo.eu-west-1.es.amazonaws.com or doc-imdb-movies-oopcnjfn6u.eu-west-1.es.amazonaws.com.

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 ip_address_type(&self) -> Option<&IpAddressType>

The type of IP addresses supported by the endpoint 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.

pub fn off_peak_window_options(&self) -> Option<&OffPeakWindowOptions>

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

pub fn software_update_options(&self) -> Option<&SoftwareUpdateOptions>

Service software update options for the domain.

impl DomainStatus

pub fn builder() -> DomainStatusBuilder

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