#[non_exhaustive]pub struct ElasticsearchDomainStatus {Show 27 fields
pub domain_id: String,
pub domain_name: String,
pub arn: 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 elasticsearch_version: Option<String>,
pub elasticsearch_cluster_config: Option<ElasticsearchClusterConfig>,
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>,
pub domain_processing_status: Option<DomainProcessingStatusType>,
pub modifying_properties: Option<Vec<ModifyingProperties>>,
}
Expand description
The current status of an Elasticsearch domain.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.domain_id: String
The unique identifier for the specified Elasticsearch domain.
domain_name: String
The name of an Elasticsearch 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: String
The Amazon resource name (ARN) of an Elasticsearch domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.
created: Option<bool>
The domain creation status. True
if the creation of an Elasticsearch 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 Elasticsearch domain endpoint that you use to submit index and search requests.
endpoints: Option<HashMap<String, String>>
Map containing the Elasticsearch 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 Elasticsearch domain configuration. True
if Amazon Elasticsearch Service is processing configuration changes. False
if the configuration is active.
upgrade_processing: Option<bool>
The status of an Elasticsearch domain version upgrade. True
if Amazon Elasticsearch Service is undergoing a version upgrade. False
if the configuration is active.
elasticsearch_version: Option<String>
§elasticsearch_cluster_config: Option<ElasticsearchClusterConfig>
The type and number of instances in the domain cluster.
ebs_options: Option<EbsOptions>
The EBSOptions
for the specified domain. See Configuring EBS-based Storage for more information.
access_policies: Option<String>
IAM access policy as a JSON-formatted string.
snapshot_options: Option<SnapshotOptions>
Specifies the status of the SnapshotOptions
vpc_options: Option<VpcDerivedInfo>
The VPCOptions
for the specified domain. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.
cognito_options: Option<CognitoOptions>
The CognitoOptions
for the specified domain. For more information, see Amazon Cognito Authentication for Kibana.
encryption_at_rest_options: Option<EncryptionAtRestOptions>
Specifies the status of the EncryptionAtRestOptions
.
node_to_node_encryption_options: Option<NodeToNodeEncryptionOptions>
Specifies the status of the NodeToNodeEncryptionOptions
.
advanced_options: Option<HashMap<String, String>>
Specifies 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 Elasticsearch domain's service software.
domain_endpoint_options: Option<DomainEndpointOptions>
The current status of the Elasticsearch domain's endpoint options.
advanced_security_options: Option<AdvancedSecurityOptions>
The current status of the Elasticsearch domain's advanced security options.
auto_tune_options: Option<AutoTuneOptionsOutput>
The current status of the Elasticsearch domain's Auto-Tune options.
change_progress_details: Option<ChangeProgressDetails>
Specifies change details of the domain configuration change.
domain_processing_status: Option<DomainProcessingStatusType>
The status of any changes that are currently in progress for the domain.
modifying_properties: Option<Vec<ModifyingProperties>>
Information about the domain properties that are currently being modified.
Implementations§
Source§impl ElasticsearchDomainStatus
impl ElasticsearchDomainStatus
Sourcepub fn domain_name(&self) -> &str
pub fn domain_name(&self) -> &str
The name of an Elasticsearch 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).
Sourcepub fn arn(&self) -> &str
pub fn arn(&self) -> &str
The Amazon resource name (ARN) of an Elasticsearch domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.
Sourcepub fn created(&self) -> Option<bool>
pub fn created(&self) -> Option<bool>
The domain creation status. True
if the creation of an Elasticsearch domain is complete. False
if domain creation is still in progress.
Sourcepub fn deleted(&self) -> Option<bool>
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.
Sourcepub fn endpoint(&self) -> Option<&str>
pub fn endpoint(&self) -> Option<&str>
The Elasticsearch domain endpoint that you use to submit index and search requests.
Sourcepub fn endpoints(&self) -> Option<&HashMap<String, String>>
pub fn endpoints(&self) -> Option<&HashMap<String, String>>
Map containing the Elasticsearch domain endpoints used to submit index and search requests. Example key, value
: 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'
.
Sourcepub fn processing(&self) -> Option<bool>
pub fn processing(&self) -> Option<bool>
The status of the Elasticsearch domain configuration. True
if Amazon Elasticsearch Service is processing configuration changes. False
if the configuration is active.
Sourcepub fn upgrade_processing(&self) -> Option<bool>
pub fn upgrade_processing(&self) -> Option<bool>
The status of an Elasticsearch domain version upgrade. True
if Amazon Elasticsearch Service is undergoing a version upgrade. False
if the configuration is active.
pub fn elasticsearch_version(&self) -> Option<&str>
Sourcepub fn elasticsearch_cluster_config(
&self,
) -> Option<&ElasticsearchClusterConfig>
pub fn elasticsearch_cluster_config( &self, ) -> Option<&ElasticsearchClusterConfig>
The type and number of instances in the domain cluster.
Sourcepub fn ebs_options(&self) -> Option<&EbsOptions>
pub fn ebs_options(&self) -> Option<&EbsOptions>
The EBSOptions
for the specified domain. See Configuring EBS-based Storage for more information.
Sourcepub fn access_policies(&self) -> Option<&str>
pub fn access_policies(&self) -> Option<&str>
IAM access policy as a JSON-formatted string.
Sourcepub fn snapshot_options(&self) -> Option<&SnapshotOptions>
pub fn snapshot_options(&self) -> Option<&SnapshotOptions>
Specifies the status of the SnapshotOptions
Sourcepub fn vpc_options(&self) -> Option<&VpcDerivedInfo>
pub fn vpc_options(&self) -> Option<&VpcDerivedInfo>
The VPCOptions
for the specified domain. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.
Sourcepub fn cognito_options(&self) -> Option<&CognitoOptions>
pub fn cognito_options(&self) -> Option<&CognitoOptions>
The CognitoOptions
for the specified domain. For more information, see Amazon Cognito Authentication for Kibana.
Sourcepub fn encryption_at_rest_options(&self) -> Option<&EncryptionAtRestOptions>
pub fn encryption_at_rest_options(&self) -> Option<&EncryptionAtRestOptions>
Specifies the status of the EncryptionAtRestOptions
.
Sourcepub fn node_to_node_encryption_options(
&self,
) -> Option<&NodeToNodeEncryptionOptions>
pub fn node_to_node_encryption_options( &self, ) -> Option<&NodeToNodeEncryptionOptions>
Specifies the status of the NodeToNodeEncryptionOptions
.
Sourcepub fn advanced_options(&self) -> Option<&HashMap<String, String>>
pub fn advanced_options(&self) -> Option<&HashMap<String, String>>
Specifies the status of the AdvancedOptions
Sourcepub fn log_publishing_options(
&self,
) -> Option<&HashMap<LogType, LogPublishingOption>>
pub fn log_publishing_options( &self, ) -> Option<&HashMap<LogType, LogPublishingOption>>
Log publishing options for the given domain.
Sourcepub fn service_software_options(&self) -> Option<&ServiceSoftwareOptions>
pub fn service_software_options(&self) -> Option<&ServiceSoftwareOptions>
The current status of the Elasticsearch domain's service software.
Sourcepub fn domain_endpoint_options(&self) -> Option<&DomainEndpointOptions>
pub fn domain_endpoint_options(&self) -> Option<&DomainEndpointOptions>
The current status of the Elasticsearch domain's endpoint options.
Sourcepub fn advanced_security_options(&self) -> Option<&AdvancedSecurityOptions>
pub fn advanced_security_options(&self) -> Option<&AdvancedSecurityOptions>
The current status of the Elasticsearch domain's advanced security options.
Sourcepub fn auto_tune_options(&self) -> Option<&AutoTuneOptionsOutput>
pub fn auto_tune_options(&self) -> Option<&AutoTuneOptionsOutput>
The current status of the Elasticsearch domain's Auto-Tune options.
Sourcepub fn change_progress_details(&self) -> Option<&ChangeProgressDetails>
pub fn change_progress_details(&self) -> Option<&ChangeProgressDetails>
Specifies change details of the domain configuration change.
Sourcepub fn domain_processing_status(&self) -> Option<&DomainProcessingStatusType>
pub fn domain_processing_status(&self) -> Option<&DomainProcessingStatusType>
The status of any changes that are currently in progress for the domain.
Sourcepub fn modifying_properties(&self) -> &[ModifyingProperties]
pub fn modifying_properties(&self) -> &[ModifyingProperties]
Information about the domain properties that are currently being modified.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .modifying_properties.is_none()
.
Source§impl ElasticsearchDomainStatus
impl ElasticsearchDomainStatus
Sourcepub fn builder() -> ElasticsearchDomainStatusBuilder
pub fn builder() -> ElasticsearchDomainStatusBuilder
Creates a new builder-style object to manufacture ElasticsearchDomainStatus
.
Trait Implementations§
Source§impl Clone for ElasticsearchDomainStatus
impl Clone for ElasticsearchDomainStatus
Source§fn clone(&self) -> ElasticsearchDomainStatus
fn clone(&self) -> ElasticsearchDomainStatus
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ElasticsearchDomainStatus
impl Debug for ElasticsearchDomainStatus
impl StructuralPartialEq for ElasticsearchDomainStatus
Auto Trait Implementations§
impl Freeze for ElasticsearchDomainStatus
impl RefUnwindSafe for ElasticsearchDomainStatus
impl Send for ElasticsearchDomainStatus
impl Sync for ElasticsearchDomainStatus
impl Unpin for ElasticsearchDomainStatus
impl UnwindSafe for ElasticsearchDomainStatus
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);