PostgreSQLSettings - Amazon Database Migration Service
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

PostgreSQLSettings

Provides information that defines a PostgreSQL endpoint.

Contents

AfterConnectScript

For use with change data capture (CDC) only, this attribute has Amazon 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

BabelfishDatabaseName

The Babelfish for Aurora PostgreSQL database name for the endpoint.

Type: String

Required: No

CaptureDdls

To capture DDL events, Amazon 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

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.

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

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.

Type: Boolean

Required: No

HeartbeatFrequency

Sets the WAL heartbeat frequency (in minutes).

Type: Integer

Required: No

HeartbeatSchema

Sets the schema in which the heartbeat artifacts are created.

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.

Type: Boolean

Required: No

MapJsonbAsClob

When true, Amazon DMS migrates JSONB values as CLOB.

Type: Boolean

Required: No

MapLongVarcharAs

When true, Amazon DMS migrates LONG values as VARCHAR.

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.

Example: maxFileSize=512

Type: Integer

Required: No

Password

Endpoint connection password.

Type: String

Required: No

PluginName

Specifies the plugin to use to create a replication slot.

Type: String

Valid Values: no-preference | test-decoding | pglogical

Required: No

Port

Endpoint TCP port. The default is 5432.

Type: Integer

Required: No

SecretsManagerAccessRoleArn

The full Amazon Resource Name (ARN) of the IAM role that specifies Amazon 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 Amazon Secrets Manager secret that allows access to the PostgreSQL endpoint.

Note

You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerSecretId. Or you can specify clear-text values for UserName, Password, ServerName, and Port. You can't specify both. For more information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access Amazon Database Migration Service resources in the Amazon Database Migration Service User Guide.

Type: String

Required: No

SecretsManagerSecretId

The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the PostgreSQL endpoint connection details.

Type: String

Required: No

ServerName

The host name of the endpoint database.

For an Amazon RDS PostgreSQL instance, this is the output of DescribeDBInstances, in the Endpoint.Address field.

For an Aurora PostgreSQL instance, this is the output of DescribeDBClusters, in the Endpoint field.

Type: String

Required: No

SlotName

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 Amazon 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 Amazon Database Migration Service User Guide. For more information about using CdcStartPosition, see CreateReplicationTask, StartReplicationTask, and ModifyReplicationTask.

Type: String

Required: No

TrimSpaceInChar

Use the TrimSpaceInChar source endpoint setting to trim data on CHAR and NCHAR data types during migration. The default value is true.

Type: Boolean

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 Amazon SDKs, see the following: