Struct aws_sdk_opensearch::client::fluent_builders::UpdateDomainConfig

pub struct UpdateDomainConfig { /* private fields */ }

Fluent builder constructing a request to UpdateDomainConfig.

Modifies the cluster configuration of the specified Amazon OpenSearch Service domain.

Implementations

impl UpdateDomainConfig

pub async fn customize(
    self
) -> Result<CustomizableOperation<UpdateDomainConfig, AwsResponseRetryClassifier>, SdkError<UpdateDomainConfigError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<UpdateDomainConfigOutput, SdkError<UpdateDomainConfigError>>

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 the domain that you're updating.

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

The name of the domain that you're updating.

pub fn cluster_config(self, input: ClusterConfig) -> Self

Changes that you want to make to the cluster configuration, such as the instance type and number of EC2 instances.

pub fn set_cluster_config(self, input: Option<ClusterConfig>) -> Self

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, input: EbsOptions) -> Self

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

pub fn set_ebs_options(self, input: Option<EbsOptions>) -> Self

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

pub fn snapshot_options(self, input: SnapshotOptions) -> Self

Option to set the time, in UTC format, for the daily automated snapshot. Default value is 0 hours.

pub fn set_snapshot_options(self, input: Option<SnapshotOptions>) -> Self

Option to set the time, in UTC format, for the daily automated snapshot. Default value is 0 hours.

pub fn vpc_options(self, input: VpcOptions) -> Self

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 set_vpc_options(self, input: Option<VpcOptions>) -> Self

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, input: CognitoOptions) -> Self

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

pub fn set_cognito_options(self, input: Option<CognitoOptions>) -> Self

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

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.

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 set_advanced_options(self, input: Option<HashMap<String, String>>) -> Self

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, input: impl Into<String>) -> Self

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

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

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

pub fn log_publishing_options(self, k: LogType, v: LogPublishingOption) -> Self

Adds a key-value pair to LogPublishingOptions.

To override the contents of this collection use set_log_publishing_options.

Options to publish OpenSearch lots to Amazon CloudWatch Logs.

pub fn set_log_publishing_options(
    self,
    input: Option<HashMap<LogType, LogPublishingOption>>
) -> Self

Options to publish OpenSearch lots to Amazon CloudWatch Logs.

pub fn encryption_at_rest_options(self, input: EncryptionAtRestOptions) -> Self

Encryption at rest options for the domain.

pub fn set_encryption_at_rest_options(
    self,
    input: Option<EncryptionAtRestOptions>
) -> Self

Encryption at rest options for the domain.

pub fn domain_endpoint_options(self, input: DomainEndpointOptions) -> Self

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

pub fn set_domain_endpoint_options(
    self,
    input: Option<DomainEndpointOptions>
) -> Self

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

pub fn node_to_node_encryption_options(
    self,
    input: NodeToNodeEncryptionOptions
) -> Self

Node-To-Node Encryption options for the domain.

pub fn set_node_to_node_encryption_options(
    self,
    input: Option<NodeToNodeEncryptionOptions>
) -> Self

Node-To-Node Encryption options for the domain.

pub fn advanced_security_options(
    self,
    input: AdvancedSecurityOptionsInput
) -> Self

Options for fine-grained access control.

pub fn set_advanced_security_options(
    self,
    input: Option<AdvancedSecurityOptionsInput>
) -> Self

Options for fine-grained access control.

pub fn auto_tune_options(self, input: AutoTuneOptions) -> Self

Options for Auto-Tune.

pub fn set_auto_tune_options(self, input: Option<AutoTuneOptions>) -> Self

Options for Auto-Tune.

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

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 set_dry_run(self, input: Option<bool>) -> Self

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, input: DryRunMode) -> Self

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.

pub fn set_dry_run_mode(self, input: Option<DryRunMode>) -> Self

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 UpdateDomainConfig

fn clone(&self) -> UpdateDomainConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateDomainConfig

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

Formats the value using the given formatter.