interface PostgreSqlSettingsProperty

Language	Type name
.NET	`Amazon.CDK.AWS.DMS.CfnEndpoint.PostgreSqlSettingsProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsdms#CfnEndpoint_PostgreSqlSettingsProperty`
Java	`software.amazon.awscdk.services.dms.CfnEndpoint.PostgreSqlSettingsProperty`
Python	`aws_cdk.aws_dms.CfnEndpoint.PostgreSqlSettingsProperty`
TypeScript	`aws-cdk-lib` » `aws_dms` » `CfnEndpoint` » `PostgreSqlSettingsProperty`

Provides information that defines a PostgreSQL endpoint.

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 .

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_dms as dms } from 'aws-cdk-lib';
const postgreSqlSettingsProperty: dms.CfnEndpoint.PostgreSqlSettingsProperty = {
  afterConnectScript: 'afterConnectScript',
  babelfishDatabaseName: 'babelfishDatabaseName',
  captureDdls: false,
  databaseMode: 'databaseMode',
  ddlArtifactsSchema: 'ddlArtifactsSchema',
  executeTimeout: 123,
  failTasksOnLobTruncation: false,
  heartbeatEnable: false,
  heartbeatFrequency: 123,
  heartbeatSchema: 'heartbeatSchema',
  mapBooleanAsBoolean: false,
  maxFileSize: 123,
  pluginName: 'pluginName',
  secretsManagerAccessRoleArn: 'secretsManagerAccessRoleArn',
  secretsManagerSecretId: 'secretsManagerSecretId',
  slotName: 'slotName',
};

Properties

Name	Type	Description
afterConnectScript?	`string`	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.
babelfishDatabaseName?	`string`	The Babelfish for Aurora PostgreSQL database name for the endpoint.
captureDdls?	`boolean \|` `IResolvable`	To capture DDL events, AWS DMS creates various artifacts in the PostgreSQL database when the task starts.
databaseMode?	`string`	Specifies the default behavior of the replication's handling of PostgreSQL- compatible endpoints that require some additional configuration, such as Babelfish endpoints.
ddlArtifactsSchema?	`string`	The schema in which the operational DDL database artifacts are created.
executeTimeout?	`number`	Sets the client statement timeout for the PostgreSQL instance, in seconds. The default value is 60 seconds.
failTasksOnLobTruncation?	`boolean \|` `IResolvable`	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` .
heartbeatEnable?	`boolean \|` `IResolvable`	The write-ahead log (WAL) heartbeat feature mimics a dummy transaction.
heartbeatFrequency?	`number`	Sets the WAL heartbeat frequency (in minutes).
heartbeatSchema?	`string`	Sets the schema in which the heartbeat artifacts are created.
mapBooleanAsBoolean?	`boolean \|` `IResolvable`	When true, lets PostgreSQL migrate the boolean type as boolean.
maxFileSize?	`number`	Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.
pluginName?	`string`	Specifies the plugin to use to create a replication slot.
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` .
secretsManagerSecretId?	`string`	The full ARN, partial ARN, or display name of the `SecretsManagerSecret` that contains the PostgreSQL endpoint connection details.
slotName?	`string`	Sets the name of a previously created logical replication slot for a change data capture (CDC) load of the PostgreSQL source instance.

afterConnectScript?

Type: string (optional)

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'

babelfishDatabaseName?

Type: string (optional)

The Babelfish for Aurora PostgreSQL database name for the endpoint.

captureDdls?

Type: boolean | IResolvable (optional)

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 True , you don't have to create tables or triggers on the source database.

databaseMode?

Type: string (optional)

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

ddlArtifactsSchema?

Type: string (optional)

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

The default value is public .

Example: ddlArtifactsSchema=xyzddlschema;

executeTimeout?

Type: number (optional)

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

Example: executeTimeout=100;

failTasksOnLobTruncation?

Type: boolean | IResolvable (optional)

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.

heartbeatEnable?

Type: boolean | IResolvable (optional)

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 .

heartbeatFrequency?

Type: number (optional)

Sets the WAL heartbeat frequency (in minutes).

The default value is 5 minutes.

heartbeatSchema?

Type: string (optional)

Sets the schema in which the heartbeat artifacts are created.

The default value is public .

mapBooleanAsBoolean?

Type: boolean | IResolvable (optional)

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 .

maxFileSize?

Type: number (optional)

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

pluginName?

Type: string (optional)

Specifies the plugin to use to create a replication slot.

The default value is pglogical .

secretsManagerAccessRoleArn?

Type: string (optional)

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.

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 , the corresponding SecretsManagerAccessRoleArn , and the SecretsManagerSecretId that is required to access it, see Using secrets to access AWS Database Migration Service resources in the AWS Database Migration Service User Guide .

secretsManagerSecretId?

Type: string (optional)

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

slotName?

Type: string (optional)

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 .