#[non_exhaustive]pub struct DomainConfig {Show 21 fields
pub engine_version: Option<VersionStatus>,
pub cluster_config: Option<ClusterConfigStatus>,
pub ebs_options: Option<EbsOptionsStatus>,
pub access_policies: Option<AccessPoliciesStatus>,
pub ip_address_type: Option<IpAddressTypeStatus>,
pub snapshot_options: Option<SnapshotOptionsStatus>,
pub vpc_options: Option<VpcDerivedInfoStatus>,
pub cognito_options: Option<CognitoOptionsStatus>,
pub encryption_at_rest_options: Option<EncryptionAtRestOptionsStatus>,
pub node_to_node_encryption_options: Option<NodeToNodeEncryptionOptionsStatus>,
pub advanced_options: Option<AdvancedOptionsStatus>,
pub log_publishing_options: Option<LogPublishingOptionsStatus>,
pub domain_endpoint_options: Option<DomainEndpointOptionsStatus>,
pub advanced_security_options: Option<AdvancedSecurityOptionsStatus>,
pub identity_center_options: Option<IdentityCenterOptionsStatus>,
pub auto_tune_options: Option<AutoTuneOptionsStatus>,
pub change_progress_details: Option<ChangeProgressDetails>,
pub off_peak_window_options: Option<OffPeakWindowOptionsStatus>,
pub software_update_options: Option<SoftwareUpdateOptionsStatus>,
pub modifying_properties: Option<Vec<ModifyingProperties>>,
pub aiml_options: Option<AimlOptionsStatus>,
}
Expand description
Container for the configuration 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.engine_version: Option<VersionStatus>
The OpenSearch or Elasticsearch version that the domain is running.
cluster_config: Option<ClusterConfigStatus>
Container for the cluster configuration of a the domain.
ebs_options: Option<EbsOptionsStatus>
Container for EBS options configured for the domain.
access_policies: Option<AccessPoliciesStatus>
Specifies the access policies for the domain.
ip_address_type: Option<IpAddressTypeStatus>
Choose either dual stack or IPv4 as your IP address type. Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option. If you set your IP address type to dual stack, you can't change your address type later.
snapshot_options: Option<SnapshotOptionsStatus>
DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.
vpc_options: Option<VpcDerivedInfoStatus>
The current VPC options for the domain and the status of any updates to their configuration.
cognito_options: Option<CognitoOptionsStatus>
Container for Amazon Cognito options for the domain.
encryption_at_rest_options: Option<EncryptionAtRestOptionsStatus>
Key-value pairs to enable encryption at rest.
node_to_node_encryption_options: Option<NodeToNodeEncryptionOptionsStatus>
Whether node-to-node encryption is enabled or disabled.
advanced_options: Option<AdvancedOptionsStatus>
Key-value pairs to specify advanced configuration options. For more information, see Advanced options.
log_publishing_options: Option<LogPublishingOptionsStatus>
Key-value pairs to configure log publishing.
domain_endpoint_options: Option<DomainEndpointOptionsStatus>
Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
advanced_security_options: Option<AdvancedSecurityOptionsStatus>
Container for fine-grained access control settings for the domain.
identity_center_options: Option<IdentityCenterOptionsStatus>
Configuration options for enabling and managing IAM Identity Center integration within a domain.
auto_tune_options: Option<AutoTuneOptionsStatus>
Container for Auto-Tune settings for the domain.
change_progress_details: Option<ChangeProgressDetails>
Container for information about the progress of an existing configuration change.
off_peak_window_options: Option<OffPeakWindowOptionsStatus>
Container for off-peak window options for the domain.
software_update_options: Option<SoftwareUpdateOptionsStatus>
Software update options for the domain.
modifying_properties: Option<Vec<ModifyingProperties>>
Information about the domain properties that are currently being modified.
aiml_options: Option<AimlOptionsStatus>
Container for parameters required to enable all machine learning features.
Implementations§
Source§impl DomainConfig
impl DomainConfig
Sourcepub fn engine_version(&self) -> Option<&VersionStatus>
pub fn engine_version(&self) -> Option<&VersionStatus>
The OpenSearch or Elasticsearch version that the domain is running.
Sourcepub fn cluster_config(&self) -> Option<&ClusterConfigStatus>
pub fn cluster_config(&self) -> Option<&ClusterConfigStatus>
Container for the cluster configuration of a the domain.
Sourcepub fn ebs_options(&self) -> Option<&EbsOptionsStatus>
pub fn ebs_options(&self) -> Option<&EbsOptionsStatus>
Container for EBS options configured for the domain.
Sourcepub fn access_policies(&self) -> Option<&AccessPoliciesStatus>
pub fn access_policies(&self) -> Option<&AccessPoliciesStatus>
Specifies the access policies for the domain.
Sourcepub fn ip_address_type(&self) -> Option<&IpAddressTypeStatus>
pub fn ip_address_type(&self) -> Option<&IpAddressTypeStatus>
Choose either dual stack or IPv4 as your IP address type. Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option. If you set your IP address type to dual stack, you can't change your address type later.
Sourcepub fn snapshot_options(&self) -> Option<&SnapshotOptionsStatus>
pub fn snapshot_options(&self) -> Option<&SnapshotOptionsStatus>
DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.
Sourcepub fn vpc_options(&self) -> Option<&VpcDerivedInfoStatus>
pub fn vpc_options(&self) -> Option<&VpcDerivedInfoStatus>
The current VPC options for the domain and the status of any updates to their configuration.
Sourcepub fn cognito_options(&self) -> Option<&CognitoOptionsStatus>
pub fn cognito_options(&self) -> Option<&CognitoOptionsStatus>
Container for Amazon Cognito options for the domain.
Sourcepub fn encryption_at_rest_options(
&self,
) -> Option<&EncryptionAtRestOptionsStatus>
pub fn encryption_at_rest_options( &self, ) -> Option<&EncryptionAtRestOptionsStatus>
Key-value pairs to enable encryption at rest.
Sourcepub fn node_to_node_encryption_options(
&self,
) -> Option<&NodeToNodeEncryptionOptionsStatus>
pub fn node_to_node_encryption_options( &self, ) -> Option<&NodeToNodeEncryptionOptionsStatus>
Whether node-to-node encryption is enabled or disabled.
Sourcepub fn advanced_options(&self) -> Option<&AdvancedOptionsStatus>
pub fn advanced_options(&self) -> Option<&AdvancedOptionsStatus>
Key-value pairs to specify advanced configuration options. For more information, see Advanced options.
Sourcepub fn log_publishing_options(&self) -> Option<&LogPublishingOptionsStatus>
pub fn log_publishing_options(&self) -> Option<&LogPublishingOptionsStatus>
Key-value pairs to configure log publishing.
Sourcepub fn domain_endpoint_options(&self) -> Option<&DomainEndpointOptionsStatus>
pub fn domain_endpoint_options(&self) -> Option<&DomainEndpointOptionsStatus>
Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
Sourcepub fn advanced_security_options(
&self,
) -> Option<&AdvancedSecurityOptionsStatus>
pub fn advanced_security_options( &self, ) -> Option<&AdvancedSecurityOptionsStatus>
Container for fine-grained access control settings for the domain.
Sourcepub fn identity_center_options(&self) -> Option<&IdentityCenterOptionsStatus>
pub fn identity_center_options(&self) -> Option<&IdentityCenterOptionsStatus>
Configuration options for enabling and managing IAM Identity Center integration within a domain.
Sourcepub fn auto_tune_options(&self) -> Option<&AutoTuneOptionsStatus>
pub fn auto_tune_options(&self) -> Option<&AutoTuneOptionsStatus>
Container for Auto-Tune settings for the domain.
Sourcepub fn change_progress_details(&self) -> Option<&ChangeProgressDetails>
pub fn change_progress_details(&self) -> Option<&ChangeProgressDetails>
Container for information about the progress of an existing configuration change.
Sourcepub fn off_peak_window_options(&self) -> Option<&OffPeakWindowOptionsStatus>
pub fn off_peak_window_options(&self) -> Option<&OffPeakWindowOptionsStatus>
Container for off-peak window options for the domain.
Sourcepub fn software_update_options(&self) -> Option<&SoftwareUpdateOptionsStatus>
pub fn software_update_options(&self) -> Option<&SoftwareUpdateOptionsStatus>
Software update options 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<&AimlOptionsStatus>
pub fn aiml_options(&self) -> Option<&AimlOptionsStatus>
Container for parameters required to enable all machine learning features.
Source§impl DomainConfig
impl DomainConfig
Sourcepub fn builder() -> DomainConfigBuilder
pub fn builder() -> DomainConfigBuilder
Creates a new builder-style object to manufacture DomainConfig
.
Trait Implementations§
Source§impl Clone for DomainConfig
impl Clone for DomainConfig
Source§fn clone(&self) -> DomainConfig
fn clone(&self) -> DomainConfig
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 DomainConfig
impl Debug for DomainConfig
Source§impl PartialEq for DomainConfig
impl PartialEq for DomainConfig
impl StructuralPartialEq for DomainConfig
Auto Trait Implementations§
impl Freeze for DomainConfig
impl RefUnwindSafe for DomainConfig
impl Send for DomainConfig
impl Sync for DomainConfig
impl Unpin for DomainConfig
impl UnwindSafe for DomainConfig
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);