Struct aws_sdk_opensearch::operation::update_domain_config::builders::UpdateDomainConfigInputBuilder

#[non_exhaustive]
pub struct UpdateDomainConfigInputBuilder { /* private fields */ }

A builder for UpdateDomainConfigInput.

Implementations

impl UpdateDomainConfigInputBuilder

pub fn domain_name(self, input: impl Into<String>) -> Self

The name of the domain that you're updating.

This field is required.

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

The name of the domain that you're updating.

pub fn get_domain_name(&self) -> &Option<String>

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 get_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, 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 get_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, 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 get_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, 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 get_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, 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 get_cognito_options(&self) -> &Option<CognitoOptions>

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

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.

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.

For more information, see Advanced cluster parameters.

pub fn get_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, 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 get_access_policies(&self) -> &Option<String>

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

pub fn ip_address_type(self, input: IpAddressType) -> Self

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

pub fn set_ip_address_type(self, input: Option<IpAddressType>) -> Self

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

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

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

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

Adds a key-value pair to log_publishing_options.

To override the contents of this collection use set_log_publishing_options.

Options to publish OpenSearch logs to Amazon CloudWatch Logs.

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

Options to publish OpenSearch logs to Amazon CloudWatch Logs.

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

Options to publish OpenSearch logs 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 get_encryption_at_rest_options(&self) -> &Option<EncryptionAtRestOptions>

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 get_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, 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 get_node_to_node_encryption_options( &self ) -> &Option<NodeToNodeEncryptionOptions>

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 get_advanced_security_options( &self ) -> &Option<AdvancedSecurityOptionsInput>

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 get_auto_tune_options(&self) -> &Option<AutoTuneOptions>

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 get_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, 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.

pub fn get_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, input: OffPeakWindowOptions) -> Self

Off-peak window options for the domain.

pub fn set_off_peak_window_options( self, input: Option<OffPeakWindowOptions> ) -> Self

Off-peak window options for the domain.

pub fn get_off_peak_window_options(&self) -> &Option<OffPeakWindowOptions>

Off-peak window options for the domain.

pub fn software_update_options(self, input: SoftwareUpdateOptions) -> Self

Service software update options for the domain.

pub fn set_software_update_options( self, input: Option<SoftwareUpdateOptions> ) -> Self

Service software update options for the domain.

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

Service software update options for the domain.

pub fn build(self) -> Result<UpdateDomainConfigInput, BuildError>

Consumes the builder and constructs a UpdateDomainConfigInput.

impl UpdateDomainConfigInputBuilder

pub async fn send_with( self, client: &Client ) -> Result<UpdateDomainConfigOutput, SdkError<UpdateDomainConfigError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for UpdateDomainConfigInputBuilder

fn clone(&self) -> UpdateDomainConfigInputBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateDomainConfigInputBuilder

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

Formats the value using the given formatter.

impl Default for UpdateDomainConfigInputBuilder

fn default() -> UpdateDomainConfigInputBuilder

Returns the “default value” for a type.

impl PartialEq for UpdateDomainConfigInputBuilder

fn eq(&self, other: &UpdateDomainConfigInputBuilder) -> 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 UpdateDomainConfigInputBuilder