View a markdown version of this page

PostgreSQLSettings - AWS Database Migration Service

PostgreSQLSettings

Provides information that defines a PostgreSQL endpoint.

Contents

AfterConnectScript

For use with change data capture (CDC) only, this attribute has AWS DMS bypass foreign keys and user triggers to reduce the time it takes to bulk load data.

Example: afterConnectScript=SET session_replication_role='replica'

Type: String

Required: No

AuthenticationMethod

This attribute allows you to specify the authentication method as "iam auth".

Type: String

Valid Values: password | iam

Required: No

BabelfishDatabaseName

The Babelfish for Aurora PostgreSQL database name for the endpoint.

Type: String

Required: No

CaptureDdls

To capture DDL events, AWS DMS creates various artifacts in the PostgreSQL database when the task starts. You can later remove these artifacts.

The default value is true.

If this value is set to N, you don't have to create tables or triggers on the source database.

Type: Boolean

Required: No

DatabaseMode

Specifies the default behavior of the replication's handling of PostgreSQL- compatible endpoints that require some additional configuration, such as Babelfish endpoints.

Type: String

Valid Values: default | babelfish

Required: No

DatabaseName

Database name for the endpoint.

Type: String

Required: No

DdlArtifactsSchema

The schema in which the operational DDL database artifacts are created.

The default value is public.

Example: ddlArtifactsSchema=xyzddlschema;

Type: String

Required: No

DisableUnicodeSourceFilter

Disables the Unicode source filter with PostgreSQL, for values passed into the Selection rule filter on Source Endpoint column values. By default DMS performs source filter comparisons using a Unicode string which can cause look ups to ignore the indexes in the text columns and slow down migrations.

Unicode support should only be disabled when using a selection rule filter is on a text column in the Source database that is indexed.

Type: Boolean

Required: No

ExecuteTimeout

Sets the client statement timeout for the PostgreSQL instance, in seconds. The default value is 60 seconds.

Example: executeTimeout=100;

Type: Integer

Required: No

FailTasksOnLobTruncation

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.

The default value is false.

If task is set to Limited LOB mode and this option is set to true, the task fails instead of truncating the LOB data.

Type: Boolean

Required: No

HeartbeatEnable

The write-ahead log (WAL) heartbeat feature mimics a dummy transaction. By doing this, it prevents idle logical replication slots from holding onto old WAL logs, which can result in storage full situations on the source. This heartbeat keeps restart_lsn moving and prevents storage full scenarios.

The default value is false.

Type: Boolean

Required: No

HeartbeatFrequency

Sets the WAL heartbeat frequency (in minutes).

The default value is 5 minutes.

Type: Integer

Required: No

HeartbeatSchema

Sets the schema in which the heartbeat artifacts are created.

The default value is public.

Type: String

Required: No

MapBooleanAsBoolean

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.

The default value is false.

Type: Boolean

Required: No

MapJsonbAsClob

When true, AWS DMS migrates JSONB values as CLOB.

The default value is false.

Type: Boolean

Required: No

MapLongVarcharAs

Sets what datatype to map LONG values as.

The default value is wstring.

Type: String

Valid Values: wstring | clob | nclob

Required: No

MaxFileSize

Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.

The default value is 32,768 KB (32 MB).

Example: maxFileSize=512

Type: Integer

Required: No

Password

Endpoint connection password.

Type: String

Required: No