interface CfnEndpointProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.DMS.CfnEndpointProps |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awsdms#CfnEndpointProps |
 Java | software.amazon.awscdk.services.dms.CfnEndpointProps |
 Python | aws_cdk.aws_dms.CfnEndpointProps |
 TypeScript | aws-cdk-lib » aws_dms » CfnEndpointProps |
Properties for defining a CfnEndpoint.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html
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
| Name | Type | Description |
|---|---|---|
| endpoint | string | The type of endpoint. |
| engine | string | The type of engine for the endpoint, depending on the EndpointType value. |
| certificate | string | The Amazon Resource Name (ARN) for the certificate. |
| database | string | The name of the endpoint database. |
| doc | IResolvable | Doc | Settings in JSON format for the source and target DocumentDB endpoint. |
| dynamo | IResolvable | Dynamo | Settings in JSON format for the target Amazon DynamoDB endpoint. |
| elasticsearch | IResolvable | Elasticsearch | Settings in JSON format for the target OpenSearch endpoint. |
| endpoint | string | The database endpoint identifier. |
| extra | string | Additional attributes associated with the connection. |
| gcp | IResolvable | Gcp | Settings in JSON format for the source GCP MySQL endpoint. |
| ibm | IResolvable | Ibm | Settings in JSON format for the source IBM Db2 LUW endpoint. |
| kafka | IResolvable | Kafka | Settings in JSON format for the target Apache Kafka endpoint. |
| kinesis | IResolvable | Kinesis | Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. |
| kms | string | An AWS KMS key identifier that is used to encrypt the connection parameters for the endpoint. |
| microsoft | IResolvable | Microsoft | Settings in JSON format for the source and target Microsoft SQL Server endpoint. |
| mongo | IResolvable | Mongo | Settings in JSON format for the source MongoDB endpoint. |
| my | IResolvable | My | Settings in JSON format for the source and target MySQL endpoint. |
| neptune | IResolvable | Neptune | Settings in JSON format for the target Amazon Neptune endpoint. |
| oracle | IResolvable | Oracle | Settings in JSON format for the source and target Oracle endpoint. |
| password? | string | The password to be used to log in to the endpoint database. |
| port? | number | The port used by the endpoint database. |
| postgre | IResolvable | Postgre | Settings in JSON format for the source and target PostgreSQL endpoint. |
| redis | IResolvable | Redis | Settings in JSON format for the target Redis endpoint. |
| redshift | IResolvable | Redshift | Settings in JSON format for the Amazon Redshift endpoint. |
| resource | string | A display name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object. |
| s3 | IResolvable | S3 | Settings in JSON format for the source and target Amazon S3 endpoint. |
| server | string | The name of the server where the endpoint database resides. |
| ssl | string | The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is none . |
| sybase | IResolvable | Sybase | Settings in JSON format for the source and target SAP ASE endpoint. |
| tags? | Cfn[] | One or more tags to be assigned to the endpoint. |
| username? | string | The user name to be used to log in to the endpoint database. |
endpointType
Type:
string
The type of endpoint.
Valid values are source and target .
engineName
Type:
string
The type of engine for the endpoint, depending on the EndpointType value.
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
certificateArn?
Type:
string
(optional)
The Amazon Resource Name (ARN) for the certificate.
databaseName?
Type:
string
(optional)
The name of the endpoint database.
For a MySQL source or target endpoint, don't specify DatabaseName . To migrate to a specific database, use this setting and targetDbType .
docDbSettings?
Type:
IResolvable | Doc
(optional)
Settings in JSON format for the source and target DocumentDB endpoint.
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 .
dynamoDbSettings?
Type:
IResolvable | Dynamo
(optional)
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 AWS Database Migration Service User Guide .
elasticsearchSettings?
Type:
IResolvable | Elasticsearch
(optional)
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 AWS DMS in the AWS Database Migration Service User Guide .
endpointIdentifier?
Type:
string
(optional)
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.
extraConnectionAttributes?
Type:
string
(optional)
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 AWS DMS Endpoints in the AWS Database Migration Service User Guide .
gcpMySqlSettings?
Type:
IResolvable | Gcp
(optional)
Settings in JSON format for the source GCP MySQL endpoint.
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 .
ibmDb2Settings?
Type:
IResolvable | Ibm
(optional)
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 AWS DMS in the AWS Database Migration Service User Guide .
kafkaSettings?
Type:
IResolvable | Kafka
(optional)
Settings in JSON format for the target Apache Kafka endpoint.
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 .
kinesisSettings?
Type:
IResolvable | Kinesis
(optional)
Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams.
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 .
kmsKeyId?
Type:
string
(optional)
An AWS 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, AWS DMS uses your default encryption key.
AWS KMS creates the default encryption key for your AWS account . Your AWS account has a different default encryption key for each AWS Region .
microsoftSqlServerSettings?
Type:
IResolvable | Microsoft
(optional)
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 AWS DMS and Extra connection attributes when using SQL Server as a target for AWS DMS in the AWS Database Migration Service User Guide .
mongoDbSettings?
Type:
IResolvable | Mongo
(optional)
Settings in JSON format for the source MongoDB endpoint.
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 .
mySqlSettings?
Type:
IResolvable | My
(optional)
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 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 .
neptuneSettings?
Type:
IResolvable | Neptune
(optional)
Settings in JSON format for the target Amazon Neptune endpoint.
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 .
oracleSettings?
Type:
IResolvable | Oracle
(optional)
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 AWS DMS and Extra connection attributes when using Oracle as a target for AWS DMS in the AWS Database Migration Service User Guide .
password?
Type:
string
(optional)
The password to be used to log in to the endpoint database.
port?
Type:
number
(optional)
The port used by the endpoint database.
postgreSqlSettings?
Type:
IResolvable | Postgre
(optional)
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 AWS DMS and Extra connection attributes when using PostgreSQL as a target for AWS DMS in the AWS Database Migration Service User Guide .
redisSettings?
Type:
IResolvable | Redis
(optional)
Settings in JSON format for the target Redis endpoint.
For information about other available settings, see Specifying endpoint settings for Redis as a target in the AWS Database Migration Service User Guide .
redshiftSettings?
Type:
IResolvable | Redshift
(optional)
Settings in JSON format for the Amazon Redshift endpoint.
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 .
resourceIdentifier?
Type:
string
(optional)
A display 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, AWS DMS generates a default identifier value for the end of EndpointArn .
s3Settings?
Type:
IResolvable | S3
(optional)
Settings in JSON format for the source and target Amazon S3 endpoint.
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 .
serverName?
Type:
string
(optional)
The name of the server where the endpoint database resides.
sslMode?
Type:
string
(optional)
The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is none .
When
engine_nameis set to S3, the only allowed value isnone.
sybaseSettings?
Type:
IResolvable | Sybase
(optional)
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 AWS DMS and Extra connection attributes when using SAP ASE as a target for AWS DMS in the AWS Database Migration Service User Guide .
tags?
Type:
Cfn[]
(optional)
One or more tags to be assigned to the endpoint.
username?
Type:
string
(optional)
The user name to be used to log in to the endpoint database.