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

Inherits:

Struct

• Object
• Struct
• Aws::DatabaseMigrationService::Types::PostgreSQLSettings

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",
  secrets_manager_access_role_arn: "String",
  secrets_manager_secret_id: "String",
}

Provides information that defines a PostgreSQL endpoint.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:password]

Instance Attribute Summary

• #after_connect_script ⇒ String

  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.

• #capture_ddls ⇒ Boolean

  To capture DDL events, AWS DMS creates various artifacts in the PostgreSQL database when the task starts.

• #database_name ⇒ String

  Database name for the endpoint.

• #ddl_artifacts_schema ⇒ String

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

• #execute_timeout ⇒ Integer

  Sets the client statement timeout for the PostgreSQL instance, in seconds.

• #fail_tasks_on_lob_truncation ⇒ Boolean

  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.

• #max_file_size ⇒ Integer

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

• #password ⇒ String

  Endpoint connection password.

• #port ⇒ Integer

  Endpoint TCP port.

• #secrets_manager_access_role_arn ⇒ String

  The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret.

• #secrets_manager_secret_id ⇒ String

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

• #server_name ⇒ String

  Fully qualified domain name of the endpoint.

• #slot_name ⇒ String

  Sets the name of a previously created logical replication slot for a CDC load of the PostgreSQL source instance.

• #username ⇒ String

  Endpoint connection user name.

Instance Attribute Details

#after_connect_script ⇒ String

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)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6391

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,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id)
  SENSITIVE = [:password]
  include Aws::Structure
end

#capture_ddls ⇒ Boolean

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)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6391

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,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id)
  SENSITIVE = [:password]
  include Aws::Structure
end

#database_name ⇒ String

Database name for the endpoint.

Returns:

• (String)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6391

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,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id)
  SENSITIVE = [:password]
  include Aws::Structure
end

#ddl_artifacts_schema ⇒ String

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

Example: ddlArtifactsSchema=xyzddlschema;

Returns:

• (String)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6391

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,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id)
  SENSITIVE = [:password]
  include Aws::Structure
end

#execute_timeout ⇒ Integer

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

Example: executeTimeout=100;

Returns:

• (Integer)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6391

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,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id)
  SENSITIVE = [:password]
  include Aws::Structure
end

#fail_tasks_on_lob_truncation ⇒ Boolean

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)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6391

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,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id)
  SENSITIVE = [:password]
  include Aws::Structure
end

#max_file_size ⇒ Integer

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

Example: maxFileSize=512

Returns:

• (Integer)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6391

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,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id)
  SENSITIVE = [:password]
  include Aws::Structure
end

#password ⇒ String

Endpoint connection password.

Returns:

• (String)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6391

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,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id)
  SENSITIVE = [:password]
  include Aws::Structure
end

#port ⇒ Integer

Endpoint TCP port.

Returns:

• (Integer)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6391

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,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id)
  SENSITIVE = [:password]
  include Aws::Structure
end

#secrets_manager_access_role_arn ⇒ String

The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret. SecretsManagerSecret has the value of the AWS 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 AWS Database Migration Service resources in the AWS Database Migration Service User Guide.

Returns:

• (String)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6391

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,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id)
  SENSITIVE = [:password]
  include Aws::Structure
end

#secrets_manager_secret_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6391

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,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id)
  SENSITIVE = [:password]
  include Aws::Structure
end

#server_name ⇒ String

Fully qualified domain name of the endpoint.

Returns:

• (String)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6391

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,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id)
  SENSITIVE = [:password]
  include Aws::Structure
end

#slot_name ⇒ String

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)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6391

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,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id)
  SENSITIVE = [:password]
  include Aws::Structure
end

#username ⇒ String

Endpoint connection user name.

Returns:

• (String)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6391

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,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id)
  SENSITIVE = [:password]
  include Aws::Structure
end