#[non_exhaustive]pub struct DomainStatus {Show 34 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 endpoint_v2: Option<String>,
pub endpoints: Option<HashMap<String, String>>,
pub domain_endpoint_v2_hosted_zone_id: Option<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 identity_center_options: Option<IdentityCenterOptions>,
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>,
pub domain_processing_status: Option<DomainProcessingStatusType>,
pub modifying_properties: Option<Vec<ModifyingProperties>>,
pub aiml_options: Option<AimlOptionsOutput>,
}Expand description
The current status of an OpenSearch Service 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: StringUnique identifier for the domain.
domain_name: StringName of the domain. Domain names are unique across all domains owned by the same account within an Amazon Web Services Region.
arn: StringThe 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>If IPAddressType to set to dualstack, a version 2 domain endpoint is provisioned. This endpoint functions like a normal endpoint, except that it works with both IPv4 and IPv6 IP addresses. Normal endpoints work only with IPv4 IP addresses.
endpoints: Option<HashMap<String, String>>The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints. For example:
-
IPv4 IP addresses -
'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com' -
Dual stack IP addresses -
'vpcv2':'vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.aos.us-east-1.on.aws'
domain_endpoint_v2_hosted_zone_id: Option<String>The dual stack hosted zone ID for the domain.
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.
identity_center_options: Option<IdentityCenterOptions>Configuration options for controlling IAM Identity Center integration within a domain.
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.
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.
aiml_options: Option<AimlOptionsOutput>Container for parameters required to enable all machine learning features.
Implementations§
Source§impl DomainStatus
impl DomainStatus
Sourcepub fn domain_name(&self) -> &str
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.
Sourcepub fn arn(&self) -> &str
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.
Sourcepub fn created(&self) -> Option<bool>
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.
Sourcepub fn deleted(&self) -> Option<bool>
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.
Sourcepub fn endpoint(&self) -> Option<&str>
pub fn endpoint(&self) -> Option<&str>
Domain-specific endpoint used to submit index, search, and data upload requests to the domain.
Sourcepub fn endpoint_v2(&self) -> Option<&str>
pub fn endpoint_v2(&self) -> Option<&str>
If IPAddressType to set to dualstack, a version 2 domain endpoint is provisioned. This endpoint functions like a normal endpoint, except that it works with both IPv4 and IPv6 IP addresses. Normal endpoints work only with IPv4 IP addresses.
Sourcepub fn endpoints(&self) -> Option<&HashMap<String, String>>
pub fn endpoints(&self) -> Option<&HashMap<String, String>>
The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints. For example:
-
IPv4 IP addresses -
'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com' -
Dual stack IP addresses -
'vpcv2':'vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.aos.us-east-1.on.aws'
Sourcepub fn domain_endpoint_v2_hosted_zone_id(&self) -> Option<&str>
pub fn domain_endpoint_v2_hosted_zone_id(&self) -> Option<&str>
The dual stack hosted zone ID for the domain.
Sourcepub fn processing(&self) -> Option<bool>
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.
Sourcepub fn upgrade_processing(&self) -> Option<bool>
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.
Sourcepub fn engine_version(&self) -> Option<&str>
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.
Sourcepub fn cluster_config(&self) -> Option<&ClusterConfig>
pub fn cluster_config(&self) -> Option<&ClusterConfig>
Container for the cluster configuration of the domain.
Sourcepub fn ebs_options(&self) -> Option<&EbsOptions>
pub fn ebs_options(&self) -> Option<&EbsOptions>
Container for EBS-based storage settings for the domain.
Sourcepub fn access_policies(&self) -> Option<&str>
pub fn access_policies(&self) -> Option<&str>
Identity and Access Management (IAM) policy document specifying the access policies for the domain.
Sourcepub fn ip_address_type(&self) -> Option<&IpAddressType>
pub fn ip_address_type(&self) -> Option<&IpAddressType>
The type of IP addresses supported by the endpoint for the domain.
Sourcepub fn snapshot_options(&self) -> Option<&SnapshotOptions>
pub fn snapshot_options(&self) -> Option<&SnapshotOptions>
DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.
Sourcepub fn vpc_options(&self) -> Option<&VpcDerivedInfo>
pub fn vpc_options(&self) -> Option<&VpcDerivedInfo>
The VPC configuration for the domain.
Sourcepub fn cognito_options(&self) -> Option<&CognitoOptions>
pub fn cognito_options(&self) -> Option<&CognitoOptions>
Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.
Sourcepub fn encryption_at_rest_options(&self) -> Option<&EncryptionAtRestOptions>
pub fn encryption_at_rest_options(&self) -> Option<&EncryptionAtRestOptions>
Encryption at rest settings for the domain.
Sourcepub fn node_to_node_encryption_options(
&self,
) -> Option<&NodeToNodeEncryptionOptions>
pub fn node_to_node_encryption_options( &self, ) -> Option<&NodeToNodeEncryptionOptions>
Whether node-to-node encryption is enabled or disabled.
Sourcepub fn advanced_options(&self) -> Option<&HashMap<String, String>>
pub fn advanced_options(&self) -> Option<&HashMap<String, String>>
Key-value pairs that specify advanced configuration options.
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 domain.
Sourcepub fn service_software_options(&self) -> Option<&ServiceSoftwareOptions>
pub fn service_software_options(&self) -> Option<&ServiceSoftwareOptions>
The current status of the domain's service software.
Sourcepub fn domain_endpoint_options(&self) -> Option<&DomainEndpointOptions>
pub fn domain_endpoint_options(&self) -> Option<&DomainEndpointOptions>
Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
Sourcepub fn advanced_security_options(&self) -> Option<&AdvancedSecurityOptions>
pub fn advanced_security_options(&self) -> Option<&AdvancedSecurityOptions>
Settings for fine-grained access control.
Sourcepub fn identity_center_options(&self) -> Option<&IdentityCenterOptions>
pub fn identity_center_options(&self) -> Option<&IdentityCenterOptions>
Configuration options for controlling IAM Identity Center integration within a domain.
Sourcepub fn auto_tune_options(&self) -> Option<&AutoTuneOptionsOutput>
pub fn auto_tune_options(&self) -> Option<&AutoTuneOptionsOutput>
Auto-Tune settings for the domain.
Sourcepub fn change_progress_details(&self) -> Option<&ChangeProgressDetails>
pub fn change_progress_details(&self) -> Option<&ChangeProgressDetails>
Information about a configuration change happening on the domain.
Sourcepub fn off_peak_window_options(&self) -> Option<&OffPeakWindowOptions>
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.
Sourcepub fn software_update_options(&self) -> Option<&SoftwareUpdateOptions>
pub fn software_update_options(&self) -> Option<&SoftwareUpdateOptions>
Service software update options for the domain.
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().
Sourcepub fn aiml_options(&self) -> Option<&AimlOptionsOutput>
pub fn aiml_options(&self) -> Option<&AimlOptionsOutput>
Container for parameters required to enable all machine learning features.
Source§impl DomainStatus
impl DomainStatus
Sourcepub fn builder() -> DomainStatusBuilder
pub fn builder() -> DomainStatusBuilder
Creates a new builder-style object to manufacture DomainStatus.
Trait Implementations§
Source§impl Clone for DomainStatus
impl Clone for DomainStatus
Source§fn clone(&self) -> DomainStatus
fn clone(&self) -> DomainStatus
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for DomainStatus
impl Debug for DomainStatus
Source§impl PartialEq for DomainStatus
impl PartialEq for DomainStatus
impl StructuralPartialEq for DomainStatus
Auto Trait Implementations§
impl Freeze for DomainStatus
impl RefUnwindSafe for DomainStatus
impl Send for DomainStatus
impl Sync for DomainStatus
impl Unpin for DomainStatus
impl UnwindSafe for DomainStatus
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);