Package software.amazon.awscdk.services.dms

Class CfnEndpoint.PostgreSqlSettingsProperty.Builder

java.lang.Object

software.amazon.awscdk.services.dms.CfnEndpoint.PostgreSqlSettingsProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnEndpoint.PostgreSqlSettingsProperty>

Enclosing interface:

CfnEndpoint.PostgreSqlSettingsProperty

@Stability(Stable)
public static final class CfnEndpoint.PostgreSqlSettingsProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnEndpoint.PostgreSqlSettingsProperty>

A builder for CfnEndpoint.PostgreSqlSettingsProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnEndpoint.PostgreSqlSettingsProperty.Builder	afterConnectScript(String afterConnectScript)	Sets the value of CfnEndpoint.PostgreSqlSettingsProperty.getAfterConnectScript()
CfnEndpoint.PostgreSqlSettingsProperty.Builder	babelfishDatabaseName(String babelfishDatabaseName)	Sets the value of CfnEndpoint.PostgreSqlSettingsProperty.getBabelfishDatabaseName()
CfnEndpoint.PostgreSqlSettingsProperty	build()	Builds the configured instance.
CfnEndpoint.PostgreSqlSettingsProperty.Builder	captureDdls(Boolean captureDdls)	Sets the value of CfnEndpoint.PostgreSqlSettingsProperty.getCaptureDdls()
CfnEndpoint.PostgreSqlSettingsProperty.Builder	captureDdls(IResolvable captureDdls)	Sets the value of CfnEndpoint.PostgreSqlSettingsProperty.getCaptureDdls()
CfnEndpoint.PostgreSqlSettingsProperty.Builder	databaseMode(String databaseMode)	Sets the value of CfnEndpoint.PostgreSqlSettingsProperty.getDatabaseMode()
CfnEndpoint.PostgreSqlSettingsProperty.Builder	ddlArtifactsSchema(String ddlArtifactsSchema)	Sets the value of CfnEndpoint.PostgreSqlSettingsProperty.getDdlArtifactsSchema()
CfnEndpoint.PostgreSqlSettingsProperty.Builder	executeTimeout(Number executeTimeout)	Sets the value of CfnEndpoint.PostgreSqlSettingsProperty.getExecuteTimeout()
CfnEndpoint.PostgreSqlSettingsProperty.Builder	failTasksOnLobTruncation(Boolean failTasksOnLobTruncation)	Sets the value of CfnEndpoint.PostgreSqlSettingsProperty.getFailTasksOnLobTruncation()
CfnEndpoint.PostgreSqlSettingsProperty.Builder	failTasksOnLobTruncation(IResolvable failTasksOnLobTruncation)	Sets the value of CfnEndpoint.PostgreSqlSettingsProperty.getFailTasksOnLobTruncation()
CfnEndpoint.PostgreSqlSettingsProperty.Builder	heartbeatEnable(Boolean heartbeatEnable)	Sets the value of CfnEndpoint.PostgreSqlSettingsProperty.getHeartbeatEnable()
CfnEndpoint.PostgreSqlSettingsProperty.Builder	heartbeatEnable(IResolvable heartbeatEnable)	Sets the value of CfnEndpoint.PostgreSqlSettingsProperty.getHeartbeatEnable()
CfnEndpoint.PostgreSqlSettingsProperty.Builder	heartbeatFrequency(Number heartbeatFrequency)	Sets the value of CfnEndpoint.PostgreSqlSettingsProperty.getHeartbeatFrequency()
CfnEndpoint.PostgreSqlSettingsProperty.Builder	heartbeatSchema(String heartbeatSchema)	Sets the value of CfnEndpoint.PostgreSqlSettingsProperty.getHeartbeatSchema()
CfnEndpoint.PostgreSqlSettingsProperty.Builder	mapBooleanAsBoolean(Boolean mapBooleanAsBoolean)	Sets the value of CfnEndpoint.PostgreSqlSettingsProperty.getMapBooleanAsBoolean()
CfnEndpoint.PostgreSqlSettingsProperty.Builder	mapBooleanAsBoolean(IResolvable mapBooleanAsBoolean)	Sets the value of CfnEndpoint.PostgreSqlSettingsProperty.getMapBooleanAsBoolean()
CfnEndpoint.PostgreSqlSettingsProperty.Builder	maxFileSize(Number maxFileSize)	Sets the value of CfnEndpoint.PostgreSqlSettingsProperty.getMaxFileSize()
CfnEndpoint.PostgreSqlSettingsProperty.Builder	pluginName(String pluginName)	Sets the value of CfnEndpoint.PostgreSqlSettingsProperty.getPluginName()
CfnEndpoint.PostgreSqlSettingsProperty.Builder	secretsManagerAccessRoleArn(String secretsManagerAccessRoleArn)	Sets the value of CfnEndpoint.PostgreSqlSettingsProperty.getSecretsManagerAccessRoleArn()
CfnEndpoint.PostgreSqlSettingsProperty.Builder	secretsManagerSecretId(String secretsManagerSecretId)	Sets the value of CfnEndpoint.PostgreSqlSettingsProperty.getSecretsManagerSecretId()
CfnEndpoint.PostgreSqlSettingsProperty.Builder	slotName(String slotName)	Sets the value of CfnEndpoint.PostgreSqlSettingsProperty.getSlotName()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

afterConnectScript

@Stability(Stable)
public CfnEndpoint.PostgreSqlSettingsProperty.Builder afterConnectScript(String afterConnectScript)

Sets the value of CfnEndpoint.PostgreSqlSettingsProperty.getAfterConnectScript()

Parameters:

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'

Returns:

this

babelfishDatabaseName

@Stability(Stable)
public CfnEndpoint.PostgreSqlSettingsProperty.Builder babelfishDatabaseName(String babelfishDatabaseName)

Sets the value of CfnEndpoint.PostgreSqlSettingsProperty.getBabelfishDatabaseName()

Parameters:

babelfishDatabaseName - The Babelfish for Aurora PostgreSQL database name for the endpoint.

Returns:

this

captureDdls

@Stability(Stable)
public CfnEndpoint.PostgreSqlSettingsProperty.Builder captureDdls(Boolean captureDdls)

Sets the value of CfnEndpoint.PostgreSqlSettingsProperty.getCaptureDdls()

Parameters:

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

Returns:

this

captureDdls

@Stability(Stable)
public CfnEndpoint.PostgreSqlSettingsProperty.Builder captureDdls(IResolvable captureDdls)

Sets the value of CfnEndpoint.PostgreSqlSettingsProperty.getCaptureDdls()

Parameters:

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

Returns:

this

databaseMode

@Stability(Stable)
public CfnEndpoint.PostgreSqlSettingsProperty.Builder databaseMode(String databaseMode)

Sets the value of CfnEndpoint.PostgreSqlSettingsProperty.getDatabaseMode()

Parameters:

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

Returns:

this

ddlArtifactsSchema

@Stability(Stable)
public CfnEndpoint.PostgreSqlSettingsProperty.Builder ddlArtifactsSchema(String ddlArtifactsSchema)

Sets the value of CfnEndpoint.PostgreSqlSettingsProperty.getDdlArtifactsSchema()

Parameters:

ddlArtifactsSchema - The schema in which the operational DDL database artifacts are created. The default value is public .

Example: ddlArtifactsSchema=xyzddlschema;

Returns:

this

executeTimeout

@Stability(Stable)
public CfnEndpoint.PostgreSqlSettingsProperty.Builder executeTimeout(Number executeTimeout)

Sets the value of CfnEndpoint.PostgreSqlSettingsProperty.getExecuteTimeout()

Parameters:

executeTimeout - Sets the client statement timeout for the PostgreSQL instance, in seconds. The default value is 60 seconds. Example: executeTimeout=100;

Returns:

this

failTasksOnLobTruncation

@Stability(Stable)
public CfnEndpoint.PostgreSqlSettingsProperty.Builder failTasksOnLobTruncation(Boolean failTasksOnLobTruncation)

Sets the value of CfnEndpoint.PostgreSqlSettingsProperty.getFailTasksOnLobTruncation()

Parameters:

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 . 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.

Returns:

this

failTasksOnLobTruncation

@Stability(Stable)
public CfnEndpoint.PostgreSqlSettingsProperty.Builder failTasksOnLobTruncation(IResolvable failTasksOnLobTruncation)

Sets the value of CfnEndpoint.PostgreSqlSettingsProperty.getFailTasksOnLobTruncation()

Parameters:

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 . 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.

Returns:

this

heartbeatEnable

@Stability(Stable)
public CfnEndpoint.PostgreSqlSettingsProperty.Builder heartbeatEnable(Boolean heartbeatEnable)

Sets the value of CfnEndpoint.PostgreSqlSettingsProperty.getHeartbeatEnable()

Parameters:

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.

The default value is false .

Returns:

this

heartbeatEnable

@Stability(Stable)
public CfnEndpoint.PostgreSqlSettingsProperty.Builder heartbeatEnable(IResolvable heartbeatEnable)

Sets the value of CfnEndpoint.PostgreSqlSettingsProperty.getHeartbeatEnable()

Parameters:

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.

The default value is false .

Returns:

this

heartbeatFrequency

@Stability(Stable)
public CfnEndpoint.PostgreSqlSettingsProperty.Builder heartbeatFrequency(Number heartbeatFrequency)

Sets the value of CfnEndpoint.PostgreSqlSettingsProperty.getHeartbeatFrequency()

Parameters:

heartbeatFrequency - Sets the WAL heartbeat frequency (in minutes). The default value is 5 minutes.

Returns:

this

heartbeatSchema

@Stability(Stable)
public CfnEndpoint.PostgreSqlSettingsProperty.Builder heartbeatSchema(String heartbeatSchema)

Sets the value of CfnEndpoint.PostgreSqlSettingsProperty.getHeartbeatSchema()

Parameters:

heartbeatSchema - Sets the schema in which the heartbeat artifacts are created. The default value is public .

Returns:

this

mapBooleanAsBoolean

@Stability(Stable)
public CfnEndpoint.PostgreSqlSettingsProperty.Builder mapBooleanAsBoolean(Boolean mapBooleanAsBoolean)

Sets the value of CfnEndpoint.PostgreSqlSettingsProperty.getMapBooleanAsBoolean()

Parameters:

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.

The default value is false .

Returns:

this

mapBooleanAsBoolean

@Stability(Stable)
public CfnEndpoint.PostgreSqlSettingsProperty.Builder mapBooleanAsBoolean(IResolvable mapBooleanAsBoolean)

Sets the value of CfnEndpoint.PostgreSqlSettingsProperty.getMapBooleanAsBoolean()

Parameters:

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.

The default value is false .

Returns:

this

maxFileSize

@Stability(Stable)
public CfnEndpoint.PostgreSqlSettingsProperty.Builder maxFileSize(Number maxFileSize)

Sets the value of CfnEndpoint.PostgreSqlSettingsProperty.getMaxFileSize()

Parameters:

maxFileSize - 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

Returns:

this

pluginName

@Stability(Stable)
public CfnEndpoint.PostgreSqlSettingsProperty.Builder pluginName(String pluginName)

Sets the value of CfnEndpoint.PostgreSqlSettingsProperty.getPluginName()

Parameters:

pluginName - Specifies the plugin to use to create a replication slot. The default value is pglogical .

Returns:

this

secretsManagerAccessRoleArn

@Stability(Stable)
public CfnEndpoint.PostgreSqlSettingsProperty.Builder secretsManagerAccessRoleArn(String secretsManagerAccessRoleArn)

Sets the value of CfnEndpoint.PostgreSqlSettingsProperty.getSecretsManagerAccessRoleArn()

Parameters:

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 . 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 .

Returns:

this

secretsManagerSecretId

@Stability(Stable)
public CfnEndpoint.PostgreSqlSettingsProperty.Builder secretsManagerSecretId(String secretsManagerSecretId)

Sets the value of CfnEndpoint.PostgreSqlSettingsProperty.getSecretsManagerSecretId()

Parameters:

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

Returns:

this

slotName

@Stability(Stable)
public CfnEndpoint.PostgreSqlSettingsProperty.Builder slotName(String slotName)

Sets the value of CfnEndpoint.PostgreSqlSettingsProperty.getSlotName()

Parameters:

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 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 .

Returns:

this

build

@Stability(Stable)
public CfnEndpoint.PostgreSqlSettingsProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnEndpoint.PostgreSqlSettingsProperty>

Returns:

a new instance of CfnEndpoint.PostgreSqlSettingsProperty

Throws:

NullPointerException - if any required attribute was not provided