Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.DMS.Types.ElasticsearchSettings

Description

Documentation

data ElasticsearchSettings Source #

Provides information that defines an OpenSearch endpoint.

See: newElasticsearchSettings smart constructor.

Constructors

ElasticsearchSettings'

Fields

errorRetryDuration :: Maybe Int
The maximum number of seconds for which DMS retries failed API requests to the OpenSearch cluster.
fullLoadErrorPercentage :: Maybe Int
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.
useNewMappingType :: Maybe Bool
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.
serviceAccessRoleArn :: Text
The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the iam:PassRole action.
endpointUri :: Text
The endpoint for the OpenSearch cluster. DMS uses HTTPS if a transport protocol (http/https) is not specified.

Instances

Instances details

FromJSON ElasticsearchSettings Source #
Instance details Defined in Amazonka.DMS.Types.ElasticsearchSettings Methods parseJSON :: Value -> Parser ElasticsearchSettings # parseJSONList :: Value -> Parser [ElasticsearchSettings] #
ToJSON ElasticsearchSettings Source #
Instance details Defined in Amazonka.DMS.Types.ElasticsearchSettings Methods toJSON :: ElasticsearchSettings -> Value # toEncoding :: ElasticsearchSettings -> Encoding # toJSONList :: [ElasticsearchSettings] -> Value # toEncodingList :: [ElasticsearchSettings] -> Encoding #
Generic ElasticsearchSettings Source #
Instance details Defined in Amazonka.DMS.Types.ElasticsearchSettings Associated Types type Rep ElasticsearchSettings :: Type -> Type # Methods from :: ElasticsearchSettings -> Rep ElasticsearchSettings x # to :: Rep ElasticsearchSettings x -> ElasticsearchSettings #
Read ElasticsearchSettings Source #
Instance details Defined in Amazonka.DMS.Types.ElasticsearchSettings Methods readsPrec :: Int -> ReadS ElasticsearchSettings # readList :: ReadS [ElasticsearchSettings] # readPrec :: ReadPrec ElasticsearchSettings # readListPrec :: ReadPrec [ElasticsearchSettings] #
Show ElasticsearchSettings Source #
Instance details Defined in Amazonka.DMS.Types.ElasticsearchSettings Methods showsPrec :: Int -> ElasticsearchSettings -> ShowS # show :: ElasticsearchSettings -> String # showList :: [ElasticsearchSettings] -> ShowS #
NFData ElasticsearchSettings Source #
Instance details Defined in Amazonka.DMS.Types.ElasticsearchSettings Methods rnf :: ElasticsearchSettings -> () #
Eq ElasticsearchSettings Source #
Instance details Defined in Amazonka.DMS.Types.ElasticsearchSettings Methods (==) :: ElasticsearchSettings -> ElasticsearchSettings -> Bool # (/=) :: ElasticsearchSettings -> ElasticsearchSettings -> Bool #
Hashable ElasticsearchSettings Source #
Instance details Defined in Amazonka.DMS.Types.ElasticsearchSettings Methods hashWithSalt :: Int -> ElasticsearchSettings -> Int # hash :: ElasticsearchSettings -> Int #
type Rep ElasticsearchSettings Source #
Instance details Defined in Amazonka.DMS.Types.ElasticsearchSettings type Rep ElasticsearchSettings = D1 ('MetaData "ElasticsearchSettings" "Amazonka.DMS.Types.ElasticsearchSettings" "amazonka-dms-2.0-LVCLJv4CY4nJuf0WXCDs3O" 'False) (C1 ('MetaCons "ElasticsearchSettings'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "errorRetryDuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "fullLoadErrorPercentage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :: (S1 ('MetaSel ('Just "useNewMappingType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "serviceAccessRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "endpointUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newElasticsearchSettings Source #

Arguments

:: Text	`$sel:serviceAccessRoleArn:ElasticsearchSettings'`
-> Text	`$sel:endpointUri:ElasticsearchSettings'`
-> ElasticsearchSettings

Create a value of ElasticsearchSettings with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:errorRetryDuration:ElasticsearchSettings', elasticsearchSettings_errorRetryDuration - The maximum number of seconds for which DMS retries failed API requests to the OpenSearch cluster.

$sel:fullLoadErrorPercentage:ElasticsearchSettings', elasticsearchSettings_fullLoadErrorPercentage - 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.

$sel:useNewMappingType:ElasticsearchSettings', elasticsearchSettings_useNewMappingType - 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.

$sel:serviceAccessRoleArn:ElasticsearchSettings', elasticsearchSettings_serviceAccessRoleArn - The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the iam:PassRole action.

$sel:endpointUri:ElasticsearchSettings', elasticsearchSettings_endpointUri - The endpoint for the OpenSearch cluster. DMS uses HTTPS if a transport protocol (http/https) is not specified.

elasticsearchSettings_errorRetryDuration :: Lens' ElasticsearchSettings (Maybe Int) Source #

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

elasticsearchSettings_fullLoadErrorPercentage :: Lens' ElasticsearchSettings (Maybe Int) Source #

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.

elasticsearchSettings_useNewMappingType :: Lens' ElasticsearchSettings (Maybe Bool) Source #

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.

elasticsearchSettings_serviceAccessRoleArn :: Lens' ElasticsearchSettings Text Source #

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

elasticsearchSettings_endpointUri :: Lens' ElasticsearchSettings Text Source #

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