Struct ElasticsearchSettings

#[non_exhaustive]
pub struct ElasticsearchSettings {
    pub service_access_role_arn: String,
    pub endpoint_uri: String,
    pub full_load_error_percentage: Option<i32>,
    pub error_retry_duration: Option<i32>,
    pub use_new_mapping_type: Option<bool>,
}

Provides information that defines an OpenSearch endpoint.

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.

service_access_role_arn: String

The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the iam:PassRole action.

endpoint_uri: String

The endpoint for the OpenSearch cluster. DMS uses HTTPS if a transport protocol (http/https) is not specified.

full_load_error_percentage: Option<i32>

The maximum percentage of records that can fail to be written before a full load operation stops.

To avoid early failure, this counter is only effective after 1000 records are transferred. OpenSearch also has the concept of error monitoring during the last 10 minutes of an Observation Window. If transfer of all records fail in the last 10 minutes, the full load operation stops.

error_retry_duration: Option<i32>

The maximum number of seconds for which DMS retries failed API requests to the OpenSearch cluster.

use_new_mapping_type: Option<bool>

Set this option to true for DMS to migrate documentation using the documentation type _doc. OpenSearch and an Elasticsearch cluster only support the _doc documentation type in versions 7. x and later. The default value is false.

Implementations

impl ElasticsearchSettings

pub fn service_access_role_arn(&self) -> &str

The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the iam:PassRole action.

pub fn endpoint_uri(&self) -> &str

The endpoint for the OpenSearch cluster. DMS uses HTTPS if a transport protocol (http/https) is not specified.

pub fn full_load_error_percentage(&self) -> Option<i32>

The maximum percentage of records that can fail to be written before a full load operation stops.

To avoid early failure, this counter is only effective after 1000 records are transferred. OpenSearch also has the concept of error monitoring during the last 10 minutes of an Observation Window. If transfer of all records fail in the last 10 minutes, the full load operation stops.

pub fn error_retry_duration(&self) -> Option<i32>

The maximum number of seconds for which DMS retries failed API requests to the OpenSearch cluster.

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

Set this option to true for DMS to migrate documentation using the documentation type _doc. OpenSearch and an Elasticsearch cluster only support the _doc documentation type in versions 7. x and later. The default value is false.

impl ElasticsearchSettings

pub fn builder() -> ElasticsearchSettingsBuilder

Creates a new builder-style object to manufacture ElasticsearchSettings.

Trait Implementations

impl Clone for ElasticsearchSettings

fn clone(&self) -> ElasticsearchSettings

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ElasticsearchSettings

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

Formats the value using the given formatter.

impl PartialEq for ElasticsearchSettings

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for ElasticsearchSettings