MDAA TS Docs
    Preparing search index...

    Interface MongoDbSettingsProperty

    Provides information that defines a MongoDB endpoint. Modified from the equivalent L1 Construct to prevent use of plaintext credentials and enforce use of KMS encryption. This information includes the output format of records applied to the endpoint and details of transaction and control table data information. For more information about other available settings, see Endpoint configuration settings when using MongoDB as a source for AWS DMS in the AWS Database Migration Service User Guide .

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html

    interface MongoDbSettingsProperty {
        authMechanism?: string;
        authSource?: string;
        authType?: string;
        databaseName?: string;
        docsToInvestigate?: string;
        extractDocId?: string;
        nestingLevel?: string;
        port?: number;
        secretsManagerAccessRoleArn?: string;
        secretsManagerSecretArn: string;
        secretsManagerSecretKMSArn?: string;
        serverName?: string;
    }
    Index

    Properties

    authMechanism? authSource? authType? databaseName? docsToInvestigate? extractDocId? nestingLevel? port? secretsManagerAccessRoleArn? secretsManagerSecretArn secretsManagerSecretKMSArn? serverName?

    Properties

    authMechanism?: string

    Authentication mechanism for MongoDB source endpoint access with version-specific defaults

    authSource?: string

    MongoDB database name for authentication with default "admin" database

    authType?: string

    Authentication type for MongoDB source endpoint access control

    databaseName?: string

    Database name on MongoDB source endpoint for migration scope specification

    docsToInvestigate?: string

    Number of documents to preview for document organization analysis when using table mode

    extractDocId?: string

    Flag to specify document ID extraction when using document mode

    nestingLevel?: string

    Nesting level specification for document or table mode selection

    port?: number

    The port value for the MongoDB source endpoint. See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-port

    secretsManagerAccessRoleArn?: string

    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret . The role must allow the iam:PassRole action. SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the MongoDB endpoint. See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-secretsmanageraccessrolearn

    secretsManagerSecretArn: string

    The full ARN of the SecretsManagerSecret that contains the MongoDB endpoint connection details. See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-secretsmanagersecretid

    secretsManagerSecretKMSArn?: string

    The ID of the KMS key used to encrypt the credentials secret.

    serverName?: string

    The name of the server on the MongoDB source endpoint. See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-servername

    Settings

    Member Visibility

    On This Page

    Properties