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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Modifies the specified endpoint.

For a MySQL source or target endpoint, don't explicitly specify the database using the DatabaseName request parameter on the ModifyEndpoint API call. Specifying DatabaseName when you modify 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 ModifyEndpoint Source #

See: newModifyEndpoint smart constructor.

Constructors

ModifyEndpoint'

Fields

certificateArn :: Maybe Text
The Amazon Resource Name (ARN) of the certificate used for SSL connection.
databaseName :: Maybe Text
The name of the endpoint database. For a MySQL source or target endpoint, do not specify DatabaseName.
dmsTransferSettings :: Maybe DmsTransferSettings
The settings in JSON format for the DMS transfer type of source endpoint.
Attributes 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
Settings in JSON format for the source DocumentDB endpoint. For more information about the available settings, see the configuration properties section in Using DocumentDB as a Target for Database Migration Service in the Database Migration Service User Guide.
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.
endpointIdentifier :: Maybe 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 :: Maybe ReplicationEndpointTypeValue
The type of endpoint. Valid values are source and target.
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".
exactSettings :: Maybe Bool
If this attribute is Y, the current call to ModifyEndpoint replaces all existing endpoint settings with the exact settings that you specify in this call. If this attribute is N, the current call to ModifyEndpoint does two things:
- It replaces any endpoint settings that already exist with new values, for settings with the same names.
- It creates new endpoint settings that you specify in the call, for settings with different names.
For example, if you call create-endpoint ... --endpoint-settings '{"a":1}' ..., the endpoint has the following endpoint settings: '{"a":1}'. If you then call modify-endpoint ... --endpoint-settings '{"b":2}' ... for the same endpoint, the endpoint has the following settings: '{"a":1,"b":2}'.
However, suppose that you follow this with a call to modify-endpoint ... --endpoint-settings '{"b":2}' --exact-settings ... for that same endpoint again. Then the endpoint has the following settings: '{"b":2}'. All existing settings are replaced with the exact settings that you specify.
externalTableDefinition :: Maybe Text
The external table definition.
extraConnectionAttributes :: Maybe Text
Additional attributes associated with the connection. To reset this parameter, pass the empty string ("") as an argument.
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.
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 the configuration properties section in 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 login 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 Redis target endpoint.
redshiftSettings :: Maybe RedshiftSettings
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 IAM role you want to use to modify the endpoint. The role must allow the iam:PassRole action.
sslMode :: Maybe DmsSslModeValue
The SSL mode used to connect to the endpoint. The default value 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.
username :: Maybe Text
The user name to be used to login to the endpoint database.
endpointArn :: Text
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

Instances

Instances details

ToJSON ModifyEndpoint Source #
Instance details Defined in Amazonka.DMS.ModifyEndpoint Methods toJSON :: ModifyEndpoint -> Value # toEncoding :: ModifyEndpoint -> Encoding # toJSONList :: [ModifyEndpoint] -> Value # toEncodingList :: [ModifyEndpoint] -> Encoding #
ToHeaders ModifyEndpoint Source #
Instance details Defined in Amazonka.DMS.ModifyEndpoint Methods toHeaders :: ModifyEndpoint -> [Header] #
ToPath ModifyEndpoint Source #
Instance details Defined in Amazonka.DMS.ModifyEndpoint Methods toPath :: ModifyEndpoint -> ByteString #
ToQuery ModifyEndpoint Source #
Instance details Defined in Amazonka.DMS.ModifyEndpoint Methods toQuery :: ModifyEndpoint -> QueryString #
AWSRequest ModifyEndpoint Source #
Instance details Defined in Amazonka.DMS.ModifyEndpoint Associated Types type AWSResponse ModifyEndpoint # Methods request :: (Service -> Service) -> ModifyEndpoint -> Request ModifyEndpoint # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ModifyEndpoint -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ModifyEndpoint))) #
Generic ModifyEndpoint Source #
Instance details Defined in Amazonka.DMS.ModifyEndpoint Associated Types type Rep ModifyEndpoint :: Type -> Type # Methods from :: ModifyEndpoint -> Rep ModifyEndpoint x # to :: Rep ModifyEndpoint x -> ModifyEndpoint #
Show ModifyEndpoint Source #
Instance details Defined in Amazonka.DMS.ModifyEndpoint Methods showsPrec :: Int -> ModifyEndpoint -> ShowS # show :: ModifyEndpoint -> String # showList :: [ModifyEndpoint] -> ShowS #
NFData ModifyEndpoint Source #
Instance details Defined in Amazonka.DMS.ModifyEndpoint Methods rnf :: ModifyEndpoint -> () #
Eq ModifyEndpoint Source #
Instance details Defined in Amazonka.DMS.ModifyEndpoint Methods (==) :: ModifyEndpoint -> ModifyEndpoint -> Bool # (/=) :: ModifyEndpoint -> ModifyEndpoint -> Bool #
Hashable ModifyEndpoint Source #
Instance details Defined in Amazonka.DMS.ModifyEndpoint Methods hashWithSalt :: Int -> ModifyEndpoint -> Int # hash :: ModifyEndpoint -> Int #
type AWSResponse ModifyEndpoint Source #
Instance details Defined in Amazonka.DMS.ModifyEndpoint type AWSResponse ModifyEndpoint = ModifyEndpointResponse
type Rep ModifyEndpoint Source #
Instance details Defined in Amazonka.DMS.ModifyEndpoint type Rep ModifyEndpoint = D1 ('MetaData "ModifyEndpoint" "Amazonka.DMS.ModifyEndpoint" "amazonka-dms-2.0-LVCLJv4CY4nJuf0WXCDs3O" 'False) (C1 ('MetaCons "ModifyEndpoint'" '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 "endpointIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "endpointType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReplicationEndpointTypeValue))))) :: (((S1 ('MetaSel ('Just "engineName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "exactSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (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 "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 "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 "username") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "endpointArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))))

newModifyEndpoint Source #

Arguments

:: Text	`ModifyEndpoint`
-> ModifyEndpoint

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

ModifyEndpoint, modifyEndpoint_certificateArn - The Amazon Resource Name (ARN) of the certificate used for SSL connection.

ModifyEndpoint, modifyEndpoint_databaseName - The name of the endpoint database. For a MySQL source or target endpoint, do not specify DatabaseName.

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

Attributes 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"}

ModifyEndpoint, modifyEndpoint_docDbSettings - Settings in JSON format for the source DocumentDB endpoint. For more information about the available settings, see the configuration properties section in Using DocumentDB as a Target for Database Migration Service in the Database Migration Service User Guide.

ModifyEndpoint, modifyEndpoint_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.

ModifyEndpoint, modifyEndpoint_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.

ModifyEndpoint, modifyEndpoint_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.

ModifyEndpoint, modifyEndpoint_endpointType - The type of endpoint. Valid values are source and target.

ModifyEndpoint, modifyEndpoint_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:exactSettings:ModifyEndpoint', modifyEndpoint_exactSettings - If this attribute is Y, the current call to ModifyEndpoint replaces all existing endpoint settings with the exact settings that you specify in this call. If this attribute is N, the current call to ModifyEndpoint does two things:

It replaces any endpoint settings that already exist with new values, for settings with the same names.
It creates new endpoint settings that you specify in the call, for settings with different names.

For example, if you call create-endpoint ... --endpoint-settings '{"a":1}' ..., the endpoint has the following endpoint settings: '{"a":1}'. If you then call modify-endpoint ... --endpoint-settings '{"b":2}' ... for the same endpoint, the endpoint has the following settings: '{"a":1,"b":2}'.

However, suppose that you follow this with a call to modify-endpoint ... --endpoint-settings '{"b":2}' --exact-settings ... for that same endpoint again. Then the endpoint has the following settings: '{"b":2}'. All existing settings are replaced with the exact settings that you specify.

ModifyEndpoint, modifyEndpoint_externalTableDefinition - The external table definition.

ModifyEndpoint, modifyEndpoint_extraConnectionAttributes - Additional attributes associated with the connection. To reset this parameter, pass the empty string ("") as an argument.

ModifyEndpoint, modifyEndpoint_gcpMySQLSettings - Settings in JSON format for the source GCP MySQL endpoint.

ModifyEndpoint, modifyEndpoint_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.

ModifyEndpoint, modifyEndpoint_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.

ModifyEndpoint, modifyEndpoint_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.

ModifyEndpoint, modifyEndpoint_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.

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

ModifyEndpoint, modifyEndpoint_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.

ModifyEndpoint, modifyEndpoint_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.

ModifyEndpoint, modifyEndpoint_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.

ModifyEndpoint, modifyEndpoint_password - The password to be used to login to the endpoint database.

ModifyEndpoint, modifyEndpoint_port - The port used by the endpoint database.

ModifyEndpoint, modifyEndpoint_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.

ModifyEndpoint, modifyEndpoint_redisSettings - Settings in JSON format for the Redis target endpoint.

ModifyEndpoint, modifyEndpoint_redshiftSettings - Undocumented member.

ModifyEndpoint, modifyEndpoint_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.

ModifyEndpoint, modifyEndpoint_serverName - The name of the server where the endpoint database resides.

ModifyEndpoint, modifyEndpoint_serviceAccessRoleArn - The Amazon Resource Name (ARN) for the IAM role you want to use to modify the endpoint. The role must allow the iam:PassRole action.

ModifyEndpoint, modifyEndpoint_sslMode - The SSL mode used to connect to the endpoint. The default value is none.

ModifyEndpoint, modifyEndpoint_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.

ModifyEndpoint, modifyEndpoint_username - The user name to be used to login to the endpoint database.

ModifyEndpoint, modifyEndpoint_endpointArn - The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

Request Lenses

modifyEndpoint_certificateArn :: Lens' ModifyEndpoint (Maybe Text) Source #

The Amazon Resource Name (ARN) of the certificate used for SSL connection.

modifyEndpoint_databaseName :: Lens' ModifyEndpoint (Maybe Text) Source #

The name of the endpoint database. For a MySQL source or target endpoint, do not specify DatabaseName.

modifyEndpoint_dmsTransferSettings :: Lens' ModifyEndpoint (Maybe DmsTransferSettings) Source #

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

Attributes 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"}

modifyEndpoint_docDbSettings :: Lens' ModifyEndpoint (Maybe DocDbSettings) Source #

Settings in JSON format for the source DocumentDB endpoint. For more information about the available settings, see the configuration properties section in Using DocumentDB as a Target for Database Migration Service in the Database Migration Service User Guide.

modifyEndpoint_dynamoDbSettings :: Lens' ModifyEndpoint (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.

modifyEndpoint_elasticsearchSettings :: Lens' ModifyEndpoint (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.

modifyEndpoint_endpointIdentifier :: Lens' ModifyEndpoint (Maybe 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.

modifyEndpoint_endpointType :: Lens' ModifyEndpoint (Maybe ReplicationEndpointTypeValue) Source #

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

modifyEndpoint_engineName :: Lens' ModifyEndpoint (Maybe Text) Source #

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

modifyEndpoint_exactSettings :: Lens' ModifyEndpoint (Maybe Bool) Source #

If this attribute is Y, the current call to ModifyEndpoint replaces all existing endpoint settings with the exact settings that you specify in this call. If this attribute is N, the current call to ModifyEndpoint does two things:

It replaces any endpoint settings that already exist with new values, for settings with the same names.
It creates new endpoint settings that you specify in the call, for settings with different names.

For example, if you call create-endpoint ... --endpoint-settings '{"a":1}' ..., the endpoint has the following endpoint settings: '{"a":1}'. If you then call modify-endpoint ... --endpoint-settings '{"b":2}' ... for the same endpoint, the endpoint has the following settings: '{"a":1,"b":2}'.

However, suppose that you follow this with a call to modify-endpoint ... --endpoint-settings '{"b":2}' --exact-settings ... for that same endpoint again. Then the endpoint has the following settings: '{"b":2}'. All existing settings are replaced with the exact settings that you specify.

modifyEndpoint_externalTableDefinition :: Lens' ModifyEndpoint (Maybe Text) Source #

The external table definition.

modifyEndpoint_extraConnectionAttributes :: Lens' ModifyEndpoint (Maybe Text) Source #

Additional attributes associated with the connection. To reset this parameter, pass the empty string ("") as an argument.

modifyEndpoint_gcpMySQLSettings :: Lens' ModifyEndpoint (Maybe GcpMySQLSettings) Source #

Settings in JSON format for the source GCP MySQL endpoint.

modifyEndpoint_iBMDb2Settings :: Lens' ModifyEndpoint (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.

modifyEndpoint_kafkaSettings :: Lens' ModifyEndpoint (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.

modifyEndpoint_kinesisSettings :: Lens' ModifyEndpoint (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.

modifyEndpoint_microsoftSQLServerSettings :: Lens' ModifyEndpoint (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.

modifyEndpoint_mongoDbSettings :: Lens' ModifyEndpoint (Maybe MongoDbSettings) Source #

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

modifyEndpoint_mySQLSettings :: Lens' ModifyEndpoint (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.

modifyEndpoint_neptuneSettings :: Lens' ModifyEndpoint (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.

modifyEndpoint_oracleSettings :: Lens' ModifyEndpoint (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.

modifyEndpoint_password :: Lens' ModifyEndpoint (Maybe Text) Source #

The password to be used to login to the endpoint database.

modifyEndpoint_port :: Lens' ModifyEndpoint (Maybe Int) Source #

The port used by the endpoint database.

modifyEndpoint_postgreSQLSettings :: Lens' ModifyEndpoint (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.

modifyEndpoint_redisSettings :: Lens' ModifyEndpoint (Maybe RedisSettings) Source #

Settings in JSON format for the Redis target endpoint.

modifyEndpoint_redshiftSettings :: Lens' ModifyEndpoint (Maybe RedshiftSettings) Source #

Undocumented member.

modifyEndpoint_s3Settings :: Lens' ModifyEndpoint (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.

modifyEndpoint_serverName :: Lens' ModifyEndpoint (Maybe Text) Source #

The name of the server where the endpoint database resides.

modifyEndpoint_serviceAccessRoleArn :: Lens' ModifyEndpoint (Maybe Text) Source #

The Amazon Resource Name (ARN) for the IAM role you want to use to modify the endpoint. The role must allow the iam:PassRole action.

modifyEndpoint_sslMode :: Lens' ModifyEndpoint (Maybe DmsSslModeValue) Source #

The SSL mode used to connect to the endpoint. The default value is none.

modifyEndpoint_sybaseSettings :: Lens' ModifyEndpoint (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.

modifyEndpoint_username :: Lens' ModifyEndpoint (Maybe Text) Source #

The user name to be used to login to the endpoint database.

modifyEndpoint_endpointArn :: Lens' ModifyEndpoint Text Source #

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

Destructuring the Response

data ModifyEndpointResponse Source #

See: newModifyEndpointResponse smart constructor.

Constructors

ModifyEndpointResponse'
Fields endpoint :: Maybe Endpoint The modified endpoint. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newModifyEndpointResponse Source #

Arguments

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

Create a value of ModifyEndpointResponse 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:ModifyEndpointResponse', modifyEndpointResponse_endpoint - The modified endpoint.

$sel:httpStatus:ModifyEndpointResponse', modifyEndpointResponse_httpStatus - The response's http status code.

Response Lenses

modifyEndpointResponse_endpoint :: Lens' ModifyEndpointResponse (Maybe Endpoint) Source #

The modified endpoint.

modifyEndpointResponse_httpStatus :: Lens' ModifyEndpointResponse Int Source #

The response's http status code.