aws_sdk_elasticsearch/client/
upgrade_elasticsearch_domain.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`UpgradeElasticsearchDomain`](crate::operation::upgrade_elasticsearch_domain::builders::UpgradeElasticsearchDomainFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`domain_name(impl Into<String>)`](crate::operation::upgrade_elasticsearch_domain::builders::UpgradeElasticsearchDomainFluentBuilder::domain_name) / [`set_domain_name(Option<String>)`](crate::operation::upgrade_elasticsearch_domain::builders::UpgradeElasticsearchDomainFluentBuilder::set_domain_name):<br>required: **true**<br><p>The name of an Elasticsearch 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).</p><br>
7    ///   - [`target_version(impl Into<String>)`](crate::operation::upgrade_elasticsearch_domain::builders::UpgradeElasticsearchDomainFluentBuilder::target_version) / [`set_target_version(Option<String>)`](crate::operation::upgrade_elasticsearch_domain::builders::UpgradeElasticsearchDomainFluentBuilder::set_target_version):<br>required: **true**<br><p>The version of Elasticsearch that you intend to upgrade the domain to.</p><br>
8    ///   - [`perform_check_only(bool)`](crate::operation::upgrade_elasticsearch_domain::builders::UpgradeElasticsearchDomainFluentBuilder::perform_check_only) / [`set_perform_check_only(Option<bool>)`](crate::operation::upgrade_elasticsearch_domain::builders::UpgradeElasticsearchDomainFluentBuilder::set_perform_check_only):<br>required: **false**<br><p>This flag, when set to True, indicates that an Upgrade Eligibility Check needs to be performed. This will not actually perform the Upgrade.</p><br>
9    /// - On success, responds with [`UpgradeElasticsearchDomainOutput`](crate::operation::upgrade_elasticsearch_domain::UpgradeElasticsearchDomainOutput) with field(s):
10    ///   - [`domain_name(Option<String>)`](crate::operation::upgrade_elasticsearch_domain::UpgradeElasticsearchDomainOutput::domain_name): <p>The name of an Elasticsearch 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).</p>
11    ///   - [`target_version(Option<String>)`](crate::operation::upgrade_elasticsearch_domain::UpgradeElasticsearchDomainOutput::target_version): <p>The version of Elasticsearch that you intend to upgrade the domain to.</p>
12    ///   - [`perform_check_only(Option<bool>)`](crate::operation::upgrade_elasticsearch_domain::UpgradeElasticsearchDomainOutput::perform_check_only): <p>This flag, when set to True, indicates that an Upgrade Eligibility Check needs to be performed. This will not actually perform the Upgrade.</p>
13    ///   - [`change_progress_details(Option<ChangeProgressDetails>)`](crate::operation::upgrade_elasticsearch_domain::UpgradeElasticsearchDomainOutput::change_progress_details): <p>Specifies change details of the domain configuration change.</p>
14    /// - On failure, responds with [`SdkError<UpgradeElasticsearchDomainError>`](crate::operation::upgrade_elasticsearch_domain::UpgradeElasticsearchDomainError)
15    pub fn upgrade_elasticsearch_domain(&self) -> crate::operation::upgrade_elasticsearch_domain::builders::UpgradeElasticsearchDomainFluentBuilder {
16        crate::operation::upgrade_elasticsearch_domain::builders::UpgradeElasticsearchDomainFluentBuilder::new(self.handle.clone())
17    }
18}