Package software.amazon.awssdk.services.databasemigration.model

Interface PostgreSQLSettings.Builder

    • Method Detail

      • afterConnectScript

        PostgreSQLSettings.Builder afterConnectScript​(String afterConnectScript)

        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'

        Parameters:
        afterConnectScript - 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:
        Returns a reference to this object so that method calls can be chained together.

      • captureDdls

        PostgreSQLSettings.Builder captureDdls​(Boolean captureDdls)

        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.

        Parameters:
        captureDdls - 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:
        Returns a reference to this object so that method calls can be chained together.

      • maxFileSize

        PostgreSQLSettings.Builder maxFileSize​(Integer maxFileSize)

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

        Example: maxFileSize=512

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

        Example: maxFileSize=512

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • databaseName

        PostgreSQLSettings.Builder databaseName​(String databaseName)

        Database name for the endpoint.

        Parameters:
        databaseName - Database name for the endpoint.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • ddlArtifactsSchema

        PostgreSQLSettings.Builder ddlArtifactsSchema​(String ddlArtifactsSchema)

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

        Example: ddlArtifactsSchema=xyzddlschema;

        Parameters:
        ddlArtifactsSchema - The schema in which the operational DDL database artifacts are created.

        Example: ddlArtifactsSchema=xyzddlschema;

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • executeTimeout

        PostgreSQLSettings.Builder executeTimeout​(Integer executeTimeout)

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

        Example: executeTimeout=100;

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

        Example: executeTimeout=100;

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • failTasksOnLobTruncation

        PostgreSQLSettings.Builder failTasksOnLobTruncation​(Boolean failTasksOnLobTruncation)

        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.

        Parameters:
        failTasksOnLobTruncation - 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:
        Returns a reference to this object so that method calls can be chained together.

      • heartbeatEnable

        PostgreSQLSettings.Builder heartbeatEnable​(Boolean heartbeatEnable)

        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.

        Parameters:
        heartbeatEnable - 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:
        Returns a reference to this object so that method calls can be chained together.

      • heartbeatSchema

        PostgreSQLSettings.Builder heartbeatSchema​(String heartbeatSchema)

        Sets the schema in which the heartbeat artifacts are created.

        Parameters:
        heartbeatSchema - Sets the schema in which the heartbeat artifacts are created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • heartbeatFrequency

        PostgreSQLSettings.Builder heartbeatFrequency​(Integer heartbeatFrequency)

        Sets the WAL heartbeat frequency (in minutes).

        Parameters:
        heartbeatFrequency - Sets the WAL heartbeat frequency (in minutes).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • password

        PostgreSQLSettings.Builder password​(String password)

        Endpoint connection password.

        Parameters:
        password - Endpoint connection password.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • port

        PostgreSQLSettings.Builder port​(Integer port)

        Endpoint TCP port. The default is 5432.

        Parameters:
        port - Endpoint TCP port. The default is 5432.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • serverName

        PostgreSQLSettings.Builder serverName​(String serverName)

        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.

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • username

        PostgreSQLSettings.Builder username​(String username)

        Endpoint connection user name.

        Parameters:
        username - Endpoint connection user name.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • slotName

        PostgreSQLSettings.Builder slotName​(String slotName)

        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.

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • pluginName

        PostgreSQLSettings.Builder pluginName​(String pluginName)

        Specifies the plugin to use to create a replication slot.

        Parameters:
        pluginName - Specifies the plugin to use to create a replication slot.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        PluginNameValue, PluginNameValue

      • pluginName

        PostgreSQLSettings.Builder pluginName​(PluginNameValue pluginName)

        Specifies the plugin to use to create a replication slot.

        Parameters:
        pluginName - Specifies the plugin to use to create a replication slot.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        PluginNameValue, PluginNameValue

      • secretsManagerAccessRoleArn

        PostgreSQLSettings.Builder secretsManagerAccessRoleArn​(String secretsManagerAccessRoleArn)

        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.

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • secretsManagerSecretId

        PostgreSQLSettings.Builder secretsManagerSecretId​(String secretsManagerSecretId)

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

        Parameters:
        secretsManagerSecretId - The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the PostgreSQL endpoint connection details.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • trimSpaceInChar

        PostgreSQLSettings.Builder trimSpaceInChar​(Boolean trimSpaceInChar)

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

        Parameters:
        trimSpaceInChar - Use the TrimSpaceInChar source endpoint setting to trim data on CHAR and NCHAR data types during migration. The default value is true.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • mapBooleanAsBoolean

        PostgreSQLSettings.Builder mapBooleanAsBoolean​(Boolean mapBooleanAsBoolean)

        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.

        Parameters:
        mapBooleanAsBoolean - 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:
        Returns a reference to this object so that method calls can be chained together.

      • mapJsonbAsClob

        PostgreSQLSettings.Builder mapJsonbAsClob​(Boolean mapJsonbAsClob)

        When true, DMS migrates JSONB values as CLOB.

        Parameters:
        mapJsonbAsClob - When true, DMS migrates JSONB values as CLOB.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • databaseMode

        PostgreSQLSettings.Builder databaseMode​(String databaseMode)

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

        Parameters:
        databaseMode - Specifies the default behavior of the replication's handling of PostgreSQL- compatible endpoints that require some additional configuration, such as Babelfish endpoints.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        DatabaseMode, DatabaseMode

      • databaseMode

        PostgreSQLSettings.Builder databaseMode​(DatabaseMode databaseMode)

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

        Parameters:
        databaseMode - Specifies the default behavior of the replication's handling of PostgreSQL- compatible endpoints that require some additional configuration, such as Babelfish endpoints.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        DatabaseMode, DatabaseMode

      • babelfishDatabaseName

        PostgreSQLSettings.Builder babelfishDatabaseName​(String babelfishDatabaseName)

        The Babelfish for Aurora PostgreSQL database name for the endpoint.

        Parameters:
        babelfishDatabaseName - The Babelfish for Aurora PostgreSQL database name for the endpoint.
        Returns:
        Returns a reference to this object so that method calls can be chained together.