#[non_exhaustive]pub struct PostgreSqlSettings { /* private fields */ }
Expand description
Provides information that defines a PostgreSQL endpoint.
Implementations§
source§impl PostgreSqlSettings
impl PostgreSqlSettings
sourcepub fn after_connect_script(&self) -> Option<&str>
pub fn after_connect_script(&self) -> Option<&str>
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'
sourcepub fn capture_ddls(&self) -> Option<bool>
pub fn capture_ddls(&self) -> Option<bool>
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.
sourcepub fn max_file_size(&self) -> Option<i32>
pub fn max_file_size(&self) -> Option<i32>
Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.
Example: maxFileSize=512
sourcepub fn database_name(&self) -> Option<&str>
pub fn database_name(&self) -> Option<&str>
Database name for the endpoint.
sourcepub fn ddl_artifacts_schema(&self) -> Option<&str>
pub fn ddl_artifacts_schema(&self) -> Option<&str>
The schema in which the operational DDL database artifacts are created.
Example: ddlArtifactsSchema=xyzddlschema;
sourcepub fn execute_timeout(&self) -> Option<i32>
pub fn execute_timeout(&self) -> Option<i32>
Sets the client statement timeout for the PostgreSQL instance, in seconds. The default value is 60 seconds.
Example: executeTimeout=100;
sourcepub fn fail_tasks_on_lob_truncation(&self) -> Option<bool>
pub fn fail_tasks_on_lob_truncation(&self) -> Option<bool>
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.
sourcepub fn heartbeat_enable(&self) -> Option<bool>
pub fn heartbeat_enable(&self) -> Option<bool>
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.
sourcepub fn heartbeat_schema(&self) -> Option<&str>
pub fn heartbeat_schema(&self) -> Option<&str>
Sets the schema in which the heartbeat artifacts are created.
sourcepub fn heartbeat_frequency(&self) -> Option<i32>
pub fn heartbeat_frequency(&self) -> Option<i32>
Sets the WAL heartbeat frequency (in minutes).
sourcepub fn server_name(&self) -> Option<&str>
pub fn server_name(&self) -> Option<&str>
Fully qualified domain name of the endpoint.
sourcepub fn slot_name(&self) -> Option<&str>
pub fn slot_name(&self) -> Option<&str>
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.
sourcepub fn plugin_name(&self) -> Option<&PluginNameValue>
pub fn plugin_name(&self) -> Option<&PluginNameValue>
Specifies the plugin to use to create a replication slot.
sourcepub fn secrets_manager_access_role_arn(&self) -> Option<&str>
pub fn secrets_manager_access_role_arn(&self) -> Option<&str>
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.
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.
sourcepub fn secrets_manager_secret_id(&self) -> Option<&str>
pub fn secrets_manager_secret_id(&self) -> Option<&str>
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret
that contains the PostgreSQL endpoint connection details.
sourcepub fn trim_space_in_char(&self) -> Option<bool>
pub fn trim_space_in_char(&self) -> Option<bool>
Use the TrimSpaceInChar
source endpoint setting to trim data on CHAR and NCHAR data types during migration. The default value is true
.
source§impl PostgreSqlSettings
impl PostgreSqlSettings
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture PostgreSqlSettings
.
Trait Implementations§
source§impl Clone for PostgreSqlSettings
impl Clone for PostgreSqlSettings
source§fn clone(&self) -> PostgreSqlSettings
fn clone(&self) -> PostgreSqlSettings
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for PostgreSqlSettings
impl Debug for PostgreSqlSettings
source§impl PartialEq<PostgreSqlSettings> for PostgreSqlSettings
impl PartialEq<PostgreSqlSettings> for PostgreSqlSettings
source§fn eq(&self, other: &PostgreSqlSettings) -> bool
fn eq(&self, other: &PostgreSqlSettings) -> bool
self
and other
values to be equal, and is used
by ==
.