Struct aws_sdk_opensearch::output::UpgradeDomainOutput

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

Container for response returned by 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.

upgrade_id: Option<String>

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

change_progress_details: Option<ChangeProgressDetails>

Specifies change details of the domain configuration change.

Implementations

impl UpgradeDomainOutput

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

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

pub fn change_progress_details(&self) -> Option<&ChangeProgressDetails>

Specifies change details of the domain configuration change.

impl UpgradeDomainOutput

pub fn builder() -> Builder

Creates a new builder-style object to manufacture UpgradeDomainOutput

Trait Implementations

impl Clone for UpgradeDomainOutput

fn clone(&self) -> UpgradeDomainOutput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UpgradeDomainOutput

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

Formats the value using the given formatter.

impl PartialEq<UpgradeDomainOutput> for UpgradeDomainOutput

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

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

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

This method tests for !=.

impl StructuralPartialEq for UpgradeDomainOutput