pub struct Builder { /* private fields */ }
Expand description
A builder for UpdateDomainConfigInput
.
Implementations§
source§impl Builder
impl Builder
sourcepub fn domain_name(self, input: impl Into<String>) -> Self
pub fn domain_name(self, input: impl Into<String>) -> Self
The name of the domain that you're updating.
sourcepub fn set_domain_name(self, input: Option<String>) -> Self
pub fn set_domain_name(self, input: Option<String>) -> Self
The name of the domain that you're updating.
sourcepub fn cluster_config(self, input: ClusterConfig) -> Self
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.
sourcepub fn set_cluster_config(self, input: Option<ClusterConfig>) -> Self
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.
sourcepub fn ebs_options(self, input: EbsOptions) -> Self
pub fn ebs_options(self, input: EbsOptions) -> Self
The type and size of the EBS volume to attach to instances in the domain.
sourcepub fn set_ebs_options(self, input: Option<EbsOptions>) -> Self
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.
sourcepub fn snapshot_options(self, input: SnapshotOptions) -> Self
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.
sourcepub fn set_snapshot_options(self, input: Option<SnapshotOptions>) -> Self
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.
sourcepub fn vpc_options(self, input: VpcOptions) -> Self
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.
sourcepub fn set_vpc_options(self, input: Option<VpcOptions>) -> Self
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.
sourcepub fn cognito_options(self, input: CognitoOptions) -> Self
pub fn cognito_options(self, input: CognitoOptions) -> Self
Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.
sourcepub fn set_cognito_options(self, input: Option<CognitoOptions>) -> Self
pub fn set_cognito_options(self, input: Option<CognitoOptions>) -> Self
Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.
sourcepub fn advanced_options(self, k: impl Into<String>, v: impl Into<String>) -> Self
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 aTooManyClauses
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.
sourcepub fn set_advanced_options(self, input: Option<HashMap<String, String>>) -> Self
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 aTooManyClauses
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.
sourcepub fn access_policies(self, input: impl Into<String>) -> Self
pub fn access_policies(self, input: impl Into<String>) -> Self
Identity and Access Management (IAM) access policy as a JSON-formatted string.
sourcepub fn set_access_policies(self, input: Option<String>) -> Self
pub fn set_access_policies(self, input: Option<String>) -> Self
Identity and Access Management (IAM) access policy as a JSON-formatted string.
sourcepub fn log_publishing_options(self, k: LogType, v: LogPublishingOption) -> Self
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 lots to Amazon CloudWatch Logs.
sourcepub fn set_log_publishing_options(
self,
input: Option<HashMap<LogType, LogPublishingOption>>
) -> Self
pub fn set_log_publishing_options(
self,
input: Option<HashMap<LogType, LogPublishingOption>>
) -> Self
Options to publish OpenSearch lots to Amazon CloudWatch Logs.
sourcepub fn encryption_at_rest_options(self, input: EncryptionAtRestOptions) -> Self
pub fn encryption_at_rest_options(self, input: EncryptionAtRestOptions) -> Self
Encryption at rest options for the domain.
sourcepub fn set_encryption_at_rest_options(
self,
input: Option<EncryptionAtRestOptions>
) -> Self
pub fn set_encryption_at_rest_options(
self,
input: Option<EncryptionAtRestOptions>
) -> Self
Encryption at rest options for the domain.
sourcepub fn domain_endpoint_options(self, input: DomainEndpointOptions) -> Self
pub fn domain_endpoint_options(self, input: DomainEndpointOptions) -> Self
Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
sourcepub fn set_domain_endpoint_options(
self,
input: Option<DomainEndpointOptions>
) -> Self
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.
sourcepub fn node_to_node_encryption_options(
self,
input: NodeToNodeEncryptionOptions
) -> Self
pub fn node_to_node_encryption_options(
self,
input: NodeToNodeEncryptionOptions
) -> Self
Node-To-Node Encryption options for the domain.
sourcepub fn set_node_to_node_encryption_options(
self,
input: Option<NodeToNodeEncryptionOptions>
) -> Self
pub fn set_node_to_node_encryption_options(
self,
input: Option<NodeToNodeEncryptionOptions>
) -> Self
Node-To-Node Encryption options for the domain.
sourcepub fn advanced_security_options(
self,
input: AdvancedSecurityOptionsInput
) -> Self
pub fn advanced_security_options(
self,
input: AdvancedSecurityOptionsInput
) -> Self
Options for fine-grained access control.
sourcepub fn set_advanced_security_options(
self,
input: Option<AdvancedSecurityOptionsInput>
) -> Self
pub fn set_advanced_security_options(
self,
input: Option<AdvancedSecurityOptionsInput>
) -> Self
Options for fine-grained access control.
sourcepub fn auto_tune_options(self, input: AutoTuneOptions) -> Self
pub fn auto_tune_options(self, input: AutoTuneOptions) -> Self
Options for Auto-Tune.
sourcepub fn set_auto_tune_options(self, input: Option<AutoTuneOptions>) -> Self
pub fn set_auto_tune_options(self, input: Option<AutoTuneOptions>) -> Self
Options for Auto-Tune.
sourcepub fn dry_run(self, input: bool) -> Self
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.
sourcepub fn set_dry_run(self, input: Option<bool>) -> Self
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.
sourcepub fn dry_run_mode(self, input: DryRunMode) -> Self
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.
sourcepub fn set_dry_run_mode(self, input: Option<DryRunMode>) -> Self
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.
sourcepub fn build(self) -> Result<UpdateDomainConfigInput, BuildError>
pub fn build(self) -> Result<UpdateDomainConfigInput, BuildError>
Consumes the builder and constructs a UpdateDomainConfigInput
.