Class: Aws::DatabaseMigrationService::Types::PostgreSQLSettings

Inherits:

Struct

• Object
• Struct
• Aws::DatabaseMigrationService::Types::PostgreSQLSettings

Includes:

Structure

Defined in:

lib/aws-sdk-databasemigrationservice/types.rb

Overview

Provides information that defines a PostgreSQL endpoint.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:password]

Instance Attribute Summary

• #after_connect_script ⇒ String

  For use with change data capture (CDC) only, this attribute has DMS bypass foreign keys and user triggers to reduce the time it takes to bulk load data.

• #babelfish_database_name ⇒ String

  The Babelfish for Aurora PostgreSQL database name for the endpoint.

• #capture_ddls ⇒ Boolean

  To capture DDL events, DMS creates various artifacts in the PostgreSQL database when the task starts.

• #database_mode ⇒ String

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

• #database_name ⇒ String

  Database name for the endpoint.

• #ddl_artifacts_schema ⇒ String

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

• #execute_timeout ⇒ Integer

  Sets the client statement timeout for the PostgreSQL instance, in seconds.

• #fail_tasks_on_lob_truncation ⇒ Boolean

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

• #heartbeat_enable ⇒ Boolean

  The write-ahead log (WAL) heartbeat feature mimics a dummy transaction.

• #heartbeat_frequency ⇒ Integer

  Sets the WAL heartbeat frequency (in minutes).

• #heartbeat_schema ⇒ String

  Sets the schema in which the heartbeat artifacts are created.

• #map_boolean_as_boolean ⇒ Boolean

  When true, lets PostgreSQL migrate the boolean type as boolean.

• #map_jsonb_as_clob ⇒ Boolean

  When true, DMS migrates JSONB values as CLOB.

• #map_long_varchar_as ⇒ String

  When true, DMS migrates LONG values as VARCHAR.

• #max_file_size ⇒ Integer

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

• #password ⇒ String

  Endpoint connection password.

• #plugin_name ⇒ String

  Specifies the plugin to use to create a replication slot.

• #port ⇒ Integer

  Endpoint TCP port.

• #secrets_manager_access_role_arn ⇒ String

  The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in ‘SecretsManagerSecret`.

• #secrets_manager_secret_id ⇒ String

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

• #server_name ⇒ String

  The host name of the endpoint database.

• #slot_name ⇒ String

  Sets the name of a previously created logical replication slot for a change data capture (CDC) load of the PostgreSQL source instance.

• #trim_space_in_char ⇒ Boolean

  Use the ‘TrimSpaceInChar` source endpoint setting to trim data on CHAR and NCHAR data types during migration.

• #username ⇒ String

  Endpoint connection user name.

Instance Attribute Details

#after_connect_script ⇒ String

For use with change data capture (CDC) only, this attribute has 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:

• (String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 9278

class PostgreSQLSettings < Struct.new(
  :after_connect_script,
  :capture_ddls,
  :max_file_size,
  :database_name,
  :ddl_artifacts_schema,
  :execute_timeout,
  :fail_tasks_on_lob_truncation,
  :heartbeat_enable,
  :heartbeat_schema,
  :heartbeat_frequency,
  :password,
  :port,
  :server_name,
  :username,
  :slot_name,
  :plugin_name,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :trim_space_in_char,
  :map_boolean_as_boolean,
  :map_jsonb_as_clob,
  :map_long_varchar_as,
  :database_mode,
  :babelfish_database_name)
  SENSITIVE = [:password]
  include Aws::Structure
end

#babelfish_database_name ⇒ String

The Babelfish for Aurora PostgreSQL database name for the endpoint.

Returns:

• (String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 9278

class PostgreSQLSettings < Struct.new(
  :after_connect_script,
  :capture_ddls,
  :max_file_size,
  :database_name,
  :ddl_artifacts_schema,
  :execute_timeout,
  :fail_tasks_on_lob_truncation,
  :heartbeat_enable,
  :heartbeat_schema,
  :heartbeat_frequency,
  :password,
  :port,
  :server_name,
  :username,
  :slot_name,
  :plugin_name,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :trim_space_in_char,
  :map_boolean_as_boolean,
  :map_jsonb_as_clob,
  :map_long_varchar_as,
  :database_mode,
  :babelfish_database_name)
  SENSITIVE = [:password]
  include Aws::Structure
end

#capture_ddls ⇒ Boolean

To capture DDL events, 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:

• (Boolean)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 9278

class PostgreSQLSettings < Struct.new(
  :after_connect_script,
  :capture_ddls,
  :max_file_size,
  :database_name,
  :ddl_artifacts_schema,
  :execute_timeout,
  :fail_tasks_on_lob_truncation,
  :heartbeat_enable,
  :heartbeat_schema,
  :heartbeat_frequency,
  :password,
  :port,
  :server_name,
  :username,
  :slot_name,
  :plugin_name,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :trim_space_in_char,
  :map_boolean_as_boolean,
  :map_jsonb_as_clob,
  :map_long_varchar_as,
  :database_mode,
  :babelfish_database_name)
  SENSITIVE = [:password]
  include Aws::Structure
end

#database_mode ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 9278

class PostgreSQLSettings < Struct.new(
  :after_connect_script,
  :capture_ddls,
  :max_file_size,
  :database_name,
  :ddl_artifacts_schema,
  :execute_timeout,
  :fail_tasks_on_lob_truncation,
  :heartbeat_enable,
  :heartbeat_schema,
  :heartbeat_frequency,
  :password,
  :port,
  :server_name,
  :username,
  :slot_name,
  :plugin_name,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :trim_space_in_char,
  :map_boolean_as_boolean,
  :map_jsonb_as_clob,
  :map_long_varchar_as,
  :database_mode,
  :babelfish_database_name)
  SENSITIVE = [:password]
  include Aws::Structure
end

#database_name ⇒ String

Database name for the endpoint.

Returns:

• (String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 9278

class PostgreSQLSettings < Struct.new(
  :after_connect_script,
  :capture_ddls,
  :max_file_size,
  :database_name,
  :ddl_artifacts_schema,
  :execute_timeout,
  :fail_tasks_on_lob_truncation,
  :heartbeat_enable,
  :heartbeat_schema,
  :heartbeat_frequency,
  :password,
  :port,
  :server_name,
  :username,
  :slot_name,
  :plugin_name,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :trim_space_in_char,
  :map_boolean_as_boolean,
  :map_jsonb_as_clob,
  :map_long_varchar_as,
  :database_mode,
  :babelfish_database_name)
  SENSITIVE = [:password]
  include Aws::Structure
end

#ddl_artifacts_schema ⇒ String

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

Example: ‘ddlArtifactsSchema=xyzddlschema;`

Returns:

• (String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 9278

class PostgreSQLSettings < Struct.new(
  :after_connect_script,
  :capture_ddls,
  :max_file_size,
  :database_name,
  :ddl_artifacts_schema,
  :execute_timeout,
  :fail_tasks_on_lob_truncation,
  :heartbeat_enable,
  :heartbeat_schema,
  :heartbeat_frequency,
  :password,
  :port,
  :server_name,
  :username,
  :slot_name,
  :plugin_name,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :trim_space_in_char,
  :map_boolean_as_boolean,
  :map_jsonb_as_clob,
  :map_long_varchar_as,
  :database_mode,
  :babelfish_database_name)
  SENSITIVE = [:password]
  include Aws::Structure
end

#execute_timeout ⇒ Integer

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

Example: ‘executeTimeout=100;`

Returns:

• (Integer)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 9278

class PostgreSQLSettings < Struct.new(
  :after_connect_script,
  :capture_ddls,
  :max_file_size,
  :database_name,
  :ddl_artifacts_schema,
  :execute_timeout,
  :fail_tasks_on_lob_truncation,
  :heartbeat_enable,
  :heartbeat_schema,
  :heartbeat_frequency,
  :password,
  :port,
  :server_name,
  :username,
  :slot_name,
  :plugin_name,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :trim_space_in_char,
  :map_boolean_as_boolean,
  :map_jsonb_as_clob,
  :map_long_varchar_as,
  :database_mode,
  :babelfish_database_name)
  SENSITIVE = [:password]
  include Aws::Structure
end

#fail_tasks_on_lob_truncation ⇒ Boolean

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:

• (Boolean)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 9278

class PostgreSQLSettings < Struct.new(
  :after_connect_script,
  :capture_ddls,
  :max_file_size,
  :database_name,
  :ddl_artifacts_schema,
  :execute_timeout,
  :fail_tasks_on_lob_truncation,
  :heartbeat_enable,
  :heartbeat_schema,
  :heartbeat_frequency,
  :password,
  :port,
  :server_name,
  :username,
  :slot_name,
  :plugin_name,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :trim_space_in_char,
  :map_boolean_as_boolean,
  :map_jsonb_as_clob,
  :map_long_varchar_as,
  :database_mode,
  :babelfish_database_name)
  SENSITIVE = [:password]
  include Aws::Structure
end

#heartbeat_enable ⇒ Boolean

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.

Returns:

• (Boolean)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 9278

class PostgreSQLSettings < Struct.new(
  :after_connect_script,
  :capture_ddls,
  :max_file_size,
  :database_name,
  :ddl_artifacts_schema,
  :execute_timeout,
  :fail_tasks_on_lob_truncation,
  :heartbeat_enable,
  :heartbeat_schema,
  :heartbeat_frequency,
  :password,
  :port,
  :server_name,
  :username,
  :slot_name,
  :plugin_name,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :trim_space_in_char,
  :map_boolean_as_boolean,
  :map_jsonb_as_clob,
  :map_long_varchar_as,
  :database_mode,
  :babelfish_database_name)
  SENSITIVE = [:password]
  include Aws::Structure
end

#heartbeat_frequency ⇒ Integer

Sets the WAL heartbeat frequency (in minutes).

Returns:

• (Integer)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 9278

class PostgreSQLSettings < Struct.new(
  :after_connect_script,
  :capture_ddls,
  :max_file_size,
  :database_name,
  :ddl_artifacts_schema,
  :execute_timeout,
  :fail_tasks_on_lob_truncation,
  :heartbeat_enable,
  :heartbeat_schema,
  :heartbeat_frequency,
  :password,
  :port,
  :server_name,
  :username,
  :slot_name,
  :plugin_name,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :trim_space_in_char,
  :map_boolean_as_boolean,
  :map_jsonb_as_clob,
  :map_long_varchar_as,
  :database_mode,
  :babelfish_database_name)
  SENSITIVE = [:password]
  include Aws::Structure
end

#heartbeat_schema ⇒ String

Sets the schema in which the heartbeat artifacts are created.

Returns:

• (String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 9278

class PostgreSQLSettings < Struct.new(
  :after_connect_script,
  :capture_ddls,
  :max_file_size,
  :database_name,
  :ddl_artifacts_schema,
  :execute_timeout,
  :fail_tasks_on_lob_truncation,
  :heartbeat_enable,
  :heartbeat_schema,
  :heartbeat_frequency,
  :password,
  :port,
  :server_name,
  :username,
  :slot_name,
  :plugin_name,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :trim_space_in_char,
  :map_boolean_as_boolean,
  :map_jsonb_as_clob,
  :map_long_varchar_as,
  :database_mode,
  :babelfish_database_name)
  SENSITIVE = [:password]
  include Aws::Structure
end

#map_boolean_as_boolean ⇒ Boolean

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.

Returns:

• (Boolean)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 9278

class PostgreSQLSettings < Struct.new(
  :after_connect_script,
  :capture_ddls,
  :max_file_size,
  :database_name,
  :ddl_artifacts_schema,
  :execute_timeout,
  :fail_tasks_on_lob_truncation,
  :heartbeat_enable,
  :heartbeat_schema,
  :heartbeat_frequency,
  :password,
  :port,
  :server_name,
  :username,
  :slot_name,
  :plugin_name,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :trim_space_in_char,
  :map_boolean_as_boolean,
  :map_jsonb_as_clob,
  :map_long_varchar_as,
  :database_mode,
  :babelfish_database_name)
  SENSITIVE = [:password]
  include Aws::Structure
end

#map_jsonb_as_clob ⇒ Boolean

When true, DMS migrates JSONB values as CLOB.

Returns:

• (Boolean)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 9278

class PostgreSQLSettings < Struct.new(
  :after_connect_script,
  :capture_ddls,
  :max_file_size,
  :database_name,
  :ddl_artifacts_schema,
  :execute_timeout,
  :fail_tasks_on_lob_truncation,
  :heartbeat_enable,
  :heartbeat_schema,
  :heartbeat_frequency,
  :password,
  :port,
  :server_name,
  :username,
  :slot_name,
  :plugin_name,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :trim_space_in_char,
  :map_boolean_as_boolean,
  :map_jsonb_as_clob,
  :map_long_varchar_as,
  :database_mode,
  :babelfish_database_name)
  SENSITIVE = [:password]
  include Aws::Structure
end

#map_long_varchar_as ⇒ String

When true, DMS migrates LONG values as VARCHAR.

Returns:

• (String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 9278

class PostgreSQLSettings < Struct.new(
  :after_connect_script,
  :capture_ddls,
  :max_file_size,
  :database_name,
  :ddl_artifacts_schema,
  :execute_timeout,
  :fail_tasks_on_lob_truncation,
  :heartbeat_enable,
  :heartbeat_schema,
  :heartbeat_frequency,
  :password,
  :port,
  :server_name,
  :username,
  :slot_name,
  :plugin_name,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :trim_space_in_char,
  :map_boolean_as_boolean,
  :map_jsonb_as_clob,
  :map_long_varchar_as,
  :database_mode,
  :babelfish_database_name)
  SENSITIVE = [:password]
  include Aws::Structure
end

#max_file_size ⇒ Integer

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

Example: ‘maxFileSize=512`

Returns:

• (Integer)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 9278

class PostgreSQLSettings < Struct.new(
  :after_connect_script,
  :capture_ddls,
  :max_file_size,
  :database_name,
  :ddl_artifacts_schema,
  :execute_timeout,
  :fail_tasks_on_lob_truncation,
  :heartbeat_enable,
  :heartbeat_schema,
  :heartbeat_frequency,
  :password,
  :port,
  :server_name,
  :username,
  :slot_name,
  :plugin_name,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :trim_space_in_char,
  :map_boolean_as_boolean,
  :map_jsonb_as_clob,
  :map_long_varchar_as,
  :database_mode,
  :babelfish_database_name)
  SENSITIVE = [:password]
  include Aws::Structure
end

#password ⇒ String

Endpoint connection password.

Returns:

• (String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 9278

class PostgreSQLSettings < Struct.new(
  :after_connect_script,
  :capture_ddls,
  :max_file_size,
  :database_name,
  :ddl_artifacts_schema,
  :execute_timeout,
  :fail_tasks_on_lob_truncation,
  :heartbeat_enable,
  :heartbeat_schema,
  :heartbeat_frequency,
  :password,
  :port,
  :server_name,
  :username,
  :slot_name,
  :plugin_name,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :trim_space_in_char,
  :map_boolean_as_boolean,
  :map_jsonb_as_clob,
  :map_long_varchar_as,
  :database_mode,
  :babelfish_database_name)
  SENSITIVE = [:password]
  include Aws::Structure
end

#plugin_name ⇒ String

Specifies the plugin to use to create a replication slot.

Returns:

• (String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 9278

class PostgreSQLSettings < Struct.new(
  :after_connect_script,
  :capture_ddls,
  :max_file_size,
  :database_name,
  :ddl_artifacts_schema,
  :execute_timeout,
  :fail_tasks_on_lob_truncation,
  :heartbeat_enable,
  :heartbeat_schema,
  :heartbeat_frequency,
  :password,
  :port,
  :server_name,
  :username,
  :slot_name,
  :plugin_name,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :trim_space_in_char,
  :map_boolean_as_boolean,
  :map_jsonb_as_clob,
  :map_long_varchar_as,
  :database_mode,
  :babelfish_database_name)
  SENSITIVE = [:password]
  include Aws::Structure
end

#port ⇒ Integer

Endpoint TCP port. The default is 5432.

Returns:

• (Integer)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 9278

class PostgreSQLSettings < Struct.new(
  :after_connect_script,
  :capture_ddls,
  :max_file_size,
  :database_name,
  :ddl_artifacts_schema,
  :execute_timeout,
  :fail_tasks_on_lob_truncation,
  :heartbeat_enable,
  :heartbeat_schema,
  :heartbeat_frequency,
  :password,
  :port,
  :server_name,
  :username,
  :slot_name,
  :plugin_name,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :trim_space_in_char,
  :map_boolean_as_boolean,
  :map_jsonb_as_clob,
  :map_long_varchar_as,
  :database_mode,
  :babelfish_database_name)
  SENSITIVE = [:password]
  include Aws::Structure
end

#secrets_manager_access_role_arn ⇒ String

The full Amazon Resource Name (ARN) of the IAM role that specifies 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 Amazon Web Services Secrets Manager secret that allows access to the PostgreSQL endpoint.

<note markdown=“1”> 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 Database Migration Service resources] in the *Database Migration Service User Guide*.

</note>

[1]: docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager

Returns:

• (String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 9278

class PostgreSQLSettings < Struct.new(
  :after_connect_script,
  :capture_ddls,
  :max_file_size,
  :database_name,
  :ddl_artifacts_schema,
  :execute_timeout,
  :fail_tasks_on_lob_truncation,
  :heartbeat_enable,
  :heartbeat_schema,
  :heartbeat_frequency,
  :password,
  :port,
  :server_name,
  :username,
  :slot_name,
  :plugin_name,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :trim_space_in_char,
  :map_boolean_as_boolean,
  :map_jsonb_as_clob,
  :map_long_varchar_as,
  :database_mode,
  :babelfish_database_name)
  SENSITIVE = [:password]
  include Aws::Structure
end

#secrets_manager_secret_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 9278

class PostgreSQLSettings < Struct.new(
  :after_connect_script,
  :capture_ddls,
  :max_file_size,
  :database_name,
  :ddl_artifacts_schema,
  :execute_timeout,
  :fail_tasks_on_lob_truncation,
  :heartbeat_enable,
  :heartbeat_schema,
  :heartbeat_frequency,
  :password,
  :port,
  :server_name,
  :username,
  :slot_name,
  :plugin_name,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :trim_space_in_char,
  :map_boolean_as_boolean,
  :map_jsonb_as_clob,
  :map_long_varchar_as,
  :database_mode,
  :babelfish_database_name)
  SENSITIVE = [:password]
  include Aws::Structure
end

#server_name ⇒ String

The host name of the endpoint database.

For an Amazon RDS PostgreSQL instance, this is the output of [DescribeDBInstances], in the ‘ Endpoint.Address` field.

For an Aurora PostgreSQL instance, this is the output of [DescribeDBClusters], in the ‘Endpoint` field.

[1]: docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html [2]: docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBClusters.html

Returns:

• (String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 9278

class PostgreSQLSettings < Struct.new(
  :after_connect_script,
  :capture_ddls,
  :max_file_size,
  :database_name,
  :ddl_artifacts_schema,
  :execute_timeout,
  :fail_tasks_on_lob_truncation,
  :heartbeat_enable,
  :heartbeat_schema,
  :heartbeat_frequency,
  :password,
  :port,
  :server_name,
  :username,
  :slot_name,
  :plugin_name,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :trim_space_in_char,
  :map_boolean_as_boolean,
  :map_jsonb_as_clob,
  :map_long_varchar_as,
  :database_mode,
  :babelfish_database_name)
  SENSITIVE = [:password]
  include Aws::Structure
end

#slot_name ⇒ String

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 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 *Database Migration Service User Guide*. For more information about using `CdcStartPosition`, see [CreateReplicationTask], [StartReplicationTask], and [ModifyReplicationTask].

[1]: docs.aws.amazon.com/dms/latest/userguide/CHAP_Task.CDC.html#CHAP_Task.CDC.StartPoint.Native [2]: docs.aws.amazon.com/dms/latest/APIReference/API_CreateReplicationTask.html [3]: docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html [4]: docs.aws.amazon.com/dms/latest/APIReference/API_ModifyReplicationTask.html

Returns:

• (String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 9278

class PostgreSQLSettings < Struct.new(
  :after_connect_script,
  :capture_ddls,
  :max_file_size,
  :database_name,
  :ddl_artifacts_schema,
  :execute_timeout,
  :fail_tasks_on_lob_truncation,
  :heartbeat_enable,
  :heartbeat_schema,
  :heartbeat_frequency,
  :password,
  :port,
  :server_name,
  :username,
  :slot_name,
  :plugin_name,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :trim_space_in_char,
  :map_boolean_as_boolean,
  :map_jsonb_as_clob,
  :map_long_varchar_as,
  :database_mode,
  :babelfish_database_name)
  SENSITIVE = [:password]
  include Aws::Structure
end

#trim_space_in_char ⇒ Boolean

Use the ‘TrimSpaceInChar` source endpoint setting to trim data on CHAR and NCHAR data types during migration. The default value is `true`.

Returns:

• (Boolean)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 9278

class PostgreSQLSettings < Struct.new(
  :after_connect_script,
  :capture_ddls,
  :max_file_size,
  :database_name,
  :ddl_artifacts_schema,
  :execute_timeout,
  :fail_tasks_on_lob_truncation,
  :heartbeat_enable,
  :heartbeat_schema,
  :heartbeat_frequency,
  :password,
  :port,
  :server_name,
  :username,
  :slot_name,
  :plugin_name,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :trim_space_in_char,
  :map_boolean_as_boolean,
  :map_jsonb_as_clob,
  :map_long_varchar_as,
  :database_mode,
  :babelfish_database_name)
  SENSITIVE = [:password]
  include Aws::Structure
end

#username ⇒ String

Endpoint connection user name.

Returns:

• (String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 9278

class PostgreSQLSettings < Struct.new(
  :after_connect_script,
  :capture_ddls,
  :max_file_size,
  :database_name,
  :ddl_artifacts_schema,
  :execute_timeout,
  :fail_tasks_on_lob_truncation,
  :heartbeat_enable,
  :heartbeat_schema,
  :heartbeat_frequency,
  :password,
  :port,
  :server_name,
  :username,
  :slot_name,
  :plugin_name,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id,
  :trim_space_in_char,
  :map_boolean_as_boolean,
  :map_jsonb_as_clob,
  :map_long_varchar_as,
  :database_mode,
  :babelfish_database_name)
  SENSITIVE = [:password]
  include Aws::Structure
end