Struct aws_sdk_opensearch::client::fluent_builders::UpgradeDomain

pub struct UpgradeDomain { /* private fields */ }

Fluent builder constructing a request to UpgradeDomain.

Allows you to either upgrade your domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.

Implementations

impl UpgradeDomain

pub async fn send(
    self
) -> Result<UpgradeDomainOutput, SdkError<UpgradeDomainError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn domain_name(self, input: impl Into<String>) -> Self

The name of an 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).

pub fn set_domain_name(self, input: Option<String>) -> Self

The name of an 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).

pub fn target_version(self, input: impl Into<String>) -> Self

The version of OpenSearch you intend to upgrade the domain to.

pub fn set_target_version(self, input: Option<String>) -> Self

The version of OpenSearch you intend to upgrade the domain to.

pub fn perform_check_only(self, input: bool) -> Self

When true, indicates that an upgrade eligibility check needs to be performed. Does not actually perform the upgrade.

pub fn set_perform_check_only(self, input: Option<bool>) -> Self

When true, indicates that an upgrade eligibility check needs to be performed. Does not actually perform the upgrade.

pub fn advanced_options(
    self,
    k: impl Into<String>,
    v: impl Into<String>
) -> Self

Adds a key-value pair to AdvancedOptions.

To override the contents of this collection use set_advanced_options.

Exposes select native OpenSearch configuration values from opensearch.yml. Currently, the following advanced options are available:

• Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Advanced cluster parameters for more information.
• Option to specify the percentage of heap space allocated to field data. By default, this setting is unbounded.

For more information, see Advanced cluster parameters.

pub fn set_advanced_options(
    self,
    input: Option<HashMap<String, String>>
) -> Self

Exposes select native OpenSearch configuration values from opensearch.yml. Currently, the following advanced options are available:

• Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Advanced cluster parameters for more information.
• Option to specify the percentage of heap space allocated to field data. By default, this setting is unbounded.

For more information, see Advanced cluster parameters.

Trait Implementations

impl Clone for UpgradeDomain

fn clone(&self) -> UpgradeDomain

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UpgradeDomain

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

Formats the value using the given formatter.