Struct PostgreSqlSettings

#[non_exhaustive]
pub struct PostgreSqlSettings {

    pub after_connect_script: Option<String>,
    pub capture_ddls: Option<bool>,
    pub max_file_size: Option<i32>,
    pub database_name: Option<String>,
    pub ddl_artifacts_schema: Option<String>,
    pub execute_timeout: Option<i32>,
    pub fail_tasks_on_lob_truncation: Option<bool>,
    pub heartbeat_enable: Option<bool>,
    pub heartbeat_schema: Option<String>,
    pub heartbeat_frequency: Option<i32>,
    pub password: Option<String>,
    pub port: Option<i32>,
    pub server_name: Option<String>,
    pub username: Option<String>,
    pub slot_name: Option<String>,
    pub plugin_name: Option<PluginNameValue>,
    pub secrets_manager_access_role_arn: Option<String>,
    pub secrets_manager_secret_id: Option<String>,
    pub trim_space_in_char: Option<bool>,
    pub map_boolean_as_boolean: Option<bool>,
    pub map_jsonb_as_clob: Option<bool>,
    pub map_long_varchar_as: Option<LongVarcharMappingType>,
    pub database_mode: Option<DatabaseMode>,
    pub babelfish_database_name: Option<String>,
    pub disable_unicode_source_filter: Option<bool>,
}

Provides information that defines a PostgreSQL endpoint.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

after_connect_script: Option<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'

capture_ddls: Option<bool>

To capture DDL events, DMS creates various artifacts in the PostgreSQL database when the task starts. You can later remove these artifacts.

The default value is true.

If this value is set to N, you don't have to create tables or triggers on the source database.

max_file_size: Option<i32>

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

The default value is 32,768 KB (32 MB).

Example: maxFileSize=512

database_name: Option<String>

Database name for the endpoint.

ddl_artifacts_schema: Option<String>

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

The default value is public.

Example: ddlArtifactsSchema=xyzddlschema;

execute_timeout: Option<i32>

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

The default value is false.

If task is set to Limited LOB mode and this option is set to true, the task fails instead of truncating the LOB data.

heartbeat_enable: 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.

The default value is false.

heartbeat_schema: Option<String>

Sets the schema in which the heartbeat artifacts are created.

The default value is public.

heartbeat_frequency: Option<i32>

Sets the WAL heartbeat frequency (in minutes).

The default value is 5 minutes.

password: Option<String>

Endpoint connection password.

port: Option<i32>

Endpoint TCP port. The default is 5432.

server_name: Option<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.

username: Option<String>

Endpoint connection user name.

slot_name: Option<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.

plugin_name: Option<PluginNameValue>

Specifies the plugin to use to create a replication slot.

The default value is pglogical.

secrets_manager_access_role_arn: Option<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.

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.

secrets_manager_secret_id: Option<String>

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

trim_space_in_char: Option<bool>

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

map_boolean_as_boolean: Option<bool>

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.

The default value is false.

map_jsonb_as_clob: Option<bool>

When true, DMS migrates JSONB values as CLOB.

The default value is false.

map_long_varchar_as: Option<LongVarcharMappingType>

Sets what datatype to map LONG values as.

The default value is wstring.

database_mode: Option<DatabaseMode>

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

babelfish_database_name: Option<String>

The Babelfish for Aurora PostgreSQL database name for the endpoint.

disable_unicode_source_filter: Option<bool>

Disables the Unicode source filter with PostgreSQL, for values passed into the Selection rule filter on Source Endpoint column values. By default DMS performs source filter comparisons using a Unicode string which can cause look ups to ignore the indexes in the text columns and slow down migrations.

Unicode support should only be disabled when using a selection rule filter is on a text column in the Source database that is indexed.

Implementations

impl PostgreSqlSettings

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'

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.

The default value is true.

If this value is set to N, you don't have to create tables or triggers on the source database.

pub fn max_file_size(&self) -> Option<i32>

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

The default value is 32,768 KB (32 MB).

Example: maxFileSize=512

pub fn database_name(&self) -> Option<&str>

Database name for the endpoint.

pub fn ddl_artifacts_schema(&self) -> Option<&str>

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

The default value is public.

Example: ddlArtifactsSchema=xyzddlschema;

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;

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.

The default value is false.

If task is set to Limited LOB mode and this option is set to true, the task fails instead of truncating the LOB data.

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.

The default value is false.

pub fn heartbeat_schema(&self) -> Option<&str>

Sets the schema in which the heartbeat artifacts are created.

The default value is public.

pub fn heartbeat_frequency(&self) -> Option<i32>

Sets the WAL heartbeat frequency (in minutes).

The default value is 5 minutes.

pub fn password(&self) -> Option<&str>

Endpoint connection password.

pub fn port(&self) -> Option<i32>

Endpoint TCP port. The default is 5432.

pub fn server_name(&self) -> Option<&str>

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.

pub fn username(&self) -> Option<&str>

Endpoint connection user name.

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.

pub fn plugin_name(&self) -> Option<&PluginNameValue>

Specifies the plugin to use to create a replication slot.

The default value is pglogical.

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.

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.

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.

pub fn map_boolean_as_boolean(&self) -> Option<bool>

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.

The default value is false.

pub fn map_jsonb_as_clob(&self) -> Option<bool>

When true, DMS migrates JSONB values as CLOB.

The default value is false.

pub fn map_long_varchar_as(&self) -> Option<&LongVarcharMappingType>

Sets what datatype to map LONG values as.

The default value is wstring.

pub fn database_mode(&self) -> Option<&DatabaseMode>

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

pub fn babelfish_database_name(&self) -> Option<&str>

The Babelfish for Aurora PostgreSQL database name for the endpoint.

pub fn disable_unicode_source_filter(&self) -> Option<bool>

Disables the Unicode source filter with PostgreSQL, for values passed into the Selection rule filter on Source Endpoint column values. By default DMS performs source filter comparisons using a Unicode string which can cause look ups to ignore the indexes in the text columns and slow down migrations.

Unicode support should only be disabled when using a selection rule filter is on a text column in the Source database that is indexed.

impl PostgreSqlSettings

pub fn builder() -> PostgreSqlSettingsBuilder

Creates a new builder-style object to manufacture PostgreSqlSettings.

Trait Implementations

impl Clone for PostgreSqlSettings

fn clone(&self) -> PostgreSqlSettings

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PostgreSqlSettings

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for PostgreSqlSettings

fn eq(&self, other: &PostgreSqlSettings) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for PostgreSqlSettings