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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb

Overview

Note:

When making an API call, you may pass ElasticsearchSettings data as a hash:

{
  service_access_role_arn: "String", # required
  endpoint_uri: "String", # required
  full_load_error_percentage: 1,
  error_retry_duration: 1,
  use_new_mapping_type: false,
}

Provides information that defines an OpenSearch endpoint.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#endpoint_uriString

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

Returns:

  • (String)


4184
4185
4186
4187
4188
4189
4190
4191
4192
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 4184

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_durationInteger

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

Returns:

  • (Integer)


4184
4185
4186
4187
4188
4189
4190
4191
4192
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 4184

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_percentageInteger

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)


4184
4185
4186
4187
4188
4189
4190
4191
4192
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 4184

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_arnString

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

Returns:

  • (String)


4184
4185
4186
4187
4188
4189
4190
4191
4192
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 4184

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_typeBoolean

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)


4184
4185
4186
4187
4188
4189
4190
4191
4192
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 4184

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