Package software.amazon.awscdk.services.dms

Interface CfnEndpoint.ElasticsearchSettingsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEndpoint.ElasticsearchSettingsProperty.Jsii$Proxy

Enclosing class:

CfnEndpoint

@Stability(Stable)
public static interface CfnEndpoint.ElasticsearchSettingsProperty
extends software.amazon.jsii.JsiiSerializable

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 .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.dms.*;
 ElasticsearchSettingsProperty elasticsearchSettingsProperty = ElasticsearchSettingsProperty.builder()
         .endpointUri("endpointUri")
         .errorRetryDuration(123)
         .fullLoadErrorPercentage(123)
         .serviceAccessRoleArn("serviceAccessRoleArn")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-elasticsearchsettings.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnEndpoint.ElasticsearchSettingsProperty.Builder	A builder for CfnEndpoint.ElasticsearchSettingsProperty
static final class	CfnEndpoint.ElasticsearchSettingsProperty.Jsii$Proxy	An implementation for CfnEndpoint.ElasticsearchSettingsProperty

Method Summary

Modifier and Type	Method	Description
static CfnEndpoint.ElasticsearchSettingsProperty.Builder	builder()
default String	getEndpointUri()	The endpoint for the OpenSearch cluster.
default Number	getErrorRetryDuration()	The maximum number of seconds for which DMS retries failed API requests to the OpenSearch cluster.
default Number	getFullLoadErrorPercentage()	The maximum percentage of records that can fail to be written before a full load operation stops.
default String	getServiceAccessRoleArn()	The Amazon Resource Name (ARN) used by the service to access the IAM role.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEndpointUri

@Stability(Stable)
@Nullable
default String getEndpointUri()

The endpoint for the OpenSearch cluster.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-elasticsearchsettings.html#cfn-dms-endpoint-elasticsearchsettings-endpointuri

getErrorRetryDuration

@Stability(Stable)
@Nullable
default Number getErrorRetryDuration()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-elasticsearchsettings.html#cfn-dms-endpoint-elasticsearchsettings-errorretryduration

getFullLoadErrorPercentage

@Stability(Stable)
@Nullable
default Number getFullLoadErrorPercentage()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-elasticsearchsettings.html#cfn-dms-endpoint-elasticsearchsettings-fullloaderrorpercentage

getServiceAccessRoleArn

@Stability(Stable)
@Nullable
default String getServiceAccessRoleArn()

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

The role must allow the iam:PassRole action.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-elasticsearchsettings.html#cfn-dms-endpoint-elasticsearchsettings-serviceaccessrolearn

builder

@Stability(Stable)
static CfnEndpoint.ElasticsearchSettingsProperty.Builder builder()

Returns:

a CfnEndpoint.ElasticsearchSettingsProperty.Builder of CfnEndpoint.ElasticsearchSettingsProperty