Class: Aws::DatabaseMigrationService::Types::PostgreSQLSettings

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb

Overview

Note:

When making an API call, you may pass PostgreSQLSettings data as a 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.

Constant Summary collapse

SENSITIVE =
[:password]

Instance Attribute Summary collapse

Instance Attribute Details

#after_connect_scriptString

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'

Returns:

  • (String)


6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6070

class PostgreSQLSettings < Struct.new(
  :after_connect_script,
  :capture_ddls,
  :max_file_size,
  :database_name,
  :ddl_artifacts_schema,
  :execute_timeout,
  :fail_tasks_on_lob_truncation,
  :password,
  :port,
  :server_name,
  :username,
  :slot_name)
  SENSITIVE = [:password]
  include Aws::Structure
end

#capture_ddlsBoolean

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.

Returns:

  • (Boolean)


6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6070

class PostgreSQLSettings < Struct.new(
  :after_connect_script,
  :capture_ddls,
  :max_file_size,
  :database_name,
  :ddl_artifacts_schema,
  :execute_timeout,
  :fail_tasks_on_lob_truncation,
  :password,
  :port,
  :server_name,
  :username,
  :slot_name)
  SENSITIVE = [:password]
  include Aws::Structure
end

#database_nameString

Database name for the endpoint.

Returns:

  • (String)


6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6070

class PostgreSQLSettings < Struct.new(
  :after_connect_script,
  :capture_ddls,
  :max_file_size,
  :database_name,
  :ddl_artifacts_schema,
  :execute_timeout,
  :fail_tasks_on_lob_truncation,
  :password,
  :port,
  :server_name,
  :username,
  :slot_name)
  SENSITIVE = [:password]
  include Aws::Structure
end

#ddl_artifacts_schemaString

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

Example: ddlArtifactsSchema=xyzddlschema;

Returns:

  • (String)


6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6070

class PostgreSQLSettings < Struct.new(
  :after_connect_script,
  :capture_ddls,
  :max_file_size,
  :database_name,
  :ddl_artifacts_schema,
  :execute_timeout,
  :fail_tasks_on_lob_truncation,
  :password,
  :port,
  :server_name,
  :username,
  :slot_name)
  SENSITIVE = [:password]
  include Aws::Structure
end

#execute_timeoutInteger

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

Example: executeTimeout=100;

Returns:

  • (Integer)


6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6070

class PostgreSQLSettings < Struct.new(
  :after_connect_script,
  :capture_ddls,
  :max_file_size,
  :database_name,
  :ddl_artifacts_schema,
  :execute_timeout,
  :fail_tasks_on_lob_truncation,
  :password,
  :port,
  :server_name,
  :username,
  :slot_name)
  SENSITIVE = [:password]
  include Aws::Structure
end

#fail_tasks_on_lob_truncationBoolean

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:

  • (Boolean)


6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6070

class PostgreSQLSettings < Struct.new(
  :after_connect_script,
  :capture_ddls,
  :max_file_size,
  :database_name,
  :ddl_artifacts_schema,
  :execute_timeout,
  :fail_tasks_on_lob_truncation,
  :password,
  :port,
  :server_name,
  :username,
  :slot_name)
  SENSITIVE = [:password]
  include Aws::Structure
end

#max_file_sizeInteger

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

Example: maxFileSize=512

Returns:

  • (Integer)


6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6070

class PostgreSQLSettings < Struct.new(
  :after_connect_script,
  :capture_ddls,
  :max_file_size,
  :database_name,
  :ddl_artifacts_schema,
  :execute_timeout,
  :fail_tasks_on_lob_truncation,
  :password,
  :port,
  :server_name,
  :username,
  :slot_name)
  SENSITIVE = [:password]
  include Aws::Structure
end

#passwordString

Endpoint connection password.

Returns:

  • (String)


6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6070

class PostgreSQLSettings < Struct.new(
  :after_connect_script,
  :capture_ddls,
  :max_file_size,
  :database_name,
  :ddl_artifacts_schema,
  :execute_timeout,
  :fail_tasks_on_lob_truncation,
  :password,
  :port,
  :server_name,
  :username,
  :slot_name)
  SENSITIVE = [:password]
  include Aws::Structure
end

#portInteger

Endpoint TCP port.

Returns:

  • (Integer)


6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6070

class PostgreSQLSettings < Struct.new(
  :after_connect_script,
  :capture_ddls,
  :max_file_size,
  :database_name,
  :ddl_artifacts_schema,
  :execute_timeout,
  :fail_tasks_on_lob_truncation,
  :password,
  :port,
  :server_name,
  :username,
  :slot_name)
  SENSITIVE = [:password]
  include Aws::Structure
end

#server_nameString

Fully qualified domain name of the endpoint.

Returns:

  • (String)


6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6070

class PostgreSQLSettings < Struct.new(
  :after_connect_script,
  :capture_ddls,
  :max_file_size,
  :database_name,
  :ddl_artifacts_schema,
  :execute_timeout,
  :fail_tasks_on_lob_truncation,
  :password,
  :port,
  :server_name,
  :username,
  :slot_name)
  SENSITIVE = [:password]
  include Aws::Structure
end

#slot_nameString

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.

Returns:

  • (String)


6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6070

class PostgreSQLSettings < Struct.new(
  :after_connect_script,
  :capture_ddls,
  :max_file_size,
  :database_name,
  :ddl_artifacts_schema,
  :execute_timeout,
  :fail_tasks_on_lob_truncation,
  :password,
  :port,
  :server_name,
  :username,
  :slot_name)
  SENSITIVE = [:password]
  include Aws::Structure
end

#usernameString

Endpoint connection user name.

Returns:

  • (String)


6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6070

class PostgreSQLSettings < Struct.new(
  :after_connect_script,
  :capture_ddls,
  :max_file_size,
  :database_name,
  :ddl_artifacts_schema,
  :execute_timeout,
  :fail_tasks_on_lob_truncation,
  :password,
  :port,
  :server_name,
  :username,
  :slot_name)
  SENSITIVE = [:password]
  include Aws::Structure
end