You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::DatabaseMigrationService::Types::PostgreSQLSettings
- Inherits:
-
Struct
- Object
- Struct
- Aws::DatabaseMigrationService::Types::PostgreSQLSettings
- Defined in:
- (unknown)
Overview
When passing PostgreSQLSettings as input to an Aws::Client method, you can use a vanilla Hash:
{
after_connect_script: "String",
capture_ddls: false,
max_file_size: 1,
database_name: "String",
ddl_artifacts_schema: "String",
execute_timeout: 1,
fail_tasks_on_lob_truncation: false,
password: "SecretString",
port: 1,
server_name: "String",
username: "String",
slot_name: "String",
}
Provides information that defines a PostgreSQL endpoint.
Returned by:
Instance Attribute Summary collapse
-
#after_connect_script ⇒ String
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.
-
#capture_ddls ⇒ Boolean
To capture DDL events, AWS DMS creates various artifacts in the PostgreSQL database when the task starts.
-
#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 specifiedLobMaxSize
. -
#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.
-
#port ⇒ Integer
Endpoint TCP port.
-
#server_name ⇒ String
Fully qualified domain name of the endpoint.
-
#slot_name ⇒ String
Sets the name of a previously created logical replication slot for a CDC load of the PostgreSQL source instance.
-
#username ⇒ String
Endpoint connection user name.
Instance Attribute Details
#after_connect_script ⇒ String
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'
#capture_ddls ⇒ Boolean
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.
#database_name ⇒ String
Database name for the endpoint.
#ddl_artifacts_schema ⇒ String
The schema in which the operational DDL database artifacts are created.
Example: ddlArtifactsSchema=xyzddlschema;
#execute_timeout ⇒ Integer
Sets the client statement timeout for the PostgreSQL instance, in seconds. The default value is 60 seconds.
Example: executeTimeout=100;
#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.
#max_file_size ⇒ Integer
Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.
Example: maxFileSize=512
#password ⇒ String
Endpoint connection password.
#port ⇒ Integer
Endpoint TCP port.
#server_name ⇒ String
Fully qualified domain name of the endpoint.
#slot_name ⇒ String
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.
#username ⇒ String
Endpoint connection user name.