software.amazon.awssdk.services.databasemigration.model

Class PostgreSQLSettings

java.lang.Object

software.amazon.awssdk.services.databasemigration.model.PostgreSQLSettings

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<PostgreSQLSettings.Builder,PostgreSQLSettings>

@Generated(value="software.amazon.awssdk:codegen")
public final class PostgreSQLSettings
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<PostgreSQLSettings.Builder,PostgreSQLSettings>

Provides information that defines a PostgreSQL endpoint.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PostgreSQLSettings.Builder

Method Summary

Modifier and Type	Method and Description
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.
static PostgreSQLSettings.Builder	builder()
Boolean	captureDdls() To capture DDL events, AWS DMS creates various artifacts in the PostgreSQL database when the task starts.
String	databaseName() Database name for the endpoint.
String	ddlArtifactsSchema() The schema in which the operational DDL database artifacts are created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Integer	executeTimeout() Sets the client statement timeout for the PostgreSQL instance, in seconds.
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.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxFileSize() Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.
String	password() Endpoint connection password.
Integer	port() Endpoint TCP port.
List<SdkField<?>>	sdkFields()
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.
String	secretsManagerSecretId() The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the PostgreSQL endpoint connection details.
static Class<? extends PostgreSQLSettings.Builder>	serializableBuilderClass()
String	serverName() Fully qualified domain name of the endpoint.
String	slotName() Sets the name of a previously created logical replication slot for a CDC load of the PostgreSQL source instance.
PostgreSQLSettings.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	username() Endpoint connection user name.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

afterConnectScript

public final 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'

Returns:

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'

captureDdls

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

Returns:

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.

maxFileSize

public final Integer maxFileSize()

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

Example: maxFileSize=512

Returns:

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

Example: maxFileSize=512

databaseName

public final String databaseName()

Database name for the endpoint.

Returns:

Database name for the endpoint.

ddlArtifactsSchema

public final String ddlArtifactsSchema()

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

Example: ddlArtifactsSchema=xyzddlschema;

Returns:

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

Example: ddlArtifactsSchema=xyzddlschema;

executeTimeout

public final Integer executeTimeout()

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

Example: executeTimeout=100;

Returns:

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

Example: executeTimeout=100;

failTasksOnLobTruncation

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

Returns:

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.

password

public final String password()

Endpoint connection password.

Returns:

Endpoint connection password.

port

public final Integer port()

Endpoint TCP port.

Returns:

Endpoint TCP port.

serverName

public final String serverName()

Fully qualified domain name of the endpoint.

Returns:

Fully qualified domain name of the endpoint.

username

public final String username()

Endpoint connection user name.

Returns:

Endpoint connection user name.

slotName

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

Returns:

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.

secretsManagerAccessRoleArn

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

Returns:

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.

secretsManagerSecretId

public final String secretsManagerSecretId()

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

Returns:

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

toBuilder

public PostgreSQLSettings.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PostgreSQLSettings.Builder,PostgreSQLSettings>

builder

public static PostgreSQLSettings.Builder builder()

serializableBuilderClass

public static Class<? extends PostgreSQLSettings.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo