Struct aws_sdk_opensearch::input::UpdateDomainConfigInput

#[non_exhaustive]
pub struct UpdateDomainConfigInput { /* private fields */ }

Container for the request parameters to the UpdateDomain operation.

Implementations

impl UpdateDomainConfigInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<UpdateDomainConfig, AwsResponseRetryClassifier>, BuildError>

Consumes the builder and constructs an Operation<UpdateDomainConfig>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture UpdateDomainConfigInput.

impl UpdateDomainConfigInput

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

The name of the domain that you're updating.

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.

pub fn ebs_options(&self) -> Option<&EbsOptions>

The type and size of the EBS volume to attach to instances in the domain.

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.

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.

pub fn cognito_options(&self) -> Option<&CognitoOptions>

Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.

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 a TooManyClauses error.

• "override_main_response_version": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether the domain reports its version as 7.10 to allow Elasticsearch OSS clients and plugins to continue working with it. Default is false when creating a domain and true when upgrading a domain.

For more information, see Advanced cluster parameters.

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

Identity and Access Management (IAM) access policy as a JSON-formatted string.

pub fn log_publishing_options(
    &self
) -> Option<&HashMap<LogType, LogPublishingOption>>

Options to publish OpenSearch lots to Amazon CloudWatch Logs.

pub fn encryption_at_rest_options(&self) -> Option<&EncryptionAtRestOptions>

Encryption at rest options for the domain.

pub fn domain_endpoint_options(&self) -> Option<&DomainEndpointOptions>

Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

pub fn node_to_node_encryption_options(
    &self
) -> Option<&NodeToNodeEncryptionOptions>

Node-To-Node Encryption options for the domain.

pub fn advanced_security_options(&self) -> Option<&AdvancedSecurityOptionsInput>

Options for fine-grained access control.

pub fn auto_tune_options(&self) -> Option<&AutoTuneOptions>

Options for Auto-Tune.

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.

pub fn dry_run_mode(&self) -> Option<&DryRunMode>

The type of dry run to perform.

• Basic only returns the type of deployment (blue/green or dynamic) that the update will cause.

• Verbose runs an additional check to validate the changes you're making. For more information, see Validating a domain update.

Trait Implementations

impl Clone for UpdateDomainConfigInput

fn clone(&self) -> UpdateDomainConfigInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UpdateDomainConfigInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<UpdateDomainConfigInput> for UpdateDomainConfigInput

fn eq(&self, other: &UpdateDomainConfigInput) -> 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 UpdateDomainConfigInput