#[non_exhaustive]pub struct UpdateDomainConfigInput {Show 21 fields
pub domain_name: Option<String>,
pub cluster_config: Option<ClusterConfig>,
pub ebs_options: Option<EbsOptions>,
pub snapshot_options: Option<SnapshotOptions>,
pub vpc_options: Option<VpcOptions>,
pub cognito_options: Option<CognitoOptions>,
pub advanced_options: Option<HashMap<String, String>>,
pub access_policies: Option<String>,
pub ip_address_type: Option<IpAddressType>,
pub log_publishing_options: Option<HashMap<LogType, LogPublishingOption>>,
pub encryption_at_rest_options: Option<EncryptionAtRestOptions>,
pub domain_endpoint_options: Option<DomainEndpointOptions>,
pub node_to_node_encryption_options: Option<NodeToNodeEncryptionOptions>,
pub advanced_security_options: Option<AdvancedSecurityOptionsInput>,
pub identity_center_options: Option<IdentityCenterOptionsInput>,
pub auto_tune_options: Option<AutoTuneOptions>,
pub dry_run: Option<bool>,
pub dry_run_mode: Option<DryRunMode>,
pub off_peak_window_options: Option<OffPeakWindowOptions>,
pub software_update_options: Option<SoftwareUpdateOptions>,
pub aiml_options: Option<AimlOptionsInput>,
}Expand description
Container for the request parameters to the UpdateDomain operation.
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_name: Option<String>The name of the domain that you're updating.
cluster_config: Option<ClusterConfig>Changes that you want to make to the cluster configuration, such as the instance type and number of EC2 instances.
ebs_options: Option<EbsOptions>The type and size of the EBS volume to attach to instances in the domain.
snapshot_options: Option<SnapshotOptions>Option to set the time, in UTC format, for the daily automated snapshot. Default value is 0 hours.
vpc_options: Option<VpcOptions>Options to specify the subnets and security groups for a VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.
cognito_options: Option<CognitoOptions>Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.
advanced_options: Option<HashMap<String, String>>Key-value pairs to specify advanced configuration options. The following key-value pairs are supported:
-
"rest.action.multi.allow_explicit_index": "true" | "false"- Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true. -
"indices.fielddata.cache.size": "80"- Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded. -
"indices.query.bool.max_clause_count": "1024"- Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in aTooManyClauseserror.
For more information, see Advanced cluster parameters.
access_policies: Option<String>Identity and Access Management (IAM) access policy as a JSON-formatted string.
ip_address_type: Option<IpAddressType>Specify 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 your IP address type is currently set to dual stack, you can't change it.
log_publishing_options: Option<HashMap<LogType, LogPublishingOption>>Options to publish OpenSearch logs to Amazon CloudWatch Logs.
encryption_at_rest_options: Option<EncryptionAtRestOptions>Encryption at rest options for the domain.
domain_endpoint_options: Option<DomainEndpointOptions>Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
node_to_node_encryption_options: Option<NodeToNodeEncryptionOptions>Node-to-node encryption options for the domain.
advanced_security_options: Option<AdvancedSecurityOptionsInput>Options for fine-grained access control.
identity_center_options: Option<IdentityCenterOptionsInput>Configuration settings for enabling and managing IAM Identity Center.
auto_tune_options: Option<AutoTuneOptions>Options for Auto-Tune.
dry_run: Option<bool>This flag, when set to True, specifies whether the UpdateDomain request should return the results of a dry run analysis without actually applying the change. A dry run determines what type of deployment the update will cause.
dry_run_mode: Option<DryRunMode>The type of dry run to perform.
-
Basiconly returns the type of deployment (blue/green or dynamic) that the update will cause. -
Verboseruns an additional check to validate the changes you're making. For more information, see Validating a domain update.
off_peak_window_options: Option<OffPeakWindowOptions>Off-peak window options for the domain.
software_update_options: Option<SoftwareUpdateOptions>Service software update options for the domain.
aiml_options: Option<AimlOptionsInput>Options for all machine learning features for the specified domain.
Implementations§
Source§impl UpdateDomainConfigInput
impl UpdateDomainConfigInput
Sourcepub fn domain_name(&self) -> Option<&str>
pub fn domain_name(&self) -> Option<&str>
The name of the domain that you're updating.
Sourcepub fn cluster_config(&self) -> Option<&ClusterConfig>
pub fn cluster_config(&self) -> Option<&ClusterConfig>
Changes that you want to make to the cluster configuration, such as the instance type and number of EC2 instances.
Sourcepub fn ebs_options(&self) -> Option<&EbsOptions>
pub fn ebs_options(&self) -> Option<&EbsOptions>
The type and size of the EBS volume to attach to instances in the domain.
Sourcepub fn snapshot_options(&self) -> Option<&SnapshotOptions>
pub fn snapshot_options(&self) -> Option<&SnapshotOptions>
Option to set the time, in UTC format, for the daily automated snapshot. Default value is 0 hours.
Sourcepub fn vpc_options(&self) -> Option<&VpcOptions>
pub fn vpc_options(&self) -> Option<&VpcOptions>
Options to specify the subnets and security groups for a VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.
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 advanced_options(&self) -> Option<&HashMap<String, String>>
pub fn advanced_options(&self) -> Option<&HashMap<String, String>>
Key-value pairs to specify advanced configuration options. The following key-value pairs are supported:
-
"rest.action.multi.allow_explicit_index": "true" | "false"- Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true. -
"indices.fielddata.cache.size": "80"- Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded. -
"indices.query.bool.max_clause_count": "1024"- Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in aTooManyClauseserror.
For more information, see Advanced cluster parameters.
Sourcepub fn access_policies(&self) -> Option<&str>
pub fn access_policies(&self) -> Option<&str>
Identity and Access Management (IAM) access policy as a JSON-formatted string.
Sourcepub fn ip_address_type(&self) -> Option<&IpAddressType>
pub fn ip_address_type(&self) -> Option<&IpAddressType>
Specify 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 your IP address type is currently set to dual stack, you can't change it.
Sourcepub fn log_publishing_options(
&self,
) -> Option<&HashMap<LogType, LogPublishingOption>>
pub fn log_publishing_options( &self, ) -> Option<&HashMap<LogType, LogPublishingOption>>
Options to publish OpenSearch logs to Amazon CloudWatch Logs.
Sourcepub fn encryption_at_rest_options(&self) -> Option<&EncryptionAtRestOptions>
pub fn encryption_at_rest_options(&self) -> Option<&EncryptionAtRestOptions>
Encryption at rest options for the domain.
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 node_to_node_encryption_options(
&self,
) -> Option<&NodeToNodeEncryptionOptions>
pub fn node_to_node_encryption_options( &self, ) -> Option<&NodeToNodeEncryptionOptions>
Node-to-node encryption options for the domain.
Sourcepub fn advanced_security_options(&self) -> Option<&AdvancedSecurityOptionsInput>
pub fn advanced_security_options(&self) -> Option<&AdvancedSecurityOptionsInput>
Options for fine-grained access control.
Sourcepub fn identity_center_options(&self) -> Option<&IdentityCenterOptionsInput>
pub fn identity_center_options(&self) -> Option<&IdentityCenterOptionsInput>
Configuration settings for enabling and managing IAM Identity Center.
Sourcepub fn auto_tune_options(&self) -> Option<&AutoTuneOptions>
pub fn auto_tune_options(&self) -> Option<&AutoTuneOptions>
Options for Auto-Tune.
Sourcepub fn dry_run(&self) -> Option<bool>
pub fn dry_run(&self) -> Option<bool>
This flag, when set to True, specifies whether the UpdateDomain request should return the results of a dry run analysis without actually applying the change. A dry run determines what type of deployment the update will cause.
Sourcepub fn dry_run_mode(&self) -> Option<&DryRunMode>
pub fn dry_run_mode(&self) -> Option<&DryRunMode>
The type of dry run to perform.
-
Basiconly returns the type of deployment (blue/green or dynamic) that the update will cause. -
Verboseruns an additional check to validate the changes you're making. For more information, see Validating a domain update.
Sourcepub fn off_peak_window_options(&self) -> Option<&OffPeakWindowOptions>
pub fn off_peak_window_options(&self) -> Option<&OffPeakWindowOptions>
Off-peak window options for 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 aiml_options(&self) -> Option<&AimlOptionsInput>
pub fn aiml_options(&self) -> Option<&AimlOptionsInput>
Options for all machine learning features for the specified domain.
Source§impl UpdateDomainConfigInput
impl UpdateDomainConfigInput
Sourcepub fn builder() -> UpdateDomainConfigInputBuilder
pub fn builder() -> UpdateDomainConfigInputBuilder
Creates a new builder-style object to manufacture UpdateDomainConfigInput.
Trait Implementations§
Source§impl Clone for UpdateDomainConfigInput
impl Clone for UpdateDomainConfigInput
Source§fn clone(&self) -> UpdateDomainConfigInput
fn clone(&self) -> UpdateDomainConfigInput
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 UpdateDomainConfigInput
impl Debug for UpdateDomainConfigInput
Source§impl PartialEq for UpdateDomainConfigInput
impl PartialEq for UpdateDomainConfigInput
Source§fn eq(&self, other: &UpdateDomainConfigInput) -> bool
fn eq(&self, other: &UpdateDomainConfigInput) -> bool
self and other values to be equal, and is used by ==.impl StructuralPartialEq for UpdateDomainConfigInput
Auto Trait Implementations§
impl Freeze for UpdateDomainConfigInput
impl RefUnwindSafe for UpdateDomainConfigInput
impl Send for UpdateDomainConfigInput
impl Sync for UpdateDomainConfigInput
impl Unpin for UpdateDomainConfigInput
impl UnwindSafe for UpdateDomainConfigInput
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);