class CfnEndpoint (construct)

Language	Type name
.NET	Amazon.CDK.AWS.DMS.CfnEndpoint
Java	software.amazon.awscdk.services.dms.CfnEndpoint
Python	aws_cdk.aws_dms.CfnEndpoint
TypeScript	@aws-cdk/aws-dms » CfnEndpoint

Implements IConstruct, IConstruct, IDependable, IInspectable

A CloudFormation AWS::DMS::Endpoint.

The AWS::DMS::Endpoint resource specifies an AWS DMS endpoint.

Currently, AWS CloudFormation supports all AWS DMS endpoint types.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as dms from '@aws-cdk/aws-dms';
const cfnEndpoint = new dms.CfnEndpoint(this, 'MyCfnEndpoint', {
  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',
    maxKBytesPerRead: 123,
    secretsManagerAccessRoleArn: 'secretsManagerAccessRoleArn',
    secretsManagerSecretId: 'secretsManagerSecretId',
    setDataCaptureChanges: false,
  },
  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',
    querySingleAlwaysOnNode: false,
    readBackupOnly: false,
    safeguardPolicy: 'safeguardPolicy',
    secretsManagerAccessRoleArn: 'secretsManagerAccessRoleArn',
    secretsManagerSecretId: 'secretsManagerSecretId',
    useBcpFullLoad: false,
    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',
    captureDdls: false,
    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,
    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',
    externalTableDefinition: 'externalTableDefinition',
    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',
});

Initializer

new CfnEndpoint(scope: Construct, id: string, props: CfnEndpointProps)

Parameters

• scope Construct — - scope in which this resource is defined.
• id string — - scoped id of the resource.
• props CfnEndpointProps — - resource properties.

Create a new AWS::DMS::Endpoint.

Construct Props

Name	Type	Description
endpointType	string	The type of endpoint.
engineName	string	The type of engine for the endpoint, depending on the EndpointType value.
certificateArn?	string	The Amazon Resource Name (ARN) for the certificate.
databaseName?	string	The name of the endpoint database.
docDbSettings?	DocDbSettingsProperty | IResolvable	Settings in JSON format for the source and target DocumentDB endpoint.
dynamoDbSettings?	IResolvable | DynamoDbSettingsProperty	Settings in JSON format for the target Amazon DynamoDB endpoint.
elasticsearchSettings?	IResolvable | ElasticsearchSettingsProperty	Settings in JSON format for the target OpenSearch endpoint.
endpointIdentifier?	string	The database endpoint identifier.
extraConnectionAttributes?	string	Additional attributes associated with the connection.
gcpMySqlSettings?	IResolvable | GcpMySQLSettingsProperty	Settings in JSON format for the source GCP MySQL endpoint.
ibmDb2Settings?	IResolvable | IbmDb2SettingsProperty	Settings in JSON format for the source IBM Db2 LUW endpoint.
kafkaSettings?	IResolvable | KafkaSettingsProperty	Settings in JSON format for the target Apache Kafka endpoint.
kinesisSettings?	IResolvable | KinesisSettingsProperty	Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams.
kmsKeyId?	string	An AWS KMS key identifier that is used to encrypt the connection parameters for the endpoint.
microsoftSqlServerSettings?	IResolvable | MicrosoftSqlServerSettingsProperty	Settings in JSON format for the source and target Microsoft SQL Server endpoint.
mongoDbSettings?	IResolvable | MongoDbSettingsProperty	Settings in JSON format for the source MongoDB endpoint.
mySqlSettings?	IResolvable | MySqlSettingsProperty	Settings in JSON format for the source and target MySQL endpoint.
neptuneSettings?	IResolvable | NeptuneSettingsProperty	Settings in JSON format for the target Amazon Neptune endpoint.
oracleSettings?	IResolvable | OracleSettingsProperty	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.
postgreSqlSettings?	IResolvable | PostgreSqlSettingsProperty	Settings in JSON format for the source and target PostgreSQL endpoint.
redisSettings?	IResolvable | RedisSettingsProperty	Settings in JSON format for the target Redis endpoint.
redshiftSettings?	IResolvable | RedshiftSettingsProperty	Settings in JSON format for the Amazon Redshift endpoint.
resourceIdentifier?	string	A display name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object.
s3Settings?	IResolvable | S3SettingsProperty	Settings in JSON format for the source and target Amazon S3 endpoint.
serverName?	string	The name of the server where the endpoint database resides.
sslMode?	string	The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is none .
sybaseSettings?	IResolvable | SybaseSettingsProperty	Settings in JSON format for the source and target SAP ASE endpoint.
tags?	CfnTag[]	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 | 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: DocDbSettingsProperty | IResolvable (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 | DynamoDbSettingsProperty (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 | ElasticsearchSettingsProperty (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 | GcpMySQLSettingsProperty (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 | IbmDb2SettingsProperty (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 | KafkaSettingsProperty (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 | KinesisSettingsProperty (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 | MicrosoftSqlServerSettingsProperty (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 | MongoDbSettingsProperty (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 | MySqlSettingsProperty (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 | NeptuneSettingsProperty (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 | OracleSettingsProperty (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 | PostgreSqlSettingsProperty (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 | RedisSettingsProperty (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 | RedshiftSettingsProperty (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 | S3SettingsProperty (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_name is set to S3, the only allowed value is none .

---

sybaseSettings?

Type: IResolvable | SybaseSettingsProperty (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: CfnTag[] (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.

Properties

Name	Type	Description
attrExternalId	string	A value that can be used for cross-account validation.
cfnOptions	ICfnResourceOptions	Options for this resource, such as condition, update policy etc.
cfnProperties	{ [string]: any }
cfnResourceType	string	AWS resource type.
creationStack	string[]
endpointType	string	The type of endpoint.
engineName	string	The type of engine for the endpoint, depending on the EndpointType value.
logicalId	string	The logical ID for this CloudFormation stack element.
node	ConstructNode	The construct tree node associated with this construct.
ref	string	Return a string that will be resolved to a CloudFormation { Ref } for this element.
stack	Stack	The stack in which this element is defined.
tags	TagManager	One or more tags to be assigned to the endpoint.
certificateArn?	string	The Amazon Resource Name (ARN) for the certificate.
databaseName?	string	The name of the endpoint database.
docDbSettings?	DocDbSettingsProperty | IResolvable	Settings in JSON format for the source and target DocumentDB endpoint.
dynamoDbSettings?	IResolvable | DynamoDbSettingsProperty	Settings in JSON format for the target Amazon DynamoDB endpoint.
elasticsearchSettings?	IResolvable | ElasticsearchSettingsProperty	Settings in JSON format for the target OpenSearch endpoint.
endpointIdentifier?	string	The database endpoint identifier.
extraConnectionAttributes?	string	Additional attributes associated with the connection.
gcpMySqlSettings?	IResolvable | GcpMySQLSettingsProperty	Settings in JSON format for the source GCP MySQL endpoint.
ibmDb2Settings?	IResolvable | IbmDb2SettingsProperty	Settings in JSON format for the source IBM Db2 LUW endpoint.
kafkaSettings?	IResolvable | KafkaSettingsProperty	Settings in JSON format for the target Apache Kafka endpoint.
kinesisSettings?	IResolvable | KinesisSettingsProperty	Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams.
kmsKeyId?	string	An AWS KMS key identifier that is used to encrypt the connection parameters for the endpoint.
microsoftSqlServerSettings?	IResolvable | MicrosoftSqlServerSettingsProperty	Settings in JSON format for the source and target Microsoft SQL Server endpoint.
mongoDbSettings?	IResolvable | MongoDbSettingsProperty	Settings in JSON format for the source MongoDB endpoint.
mySqlSettings?	IResolvable | MySqlSettingsProperty	Settings in JSON format for the source and target MySQL endpoint.
neptuneSettings?	IResolvable | NeptuneSettingsProperty	Settings in JSON format for the target Amazon Neptune endpoint.
oracleSettings?	IResolvable | OracleSettingsProperty	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.
postgreSqlSettings?	IResolvable | PostgreSqlSettingsProperty	Settings in JSON format for the source and target PostgreSQL endpoint.
redisSettings?	IResolvable | RedisSettingsProperty	Settings in JSON format for the target Redis endpoint.
redshiftSettings?	IResolvable | RedshiftSettingsProperty	Settings in JSON format for the Amazon Redshift endpoint.
resourceIdentifier?	string	A display name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object.
s3Settings?	IResolvable | S3SettingsProperty	Settings in JSON format for the source and target Amazon S3 endpoint.
serverName?	string	The name of the server where the endpoint database resides.
sslMode?	string	The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is none .
sybaseSettings?	IResolvable | SybaseSettingsProperty	Settings in JSON format for the source and target SAP ASE endpoint.
username?	string	The user name to be used to log in to the endpoint database.
static CFN_RESOURCE_TYPE_NAME	string	The CloudFormation resource type name for this resource class.

---

attrExternalId

Type: string

A value that can be used for cross-account validation.

---

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

---

cfnProperties

Type: { [string]: any }

---

cfnResourceType

Type: string

AWS resource type.

---

creationStack

Type: string[]

---

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 | s3 | db2 | azuredb | sybase | dynamodb | mongodb | kinesis | kafka | elasticsearch | docdb | sqlserver | neptune

---

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

---

node

Type: ConstructNode

The construct tree node associated with this construct.

---

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

---

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

---

tags

Type: TagManager

One or more tags to be assigned to the endpoint.

---

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: DocDbSettingsProperty | IResolvable (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 | DynamoDbSettingsProperty (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 | ElasticsearchSettingsProperty (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 | GcpMySQLSettingsProperty (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 | IbmDb2SettingsProperty (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 | KafkaSettingsProperty (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 | KinesisSettingsProperty (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 | MicrosoftSqlServerSettingsProperty (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 | MongoDbSettingsProperty (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 | MySqlSettingsProperty (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 | NeptuneSettingsProperty (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 | OracleSettingsProperty (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 | PostgreSqlSettingsProperty (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 | RedisSettingsProperty (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 | RedshiftSettingsProperty (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 | S3SettingsProperty (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_name is set to S3, the only allowed value is none .

---

sybaseSettings?

Type: IResolvable | SybaseSettingsProperty (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 .

---

username?

Type: string (optional)

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

---

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for addOverride(path, undefined).
addDependsOn(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

---

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

• path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

---

addDependsOn(target)

public addDependsOn(target: CfnResource): void

Parameters

• target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

---

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

• key string
• value any

Add a value to the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

---

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

• path string — - The path of the property, you can use dot notation to override values in complex types.
• value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

---

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

• propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

---

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

• propertyPath string — The path of the property.
• value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

---

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

• policy RemovalPolicy
• options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

getAtt(attributeName)

public getAtt(attributeName: string): Reference

Parameters

• attributeName string — The name of the attribute.

Returns

• Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

---

getMetadata(key)

public getMetadata(key: string): any

Parameters

• key string

Returns

• any

Retrieve a value value from the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

---

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

• inspector TreeInspector — - tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

---

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

• newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

• props { [string]: any }

Returns

• { [string]: any }