software.amazon.awssdk.services.databasemigration.model

Interface PostgreSQLSettings.Builder

All Superinterfaces:

Buildable, CopyableBuilder<PostgreSQLSettings.Builder,PostgreSQLSettings>, SdkBuilder<PostgreSQLSettings.Builder,PostgreSQLSettings>, SdkPojo

Enclosing class:

PostgreSQLSettings

public static interface PostgreSQLSettings.Builder
extends SdkPojo, CopyableBuilder<PostgreSQLSettings.Builder,PostgreSQLSettings>

Method Summary

Modifier and Type	Method and Description
PostgreSQLSettings.Builder	afterConnectScript(String 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.
PostgreSQLSettings.Builder	captureDdls(Boolean captureDdls) To capture DDL events, AWS DMS creates various artifacts in the PostgreSQL database when the task starts.
PostgreSQLSettings.Builder	databaseName(String databaseName) Database name for the endpoint.
PostgreSQLSettings.Builder	ddlArtifactsSchema(String ddlArtifactsSchema) The schema in which the operational DDL database artifacts are created.
PostgreSQLSettings.Builder	executeTimeout(Integer executeTimeout) Sets the client statement timeout for the PostgreSQL instance, in seconds.
PostgreSQLSettings.Builder	failTasksOnLobTruncation(Boolean 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.
PostgreSQLSettings.Builder	maxFileSize(Integer maxFileSize) Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.
PostgreSQLSettings.Builder	password(String password) Endpoint connection password.
PostgreSQLSettings.Builder	port(Integer port) Endpoint TCP port.
PostgreSQLSettings.Builder	secretsManagerAccessRoleArn(String 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.
PostgreSQLSettings.Builder	secretsManagerSecretId(String secretsManagerSecretId) The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the PostgreSQL endpoint connection details.
PostgreSQLSettings.Builder	serverName(String serverName) Fully qualified domain name of the endpoint.
PostgreSQLSettings.Builder	slotName(String slotName) Sets the name of a previously created logical replication slot for a CDC load of the PostgreSQL source instance.
PostgreSQLSettings.Builder	username(String username) Endpoint connection user name.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

afterConnectScript

PostgreSQLSettings.Builder afterConnectScript(String 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'

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:

Returns a reference to this object so that method calls can be chained together.

captureDdls

PostgreSQLSettings.Builder captureDdls(Boolean 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 N, you don't have to create tables or triggers on the source database.

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

Returns:

Returns a reference to this object so that method calls can be chained together.

maxFileSize

PostgreSQLSettings.Builder maxFileSize(Integer maxFileSize)

Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.

Example: maxFileSize=512

Parameters:

maxFileSize - Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.

Example: maxFileSize=512

Returns:

Returns a reference to this object so that method calls can be chained together.

databaseName

PostgreSQLSettings.Builder databaseName(String databaseName)

Database name for the endpoint.

Parameters:

databaseName - Database name for the endpoint.

Returns:

Returns a reference to this object so that method calls can be chained together.

ddlArtifactsSchema

PostgreSQLSettings.Builder ddlArtifactsSchema(String ddlArtifactsSchema)

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

Example: ddlArtifactsSchema=xyzddlschema;

Parameters:

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

Example: ddlArtifactsSchema=xyzddlschema;

Returns:

Returns a reference to this object so that method calls can be chained together.

executeTimeout

PostgreSQLSettings.Builder executeTimeout(Integer executeTimeout)

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

Example: executeTimeout=100;

Parameters:

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

Example: executeTimeout=100;

Returns:

Returns a reference to this object so that method calls can be chained together.

failTasksOnLobTruncation

PostgreSQLSettings.Builder failTasksOnLobTruncation(Boolean 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.

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.

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:

Returns a reference to this object so that method calls can be chained together.

password

PostgreSQLSettings.Builder password(String password)

Endpoint connection password.

Parameters:

password - Endpoint connection password.

Returns:

Returns a reference to this object so that method calls can be chained together.

port

PostgreSQLSettings.Builder port(Integer port)

Endpoint TCP port.

Parameters:

port - Endpoint TCP port.

Returns:

Returns a reference to this object so that method calls can be chained together.

serverName

PostgreSQLSettings.Builder serverName(String serverName)

Fully qualified domain name of the endpoint.

Parameters:

serverName - Fully qualified domain name of the endpoint.

Returns:

Returns a reference to this object so that method calls can be chained together.

username

PostgreSQLSettings.Builder username(String username)

Endpoint connection user name.

Parameters:

username - Endpoint connection user name.

Returns:

Returns a reference to this object so that method calls can be chained together.

slotName

PostgreSQLSettings.Builder slotName(String slotName)

Sets the name of a previously created logical replication slot for a CDC load of the PostgreSQL source instance.

When used with the AWS DMS API CdcStartPosition request parameter, this attribute also enables using native CDC start points.

Parameters:

slotName - Sets the name of a previously created logical replication slot for a CDC load of the PostgreSQL source instance.

When used with the AWS DMS API CdcStartPosition request parameter, this attribute also enables using native CDC start points.

Returns:

Returns a reference to this object so that method calls can be chained together.

secretsManagerAccessRoleArn

PostgreSQLSettings.Builder secretsManagerAccessRoleArn(String 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. 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 and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access AWS Database Migration Service resources in the AWS Database Migration Service User Guide.

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

Returns:

Returns a reference to this object so that method calls can be chained together.

secretsManagerSecretId

PostgreSQLSettings.Builder secretsManagerSecretId(String secretsManagerSecretId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.