# CfnEndpoint

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

Currently, AWS CloudFormation supports all AWS DMS endpoint types.

Extends: Construct › CfnElement › CfnRefElement › CfnResource › CfnEndpoint
Implements: IInspectable, ITaggable, IEnvironmentAware, IEndpointRef, IConstruct, IDependable

- CloudFormation: [`AWS::DMS::Endpoint`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-dms-endpoint.html)
- Source: Generated code
- Type last changed: v2.268.0 · 2 Sep 2026

## Example

```ts
// 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 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',
    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',
});
```

## Initializer

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

## Construct Props

- `certificateArn`: string — The Amazon Resource Name (ARN) for the certificate.

- `databaseName`: string — 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`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnEndpoint.DocDbSettingsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_dms.CfnEndpoint.DocDbSettingsProperty.html) — 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](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.DocumentDB.html#CHAP_Source.DocumentDB.ECAs) and [Using Amazon DocumentDB as a target for AWS Database Migration Service](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.DocumentDB.html) in the *AWS Database Migration Service User Guide* .

- `dynamoDbSettings`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnEndpoint.DynamoDbSettingsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_dms.CfnEndpoint.DynamoDbSettingsProperty.html) — 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](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.DynamoDB.html#CHAP_Target.DynamoDB.ObjectMapping) in the *AWS Database Migration Service User Guide* .

- `elasticsearchSettings`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnEndpoint.ElasticsearchSettingsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_dms.CfnEndpoint.ElasticsearchSettingsProperty.html) — 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](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Elasticsearch.html#CHAP_Target.Elasticsearch.Configuration) in the *AWS Database Migration Service User Guide* .

- `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`: string (required) — The type of endpoint.

  Valid values are `source` and `target` .

- `engineName`: string (required) — 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`

- `extraConnectionAttributes`: string — 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](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Endpoints.html) in the *AWS Database Migration Service User Guide* .

- `gcpMySqlSettings`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnEndpoint.GcpMySQLSettingsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_dms.CfnEndpoint.GcpMySQLSettingsProperty.html) — 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](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MySQL.html#CHAP_Source.MySQL.ConnectionAttrib) in the *AWS Database Migration Service User Guide* .

- `ibmDb2Settings`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnEndpoint.IbmDb2SettingsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_dms.CfnEndpoint.IbmDb2SettingsProperty.html) — 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](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.DB2.html#CHAP_Source.DB2.ConnectionAttrib) in the *AWS Database Migration Service User Guide* .

- `kafkaSettings`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnEndpoint.KafkaSettingsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_dms.CfnEndpoint.KafkaSettingsProperty.html) — 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](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kafka.html#CHAP_Target.Kafka.ObjectMapping) in the *AWS Database Migration Service User Guide* .

- `kinesisSettings`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnEndpoint.KinesisSettingsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_dms.CfnEndpoint.KinesisSettingsProperty.html) — 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](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kinesis.html#CHAP_Target.Kinesis.ObjectMapping) in the *AWS Database Migration Service User Guide* .

- `kmsKeyId`: string — An AWS 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  creates the default encryption key for your AWS account . Your AWS account has a different default encryption key for each AWS Region .

- `microsoftSqlServerSettings`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnEndpoint.MicrosoftSqlServerSettingsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_dms.CfnEndpoint.MicrosoftSqlServerSettingsProperty.html) — 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](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SQLServer.html#CHAP_Source.SQLServer.ConnectionAttrib) and [Extra connection attributes when using SQL Server as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.SQLServer.html#CHAP_Target.SQLServer.ConnectionAttrib) in the *AWS Database Migration Service User Guide* .

- `mongoDbSettings`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnEndpoint.MongoDbSettingsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_dms.CfnEndpoint.MongoDbSettingsProperty.html) — 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](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MongoDB.html#CHAP_Source.MongoDB.Configuration) in the *AWS Database Migration Service User Guide* .

- `mySqlSettings`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnEndpoint.MySqlSettingsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_dms.CfnEndpoint.MySqlSettingsProperty.html) — 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](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MySQL.html#CHAP_Source.MySQL.ConnectionAttrib) and [Extra connection attributes when using a MySQL-compatible database as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.MySQL.html#CHAP_Target.MySQL.ConnectionAttrib) in the *AWS Database Migration Service User Guide* .

- `neptuneSettings`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnEndpoint.NeptuneSettingsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_dms.CfnEndpoint.NeptuneSettingsProperty.html) — 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](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.EndpointSettings) in the *AWS Database Migration Service User Guide* .

- `oracleSettings`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnEndpoint.OracleSettingsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_dms.CfnEndpoint.OracleSettingsProperty.html) — 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](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.ConnectionAttrib) and [Extra connection attributes when using Oracle as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Oracle.html#CHAP_Target.Oracle.ConnectionAttrib) in the *AWS Database Migration Service User Guide* .

- `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](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnEndpoint.PostgreSqlSettingsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_dms.CfnEndpoint.PostgreSqlSettingsProperty.html) — 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](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.html#CHAP_Source.PostgreSQL.ConnectionAttrib) and [Extra connection attributes when using PostgreSQL as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.PostgreSQL.html#CHAP_Target.PostgreSQL.ConnectionAttrib) in the *AWS Database Migration Service User Guide* .

- `redisSettings`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnEndpoint.RedisSettingsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_dms.CfnEndpoint.RedisSettingsProperty.html) — Settings in JSON format for the target Redis endpoint.

  For information about other available settings, see [Specifying endpoint settings for Redis as a target](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Redis.html#CHAP_Target.Redis.EndpointSettings) in the *AWS Database Migration Service User Guide* .

- `redshiftSettings`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnEndpoint.RedshiftSettingsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_dms.CfnEndpoint.RedshiftSettingsProperty.html) — 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](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Redshift.html#CHAP_Target.Redshift.ConnectionAttrib) in the *AWS Database Migration Service User Guide* .

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

  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`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnEndpoint.S3SettingsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_dms.CfnEndpoint.S3SettingsProperty.html) — 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](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.S3.html#CHAP_Source.S3.Configuring) and [Extra connection attributes when using Amazon S3 as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring) in the *AWS Database Migration Service User Guide* .

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

  > When `engine_name` is set to S3, the only allowed value is `none` .

- `sybaseSettings`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnEndpoint.SybaseSettingsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_dms.CfnEndpoint.SybaseSettingsProperty.html) — 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](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SAP.html#CHAP_Source.SAP.ConnectionAttrib) and [Extra connection attributes when using SAP ASE as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.SAP.html#CHAP_Target.SAP.ConnectionAttrib) in the *AWS Database Migration Service User Guide* .

- `tags`: [CfnTag](/cdk/api/v2/docs/aws-cdk-lib.CfnTag.html)[] — 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.

## Properties

- `attrEndpointArn`: string (required) — The endpoint ARN.

- `attrExternalId`: string (required) — A value that can be used for cross-account validation.

- `certificateArn`: string — The Amazon Resource Name (ARN) for the certificate.

- `CFN_RESOURCE_TYPE_NAME`: string (required) (static) — The CloudFormation resource type name for this resource class.

- `cfnOptions`: [ICfnResourceOptions](/cdk/api/v2/docs/aws-cdk-lib.ICfnResourceOptions.html) (required) — Options for this resource, such as condition, update policy etc.

- `cfnResourceType`: string (required) — AWS resource type.

- `creationStack`: string[] (required)

- `databaseName`: string — The name of the endpoint database.

- `docDbSettings`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnEndpoint.DocDbSettingsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_dms.CfnEndpoint.DocDbSettingsProperty.html) — Settings in JSON format for the source and target DocumentDB endpoint.

- `dynamoDbSettings`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnEndpoint.DynamoDbSettingsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_dms.CfnEndpoint.DynamoDbSettingsProperty.html) — Settings in JSON format for the target Amazon DynamoDB endpoint.

- `elasticsearchSettings`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnEndpoint.ElasticsearchSettingsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_dms.CfnEndpoint.ElasticsearchSettingsProperty.html) — Settings in JSON format for the target OpenSearch endpoint.

- `endpointIdentifier`: string — The database endpoint identifier.

- `endpointRef`: [EndpointReference](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_dms.EndpointReference.html) (required) — A reference to a Endpoint resource.

- `endpointType`: string (required) — The type of endpoint.

- `engineName`: string (required) — The type of engine for the endpoint, depending on the `EndpointType` value.

- `env`: [ResourceEnvironment](/cdk/api/v2/docs/aws-cdk-lib.interfaces.ResourceEnvironment.html) (required)

- `extraConnectionAttributes`: string — Additional attributes associated with the connection.

- `gcpMySqlSettings`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnEndpoint.GcpMySQLSettingsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_dms.CfnEndpoint.GcpMySQLSettingsProperty.html) — Settings in JSON format for the source GCP MySQL endpoint.

- `ibmDb2Settings`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnEndpoint.IbmDb2SettingsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_dms.CfnEndpoint.IbmDb2SettingsProperty.html) — Settings in JSON format for the source IBM Db2 LUW endpoint.

- `kafkaSettings`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnEndpoint.KafkaSettingsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_dms.CfnEndpoint.KafkaSettingsProperty.html) — Settings in JSON format for the target Apache Kafka endpoint.

- `kinesisSettings`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnEndpoint.KinesisSettingsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_dms.CfnEndpoint.KinesisSettingsProperty.html) — Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams.

- `kmsKeyId`: string — An AWS key identifier that is used to encrypt the connection parameters for the endpoint.

- `logicalId`: string (required) — 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)`.

- `microsoftSqlServerSettings`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnEndpoint.MicrosoftSqlServerSettingsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_dms.CfnEndpoint.MicrosoftSqlServerSettingsProperty.html) — Settings in JSON format for the source and target Microsoft SQL Server endpoint.

- `mongoDbSettings`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnEndpoint.MongoDbSettingsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_dms.CfnEndpoint.MongoDbSettingsProperty.html) — Settings in JSON format for the source MongoDB endpoint.

- `mySqlSettings`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnEndpoint.MySqlSettingsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_dms.CfnEndpoint.MySqlSettingsProperty.html) — Settings in JSON format for the source and target MySQL endpoint.

- `neptuneSettings`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnEndpoint.NeptuneSettingsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_dms.CfnEndpoint.NeptuneSettingsProperty.html) — Settings in JSON format for the target Amazon Neptune endpoint.

- `node`: [Node](/cdk/api/v2/docs/constructs.Node.html) (required) — The tree node.

- `oracleSettings`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnEndpoint.OracleSettingsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_dms.CfnEndpoint.OracleSettingsProperty.html) — 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](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnEndpoint.PostgreSqlSettingsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_dms.CfnEndpoint.PostgreSqlSettingsProperty.html) — Settings in JSON format for the source and target PostgreSQL endpoint.

- `redisSettings`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnEndpoint.RedisSettingsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_dms.CfnEndpoint.RedisSettingsProperty.html) — Settings in JSON format for the target Redis endpoint.

- `redshiftSettings`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnEndpoint.RedshiftSettingsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_dms.CfnEndpoint.RedshiftSettingsProperty.html) — Settings in JSON format for the Amazon Redshift endpoint.

- `ref`: string (required) — 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 })`.

- `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](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnEndpoint.S3SettingsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_dms.CfnEndpoint.S3SettingsProperty.html) — 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` .

- `stack`: [Stack](/cdk/api/v2/docs/aws-cdk-lib.Stack.html) (required) — The stack in which this element is defined.

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

- `sybaseSettings`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnEndpoint.SybaseSettingsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_dms.CfnEndpoint.SybaseSettingsProperty.html) — Settings in JSON format for the source and target SAP ASE endpoint.

- `tags`: [TagManager](/cdk/api/v2/docs/aws-cdk-lib.TagManager.html) (required) — Tag Manager which manages the tags for this resource.

- `tagsRaw`: [CfnTag](/cdk/api/v2/docs/aws-cdk-lib.CfnTag.html)[] — 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.

## Methods

- `addDeletionOverride(path: string): void` — Syntactic sugar for `addOverride(path, undefined)`.

  **Parameters**

  - `path` — The path of the value to delete.

- `addDependency(target: CfnResource): void` — Use `addResourceDependency` instead.

  This method has been renamed to `addResourceDependency` to more clearly
  set it apart from `construct.node.addDependency`. See the documentation
  of that function for more details.

- `addDependsOn(target: CfnResource): void` — Use `addResourceDependency` instead.

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

  This method has been renamed to `addResourceDependency`, which makes it
  more clear that this method operates at a different level from the
  construct-level `construct.node.addDependency()` mechanism.

- `addMetadata(key: string, value: any): void` — Add a value to the CloudFormation Resource Metadata.

- `addOverride(path: string, value: any): void` — 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,
  ```typescript
  cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
  cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
  ```
  would add the overrides
  ```json
  "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.

  **Parameters**

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

- `addPropertyDeletionOverride(propertyPath: string): void` — Adds an override that deletes the value of a property from the resource definition.

  **Parameters**

  - `propertyPath` — The path to the property.

- `addPropertyOverride(propertyPath: string, value: any): void` — Adds an override to a resource property.

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

  **Parameters**

  - `propertyPath` — The path of the property.
  - `value` — The value.

- `addResourceDependency(target: CfnResource, reason?: string): void` — 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.

  This method only adds dependencies between L1 resources. If you are
  looking for a generic construct-to-construct dependency mechanism that works
  for all constructs including L2s, use `construct.node.addDependency` instead.

- `applyCrossStackReferenceStrength(strength: ReferenceStrength): void` — Sets the cross-stack reference strength for this resource.

  When set, any cross-stack reference to this resource will use the specified
  strength instead of the global default from the consuming stack's context.

  **Parameters**

  - `strength` — - The reference strength to use for this resource.

- `applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void` — 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`). In some
  cases, a snapshot can be taken of the resource prior to deletion
  (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
  can be found in the following link:

- `arnForEndpoint(resource: IEndpointRef): string` (static)

- `cfnPropertyName(cdkPropertyName: string): string`

- `getAtt(attributeName: string, typeHint?: ResolutionTypeHint): 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.

  **Parameters**

  - `attributeName` — The name of the attribute.

- `getMetadata(key: string): any` — Retrieve a value value from the CloudFormation Resource Metadata.

- `inspect(inspector: TreeInspector): void` — Examines the CloudFormation resource and discloses attributes.

  **Parameters**

  - `inspector` — tree inspector to collect and process attributes.

- `isCfnElement(x: any): boolean` (static) — Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

  Uses duck-typing instead of `instanceof` to allow stack elements from different
  versions of this library to be included in the same stack.

  **Returns:** The construct as a stack element or undefined if it is not a stack element.

- `isCfnEndpoint(x: any): boolean` (static) — Checks whether the given object is a CfnEndpoint.

- `isCfnResource(x: any): boolean` (static) — Check whether the given object is a CfnResource.

- `isConstruct(x: any): boolean` (static) — Checks if `x` is a construct.

  Use this method instead of `instanceof` to properly detect `Construct`
  instances, even when the construct library is symlinked.

  Explanation: in JavaScript, multiple copies of the `constructs` library on
  disk are seen as independent, completely different libraries. As a
  consequence, the class `Construct` in each copy of the `constructs` library
  is seen as a different class, and an instance of one class will not test as
  `instanceof` the other class. `npm install` will not create installations
  like this, but users may manually symlink construct libraries together or
  use a monorepo tool: in those cases, multiple copies of the `constructs`
  library can be accidentally installed, and `instanceof` will behave
  unpredictably. It is safest to avoid using `instanceof`, and using
  this type-testing method instead.

  **Parameters**

  - `x` — Any object.

  **Returns:** true if `x` is an object created from a class which extends `Construct`.

- `obtainDependencies(): Stack | CfnResource[]` — Retrieves an array of resources and stacks this resource depends on.

  For resources depended on directly, returns the `CfnResource` object. For
  dependencies on other stacks, returns the `Stack` object. The order of the
  array is not guaranteed.

- `overrideLogicalId(newLogicalId: string): void` — Overrides the auto-generated logical ID with a specific ID.

  **Parameters**

  - `newLogicalId` — The new logical ID to use for this stack element.

- `removeDependency(target: CfnResource): void` — Use `removeResourceDependency` instead

  This can be used for resources across stacks (including nested stacks)
  and the dependency will automatically be removed from the relevant scope.

- `removeResourceDependency(target: CfnResource): void` — Indicates that this resource no longer depends on another resource.

  This can be used for resources across stacks (including nested stacks)
  and the dependency will automatically be removed from the relevant scope.

- `replaceDependency(target: CfnResource, newTarget: CfnResource): void` — Replaces one dependency with another.

  **Parameters**

  - `target` — The dependency to replace.
  - `newTarget` — The new dependency to add.

- `toString(): string` — Returns a string representation of this construct.

  **Returns:** a string representation of this resource

- `with(...mixins: IMixin[]): IConstruct` — Applies one or more mixins to this construct.

  Mixins are applied in order. The list of constructs is captured at the
  start of the call, so constructs added by a mixin will not be visited.
  Use multiple `with()` calls if subsequent mixins should apply to added
  constructs.