Package software.amazon.awscdk.services.dms

Interface CfnEndpoint.PostgreSqlSettingsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEndpoint.PostgreSqlSettingsProperty.Jsii$Proxy

Enclosing class:

CfnEndpoint

@Stability(Stable)
public static interface CfnEndpoint.PostgreSqlSettingsProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.dms.*;
 PostgreSqlSettingsProperty postgreSqlSettingsProperty = PostgreSqlSettingsProperty.builder()
         .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")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnEndpoint.PostgreSqlSettingsProperty.Builder	A builder for CfnEndpoint.PostgreSqlSettingsProperty
static final class	CfnEndpoint.PostgreSqlSettingsProperty.Jsii$Proxy	An implementation for CfnEndpoint.PostgreSqlSettingsProperty

Method Summary

Modifier and Type	Method	Description
static CfnEndpoint.PostgreSqlSettingsProperty.Builder	builder()
default String	getAfterConnectScript()	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.
default String	getBabelfishDatabaseName()	The Babelfish for Aurora PostgreSQL database name for the endpoint.
default Object	getCaptureDdls()	To capture DDL events, AWS DMS creates various artifacts in the PostgreSQL database when the task starts.
default String	getDatabaseMode()	Specifies the default behavior of the replication's handling of PostgreSQL- compatible endpoints that require some additional configuration, such as Babelfish endpoints.
default String	getDdlArtifactsSchema()	The schema in which the operational DDL database artifacts are created.
default Number	getExecuteTimeout()	Sets the client statement timeout for the PostgreSQL instance, in seconds.
default Object	getFailTasksOnLobTruncation()	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 .
default Object	getHeartbeatEnable()	The write-ahead log (WAL) heartbeat feature mimics a dummy transaction.
default Number	getHeartbeatFrequency()	Sets the WAL heartbeat frequency (in minutes).
default String	getHeartbeatSchema()	Sets the schema in which the heartbeat artifacts are created.
default Object	getMapBooleanAsBoolean()	When true, lets PostgreSQL migrate the boolean type as boolean.
default Number	getMaxFileSize()	Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.
default String	getPluginName()	Specifies the plugin to use to create a replication slot.
default String	getSecretsManagerAccessRoleArn()	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 .
default String	getSecretsManagerSecretId()	The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the PostgreSQL endpoint connection details.
default String	getSlotName()	Sets the name of a previously created logical replication slot for a change data capture (CDC) load of the PostgreSQL source instance.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAfterConnectScript

@Stability(Stable)
@Nullable
default String getAfterConnectScript()

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'

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-afterconnectscript

getBabelfishDatabaseName

@Stability(Stable)
@Nullable
default String getBabelfishDatabaseName()

The Babelfish for Aurora PostgreSQL database name for the endpoint.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-babelfishdatabasename

getCaptureDdls

@Stability(Stable)
@Nullable
default Object getCaptureDdls()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-captureddls

getDatabaseMode

@Stability(Stable)
@Nullable
default String getDatabaseMode()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-databasemode

getDdlArtifactsSchema

@Stability(Stable)
@Nullable
default String getDdlArtifactsSchema()

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

The default value is public .

Example: ddlArtifactsSchema=xyzddlschema;

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-ddlartifactsschema

getExecuteTimeout

@Stability(Stable)
@Nullable
default Number getExecuteTimeout()

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

Example: executeTimeout=100;

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-executetimeout

getFailTasksOnLobTruncation

@Stability(Stable)
@Nullable
default Object getFailTasksOnLobTruncation()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-failtasksonlobtruncation

getHeartbeatEnable

@Stability(Stable)
@Nullable
default Object getHeartbeatEnable()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-heartbeatenable

getHeartbeatFrequency

@Stability(Stable)
@Nullable
default Number getHeartbeatFrequency()

Sets the WAL heartbeat frequency (in minutes).

The default value is 5 minutes.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-heartbeatfrequency

getHeartbeatSchema

@Stability(Stable)
@Nullable
default String getHeartbeatSchema()

Sets the schema in which the heartbeat artifacts are created.

The default value is public .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-heartbeatschema

getMapBooleanAsBoolean

@Stability(Stable)
@Nullable
default Object getMapBooleanAsBoolean()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-mapbooleanasboolean

getMaxFileSize

@Stability(Stable)
@Nullable
default Number getMaxFileSize()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-maxfilesize

getPluginName

@Stability(Stable)
@Nullable
default String getPluginName()

Specifies the plugin to use to create a replication slot.

The default value is pglogical .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-pluginname

getSecretsManagerAccessRoleArn

@Stability(Stable)
@Nullable
default String getSecretsManagerAccessRoleArn()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-secretsmanageraccessrolearn

getSecretsManagerSecretId

@Stability(Stable)
@Nullable
default String getSecretsManagerSecretId()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-secretsmanagersecretid

getSlotName

@Stability(Stable)
@Nullable
default String getSlotName()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-slotname

builder

@Stability(Stable)
static CfnEndpoint.PostgreSqlSettingsProperty.Builder builder()

Returns:

a CfnEndpoint.PostgreSqlSettingsProperty.Builder of CfnEndpoint.PostgreSqlSettingsProperty