MDAA TS Docs
    Preparing search index...

    Interface EndpointProps

    Configuration for a DMS endpoint defining database connection settings.

    Use cases: Database migration; Database replication; Data migration workflows; Database connectivity

    AWS: AWS Database Migration Service configuration for database migration and replication

    Validation: Configuration must be valid for deployment; properties must conform to AWS DMS and MDAA requirements

    interface EndpointProps {
        databaseName?: string;
        docDbSettings?: DocDbSettingsProperty;
        dynamoDbSettings?: DynamoDbSettingsProperty;
        elasticsearchSettings?: ElasticsearchSettingsProperty;
        endpointType: MdaaEndpointType;
        engineName: MdaaEndpointEngine;
        ibmDb2Settings?: IbmDb2SettingsProperty;
        kinesisSettings?: KinesisSettingsProperty;
        microsoftSqlServerSettings?: MicrosoftSqlServerSettingsProperty;
        mongoDbSettings?: MongoDbSettingsProperty;
        mySqlSettings?: MySqlSettingsProperty;
        neptuneSettings?: NeptuneSettingsProperty;
        oracleSettings?: OracleSettingsProperty;
        postgreSqlSettings?: PostgreSqlSettingsProperty;
        redshiftSettings?: RedshiftSettingsProperty;
        s3Settings?: S3SettingsProperty;
        sybaseSettings?: SybaseSettingsProperty;
    }
    Index

    Properties

    databaseName? docDbSettings? dynamoDbSettings? elasticsearchSettings? endpointType engineName ibmDb2Settings? kinesisSettings? microsoftSqlServerSettings? mongoDbSettings? mySqlSettings? neptuneSettings? oracleSettings? postgreSqlSettings? redshiftSettings? s3Settings? sybaseSettings?

    Properties

    databaseName?: string

    The optional name of the endpoint database. Required for certain endpoint types.

    docDbSettings?: DocDbSettingsProperty

    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 . See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-docdbsettings

    dynamoDbSettings?: DynamoDbSettingsProperty

    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 . See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-dynamodbsettings

    elasticsearchSettings?: ElasticsearchSettingsProperty

    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 . See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-elasticsearchsettings

    endpointType: MdaaEndpointType

    The type of Endpoint ("source" or "target")

    engineName: MdaaEndpointEngine

    The name of the endpoint engine

    ibmDb2Settings?: IbmDb2SettingsProperty

    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 . See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-ibmdb2settings

    kinesisSettings?: KinesisSettingsProperty

    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 . See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-kinesissettings

    microsoftSqlServerSettings?: MicrosoftSqlServerSettingsProperty

    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 . See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-microsoftsqlserversettings

    mongoDbSettings?: MongoDbSettingsProperty

    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 . See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-mongodbsettings

    mySqlSettings?: MySqlSettingsProperty

    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 . See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-mysqlsettings

    neptuneSettings?: NeptuneSettingsProperty

    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 . See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-neptunesettings

    oracleSettings?: OracleSettingsProperty

    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 . See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-oraclesettings

    postgreSqlSettings?: PostgreSqlSettingsProperty

    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 . See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-postgresqlsettings

    redshiftSettings?: RedshiftSettingsProperty

    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 . See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-redshiftsettings

    s3Settings?: S3SettingsProperty

    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 . See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-s3settings

    sybaseSettings?: SybaseSettingsProperty

    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 . See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-sybasesettings

    Settings

    Member Visibility

    On This Page

    Properties