CfnEndpointProps Struct
Properties for defining a CfnEndpoint.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_dms as dms } from 'aws-cdk-lib';
const cfnEndpointProps: dms.CfnEndpointProps = {
endpointType: 'endpointType',
engineName: 'engineName',
// the properties below are optional
certificateArn: 'certificateArn',
databaseName: 'databaseName',
docDbSettings: {
docsToInvestigate: 123,
extractDocId: false,
nestingLevel: 'nestingLevel',
secretsManagerAccessRoleArn: 'secretsManagerAccessRoleArn',
secretsManagerSecretId: 'secretsManagerSecretId',
},
dynamoDbSettings: {
serviceAccessRoleArn: 'serviceAccessRoleArn',
},
elasticsearchSettings: {
endpointUri: 'endpointUri',
errorRetryDuration: 123,
fullLoadErrorPercentage: 123,
serviceAccessRoleArn: 'serviceAccessRoleArn',
},
endpointIdentifier: 'endpointIdentifier',
extraConnectionAttributes: 'extraConnectionAttributes',
gcpMySqlSettings: {
afterConnectScript: 'afterConnectScript',
cleanSourceMetadataOnMismatch: false,
databaseName: 'databaseName',
eventsPollInterval: 123,
maxFileSize: 123,
parallelLoadThreads: 123,
password: 'password',
port: 123,
secretsManagerAccessRoleArn: 'secretsManagerAccessRoleArn',
secretsManagerSecretId: 'secretsManagerSecretId',
serverName: 'serverName',
serverTimezone: 'serverTimezone',
username: 'username',
},
ibmDb2Settings: {
currentLsn: 'currentLsn',
keepCsvFiles: false,
loadTimeout: 123,
maxFileSize: 123,
maxKBytesPerRead: 123,
secretsManagerAccessRoleArn: 'secretsManagerAccessRoleArn',
secretsManagerSecretId: 'secretsManagerSecretId',
setDataCaptureChanges: false,
writeBufferSize: 123,
},
kafkaSettings: {
broker: 'broker',
includeControlDetails: false,
includeNullAndEmpty: false,
includePartitionValue: false,
includeTableAlterOperations: false,
includeTransactionDetails: false,
messageFormat: 'messageFormat',
messageMaxBytes: 123,
noHexPrefix: false,
partitionIncludeSchemaTable: false,
saslPassword: 'saslPassword',
saslUserName: 'saslUserName',
securityProtocol: 'securityProtocol',
sslCaCertificateArn: 'sslCaCertificateArn',
sslClientCertificateArn: 'sslClientCertificateArn',
sslClientKeyArn: 'sslClientKeyArn',
sslClientKeyPassword: 'sslClientKeyPassword',
topic: 'topic',
},
kinesisSettings: {
includeControlDetails: false,
includeNullAndEmpty: false,
includePartitionValue: false,
includeTableAlterOperations: false,
includeTransactionDetails: false,
messageFormat: 'messageFormat',
noHexPrefix: false,
partitionIncludeSchemaTable: false,
serviceAccessRoleArn: 'serviceAccessRoleArn',
streamArn: 'streamArn',
},
kmsKeyId: 'kmsKeyId',
microsoftSqlServerSettings: {
bcpPacketSize: 123,
controlTablesFileGroup: 'controlTablesFileGroup',
databaseName: 'databaseName',
forceLobLookup: false,
password: 'password',
port: 123,
querySingleAlwaysOnNode: false,
readBackupOnly: false,
safeguardPolicy: 'safeguardPolicy',
secretsManagerAccessRoleArn: 'secretsManagerAccessRoleArn',
secretsManagerSecretId: 'secretsManagerSecretId',
serverName: 'serverName',
tlogAccessMode: 'tlogAccessMode',
trimSpaceInChar: false,
useBcpFullLoad: false,
username: 'username',
useThirdPartyBackupDevice: false,
},
mongoDbSettings: {
authMechanism: 'authMechanism',
authSource: 'authSource',
authType: 'authType',
databaseName: 'databaseName',
docsToInvestigate: 'docsToInvestigate',
extractDocId: 'extractDocId',
nestingLevel: 'nestingLevel',
password: 'password',
port: 123,
secretsManagerAccessRoleArn: 'secretsManagerAccessRoleArn',
secretsManagerSecretId: 'secretsManagerSecretId',
serverName: 'serverName',
username: 'username',
},
mySqlSettings: {
afterConnectScript: 'afterConnectScript',
cleanSourceMetadataOnMismatch: false,
eventsPollInterval: 123,
maxFileSize: 123,
parallelLoadThreads: 123,
secretsManagerAccessRoleArn: 'secretsManagerAccessRoleArn',
secretsManagerSecretId: 'secretsManagerSecretId',
serverTimezone: 'serverTimezone',
targetDbType: 'targetDbType',
},
neptuneSettings: {
errorRetryDuration: 123,
iamAuthEnabled: false,
maxFileSize: 123,
maxRetryCount: 123,
s3BucketFolder: 's3BucketFolder',
s3BucketName: 's3BucketName',
serviceAccessRoleArn: 'serviceAccessRoleArn',
},
oracleSettings: {
accessAlternateDirectly: false,
additionalArchivedLogDestId: 123,
addSupplementalLogging: false,
allowSelectNestedTables: false,
archivedLogDestId: 123,
archivedLogsOnly: false,
asmPassword: 'asmPassword',
asmServer: 'asmServer',
asmUser: 'asmUser',
charLengthSemantics: 'charLengthSemantics',
directPathNoLog: false,
directPathParallelLoad: false,
enableHomogenousTablespace: false,
extraArchivedLogDestIds: [123],
failTasksOnLobTruncation: false,
numberDatatypeScale: 123,
oraclePathPrefix: 'oraclePathPrefix',
parallelAsmReadThreads: 123,
readAheadBlocks: 123,
readTableSpaceName: false,
replacePathPrefix: false,
retryInterval: 123,
secretsManagerAccessRoleArn: 'secretsManagerAccessRoleArn',
secretsManagerOracleAsmAccessRoleArn: 'secretsManagerOracleAsmAccessRoleArn',
secretsManagerOracleAsmSecretId: 'secretsManagerOracleAsmSecretId',
secretsManagerSecretId: 'secretsManagerSecretId',
securityDbEncryption: 'securityDbEncryption',
securityDbEncryptionName: 'securityDbEncryptionName',
spatialDataOptionToGeoJsonFunctionName: 'spatialDataOptionToGeoJsonFunctionName',
standbyDelayTime: 123,
useAlternateFolderForOnline: false,
useBFile: false,
useDirectPathFullLoad: false,
useLogminerReader: false,
usePathPrefix: 'usePathPrefix',
},
password: 'password',
port: 123,
postgreSqlSettings: {
afterConnectScript: 'afterConnectScript',
babelfishDatabaseName: 'babelfishDatabaseName',
captureDdls: false,
databaseMode: 'databaseMode',
ddlArtifactsSchema: 'ddlArtifactsSchema',
executeTimeout: 123,
failTasksOnLobTruncation: false,
heartbeatEnable: false,
heartbeatFrequency: 123,
heartbeatSchema: 'heartbeatSchema',
mapBooleanAsBoolean: false,
maxFileSize: 123,
pluginName: 'pluginName',
secretsManagerAccessRoleArn: 'secretsManagerAccessRoleArn',
secretsManagerSecretId: 'secretsManagerSecretId',
slotName: 'slotName',
},
redisSettings: {
authPassword: 'authPassword',
authType: 'authType',
authUserName: 'authUserName',
port: 123,
serverName: 'serverName',
sslCaCertificateArn: 'sslCaCertificateArn',
sslSecurityProtocol: 'sslSecurityProtocol',
},
redshiftSettings: {
acceptAnyDate: false,
afterConnectScript: 'afterConnectScript',
bucketFolder: 'bucketFolder',
bucketName: 'bucketName',
caseSensitiveNames: false,
compUpdate: false,
connectionTimeout: 123,
dateFormat: 'dateFormat',
emptyAsNull: false,
encryptionMode: 'encryptionMode',
explicitIds: false,
fileTransferUploadStreams: 123,
loadTimeout: 123,
mapBooleanAsBoolean: false,
maxFileSize: 123,
removeQuotes: false,
replaceChars: 'replaceChars',
replaceInvalidChars: 'replaceInvalidChars',
secretsManagerAccessRoleArn: 'secretsManagerAccessRoleArn',
secretsManagerSecretId: 'secretsManagerSecretId',
serverSideEncryptionKmsKeyId: 'serverSideEncryptionKmsKeyId',
serviceAccessRoleArn: 'serviceAccessRoleArn',
timeFormat: 'timeFormat',
trimBlanks: false,
truncateColumns: false,
writeBufferSize: 123,
},
resourceIdentifier: 'resourceIdentifier',
s3Settings: {
addColumnName: false,
addTrailingPaddingCharacter: false,
bucketFolder: 'bucketFolder',
bucketName: 'bucketName',
cannedAclForObjects: 'cannedAclForObjects',
cdcInsertsAndUpdates: false,
cdcInsertsOnly: false,
cdcMaxBatchInterval: 123,
cdcMinFileSize: 123,
cdcPath: 'cdcPath',
compressionType: 'compressionType',
csvDelimiter: 'csvDelimiter',
csvNoSupValue: 'csvNoSupValue',
csvNullValue: 'csvNullValue',
csvRowDelimiter: 'csvRowDelimiter',
dataFormat: 'dataFormat',
dataPageSize: 123,
datePartitionDelimiter: 'datePartitionDelimiter',
datePartitionEnabled: false,
datePartitionSequence: 'datePartitionSequence',
datePartitionTimezone: 'datePartitionTimezone',
dictPageSizeLimit: 123,
enableStatistics: false,
encodingType: 'encodingType',
encryptionMode: 'encryptionMode',
expectedBucketOwner: 'expectedBucketOwner',
externalTableDefinition: 'externalTableDefinition',
glueCatalogGeneration: false,
ignoreHeaderRows: 123,
includeOpForFullLoad: false,
maxFileSize: 123,
parquetTimestampInMillisecond: false,
parquetVersion: 'parquetVersion',
preserveTransactions: false,
rfc4180: false,
rowGroupLength: 123,
serverSideEncryptionKmsKeyId: 'serverSideEncryptionKmsKeyId',
serviceAccessRoleArn: 'serviceAccessRoleArn',
timestampColumnName: 'timestampColumnName',
useCsvNoSupValue: false,
useTaskStartTimeForFullLoadTimestamp: false,
},
serverName: 'serverName',
sslMode: 'sslMode',
sybaseSettings: {
secretsManagerAccessRoleArn: 'secretsManagerAccessRoleArn',
secretsManagerSecretId: 'secretsManagerSecretId',
},
tags: [{
key: 'key',
value: 'value',
}],
username: 'username',
};
Properties
certificateArnstringcertificate_arnstrcertificateArnStringCertificateArnstringCertificateArn*string#For a MySQL source or target endpoint, don't specify DatabaseName . To migrate to a specific database, use this setting and targetDbType .
docDbSettingsIResolvable | CfnEndpoint.DocDbSettingsPropertydoc_db_settingstyping.Union[IResolvable, DocDbSettingsProperty]docDbSettingsIResolvableDocDbSettingsIResolvableDocDbSettingsinterface{}#notes
For more information about other available settings, see Using extra connections attributes with Amazon DocumentDB as a source and Using Amazon DocumentDB as a target for AWS Database Migration Service in the AWS Database Migration Service User Guide .
dynamoDbSettingsIResolvable | CfnEndpoint.DynamoDbSettingsPropertydynamo_db_settingstyping.Union[IResolvable, DynamoDbSettingsProperty]dynamoDbSettingsIResolvableDynamoDbSettingsIResolvableDynamoDbSettingsinterface{}#notes
For information about other available settings, see Using object mapping to migrate data to DynamoDB in the AWS Database Migration Service User Guide .
elasticsearchSettingsIResolvable | CfnEndpoint.ElasticsearchSettingsPropertyelasticsearch_settingstyping.Union[IResolvable, ElasticsearchSettingsProperty]elasticsearchSettingsIResolvableElasticsearchSettingsIResolvableElasticsearchSettingsinterface{}#notes
For more information about the available settings, see Extra connection attributes when using OpenSearch as a target for AWS DMS in the AWS Database Migration Service User Guide .
endpointIdentifierstringendpoint_identifierstrendpointIdentifierStringEndpointIdentifierstringEndpointIdentifier*string#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.
Valid values are source and target .
notes
Valid values : mysql | oracle | postgres | mariadb | aurora | aurora-postgresql | opensearch | redshift | redshift-serverless | s3 | db2 | azuredb | sybase | dynamodb | mongodb | kinesis | kafka | elasticsearch | docdb | sqlserver | neptune
extraConnectionAttributesstringextra_connection_attributesstrextraConnectionAttributesStringExtraConnectionAttributesstringExtraConnectionAttributes*string#notes
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 AWS DMS Endpoints in the AWS Database Migration Service User Guide .
gcpMySqlSettingsIResolvable | CfnEndpoint.GcpMySQLSettingsPropertygcp_my_sql_settingstyping.Union[IResolvable, GcpMySQLSettingsProperty]gcpMySqlSettingsIResolvableGcpMySqlSettingsIResolvableGcpMySqlSettingsinterface{}#notes
These settings are much the same as the settings for any MySQL-compatible endpoint. For more information, see Extra connection attributes when using MySQL as a source for AWS DMS in the AWS Database Migration Service User Guide .
ibmDb2SettingsIResolvable | CfnEndpoint.IbmDb2SettingsPropertyibm_db2_settingstyping.Union[IResolvable, IbmDb2SettingsProperty]ibmDb2SettingsIResolvableIbmDb2SettingsIResolvableIbmDb2Settingsinterface{}#notes
For information about other available settings, see Extra connection attributes when using Db2 LUW as a source for AWS DMS in the AWS Database Migration Service User Guide .
kafkaSettingsIResolvable | CfnEndpoint.KafkaSettingsPropertykafka_settingstyping.Union[IResolvable, KafkaSettingsProperty]kafkaSettingsIResolvableKafkaSettingsIResolvableKafkaSettingsinterface{}#notes
For more information about other available settings, see Using object mapping to migrate data to a Kafka topic in the AWS Database Migration Service User Guide .
kinesisSettingsIResolvable | CfnEndpoint.KinesisSettingsPropertykinesis_settingstyping.Union[IResolvable, KinesisSettingsProperty]kinesisSettingsIResolvableKinesisSettingsIResolvableKinesisSettingsinterface{}#notes
For more information about other available settings, see Using object mapping to migrate data to a Kinesis data stream in the AWS Database Migration Service User Guide .
notes
If you don't specify a value for the KmsKeyId parameter, AWS DMS uses your default encryption key.
AWS creates the default encryption key for your AWS account . Your AWS account has a different default encryption key for each AWS Region .
microsoftSqlServerSettingsIResolvable | CfnEndpoint.MicrosoftSqlServerSettingsPropertymicrosoft_sql_server_settingstyping.Union[IResolvable, MicrosoftSqlServerSettingsProperty]microsoftSqlServerSettingsIResolvableMicrosoftSqlServerSettingsIResolvableMicrosoftSqlServerSettingsinterface{}#notes
For information about other available settings, see Extra connection attributes when using SQL Server as a source for AWS DMS and Extra connection attributes when using SQL Server as a target for AWS DMS in the AWS Database Migration Service User Guide .
mongoDbSettingsIResolvable | CfnEndpoint.MongoDbSettingsPropertymongo_db_settingstyping.Union[IResolvable, MongoDbSettingsProperty]mongoDbSettingsIResolvableMongoDbSettingsIResolvableMongoDbSettingsinterface{}#notes
For more information about the available settings, see Using MongoDB as a target for AWS Database Migration Service in the AWS Database Migration Service User Guide .
mySqlSettingsIResolvable | CfnEndpoint.MySqlSettingsPropertymy_sql_settingstyping.Union[IResolvable, MySqlSettingsProperty]mySqlSettingsIResolvableMySqlSettingsIResolvableMySqlSettingsinterface{}#notes
For information about other available settings, see Extra connection attributes when using MySQL as a source for AWS DMS and Extra connection attributes when using a MySQL-compatible database as a target for AWS DMS in the AWS Database Migration Service User Guide .
neptuneSettingsIResolvable | CfnEndpoint.NeptuneSettingsPropertyneptune_settingstyping.Union[IResolvable, NeptuneSettingsProperty]neptuneSettingsIResolvableNeptuneSettingsIResolvableNeptuneSettingsinterface{}#notes
For more information about the available settings, see Specifying endpoint settings for Amazon Neptune as a target in the AWS Database Migration Service User Guide .
oracleSettingsIResolvable | CfnEndpoint.OracleSettingsPropertyoracle_settingstyping.Union[IResolvable, OracleSettingsProperty]oracleSettingsIResolvableOracleSettingsIResolvableOracleSettingsinterface{}#notes
For information about other available settings, see Extra connection attributes when using Oracle as a source for AWS DMS and Extra connection attributes when using Oracle as a target for AWS DMS in the AWS Database Migration Service User Guide .
postgreSqlSettingsIResolvable | CfnEndpoint.PostgreSqlSettingsPropertypostgre_sql_settingstyping.Union[IResolvable, PostgreSqlSettingsProperty]postgreSqlSettingsIResolvablePostgreSqlSettingsIResolvablePostgreSqlSettingsinterface{}#notes
For information about other available settings, see Extra connection attributes when using PostgreSQL as a source for AWS DMS and Extra connection attributes when using PostgreSQL as a target for AWS DMS in the AWS Database Migration Service User Guide .
redisSettingsIResolvable | CfnEndpoint.RedisSettingsPropertyredis_settingstyping.Union[IResolvable, RedisSettingsProperty]redisSettingsIResolvableRedisSettingsIResolvableRedisSettingsinterface{}#notes
For information about other available settings, see Specifying endpoint settings for Redis as a target in the AWS Database Migration Service User Guide .
redshiftSettingsIResolvable | CfnEndpoint.RedshiftSettingsPropertyredshift_settingstyping.Union[IResolvable, RedshiftSettingsProperty]redshiftSettingsIResolvableRedshiftSettingsIResolvableRedshiftSettingsinterface{}#notes
For more information about other available settings, see Extra connection attributes when using Amazon Redshift as a target for AWS DMS in the AWS Database Migration Service User Guide .
resourceIdentifierstringresource_identifierstrresourceIdentifierStringResourceIdentifierstringResourceIdentifier*string#notes
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, AWS DMS generates a default identifier value for the end of EndpointArn .
s3SettingsIResolvable | CfnEndpoint.S3SettingsPropertys3_settingstyping.Union[IResolvable, S3SettingsProperty]s3SettingsIResolvableS3SettingsIResolvableS3Settingsinterface{}#notes
For more information about other available settings, see Extra connection attributes when using Amazon S3 as a source for AWS DMS and Extra connection attributes when using Amazon S3 as a target for AWS DMS in the AWS Database Migration Service User Guide .
When
engine_nameis set to S3, the only allowed value isnone.
sybaseSettingsIResolvable | CfnEndpoint.SybaseSettingsPropertysybase_settingstyping.Union[IResolvable, SybaseSettingsProperty]sybaseSettingsIResolvableSybaseSettingsIResolvableSybaseSettingsinterface{}#notes
For information about other available settings, see Extra connection attributes when using SAP ASE as a source for AWS DMS and Extra connection attributes when using SAP ASE as a target for AWS DMS in the AWS Database Migration Service User Guide .