Struct aws_sdk_databasemigration::types::builders::PostgreSqlSettingsBuilder

#[non_exhaustive]
pub struct PostgreSqlSettingsBuilder { /* private fields */ }

A builder for PostgreSqlSettings.

Implementations

impl PostgreSqlSettingsBuilder

pub fn after_connect_script(self, input: impl Into<String>) -> Self

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 set_after_connect_script(self, input: Option<String>) -> Self

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 get_after_connect_script(&self) -> &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'

pub fn capture_ddls(self, input: bool) -> Self

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.

pub fn set_capture_ddls(self, input: Option<bool>) -> Self

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.

pub fn get_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.

pub fn max_file_size(self, input: i32) -> Self

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

Example: maxFileSize=512

pub fn set_max_file_size(self, input: Option<i32>) -> Self

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

Example: maxFileSize=512

pub fn get_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

pub fn database_name(self, input: impl Into<String>) -> Self

Database name for the endpoint.

pub fn set_database_name(self, input: Option<String>) -> Self

Database name for the endpoint.

pub fn get_database_name(&self) -> &Option<String>

Database name for the endpoint.

pub fn ddl_artifacts_schema(self, input: impl Into<String>) -> Self

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

Example: ddlArtifactsSchema=xyzddlschema;

pub fn set_ddl_artifacts_schema(self, input: Option<String>) -> Self

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

Example: ddlArtifactsSchema=xyzddlschema;

pub fn get_ddl_artifacts_schema(&self) -> &Option<String>

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

Example: ddlArtifactsSchema=xyzddlschema;

pub fn execute_timeout(self, input: i32) -> Self

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

Example: executeTimeout=100;

pub fn set_execute_timeout(self, input: Option<i32>) -> Self

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

Example: executeTimeout=100;

pub fn get_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, input: bool) -> Self

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.

pub fn set_fail_tasks_on_lob_truncation(self, input: Option<bool>) -> Self

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.

pub fn get_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.

pub fn heartbeat_enable(self, input: bool) -> Self

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.

pub fn set_heartbeat_enable(self, input: Option<bool>) -> Self

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.

pub fn get_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.

pub fn heartbeat_schema(self, input: impl Into<String>) -> Self

Sets the schema in which the heartbeat artifacts are created.

pub fn set_heartbeat_schema(self, input: Option<String>) -> Self

Sets the schema in which the heartbeat artifacts are created.

pub fn get_heartbeat_schema(&self) -> &Option<String>

Sets the schema in which the heartbeat artifacts are created.

pub fn heartbeat_frequency(self, input: i32) -> Self

Sets the WAL heartbeat frequency (in minutes).

pub fn set_heartbeat_frequency(self, input: Option<i32>) -> Self

Sets the WAL heartbeat frequency (in minutes).

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

Sets the WAL heartbeat frequency (in minutes).

pub fn password(self, input: impl Into<String>) -> Self

Endpoint connection password.

pub fn set_password(self, input: Option<String>) -> Self

Endpoint connection password.

pub fn get_password(&self) -> &Option<String>

Endpoint connection password.

pub fn port(self, input: i32) -> Self

Endpoint TCP port. The default is 5432.

pub fn set_port(self, input: Option<i32>) -> Self

Endpoint TCP port. The default is 5432.

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

Endpoint TCP port. The default is 5432.

pub fn server_name(self, input: impl Into<String>) -> Self

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 set_server_name(self, input: Option<String>) -> Self

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 get_server_name(&self) -> &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.

pub fn username(self, input: impl Into<String>) -> Self

Endpoint connection user name.

pub fn set_username(self, input: Option<String>) -> Self

Endpoint connection user name.

pub fn get_username(&self) -> &Option<String>

Endpoint connection user name.

pub fn slot_name(self, input: impl Into<String>) -> Self

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 set_slot_name(self, input: Option<String>) -> Self

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 get_slot_name(&self) -> &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.

pub fn plugin_name(self, input: PluginNameValue) -> Self

Specifies the plugin to use to create a replication slot.

pub fn set_plugin_name(self, input: Option<PluginNameValue>) -> Self

Specifies the plugin to use to create a replication slot.

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

Specifies the plugin to use to create a replication slot.

pub fn secrets_manager_access_role_arn(self, input: impl Into<String>) -> Self

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 set_secrets_manager_access_role_arn(self, input: Option<String>) -> Self

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 get_secrets_manager_access_role_arn(&self) -> &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.

pub fn secrets_manager_secret_id(self, input: impl Into<String>) -> Self

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

pub fn set_secrets_manager_secret_id(self, input: Option<String>) -> Self

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

pub fn get_secrets_manager_secret_id(&self) -> &Option<String>

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, input: bool) -> Self

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

pub fn set_trim_space_in_char(self, input: Option<bool>) -> Self

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

pub fn get_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, input: bool) -> Self

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.

pub fn set_map_boolean_as_boolean(self, input: Option<bool>) -> Self

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.

pub fn get_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.

pub fn map_jsonb_as_clob(self, input: bool) -> Self

When true, DMS migrates JSONB values as CLOB.

pub fn set_map_jsonb_as_clob(self, input: Option<bool>) -> Self

When true, DMS migrates JSONB values as CLOB.

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

When true, DMS migrates JSONB values as CLOB.

pub fn map_long_varchar_as(self, input: LongVarcharMappingType) -> Self

When true, DMS migrates LONG values as VARCHAR.

pub fn set_map_long_varchar_as( self, input: Option<LongVarcharMappingType> ) -> Self

When true, DMS migrates LONG values as VARCHAR.

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

When true, DMS migrates LONG values as VARCHAR.

pub fn database_mode(self, input: DatabaseMode) -> Self

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

pub fn set_database_mode(self, input: Option<DatabaseMode>) -> Self

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

pub fn get_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, input: impl Into<String>) -> Self

The Babelfish for Aurora PostgreSQL database name for the endpoint.

pub fn set_babelfish_database_name(self, input: Option<String>) -> Self

The Babelfish for Aurora PostgreSQL database name for the endpoint.

pub fn get_babelfish_database_name(&self) -> &Option<String>

The Babelfish for Aurora PostgreSQL database name for the endpoint.

pub fn build(self) -> PostgreSqlSettings

Consumes the builder and constructs a PostgreSqlSettings.

Trait Implementations

impl Clone for PostgreSqlSettingsBuilder

fn clone(&self) -> PostgreSqlSettingsBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PostgreSqlSettingsBuilder

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

Formats the value using the given formatter.

impl Default for PostgreSqlSettingsBuilder

fn default() -> PostgreSqlSettingsBuilder

Returns the “default value” for a type.

impl PartialEq for PostgreSqlSettingsBuilder

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for PostgreSqlSettingsBuilder