Class: Aws::DatabaseMigrationService::Types::ElasticsearchSettings

Inherits:

Struct

• Object
• Struct
• Aws::DatabaseMigrationService::Types::ElasticsearchSettings

Defined in:

gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb

Overview

Provides information that defines an OpenSearch endpoint.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #endpoint_uri ⇒ String

  The endpoint for the OpenSearch cluster.

• #error_retry_duration ⇒ Integer

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

• #full_load_error_percentage ⇒ Integer

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

• #service_access_role_arn ⇒ String

  The Amazon Resource Name (ARN) used by the service to access the IAM role.

• #use_new_mapping_type ⇒ Boolean

  Set this option to true for DMS to migrate documentation using the documentation type _doc.

Instance Attribute Details

#endpoint_uri ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5351

class ElasticsearchSettings < Struct.new(
  :service_access_role_arn,
  :endpoint_uri,
  :full_load_error_percentage,
  :error_retry_duration,
  :use_new_mapping_type)
  SENSITIVE = []
  include Aws::Structure
end

#error_retry_duration ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5351

class ElasticsearchSettings < Struct.new(
  :service_access_role_arn,
  :endpoint_uri,
  :full_load_error_percentage,
  :error_retry_duration,
  :use_new_mapping_type)
  SENSITIVE = []
  include Aws::Structure
end

#full_load_error_percentage ⇒ Integer

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.

Returns:

• (Integer)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5351

class ElasticsearchSettings < Struct.new(
  :service_access_role_arn,
  :endpoint_uri,
  :full_load_error_percentage,
  :error_retry_duration,
  :use_new_mapping_type)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

• (String)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5351

class ElasticsearchSettings < Struct.new(
  :service_access_role_arn,
  :endpoint_uri,
  :full_load_error_percentage,
  :error_retry_duration,
  :use_new_mapping_type)
  SENSITIVE = []
  include Aws::Structure
end

#use_new_mapping_type ⇒ Boolean

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.

Returns:

• (Boolean)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5351

class ElasticsearchSettings < Struct.new(
  :service_access_role_arn,
  :endpoint_uri,
  :full_load_error_percentage,
  :error_retry_duration,
  :use_new_mapping_type)
  SENSITIVE = []
  include Aws::Structure
end