Struct aws_sdk_opensearch::model::DomainStatus

#[non_exhaustive]
pub struct DomainStatus {

    pub domain_id: Option<String>,
    pub domain_name: Option<String>,
    pub arn: Option<String>,
    pub created: Option<bool>,
    pub deleted: Option<bool>,
    pub endpoint: 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 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>,
}

The current status of a 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: Option<String>

The unique identifier for the specified domain.

domain_name: Option<String>

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

arn: Option<String>

The Amazon Resource Name (ARN) of a domain. See IAM identifiers in the AWS Identity and Access Management User Guide for more information.

created: Option<bool>

The domain creation status. True if the creation of a domain is complete. False if domain creation is still in progress.

deleted: Option<bool>

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.

endpoint: Option<String>

The domain endpoint that you use to submit index and search requests.

endpoints: Option<HashMap<String, String>>

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

processing: Option<bool>

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

upgrade_processing: Option<bool>

The status of a domain version upgrade. True if Amazon OpenSearch Service is undergoing a version upgrade. False if the configuration is active.

engine_version: Option<String>

cluster_config: Option<ClusterConfig>

The type and number of instances in the domain.

ebs_options: Option<EbsOptions>

The EBSOptions for the specified domain.

access_policies: Option<String>

IAM access policy as a JSON-formatted string.

snapshot_options: Option<SnapshotOptions>

The status of the SnapshotOptions.

vpc_options: Option<VpcDerivedInfo>

The VPCOptions for the specified domain. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.

cognito_options: Option<CognitoOptions>

The CognitoOptions for the specified domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

encryption_at_rest_options: Option<EncryptionAtRestOptions>

The status of the EncryptionAtRestOptions.

node_to_node_encryption_options: Option<NodeToNodeEncryptionOptions>

The status of the NodeToNodeEncryptionOptions.

advanced_options: Option<HashMap<String, String>>

The status of the AdvancedOptions.

log_publishing_options: Option<HashMap<LogType, LogPublishingOption>>

Log publishing options for the given domain.

service_software_options: Option<ServiceSoftwareOptions>

The current status of the domain's service software.

domain_endpoint_options: Option<DomainEndpointOptions>

The current status of the domain's endpoint options.

advanced_security_options: Option<AdvancedSecurityOptions>

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

auto_tune_options: Option<AutoTuneOptionsOutput>

The current status of the domain's Auto-Tune options.

change_progress_details: Option<ChangeProgressDetails>

Specifies change details of the domain configuration change.

Implementations

impl DomainStatus

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

The unique identifier for the specified domain.

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

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

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

The Amazon Resource Name (ARN) of a domain. See IAM identifiers in the AWS Identity and Access Management User Guide for more information.

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

The domain creation status. True if the creation of a domain is complete. False if domain creation is still in progress.

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

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.

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

The domain endpoint that you use to submit index and search requests.

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

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

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

The status of the domain configuration. True if Amazon 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. True if Amazon OpenSearch Service is undergoing a version upgrade. False if the configuration is active.

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

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

The type and number of instances in the domain.

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

The EBSOptions for the specified domain.

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

IAM access policy as a JSON-formatted string.

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

The status of the SnapshotOptions.

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

The VPCOptions for the specified domain. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.

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

The CognitoOptions for the specified domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

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

The status of the EncryptionAtRestOptions.

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

The status of the NodeToNodeEncryptionOptions.

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

The status of the AdvancedOptions.

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

Log publishing options for the given 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>

The current status of the domain's endpoint options.

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

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

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

The current status of the domain's Auto-Tune options.

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

Specifies change details of the domain configuration change.

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: &DomainStatus) -> bool

This method tests for !=.

impl StructuralPartialEq for DomainStatus