MDAA TS Docs
    Preparing search index...

    Interface PostgreSqlSettingsProperty

    Provides information that defines a PostgreSQL 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 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-properties-dms-endpoint-postgresqlsettings.html

    interface PostgreSqlSettingsProperty {
        afterConnectScript?: string;
        babelfishDatabaseName?: string;
        captureDdls?: boolean;
        databaseMode?: string;
        ddlArtifactsSchema?: string;
        executeTimeout?: number;
        failTasksOnLobTruncation?: boolean;
        heartbeatEnable?: boolean;
        heartbeatFrequency?: number;
        heartbeatSchema?: string;
        mapBooleanAsBoolean?: boolean;
        maxFileSize?: number;
        pluginName?: string;
        secretsManagerAccessRoleArn?: string;
        secretsManagerSecretArn: string;
        secretsManagerSecretKMSArn?: string;
        slotName?: string;
    }
    Index

    Properties

    afterConnectScript? babelfishDatabaseName? captureDdls? databaseMode? ddlArtifactsSchema? executeTimeout? failTasksOnLobTruncation? heartbeatEnable? heartbeatFrequency? heartbeatSchema? mapBooleanAsBoolean? maxFileSize? pluginName? secretsManagerAccessRoleArn? secretsManagerSecretArn secretsManagerSecretKMSArn? slotName?

    Properties

    afterConnectScript?: string

    SQL script executed after connecting to PostgreSQL source for change data capture (CDC)

    babelfishDatabaseName?: string

    Babelfish for Aurora PostgreSQL database name for DMS endpoint configuration enabling SQL

    captureDdls?: boolean

    Boolean flag to enable DDL event capture for PostgreSQL DMS migration enabling schema

    databaseMode?: string

    Database mode specification for PostgreSQL-compatible endpoints requiring additional

    ddlArtifactsSchema?: string

    The schema in which the operational DDL database artifacts are created. Example: ddlArtifactsSchema=xyzddlschema; See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-ddlartifactsschema

    executeTimeout?: number

    Sets the client statement timeout for the PostgreSQL instance, in seconds. The default value is 60 seconds. Example: executeTimeout=100; See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-executetimeout

    failTasksOnLobTruncation?: boolean

    When set to true , this value causes a task to fail if the actual size of a LOB column is greater than the specified LobMaxSize . If task is set to Limited LOB mode and this option is set to true, the task fails instead of truncating the LOB data. See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-failtasksonlobtruncation

    heartbeatEnable?: boolean

    Boolean flag to enable WAL heartbeat feature for PostgreSQL DMS migration preventing

    heartbeatFrequency?: number

    WAL heartbeat frequency in minutes for PostgreSQL DMS migration enabling configurable

    heartbeatSchema?: string

    Sets the schema in which the heartbeat artifacts are created. See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-heartbeatschema

    mapBooleanAsBoolean?: boolean

    When true, lets PostgreSQL migrate the boolean type as boolean. By default, PostgreSQL migrates booleans as varchar(5) . You must set this setting on both the source and target endpoints for it to take effect. See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-mapbooleanasboolean

    maxFileSize?: number

    Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL. Example: maxFileSize=512 See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-maxfilesize

    pluginName?: string

    Specifies the plugin to use to create a replication slot. See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-pluginname

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

    secretsManagerSecretArn: string

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

    secretsManagerSecretKMSArn?: string

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

    slotName?: string

    Sets the name of a previously created logical replication slot for a change data capture (CDC) load of the PostgreSQL source instance. When used with the CdcStartPosition request parameter for the AWS DMS API , this attribute also makes it possible to use native CDC start points. DMS verifies that the specified logical replication slot exists before starting the CDC load task. It also verifies that the task was created with a valid setting of CdcStartPosition . If the specified slot doesn't exist or the task doesn't have a valid CdcStartPosition setting, DMS raises an error. For more information about setting the CdcStartPosition request parameter, see Determining a CDC native start point in the AWS Database Migration Service User Guide . For more information about using CdcStartPosition , see CreateReplicationTask , StartReplicationTask , and ModifyReplicationTask . See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-slotname

    Settings

    Member Visibility

    On This Page

    Properties