Struct aws_sdk_opensearch::input::UpgradeDomainInput

#[non_exhaustive]
pub struct UpgradeDomainInput {
    pub domain_name: Option<String>,
    pub target_version: Option<String>,
    pub perform_check_only: Option<bool>,
    pub advanced_options: Option<HashMap<String, String>>,
}

Container for the request parameters to UpgradeDomain operation.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

domain_name: Option<String>

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).

target_version: Option<String>

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

perform_check_only: Option<bool>

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

advanced_options: Option<HashMap<String, String>>

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.

Implementations

impl UpgradeDomainInput

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

Consumes the builder and constructs an Operation<UpgradeDomain>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture UpgradeDomainInput

impl UpgradeDomainInput

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

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) -> Option<&str>

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

pub fn perform_check_only(&self) -> Option<bool>

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

pub fn advanced_options(&self) -> Option<&HashMap<String, String>>

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 UpgradeDomainInput

fn clone(&self) -> UpgradeDomainInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UpgradeDomainInput

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

Formats the value using the given formatter.

impl PartialEq<UpgradeDomainInput> for UpgradeDomainInput

fn eq(&self, other: &UpgradeDomainInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &UpgradeDomainInput) -> bool

This method tests for !=.

impl StructuralPartialEq for UpgradeDomainInput