Amazonka.DMS.Types.SupportedEndpointType

Documentation

data SupportedEndpointType

Provides information about types of supported endpoints in response to a request by the DescribeEndpointTypes operation. This information includes the type of endpoint, the database engine name, and whether change data capture (CDC) is supported.

See: newSupportedEndpointType smart constructor.

Constructors

SupportedEndpointType'

Fields

• endpointType :: Maybe ReplicationEndpointTypeValue

  The type of endpoint. Valid values are source and target.

• engineDisplayName :: Maybe Text

  The expanded name for the engine name. For example, if the EngineName parameter is "aurora", this value would be "Amazon Aurora MySQL".

• engineName :: Maybe Text

  The database engine name. Valid values, depending on the EndpointType, include "mysql", "oracle", "postgres", "mariadb", "aurora", "aurora-postgresql", "redshift", "s3", "db2", "db2-zos", "azuredb", "sybase", "dynamodb", "mongodb", "kinesis", "kafka", "elasticsearch", "documentdb", "sqlserver", "neptune", and "babelfish".

• replicationInstanceEngineMinimumVersion :: Maybe Text

  The earliest DMS engine version that supports this endpoint engine. Note that endpoint engines released with DMS versions earlier than 3.1.1 do not return a value for this parameter.

• supportsCDC :: Maybe Bool

  Indicates if change data capture (CDC) is supported.

Instances

FromJSON SupportedEndpointType

Defined in Amazonka.DMS.Types.SupportedEndpointType

Methods

parseJSON :: Value -> Parser SupportedEndpointType

parseJSONList :: Value -> Parser [SupportedEndpointType]

Generic SupportedEndpointType

Defined in Amazonka.DMS.Types.SupportedEndpointType

Associated Types

type Rep SupportedEndpointType :: Type -> Type

Methods

from :: SupportedEndpointType -> Rep SupportedEndpointType x

to :: Rep SupportedEndpointType x -> SupportedEndpointType

Read SupportedEndpointType

Defined in Amazonka.DMS.Types.SupportedEndpointType

Methods

readsPrec :: Int -> ReadS SupportedEndpointType

readList :: ReadS [SupportedEndpointType]

readPrec :: ReadPrec SupportedEndpointType

readListPrec :: ReadPrec [SupportedEndpointType]

Show SupportedEndpointType

Defined in Amazonka.DMS.Types.SupportedEndpointType

Methods

showsPrec :: Int -> SupportedEndpointType -> ShowS

show :: SupportedEndpointType -> String

showList :: [SupportedEndpointType] -> ShowS

NFData SupportedEndpointType

Defined in Amazonka.DMS.Types.SupportedEndpointType

Methods

rnf :: SupportedEndpointType -> ()

Eq SupportedEndpointType

Defined in Amazonka.DMS.Types.SupportedEndpointType

Methods

(==) :: SupportedEndpointType -> SupportedEndpointType -> Bool

(/=) :: SupportedEndpointType -> SupportedEndpointType -> Bool

Hashable SupportedEndpointType

Defined in Amazonka.DMS.Types.SupportedEndpointType

Methods

hashWithSalt :: Int -> SupportedEndpointType -> Int

hash :: SupportedEndpointType -> Int

type Rep SupportedEndpointType

Defined in Amazonka.DMS.Types.SupportedEndpointType

type Rep SupportedEndpointType = D1 ('MetaData "SupportedEndpointType" "Amazonka.DMS.Types.SupportedEndpointType" "amazonka-dms-2.0-LVCLJv4CY4nJuf0WXCDs3O" 'False) (C1 ('MetaCons "SupportedEndpointType'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "endpointType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReplicationEndpointTypeValue)) :*: S1 ('MetaSel ('Just "engineDisplayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "engineName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "replicationInstanceEngineMinimumVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "supportsCDC") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))))

newSupportedEndpointType :: SupportedEndpointType

Create a value of SupportedEndpointType 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:endpointType:SupportedEndpointType', supportedEndpointType_endpointType - The type of endpoint. Valid values are source and target.

$sel:engineDisplayName:SupportedEndpointType', supportedEndpointType_engineDisplayName - The expanded name for the engine name. For example, if the EngineName parameter is "aurora", this value would be "Amazon Aurora MySQL".

$sel:engineName:SupportedEndpointType', supportedEndpointType_engineName - The database engine name. Valid values, depending on the EndpointType, include "mysql", "oracle", "postgres", "mariadb", "aurora", "aurora-postgresql", "redshift", "s3", "db2", "db2-zos", "azuredb", "sybase", "dynamodb", "mongodb", "kinesis", "kafka", "elasticsearch", "documentdb", "sqlserver", "neptune", and "babelfish".

$sel:replicationInstanceEngineMinimumVersion:SupportedEndpointType', supportedEndpointType_replicationInstanceEngineMinimumVersion - The earliest DMS engine version that supports this endpoint engine. Note that endpoint engines released with DMS versions earlier than 3.1.1 do not return a value for this parameter.

$sel:supportsCDC:SupportedEndpointType', supportedEndpointType_supportsCDC - Indicates if change data capture (CDC) is supported.

supportedEndpointType_endpointType :: Lens' SupportedEndpointType (Maybe ReplicationEndpointTypeValue)

The type of endpoint. Valid values are source and target.

supportedEndpointType_engineDisplayName :: Lens' SupportedEndpointType (Maybe Text)

The expanded name for the engine name. For example, if the EngineName parameter is "aurora", this value would be "Amazon Aurora MySQL".

supportedEndpointType_engineName :: Lens' SupportedEndpointType (Maybe Text)

The database engine name. Valid values, depending on the EndpointType, include "mysql", "oracle", "postgres", "mariadb", "aurora", "aurora-postgresql", "redshift", "s3", "db2", "db2-zos", "azuredb", "sybase", "dynamodb", "mongodb", "kinesis", "kafka", "elasticsearch", "documentdb", "sqlserver", "neptune", and "babelfish".

supportedEndpointType_replicationInstanceEngineMinimumVersion :: Lens' SupportedEndpointType (Maybe Text)

The earliest DMS engine version that supports this endpoint engine. Note that endpoint engines released with DMS versions earlier than 3.1.1 do not return a value for this parameter.

supportedEndpointType_supportsCDC :: Lens' SupportedEndpointType (Maybe Bool)

Indicates if change data capture (CDC) is supported.