Struct aws_sdk_cloudsearch::types::DomainStatus

#[non_exhaustive]
pub struct DomainStatus {

    pub domain_id: String,
    pub domain_name: String,
    pub arn: Option<String>,
    pub created: Option<bool>,
    pub deleted: Option<bool>,
    pub doc_service: Option<ServiceEndpoint>,
    pub search_service: Option<ServiceEndpoint>,
    pub requires_index_documents: bool,
    pub processing: Option<bool>,
    pub search_instance_type: Option<String>,
    pub search_partition_count: Option<i32>,
    pub search_instance_count: Option<i32>,
    pub limits: Option<Limits>,
}

The current status of the search 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

An internally generated unique identifier for a domain.

domain_name: String

A string that represents 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 the search domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

created: Option<bool>

True if the search domain is created. It can take several minutes to initialize a domain when CreateDomain is called. Newly created search domains are returned from DescribeDomains with a false value for Created until domain creation is complete.

deleted: Option<bool>

True if the search domain has been deleted. The system must clean up resources dedicated to the search domain when DeleteDomain is called. Newly deleted search domains are returned from DescribeDomains with a true value for IsDeleted for several minutes until resource cleanup is complete.

doc_service: Option<ServiceEndpoint>

The service endpoint for updating documents in a search domain.

search_service: Option<ServiceEndpoint>

The service endpoint for requesting search results from a search domain.

requires_index_documents: bool

True if IndexDocuments needs to be called to activate the current domain configuration.

processing: Option<bool>

True if processing is being done to activate the current domain configuration.

search_instance_type: Option<String>

The instance type that is being used to process search requests.

search_partition_count: Option<i32>

The number of partitions across which the search index is spread.

search_instance_count: Option<i32>

The number of search instances that are available to process search requests.

limits: Option<Limits>

Implementations

impl DomainStatus

pub fn domain_id(&self) -> &str

An internally generated unique identifier for a domain.

pub fn domain_name(&self) -> &str

A string that represents 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 the search domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

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

True if the search domain is created. It can take several minutes to initialize a domain when CreateDomain is called. Newly created search domains are returned from DescribeDomains with a false value for Created until domain creation is complete.

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

True if the search domain has been deleted. The system must clean up resources dedicated to the search domain when DeleteDomain is called. Newly deleted search domains are returned from DescribeDomains with a true value for IsDeleted for several minutes until resource cleanup is complete.

pub fn doc_service(&self) -> Option<&ServiceEndpoint>

The service endpoint for updating documents in a search domain.

pub fn search_service(&self) -> Option<&ServiceEndpoint>

The service endpoint for requesting search results from a search domain.

pub fn requires_index_documents(&self) -> bool

True if IndexDocuments needs to be called to activate the current domain configuration.

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

True if processing is being done to activate the current domain configuration.

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

The instance type that is being used to process search requests.

pub fn search_partition_count(&self) -> Option<i32>

The number of partitions across which the search index is spread.

pub fn search_instance_count(&self) -> Option<i32>

The number of search instances that are available to process search requests.

pub fn limits(&self) -> Option<&Limits>

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