Struct aws_sdk_opensearch::operation::update_domain_config::UpdateDomainConfigInput

#[non_exhaustive]
pub struct UpdateDomainConfigInput {

    pub domain_name: Option<String>,
    pub cluster_config: Option<ClusterConfig>,
    pub ebs_options: Option<EbsOptions>,
    pub snapshot_options: Option<SnapshotOptions>,
    pub vpc_options: Option<VpcOptions>,
    pub cognito_options: Option<CognitoOptions>,
    pub advanced_options: Option<HashMap<String, String>>,
    pub access_policies: Option<String>,
    pub ip_address_type: Option<IpAddressType>,
    pub log_publishing_options: Option<HashMap<LogType, LogPublishingOption>>,
    pub encryption_at_rest_options: Option<EncryptionAtRestOptions>,
    pub domain_endpoint_options: Option<DomainEndpointOptions>,
    pub node_to_node_encryption_options: Option<NodeToNodeEncryptionOptions>,
    pub advanced_security_options: Option<AdvancedSecurityOptionsInput>,
    pub auto_tune_options: Option<AutoTuneOptions>,
    pub dry_run: Option<bool>,
    pub dry_run_mode: Option<DryRunMode>,
    pub off_peak_window_options: Option<OffPeakWindowOptions>,
    pub software_update_options: Option<SoftwareUpdateOptions>,
}

Container for the request parameters to the UpdateDomain 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 the domain that you're updating.

cluster_config: Option<ClusterConfig>

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

ebs_options: Option<EbsOptions>

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

snapshot_options: Option<SnapshotOptions>

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

vpc_options: Option<VpcOptions>

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.

cognito_options: Option<CognitoOptions>

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

advanced_options: Option<HashMap<String, String>>

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.

For more information, see Advanced cluster parameters.

access_policies: Option<String>

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

ip_address_type: Option<IpAddressType>

The type of IP addresses supported by the endpoint for the domain.

log_publishing_options: Option<HashMap<LogType, LogPublishingOption>>

Options to publish OpenSearch logs to Amazon CloudWatch Logs.

encryption_at_rest_options: Option<EncryptionAtRestOptions>

Encryption at rest options for the domain.

domain_endpoint_options: Option<DomainEndpointOptions>

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

node_to_node_encryption_options: Option<NodeToNodeEncryptionOptions>

Node-to-node encryption options for the domain.

advanced_security_options: Option<AdvancedSecurityOptionsInput>

Options for fine-grained access control.

auto_tune_options: Option<AutoTuneOptions>

Options for Auto-Tune.

dry_run: Option<bool>

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.

dry_run_mode: Option<DryRunMode>

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.

off_peak_window_options: Option<OffPeakWindowOptions>

Off-peak window options for the domain.

software_update_options: Option<SoftwareUpdateOptions>

Service software update options for the domain.

Implementations

impl UpdateDomainConfigInput

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

The name of the domain that you're updating.

pub fn cluster_config(&self) -> Option<&ClusterConfig>

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

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

pub fn snapshot_options(&self) -> Option<&SnapshotOptions>

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

pub fn vpc_options(&self) -> Option<&VpcOptions>

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

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

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

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.

For more information, see Advanced cluster parameters.

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

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

pub fn ip_address_type(&self) -> Option<&IpAddressType>

The type of IP addresses supported by the endpoint for the domain.

pub fn log_publishing_options( &self ) -> Option<&HashMap<LogType, LogPublishingOption>>

Options to publish OpenSearch logs to Amazon CloudWatch Logs.

pub fn encryption_at_rest_options(&self) -> Option<&EncryptionAtRestOptions>

Encryption at rest options for the domain.

pub fn domain_endpoint_options(&self) -> Option<&DomainEndpointOptions>

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

pub fn node_to_node_encryption_options( &self ) -> Option<&NodeToNodeEncryptionOptions>

Node-to-node encryption options for the domain.

pub fn advanced_security_options(&self) -> Option<&AdvancedSecurityOptionsInput>

Options for fine-grained access control.

pub fn auto_tune_options(&self) -> Option<&AutoTuneOptions>

Options for Auto-Tune.

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

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

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 off_peak_window_options(&self) -> Option<&OffPeakWindowOptions>

Off-peak window options for the domain.

pub fn software_update_options(&self) -> Option<&SoftwareUpdateOptions>

Service software update options for the domain.

impl UpdateDomainConfigInput

pub fn builder() -> UpdateDomainConfigInputBuilder

Creates a new builder-style object to manufacture UpdateDomainConfigInput.

Trait Implementations

impl Clone for UpdateDomainConfigInput

fn clone(&self) -> UpdateDomainConfigInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateDomainConfigInput

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

Formats the value using the given formatter.

impl PartialEq for UpdateDomainConfigInput

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for UpdateDomainConfigInput