Skip to content

ElasticsearchSettings

Used by
Source code in docs_src/capo_database_migration_service/types/elasticsearch_settings.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
class ElasticsearchSettings(TypedDict, closed=True):
    service_access_role_arn: "capo_database_migration_service.types.string.String"
    """<p>The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the <code>iam:PassRole</code> action.</p>"""
    endpoint_uri: "capo_database_migration_service.types.string.String"
    """<p>The endpoint for the OpenSearch cluster. DMS uses HTTPS if a transport protocol (http/https) is not specified.</p>"""
    full_load_error_percentage: NotRequired[
        "capo_database_migration_service.types.integer_optional.IntegerOptional"
    ]
    """<p>The maximum percentage of records that can fail to be written before a full load operation stops.</p> <p>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. </p>"""
    error_retry_duration: NotRequired[
        "capo_database_migration_service.types.integer_optional.IntegerOptional"
    ]
    """<p>The maximum number of seconds for which DMS retries failed API requests to the OpenSearch cluster.</p>"""
    use_new_mapping_type: NotRequired[
        "capo_database_migration_service.types.boolean_optional.BooleanOptional"
    ]
    """<p>Set this option to <code>true</code> for DMS to migrate documentation using the documentation type <code>_doc</code>. OpenSearch and an Elasticsearch cluster only support the _doc documentation type in versions 7. x and later. The default value is <code>false</code>.</p>"""

endpoint_uri instance-attribute 

endpoint_uri: String

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

error_retry_duration instance-attribute 

error_retry_duration: NotRequired[IntegerOptional]

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

full_load_error_percentage instance-attribute 

full_load_error_percentage: NotRequired[IntegerOptional]

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.

service_access_role_arn instance-attribute 

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.

use_new_mapping_type instance-attribute 

use_new_mapping_type: NotRequired[BooleanOptional]

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.