databasemigrationservice/aws.sdk.kotlin.services.databasemigrationservice.model/ModifyEndpointRequest/Builder

Builder

class Builder

Properties

certificateArn

var certificateArn: String?

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

databaseName

var databaseName: String?

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

dmsTransferSettings

var dmsTransferSettings: DmsTransferSettings?

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

docDbSettings

var docDbSettings: 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

var dynamoDbSettings: 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

var elasticsearchSettings: 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.

endpointArn

var endpointArn: String?

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

endpointIdentifier

var endpointIdentifier: String?

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

var endpointType: ReplicationEndpointTypeValue?

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

engineName

var engineName: String?

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

var exactSettings: Boolean?

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:

externalTableDefinition

var externalTableDefinition: String?

The external table definition.

extraConnectionAttributes

var extraConnectionAttributes: String?

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

gcpMySqlSettings

var gcpMySqlSettings: GcpMySqlSettings?

Settings in JSON format for the source GCP MySQL endpoint.

ibmDb2Settings

var ibmDb2Settings: 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

var kafkaSettings: 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

var kinesisSettings: 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

var microsoftSqlServerSettings: 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

var mongoDbSettings: 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

var mySqlSettings: 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

var neptuneSettings: 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

var oracleSettings: 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

var password: String?

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

port

var port: Int?

The port used by the endpoint database.

postgreSqlSettings

var postgreSqlSettings: 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

var redisSettings: RedisSettings?

Settings in JSON format for the Redis target endpoint.

redshiftSettings

var redshiftSettings: RedshiftSettings?

Provides information that defines an Amazon Redshift endpoint.

s3Settings

var s3Settings: 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

var serverName: String?

The name of the server where the endpoint database resides.

serviceAccessRoleArn

var serviceAccessRoleArn: String?

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

var sslMode: DmsSslModeValue?

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

sybaseSettings

var sybaseSettings: 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.