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

CaptureDdls

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

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

Type: Boolean

Required: No

DatabaseName

Database name for the endpoint.

Type: String

Required: No

DdlArtifactsSchema

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

Example: ddlArtifactsSchema=xyzddlschema;

Type: String

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.

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

MaxFileSize

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

Example: maxFileSize=512

Type: Integer

Required: No

Password

Endpoint connection password.

Type: String

Required: No

Port

Endpoint TCP port.

Type: Integer

Required: No

ServerName

Fully qualified domain name of the endpoint.

Type: String

Required: No

SlotName

Sets the name of a previously created logical replication slot for a CDC load of the PostgreSQL source instance.

When used with the AWS DMS API CdcStartPosition request parameter, this attribute also enables using native CDC start points.

Type: String

Required: No

Username

Endpoint connection user name.

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: