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.CreateEndpoint

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an endpoint using the provided settings.

For a MySQL source or target endpoint, don't explicitly specify the database using the DatabaseName request parameter on the CreateEndpoint API call. Specifying DatabaseName when you create a MySQL endpoint replicates all the task tables to this single database. For MySQL endpoints, you specify the database only when you specify the schema in the table-mapping rules of the DMS task.

Synopsis

Creating a Request

data CreateEndpoint Source #

See: newCreateEndpoint smart constructor.

Constructors

CreateEndpoint'

Fields

certificateArn :: Maybe Text
The Amazon Resource Name (ARN) for the certificate.
databaseName :: Maybe Text
The name of the endpoint database. For a MySQL source or target endpoint, do not specify DatabaseName. To migrate to a specific database, use this setting and targetDbType.
dmsTransferSettings :: Maybe DmsTransferSettings
The settings in JSON format for the DMS transfer type of source endpoint.
Possible settings include the following:
- ServiceAccessRoleArn - The Amazon Resource Name (ARN) used by the service access IAM role. The role must allow the iam:PassRole action.
- BucketName - The name of the S3 bucket to use.
Shorthand syntax for these settings is as follows: ServiceAccessRoleArn=string,BucketName=string
JSON syntax for these settings is as follows: { "ServiceAccessRoleArn": "string", "BucketName": "string", }
docDbSettings :: Maybe DocDbSettings
dynamoDbSettings :: Maybe DynamoDbSettings
Settings in JSON format for the target Amazon DynamoDB endpoint. For information about other available settings, see Using Object Mapping to Migrate Data to DynamoDB in the Database Migration Service User Guide.
elasticsearchSettings :: Maybe ElasticsearchSettings
Settings in JSON format for the target OpenSearch endpoint. For more information about the available settings, see Extra Connection Attributes When Using OpenSearch as a Target for DMS in the Database Migration Service User Guide.
externalTableDefinition :: Maybe Text
The external table definition.
extraConnectionAttributes :: Maybe Text
Additional attributes associated with the connection. Each attribute is specified as a name-value pair associated by an equal sign (=). Multiple attributes are separated by a semicolon (;) with no additional white space. For information on the attributes available for connecting your source or target endpoint, see Working with DMS Endpoints in the Database Migration Service User Guide.
gcpMySQLSettings :: Maybe GcpMySQLSettings
Settings in JSON format for the source GCP MySQL endpoint.
iBMDb2Settings :: Maybe IBMDb2Settings
Settings in JSON format for the source IBM Db2 LUW endpoint. For information about other available settings, see Extra connection attributes when using Db2 LUW as a source for DMS in the Database Migration Service User Guide.
kafkaSettings :: Maybe KafkaSettings
Settings in JSON format for the target Apache Kafka endpoint. For more information about the available settings, see Using object mapping to migrate data to a Kafka topic in the Database Migration Service User Guide.
kinesisSettings :: Maybe KinesisSettings
Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For more information about the available settings, see Using object mapping to migrate data to a Kinesis data stream in the Database Migration Service User Guide.
kmsKeyId :: Maybe Text
An KMS key identifier that is used to encrypt the connection parameters for the endpoint.
If you don't specify a value for the KmsKeyId parameter, then DMS uses your default encryption key.
KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.
microsoftSQLServerSettings :: Maybe MicrosoftSQLServerSettings
Settings in JSON format for the source and target Microsoft SQL Server endpoint. For information about other available settings, see Extra connection attributes when using SQL Server as a source for DMS and Extra connection attributes when using SQL Server as a target for DMS in the Database Migration Service User Guide.
mongoDbSettings :: Maybe MongoDbSettings
Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see Endpoint configuration settings when using MongoDB as a source for Database Migration Service in the Database Migration Service User Guide.
mySQLSettings :: Maybe MySQLSettings
Settings in JSON format for the source and target MySQL endpoint. For information about other available settings, see Extra connection attributes when using MySQL as a source for DMS and Extra connection attributes when using a MySQL-compatible database as a target for DMS in the Database Migration Service User Guide.
neptuneSettings :: Maybe NeptuneSettings
Settings in JSON format for the target Amazon Neptune endpoint. For more information about the available settings, see Specifying graph-mapping rules using Gremlin and R2RML for Amazon Neptune as a target in the Database Migration Service User Guide.
oracleSettings :: Maybe OracleSettings
Settings in JSON format for the source and target Oracle endpoint. For information about other available settings, see Extra connection attributes when using Oracle as a source for DMS and Extra connection attributes when using Oracle as a target for DMS in the Database Migration Service User Guide.
password :: Maybe (Sensitive Text)
The password to be used to log in to the endpoint database.
port :: Maybe Int
The port used by the endpoint database.
postgreSQLSettings :: Maybe PostgreSQLSettings
Settings in JSON format for the source and target PostgreSQL endpoint. For information about other available settings, see Extra connection attributes when using PostgreSQL as a source for DMS and Extra connection attributes when using PostgreSQL as a target for DMS in the Database Migration Service User Guide.
redisSettings :: Maybe RedisSettings
Settings in JSON format for the target Redis endpoint.
redshiftSettings :: Maybe RedshiftSettings
resourceIdentifier :: Maybe Text
A friendly name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object. The value for this parameter can have up to 31 characters. It can contain only ASCII letters, digits, and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as Example-App-ARN1. For example, this value might result in the EndpointArn value arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. If you don't specify a ResourceIdentifier value, DMS generates a default identifier value for the end of EndpointArn.
s3Settings :: Maybe S3Settings
Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see Extra Connection Attributes When Using Amazon S3 as a Target for DMS in the Database Migration Service User Guide.
serverName :: Maybe Text
The name of the server where the endpoint database resides.
serviceAccessRoleArn :: Maybe Text
The Amazon Resource Name (ARN) for the service access role that you want to use to create the endpoint. The role must allow the iam:PassRole action.
sslMode :: Maybe DmsSslModeValue
The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is none
sybaseSettings :: Maybe SybaseSettings
Settings in JSON format for the source and target SAP ASE endpoint. For information about other available settings, see Extra connection attributes when using SAP ASE as a source for DMS and Extra connection attributes when using SAP ASE as a target for DMS in the Database Migration Service User Guide.
tags :: Maybe [Tag]
One or more tags to be assigned to the endpoint.
username :: Maybe Text
The user name to be used to log in to the endpoint database.
endpointIdentifier :: Text
The database endpoint identifier. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen, or contain two consecutive hyphens.
endpointType :: ReplicationEndpointTypeValue
The type of endpoint. Valid values are source and target.
engineName :: Text
The type of engine for the endpoint. Valid values, depending on the EndpointType value, include "mysql", "oracle", "postgres", "mariadb", "aurora", "aurora-postgresql", "opensearch", "redshift", "s3", "db2", "db2-zos", "azuredb", "sybase", "dynamodb", "mongodb", "kinesis", "kafka", "elasticsearch", "docdb", "sqlserver", "neptune", and "babelfish".

Instances

Instances details

ToJSON CreateEndpoint Source #
Instance details Defined in Amazonka.DMS.CreateEndpoint Methods toJSON :: CreateEndpoint -> Value # toEncoding :: CreateEndpoint -> Encoding # toJSONList :: [CreateEndpoint] -> Value # toEncodingList :: [CreateEndpoint] -> Encoding #
ToHeaders CreateEndpoint Source #
Instance details Defined in Amazonka.DMS.CreateEndpoint Methods toHeaders :: CreateEndpoint -> [Header] #
ToPath CreateEndpoint Source #
Instance details Defined in Amazonka.DMS.CreateEndpoint Methods toPath :: CreateEndpoint -> ByteString #
ToQuery CreateEndpoint Source #
Instance details Defined in Amazonka.DMS.CreateEndpoint Methods toQuery :: CreateEndpoint -> QueryString #
AWSRequest CreateEndpoint Source #
Instance details Defined in Amazonka.DMS.CreateEndpoint Associated Types type AWSResponse CreateEndpoint # Methods request :: (Service -> Service) -> CreateEndpoint -> Request CreateEndpoint # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateEndpoint -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateEndpoint))) #
Generic CreateEndpoint Source #
Instance details Defined in Amazonka.DMS.CreateEndpoint Associated Types type Rep CreateEndpoint :: Type -> Type # Methods from :: CreateEndpoint -> Rep CreateEndpoint x # to :: Rep CreateEndpoint x -> CreateEndpoint #
Show CreateEndpoint Source #
Instance details Defined in Amazonka.DMS.CreateEndpoint Methods showsPrec :: Int -> CreateEndpoint -> ShowS # show :: CreateEndpoint -> String # showList :: [CreateEndpoint] -> ShowS #
NFData CreateEndpoint Source #
Instance details Defined in Amazonka.DMS.CreateEndpoint Methods rnf :: CreateEndpoint -> () #
Eq CreateEndpoint Source #
Instance details Defined in Amazonka.DMS.CreateEndpoint Methods (==) :: CreateEndpoint -> CreateEndpoint -> Bool # (/=) :: CreateEndpoint -> CreateEndpoint -> Bool #
Hashable CreateEndpoint Source #
Instance details Defined in Amazonka.DMS.CreateEndpoint Methods hashWithSalt :: Int -> CreateEndpoint -> Int # hash :: CreateEndpoint -> Int #
type AWSResponse CreateEndpoint Source #
Instance details Defined in Amazonka.DMS.CreateEndpoint type AWSResponse CreateEndpoint = CreateEndpointResponse
type Rep CreateEndpoint Source #
Instance details Defined in Amazonka.DMS.CreateEndpoint type Rep CreateEndpoint = D1 ('MetaData "CreateEndpoint" "Amazonka.DMS.CreateEndpoint" "amazonka-dms-2.0-LVCLJv4CY4nJuf0WXCDs3O" 'False) (C1 ('MetaCons "CreateEndpoint'" 'PrefixI 'True) (((((S1 ('MetaSel ('Just "certificateArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "databaseName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "dmsTransferSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DmsTransferSettings)) :: S1 ('MetaSel ('Just "docDbSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocDbSettings)))) :: ((S1 ('MetaSel ('Just "dynamoDbSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DynamoDbSettings)) :: S1 ('MetaSel ('Just "elasticsearchSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ElasticsearchSettings))) :: (S1 ('MetaSel ('Just "externalTableDefinition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "extraConnectionAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: (((S1 ('MetaSel ('Just "gcpMySQLSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GcpMySQLSettings)) :: S1 ('MetaSel ('Just "iBMDb2Settings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IBMDb2Settings))) :: (S1 ('MetaSel ('Just "kafkaSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KafkaSettings)) :: S1 ('MetaSel ('Just "kinesisSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KinesisSettings)))) :: ((S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "microsoftSQLServerSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MicrosoftSQLServerSettings))) :: (S1 ('MetaSel ('Just "mongoDbSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MongoDbSettings)) :: (S1 ('MetaSel ('Just "mySQLSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MySQLSettings)) :: S1 ('MetaSel ('Just "neptuneSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NeptuneSettings))))))) :: ((((S1 ('MetaSel ('Just "oracleSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OracleSettings)) :: S1 ('MetaSel ('Just "password") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))) :: (S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "postgreSQLSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PostgreSQLSettings)))) :: ((S1 ('MetaSel ('Just "redisSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RedisSettings)) :: S1 ('MetaSel ('Just "redshiftSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RedshiftSettings))) :: (S1 ('MetaSel ('Just "resourceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "s3Settings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3Settings))))) :: (((S1 ('MetaSel ('Just "serverName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "serviceAccessRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "sslMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DmsSslModeValue)) :: S1 ('MetaSel ('Just "sybaseSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SybaseSettings)))) :: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: S1 ('MetaSel ('Just "username") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "endpointIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "endpointType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ReplicationEndpointTypeValue) :*: S1 ('MetaSel ('Just "engineName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))))

newCreateEndpoint Source #

Arguments

:: Text	`CreateEndpoint`
-> ReplicationEndpointTypeValue	`CreateEndpoint`
-> Text	`CreateEndpoint`
-> CreateEndpoint

Create a value of CreateEndpoint 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:

CreateEndpoint, createEndpoint_certificateArn - The Amazon Resource Name (ARN) for the certificate.

CreateEndpoint, createEndpoint_databaseName - The name of the endpoint database. For a MySQL source or target endpoint, do not specify DatabaseName. To migrate to a specific database, use this setting and targetDbType.

CreateEndpoint, createEndpoint_dmsTransferSettings - The settings in JSON format for the DMS transfer type of source endpoint.

Possible settings include the following:

ServiceAccessRoleArn - The Amazon Resource Name (ARN) used by the service access IAM role. The role must allow the iam:PassRole action.
BucketName - The name of the S3 bucket to use.

Shorthand syntax for these settings is as follows: ServiceAccessRoleArn=string,BucketName=string

JSON syntax for these settings is as follows: { "ServiceAccessRoleArn": "string", "BucketName": "string", }

CreateEndpoint, createEndpoint_docDbSettings - Undocumented member.

CreateEndpoint, createEndpoint_dynamoDbSettings - Settings in JSON format for the target Amazon DynamoDB endpoint. For information about other available settings, see Using Object Mapping to Migrate Data to DynamoDB in the Database Migration Service User Guide.

CreateEndpoint, createEndpoint_elasticsearchSettings - Settings in JSON format for the target OpenSearch endpoint. For more information about the available settings, see Extra Connection Attributes When Using OpenSearch as a Target for DMS in the Database Migration Service User Guide.

CreateEndpoint, createEndpoint_externalTableDefinition - The external table definition.

CreateEndpoint, createEndpoint_extraConnectionAttributes - Additional attributes associated with the connection. Each attribute is specified as a name-value pair associated by an equal sign (=). Multiple attributes are separated by a semicolon (;) with no additional white space. For information on the attributes available for connecting your source or target endpoint, see Working with DMS Endpoints in the Database Migration Service User Guide.

CreateEndpoint, createEndpoint_gcpMySQLSettings - Settings in JSON format for the source GCP MySQL endpoint.

CreateEndpoint, createEndpoint_iBMDb2Settings - Settings in JSON format for the source IBM Db2 LUW endpoint. For information about other available settings, see Extra connection attributes when using Db2 LUW as a source for DMS in the Database Migration Service User Guide.

CreateEndpoint, createEndpoint_kafkaSettings - Settings in JSON format for the target Apache Kafka endpoint. For more information about the available settings, see Using object mapping to migrate data to a Kafka topic in the Database Migration Service User Guide.

CreateEndpoint, createEndpoint_kinesisSettings - Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For more information about the available settings, see Using object mapping to migrate data to a Kinesis data stream in the Database Migration Service User Guide.

CreateEndpoint, createEndpoint_kmsKeyId - An KMS key identifier that is used to encrypt the connection parameters for the endpoint.

If you don't specify a value for the KmsKeyId parameter, then DMS uses your default encryption key.

KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.

CreateEndpoint, createEndpoint_microsoftSQLServerSettings - Settings in JSON format for the source and target Microsoft SQL Server endpoint. For information about other available settings, see Extra connection attributes when using SQL Server as a source for DMS and Extra connection attributes when using SQL Server as a target for DMS in the Database Migration Service User Guide.

CreateEndpoint, createEndpoint_mongoDbSettings - Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see Endpoint configuration settings when using MongoDB as a source for Database Migration Service in the Database Migration Service User Guide.

CreateEndpoint, createEndpoint_mySQLSettings - Settings in JSON format for the source and target MySQL endpoint. For information about other available settings, see Extra connection attributes when using MySQL as a source for DMS and Extra connection attributes when using a MySQL-compatible database as a target for DMS in the Database Migration Service User Guide.

CreateEndpoint, createEndpoint_neptuneSettings - Settings in JSON format for the target Amazon Neptune endpoint. For more information about the available settings, see Specifying graph-mapping rules using Gremlin and R2RML for Amazon Neptune as a target in the Database Migration Service User Guide.

CreateEndpoint, createEndpoint_oracleSettings - Settings in JSON format for the source and target Oracle endpoint. For information about other available settings, see Extra connection attributes when using Oracle as a source for DMS and Extra connection attributes when using Oracle as a target for DMS in the Database Migration Service User Guide.

CreateEndpoint, createEndpoint_password - The password to be used to log in to the endpoint database.

CreateEndpoint, createEndpoint_port - The port used by the endpoint database.

CreateEndpoint, createEndpoint_postgreSQLSettings - Settings in JSON format for the source and target PostgreSQL endpoint. For information about other available settings, see Extra connection attributes when using PostgreSQL as a source for DMS and Extra connection attributes when using PostgreSQL as a target for DMS in the Database Migration Service User Guide.

CreateEndpoint, createEndpoint_redisSettings - Settings in JSON format for the target Redis endpoint.

CreateEndpoint, createEndpoint_redshiftSettings - Undocumented member.

CreateEndpoint, createEndpoint_resourceIdentifier - A friendly name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object. The value for this parameter can have up to 31 characters. It can contain only ASCII letters, digits, and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as Example-App-ARN1. For example, this value might result in the EndpointArn value arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. If you don't specify a ResourceIdentifier value, DMS generates a default identifier value for the end of EndpointArn.

CreateEndpoint, createEndpoint_s3Settings - Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see Extra Connection Attributes When Using Amazon S3 as a Target for DMS in the Database Migration Service User Guide.

CreateEndpoint, createEndpoint_serverName - The name of the server where the endpoint database resides.

CreateEndpoint, createEndpoint_serviceAccessRoleArn - The Amazon Resource Name (ARN) for the service access role that you want to use to create the endpoint. The role must allow the iam:PassRole action.

CreateEndpoint, createEndpoint_sslMode - The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is none

CreateEndpoint, createEndpoint_sybaseSettings - Settings in JSON format for the source and target SAP ASE endpoint. For information about other available settings, see Extra connection attributes when using SAP ASE as a source for DMS and Extra connection attributes when using SAP ASE as a target for DMS in the Database Migration Service User Guide.

$sel:tags:CreateEndpoint', createEndpoint_tags - One or more tags to be assigned to the endpoint.

CreateEndpoint, createEndpoint_username - The user name to be used to log in to the endpoint database.

CreateEndpoint, createEndpoint_endpointIdentifier - The database endpoint identifier. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen, or contain two consecutive hyphens.

CreateEndpoint, createEndpoint_endpointType - The type of endpoint. Valid values are source and target.

CreateEndpoint, createEndpoint_engineName - The type of engine for the endpoint. Valid values, depending on the EndpointType value, include "mysql", "oracle", "postgres", "mariadb", "aurora", "aurora-postgresql", "opensearch", "redshift", "s3", "db2", "db2-zos", "azuredb", "sybase", "dynamodb", "mongodb", "kinesis", "kafka", "elasticsearch", "docdb", "sqlserver", "neptune", and "babelfish".

Request Lenses

createEndpoint_certificateArn :: Lens' CreateEndpoint (Maybe Text) Source #

The Amazon Resource Name (ARN) for the certificate.

createEndpoint_databaseName :: Lens' CreateEndpoint (Maybe Text) Source #

The name of the endpoint database. For a MySQL source or target endpoint, do not specify DatabaseName. To migrate to a specific database, use this setting and targetDbType.

createEndpoint_dmsTransferSettings :: Lens' CreateEndpoint (Maybe DmsTransferSettings) Source #

The settings in JSON format for the DMS transfer type of source endpoint.

Possible settings include the following:

ServiceAccessRoleArn - The Amazon Resource Name (ARN) used by the service access IAM role. The role must allow the iam:PassRole action.
BucketName - The name of the S3 bucket to use.

Shorthand syntax for these settings is as follows: ServiceAccessRoleArn=string,BucketName=string

JSON syntax for these settings is as follows: { "ServiceAccessRoleArn": "string", "BucketName": "string", }

createEndpoint_docDbSettings :: Lens' CreateEndpoint (Maybe DocDbSettings) Source #

Undocumented member.

createEndpoint_dynamoDbSettings :: Lens' CreateEndpoint (Maybe DynamoDbSettings) Source #

Settings in JSON format for the target Amazon DynamoDB endpoint. For information about other available settings, see Using Object Mapping to Migrate Data to DynamoDB in the Database Migration Service User Guide.

createEndpoint_elasticsearchSettings :: Lens' CreateEndpoint (Maybe ElasticsearchSettings) Source #

Settings in JSON format for the target OpenSearch endpoint. For more information about the available settings, see Extra Connection Attributes When Using OpenSearch as a Target for DMS in the Database Migration Service User Guide.

createEndpoint_externalTableDefinition :: Lens' CreateEndpoint (Maybe Text) Source #

The external table definition.

createEndpoint_extraConnectionAttributes :: Lens' CreateEndpoint (Maybe Text) Source #

Additional attributes associated with the connection. Each attribute is specified as a name-value pair associated by an equal sign (=). Multiple attributes are separated by a semicolon (;) with no additional white space. For information on the attributes available for connecting your source or target endpoint, see Working with DMS Endpoints in the Database Migration Service User Guide.

createEndpoint_gcpMySQLSettings :: Lens' CreateEndpoint (Maybe GcpMySQLSettings) Source #

Settings in JSON format for the source GCP MySQL endpoint.

createEndpoint_iBMDb2Settings :: Lens' CreateEndpoint (Maybe IBMDb2Settings) Source #

Settings in JSON format for the source IBM Db2 LUW endpoint. For information about other available settings, see Extra connection attributes when using Db2 LUW as a source for DMS in the Database Migration Service User Guide.

createEndpoint_kafkaSettings :: Lens' CreateEndpoint (Maybe KafkaSettings) Source #

Settings in JSON format for the target Apache Kafka endpoint. For more information about the available settings, see Using object mapping to migrate data to a Kafka topic in the Database Migration Service User Guide.

createEndpoint_kinesisSettings :: Lens' CreateEndpoint (Maybe KinesisSettings) Source #

Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For more information about the available settings, see Using object mapping to migrate data to a Kinesis data stream in the Database Migration Service User Guide.

createEndpoint_kmsKeyId :: Lens' CreateEndpoint (Maybe Text) Source #

An KMS key identifier that is used to encrypt the connection parameters for the endpoint.

If you don't specify a value for the KmsKeyId parameter, then DMS uses your default encryption key.

KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.

createEndpoint_microsoftSQLServerSettings :: Lens' CreateEndpoint (Maybe MicrosoftSQLServerSettings) Source #

Settings in JSON format for the source and target Microsoft SQL Server endpoint. For information about other available settings, see Extra connection attributes when using SQL Server as a source for DMS and Extra connection attributes when using SQL Server as a target for DMS in the Database Migration Service User Guide.

createEndpoint_mongoDbSettings :: Lens' CreateEndpoint (Maybe MongoDbSettings) Source #

Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see Endpoint configuration settings when using MongoDB as a source for Database Migration Service in the Database Migration Service User Guide.

createEndpoint_mySQLSettings :: Lens' CreateEndpoint (Maybe MySQLSettings) Source #

Settings in JSON format for the source and target MySQL endpoint. For information about other available settings, see Extra connection attributes when using MySQL as a source for DMS and Extra connection attributes when using a MySQL-compatible database as a target for DMS in the Database Migration Service User Guide.

createEndpoint_neptuneSettings :: Lens' CreateEndpoint (Maybe NeptuneSettings) Source #

Settings in JSON format for the target Amazon Neptune endpoint. For more information about the available settings, see Specifying graph-mapping rules using Gremlin and R2RML for Amazon Neptune as a target in the Database Migration Service User Guide.

createEndpoint_oracleSettings :: Lens' CreateEndpoint (Maybe OracleSettings) Source #

Settings in JSON format for the source and target Oracle endpoint. For information about other available settings, see Extra connection attributes when using Oracle as a source for DMS and Extra connection attributes when using Oracle as a target for DMS in the Database Migration Service User Guide.

createEndpoint_password :: Lens' CreateEndpoint (Maybe Text) Source #

The password to be used to log in to the endpoint database.

createEndpoint_port :: Lens' CreateEndpoint (Maybe Int) Source #

The port used by the endpoint database.

createEndpoint_postgreSQLSettings :: Lens' CreateEndpoint (Maybe PostgreSQLSettings) Source #

Settings in JSON format for the source and target PostgreSQL endpoint. For information about other available settings, see Extra connection attributes when using PostgreSQL as a source for DMS and Extra connection attributes when using PostgreSQL as a target for DMS in the Database Migration Service User Guide.

createEndpoint_redisSettings :: Lens' CreateEndpoint (Maybe RedisSettings) Source #

Settings in JSON format for the target Redis endpoint.

createEndpoint_redshiftSettings :: Lens' CreateEndpoint (Maybe RedshiftSettings) Source #

Undocumented member.

createEndpoint_resourceIdentifier :: Lens' CreateEndpoint (Maybe Text) Source #

A friendly name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object. The value for this parameter can have up to 31 characters. It can contain only ASCII letters, digits, and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as Example-App-ARN1. For example, this value might result in the EndpointArn value arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. If you don't specify a ResourceIdentifier value, DMS generates a default identifier value for the end of EndpointArn.

createEndpoint_s3Settings :: Lens' CreateEndpoint (Maybe S3Settings) Source #

Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see Extra Connection Attributes When Using Amazon S3 as a Target for DMS in the Database Migration Service User Guide.

createEndpoint_serverName :: Lens' CreateEndpoint (Maybe Text) Source #

The name of the server where the endpoint database resides.

createEndpoint_serviceAccessRoleArn :: Lens' CreateEndpoint (Maybe Text) Source #

The Amazon Resource Name (ARN) for the service access role that you want to use to create the endpoint. The role must allow the iam:PassRole action.

createEndpoint_sslMode :: Lens' CreateEndpoint (Maybe DmsSslModeValue) Source #

The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is none

createEndpoint_sybaseSettings :: Lens' CreateEndpoint (Maybe SybaseSettings) Source #

Settings in JSON format for the source and target SAP ASE endpoint. For information about other available settings, see Extra connection attributes when using SAP ASE as a source for DMS and Extra connection attributes when using SAP ASE as a target for DMS in the Database Migration Service User Guide.

createEndpoint_tags :: Lens' CreateEndpoint (Maybe [Tag]) Source #

One or more tags to be assigned to the endpoint.

createEndpoint_username :: Lens' CreateEndpoint (Maybe Text) Source #

The user name to be used to log in to the endpoint database.

createEndpoint_endpointIdentifier :: Lens' CreateEndpoint Text Source #

The database endpoint identifier. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen, or contain two consecutive hyphens.

createEndpoint_endpointType :: Lens' CreateEndpoint ReplicationEndpointTypeValue Source #

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

createEndpoint_engineName :: Lens' CreateEndpoint Text Source #

The type of engine for the endpoint. Valid values, depending on the EndpointType value, include "mysql", "oracle", "postgres", "mariadb", "aurora", "aurora-postgresql", "opensearch", "redshift", "s3", "db2", "db2-zos", "azuredb", "sybase", "dynamodb", "mongodb", "kinesis", "kafka", "elasticsearch", "docdb", "sqlserver", "neptune", and "babelfish".

Destructuring the Response

data CreateEndpointResponse Source #

See: newCreateEndpointResponse smart constructor.

Constructors

CreateEndpointResponse'
Fields endpoint :: Maybe Endpoint The endpoint that was created. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateEndpointResponse Source #
Instance details Defined in Amazonka.DMS.CreateEndpoint Associated Types type Rep CreateEndpointResponse :: Type -> Type # Methods from :: CreateEndpointResponse -> Rep CreateEndpointResponse x # to :: Rep CreateEndpointResponse x -> CreateEndpointResponse #
Show CreateEndpointResponse Source #
Instance details Defined in Amazonka.DMS.CreateEndpoint Methods showsPrec :: Int -> CreateEndpointResponse -> ShowS # show :: CreateEndpointResponse -> String # showList :: [CreateEndpointResponse] -> ShowS #
NFData CreateEndpointResponse Source #
Instance details Defined in Amazonka.DMS.CreateEndpoint Methods rnf :: CreateEndpointResponse -> () #
Eq CreateEndpointResponse Source #
Instance details Defined in Amazonka.DMS.CreateEndpoint Methods (==) :: CreateEndpointResponse -> CreateEndpointResponse -> Bool # (/=) :: CreateEndpointResponse -> CreateEndpointResponse -> Bool #
type Rep CreateEndpointResponse Source #
Instance details Defined in Amazonka.DMS.CreateEndpoint type Rep CreateEndpointResponse = D1 ('MetaData "CreateEndpointResponse" "Amazonka.DMS.CreateEndpoint" "amazonka-dms-2.0-LVCLJv4CY4nJuf0WXCDs3O" 'False) (C1 ('MetaCons "CreateEndpointResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "endpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Endpoint)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateEndpointResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateEndpointResponse'`
-> CreateEndpointResponse

Create a value of CreateEndpointResponse 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:endpoint:CreateEndpointResponse', createEndpointResponse_endpoint - The endpoint that was created.

$sel:httpStatus:CreateEndpointResponse', createEndpointResponse_httpStatus - The response's http status code.

Response Lenses

createEndpointResponse_endpoint :: Lens' CreateEndpointResponse (Maybe Endpoint) Source #

The endpoint that was created.

createEndpointResponse_httpStatus :: Lens' CreateEndpointResponse Int Source #

The response's http status code.