Class: AWSCDK::DMS::CfnEndpoint::ElasticsearchSettingsProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
dms/cfn_endpoint.rb

Overview

Provides information that defines an OpenSearch endpoint.

This information includes the output format of records applied to the endpoint and details of transaction and control table data information. For more information about the available settings, see Extra connection attributes when using OpenSearch as a target for AWS DMS in the AWS Database Migration Service User Guide .

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(endpoint_uri: nil, error_retry_duration: nil, full_load_error_percentage: nil, service_access_role_arn: nil) ⇒ ElasticsearchSettingsProperty

Returns a new instance of ElasticsearchSettingsProperty.

Parameters:

  • endpoint_uri (String, nil) (defaults to: nil) —

    The endpoint for the OpenSearch cluster.

  • error_retry_duration (Numeric, nil) (defaults to: nil) —

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

  • full_load_error_percentage (Numeric, nil) (defaults to: nil) —

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

  • service_access_role_arn (String, nil) (defaults to: nil) —

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



1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
 
# File 'dms/cfn_endpoint.rb', line 1078

def initialize(endpoint_uri: nil, error_retry_duration: nil, full_load_error_percentage: nil, service_access_role_arn: nil)
  @endpoint_uri = endpoint_uri
  Jsii::Type.check_type(@endpoint_uri, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "endpointUri") unless @endpoint_uri.nil?
  @error_retry_duration = error_retry_duration
  Jsii::Type.check_type(@error_retry_duration, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "errorRetryDuration") unless @error_retry_duration.nil?
  @full_load_error_percentage = full_load_error_percentage
  Jsii::Type.check_type(@full_load_error_percentage, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "fullLoadErrorPercentage") unless @full_load_error_percentage.nil?
  @service_access_role_arn = service_access_role_arn
  Jsii::Type.check_type(@service_access_role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "serviceAccessRoleArn") unless @service_access_role_arn.nil?
end

Instance Attribute Details

#endpoint_uri ⇒ String? (readonly)

The endpoint for the OpenSearch cluster.

AWS DMS uses HTTPS if a transport protocol (either HTTP or HTTPS) isn't specified.

Returns:

  • (String, nil)

See Also:



1095
1096
1097
 
# File 'dms/cfn_endpoint.rb', line 1095

def endpoint_uri
  @endpoint_uri
end

#error_retry_duration ⇒ Numeric? (readonly)

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

Returns:

  • (Numeric, nil)

See Also:



1100
1101
1102
 
# File 'dms/cfn_endpoint.rb', line 1100

def error_retry_duration
  @error_retry_duration
end

#full_load_error_percentage ⇒ Numeric? (readonly)

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 1,000 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:

  • (Numeric, nil)

See Also:



1107
1108
1109
 
# File 'dms/cfn_endpoint.rb', line 1107

def full_load_error_percentage
  @full_load_error_percentage
end

#service_access_role_arn ⇒ String? (readonly)

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

The role must allow the iam:PassRole action.

Returns:

  • (String, nil)

See Also:



1114
1115
1116
 
# File 'dms/cfn_endpoint.rb', line 1114

def service_access_role_arn
  @service_access_role_arn
end

Class Method Details

.jsii_properties ⇒ Object 



1116
1117
1118
1119
1120
1121
1122
1123
 
# File 'dms/cfn_endpoint.rb', line 1116

def self.jsii_properties
  {
    :endpoint_uri => "endpointUri",
    :error_retry_duration => "errorRetryDuration",
    :full_load_error_percentage => "fullLoadErrorPercentage",
    :service_access_role_arn => "serviceAccessRoleArn",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
 
# File 'dms/cfn_endpoint.rb', line 1125

def to_jsii
  result = {}
  result.merge!({
    "endpointUri" => @endpoint_uri,
    "errorRetryDuration" => @error_retry_duration,
    "fullLoadErrorPercentage" => @full_load_error_percentage,
    "serviceAccessRoleArn" => @service_access_role_arn,
  })
  result.compact
end