Interface CfnEndpoint.IElasticsearchSettingsProperty
Provides information that defines an OpenSearch endpoint.
Namespace: Amazon.CDK.AWS.DMS
Assembly: Amazon.CDK.AWS.DMS.dll
Syntax (csharp)
public interface IElasticsearchSettingsProperty
Syntax (vb)
Public Interface IElasticsearchSettingsProperty
Remarks
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 .
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.DMS;
var elasticsearchSettingsProperty = new ElasticsearchSettingsProperty {
EndpointUri = "endpointUri",
ErrorRetryDuration = 123,
FullLoadErrorPercentage = 123,
ServiceAccessRoleArn = "serviceAccessRoleArn"
};
Synopsis
Properties
EndpointUri | The endpoint for the OpenSearch cluster. |
ErrorRetryDuration | The maximum number of seconds for which DMS retries failed API requests to the OpenSearch cluster. |
FullLoadErrorPercentage | The maximum percentage of records that can fail to be written before a full load operation stops. |
ServiceAccessRoleArn | The Amazon Resource Name (ARN) used by the service to access the IAM role. |
Properties
EndpointUri
The endpoint for the OpenSearch cluster.
virtual string EndpointUri { get; }
Property Value
System.String
Remarks
AWS DMS uses HTTPS if a transport protocol (either HTTP or HTTPS) isn't specified.
ErrorRetryDuration
The maximum number of seconds for which DMS retries failed API requests to the OpenSearch cluster.
virtual Nullable<double> ErrorRetryDuration { get; }
Property Value
System.Nullable<System.Double>
Remarks
FullLoadErrorPercentage
The maximum percentage of records that can fail to be written before a full load operation stops.
virtual Nullable<double> FullLoadErrorPercentage { get; }
Property Value
System.Nullable<System.Double>
Remarks
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.
ServiceAccessRoleArn
The Amazon Resource Name (ARN) used by the service to access the IAM role.
virtual string ServiceAccessRoleArn { get; }
Property Value
System.String
Remarks
The role must allow the iam:PassRole
action.