Interface CfnEndpointPropsMixin.IPostgreSqlSettingsProperty
Provides information that defines a PostgreSQL endpoint.
Namespace: Amazon.CDK.CfnPropertyMixins.AWS.DMS
Assembly: Amazon.CDK.CfnPropertyMixins.dll
Syntax (csharp)
public interface CfnEndpointPropsMixin.IPostgreSqlSettingsPropertySyntax (vb)
Public Interface CfnEndpointPropsMixin.IPostgreSqlSettingsPropertyRemarks
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 .
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.CfnPropertyMixins.AWS.DMS;
var postgreSqlSettingsProperty = new 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"
};Synopsis
Properties
| 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. |
| BabelfishDatabaseName | The Babelfish for Aurora PostgreSQL database name for the endpoint. |
| CaptureDdls | To capture DDL events, AWS DMS creates various artifacts in the PostgreSQL database when the task starts. |
| DatabaseMode | Specifies the default behavior of the replication's handling of PostgreSQL- compatible endpoints that require some additional configuration, such as Babelfish endpoints. |
| DdlArtifactsSchema | The schema in which the operational DDL database artifacts are created. |
| ExecuteTimeout | Sets the client statement timeout for the PostgreSQL instance, in seconds. The default value is 60 seconds. |
| FailTasksOnLobTruncation | When set to |
| HeartbeatEnable | The write-ahead log (WAL) heartbeat feature mimics a dummy transaction. |
| HeartbeatFrequency | Sets the WAL heartbeat frequency (in minutes). |
| HeartbeatSchema | Sets the schema in which the heartbeat artifacts are created. |
| MapBooleanAsBoolean | When true, lets PostgreSQL migrate the boolean type as boolean. |
| MaxFileSize | Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL. |
| PluginName | Specifies the plugin to use to create a replication slot. |
| SecretsManagerAccessRoleArn | 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 |
| SecretsManagerSecretId | The full ARN, partial ARN, or display name of the |
| SlotName | Sets the name of a previously created logical replication slot for a change data capture (CDC) load of the PostgreSQL source instance. |
Properties
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.
string? AfterConnectScript { get; }Property Value
Remarks
Example: afterConnectScript=SET session_replication_role='replica'
BabelfishDatabaseName
The Babelfish for Aurora PostgreSQL database name for the endpoint.
string? BabelfishDatabaseName { get; }Property Value
Remarks
CaptureDdls
To capture DDL events, AWS DMS creates various artifacts in the PostgreSQL database when the task starts.
object? CaptureDdls { get; }Property Value
Remarks
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.
Type union: either bool or IResolvable
DatabaseMode
Specifies the default behavior of the replication's handling of PostgreSQL- compatible endpoints that require some additional configuration, such as Babelfish endpoints.
string? DatabaseMode { get; }Property Value
Remarks
DdlArtifactsSchema
The schema in which the operational DDL database artifacts are created.
string? DdlArtifactsSchema { get; }Property Value
Remarks
The default value is public .
Example: ddlArtifactsSchema=xyzddlschema;
ExecuteTimeout
Sets the client statement timeout for the PostgreSQL instance, in seconds. The default value is 60 seconds.
double? ExecuteTimeout { get; }Property Value
Remarks
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 .
object? FailTasksOnLobTruncation { get; }Property Value
Remarks
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 union: either bool or IResolvable
HeartbeatEnable
The write-ahead log (WAL) heartbeat feature mimics a dummy transaction.
object? HeartbeatEnable { get; }Property Value
Remarks
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 union: either bool or IResolvable
HeartbeatFrequency
Sets the WAL heartbeat frequency (in minutes).
double? HeartbeatFrequency { get; }Property Value
Remarks
HeartbeatSchema
Sets the schema in which the heartbeat artifacts are created.
string? HeartbeatSchema { get; }Property Value
Remarks
MapBooleanAsBoolean
When true, lets PostgreSQL migrate the boolean type as boolean.
object? MapBooleanAsBoolean { get; }Property Value
Remarks
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 union: either bool or IResolvable
MaxFileSize
Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.
double? MaxFileSize { get; }Property Value
Remarks
The default value is 32,768 KB (32 MB).
Example: maxFileSize=512
PluginName
Specifies the plugin to use to create a replication slot.
string? PluginName { get; }Property Value
Remarks
SecretsManagerAccessRoleArn
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 .
string? SecretsManagerAccessRoleArn { get; }Property Value
Remarks
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 <code>SecretsManagerSecretId</code> . Or you can specify clear-text values for <code>UserName</code> , <code>Password</code> , <code>ServerName</code> , and <code>Port</code> . 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
The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the PostgreSQL endpoint connection details.
string? SecretsManagerSecretId { get; }Property Value
Remarks
SlotName
Sets the name of a previously created logical replication slot for a change data capture (CDC) load of the PostgreSQL source instance.
string? SlotName { get; }Property Value
Remarks
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 .