AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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,
}

Provides information that defines an Elasticsearch endpoint.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#endpoint_uriString

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

Returns:

  • (String)


3401
3402
3403
3404
3405
3406
3407
3408
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3401

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

#error_retry_durationInteger

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

Returns:

  • (Integer)


3401
3402
3403
3404
3405
3406
3407
3408
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3401

class ElasticsearchSettings < Struct.new(
  :service_access_role_arn,
  :endpoint_uri,
  :full_load_error_percentage,
  :error_retry_duration)
  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. Elasticsearch 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)


3401
3402
3403
3404
3405
3406
3407
3408
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3401

class ElasticsearchSettings < Struct.new(
  :service_access_role_arn,
  :endpoint_uri,
  :full_load_error_percentage,
  :error_retry_duration)
  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)


3401
3402
3403
3404
3405
3406
3407
3408
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3401

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